@wix/auto_sdk_members_members 1.0.89 → 1.0.90

package/build/cjs/index.d.ts

@@ -22,6 +22,8 @@ declare function updateMemberSlug$1(httpClient: HttpClient): UpdateMemberSlugSig
 interface UpdateMemberSlugSignature {
     /**
      * 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 - Member ID.
      * @param - New slug.
      */
@@ -75,6 +77,8 @@ interface GetCurrentMemberSignature {
      *
      * >**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).
      * @returns Member profile.
      */
     (options?: GetCurrentMemberOptions): Promise<NonNullablePaths<GetMyMemberResponse, `member.status` | `member.contact.phones` | `member.contact.emails` | `member.contact.addresses` | `member.contact.addresses.${number}.streetAddress.number` | `member.contact.addresses.${number}.streetAddress.name` | `member.profile.photo._id` | `member.profile.photo.url` | `member.profile.photo.height` | `member.profile.photo.width` | `member.privacyStatus` | `member.activityStatus`, 7>>;
@@ -112,6 +116,8 @@ interface MuteMemberSignature {
      * 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 of the member to mute.
      */
     (_id: string): Promise<NonNullablePaths<MuteMemberResponse, `member.status` | `member.contact.phones` | `member.contact.emails` | `member.contact.addresses` | `member.contact.addresses.${number}.streetAddress.number` | `member.contact.addresses.${number}.streetAddress.name` | `member.profile.photo._id` | `member.profile.photo.url` | `member.profile.photo.height` | `member.profile.photo.width` | `member.privacyStatus` | `member.activityStatus`, 7>>;
@@ -124,6 +130,8 @@ interface UnmuteMemberSignature {
      * 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 of the member to unmute.
      */
     (_id: string): Promise<NonNullablePaths<UnmuteMemberResponse, `member.status` | `member.contact.phones` | `member.contact.emails` | `member.contact.addresses` | `member.contact.addresses.${number}.streetAddress.number` | `member.contact.addresses.${number}.streetAddress.name` | `member.profile.photo._id` | `member.profile.photo.url` | `member.profile.photo.height` | `member.profile.photo.width` | `member.privacyStatus` | `member.activityStatus`, 7>>;
@@ -136,6 +144,10 @@ interface ApproveMemberSignature {
      * 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 of the member to approve.
      */
     (_id: string): Promise<NonNullablePaths<ApproveMemberResponse, `member.status` | `member.contact.phones` | `member.contact.emails` | `member.contact.addresses` | `member.contact.addresses.${number}.streetAddress.number` | `member.contact.addresses.${number}.streetAddress.name` | `member.profile.photo._id` | `member.profile.photo.url` | `member.profile.photo.height` | `member.profile.photo.width` | `member.privacyStatus` | `member.activityStatus`, 7>>;
@@ -147,7 +159,9 @@ interface BlockMemberSignature {
      *
      * 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 of a member to block.
      */
     (_id: string): Promise<NonNullablePaths<BlockMemberResponse, `member.status` | `member.contact.phones` | `member.contact.emails` | `member.contact.addresses` | `member.contact.addresses.${number}.streetAddress.number` | `member.contact.addresses.${number}.streetAddress.name` | `member.profile.photo._id` | `member.profile.photo.url` | `member.profile.photo.height` | `member.profile.photo.width` | `member.privacyStatus` | `member.activityStatus`, 7> & {
@@ -172,6 +186,12 @@ interface DeleteMemberSignature {
      * 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 of a member to delete.
      */
     (_id: string): Promise<void & {
@@ -189,6 +209,12 @@ interface DeleteMyMemberSignature {
      *
      * >**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).
      */
     (options?: DeleteMyMemberOptions): Promise<void & {
         __validationErrorsType?: DeleteMyMemberValidationErrors;
@@ -200,6 +226,12 @@ interface BulkDeleteMembersSignature {
      * 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 - IDs of members to be deleted.
      */
     (memberIds: string[]): Promise<NonNullablePaths<BulkDeleteMembersResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
@@ -210,6 +242,12 @@ interface BulkDeleteMembersByFilterSignature {
      * 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 - Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.
      */
     (filter: any, options?: BulkDeleteMembersByFilterOptions): Promise<NonNullablePaths<BulkDeleteMembersByFilterResponse, `jobId`, 2>>;
@@ -222,6 +260,8 @@ interface BulkApproveMembersSignature {
      * 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 - Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.
      */
     (filter: any): Promise<NonNullablePaths<BulkApproveMembersResponse, `jobId`, 2>>;
@@ -233,7 +273,11 @@ interface BulkBlockMembersSignature {
      *
      * 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 - Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.
      */
     (filter: any): Promise<NonNullablePaths<BulkBlockMembersResponse, `jobId`, 2>>;