@wix/members 1.0.20 → 1.0.22

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

@@ -13,7 +13,7 @@ export interface Member {
     /** Email used by the member to log in to the site. */
     loginEmail?: string | null;
     /**
-     * Indication of email verification status.
+     * Whether the email used by the member has been verified.
      * @readonly
      */
     loginEmailVerified?: boolean | null;
@@ -320,7 +320,7 @@ export interface URI {
 }
 export interface UpdateMySlugRequest {
     /** New slug. */
-    slug?: string;
+    slug: string;
 }
 export interface UpdateMySlugResponse {
     /** Updated member. */
@@ -959,6 +959,410 @@ export interface MemberOwnershipTransferred {
     fromMember?: Member;
     toMember?: Member;
 }
+export interface UpdateMySlugResponseNonNullableFields {
+    member?: {
+        status: Status;
+        contact?: {
+            addresses: {
+                streetAddress?: {
+                    number: string;
+                    name: string;
+                };
+            }[];
+        };
+        profile?: {
+            photo?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            cover?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+        };
+        privacyStatus: PrivacyStatusStatus;
+        activityStatus: ActivityStatusStatus;
+    };
+}
+export interface JoinCommunityResponseNonNullableFields {
+    member?: {
+        status: Status;
+        contact?: {
+            addresses: {
+                streetAddress?: {
+                    number: string;
+                    name: string;
+                };
+            }[];
+        };
+        profile?: {
+            photo?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            cover?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+        };
+        privacyStatus: PrivacyStatusStatus;
+        activityStatus: ActivityStatusStatus;
+    };
+}
+export interface LeaveCommunityResponseNonNullableFields {
+    member?: {
+        status: Status;
+        contact?: {
+            addresses: {
+                streetAddress?: {
+                    number: string;
+                    name: string;
+                };
+            }[];
+        };
+        profile?: {
+            photo?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            cover?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+        };
+        privacyStatus: PrivacyStatusStatus;
+        activityStatus: ActivityStatusStatus;
+    };
+}
+export interface GetMyMemberResponseNonNullableFields {
+    member?: {
+        status: Status;
+        contact?: {
+            addresses: {
+                streetAddress?: {
+                    number: string;
+                    name: string;
+                };
+            }[];
+        };
+        profile?: {
+            photo?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            cover?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+        };
+        privacyStatus: PrivacyStatusStatus;
+        activityStatus: ActivityStatusStatus;
+    };
+}
+export interface GetMemberResponseNonNullableFields {
+    member?: {
+        status: Status;
+        contact?: {
+            addresses: {
+                streetAddress?: {
+                    number: string;
+                    name: string;
+                };
+            }[];
+        };
+        profile?: {
+            photo?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            cover?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+        };
+        privacyStatus: PrivacyStatusStatus;
+        activityStatus: ActivityStatusStatus;
+    };
+}
+export interface ListMembersResponseNonNullableFields {
+    members: {
+        status: Status;
+        contact?: {
+            addresses: {
+                streetAddress?: {
+                    number: string;
+                    name: string;
+                };
+            }[];
+        };
+        profile?: {
+            photo?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            cover?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+        };
+        privacyStatus: PrivacyStatusStatus;
+        activityStatus: ActivityStatusStatus;
+    }[];
+}
+export interface QueryMembersResponseNonNullableFields {
+    members: {
+        status: Status;
+        contact?: {
+            addresses: {
+                streetAddress?: {
+                    number: string;
+                    name: string;
+                };
+            }[];
+        };
+        profile?: {
+            photo?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            cover?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+        };
+        privacyStatus: PrivacyStatusStatus;
+        activityStatus: ActivityStatusStatus;
+    }[];
+}
+export interface CreateMemberResponseNonNullableFields {
+    member?: {
+        status: Status;
+        contact?: {
+            addresses: {
+                streetAddress?: {
+                    number: string;
+                    name: string;
+                };
+            }[];
+        };
+        profile?: {
+            photo?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            cover?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+        };
+        privacyStatus: PrivacyStatusStatus;
+        activityStatus: ActivityStatusStatus;
+    };
+}
+export interface UpdateMemberResponseNonNullableFields {
+    member?: {
+        status: Status;
+        contact?: {
+            addresses: {
+                streetAddress?: {
+                    number: string;
+                    name: string;
+                };
+            }[];
+        };
+        profile?: {
+            photo?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            cover?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+        };
+        privacyStatus: PrivacyStatusStatus;
+        activityStatus: ActivityStatusStatus;
+    };
+}
+export interface DeleteMemberPhonesResponseNonNullableFields {
+    member?: {
+        status: Status;
+        contact?: {
+            addresses: {
+                streetAddress?: {
+                    number: string;
+                    name: string;
+                };
+            }[];
+        };
+        profile?: {
+            photo?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            cover?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+        };
+        privacyStatus: PrivacyStatusStatus;
+        activityStatus: ActivityStatusStatus;
+    };
+}
+export interface DeleteMemberEmailsResponseNonNullableFields {
+    member?: {
+        status: Status;
+        contact?: {
+            addresses: {
+                streetAddress?: {
+                    number: string;
+                    name: string;
+                };
+            }[];
+        };
+        profile?: {
+            photo?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            cover?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+        };
+        privacyStatus: PrivacyStatusStatus;
+        activityStatus: ActivityStatusStatus;
+    };
+}
+export interface DeleteMemberAddressesResponseNonNullableFields {
+    member?: {
+        status: Status;
+        contact?: {
+            addresses: {
+                streetAddress?: {
+                    number: string;
+                    name: string;
+                };
+            }[];
+        };
+        profile?: {
+            photo?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            cover?: {
+                _id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+        };
+        privacyStatus: PrivacyStatusStatus;
+        activityStatus: ActivityStatusStatus;
+    };
+}
+/**
+ * Change the currently logged in member slug.
+ * @param slug - New slug.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField slug
+ * @permissionScope Manage Members
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ */
+export declare function updateMySlug(slug: string): Promise<UpdateMySlugResponse & UpdateMySlugResponseNonNullableFields>;
+/**
+ * Joins the currently logged-in member to the site community and their profile to public.
+ *
+ * <!--ONLY:VELO
+ * This function returns a Promise that resolves to a member object
+ * when the member's profile privacy is updated.
+ * <!--END:ONLY:VELO-->
+ *
+ * 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.
+ * @public
+ * @documentationMaturity preview
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @returns Member profile.
+ */
+export declare function joinCommunity(): Promise<JoinCommunityResponse & JoinCommunityResponseNonNullableFields>;
+/**
+ * Removes the currently logged-in member from the site community and sets their profile to private.
+ *
+ * <!--ONLY:VELO
+ * This function returns a Promise that resolves to a member object
+ * when the member's profile privacy is updated.
+ * <!--END:ONLY:VELO-->
+ *
+ * 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.
+ *
+ * > **Note:**
+ * > If a public member profile changes to private —
+ * > in other words, if a member leaves the site's community —
+ * > their content such as forum posts and blog comments remain publicly visible.
+ * @public
+ * @documentationMaturity preview
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @returns Member profile.
+ */
+export declare function leaveCommunity(): Promise<LeaveCommunityResponse & LeaveCommunityResponseNonNullableFields>;
 /**
  * Retrieves the currently logged-in member.
  *
@@ -980,7 +1384,7 @@ export interface MemberOwnershipTransferred {
  * @applicableIdentity VISITOR
  * @returns Member profile.
  */
-export declare function getMyMember(options?: GetMyMemberOptions): Promise<GetMyMemberResponse>;
+export declare function getMyMember(options?: GetMyMemberOptions): Promise<GetMyMemberResponse & GetMyMemberResponseNonNullableFields>;
 export interface GetMyMemberOptions {
     /**
      * Predefined set of fields to return.
@@ -1016,7 +1420,7 @@ export interface GetMyMemberOptions {
  * @applicableIdentity VISITOR
  * @returns The requested member.
  */
-export declare function getMember(_id: string, options?: GetMemberOptions): Promise<Member>;
+export declare function getMember(_id: string, options?: GetMemberOptions): Promise<Member & NonNullable<GetMemberResponseNonNullableFields>['member']>;
 export interface GetMemberOptions {
     /**
      * Predefined set of fields to return.
@@ -1046,7 +1450,7 @@ export interface GetMemberOptions {
  * @applicableIdentity MEMBER
  * @applicableIdentity VISITOR
  */
-export declare function listMembers(options?: ListMembersOptions): Promise<ListMembersResponse>;
+export declare function listMembers(options?: ListMembersOptions): Promise<ListMembersResponse & ListMembersResponseNonNullableFields>;
 export interface ListMembersOptions {
     paging?: Paging;
     /**
@@ -1214,7 +1618,7 @@ export declare function deleteMember(_id: string): Promise<void>;
  * @permissionScope Manage Members
  * @applicableIdentity APP
  */
-export declare function createMember(member: Member): Promise<CreateMemberResponse>;
+export declare function createMember(member: Member): Promise<CreateMemberResponse & CreateMemberResponseNonNullableFields>;
 /**
  * Updates a member's properties.
  *
@@ -1257,7 +1661,7 @@ export declare function createMember(member: Member): Promise<CreateMemberRespon
  * @applicableIdentity APP
  * @applicableIdentity MEMBER
  */
-export declare function updateMember(_id: string | null, options?: UpdateMemberOptions): Promise<Member>;
+export declare function updateMember(_id: string | null, options?: UpdateMemberOptions): Promise<Member & NonNullable<UpdateMemberResponseNonNullableFields>['member']>;
 export interface UpdateMemberOptions {
     member: {
         /**
@@ -1268,7 +1672,7 @@ export interface UpdateMemberOptions {
         /** Email used by the member to log in to the site. */
         loginEmail?: string | null;
         /**
-         * Indication of email verification status.
+         * Whether the email used by the member has been verified.
          * @readonly
          */
         loginEmailVerified?: boolean | null;
@@ -1382,7 +1786,7 @@ export interface UpdateMemberOptions {
  * @applicableIdentity APP
  * @applicableIdentity MEMBER
  */
-export declare function deleteMemberPhones(_id: string): Promise<DeleteMemberPhonesResponse>;
+export declare function deleteMemberPhones(_id: string): Promise<DeleteMemberPhonesResponse & DeleteMemberPhonesResponseNonNullableFields>;
 /**
  * Clears a member's email addresses.
  *
@@ -1406,7 +1810,7 @@ export declare function deleteMemberPhones(_id: string): Promise<DeleteMemberPho
  * @applicableIdentity APP
  * @applicableIdentity MEMBER
  */
-export declare function deleteMemberEmails(_id: string): Promise<DeleteMemberEmailsResponse>;
+export declare function deleteMemberEmails(_id: string): Promise<DeleteMemberEmailsResponse & DeleteMemberEmailsResponseNonNullableFields>;
 /**
  * Deletes a member's street addresses.
  *
@@ -1424,5 +1828,5 @@ export declare function deleteMemberEmails(_id: string): Promise<DeleteMemberEma
  * @applicableIdentity APP
  * @applicableIdentity MEMBER
  */
-export declare function deleteMemberAddresses(_id: string): Promise<DeleteMemberAddressesResponse>;
+export declare function deleteMemberAddresses(_id: string): Promise<DeleteMemberAddressesResponse & DeleteMemberAddressesResponseNonNullableFields>;
 export {};