@wix/auto_sdk_members_badges 1.0.4 → 1.0.6

package/build/cjs/src/badges-v3-badge-badges.http.d.ts

@@ -2,10 +2,7 @@ import { RequestOptionsFactory } from '@wix/sdk-types';
 /**
  * Creates a badge.
  *
- *
- * The `createBadge()` function returns a Promise that resolves to the newly created badge.
- *
- * 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) from the Badges page in the Dashboard.
+ * New badges do not have any badge permissions by default. Wix users can set badge permissions from the [Badges page in the dashboard](https://support.wix.com/en/article/site-members-creating-and-managing-member-badges?tabs=Dashboard-0#managing-member-badges).
  *
  * If `backgroundColor` or `textColor` are not specified, they default to `"#796EFF"` (purple) and `"#FFFFFF"` (white) respectively.
  */
@@ -13,99 +10,63 @@ export declare function createBadge(payload: object): RequestOptionsFactory<any>
 /**
  * Updates a badge.
  *
- * The `updateBadge()` function returns a Promise that resolves to the updated badge.
- *
- * 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`, if you change `title`, `slug` is updated accordingly.
- *
- * `badgeId` 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.
+ * Note that the badge `slug` is based on the badge `title`. If you update the `title`, the `slug` updates accordingly.
  */
 export declare function updateBadge(payload: object): RequestOptionsFactory<any>;
 /**
- * Lists the badges.
- *
+ * Retrieves up to 1,000 badges, given the requested paging.
  *
- * The `listBadges` function returns a Promise that resolves when the badges are retrieved. Retrieves up to 1000 badges, given the requested paging. Default paging.limit is 100, paging.offset - 0.
+ * Default `paging.limit` is `100` and `paging.offset` is `0`.
  *
- * This function is not a universal function and runs only on the backend.
+ * This method is not universal and only runs on the backend.
  */
 export declare function listBadges(payload: object): RequestOptionsFactory<any>;
 /**
- * Retrieves information about a badge.
- *
+ * Retrieves a badge.
  *
- * The `getBadge` function returns a Promise that resolves when the badge information is retrieved.
- *
- * The `_id` 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.
- *
- * This function is not a universal function and runs only on the backend.
+ * This method is not universal and only runs on the backend.
  */
 export declare function getBadge(payload: object): RequestOptionsFactory<any>;
-/**
- * Deletes a badge.
- *
- *
- * The `deleteBadge()` function returns a Promise that resolves when the specified badge is deleted.
- *
- * 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.
- */
+/** Deletes a badge. */
 export declare function deleteBadge(payload: object): RequestOptionsFactory<any>;
 /**
  * Assigns a badge to site members.
  *
- *
- * The `assignBadge()` function returns a Promise that resolves when the specified badge is assigned to the specified members.
- *
- * 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.
+ * Members inherit the badge's permissions when they receive the badge.
+ * Badge permissions are added to previous member permissions, they don't replace the existing permissions.
  */
 export declare function assignBadge(payload: object): RequestOptionsFactory<any>;
 /**
- * Removes site members from an assigned badge.
- *
+ * Removes an assigned badge from multiple site members.
  *
- * The `unassignBadge()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.
- *
- * 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.
+ * The members lose the badge's permissions when the badge is removed.
  */
 export declare function unassignBadge(payload: object): RequestOptionsFactory<any>;
 /**
- * Lists the IDs of all members assigned to a badge.
- *
- *
- * The `listMembersByBadge()` function returns a Promise that resolves to a list of member IDs assigned to the specified badge.
+ * Retrieves up to 1,000 site members assigned to a badge.
  *
- * Retrieves up to 1000 site members who have a specified badge. Default `paging.limit` is 100, `paging.offset` - 0.
+ * Default `paging.limit` is `100` and `paging.offset` is `0`.
  *
- * The `_id` 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.
- *
- * This function is not a universal function and runs only on the backend.
+ * This method is not universal and only runs on the backend.
  */
 export declare function listMembers(payload: object): RequestOptionsFactory<any>;
 /**
- * Lists the badges assigned to each of the specified site members.
- *
+ * Retrieves badges assigned to specified members.
  *
- * The `listBadgesPerMember()` function returns a Promise that resolves to a list of badge IDs associated with each of the specified members.
+ * Members are typically associated with a contact, each having a distinct `memberId` and `contactId`. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
  *
- * This function is not a universal function and runs only on the backend.
+ * This method is not universal and only runs on the backend.
  */
 export declare function listMembersBadgeIds(payload: object): RequestOptionsFactory<any>;
 /**
- * Retrieves member count per badge.
- *
+ * Retrieves a member count per badge.
  *
- * The `getMemberCountsPerBadge` function returns a Promise that resolves when the member counts of each badge are retrieved.
- *
- * This function is not a universal function and runs only on the backend.
+ * This method is not universal function and only runs on the backend.
  */
 export declare function getMemberCountsPerBadge(payload: object): RequestOptionsFactory<any>;
 /**
- * Updates badges' display order.
- *
- *
- * 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.
+ * Updates the display order of badges.
  *
- * This function is not a universal function and runs only on the backend
+ * This method is not universal function and only runs on the backend
  */
 export declare function updateBadgesDisplayOrder(payload: object): RequestOptionsFactory<any>;

