@wix/auto_sdk_members_members 1.0.91 → 1.0.93

package/build/internal/es/index.typings.d.mts

@@ -1,5 +1,9 @@
 import { QuerySpec, Query as Query$1, NonNullablePaths } from '@wix/sdk-types';
 
+/**
+ * A registered user of a Wix site who can log in, access member-only content, and participate in site activities.
+ * Members have profiles, contact information, and can interact with site features such as forums, blogs, and community features.
+ */
 interface Member {
     /**
      * Member ID.
@@ -1787,6 +1791,8 @@ declare function updateCurrentMemberSlug(slug: string): Promise<NonNullablePaths
 }>;
 /**
  * Updates a member's slug.
+ *
+ * To update the current member's slug, call [Update My Slug](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/update-my-slug).
  * @param _id - Member ID.
  * @param slug - New slug.
  * @public
@@ -1848,6 +1854,8 @@ declare function leaveCommunity(): Promise<NonNullablePaths<LeaveCommunityRespon
  *
  * >**Note:**
  * >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
+ *
+ * To retrieve a member by `ID`, call [Get Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/get-member).
  * @public
  * @permissionId MEMBERS.MEMBER_READ
  * @applicableIdentity APP
@@ -2058,6 +2066,8 @@ type MemberQuery = {
  * Muted members can't engage with a community. For example, they can't leave comments, like posts or comments, or share content.
  *
  * You can mute members in [Wix Blog](https://dev.wix.com/docs/rest/business-solutions/blog/introduction) and [Wix Forum](https://dev.wix.com/docs/rest/business-solutions/forum/introduction).
+ *
+ * To unmute a member, call [Unmute Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/unmute-member).
  * @param _id - ID of the member to mute.
  * @public
  * @requiredField _id
@@ -2072,6 +2082,8 @@ declare function muteMember(_id: string): Promise<NonNullablePaths<MuteMemberRes
  * Unmuted members can engage with the community. For example, leave comments, like posts or comments, and share content.
  *
  * You can unmute members in [Wix Blog](https://dev.wix.com/docs/rest/business-solutions/blog/introduction) and [Wix Forum](https://dev.wix.com/docs/rest/business-solutions/forum/introduction).
+ *
+ * To mute a member, call [Mute Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/mute-member).
  * @param _id - ID of the member to unmute.
  * @public
  * @requiredField _id
@@ -2086,6 +2098,10 @@ declare function unmuteMember(_id: string): Promise<NonNullablePaths<UnmuteMembe
  * Call this API to:
  * - Approve a pending member.
  * - Unblock a blocked member.
+ *
+ * To approve multiple members, call [Bulk Approve Members](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/bulk-approve-members).
+ *
+ * To block a member, call [Block Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/block-member).
  * @param _id - ID of the member to approve.
  * @public
  * @requiredField _id
@@ -2099,7 +2115,9 @@ declare function approveMember(_id: string): Promise<NonNullablePaths<ApproveMem
  *
  * A blocked member can't log in to members-only pages.
  *
- * To unblock a member, call Approve Member.
+ * To block multiple members, call [Bulk Block Members](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/bulk-block-members).
+ *
+ * To unblock a member, call [Approve Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/approve-member).
  * @param _id - ID of a member to block.
  * @public
  * @requiredField _id
@@ -2128,6 +2146,12 @@ declare function disconnectMember(_id: string): Promise<NonNullablePaths<Disconn
  * Deletes a member by ID.
  *
  * All content created by this member is transferred to a site owner's account. For example, if a Wix user had blog posts, those posts are transferred to the site owner's account, which then becomes the owner of those posts.
+ *
+ * To delete the current member, call [Delete My Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/delete-my-member).
+ *
+ * To delete multiple members by `memberId`, call [Bulk Delete Members](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/bulk-delete-members).
+ *
+ * To delete multiple members by a specified filter, call [Bulk Delete Members By Filter](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/bulk-delete-members-by-filter).
  * @param _id - ID of a member to delete.
  * @public
  * @requiredField _id
@@ -2147,6 +2171,12 @@ declare function deleteMember(_id: string): Promise<void & {
  *
  * >**Note:**
  * >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
+ *
+ * To delete a member by `ID`, call [Delete Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/delete-member).
+ *
+ * To delete multiple members by `memberId`, call [Bulk Delete Members](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/bulk-delete-members).
+ *
+ * To delete multiple members by a specified filter, call [Bulk Delete Members By Filter](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/bulk-delete-members-by-filter).
  * @public
  * @permissionId MEMBERS.MEMBER_DELETE
  * @applicableIdentity APP
@@ -2166,6 +2196,12 @@ interface DeleteMyMemberOptions {
  * Deletes multiple members by `memberId`.
  *
  * All content created by these members is transferred to a site owner's account. For example, if Wix users had blog posts, those posts are transferred to the site owner's account, which then becomes the owner of those posts.
+ *
+ * To delete only the current member, call [Delete My Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/delete-my-member).
+ *
+ * To delete a single member by `ID`, call [Delete Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/delete-member).
+ *
+ * To delete multiple members by a specified filter, call [Bulk Delete Members By Filter](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/bulk-delete-members-by-filter).
  * @param memberIds - IDs of members to be deleted.
  * @public
  * @requiredField memberIds
@@ -2178,6 +2214,12 @@ declare function bulkDeleteMembers(memberIds: string[]): Promise<NonNullablePath
  * Deletes multiple members by the specified filter.
  *
  * All content created by these members is transferred to a site owner's account. For example, if Wix users had blog posts, those posts are transferred to the site owner's account, which then becomes the owner of those posts.
+ *
+ * To delete only the current member, call [Delete My Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/delete-my-member).
+ *
+ * To delete a single member by `ID`, call [Delete Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/delete-member).
+ *
+ * To delete multiple members by `memberId`, call [Bulk Delete Members](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/bulk-delete-members).
  * @param filter - Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.
  * @public
  * @requiredField filter
@@ -2201,6 +2243,8 @@ interface BulkDeleteMembersByFilterOptions {
  * Call this API to:
  * - Approve pending members.
  * - Unblock blocked members.
+ *
+ * To approve a single member, call [Approve Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/approve-member).
  * @param filter - Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.
  * @public
  * @requiredField filter
@@ -2214,7 +2258,11 @@ declare function bulkApproveMembers(filter: any): Promise<NonNullablePaths<BulkA
  *
  * Blocked members can't log in to members-only pages.
  *
- * To unblock multiple members, call Bulk Approve Members.
+ * To block a single member, call [Block Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/block-member).
+ *
+ * To unblock a single member, call [Approve Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/approve-member).
+ *
+ * To unblock multiple members, call [Bulk Approve Members](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/bulk-approve-members).
  * @param filter - Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.
  * @public
  * @requiredField filter