@wix/auto_sdk_members_members 1.0.89 → 1.0.90

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1787,6 +1787,8 @@ declare function updateCurrentMemberSlug(slug: string): Promise<NonNullablePaths
1787
1787
  }>;
1788
1788
  /**
1789
1789
  * Updates a member's slug.
1790
+ *
1791
+ * 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).
1790
1792
  * @param _id - Member ID.
1791
1793
  * @param slug - New slug.
1792
1794
  * @public
@@ -1848,6 +1850,8 @@ declare function leaveCommunity(): Promise<NonNullablePaths<LeaveCommunityRespon
1848
1850
  *
1849
1851
  * >**Note:**
1850
1852
  * >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
1853
+ *
1854
+ * 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).
1851
1855
  * @public
1852
1856
  * @permissionId MEMBERS.MEMBER_READ
1853
1857
  * @applicableIdentity APP
@@ -2058,6 +2062,8 @@ type MemberQuery = {
2058
2062
  * Muted members can't engage with a community. For example, they can't leave comments, like posts or comments, or share content.
2059
2063
  *
2060
2064
  * 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).
2065
+ *
2066
+ * To unmute a member, call [Unmute Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/unmute-member).
2061
2067
  * @param _id - ID of the member to mute.
2062
2068
  * @public
2063
2069
  * @requiredField _id
@@ -2072,6 +2078,8 @@ declare function muteMember(_id: string): Promise<NonNullablePaths<MuteMemberRes
2072
2078
  * Unmuted members can engage with the community. For example, leave comments, like posts or comments, and share content.
2073
2079
  *
2074
2080
  * 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).
2081
+ *
2082
+ * To mute a member, call [Mute Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/mute-member).
2075
2083
  * @param _id - ID of the member to unmute.
2076
2084
  * @public
2077
2085
  * @requiredField _id
@@ -2086,6 +2094,10 @@ declare function unmuteMember(_id: string): Promise<NonNullablePaths<UnmuteMembe
2086
2094
  * Call this API to:
2087
2095
  * - Approve a pending member.
2088
2096
  * - Unblock a blocked member.
2097
+ *
2098
+ * 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).
2099
+ *
2100
+ * To block a member, call [Block Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/block-member).
2089
2101
  * @param _id - ID of the member to approve.
2090
2102
  * @public
2091
2103
  * @requiredField _id
@@ -2099,7 +2111,9 @@ declare function approveMember(_id: string): Promise<NonNullablePaths<ApproveMem
2099
2111
  *
2100
2112
  * A blocked member can't log in to members-only pages.
2101
2113
  *
2102
- * To unblock a member, call Approve Member.
2114
+ * 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).
2115
+ *
2116
+ * To unblock a member, call [Approve Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/approve-member).
2103
2117
  * @param _id - ID of a member to block.
2104
2118
  * @public
2105
2119
  * @requiredField _id
@@ -2128,6 +2142,12 @@ declare function disconnectMember(_id: string): Promise<NonNullablePaths<Disconn
2128
2142
  * Deletes a member by ID.
2129
2143
  *
2130
2144
  * 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.
2145
+ *
2146
+ * 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).
2147
+ *
2148
+ * 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).
2149
+ *
2150
+ * 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).
2131
2151
  * @param _id - ID of a member to delete.
2132
2152
  * @public
2133
2153
  * @requiredField _id
@@ -2147,6 +2167,12 @@ declare function deleteMember(_id: string): Promise<void & {
2147
2167
  *
2148
2168
  * >**Note:**
2149
2169
  * >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
2170
+ *
2171
+ * 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).
2172
+ *
2173
+ * 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).
2174
+ *
2175
+ * 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).
2150
2176
  * @public
2151
2177
  * @permissionId MEMBERS.MEMBER_DELETE
2152
2178
  * @applicableIdentity APP
@@ -2166,6 +2192,12 @@ interface DeleteMyMemberOptions {
2166
2192
  * Deletes multiple members by `memberId`.
2167
2193
  *
2168
2194
  * 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.
2195
+ *
2196
+ * 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).
2197
+ *
2198
+ * 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).
2199
+ *
2200
+ * 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).
2169
2201
  * @param memberIds - IDs of members to be deleted.
2170
2202
  * @public
2171
2203
  * @requiredField memberIds
@@ -2178,6 +2210,12 @@ declare function bulkDeleteMembers(memberIds: string[]): Promise<NonNullablePath
2178
2210
  * Deletes multiple members by the specified filter.
2179
2211
  *
2180
2212
  * 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.
2213
+ *
2214
+ * 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).
2215
+ *
2216
+ * 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).
2217
+ *
2218
+ * 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).
2181
2219
  * @param filter - Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.
2182
2220
  * @public
2183
2221
  * @requiredField filter
@@ -2201,6 +2239,8 @@ interface BulkDeleteMembersByFilterOptions {
2201
2239
  * Call this API to:
2202
2240
  * - Approve pending members.
2203
2241
  * - Unblock blocked members.
2242
+ *
2243
+ * To approve a single member, call [Approve Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/approve-member).
2204
2244
  * @param filter - Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.
2205
2245
  * @public
2206
2246
  * @requiredField filter
@@ -2214,7 +2254,11 @@ declare function bulkApproveMembers(filter: any): Promise<NonNullablePaths<BulkA
2214
2254
  *
2215
2255
  * Blocked members can't log in to members-only pages.
2216
2256
  *
2217
- * To unblock multiple members, call Bulk Approve Members.
2257
+ * To block a single member, call [Block Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/block-member).
2258
+ *
2259
+ * To unblock a single member, call [Approve Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/approve-member).
2260
+ *
2261
+ * 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).
2218
2262
  * @param filter - Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.
2219
2263
  * @public
2220
2264
  * @requiredField filter