diff --git a/wix-members-backend/wix-members-backend/Authentication.service.json b/wix-members-backend/wix-members-backend/Authentication.service.json index ff8b75964d..bbe1265373 100644 --- a/wix-members-backend/wix-members-backend/Authentication.service.json +++ b/wix-members-backend/wix-members-backend/Authentication.service.json @@ -46,13 +46,6 @@ "[wix-members-frontend `applySessionToken()` function](wix-members-frontend/authentication/applysessiontoken)", "to log the member in.", "", - "> **Note:**", - "> This function replaces the deprecated", - "> `wix-users-backend.approveByEmail()`.", - "> The deprecated function will continue to work, but it will not receive updates.", - "> To keep any existing code compatible with future changes, see the", - "> [migration instructions](wix-users-backend/approvebyemail#migration-instructions).", - "", "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", @@ -327,7 +320,8 @@ "extra": { } }, { "name": "blockByEmail", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "email", @@ -349,15 +343,8 @@ "The `blockByEmail()` function returns a Promise that resolves", "when the specified member is blocked.", "", - "> **Note:**", - "> This function replaces the deprecated", - "> `wix-users-backend.blockByEmail()`.", - "> The deprecated function will continue to work, but it will not receive updates.", - "> To keep any existing code compatible with future changes, see the", - "> [migration instructions](wix-users-backend/blockbyemail#migration-instructions).", - "", "To unblock the member and allow them to log in to the site, use", - "[`approveByEmail()`](wix-members-backend/authentication/approvebyemail).", + "[`approveByEmail()`](https://dev.wix.com/docs/velo/api-reference/wix-members-backend/authentication/approve-by-email).", "" ], "links": [ "[approveByEmail ( )](#approveByEmail)" ], @@ -570,7 +557,8 @@ "extra": { } }, { "name": "generateSessionToken", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "email", @@ -592,13 +580,6 @@ "The `generateSessionToken()` function returns a Promise that resolves to a session token", "used to log a member in to your site.", "", - "> **Note:**", - "> This function replaces the deprecated", - "> `wix-users-backend.generateSessionToken()`.", - "> The deprecated function will continue to work, but it will not receive updates.", - "> To keep any existing code compatible with future changes, see the", - "> [migration instructions](wix-users-backend/generatesessiontoken#migration-instructions).", - "", "Use `generateSessionToken()` to bypass Wix member authentication", "when using a 3rd-party service to authenticate your members.", "For example, you can use `generateSessionToken()`", @@ -725,15 +706,9 @@ "", "To complete the login,", "the returned session token must be applied using the", - "[`applySessionToken()`](wix-members-frontend/authentication/applysessiontoken)", + "[`applySessionToken()`](https://dev.wix.com/docs/velo/api-reference/wix-members-frontend/authentication/apply-session-token)", "function (from wix-members-frontend) in page code.", "", - "> **Note:**", - "> This function replaces the deprecated", - "> `wix-users-backend.login()`.", - "> The deprecated function will continue to work, but it will not receive updates.", - "> To keep any existing code compatible with future changes, see the", - "> [migration instructions](wix-users-backend/login#migration-instructions).", "" ], "links": [], "examples": diff --git a/wix-members-backend/wix-members-backend/Authorization.service.json b/wix-members-backend/wix-members-backend/Authorization.service.json index 4e11d6630b..b3159193f1 100644 --- a/wix-members-backend/wix-members-backend/Authorization.service.json +++ b/wix-members-backend/wix-members-backend/Authorization.service.json @@ -1,7 +1,8 @@ { "name": "Authorization", "memberOf": "wix-members-backend", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 139, "filename": "index.js" }, @@ -20,7 +21,8 @@ "properties": [], "operations": [ { "name": "assignRole", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "roleId", @@ -48,13 +50,6 @@ [ "The `assignRole()` function returns a Promise that resolves when the", " specified role is assigned to the specified member.", "", - "> **Note:**", - "> This function replaces the deprecated", - "> `wix-users-backend.roles.assignRole()`.", - "> The deprecated function will continue to work, but it will not receive updates.", - "> To keep any existing code compatible with future changes, see the", - "> [migration instructions](wix-users-backend/roles-obj/assignRole#migration-instructions).", - "", " `roleId` must be an ID from an existing role in your site.", " The role ID can be copied from the Role Settings page.", " You can access the Role Settings page from your site's", @@ -92,7 +87,8 @@ "extra": { } }, { "name": "removeRole", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "roleId", @@ -120,13 +116,6 @@ [ "The `removeRole()` function returns a Promise that resolves when the", " specified role is removed from the specified member.", "", - "> **Note:**", - "> This function replaces the deprecated", - "> `wix-users-backend.roles.removeRole()`.", - "> The deprecated function will continue to work, but it will not receive updates.", - "> To keep any existing code compatible with future changes, see the", - "> [migration instructions](wix-users-backend/roles-obj/removeRole#migration-instructions).", - "", " `roleId` must be an ID from an existing role in your site.", " The role ID can be copied from the Role Settings page.", " You can access the Role Settings page from your site's", diff --git a/wix-members-backend/wix-members-backend/Badges.service.json b/wix-members-backend/wix-members-backend/Badges.service.json index e3ab870567..f736218d42 100644 --- a/wix-members-backend/wix-members-backend/Badges.service.json +++ b/wix-members-backend/wix-members-backend/Badges.service.json @@ -1,7 +1,8 @@ { "name": "Badges", "memberOf": "wix-members-backend", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 110, "filename": "index.js" }, @@ -25,7 +26,8 @@ "properties": [], "operations": [ { "name": "assignMembers", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "badgeId", @@ -54,13 +56,6 @@ [ "The `assignMembers()` function returns a Promise", "that resolves when the specified badge is assigned to the specified members.", "", - "> **Note:**", - "> This function replaces the deprecated", - "> `wix-users-backend.badges.assignMembers()`.", - "> The deprecated function will continue to work, but it will not receive updates.", - "> To keep any existing code compatible with future changes, see the", - "> [migration instructions](wix-users-backend/badges/assignMembers#migration-instructions).", - "", "The `badgeId` parameter must be an ID from your site's `Members/Badges` collection.", "Typically, you retrieve the ID from the collection using a query or through a dataset." ], "links": [], @@ -158,7 +153,8 @@ "extra": { } }, { "name": "createBadge", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "badgeInfo", @@ -179,13 +175,6 @@ [ "The `createBadge()` function returns a Promise", "that resolves to the newly created badge.", "", - "> **Note:**", - "> This function replaces the deprecated", - "> `wix-users-backend.badges.createBadge()`.", - "> The deprecated function will continue to work, but it will not receive updates.", - "> To keep any existing code compatible with future changes, see the", - "> [migration instructions](wix-users-backend/badges/createbadge#migration-instructions).", - "", "New badges do not have any badge permissions by default.", "You can", "[set badge permissions](https://support.wix.com/en/article/setting-permissions-for-a-member-badge)", @@ -281,7 +270,8 @@ "extra": { } }, { "name": "deleteBadge", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "badgeId", @@ -302,13 +292,6 @@ [ "The `deleteBadge()` function returns a Promise that resolves when", "the specified badge is deleted.", "", - "> **Note:**", - "> This function replaces the deprecated", - "> `wix-users-backend.badges.deleteBadge()`.", - "> The deprecated function will continue to work, but it will not receive updates.", - "> To keep any existing code compatible with future changes, see the", - "> [migration instructions](wix-users-backend/badges/deleteBadge#migration-instructions).", - "", "The `badgeId` parameter must be an ID from your site's `Members/Badges` collection.", "Typically, you retrieve the ID from the collection using a query or through a dataset." ], "links": [], @@ -336,7 +319,8 @@ "extra": { } }, { "name": "listMemberBadges", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "memberIds", @@ -360,14 +344,7 @@ { "summary": "Lists the badges assigned to each of the specified site members.", "description": [ "The `listMemberBadges()` function returns a Promise that resolves to a", - "list of badge IDs associated with each of the specified members.", - "", - "> **Note:**", - "> This function replaces the deprecated", - "> `wix-users-backend.badges.listMemberBadges()`.", - "> The deprecated function will continue to work, but it will not receive updates.", - "> To keep any existing code compatible with future changes, see the", - "> [migration instructions](wix-users-backend/badges/listMemberBadges#migration-instructions)." ], + "list of badge IDs associated with each of the specified members." ], "links": [], "examples": [ { "title": "List badges assigned to members", @@ -425,7 +402,8 @@ "extra": { } }, { "name": "listMembers", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "badgeId", @@ -446,14 +424,7 @@ { "summary": "Lists the IDs of all members assigned to a badge.", "description": [ "The `listMembers()` function returns a Promise that resolves", - "to a list of member IDs assigned to the specified badge.", - "", - "> **Note:**", - "> This function replaces the deprecated", - "> `wix-users-backend.badges.listMembers()`.", - "> The deprecated function will continue to work, but it will not receive updates.", - "> To keep any existing code compatible with future changes, see the", - "> [migration instructions](wix-users-backend/badges/listMembers#migration-instructions)." ], + "to a list of member IDs assigned to the specified badge." ], "links": [], "examples": [ { "title": "List members assigned to a badge", @@ -489,7 +460,8 @@ "extra": { } }, { "name": "removeMembers", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "badgeId", @@ -516,13 +488,6 @@ [ "The `removeMembers()` function returns a Promise that resolves", "when the specified members are removed as holders of the specified badge.", "", - "> **Note:**", - "> This function replaces the deprecated", - "> `wix-users-backend.badges.removeMembers()`.", - "> The deprecated function will continue to work, but it will not receive updates.", - "> To keep any existing code compatible with future changes, see the", - "> [migration instructions](wix-users-backend/badges/removeMembers#migration-instructions).", - "", "The `badgeId` parameter must be an ID from your site's `Members/Badges` collection.", "Typically, you retrieve the ID from the collection using a query or through a dataset." ], "links": [], @@ -555,7 +520,8 @@ "extra": { } }, { "name": "updateBadge", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "badgeId", @@ -579,13 +545,6 @@ [ "The `updateBadge()` function returns a Promise", "that resolves to the updated badge.", "", - "> **Note:**", - "> This function replaces the deprecated", - "> `wix-users-backend.badges.updateBadge()`.", - "> The deprecated function will continue to work, but it will not receive updates.", - "> To keep any existing code compatible with future changes, see the", - "> [migration instructions](wix-users-backend/badges/updateBadge#migration-instructions).", - "", "Only the properties passed in the `BadgeInfo` object will be updated. All other properties will remain the same.", "", "Because the badge `slug` is based on the badge `title`,", diff --git a/wix-members-backend/wix-members-backend/CurrentMember.service.json b/wix-members-backend/wix-members-backend/CurrentMember.service.json index 8c6384c8ca..7b9a809ea5 100644 --- a/wix-members-backend/wix-members-backend/CurrentMember.service.json +++ b/wix-members-backend/wix-members-backend/CurrentMember.service.json @@ -1,7 +1,8 @@ { "name": "CurrentMember", "memberOf": "wix-members-backend", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 20, "filename": "index.js" }, @@ -27,7 +28,8 @@ "properties": [], "operations": [ { "name": "getMember", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "options", @@ -51,7 +53,7 @@ "to the currently logged-in member.", "", "> **Notes:**", - "> - Currently, this function throws an error if a member isn't logged in. However, the frontend [`currentMember.getMember()`](wix-members-frontend/currentmember/getmember) resolves to `undefined` if a member isn't logged in. This function may change in the future to align with the frontend `currentMember.getMember()`.", + "> - Currently, this function throws an error if a member isn't logged in. However, the frontend [`currentMember.getMember()`](https://dev.wix.com/docs/velo/api-reference/wix-members-frontend/current-member/get-member) resolves to `undefined` if a member isn't logged in. This function may change in the future to align with the frontend `currentMember.getMember()`.", "> - The APIs in `CurrentMember` are only partially functional when previewing your site. View a published version of your site to see their complete functionality.", "" ], "links": [], diff --git a/wix-members-backend/wix-members-backend/Members.service.json b/wix-members-backend/wix-members-backend/Members.service.json index 36c4c87854..284791e3eb 100644 --- a/wix-members-backend/wix-members-backend/Members.service.json +++ b/wix-members-backend/wix-members-backend/Members.service.json @@ -1,7 +1,8 @@ { "name": "Members", "memberOf": "wix-members-backend", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 53, "filename": "index.js" }, @@ -25,7 +26,8 @@ "properties": [], "operations": [ { "name": "deleteMember", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "id", @@ -47,13 +49,6 @@ "The `deleteMember()` function returns a Promise that resolves to a member object", "when the specified member is deleted.", "", - "> **Note:**", - "> This function replaces the deprecated", - "> `wix-users-backend.deleteUser()`.", - "> The deprecated function will continue to work, but it will not receive updates.", - "> To keep any existing code compatible with future changes, see the", - "> [migration instructions](wix-users-backend/deleteuser#migration-instructions).", - "", "This function permanently deletes a member.", "Once deleted, a member cannot be restored.", "" ], @@ -450,7 +445,8 @@ "extra": { } }, { "name": "updateMember", - "labels": [], + "labels": + [ "changed" ], "nameParams": [], "params": [ { "name": "id", @@ -499,9 +495,9 @@ "> However, passing an empty array will have no effect,", "> and these functions must be used to clear all data from the respective array:", ">", - "> - To clear `contactDetails.addresses`, use [`deleteMemberAddresses()`](wix-members-backend/members/deletememberaddresses).", - "> - To clear `contactDetails.emails`, use [`deleteMemberEmails()`](wix-members-backend/members/deletememberemails).", - "> - To clear `contactDetails.phones`, use [`deleteMemberPhones()`](wix-members-backend/members/deletememberphones).", + "> - To clear `contactDetails.addresses`, use [`deleteMemberAddresses()`](https://dev.wix.com/docs/velo/api-reference/wix-members-backend/members/delete-member-addresses).", + "> - To clear `contactDetails.emails`, use [`deleteMemberEmails()`](https://dev.wix.com/docs/velo/api-reference/wix-members-backend/members/delete-member-emails).", + "> - To clear `contactDetails.phones`, use [`deleteMemberPhones()`](https://dev.wix.com/docs/velo/api-reference/wix-members-backend/members/delete-member-phones).", "" ], "links": [], "examples":