Skip to content

Commit

Permalink
Merge branch 'master' into link-blitz-reb
Browse files Browse the repository at this point in the history
# Conflicts:
#	wix-groups-backend/wix-groups-backend.service.json
  • Loading branch information
rebeccask committed Jul 4, 2024
2 parents 21495e8 + faad79a commit b0b6fd6
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 123 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -327,7 +320,8 @@
"extra":
{ } },
{ "name": "blockByEmail",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "email",
Expand All @@ -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).",
"<!--END:ONLY:VELO-->" ],
"links":
[ "[approveByEmail ( )](#approveByEmail)" ],
Expand Down Expand Up @@ -570,7 +557,8 @@
"extra":
{ } },
{ "name": "generateSessionToken",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "email",
Expand All @@ -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()`",
Expand Down Expand Up @@ -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).",
"<!--END:ONLY:VELO-->" ],
"links": [],
"examples":
Expand Down
23 changes: 6 additions & 17 deletions wix-members-backend/wix-members-backend/Authorization.service.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{ "name": "Authorization",
"memberOf": "wix-members-backend",
"mixes": [],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 139,
"filename": "index.js" },
Expand All @@ -20,7 +21,8 @@
"properties": [],
"operations":
[ { "name": "assignRole",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "roleId",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -92,7 +87,8 @@
"extra":
{ } },
{ "name": "removeRole",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "roleId",
Expand Down Expand Up @@ -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",
Expand Down
77 changes: 18 additions & 59 deletions wix-members-backend/wix-members-backend/Badges.service.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{ "name": "Badges",
"memberOf": "wix-members-backend",
"mixes": [],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 110,
"filename": "index.js" },
Expand All @@ -25,7 +26,8 @@
"properties": [],
"operations":
[ { "name": "assignMembers",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "badgeId",
Expand Down Expand Up @@ -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": [],
Expand Down Expand Up @@ -158,7 +153,8 @@
"extra":
{ } },
{ "name": "createBadge",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "badgeInfo",
Expand All @@ -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)",
Expand Down Expand Up @@ -281,7 +270,8 @@
"extra":
{ } },
{ "name": "deleteBadge",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "badgeId",
Expand All @@ -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": [],
Expand Down Expand Up @@ -336,7 +319,8 @@
"extra":
{ } },
{ "name": "listMemberBadges",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "memberIds",
Expand All @@ -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",
Expand Down Expand Up @@ -425,7 +402,8 @@
"extra":
{ } },
{ "name": "listMembers",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "badgeId",
Expand All @@ -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",
Expand Down Expand Up @@ -489,7 +460,8 @@
"extra":
{ } },
{ "name": "removeMembers",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "badgeId",
Expand All @@ -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": [],
Expand Down Expand Up @@ -555,7 +520,8 @@
"extra":
{ } },
{ "name": "updateBadge",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "badgeId",
Expand All @@ -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`,",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{ "name": "CurrentMember",
"memberOf": "wix-members-backend",
"mixes": [],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 20,
"filename": "index.js" },
Expand All @@ -27,7 +28,8 @@
"properties": [],
"operations":
[ { "name": "getMember",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "options",
Expand All @@ -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.",
"<!--END:ONLY:VELO-->" ],
"links": [],
Expand Down
Loading

0 comments on commit b0b6fd6

Please sign in to comment.