@wix/groups 1.0.11 → 1.0.12

package/build/cjs/src/social-groups-v2-group-member.universal.d.ts

@@ -6,13 +6,13 @@ export declare const __debug: {
 };
 export interface GroupMember {
     /**
-     * __Deprecated.__ Use `memberId` instead.
-     * This property will be removed on June 30, 2022.
+     * @internal
+     * @internal
      * @readonly
      */
     siteMemberId?: string;
     /**
-     * Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details.
+     * Site member ID.
      * @readonly
      */
     memberId?: string;
@@ -30,9 +30,9 @@ export interface GroupMember {
  */
 export interface GroupRole {
     /**
-     * Member's role.
-     * - `MEMBER` - Regular group member.
-     * - `ADMIN` - Group administrator.
+     * Group member role. One of:
+     * - `"MEMBER"` - Regular group member.
+     * - `"ADMIN"` - Group administrator.
      */
     value?: Role;
 }
@@ -67,6 +67,11 @@ export interface MemberJoined {
     /** Joined group member. */
     groupMember?: GroupMember;
 }
+export declare enum JoinBy {
+    MANUALLY = "MANUALLY",
+    PERSONAL_INVITE_LINK = "PERSONAL_INVITE_LINK",
+    PUBLIC_INVITE_LINK = "PUBLIC_INVITE_LINK"
+}
 export interface LeaveRequest {
     /** ID of the Group to leave. */
     groupId?: string;
@@ -83,11 +88,14 @@ export interface AddGroupMembersRequest {
     /** Group ID. */
     groupId: string;
     /**
-     * __Deprecated.__ Use `memberIds` instead.
-     * This parameter will be removed on June 30, 2022.
-     */
+     * @internal
+     * @internal */
     siteMemberIds?: string[];
-    /** Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
+    /**
+     * IDs of the site members to add to the group.
+     *
+     *
+     */
     memberIds?: string[];
 }
 export interface AddGroupMembersResponse {
@@ -104,11 +112,10 @@ export interface RemoveGroupMembersRequest {
     /** Group ID. */
     groupId: string;
     /**
-     * __Deprecated.__ Use `memberIds` instead.
-     * This parameter will be removed on June 30, 2022.
-     */
+     * @internal
+     * @internal */
     siteMemberIds?: string[];
-    /** Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
+    /**  IDs of the site members to remove from the group. */
     memberIds?: string[];
 }
 export interface RemoveGroupMembersResponse {
@@ -124,12 +131,13 @@ export interface ListGroupMembersRequest {
     groupId: string;
     /** Number of items to load. Maximum `100.` */
     limit?: number | null;
-    /** Number of items to skip in the current sort order. */
+    /** Number of group members to skip in the list. */
     offset?: number | null;
 }
 export interface ListGroupMembersResponse {
     /** Retrieved members. */
     members?: GroupMember[];
+    /** Paging information. */
     metadata?: PagingMetadata;
 }
 export interface PagingMetadata {
@@ -188,6 +196,7 @@ export interface Paging {
 export interface QueryGroupMembersResponse {
     /** Group members. */
     members?: GroupMember[];
+    /** Paging information. */
     metadata?: PagingMetadata;
 }
 export interface QueryNonGroupMembersRequest {
@@ -200,16 +209,17 @@ export interface QueryNonGroupMembersResponse {
     members?: GroupMember[];
 }
 export interface ListMembershipsRequest {
-    /** Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
+    /** Site member ID. */
     memberId: string | null;
     /** Number of items to load. */
     limit?: number | null;
-    /** Number of items to skip in the current sort order. */
+    /** Number of memberships to skip in the list. */
     offset?: number | null;
 }
 export interface ListMembershipsResponse {
     /** Site member's memberships. */
     memberships?: Membership[];
+    /** Paging information. */
     metadata?: PagingMetadata;
 }
 export interface Membership {
@@ -220,8 +230,8 @@ export interface Membership {
     groupId?: string;
     /**
      * Membership status with Group
-     * - `JOINED` - Site member is a group member.
-     * - `PENDING` - Site member has submitted a Join Request for this group that is still `PENDING`.
+     * - `"JOINED"` - Site member is a group member.
+     * - `"PENDING"` - Site member has submitted a Join Request for this group that is still `"PENDING"`.
      */
     status?: MembershipStatus;
     /** Group member role. When membership status is not `JOINED`, this is empty. */
@@ -236,80 +246,119 @@ export declare enum MembershipStatus {
 }
 export interface QueryMembershipsRequest {
     /**
-     * __Deprecated.__ Use the `memberId` path parameter instead.
-     * This parameter will be removed on June 30, 2022.
-     */
+     * @internal
+     * @internal */
     siteMemberId?: string | null;
-    /** Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
+    /** Site member ID. */
     memberId: string | null;
     query?: Query;
 }
 export interface QueryMembershipsResponse {
     /** Site member's memberships. */
     memberships?: Membership[];
+    /** Paging information. */
     metadata?: PagingMetadata;
 }
 /**
- * Add site members to a specific group.
- * Admins always have access to this functionality. Site owners may allow members to use this functionality as well.
+ * Adds site members to a group.
+ *
+ *
+ * The `addGroupMembers()` function returns a Promise that resolves to the newly-added group member
+ * after the member has successfully been added.
+ *
+ * For `SECRET` groups, site admins, group admins, and group members can add additional members to their group.
+ *
+ * For `PUBLIC` and `PRIVATE` groups, only site admins and group admins can add additional members to their group. They can also choose to allow all group members to add a new member to the group.
+ * This setting can be found in your site's Dashboard under **Groups Application > Your Group > Admin Tools > Member Permissions**.
+ *
+ * <!-- > **Note:** If the `suppressAuth` option is set to `true`, all permissions are overwritten and all site members (including non-group members) can add additional members to a group. -->
+ *
  * @param groupId - Group ID.
+ * @param memberIds - IDs of the site members to add to the group.
  * @public
  * @documentationMaturity preview
  * @requiredField groupId
+ * @requiredField memberIds
  */
-export declare function addGroupMembers(groupId: string, options?: AddGroupMembersOptions): Promise<AddGroupMembersResponse>;
+export declare function addGroupMembers(groupId: string, memberIds: string[], options?: AddGroupMembersOptions): Promise<AddGroupMembersResponse>;
 export interface AddGroupMembersOptions {
     /**
-     * __Deprecated.__ Use `memberIds` instead.
-     * This parameter will be removed on June 30, 2022.
-     */
+     * @internal
+     * @internal */
     siteMemberIds?: string[];
-    /** Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
-    memberIds?: string[];
 }
 /**
- * Removes site members from a specific group.
- * Only admins have can remove members from a group.
+ * Removes members from a group.
+ *
+ *
+ * The `removeGroupMembers()` function returns a Promise that resolves when the member is removed from the group.
+ *
+ * > **Note:** Only site admins and group admins can remove members from their group. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten and all site members (including non-group members) can remove members from a group. -->
+ *
  * @param groupId - Group ID.
+ * @param memberIds - IDs of the site members to remove from the group.
  * @public
  * @documentationMaturity preview
  * @requiredField groupId
+ * @requiredField memberIds
  */
-export declare function removeGroupMembers(groupId: string, options?: RemoveGroupMembersOptions): Promise<void>;
+export declare function removeGroupMembers(groupId: string, memberIds: string[], options?: RemoveGroupMembersOptions): Promise<void>;
 export interface RemoveGroupMembersOptions {
     /**
-     * __Deprecated.__ Use `memberIds` instead.
-     * This parameter will be removed on June 30, 2022.
-     */
+     * @internal
+     * @internal */
     siteMemberIds?: string[];
-    /** Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
-    memberIds?: string[];
 }
 /**
- * Retrieves a list of up to 100 group members, given the provided paging.
- * Groups mangers can retrieve group members of any group.
+ * Lists all members of a group.
+ *
+ *
+ *  The `listGroupMembers()` function returns a Promise that resolves to a list of up to 100 group members.
+ *  Sorts by default to `joinedDate` in descending order.
+ *
+ *  > **Notes:**
+ *  > + For `SECRET` groups, only site admins, group admins, and group members can see the list of group members. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can see the list of group members.  -->
+ *  > + 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 `listGroupMembers(groupId, paging, null)`. To specify `supressAuth` only, call `listGroupMembers(groupId, null, options)`.
+ *
  * @param groupId - Group ID.
  * @public
  * @documentationMaturity preview
  * @requiredField groupId
+ * @param options - Paging options.
  */
 export declare function listGroupMembers(groupId: string, options?: ListGroupMembersOptions): Promise<ListGroupMembersResponse>;
 export interface ListGroupMembersOptions {
-    /** Number of items to load. Maximum `100.` */
+    /** Maximum number of group members to retrieve. Defaults to 100. */
     limit?: number | null;
-    /** Number of items to skip in the current sort order. */
+    /** Number of group members to skip in the list. */
     offset?: number | null;
 }
 /**
  * Retrieves a list of up to 100 group members, given the provided paging, sorting and filtering.
- * Groups mangers can retrieve group members of any group.
  *
- * Supported fields for filtering:
- * - `role`
  *
- * Supported fields for sorting:
- * - `joinedOn`
- * - `role`
+ * Creates a query to retrieve a list of group members.
+ *
+ * > **Note:** For `SECRET` groups, only site admins, group admins, and group members can query group members. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query group members.
+ *
+ * The `queryGroupMembers()` function builds a query to retrieve a list of all group members, and returns a [GroupMembersQueryBuilder](wix-groups-backend/members/membersquerybuilder) object.
+ *
+ * The returned object contains the query definition which is typically used to run the query using the [`find()`](wix-groups-backend/members/membersquerybuilder/find) function.
+ *
+ * You can refine the query by chaining `GroupMembersQueryBuilder` functions onto the query. `GroupMembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryMembers()` returns.
+ *
+ *  `queryGroupMembers()` runs with these `GroupMembersQueryBuilder` defaults, which you can override:
+ *  + [`limit(100)`](wix-groups-backend/members/membersquerybuilder/limit)
+ *  + [`descending("joinedDate")`](wix-groups-backend/members/membersquerybuilder/descending)
+ *
+ * The following `GroupMembersQueryBuilder` functions are supported for `queryGroupMembers()`. For a full description of the Members object, see the object returned for the [`items`](wix-groups-backend/members/membersqueryresult/items) property in [`GroupMembersQueryResult`](wix-groups-backend/members/membersqueryresult).
+ *
+ * | Property                    | Supported Filters & Sorting                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+ * | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+ * | `role`                      | [`eq()`](wix-groups-backend/members/membersquerybuilder/eq), [`ne()`](wix-groups-backend/members/membersquerybuilder/ne)                            |
+ * | `joinedDate`                | [`ascending()`](wix-groups-backend/members/membersquerybuilder/ascending), [`descending()`](wix-groups-backend/members/membersquerybuilder/descending)     |
+ *
+ *
  * @param groupId - Group ID.
  * @public
  * @documentationMaturity preview
@@ -320,40 +369,65 @@ export interface QueryGroupMembersOptions {
     query?: Query;
 }
 /**
- * Retrieves a list of up to 100 members and their membership status, given the provided paging.
- * Groups mangers can see all memberships for any group.
- * @param memberId - Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.
+ * Lists all group memberships of a site member.
+ *
+ *
+ * The `listMemberships()` function returns a Promise that resolves to a list of up to 100 group memberships.
+ * Sorts by default to `groupId` in descending order.
+ *
+ * > **Notes:**
+ * > + Only site admins can retrieve a site member's memberships. Site members can see a list of their memberships. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can see a list of a site member's memberships. -->
+ * > + 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 `listMemberships(memberId, paging, null)`. To specify `supressAuth` only, call `listMemberships(memberId, null, options)`.
+ *
  * @public
  * @documentationMaturity preview
  * @requiredField memberId
+ * @param memberId - Site member ID.
+ * @param options - Paging options.
  */
 export declare function listMemberships(memberId: string | null, options?: ListMembershipsOptions): Promise<ListMembershipsResponse>;
 export interface ListMembershipsOptions {
-    /** Number of items to load. */
+    /** Maximum number of memberships to retrieve. Defaults to 100. */
     limit?: number | null;
-    /** Number of items to skip in the current sort order. */
+    /** Number of memberships to skip in the list. */
     offset?: number | null;
 }
 /**
- * Retrieves a list of up to 100 members and their membership status, given the provided paging and filtering.
- * Groups mangers can see all memberships for any group.
+ * Retrieves a list of up to 100 memberships, given the provided paging, sorting and filtering.
+ *
+ *
+ * Creates a query to retrieve a list of memberships.
+ *
+ * > **Note:** Only site admins can query a site member's memberships. Site members can query their memberships. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query a site member's memberships.
+ *
+ * The `queryMemberships()` function builds a query to retrieve a list of all memberships, and returns a [MembershipsQueryBuilder](wix-groups-backend/members/membershipsquerybuilder) object.
  *
- * Supported fields for filtering:
- * - `role`
- * - `status`
+ * The returned object contains the query definition which is typically used to run the query using the [`find()`](wix-groups-backend/members/membershipsquerybuilder/find) function.
+ *
+ * You can refine the query by chaining `GroupMembersQueryBuilder` functions onto the query. `GroupMembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryMemberships()` returns.
+ *
+ * The results of the `queryMemberships()` function are sorted by `groupId` in descending order.
+ *
+ * `queryMemberships()` runs with this `GroupMembersQueryBuilder` default, which you can override:
+ * + [`limit(100)`](wix-groups-backend/members/membershipsquerybuilder/limit)
+ *
+ * The following `GroupMembersQueryBuilder` functions are supported for `queryMemberships()`. For a full description of the Memberships object, see the object returned for the [`items`](wix-groups-backend/members/membershipsqueryresult/items) property in [`MembershipsQueryResult`](wix-groups-backend/members/membershipsqueryresult).
+ *
+ * | Property                    | Supported Filters & Sorting                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+ * | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+ * | `status`                    | [`eq()`](wix-groups-backend/members/membershipsquerybuilder/eq), [`ne()`](wix-groups-backend/members/membershipsquerybuilder/ne)             |
+ * | `role`                      | [`eq()`](wix-groups-backend/members/membershipsquerybuilder/eq), [`ne()`](wix-groups-backend/members/membershipsquerybuilder/ne)             |
  *
- * No supported fields for sorting.
- * @param memberId - Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.
  * @public
  * @documentationMaturity preview
  * @requiredField memberId
+ * @param memberId - Site member ID.
  */
 export declare function queryMemberships(memberId: string | null, options?: QueryMembershipsOptions): Promise<QueryMembershipsResponse>;
 export interface QueryMembershipsOptions {
     /**
-     * __Deprecated.__ Use the `memberId` path parameter instead.
-     * This parameter will be removed on June 30, 2022.
-     */
+     * @internal
+     * @internal */
     siteMemberId?: string | null;
     query?: Query;
 }

package/build/cjs/src/social-groups-v2-group-member.universal.js

@@ -28,7 +28,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.queryMemberships = exports.listMemberships = exports.queryGroupMembers = exports.listGroupMembers = exports.removeGroupMembers = exports.addGroupMembers = exports.MembershipStatus = exports.SortOrder = exports.Role = exports.__debug = void 0;
+exports.queryMemberships = exports.listMemberships = exports.queryGroupMembers = exports.listGroupMembers = exports.removeGroupMembers = exports.addGroupMembers = exports.MembershipStatus = exports.SortOrder = exports.JoinBy = exports.Role = exports.__debug = void 0;
 const velo_1 = require("@wix/metro-runtime/velo");
 const ambassadorWixSocialGroupsV2GroupMember = __importStar(require("./social-groups-v2-group-member.http"));
 let __verbose = false;
@@ -54,6 +54,12 @@ var Role;
     /** Group administrator. */
     Role["ADMIN"] = "ADMIN";
 })(Role = exports.Role || (exports.Role = {}));
+var JoinBy;
+(function (JoinBy) {
+    JoinBy["MANUALLY"] = "MANUALLY";
+    JoinBy["PERSONAL_INVITE_LINK"] = "PERSONAL_INVITE_LINK";
+    JoinBy["PUBLIC_INVITE_LINK"] = "PUBLIC_INVITE_LINK";
+})(JoinBy = exports.JoinBy || (exports.JoinBy = {}));
 var SortOrder;
 (function (SortOrder) {
     SortOrder["ASC"] = "ASC";
@@ -80,24 +86,37 @@ const _queryMembershipsResponse = {};
 const _removeGroupMembersRequest = {};
 const _removeGroupMembersResponse = {};
 /**
- * Add site members to a specific group.
- * Admins always have access to this functionality. Site owners may allow members to use this functionality as well.
+ * Adds site members to a group.
+ *
+ *
+ * The `addGroupMembers()` function returns a Promise that resolves to the newly-added group member
+ * after the member has successfully been added.
+ *
+ * For `SECRET` groups, site admins, group admins, and group members can add additional members to their group.
+ *
+ * For `PUBLIC` and `PRIVATE` groups, only site admins and group admins can add additional members to their group. They can also choose to allow all group members to add a new member to the group.
+ * This setting can be found in your site's Dashboard under **Groups Application > Your Group > Admin Tools > Member Permissions**.
+ *
+ * <!-- > **Note:** If the `suppressAuth` option is set to `true`, all permissions are overwritten and all site members (including non-group members) can add additional members to a group. -->
+ *
  * @param groupId - Group ID.
+ * @param memberIds - IDs of the site members to add to the group.
  * @public
  * @documentationMaturity preview
  * @requiredField groupId
+ * @requiredField memberIds
  */
-function addGroupMembers(groupId, options) {
+function addGroupMembers(groupId, memberIds, options) {
     var _a, _b, _c;
     return __awaiter(this, arguments, void 0, function* () {
         const requestTransformation = {
             groupId: '$[0]',
-            siteMemberIds: '$[1].siteMemberIds',
-            memberIds: '$[1].memberIds',
+            memberIds: '$[1]',
+            siteMemberIds: '$[2].siteMemberIds',
         };
         const responseTransformation = '$';
         // @ts-ignore
-        const { httpClient, sideEffects } = arguments[2];
+        const { httpClient, sideEffects } = arguments[3];
         const { toAmbassadorRequest } = (0, velo_1.serializer)({
             rootSchema: _addGroupMembersRequest,
             depSchemas: {},
@@ -116,7 +135,7 @@ function addGroupMembers(groupId, options) {
             },
             customTransformation: responseTransformation,
         });
-        const payload = toAmbassadorRequest([groupId, options]);
+        const payload = toAmbassadorRequest([groupId, memberIds, options]);
         const reqOpts = ambassadorWixSocialGroupsV2GroupMember.addGroupMembers(payload);
         __log(`"AddGroupMembers" sending request with: ${__inspect(reqOpts)}`);
         (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
@@ -128,6 +147,7 @@ function addGroupMembers(groupId, options) {
         catch (err) {
             const transformedError = (0, velo_1.transformError)(err, requestTransformation, [
                 'groupId',
+                'memberIds',
                 'options',
             ]);
             (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
@@ -137,24 +157,31 @@ function addGroupMembers(groupId, options) {
 }
 exports.addGroupMembers = addGroupMembers;
 /**
- * Removes site members from a specific group.
- * Only admins have can remove members from a group.
+ * Removes members from a group.
+ *
+ *
+ * The `removeGroupMembers()` function returns a Promise that resolves when the member is removed from the group.
+ *
+ * > **Note:** Only site admins and group admins can remove members from their group. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten and all site members (including non-group members) can remove members from a group. -->
+ *
  * @param groupId - Group ID.
+ * @param memberIds - IDs of the site members to remove from the group.
  * @public
  * @documentationMaturity preview
  * @requiredField groupId
+ * @requiredField memberIds
  */
-function removeGroupMembers(groupId, options) {
+function removeGroupMembers(groupId, memberIds, options) {
     var _a, _b, _c;
     return __awaiter(this, arguments, void 0, function* () {
         const requestTransformation = {
             groupId: '$[0]',
-            siteMemberIds: '$[1].siteMemberIds',
-            memberIds: '$[1].memberIds',
+            memberIds: '$[1]',
+            siteMemberIds: '$[2].siteMemberIds',
         };
         const responseTransformation = '$';
         // @ts-ignore
-        const { httpClient, sideEffects } = arguments[2];
+        const { httpClient, sideEffects } = arguments[3];
         const { toAmbassadorRequest } = (0, velo_1.serializer)({
             rootSchema: _removeGroupMembersRequest,
             depSchemas: {},
@@ -173,7 +200,7 @@ function removeGroupMembers(groupId, options) {
             },
             customTransformation: responseTransformation,
         });
-        const payload = toAmbassadorRequest([groupId, options]);
+        const payload = toAmbassadorRequest([groupId, memberIds, options]);
         const reqOpts = ambassadorWixSocialGroupsV2GroupMember.removeGroupMembers(payload);
         __log(`"RemoveGroupMembers" sending request with: ${__inspect(reqOpts)}`);
         (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
@@ -185,6 +212,7 @@ function removeGroupMembers(groupId, options) {
         catch (err) {
             const transformedError = (0, velo_1.transformError)(err, requestTransformation, [
                 'groupId',
+                'memberIds',
                 'options',
             ]);
             (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
@@ -194,12 +222,21 @@ function removeGroupMembers(groupId, options) {
 }
 exports.removeGroupMembers = removeGroupMembers;
 /**
- * Retrieves a list of up to 100 group members, given the provided paging.
- * Groups mangers can retrieve group members of any group.
+ * Lists all members of a group.
+ *
+ *
+ *  The `listGroupMembers()` function returns a Promise that resolves to a list of up to 100 group members.
+ *  Sorts by default to `joinedDate` in descending order.
+ *
+ *  > **Notes:**
+ *  > + For `SECRET` groups, only site admins, group admins, and group members can see the list of group members. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can see the list of group members.  -->
+ *  > + 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 `listGroupMembers(groupId, paging, null)`. To specify `supressAuth` only, call `listGroupMembers(groupId, null, options)`.
+ *
  * @param groupId - Group ID.
  * @public
  * @documentationMaturity preview
  * @requiredField groupId
+ * @param options - Paging options.
  */
 function listGroupMembers(groupId, options) {
     var _a, _b, _c;
@@ -252,14 +289,30 @@ function listGroupMembers(groupId, options) {
 exports.listGroupMembers = listGroupMembers;
 /**
  * Retrieves a list of up to 100 group members, given the provided paging, sorting and filtering.
- * Groups mangers can retrieve group members of any group.
  *
- * Supported fields for filtering:
- * - `role`
  *
- * Supported fields for sorting:
- * - `joinedOn`
- * - `role`
+ * Creates a query to retrieve a list of group members.
+ *
+ * > **Note:** For `SECRET` groups, only site admins, group admins, and group members can query group members. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query group members.
+ *
+ * The `queryGroupMembers()` function builds a query to retrieve a list of all group members, and returns a [GroupMembersQueryBuilder](wix-groups-backend/members/membersquerybuilder) object.
+ *
+ * The returned object contains the query definition which is typically used to run the query using the [`find()`](wix-groups-backend/members/membersquerybuilder/find) function.
+ *
+ * You can refine the query by chaining `GroupMembersQueryBuilder` functions onto the query. `GroupMembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryMembers()` returns.
+ *
+ *  `queryGroupMembers()` runs with these `GroupMembersQueryBuilder` defaults, which you can override:
+ *  + [`limit(100)`](wix-groups-backend/members/membersquerybuilder/limit)
+ *  + [`descending("joinedDate")`](wix-groups-backend/members/membersquerybuilder/descending)
+ *
+ * The following `GroupMembersQueryBuilder` functions are supported for `queryGroupMembers()`. For a full description of the Members object, see the object returned for the [`items`](wix-groups-backend/members/membersqueryresult/items) property in [`GroupMembersQueryResult`](wix-groups-backend/members/membersqueryresult).
+ *
+ * | Property                    | Supported Filters & Sorting                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+ * | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+ * | `role`                      | [`eq()`](wix-groups-backend/members/membersquerybuilder/eq), [`ne()`](wix-groups-backend/members/membersquerybuilder/ne)                            |
+ * | `joinedDate`                | [`ascending()`](wix-groups-backend/members/membersquerybuilder/ascending), [`descending()`](wix-groups-backend/members/membersquerybuilder/descending)     |
+ *
+ *
  * @param groupId - Group ID.
  * @public
  * @documentationMaturity preview
@@ -311,12 +364,21 @@ function queryGroupMembers(groupId, options) {
 }
 exports.queryGroupMembers = queryGroupMembers;
 /**
- * Retrieves a list of up to 100 members and their membership status, given the provided paging.
- * Groups mangers can see all memberships for any group.
- * @param memberId - Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.
+ * Lists all group memberships of a site member.
+ *
+ *
+ * The `listMemberships()` function returns a Promise that resolves to a list of up to 100 group memberships.
+ * Sorts by default to `groupId` in descending order.
+ *
+ * > **Notes:**
+ * > + Only site admins can retrieve a site member's memberships. Site members can see a list of their memberships. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can see a list of a site member's memberships. -->
+ * > + 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 `listMemberships(memberId, paging, null)`. To specify `supressAuth` only, call `listMemberships(memberId, null, options)`.
+ *
  * @public
  * @documentationMaturity preview
  * @requiredField memberId
+ * @param memberId - Site member ID.
+ * @param options - Paging options.
  */
 function listMemberships(memberId, options) {
     var _a, _b, _c;
@@ -368,18 +430,35 @@ function listMemberships(memberId, options) {
 }
 exports.listMemberships = listMemberships;
 /**
- * Retrieves a list of up to 100 members and their membership status, given the provided paging and filtering.
- * Groups mangers can see all memberships for any group.
+ * Retrieves a list of up to 100 memberships, given the provided paging, sorting and filtering.
+ *
+ *
+ * Creates a query to retrieve a list of memberships.
+ *
+ * > **Note:** Only site admins can query a site member's memberships. Site members can query their memberships. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query a site member's memberships.
+ *
+ * The `queryMemberships()` function builds a query to retrieve a list of all memberships, and returns a [MembershipsQueryBuilder](wix-groups-backend/members/membershipsquerybuilder) object.
+ *
+ * The returned object contains the query definition which is typically used to run the query using the [`find()`](wix-groups-backend/members/membershipsquerybuilder/find) function.
+ *
+ * You can refine the query by chaining `GroupMembersQueryBuilder` functions onto the query. `GroupMembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryMemberships()` returns.
+ *
+ * The results of the `queryMemberships()` function are sorted by `groupId` in descending order.
+ *
+ * `queryMemberships()` runs with this `GroupMembersQueryBuilder` default, which you can override:
+ * + [`limit(100)`](wix-groups-backend/members/membershipsquerybuilder/limit)
+ *
+ * The following `GroupMembersQueryBuilder` functions are supported for `queryMemberships()`. For a full description of the Memberships object, see the object returned for the [`items`](wix-groups-backend/members/membershipsqueryresult/items) property in [`MembershipsQueryResult`](wix-groups-backend/members/membershipsqueryresult).
  *
- * Supported fields for filtering:
- * - `role`
- * - `status`
+ * | Property                    | Supported Filters & Sorting                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+ * | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+ * | `status`                    | [`eq()`](wix-groups-backend/members/membershipsquerybuilder/eq), [`ne()`](wix-groups-backend/members/membershipsquerybuilder/ne)             |
+ * | `role`                      | [`eq()`](wix-groups-backend/members/membershipsquerybuilder/eq), [`ne()`](wix-groups-backend/members/membershipsquerybuilder/ne)             |
  *
- * No supported fields for sorting.
- * @param memberId - Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.
  * @public
  * @documentationMaturity preview
  * @requiredField memberId
+ * @param memberId - Site member ID.
  */
 function queryMemberships(memberId, options) {
     var _a, _b, _c;