@wix/members 1.0.65 → 1.0.67

package/build/cjs/src/identity-members-v1-member.universal.d.ts

@@ -1,894 +0,0 @@
-export interface Member {
-    /**
-     * Member ID.
-     * @readonly
-     */
-    _id?: string;
-    /**
-     * @internal
-     * @internal
-     * @readonly
-     */
-    emailVerified?: boolean;
-    /**
-     * @internal
-     * @internal */
-    role?: Role;
-    /**
-     * Email used by the member to log in to the site.
-     *
-     *
-     */
-    loginEmail?: string | null;
-    /**
-     * @internal
-     * @internal */
-    memberName?: string | null;
-    /** Member's first name. */
-    firstName?: string | null;
-    /** Member's last name. */
-    lastName?: string | null;
-    /**
-     * @internal
-     * @internal */
-    imageUrl?: string | null;
-    /** Name that identifies the member to other members. Displayed on the member's profile page and interactions in the forum or blog. */
-    nickname?: string | null;
-    /**
-     * Member privacy status.
-     *
-     * One of:
-     * - `"PUBLIC"`: Member is visible to everyone.
-     * - `"PRIVATE"`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
-     * - `"UNKNOWN"`: Insufficient permissions to get the status.
-     */
-    profilePrivacyStatus?: SiteMemberPrivacyStatus;
-    /** URL segment that determines the member's profile page. */
-    slug?: string | null;
-    /**
-     * @internal
-     * @internal */
-    language?: string | null;
-    /**
-     * Member site access status.
-     *
-     * One of:
-     * - `"PENDING"`: Member created and is waiting for approval by site owner.
-     * - `"APPROVED"`: Member can log in to the site.
-     * - "OFFLINE"`: Member is a guest author for the site blog and cannot log in to the site.
-     * - `"BLOCKED"`: Member is blocked and cannot log in to the site.
-     * - `"UNKNOWN"`: Insufficient permissions to get the status.
-     */
-    status?: SiteMemberStatus;
-    /**
-     * Date and time when the member was created.
-     * @readonly
-     */
-    creationDate?: Date;
-    /**
-     * Date and time when the member was last updated.
-     *
-     *
-     * @readonly
-     */
-    lastUpdateDate?: Date;
-    /**
-     * Date and time when the member last logged in to the site.
-     *
-     * @readonly
-     */
-    lastLoginDate?: Date;
-    /**
-     * List of email addresses.
-     *
-     *
-     */
-    emails?: string[];
-    /** List of phone numbers.  */
-    phones?: string[];
-    /** List of street addresses. */
-    addresses?: Address[];
-    /**
-     * @internal
-     * @internal */
-    labels?: string[];
-    /**
-     * Custom fields, structured as key:object pairs. Custom field keys are defined in the Contacts Extended Fields API. The paired object contains the `name` and `value` properties, where `name` is the display name and `value` is the value stored for the member.
-     *
-     * Only custom fields added to the member profile in the Dashboard are available through the Members API. Empty fields are not returned.
-     *
-     * When updating a member, `name` is ignored.
-     */
-    customFields?: CustomField[];
-    /** Member's profile picture URL. */
-    picture?: string;
-    /**
-     * @internal
-     * @internal */
-    userId?: string | null;
-    /**
-     * @internal
-     * @internal */
-    groups?: Group[];
-    /**
-     * Member's contact ID.
-     * @readonly
-     */
-    contactId?: string | null;
-}
-export declare enum Role {
-    UNDEFINED_ROLE = "UNDEFINED_ROLE",
-    MEMBER = "MEMBER",
-    OWNER = "OWNER",
-    CONTRIBUTOR = "CONTRIBUTOR"
-}
-export declare enum SiteMemberPrivacyStatus {
-    UNDEFINED = "UNDEFINED",
-    PUBLIC = "PUBLIC",
-    PRIVATE = "PRIVATE",
-    COMMUNITY = "COMMUNITY"
-}
-export declare enum SiteMemberStatus {
-    UNDEFINED_STATUS = "UNDEFINED_STATUS",
-    APPLICANT = "APPLICANT",
-    ACTIVE = "ACTIVE",
-    INACTIVE = "INACTIVE",
-    BLOCKED = "BLOCKED",
-    OFFLINE_ONLY = "OFFLINE_ONLY"
-}
-export interface Address {
-    /** Street address. */
-    street?: string | null;
-    /** City name. */
-    city?: string | null;
-    /** Region name. */
-    region?: string | null;
-    /** 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
-    country?: string | null;
-    /** Postal code. */
-    postalCode?: string | null;
-}
-export interface CustomField extends CustomFieldValueOneOf {
-    /** String value. */
-    strValue?: string | null;
-    /** Number value. */
-    numValue?: number;
-    /** Date value. */
-    dateValue?: Date;
-    /** Display name. */
-    name?: string;
-}
-/** @oneof */
-export interface CustomFieldValueOneOf {
-    strValue?: string | null;
-    numValue?: number;
-    dateValue?: Date;
-}
-export interface Group {
-    _id?: string;
-    name?: string;
-    type?: string;
-}
-export interface ListMembersRequest {
-    /** for paging - maximum number of records to retrieve */
-    limit?: number;
-    /** for paging - how many records to skip */
-    offset?: number;
-    /** sort order - list of field and direction tuples. e.g. `["first_name:asc", "last_name:desc"]` */
-    order?: string[];
-    /** partial response request - list of field names to get back in response */
-    fields?: string[];
-    /** filter members with specific status */
-    status?: SiteMemberStatus;
-    /** whether to include contact details */
-    includeContactDetails?: boolean;
-}
-export interface ListMembersResponse {
-    /** members returned by List request */
-    members?: Member[];
-    /** pagination information */
-    pagination?: PaginationResponse;
-}
-export interface PaginationResponse {
-    /** offset that was applied to the request */
-    offset?: number;
-    /** limit that was applied to the request */
-    limit?: number;
-    /** total rows available */
-    total?: number;
-    /** indication that the total count was too expensive to calculate */
-    tooManyToCount?: boolean;
-}
-export interface SearchRequest {
-    /** paging - offset and limit */
-    paging?: Paging;
-    /** search by field */
-    searchBy?: SearchBy;
-    /** partial response request - list of field names to get back in response */
-    fields?: string[];
-    /** filters */
-    filterBy?: FilterBy;
-    /** ASC or DESC order */
-    sort?: Sorting;
-}
-export interface Paging {
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-export interface SearchBy {
-    /** nick name filter */
-    nickname?: string | null;
-}
-export interface FilterBy {
-    /** filter members with specific status */
-    status?: string | null;
-    /** group Id filter */
-    groupId?: string | null;
-    /** privacy status filter */
-    privacyStatus?: SiteMemberPrivacyStatus;
-    /** roles filter */
-    roles?: Role[];
-}
-export declare enum Sorting {
-    DESC = "DESC",
-    ASC = "ASC"
-}
-export interface SearchResponse {
-    /** members returned by List request */
-    members?: Member[];
-    /** pagination information */
-    pagination?: PaginationResponse;
-}
-export interface GetCurrentMemberRequest {
-}
-export interface GetMemberResponse {
-    member?: Member;
-}
-export interface GetMemberRequest {
-    /** unique identifier of the requested member(required) */
-    _id?: string;
-    /** whether to include contact details */
-    includeContactDetails?: boolean;
-    /** whether to include groups details */
-    includeGroupsDetails?: boolean;
-}
-export interface GetUserMembershipsRequest {
-    /** unique identifier of the requested **Wix** user */
-    userId?: string;
-    /** paging - offset and limit ( the max limit for page is 200) */
-    paging?: Paging;
-}
-export interface GetUserMembershipsResponse {
-    /** sequence of member's of the user with there metaSiteId */
-    userMemberships?: UserMembership[];
-}
-export interface UserMembership {
-    /** member id */
-    memberId?: string;
-    /** meta site id whom the member existing on */
-    metasiteId?: string;
-}
-export interface GetMemberRoleRequest {
-    _id?: string;
-}
-export interface GetMemberRoleResponse {
-    /**
-     * member's role:
-     *
-     * `OWNER` - member that belongs to site owner
-     * `CONTRIBUTOR` - member that belongs to a contributor in site
-     * `MEMBER` - other members that registered to site
-     */
-    role?: Role;
-    userId?: string | null;
-    status?: SiteMemberStatus;
-    contactId?: string | null;
-}
-export interface GetMemberRolesRequest {
-    /** user_id and/or contact_id */
-    ids?: string[];
-}
-export interface GetMemberRolesResponse {
-    idsToRoles?: Record<string, MemberRole>;
-}
-export interface MemberRole {
-    /**
-     * member's role:
-     *
-     * `OWNER` - member that belongs to site owner
-     * `CONTRIBUTOR` - member that belongs to a contributor in site
-     * `MEMBER` - other members that registered to site
-     */
-    role?: Role;
-    userId?: string | null;
-    status?: SiteMemberStatus;
-    contactId?: string | null;
-}
-export interface BatchGetMembersRequest {
-    /** unique identifier of the requested member(required) */
-    ids?: string[];
-    /** whether to include contact details */
-    includeContactDetails?: boolean;
-    /** whether to include groups details */
-    includeGroupsDetails?: boolean;
-}
-export interface BatchGetMembersResponse {
-    /** lest of members details */
-    members?: Member[];
-}
-export interface GetAuthorizedPagesRequest {
-    _id?: string;
-    siteId?: string;
-}
-export interface GetAuthorizedPagesResponse {
-    authorizedPages?: Record<string, string>;
-}
-export interface UpdateMemberRequest {
-    /** member id */
-    _id?: string;
-    /** the Member object containing the fields to update */
-    member?: Member;
-}
-export interface UpdateMemberResponse {
-    /** updated member */
-    member?: Member;
-}
-export interface ChangeLoginEmailRequest {
-    /** Member ID. */
-    _id: string;
-    /** New login email address. */
-    newEmail?: string;
-    /**
-     * @internal
-     * @internal */
-    revokeCurrentSessions?: boolean | null;
-}
-export interface ChangeLoginEmailResponse {
-    /** Member with the updated login email address. */
-    member?: Member;
-}
-export interface QueryMembersRequest {
-    /**
-     * query - See https://github.com/wix-private/platformization-guidelines/blob/master/Server/API-Query.md
-     * supported fields: `id`, `login_email`, `status`, `language`, `date_created`, `last_update_date`, `flags`, `name`, `first_name`, `last_name`, `nickname`, `email_verified`, `privacy_status`
-     */
-    query?: string;
-    /** whether to include contact details */
-    includeContactDetails?: boolean;
-    /** whether to include offline members */
-    includeOfflineMembers?: boolean;
-}
-export interface QueryMembersResponse {
-    /** members matching the query criteria */
-    members?: Member[];
-    /** pagination information */
-    pagination?: PaginationResponse;
-}
-export interface DeleteMemberRequest {
-    /** id of member that should be deleted (required) */
-    _id?: string;
-    /** defines if the request is a bulk action */
-    isBulkAction?: boolean;
-}
-export interface DeleteMemberResponse {
-}
-export interface ApproveMemberRequest extends ApproveMemberRequestMemberIdentifierOneOf {
-    /** ID of the member to approve. */
-    _id?: string;
-    /** Login email address of the member to approve. */
-    email?: string;
-    /** Approval token returned by the [`register()`](#register) function. */
-    token?: string;
-}
-/** @oneof */
-export interface ApproveMemberRequestMemberIdentifierOneOf {
-    /** ID of the member to approve. */
-    _id?: string;
-    /** Login email address of the member to approve. */
-    email?: string;
-    /**
-     * <!--ONLY:VELO
-     * Approval token returned by `register()`.
-     * <!--END:ONLY:VELO-->
-     */
-    token?: string;
-}
-export interface ApproveMemberResponse {
-    /** Approval session token. */
-    session?: Session;
-}
-export interface Session {
-    /** Session token when the current member is logged into the site. */
-    token?: string | null;
-}
-export interface BlockMemberRequest extends BlockMemberRequestMemberIdentifierOneOf {
-    /** ID of the member to block. */
-    _id?: string;
-    /** Login email address of the member to block. */
-    email?: string;
-    /**
-     * @internal
-     * @internal */
-    source?: Source;
-}
-/** @oneof */
-export interface BlockMemberRequestMemberIdentifierOneOf {
-    _id?: string;
-    /** Login email address of the member to block. */
-    email?: string;
-}
-export declare enum Source {
-    UNKNOWN = "UNKNOWN",
-    HANDLING_SPAM = "HANDLING_SPAM"
-}
-export interface BlockMemberResponse {
-}
-export interface MakeMemberOfflineRequest {
-    /** unique identifier of the requested member */
-    _id?: string;
-}
-export interface MakeMemberOfflineResponse {
-}
-/** Registration options. */
-export interface RegisterRequest {
-    /** Login email address for the new site member. */
-    email?: string;
-    /**
-     * Password the new site member will use to log in.
-     *
-     * Must be 4 to 15 ASCII-printable characters.
-     */
-    password?: string;
-    /** Contact information for the registered member. */
-    contactInfo?: MemberContactInfo;
-    /**
-     * @internal
-     * @internal */
-    dialogData?: DialogData;
-    /**
-     * Sets the privacy status of a new member upon registration.
-     *
-     * - `PUBLIC`: Member is visible to everyone.
-     * - `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
-     * - `UNKNOWN`: Insufficient permissions to get the status.
-     */
-    profilePrivacyStatus?: SiteMemberPrivacyStatus;
-    /**
-     * @internal
-     * @internal */
-    isOfflineRegistration?: boolean;
-    /**
-     * @internal
-     * @internal */
-    recaptchaToken?: string | null;
-    /**
-     * @internal
-     * @internal */
-    invisibleRecaptchaToken?: string | null;
-    /**
-     * @internal
-     * @internal */
-    emailVerification?: EmailVerification;
-    /**
-     * @internal
-     * @internal */
-    isMobile?: boolean | null;
-}
-export interface MemberContactInfo {
-    /** First name. */
-    firstName?: string | null;
-    /** Last name. */
-    lastName?: string | null;
-    /** Contact's profile picture. */
-    picture?: string | null;
-    /** Contact's email addresses. */
-    emails?: string[];
-    /** Contact's phone numbers. */
-    phones?: string[];
-    /** List of contact's labels. */
-    labels?: string[];
-    /**
-     * @internal
-     * @internal */
-    locale?: string | null;
-    /**
-     * Any number of custom fields.
-     * [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
-     * are used to store additional information about your site's contacts.
-     * When setting a custom field, use key:value pairs,
-     * where the key matches the names defined in your site's
-     * [Contact List](https://support.wix.com/en/article/accessing-your-contact-list).
-     * You can only set values for custom fields that already exist in the Contacts application.
-     */
-    customFields?: CustomField[];
-}
-export interface DialogData {
-    visitorId?: string | null;
-    appId?: string | null;
-    initiator?: string | null;
-}
-export interface EmailVerification {
-    /** ID of the verification process. */
-    verificationId?: string;
-    /**
-     * 6-digit code for verification.  Code can be between 100000 and 999999.
-     *
-     */
-    otp?: string;
-}
-export interface RegisterResponse {
-    /** Newly registered member. */
-    member?: Member;
-    /**
-     * in case the site is open for registration, all members are automatically
-     * approved. they will get a temporary token for obtaining a valid session
-     */
-    session?: Session;
-    /**
-     * in case the site requires members approval, the registered member
-     * will be an applicant until he's approved. the token can be used as a member
-     * identifier for approval using the `MembersService.Approve` API
-     */
-    approvalToken?: string | null;
-}
-export interface EmailVerificationRequired {
-    /** ID of the verification process. */
-    verificationId?: string;
-}
-export interface EmailVerificationFailed {
-    /** ID of the failed verification process.  */
-    verificationId?: string;
-    /** Reason for verification failure. */
-    verificationFailureReason?: VerificationFailureReason;
-}
-export declare enum VerificationFailureReason {
-    /** Default value - means no failure */
-    UNSPECIFIED = "UNSPECIFIED",
-    /** Bad verification code */
-    BAD_CODE = "BAD_CODE",
-    /** Verification code was not found */
-    NOT_FOUND = "NOT_FOUND",
-    /** Error while sending the code to the user */
-    SEND_CODE_ERROR = "SEND_CODE_ERROR"
-}
-export interface LoginRequest {
-    /** Login email address. */
-    email?: string;
-    /** Member password. */
-    password?: string;
-    /**
-     * @internal
-     * @internal */
-    recaptchaToken?: string;
-    /**
-     * @internal
-     * @internal */
-    invisibleRecaptchaToken?: string;
-    /**
-     * @internal
-     * @internal */
-    emailVerification?: EmailVerification;
-    /**
-     * @internal
-     * @internal */
-    isMobile?: boolean | null;
-}
-/** Session token for logging the member in. */
-export interface LoginResponse {
-    /** Session token. */
-    session?: Session;
-    /** the member's details */
-    member?: Member;
-}
-export interface GetResetPasswordLinkRequest {
-    /** Contact ID of the member whose password will be reset. */
-    contactId?: string;
-}
-export interface GetResetPasswordLinkResponse {
-    /**
-     * Reset password link.
-     * Valid for one use, up to two weeks from when it is created.
-     */
-    resetPasswordLink?: string;
-}
-export interface SendSetPasswordEmailRequest {
-    /** Login email of the member whose password will be set. */
-    email: string;
-    /**
-     * @internal
-     * @internal */
-    requestedByMember?: boolean;
-    /**
-     * Whether to hide the ignore this email message .
-     *
-     * If `true`, the email tells the member
-     * they can safely ignore
-     * if they did not request the password change.
-     *
-     * Default: `false`.
-     */
-    hideIgnoreMessage?: boolean;
-}
-export interface SendSetPasswordEmailResponse {
-    /** Indicates if the request was successfully received. */
-    accepted?: boolean;
-}
-export interface ResetPasswordRequest {
-    /** Contact ID of the member whose password will be reset. */
-    contactId?: string;
-}
-export interface ResetPasswordResponse {
-    /** Indicates if the request was successfully received. */
-    accepted?: boolean;
-}
-export interface SocialLoginRequest extends SocialLoginRequestLoginOneOf {
-    appleLogin?: AppleLogin;
-    googleLogin?: GoogleLogin;
-    facebookLogin?: FacebookLogin;
-    /** Must either pass explicit msid OR signed instance with visitor */
-    metaSiteId?: string | null;
-}
-/** @oneof */
-export interface SocialLoginRequestLoginOneOf {
-    appleLogin?: AppleLogin;
-    googleLogin?: GoogleLogin;
-    facebookLogin?: FacebookLogin;
-}
-export interface AppleLogin {
-    /** JWT signed by apple, contains target (aud), email etc */
-    token?: string;
-}
-export interface GoogleLogin {
-    /** JWT signed by Google, contains target (aud), email etc */
-    token?: string;
-}
-export interface FacebookLogin {
-    /** AccessToken created by Facebook, used to later fetch details over API */
-    token?: string;
-}
-export interface ChangeLoginEmailResponseNonNullableFields {
-    member?: {
-        _id: string;
-        emailVerified: boolean;
-        role: Role;
-        profilePrivacyStatus: SiteMemberPrivacyStatus;
-        status: SiteMemberStatus;
-        emails: string[];
-        phones: string[];
-        addresses: Address[];
-        labels: string[];
-        customFields: {
-            numValue: number;
-            name: string;
-        }[];
-        picture: string;
-        groups: {
-            _id: string;
-            name: string;
-            type: string;
-        }[];
-    };
-}
-export interface RegisterResponseNonNullableFields {
-    member?: {
-        _id: string;
-        emailVerified: boolean;
-        role: Role;
-        profilePrivacyStatus: SiteMemberPrivacyStatus;
-        status: SiteMemberStatus;
-        emails: string[];
-        phones: string[];
-        addresses: Address[];
-        labels: string[];
-        customFields: {
-            numValue: number;
-            name: string;
-        }[];
-        picture: string;
-        groups: {
-            _id: string;
-            name: string;
-            type: string;
-        }[];
-    };
-}
-export interface LoginResponseNonNullableFields {
-    member?: {
-        _id: string;
-        emailVerified: boolean;
-        role: Role;
-        profilePrivacyStatus: SiteMemberPrivacyStatus;
-        status: SiteMemberStatus;
-        emails: string[];
-        phones: string[];
-        addresses: Address[];
-        labels: string[];
-        customFields: {
-            numValue: number;
-            name: string;
-        }[];
-        picture: string;
-        groups: {
-            _id: string;
-            name: string;
-            type: string;
-        }[];
-    };
-}
-export interface SendSetPasswordEmailResponseNonNullableFields {
-    accepted: boolean;
-}
-/**
- * Changes a member's login email address.
- *
- * After running this function, the specified member can log in with the new email address. If the member uses social login (for example, Google login) and the member tries to log in with the old email address, they will be re-registered with the old email address.
- *
- * Site collaborators can use `changeLoginEmail()` to change another member's login email. Members who are not site collaborators can use `changeLoginEmail()` to change their own login email only.
- *
- * > **Note:** `changeLoginEmail()` cannot be used to change the login email of a site collaborator. Site collaborators can change their login emails from their Wix [account settings](https://manage.wix.com/account/account-settings).
- * @param _id - Member ID.
- * @param newEmail - New login email address.
- * @public
- * @documentationMaturity preview
- * @requiredField _id
- * @requiredField newEmail
- * @param options - Options for changing a login email address.
- */
-export declare function changeLoginEmail(_id: string, newEmail: string, options?: ChangeLoginEmailOptions): Promise<ChangeLoginEmailResponse & ChangeLoginEmailResponseNonNullableFields>;
-export interface ChangeLoginEmailOptions {
-    /**
-     * @internal
-     * @internal */
-    revokeCurrentSessions?: boolean | null;
-}
-/**
- * Approves a pending member using an ID, email address or approval token.
- *
- * Tokens must be approved within 30 hours of token creation.
- * Use the `approvalToken` parameter returned from the
- * [`register()`](#register) function when approving a member by `token`.
- *
- * > **Note:**
- * > A new member's status is `"PENDING"` when the site's membership policy is set to manual approval.
- * > To learn more about setting your site's membership approval policy, see
- * > [Editing Your Member Signup Settings](https://support.wix.com/en/article/editing-your-member-signup-settings-for-the-default-form).
- *
- * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
- * @public
- * @documentationMaturity preview
- * @permissionScope Manage Members
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
- * @applicableIdentity APP
- */
-export declare function approve(options?: ApproveOptions): Promise<ApproveMemberResponse>;
-export interface ApproveOptions extends ApproveMemberRequestMemberIdentifierOneOf {
-    /** ID of the member to approve. */
-    _id?: string;
-    /** Login email address of the member to approve. */
-    email?: string;
-    /** Approval token returned by the [`register()`](#register) function. */
-    token?: string;
-}
-/**
- * Blocks a member from logging in to the site using an ID or email address.
- *
- * To unblock the member and allow them to log in to the site, use the [`approve()`](#approve) function.
- * @public
- * @documentationMaturity preview
- * @param options - Options for blocking a member from logging in.
- */
-export declare function block(options?: BlockOptions): Promise<void>;
-export interface BlockOptions extends BlockMemberRequestMemberIdentifierOneOf {
-    /** ID of the member to block. */
-    _id?: string;
-    /** Login email address of the member to block. */
-    email?: string;
-    /**
-     * @internal
-     * @internal */
-    source?: Source;
-}
-/**
- * Registers a new site member.
- *
- * The specified `password` must be between 4 and 100 ASCII characters.
- *
- * >**Note:** The `register()` function behaves differently depending on your site's [member signup settings](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-members/enabling-custom-site-registration).
- * @param email - Login email address for the new site member.
- * @param password - Password the new site member will use to log in.
- *
- * Must be 4 to 15 ASCII-printable characters.
- * @public
- * @documentationMaturity preview
- * @requiredField email
- * @requiredField password
- * @param options - Options for registering a new member.
- */
-export declare function register(email: string, password: string, options?: RegisterOptions): Promise<RegisterResponse & RegisterResponseNonNullableFields>;
-export interface RegisterOptions {
-    /** Contact information for the registered member. */
-    contactInfo?: MemberContactInfo;
-    /** @internal */
-    dialogData?: DialogData;
-    /**
-     * Sets the privacy status of a new member upon registration.
-     *
-     * - `PUBLIC`: Member is visible to everyone.
-     * - `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
-     * - `UNKNOWN`: Insufficient permissions to get the status.
-     */
-    profilePrivacyStatus?: SiteMemberPrivacyStatus;
-    /** @internal */
-    isOfflineRegistration?: boolean;
-    /** @internal */
-    recaptchaToken?: string | null;
-    /** @internal */
-    invisibleRecaptchaToken?: string | null;
-    /**
-     * Email verification.
-     * @internal */
-    emailVerification?: EmailVerification;
-    /** @internal */
-    isMobile?: boolean | null;
-}
-/**
- * Logs in a registered member with an email and password.
- *
- * The `login()` function only works with existing members. To register a new member use the [`register()`](#register) function.
- *
- * To complete the login, the returned session token must be applied using the `applySessionToken()` function in the wix-members-frontend API.
- * @param email - Login email address.
- * @param password - Member password.
- * @public
- * @documentationMaturity preview
- * @requiredField email
- * @requiredField password
- * @param options - Options for logging in a member.
- * @returns Session token for logging the member in.
- */
-export declare function login(email: string, password: string, options?: LoginOptions): Promise<LoginResponse & LoginResponseNonNullableFields>;
-export interface LoginOptions {
-    /** @internal */
-    recaptchaToken?: string;
-    /** @internal */
-    invisibleRecaptchaToken?: string;
-    /** @internal */
-    emailVerification?: EmailVerification;
-    /** @internal */
-    isMobile?: boolean | null;
-}
-/**
- * Sends a site member an email with a link to set their password.
- *
- * The set password link is valid for 3 hours,
- * and it can be used only once.
- * If the link expires, the original password remains.
- * @param email - Login email of the member whose password will be set.
- * @public
- * @documentationMaturity preview
- * @requiredField email
- * @param options - Email display options.
- * @permissionScope Manage Members
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
- * @applicableIdentity APP
- * @applicableIdentity VISITOR
- */
-export declare function sendSetPasswordEmail(email: string, options?: SendSetPasswordEmailOptions): Promise<SendSetPasswordEmailResponse & SendSetPasswordEmailResponseNonNullableFields>;
-export interface SendSetPasswordEmailOptions {
-    /**
-     * @internal
-     * @internal */
-    requestedByMember?: boolean;
-    /**
-     * Whether to hide the ignore this email message .
-     *
-     * If `true`, the email tells the member
-     * they can safely ignore
-     * if they did not request the password change.
-     *
-     * Default: `false`.
-     */
-    hideIgnoreMessage?: boolean;
-}