package/build/cjs/src/badges-v3-badge-badges.http.js

@@ -27,10 +27,7 @@ const PACKAGE_NAME = '@wix/auto_sdk_members_badges';
 /**
  * Creates a badge.
  *
- *
- * The `createBadge()` function returns a Promise that resolves to the newly created badge.
- *
- * 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) from the Badges page in the Dashboard.
+ * New badges do not have any badge permissions by default. Wix users can set badge permissions from the [Badges page in the dashboard](https://support.wix.com/en/article/site-members-creating-and-managing-member-badges?tabs=Dashboard-0#managing-member-badges).
  *
  * If `backgroundColor` or `textColor` are not specified, they default to `"#796EFF"` (purple) and `"#FFFFFF"` (white) respectively.
  */
@@ -71,13 +68,7 @@ exports.createBadge = createBadge;
 /**
  * Updates a badge.
  *
- * The `updateBadge()` function returns a Promise that resolves to the updated badge.
- *
- * 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`, if you change `title`, `slug` is updated accordingly.
- *
- * `badgeId` 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.
+ * Note that the badge `slug` is based on the badge `title`. If you update the `title`, the `slug` updates accordingly.
  */
 function updateBadge(payload) {
     function __updateBadge({ host }) {
@@ -114,12 +105,11 @@ function updateBadge(payload) {
 }
 exports.updateBadge = updateBadge;
 /**
- * Lists the badges.
- *
+ * Retrieves up to 1,000 badges, given the requested paging.
  *
- * The `listBadges` function returns a Promise that resolves when the badges are retrieved. Retrieves up to 1000 badges, given the requested paging. Default paging.limit is 100, paging.offset - 0.
+ * Default `paging.limit` is `100` and `paging.offset` is `0`.
  *
- * This function is not a universal function and runs only on the backend.
+ * This method is not universal and only runs on the backend.
  */
 function listBadges(payload) {
     function __listBadges({ host }) {
@@ -150,14 +140,9 @@ function listBadges(payload) {
 }
 exports.listBadges = listBadges;
 /**
- * Retrieves information about a badge.
- *
+ * Retrieves a badge.
  *
- * The `getBadge` function returns a Promise that resolves when the badge information is retrieved.
- *
- * The `_id` 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.
- *
- * This function is not a universal function and runs only on the backend.
+ * This method is not universal and only runs on the backend.
  */
 function getBadge(payload) {
     function __getBadge({ host }) {
@@ -187,14 +172,7 @@ function getBadge(payload) {
     return __getBadge;
 }
 exports.getBadge = getBadge;
-/**
- * Deletes a badge.
- *
- *
- * The `deleteBadge()` function returns a Promise that resolves when the specified badge is deleted.
- *
- * 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.
- */
+/** Deletes a badge. */
 function deleteBadge(payload) {
     function __deleteBadge({ host }) {
         const metadata = {
@@ -217,10 +195,8 @@ exports.deleteBadge = deleteBadge;
 /**
  * Assigns a badge to site members.
  *
- *
- * The `assignBadge()` function returns a Promise that resolves when the specified badge is assigned to the specified members.
- *
- * 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.
+ * Members inherit the badge's permissions when they receive the badge.
+ * Badge permissions are added to previous member permissions, they don't replace the existing permissions.
  */
 function assignBadge(payload) {
     function __assignBadge({ host }) {
@@ -242,12 +218,9 @@ function assignBadge(payload) {
 }
 exports.assignBadge = assignBadge;
 /**
- * Removes site members from an assigned badge.
- *
+ * Removes an assigned badge from multiple site members.
  *
- * The `unassignBadge()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.
- *
- * 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.
+ * The members lose the badge's permissions when the badge is removed.
  */
 function unassignBadge(payload) {
     function __unassignBadge({ host }) {
@@ -269,16 +242,11 @@ function unassignBadge(payload) {
 }
 exports.unassignBadge = unassignBadge;
 /**
- * Lists the IDs of all members assigned to a badge.
- *
- *
- * The `listMembersByBadge()` function returns a Promise that resolves to a list of member IDs assigned to the specified badge.
+ * Retrieves up to 1,000 site members assigned to a badge.
  *
- * Retrieves up to 1000 site members who have a specified badge. Default `paging.limit` is 100, `paging.offset` - 0.
+ * Default `paging.limit` is `100` and `paging.offset` is `0`.
  *
- * The `_id` 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.
- *
- * This function is not a universal function and runs only on the backend.
+ * This method is not universal and only runs on the backend.
  */
 function listMembers(payload) {
     function __listMembers({ host }) {
@@ -300,12 +268,11 @@ function listMembers(payload) {
 }
 exports.listMembers = listMembers;
 /**
- * Lists the badges assigned to each of the specified site members.
- *
+ * Retrieves badges assigned to specified members.
  *
- * The `listBadgesPerMember()` function returns a Promise that resolves to a list of badge IDs associated with each of the specified members.
+ * Members are typically associated with a contact, each having a distinct `memberId` and `contactId`. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
  *
- * This function is not a universal function and runs only on the backend.
+ * This method is not universal and only runs on the backend.
  */
 function listMembersBadgeIds(payload) {
     function __listMembersBadgeIds({ host }) {
@@ -327,12 +294,9 @@ function listMembersBadgeIds(payload) {
 }
 exports.listMembersBadgeIds = listMembersBadgeIds;
 /**
- * Retrieves member count per badge.
- *
+ * Retrieves a member count per badge.
  *
- * The `getMemberCountsPerBadge` function returns a Promise that resolves when the member counts of each badge are retrieved.
- *
- * This function is not a universal function and runs only on the backend.
+ * This method is not universal function and only runs on the backend.
  */
 function getMemberCountsPerBadge(payload) {
     function __getMemberCountsPerBadge({ host }) {
@@ -354,12 +318,9 @@ function getMemberCountsPerBadge(payload) {
 }
 exports.getMemberCountsPerBadge = getMemberCountsPerBadge;
 /**
- * Updates badges' display order.
- *
- *
- * 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.
+ * Updates the display order of badges.
  *
- * This function is not a universal function and runs only on the backend
+ * This method is not universal function and only runs on the backend
  */
 function updateBadgesDisplayOrder(payload) {
     function __updateBadgesDisplayOrder({ host }) {

package/build/cjs/src/badges-v3-badge-badges.http.js.map

@@ -1 +1 @@
-{"version":3,"file":"badges-v3-badge-badges.http.js","sourceRoot":"","sources":["../../../src/badges-v3-badge-badges.http.ts"],"names":[],"mappings":";;;AAAA,gEAAkE;AAClE,0EAAkG;AAClG,0EAAkG;AAClG,sFAAkF;AAClF,gEAA2D;AAI3D,SAAS,4CAA4C,CACnD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,YAAY;aACvB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,gCAAgC;gBACzC,QAAQ,EAAE,KAAK;aAChB;SACF;KACF,CAAC;IAEF,OAAO,IAAA,yBAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,YAAY,GAAG,8BAA8B,CAAC;AAEpD;;;;;;;;;GASG;AACH,SAAgB,WAAW,CAAC,OAAe;IACzC,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,EAAE,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC;aACtE;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,oDAAoD;YAC/D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,YAAY;gBACvB,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,mBAAmB,EAAE;wBAC7B,EAAE,IAAI,EAAE,mBAAmB,EAAE;qBAC9B;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AAnCD,kCAmCC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,WAAW,CAAC,OAAe;IACzC,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,EAAE,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC;aACtE;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,OAAc;YACtB,SAAS,EAAE,oDAAoD;YAC/D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,uBAAuB;gBAClC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,mBAAmB,EAAE;wBAC7B,EAAE,IAAI,EAAE,mBAAmB,EAAE;qBAC9B;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AAnCD,kCAmCC;AAED;;;;;;;GAOG;AACH,SAAgB,UAAU,CAAC,OAAe;IACxC,SAAS,YAAY,CAAC,EAAE,IAAI,EAAO;QACjC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,mDAAmD;YAC9D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,YAAY;gBACvB,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;YAClC,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;wBAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;qBAC/B;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AA7BD,gCA6BC;AAED;;;;;;;;;GASG;AACH,SAAgB,QAAQ,CAAC,OAAe;IACtC,SAAS,UAAU,CAAC,EAAE,IAAI,EAAO;QAC/B,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,iDAAiD;YAC5D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,iBAAiB;gBAC5B,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;YAClC,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,mBAAmB,EAAE;wBAC7B,EAAE,IAAI,EAAE,mBAAmB,EAAE;qBAC9B;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AA7BD,4BA6BC;AAED;;;;;;;GAOG;AACH,SAAgB,WAAW,CAAC,OAAe;IACzC,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,QAAe;YACvB,SAAS,EAAE,oDAAoD;YAC/D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,iBAAiB;gBAC5B,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;SACnC,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AAnBD,kCAmBC;AAED;;;;;;;GAOG;AACH,SAAgB,WAAW,CAAC,OAAe;IACzC,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,oDAAoD;YAC/D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,yBAAyB;gBACpC,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;SACd,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AAnBD,kCAmBC;AAED;;;;;;;GAOG;AACH,SAAgB,aAAa,CAAC,OAAe;IAC3C,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,QAAe;YACvB,SAAS,EAAE,sDAAsD;YACjE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,yBAAyB;gBACpC,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;SACnC,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAnBD,sCAmBC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,WAAW,CAAC,OAAe;IACzC,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,oDAAoD;YAC/D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,yBAAyB;gBACpC,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;SACnC,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AAnBD,kCAmBC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CACjC,OAAe;IAEf,SAAS,qBAAqB,CAAC,EAAE,IAAI,EAAO;QAC1C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,4DAA4D;YACvE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;SACd,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AArBD,kDAqBC;AAED;;;;;;;GAOG;AACH,SAAgB,uBAAuB,CACrC,OAAe;IAEf,SAAS,yBAAyB,CAAC,EAAE,IAAI,EAAO;QAC9C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,gEAAgE;YAClE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,0BAA0B;gBACrC,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;SACnC,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,yBAAyB,CAAC;AACnC,CAAC;AAtBD,0DAsBC;AAED;;;;;;;GAOG;AACH,SAAgB,wBAAwB,CACtC,OAAe;IAEf,SAAS,0BAA0B,CAAC,EAAE,IAAI,EAAO;QAC/C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,OAAc;YACtB,SAAS,EACP,iEAAiE;YACnE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,kBAAkB;gBAC7B,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;YACb,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;wBAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;qBAC/B;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,0BAA0B,CAAC;AACpC,CAAC;AAhCD,4DAgCC"}
+{"version":3,"file":"badges-v3-badge-badges.http.js","sourceRoot":"","sources":["../../../src/badges-v3-badge-badges.http.ts"],"names":[],"mappings":";;;AAAA,gEAAkE;AAClE,0EAAkG;AAClG,0EAAkG;AAClG,sFAAkF;AAClF,gEAA2D;AAI3D,SAAS,4CAA4C,CACnD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,YAAY;aACvB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,gCAAgC;gBACzC,QAAQ,EAAE,KAAK;aAChB;SACF;KACF,CAAC;IAEF,OAAO,IAAA,yBAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,YAAY,GAAG,8BAA8B,CAAC;AAEpD;;;;;;GAMG;AACH,SAAgB,WAAW,CAAC,OAAe;IACzC,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,EAAE,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC;aACtE;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,oDAAoD;YAC/D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,YAAY;gBACvB,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,mBAAmB,EAAE;wBAC7B,EAAE,IAAI,EAAE,mBAAmB,EAAE;qBAC9B;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AAnCD,kCAmCC;AAED;;;;GAIG;AACH,SAAgB,WAAW,CAAC,OAAe;IACzC,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,EAAE,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC;aACtE;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,OAAc;YACtB,SAAS,EAAE,oDAAoD;YAC/D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,uBAAuB;gBAClC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,mBAAmB,EAAE;wBAC7B,EAAE,IAAI,EAAE,mBAAmB,EAAE;qBAC9B;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AAnCD,kCAmCC;AAED;;;;;;GAMG;AACH,SAAgB,UAAU,CAAC,OAAe;IACxC,SAAS,YAAY,CAAC,EAAE,IAAI,EAAO;QACjC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,mDAAmD;YAC9D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,YAAY;gBACvB,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;YAClC,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;wBAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;qBAC/B;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AA7BD,gCA6BC;AAED;;;;GAIG;AACH,SAAgB,QAAQ,CAAC,OAAe;IACtC,SAAS,UAAU,CAAC,EAAE,IAAI,EAAO;QAC/B,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,iDAAiD;YAC5D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,iBAAiB;gBAC5B,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;YAClC,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,mBAAmB,EAAE;wBAC7B,EAAE,IAAI,EAAE,mBAAmB,EAAE;qBAC9B;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AA7BD,4BA6BC;AAED,uBAAuB;AACvB,SAAgB,WAAW,CAAC,OAAe;IACzC,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,QAAe;YACvB,SAAS,EAAE,oDAAoD;YAC/D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,iBAAiB;gBAC5B,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;SACnC,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AAnBD,kCAmBC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,OAAe;IACzC,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,oDAAoD;YAC/D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,yBAAyB;gBACpC,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;SACd,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AAnBD,kCAmBC;AAED;;;;GAIG;AACH,SAAgB,aAAa,CAAC,OAAe;IAC3C,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,QAAe;YACvB,SAAS,EAAE,sDAAsD;YACjE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,yBAAyB;gBACpC,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;SACnC,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAnBD,sCAmBC;AAED;;;;;;GAMG;AACH,SAAgB,WAAW,CAAC,OAAe;IACzC,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,oDAAoD;YAC/D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,yBAAyB;gBACpC,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;SACnC,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AAnBD,kCAmBC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,OAAe;IAEf,SAAS,qBAAqB,CAAC,EAAE,IAAI,EAAO;QAC1C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,4DAA4D;YACvE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;SACd,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AArBD,kDAqBC;AAED;;;;GAIG;AACH,SAAgB,uBAAuB,CACrC,OAAe;IAEf,SAAS,yBAAyB,CAAC,EAAE,IAAI,EAAO;QAC9C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,gEAAgE;YAClE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,0BAA0B;gBACrC,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;SACnC,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,yBAAyB,CAAC;AACnC,CAAC;AAtBD,0DAsBC;AAED;;;;GAIG;AACH,SAAgB,wBAAwB,CACtC,OAAe;IAEf,SAAS,0BAA0B,CAAC,EAAE,IAAI,EAAO;QAC/C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qBAAqB;YACjC,MAAM,EAAE,OAAc;YACtB,SAAS,EACP,iEAAiE;YACnE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,4CAA4C,CAAC;gBAChD,SAAS,EAAE,kBAAkB;gBAC7B,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;YACb,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;wBAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;qBAC/B;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,0BAA0B,CAAC;AACpC,CAAC;AAhCD,4DAgCC"}

package/build/cjs/src/badges-v3-badge-badges.public.d.ts

@@ -8,10 +8,7 @@ interface CreateBadgeSignature {
     /**
      * Creates a badge.
      *
-     *
-     * The `createBadge()` function returns a Promise that resolves to the newly created badge.
-     *
-     * 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) from the Badges page in the Dashboard.
+     * New badges do not have any badge permissions by default. Wix users can set badge permissions from the [Badges page in the dashboard](https://support.wix.com/en/article/site-members-creating-and-managing-member-badges?tabs=Dashboard-0#managing-member-badges).
      *
      * If `backgroundColor` or `textColor` are not specified, they default to `"#796EFF"` (purple) and `"#FFFFFF"` (white) respectively.
      * @param - Badge to create.
@@ -24,13 +21,7 @@ interface UpdateBadgeSignature {
     /**
      * Updates a badge.
      *
-     * The `updateBadge()` function returns a Promise that resolves to the updated badge.
-     *
-     * 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`, if you change `title`, `slug` is updated accordingly.
-     *
-     * `badgeId` 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.
+     * Note that the badge `slug` is based on the badge `title`. If you update the `title`, the `slug` updates accordingly.
      * @param - Badge ID.
      * @returns Updated badge.
      */
@@ -39,26 +30,20 @@ interface UpdateBadgeSignature {
 export declare function listBadges(httpClient: HttpClient): ListBadgesSignature;
 interface ListBadgesSignature {
     /**
-     * Lists the badges.
-     *
+     * Retrieves up to 1,000 badges, given the requested paging.
      *
-     * The `listBadges` function returns a Promise that resolves when the badges are retrieved. Retrieves up to 1000 badges, given the requested paging. Default paging.limit is 100, paging.offset - 0.
+     * Default `paging.limit` is `100` and `paging.offset` is `0`.
      *
-     * This function is not a universal function and runs only on the backend.
+     * This method is not universal and only runs on the backend.
      */
     (options?: ListBadgesOptions | undefined): Promise<ListBadgesResponse & ListBadgesResponseNonNullableFields>;
 }
 export declare function getBadge(httpClient: HttpClient): GetBadgeSignature;
 interface GetBadgeSignature {
     /**
-     * Retrieves information about a badge.
+     * Retrieves a badge.
      *
-     *
-     * The `getBadge` function returns a Promise that resolves when the badge information is retrieved.
-     *
-     * The `_id` 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.
-     *
-     * This function is not a universal function and runs only on the backend.
+     * This method is not universal and only runs on the backend.
      * @param - Badge ID.
      * @returns Badge.
      */
@@ -68,11 +53,6 @@ export declare function deleteBadge(httpClient: HttpClient): DeleteBadgeSignatur
 interface DeleteBadgeSignature {
     /**
      * Deletes a badge.
-     *
-     *
-     * The `deleteBadge()` function returns a Promise that resolves when the specified badge is deleted.
-     *
-     * 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.
      * @param - Badge ID.
      */
     (_id: string): Promise<void>;
@@ -82,24 +62,19 @@ interface AssignBadgeSignature {
     /**
      * Assigns a badge to site members.
      *
-     *
-     * The `assignBadge()` function returns a Promise that resolves when the specified badge is assigned to the specified members.
-     *
-     * 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.
+     * Members inherit the badge's permissions when they receive the badge.
+     * Badge permissions are added to previous member permissions, they don't replace the existing permissions.
      * @param - Badge ID.
-     * @param - List of member IDs to assign to the badge.
+     * @param - Member IDs to assign to the badge.
      */
     (_id: string, memberIds: string[]): Promise<AssignBadgeResponse & AssignBadgeResponseNonNullableFields>;
 }
 export declare function unassignBadge(httpClient: HttpClient): UnassignBadgeSignature;
 interface UnassignBadgeSignature {
     /**
-     * Removes site members from an assigned badge.
-     *
+     * Removes an assigned badge from multiple site members.
      *
-     * The `unassignBadge()` function returns a Promise that resolves when the specified members are removed as holders of the specified badge.
-     *
-     * 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.
+     * The members lose the badge's permissions when the badge is removed.
      * @param - Badge ID.
      * @param - List of members to remove.
      */
@@ -108,16 +83,11 @@ interface UnassignBadgeSignature {
 export declare function listMembersByBadge(httpClient: HttpClient): ListMembersByBadgeSignature;
 interface ListMembersByBadgeSignature {
     /**
-     * Lists the IDs of all members assigned to a badge.
-     *
-     *
-     * The `listMembersByBadge()` function returns a Promise that resolves to a list of member IDs assigned to the specified badge.
+     * Retrieves up to 1,000 site members assigned to a badge.
      *
-     * Retrieves up to 1000 site members who have a specified badge. Default `paging.limit` is 100, `paging.offset` - 0.
+     * Default `paging.limit` is `100` and `paging.offset` is `0`.
      *
-     * The `_id` 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.
-     *
-     * This function is not a universal function and runs only on the backend.
+     * This method is not universal and only runs on the backend.
      * @param - Badge ID.
      */
     (_id: string, options?: ListMembersByBadgeOptions | undefined): Promise<ListMembersResponse & ListMembersResponseNonNullableFields>;
@@ -125,38 +95,31 @@ interface ListMembersByBadgeSignature {
 export declare function listBadgesPerMember(httpClient: HttpClient): ListBadgesPerMemberSignature;
 interface ListBadgesPerMemberSignature {
     /**
-     * Lists the badges assigned to each of the specified site members.
-     *
+     * Retrieves badges assigned to specified members.
      *
-     * The `listBadgesPerMember()` function returns a Promise that resolves to a list of badge IDs associated with each of the specified members.
+     * Members are typically associated with a contact, each having a distinct `memberId` and `contactId`. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
      *
-     * This function is not a universal function and runs only on the backend.
-     * @param - List of members.
+     * This method is not universal and only runs on the backend.
+     * @param - Member IDs to retrieve badges for.
      */
     (memberIds: string[]): Promise<ListMembersBadgeIdsResponse & ListMembersBadgeIdsResponseNonNullableFields>;
 }
 export declare function getMemberCountsPerBadge(httpClient: HttpClient): GetMemberCountsPerBadgeSignature;
 interface GetMemberCountsPerBadgeSignature {
     /**
-     * Retrieves member count per badge.
-     *
+     * Retrieves a member count per badge.
      *
-     * The `getMemberCountsPerBadge` function returns a Promise that resolves when the member counts of each badge are retrieved.
-     *
-     * This function is not a universal function and runs only on the backend.
+     * This method is not universal function and only runs on the backend.
      */
     (): Promise<GetMemberCountsPerBadgeResponse & GetMemberCountsPerBadgeResponseNonNullableFields>;
 }
 export declare function updateBadgesDisplayOrder(httpClient: HttpClient): UpdateBadgesDisplayOrderSignature;
 interface UpdateBadgesDisplayOrderSignature {
     /**
-     * Updates badges' display order.
-     *
-     *
-     * 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.
+     * Updates the display order of badges.
      *
-     * This function is not a universal function and runs only on the backend
-     * @param - Ordered badge IDs.
+     * This method is not universal function and only runs on the backend
+     * @param - Badge IDs in the order to display.
      */
     (badgeIds: string[]): Promise<UpdateBadgesDisplayOrderResponse & UpdateBadgesDisplayOrderResponseNonNullableFields>;
 }

package/build/cjs/src/badges-v3-badge-badges.public.js.map

@@ -1 +1 @@
-{"version":3,"file":"badges-v3-badge-badges.public.js","sourceRoot":"","sources":["../../../src/badges-v3-badge-badges.public.ts"],"names":[],"mappings":";;;AAAA,oFAAkG;AAClG,0EAAkG;AAClG,sFAAkF;AAClF,8CAA6D;AAC7D,+FAkC+C;AAElC,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC;AAE3D,SAAgB,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,KAAY,EAAE,EAAE,CACtB,IAAA,iDAAoB,EAClB,KAAK;IACL,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,kCAOC;AAkBD,SAAgB,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,GAAW,EAAE,KAAkB,EAAE,EAAE,CACzC,IAAA,iDAAoB,EAClB,GAAG,EACH,KAAK;IACL,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,kCAQC;AAmBD,SAAgB,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,OAA2B,EAAE,EAAE,CACrC,IAAA,gDAAmB,EACjB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,gCAOC;AAgBD,SAAgB,QAAQ,CAAC,UAAsB;IAC7C,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,IAAA,8CAAiB,EACf,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,4BAOC;AAkBD,SAAgB,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,IAAA,iDAAoB,EAClB,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,kCAOC;AAeD,SAAgB,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,GAAW,EAAE,SAAmB,EAAE,EAAE,CAC1C,IAAA,iDAAoB,EAClB,GAAG,EACH,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,kCAQC;AAkBD,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,GAAW,EAAE,SAAmB,EAAE,EAAE,CAC1C,IAAA,mDAAsB,EACpB,GAAG,EACH,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,sCAQC;AAgBD,SAAgB,kBAAkB,CAChC,UAAsB;IAEtB,OAAO,CAAC,GAAW,EAAE,OAAmC,EAAE,EAAE,CAC1D,IAAA,wDAA2B,EACzB,GAAG,EACH,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAVD,gDAUC;AAqBD,SAAgB,mBAAmB,CACjC,UAAsB;IAEtB,OAAO,CAAC,SAAmB,EAAE,EAAE,CAC7B,IAAA,yDAA4B,EAC1B,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,kDASC;AAiBD,SAAgB,uBAAuB,CACrC,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,IAAA,6DAAgC;IAC9B,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,0DAQC;AAiBD,SAAgB,wBAAwB,CACtC,UAAsB;IAEtB,OAAO,CAAC,QAAkB,EAAE,EAAE,CAC5B,IAAA,8DAAiC,EAC/B,QAAQ;IACR,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,4DASC;AAkBY,QAAA,eAAe,GAAG,IAAA,2BAAe,EAC5C,oCAAoC,EACpC,IAAI,EACJ,CAAC,KAA4B,EAAE,EAAE,CAC/B,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;KACxC;CACF,CAAC,CACH,CACJ,EAAyB,CAAC;AACd,QAAA,iBAAiB,GAAG,IAAA,2BAAe,EAC9C,sCAAsC,EACtC,IAAI,EACJ,CAAC,KAA8B,EAAE,EAAE,CACjC,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;KACxC;CACF,CAAC,CACH,CACJ,EAA2B,CAAC;AAChB,QAAA,cAAc,GAAG,IAAA,2BAAe,EAC3C,6BAA6B,EAC7B,IAAI,EACJ,CAAC,KAA2B,EAAE,EAAE,CAC9B,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAAwB,CAAC;AACb,QAAA,cAAc,GAAG,IAAA,2BAAe,EAC3C,6BAA6B,EAC7B,IAAI,EACJ,CAAC,KAA2B,EAAE,EAAE,CAC9B,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,uBAAuB,EAAE;YACjC,EAAE,IAAI,EAAE,uBAAuB,EAAE;YACjC,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAAwB,CAAC;AACb,QAAA,cAAc,GAAG,IAAA,2BAAe,EAC3C,6BAA6B,EAC7B,IAAI,EACJ,CAAC,KAA2B,EAAE,EAAE,CAC9B,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAAwB,CAAC;AAE1B,6FA0E+C;AAZ7C,gIAAA,SAAS,OAAA;AAWT,0IAAA,mBAAmB,OAAA"}
+{"version":3,"file":"badges-v3-badge-badges.public.js","sourceRoot":"","sources":["../../../src/badges-v3-badge-badges.public.ts"],"names":[],"mappings":";;;AAAA,oFAAkG;AAClG,0EAAkG;AAClG,sFAAkF;AAClF,8CAA6D;AAC7D,+FAkC+C;AAElC,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC;AAE3D,SAAgB,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,KAAY,EAAE,EAAE,CACtB,IAAA,iDAAoB,EAClB,KAAK;IACL,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,kCAOC;AAeD,SAAgB,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,GAAW,EAAE,KAAkB,EAAE,EAAE,CACzC,IAAA,iDAAoB,EAClB,GAAG,EACH,KAAK;IACL,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,kCAQC;AAaD,SAAgB,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,OAA2B,EAAE,EAAE,CACrC,IAAA,gDAAmB,EACjB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,gCAOC;AAeD,SAAgB,QAAQ,CAAC,UAAsB;IAC7C,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,IAAA,8CAAiB,EACf,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,4BAOC;AAaD,SAAgB,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,IAAA,iDAAoB,EAClB,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,kCAOC;AAUD,SAAgB,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,GAAW,EAAE,SAAmB,EAAE,EAAE,CAC1C,IAAA,iDAAoB,EAClB,GAAG,EACH,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,kCAQC;AAgBD,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,GAAW,EAAE,SAAmB,EAAE,EAAE,CAC1C,IAAA,mDAAsB,EACpB,GAAG,EACH,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,sCAQC;AAaD,SAAgB,kBAAkB,CAChC,UAAsB;IAEtB,OAAO,CAAC,GAAW,EAAE,OAAmC,EAAE,EAAE,CAC1D,IAAA,wDAA2B,EACzB,GAAG,EACH,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAVD,gDAUC;AAgBD,SAAgB,mBAAmB,CACjC,UAAsB;IAEtB,OAAO,CAAC,SAAmB,EAAE,EAAE,CAC7B,IAAA,yDAA4B,EAC1B,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,kDASC;AAgBD,SAAgB,uBAAuB,CACrC,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,IAAA,6DAAgC;IAC9B,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,0DAQC;AAcD,SAAgB,wBAAwB,CACtC,UAAsB;IAEtB,OAAO,CAAC,QAAkB,EAAE,EAAE,CAC5B,IAAA,8DAAiC,EAC/B,QAAQ;IACR,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,4DASC;AAeY,QAAA,eAAe,GAAG,IAAA,2BAAe,EAC5C,oCAAoC,EACpC,IAAI,EACJ,CAAC,KAA4B,EAAE,EAAE,CAC/B,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;KACxC;CACF,CAAC,CACH,CACJ,EAAyB,CAAC;AACd,QAAA,iBAAiB,GAAG,IAAA,2BAAe,EAC9C,sCAAsC,EACtC,IAAI,EACJ,CAAC,KAA8B,EAAE,EAAE,CACjC,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;KACxC;CACF,CAAC,CACH,CACJ,EAA2B,CAAC;AAChB,QAAA,cAAc,GAAG,IAAA,2BAAe,EAC3C,6BAA6B,EAC7B,IAAI,EACJ,CAAC,KAA2B,EAAE,EAAE,CAC9B,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAAwB,CAAC;AACb,QAAA,cAAc,GAAG,IAAA,2BAAe,EAC3C,6BAA6B,EAC7B,IAAI,EACJ,CAAC,KAA2B,EAAE,EAAE,CAC9B,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,uBAAuB,EAAE;YACjC,EAAE,IAAI,EAAE,uBAAuB,EAAE;YACjC,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAAwB,CAAC;AACb,QAAA,cAAc,GAAG,IAAA,2BAAe,EAC3C,6BAA6B,EAC7B,IAAI,EACJ,CAAC,KAA2B,EAAE,EAAE,CAC9B,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAAwB,CAAC;AAE1B,6FA0E+C;AAZ7C,gIAAA,SAAS,OAAA;AAWT,0IAAA,mBAAmB,OAAA"}