import { RequestOptionsFactory } from '@wix/sdk-types'; /** * Updates the currently logged in member's slug. * * The `slug` is the end of a member's URL that refers to a specific logged-in member. For example, if a member's URL is `https://example.com/member/{my-member-slug}`, the slug is `my-member-slug`. The slug is case-sensitive and is generally derived from the member's `nickname`; otherwise, it's derived from the `loginEmail`. * * > **Note:** * > Only logged-in members can call this function without elevated permissions. * > To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required. */ export declare function updateMySlug(payload: object): RequestOptionsFactory; /** Updates the member's slug. */ export declare function updateMemberSlug(payload: object): RequestOptionsFactory; /** * Joins the currently logged-in member to the site community and sets their profile to public. * * When a member's profile is public, they have access to the site's * [Members Area](https://support.wix.com/en/article/about-members-area) * features — such as chat, forum, and followers — * and their profile is visible to other members and site visitors. * * > **Note:** * > Only logged-in members can call this function without elevated permissions. * > To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required. */ export declare function joinCommunity(payload: object): RequestOptionsFactory; /** * Removes the currently logged-in member from the site community and sets their profile to private. * * When a member's profile is private, * they do not have access to the site's * [Members Area](https://support.wix.com/en/article/about-members-area) * features — such as chat, forum, and followers — * and their profile is hidden from other members and site visitors. * * > **Notes:** * > + If a member leaves the site's community, their content (such as forum posts and blog comments) remain publicly visible. * * > + Only logged-in members can call this function without elevated permissions. * > + To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required. */ export declare function leaveCommunity(payload: object): RequestOptionsFactory; /** Retrieves the currently logged-in member. */ export declare function getMyMember(payload: object): RequestOptionsFactory; /** * Retrieves a member by ID. * * >**Note:** The returned Member object contains only the fields that were explicitly added to the Member object. Custom Contact fields are **not** automatically added to the Member object. They must be [added to the Member object by the site owner](https://support.wix.com/en/article/site-members-customizing-your-member-profile-fields). * */ export declare function getMember(payload: object): RequestOptionsFactory; /** * Lists site members, given the provided paging and fieldsets. * * - `PUBLIC` fieldset returns `id` and `profile` object. `status`, `privacyStatus` and `activityStatus` are returned as `UNKNOWN`. * - `FULL` fieldset returns all fields. */ export declare function listMembers(payload: object): RequestOptionsFactory; /** * Retrieves a list of up to 100 members, given the provided filters, fieldsets, sorting and paging, and returns a `MembersQueryBuilder` object. * * The returned object contains the query definition which is typically used to run the query using the `find()` function. * * You can refine the query by chaining `MembersQueryBuilder` functions onto the query. `MembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryMembers()` returns. The functions that are chained to `queryMembers()` are applied in the order they are called. * * `queryMembers()` runs with the following `MembersQueryBuilder` defaults that you can override: * - `skip`: `0` * - `limit`: `50` * * Currently supported fields for sorting: * - `profile.nickname` * - `contact.firstName` * - `contact.lastName` * - `createdDate` * - `lastLoginDate` * * The following `MembersQueryBuilder` functions are supported for the `queryMembers()` function. For a full description of the Locations object, see the returned for the `items` property in `MembersQueryResult`. */ export declare function queryMembers(payload: object): RequestOptionsFactory; /** * Mutes a member. * * Muted members can't engage with a community. For example, leave comments, like, and share posts or comments. * * 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). */ export declare function muteMember(payload: object): RequestOptionsFactory; /** * Unmutes a member. * * Unmuted members can engage with the comunity. For example, leave comments, like, and share posts. * * 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). */ export declare function unmuteMember(payload: object): RequestOptionsFactory; /** * Changes member status to `APPROVED` and gives access to members-only pages. * * Call this API to: * - Approve a pending member. * - Unblock a blocked member. */ export declare function approveMember(payload: object): RequestOptionsFactory; /** * Blocks a member. * * A blocked member can't log in to members-only pages. * * To unblock a member, call Approve Member. */ export declare function blockMember(payload: object): RequestOptionsFactory; /** * Disconnects a member. * * A disconnected member can't log in to members-only pages, and the member isn't visible in the dashboard. * * >**Note:** This action is irreversible. To connect the same member again, you have to create a member with a new slug. */ export declare function disconnectMember(payload: object): RequestOptionsFactory; /** * Deletes a member. * * The `deleteMember()` function returns a Promise that resolves to a member object when the specified member is deleted. * * >**Note:** This function permanently deletes a member. Once deleted, a member cannot be restored. */ export declare function deleteMember(payload: object): RequestOptionsFactory; /** * Deletes the currently logged in member. * * After calling this method, the member is logged out of the site. * * All content created by this member is transferred to another account. For example, if a Wix user had blog posts, those posts are transferred to the specified account, which then becomes the owner of those posts. * * >**Note:** * >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities). */ export declare function deleteMyMember(payload: object): RequestOptionsFactory; /** * 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. */ export declare function bulkDeleteMembers(payload: object): RequestOptionsFactory; /** * 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. */ export declare function bulkDeleteMembersByFilter(payload: object): RequestOptionsFactory; /** * Changes status of multiple members to `APPROVED`, and gives access to members-only pages. * * Call this API to: * - Approve pending members. * - Unblock blocked members. */ export declare function bulkApproveMembers(payload: object): RequestOptionsFactory; /** * Blocks multiple members by a specified filter. * * Blocked members can't log in to members-only pages. * * To unblock multiple members, call Bulk Approve Members. */ export declare function bulkBlockMembers(payload: object): RequestOptionsFactory; /** * Creates a site member. * * After creation, you can use the `sendSetPasswordEmail()` function in the Members Authentication API to email the member with a link to set their password. * The member can log in to the site once they set their password for the first time. * * > **Note:** * > When creating multiple members, set your requests at least 1 second apart to keep below rate limits. */ export declare function createMember(payload: object): RequestOptionsFactory; /** * Updates a member's properties. * * Only the requested fields are updated. * To clear a field's value, set an empty value with an empty string `""`. * * > **Note:** * > Updating the `contact.addresses`, `contact.emails`, or `contact.phones` array overwrites the entire array, so any existing values you want to retain must be passed in the `updateMember()` call along with the new values to add. * > However, passing an empty array will have no effect, and these functions must be used to clear all data from the respective array: * >- To clear `contact.addresses`, use `deleteMemberAddresses()`. * >- To clear `contact.emails`, use `deleteMemberEmails()`. * >- To clear `contact.phones`, use `deleteMemberPhones()`. * * > **Note:** * > Only logged-in members can call this function without elevated permissions. * > To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required. */ export declare function updateMember(payload: object): RequestOptionsFactory; /** * Clears a member's phone numbers. * * The `deleteMemberPhones()` function clears the `phones` array under the `contact` property. * * > **Note:** * > Only logged-in members can call this function without elevated permissions. * > To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required. */ export declare function deleteMemberPhones(payload: object): RequestOptionsFactory; /** * Clears a member's email addresses. * * The `deleteMemberEmails()` function clears the `emails` array under the `contact` property. * * > **Notes:** * > A member can still log in with their `loginEmail`, * > which is not cleared when this function is called. * * > Only logged-in members can call this function without elevated permissions. * > To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required. */ export declare function deleteMemberEmails(payload: object): RequestOptionsFactory; /** * Deletes a member's street addresses. * * The `deleteMemberAddresses()` function clears the `addresses` array under the `contact` property. * * > **Note:** * > Only logged-in members can call this function without elevated permissions. * > To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required. */ export declare function deleteMemberAddresses(payload: object): RequestOptionsFactory;