@wix/members 1.0.100 → 1.0.101

package/type-bundles/context.bundle.d.ts

@@ -1057,229 +1057,6 @@ interface Group {
     name?: string;
     type?: string;
 }
-/** Registration options. */
-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;
-}
-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$2[];
-}
-interface DialogData {
-    visitorId?: string | null;
-    appId?: string | null;
-    initiator?: string | null;
-}
-interface EmailVerification {
-    /** ID of the verification process. */
-    verificationId?: string;
-    /**
-     * 6-digit code for verification.  Code can be between 100000 and 999999.
-     *
-     */
-    otp?: string;
-}
-interface RegisterResponse {
-    /** Newly registered member. */
-    member?: Member$1;
-    /**
-     * 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;
-}
-interface Session {
-    /** Session token when the current member is logged into the site. */
-    token?: string | null;
-}
-interface EmailVerificationRequired {
-    /** ID of the verification process. */
-    verificationId?: string;
-}
-interface EmailVerificationFailed {
-    /** ID of the failed verification process.  */
-    verificationId?: string;
-    /** Reason for verification failure. */
-    verificationFailureReason?: VerificationFailureReason;
-}
-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"
-}
-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. */
-interface LoginResponse {
-    /** Session token. */
-    session?: Session;
-    /** the member's details */
-    member?: Member$1;
-}
-interface GetResetPasswordLinkRequest {
-    /** Contact ID of the member whose password will be reset. */
-    contactId?: string;
-}
-interface GetResetPasswordLinkResponse {
-    /**
-     * Reset password link.
-     * Valid for one use, up to two weeks from when it is created.
-     */
-    resetPasswordLink?: string;
-}
-interface SendSetPasswordEmailRequest {
-    /** Login email of the member whose password will be set. */
-    email: string;
-    /**
-     * @internal
-     * @internal
-     * @deprecated
-     */
-    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;
-}
-interface SendSetPasswordEmailResponse {
-    /** Indicates if the request was successfully received. */
-    accepted?: boolean;
-}
-interface ResetPasswordRequest {
-    /** Contact ID of the member whose password will be reset. */
-    contactId?: string;
-}
-interface ResetPasswordResponse {
-    /** Indicates if the request was successfully received. */
-    accepted?: boolean;
-}
-interface SocialLoginRequest extends SocialLoginRequestLoginOneOf {
-    appleLogin?: AppleLogin;
-    googleLogin?: GoogleLogin;
-    facebookLogin?: FacebookLogin;
-    /** Must either pass explicit msid OR signed instance with visitor */
-    metaSiteId?: string | null;
-}
-/** @oneof */
-interface SocialLoginRequestLoginOneOf {
-    appleLogin?: AppleLogin;
-    googleLogin?: GoogleLogin;
-    facebookLogin?: FacebookLogin;
-}
-interface AppleLogin {
-    /** JWT signed by apple, contains target (aud), email etc */
-    token?: string;
-}
-interface GoogleLogin {
-    /** JWT signed by Google, contains target (aud), email etc */
-    token?: string;
-}
-interface FacebookLogin {
-    /** AccessToken created by Facebook, used to later fetch details over API */
-    token?: string;
-}
 interface ListMembersRequest$1 {
     /** for paging - maximum number of records to retrieve */
     limit?: number;
@@ -1510,6 +1287,10 @@ interface ApproveMemberResponse$1 {
     /** Approval session token. */
     session?: Session;
 }
+interface Session {
+    /** Session token when the current member is logged into the site. */
+    token?: string | null;
+}
 interface BlockMemberRequest$2 extends BlockMemberRequestMemberIdentifierOneOf {
     /** ID of the member to block. */
     _id?: string;
@@ -1538,44 +1319,21 @@ interface MakeMemberOfflineRequest {
 }
 interface MakeMemberOfflineResponse {
 }
-interface CustomFieldNonNullableFields$1 {
-    numValue: number;
-    name: string;
-}
-interface GroupNonNullableFields {
-    _id: string;
-    name: string;
-    type: string;
-}
-interface MemberNonNullableFields$1 {
-    _id: string;
-    emailVerified: boolean;
-    role: Role$1;
-    profilePrivacyStatus: SiteMemberPrivacyStatus;
-    status: SiteMemberStatus;
-    emails: string[];
-    phones: string[];
-    labels: string[];
-    customFields: CustomFieldNonNullableFields$1[];
-    picture: string;
-    groups: GroupNonNullableFields[];
-}
-interface RegisterResponseNonNullableFields {
-    member?: MemberNonNullableFields$1;
-}
-interface LoginResponseNonNullableFields {
-    member?: MemberNonNullableFields$1;
-}
-interface SendSetPasswordEmailResponseNonNullableFields {
-    accepted: boolean;
-}
-interface ChangeLoginEmailResponseNonNullableFields {
-    member?: MemberNonNullableFields$1;
-}
-interface RegisterOptions {
+/** Registration options. */
+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
+     * @internal */
     dialogData?: DialogData;
     /**
      * Sets the privacy status of a new member upon registration.
@@ -1585,30 +1343,147 @@ interface RegisterOptions {
      * - `UNKNOWN`: Insufficient permissions to get the status.
      */
     profilePrivacyStatus?: SiteMemberPrivacyStatus;
-    /** @internal */
+    /**
+     * @internal
+     * @internal */
     isOfflineRegistration?: boolean;
-    /** @internal */
+    /**
+     * @internal
+     * @internal */
     recaptchaToken?: string | null;
-    /** @internal */
+    /**
+     * @internal
+     * @internal */
     invisibleRecaptchaToken?: string | null;
     /**
-     * Email verification.
+     * @internal
      * @internal */
     emailVerification?: EmailVerification;
-    /** @internal */
+    /**
+     * @internal
+     * @internal */
     isMobile?: boolean | null;
 }
-interface LoginOptions {
-    /** @internal */
+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$2[];
+}
+interface DialogData {
+    visitorId?: string | null;
+    appId?: string | null;
+    initiator?: string | null;
+}
+interface EmailVerification {
+    /** ID of the verification process. */
+    verificationId?: string;
+    /**
+     * 6-digit code for verification.  Code can be between 100000 and 999999.
+     *
+     */
+    otp?: string;
+}
+interface RegisterResponse {
+    /** Newly registered member. */
+    member?: Member$1;
+    /**
+     * 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;
+}
+interface EmailVerificationRequired {
+    /** ID of the verification process. */
+    verificationId?: string;
+}
+interface EmailVerificationFailed {
+    /** ID of the failed verification process.  */
+    verificationId?: string;
+    /** Reason for verification failure. */
+    verificationFailureReason?: VerificationFailureReason;
+}
+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"
+}
+interface LoginRequest {
+    /** Login email address. */
+    email?: string;
+    /** Member password. */
+    password?: string;
+    /**
+     * @internal
+     * @internal */
     recaptchaToken?: string;
-    /** @internal */
+    /**
+     * @internal
+     * @internal */
     invisibleRecaptchaToken?: string;
-    /** @internal */
+    /**
+     * @internal
+     * @internal */
     emailVerification?: EmailVerification;
-    /** @internal */
+    /**
+     * @internal
+     * @internal */
     isMobile?: boolean | null;
 }
-interface SendSetPasswordEmailOptions {
+/** Session token for logging the member in. */
+interface LoginResponse {
+    /** Session token. */
+    session?: Session;
+    /** the member's details */
+    member?: Member$1;
+}
+interface GetResetPasswordLinkRequest {
+    /** Contact ID of the member whose password will be reset. */
+    contactId?: string;
+}
+interface GetResetPasswordLinkResponse {
+    /**
+     * Reset password link.
+     * Valid for one use, up to two weeks from when it is created.
+     */
+    resetPasswordLink?: string;
+}
+interface SendSetPasswordEmailRequest {
+    /** Login email of the member whose password will be set. */
+    email: string;
     /**
      * @internal
      * @internal
@@ -1626,6 +1501,77 @@ interface SendSetPasswordEmailOptions {
      */
     hideIgnoreMessage?: boolean;
 }
+interface SendSetPasswordEmailResponse {
+    /** Indicates if the request was successfully received. */
+    accepted?: boolean;
+}
+interface ResetPasswordRequest {
+    /** Contact ID of the member whose password will be reset. */
+    contactId?: string;
+}
+interface ResetPasswordResponse {
+    /** Indicates if the request was successfully received. */
+    accepted?: boolean;
+}
+interface SocialLoginRequest extends SocialLoginRequestLoginOneOf {
+    appleLogin?: AppleLogin;
+    googleLogin?: GoogleLogin;
+    facebookLogin?: FacebookLogin;
+    /** Must either pass explicit msid OR signed instance with visitor */
+    metaSiteId?: string | null;
+}
+/** @oneof */
+interface SocialLoginRequestLoginOneOf {
+    appleLogin?: AppleLogin;
+    googleLogin?: GoogleLogin;
+    facebookLogin?: FacebookLogin;
+}
+interface AppleLogin {
+    /** JWT signed by apple, contains target (aud), email etc */
+    token?: string;
+}
+interface GoogleLogin {
+    /** JWT signed by Google, contains target (aud), email etc */
+    token?: string;
+}
+interface FacebookLogin {
+    /** AccessToken created by Facebook, used to later fetch details over API */
+    token?: string;
+}
+interface CustomFieldNonNullableFields$1 {
+    numValue: number;
+    name: string;
+}
+interface GroupNonNullableFields {
+    _id: string;
+    name: string;
+    type: string;
+}
+interface MemberNonNullableFields$1 {
+    _id: string;
+    emailVerified: boolean;
+    role: Role$1;
+    profilePrivacyStatus: SiteMemberPrivacyStatus;
+    status: SiteMemberStatus;
+    emails: string[];
+    phones: string[];
+    labels: string[];
+    customFields: CustomFieldNonNullableFields$1[];
+    picture: string;
+    groups: GroupNonNullableFields[];
+}
+interface ChangeLoginEmailResponseNonNullableFields {
+    member?: MemberNonNullableFields$1;
+}
+interface RegisterResponseNonNullableFields {
+    member?: MemberNonNullableFields$1;
+}
+interface LoginResponseNonNullableFields {
+    member?: MemberNonNullableFields$1;
+}
+interface SendSetPasswordEmailResponseNonNullableFields {
+    accepted: boolean;
+}
 interface ChangeLoginEmailOptions {
     /**
      * @internal
@@ -1650,51 +1596,61 @@ interface BlockOptions extends BlockMemberRequestMemberIdentifierOneOf {
      * @internal */
     source?: Source;
 }
-
-declare function register$1(httpClient: HttpClient): RegisterSignature;
-interface RegisterSignature {
+interface RegisterOptions {
+    /** Contact information for the registered member. */
+    contactInfo?: MemberContactInfo;
+    /** @internal */
+    dialogData?: DialogData;
     /**
-     * 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 - Login email address for the new site member.
-     * @param - Password the new site member will use to log in.
+     * Sets the privacy status of a new member upon registration.
      *
-     * Must be 4 to 15 ASCII-printable characters.
-     * @param - Options for registering a new member.
+     * - `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.
      */
-    (email: string, password: string, options?: RegisterOptions | undefined): Promise<RegisterResponse & RegisterResponseNonNullableFields>;
+    profilePrivacyStatus?: SiteMemberPrivacyStatus;
+    /** @internal */
+    isOfflineRegistration?: boolean;
+    /** @internal */
+    recaptchaToken?: string | null;
+    /** @internal */
+    invisibleRecaptchaToken?: string | null;
+    /**
+     * Email verification.
+     * @internal */
+    emailVerification?: EmailVerification;
+    /** @internal */
+    isMobile?: boolean | null;
 }
-declare function login$1(httpClient: HttpClient): LoginSignature;
-interface LoginSignature {
+interface LoginOptions {
+    /** @internal */
+    recaptchaToken?: string;
+    /** @internal */
+    invisibleRecaptchaToken?: string;
+    /** @internal */
+    emailVerification?: EmailVerification;
+    /** @internal */
+    isMobile?: boolean | null;
+}
+interface SendSetPasswordEmailOptions {
     /**
-     * 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 - Login email address.
-     * @param - Member password.
-     * @param - Options for logging in a member.
-     * @returns Session token for logging the member in.
+     * @internal
+     * @internal
+     * @deprecated
      */
-    (email: string, password: string, options?: LoginOptions | undefined): Promise<LoginResponse & LoginResponseNonNullableFields>;
-}
-declare function sendSetPasswordEmail$1(httpClient: HttpClient): SendSetPasswordEmailSignature;
-interface SendSetPasswordEmailSignature {
+    requestedByMember?: boolean;
     /**
-     * Sends a site member an email with a link to set their password.
+     * Whether to hide the ignore this email message .
      *
-     * 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 - Login email of the member whose password will be set.
-     * @param - Email display options.
+     * If `true`, the email tells the member
+     * they can safely ignore
+     * if they did not request the password change.
+     *
+     * Default: `false`.
      */
-    (email: string, options?: SendSetPasswordEmailOptions | undefined): Promise<SendSetPasswordEmailResponse & SendSetPasswordEmailResponseNonNullableFields>;
+    hideIgnoreMessage?: boolean;
 }
+
 declare function changeLoginEmail$1(httpClient: HttpClient): ChangeLoginEmailSignature;
 interface ChangeLoginEmailSignature {
     /**
@@ -1739,13 +1695,57 @@ interface BlockSignature {
      */
     (options?: BlockOptions | undefined): Promise<void>;
 }
+declare function register$1(httpClient: HttpClient): RegisterSignature;
+interface RegisterSignature {
+    /**
+     * 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 - Login email address for the new site member.
+     * @param - Password the new site member will use to log in.
+     *
+     * Must be 4 to 15 ASCII-printable characters.
+     * @param - Options for registering a new member.
+     */
+    (email: string, password: string, options?: RegisterOptions | undefined): Promise<RegisterResponse & RegisterResponseNonNullableFields>;
+}
+declare function login$1(httpClient: HttpClient): LoginSignature;
+interface LoginSignature {
+    /**
+     * 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 - Login email address.
+     * @param - Member password.
+     * @param - Options for logging in a member.
+     * @returns Session token for logging the member in.
+     */
+    (email: string, password: string, options?: LoginOptions | undefined): Promise<LoginResponse & LoginResponseNonNullableFields>;
+}
+declare function sendSetPasswordEmail$1(httpClient: HttpClient): SendSetPasswordEmailSignature;
+interface SendSetPasswordEmailSignature {
+    /**
+     * 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 - Login email of the member whose password will be set.
+     * @param - Email display options.
+     */
+    (email: string, options?: SendSetPasswordEmailOptions | undefined): Promise<SendSetPasswordEmailResponse & SendSetPasswordEmailResponseNonNullableFields>;
+}
 
-declare const register: BuildRESTFunction<typeof register$1> & typeof register$1;
-declare const login: BuildRESTFunction<typeof login$1> & typeof login$1;
-declare const sendSetPasswordEmail: BuildRESTFunction<typeof sendSetPasswordEmail$1> & typeof sendSetPasswordEmail$1;
 declare const changeLoginEmail: BuildRESTFunction<typeof changeLoginEmail$1> & typeof changeLoginEmail$1;
 declare const approve: BuildRESTFunction<typeof approve$1> & typeof approve$1;
 declare const block: BuildRESTFunction<typeof block$1> & typeof block$1;
+declare const register: BuildRESTFunction<typeof register$1> & typeof register$1;
+declare const login: BuildRESTFunction<typeof login$1> & typeof login$1;
+declare const sendSetPasswordEmail: BuildRESTFunction<typeof sendSetPasswordEmail$1> & typeof sendSetPasswordEmail$1;
 
 type context$7_AppleLogin = AppleLogin;
 type context$7_ApproveMemberRequestMemberIdentifierOneOf = ApproveMemberRequestMemberIdentifierOneOf;