@wix/auto_sdk_members_badges 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1 @@
+export * from './src/badges-v3-badge-badges.context.js';

package/build/cjs/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/badges-v3-badge-badges.context.js"), exports);
+//# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0EAAwD"}

package/build/cjs/index.typings.d.ts

@@ -0,0 +1 @@
+export * from './src/badges-v3-badge-badges.universal.js';

package/build/cjs/index.typings.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/badges-v3-badge-badges.universal.js"), exports);
+//# sourceMappingURL=index.typings.js.map

package/build/cjs/index.typings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.typings.js","sourceRoot":"","sources":["../../index.typings.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4EAA0D"}

package/build/cjs/meta.d.ts

@@ -0,0 +1 @@
+export * from './src/badges-v3-badge-badges.meta.js';

package/build/cjs/meta.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/badges-v3-badge-badges.meta.js"), exports);
+//# sourceMappingURL=meta.js.map

package/build/cjs/meta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"meta.js","sourceRoot":"","sources":["../../meta.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uEAAqD"}

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

@@ -0,0 +1,41 @@
+import { createBadge as publicCreateBadge, updateBadge as publicUpdateBadge, listBadges as publicListBadges, getBadge as publicGetBadge, deleteBadge as publicDeleteBadge, assignBadge as publicAssignBadge, unassignBadge as publicUnassignBadge, listMembersByBadge as publicListMembersByBadge, listBadgesPerMember as publicListBadgesPerMember, getMemberCountsPerBadge as publicGetMemberCountsPerBadge, updateBadgesDisplayOrder as publicUpdateBadgesDisplayOrder } from './badges-v3-badge-badges.public.js';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+import { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';
+import { onBadgeAssigned as publicOnBadgeAssigned } from './badges-v3-badge-badges.public.js';
+import { onBadgeUnassigned as publicOnBadgeUnassigned } from './badges-v3-badge-badges.public.js';
+import { onBadgeCreated as publicOnBadgeCreated } from './badges-v3-badge-badges.public.js';
+import { onBadgeDeleted as publicOnBadgeDeleted } from './badges-v3-badge-badges.public.js';
+import { onBadgeUpdated as publicOnBadgeUpdated } from './badges-v3-badge-badges.public.js';
+export declare const createBadge: MaybeContext<BuildRESTFunction<typeof publicCreateBadge> & typeof publicCreateBadge>;
+export declare const updateBadge: MaybeContext<BuildRESTFunction<typeof publicUpdateBadge> & typeof publicUpdateBadge>;
+export declare const listBadges: MaybeContext<BuildRESTFunction<typeof publicListBadges> & typeof publicListBadges>;
+export declare const getBadge: MaybeContext<BuildRESTFunction<typeof publicGetBadge> & typeof publicGetBadge>;
+export declare const deleteBadge: MaybeContext<BuildRESTFunction<typeof publicDeleteBadge> & typeof publicDeleteBadge>;
+export declare const assignBadge: MaybeContext<BuildRESTFunction<typeof publicAssignBadge> & typeof publicAssignBadge>;
+export declare const unassignBadge: MaybeContext<BuildRESTFunction<typeof publicUnassignBadge> & typeof publicUnassignBadge>;
+export declare const listMembersByBadge: MaybeContext<BuildRESTFunction<typeof publicListMembersByBadge> & typeof publicListMembersByBadge>;
+export declare const listBadgesPerMember: MaybeContext<BuildRESTFunction<typeof publicListBadgesPerMember> & typeof publicListBadgesPerMember>;
+export declare const getMemberCountsPerBadge: MaybeContext<BuildRESTFunction<typeof publicGetMemberCountsPerBadge> & typeof publicGetMemberCountsPerBadge>;
+export declare const updateBadgesDisplayOrder: MaybeContext<BuildRESTFunction<typeof publicUpdateBadgesDisplayOrder> & typeof publicUpdateBadgesDisplayOrder>;
+/**
+ * Triggered when a member receives a badge.
+ */
+export declare const onBadgeAssigned: ReturnType<typeof createEventModule<typeof publicOnBadgeAssigned>>;
+/**
+ * Triggered when a member's badge is removed.
+ */
+export declare const onBadgeUnassigned: ReturnType<typeof createEventModule<typeof publicOnBadgeUnassigned>>;
+/**
+ * Triggered when a badge is created.
+ */
+export declare const onBadgeCreated: ReturnType<typeof createEventModule<typeof publicOnBadgeCreated>>;
+/**
+ * Triggered when a badge is deleted.
+ */
+export declare const onBadgeDeleted: ReturnType<typeof createEventModule<typeof publicOnBadgeDeleted>>;
+/**
+ * Triggered when a badge is updated.
+ */
+export declare const onBadgeUpdated: ReturnType<typeof createEventModule<typeof publicOnBadgeUpdated>>;
+export { SortOrder, WebhookIdentityType, } from './badges-v3-badge-badges.universal.js';
+export { Badge, CreateBadgeRequest, CreateBadgeResponse, UpdateBadgeRequest, UpdateBadgeResponse, ListBadgesRequest, Paging, ListBadgesResponse, PagingMetadata, QueryBadgesRequest, Sorting, QueryBadgesResponse, GetBadgeRequest, GetBadgeResponse, DeleteBadgeRequest, DeleteBadgeResponse, CountBadgesRequest, CountBadgesResponse, AssignBadgeRequest, AssignBadgeResponse, BadgeAssigned, AssignBadgesRequest, AssignBadgesResponse, UnassignBadgeRequest, UnassignBadgeResponse, BadgeUnassigned, ListMembersRequest, ListMembersResponse, ListMembersBadgeIdsRequest, ListMembersBadgeIdsResponse, MemberBadgeIds, GetMemberCountsPerBadgeRequest, GetMemberCountsPerBadgeResponse, BadgeMemberCount, UpdateBadgesDisplayOrderRequest, UpdateBadgesDisplayOrderResponse, ListMembersWithBadgesRequest, CursorPaging, ListMembersWithBadgesResponse, CursorPagingMetadata, Cursors, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, RestoreInfo, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, BadgeNonNullableFields, CreateBadgeResponseNonNullableFields, UpdateBadgeResponseNonNullableFields, ListBadgesResponseNonNullableFields, GetBadgeResponseNonNullableFields, AssignBadgeResponseNonNullableFields, ListMembersResponseNonNullableFields, ListMembersBadgeIdsResponseNonNullableFields, GetMemberCountsPerBadgeResponseNonNullableFields, UpdateBadgesDisplayOrderResponseNonNullableFields, BaseEventMetadata, EventMetadata, BadgeAssignedEnvelope, BadgeUnassignedEnvelope, BadgeCreatedEnvelope, BadgeDeletedEnvelope, BadgeUpdatedEnvelope, UpdateBadge, ListBadgesOptions, ListMembersByBadgeOptions, } from './badges-v3-badge-badges.universal.js';

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

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookIdentityType = exports.SortOrder = exports.onBadgeUpdated = exports.onBadgeDeleted = exports.onBadgeCreated = exports.onBadgeUnassigned = exports.onBadgeAssigned = exports.updateBadgesDisplayOrder = exports.getMemberCountsPerBadge = exports.listBadgesPerMember = exports.listMembersByBadge = exports.unassignBadge = exports.assignBadge = exports.deleteBadge = exports.getBadge = exports.listBadges = exports.updateBadge = exports.createBadge = void 0;
+const badges_v3_badge_badges_public_js_1 = require("./badges-v3-badge-badges.public.js");
+const rest_modules_1 = require("@wix/sdk-runtime/rest-modules");
+const event_definition_modules_1 = require("@wix/sdk-runtime/event-definition-modules");
+const badges_v3_badge_badges_public_js_2 = require("./badges-v3-badge-badges.public.js");
+const badges_v3_badge_badges_public_js_3 = require("./badges-v3-badge-badges.public.js");
+const badges_v3_badge_badges_public_js_4 = require("./badges-v3-badge-badges.public.js");
+const badges_v3_badge_badges_public_js_5 = require("./badges-v3-badge-badges.public.js");
+const badges_v3_badge_badges_public_js_6 = require("./badges-v3-badge-badges.public.js");
+exports.createBadge = (0, rest_modules_1.createRESTModule)(badges_v3_badge_badges_public_js_1.createBadge);
+exports.updateBadge = (0, rest_modules_1.createRESTModule)(badges_v3_badge_badges_public_js_1.updateBadge);
+exports.listBadges = (0, rest_modules_1.createRESTModule)(badges_v3_badge_badges_public_js_1.listBadges);
+exports.getBadge = (0, rest_modules_1.createRESTModule)(badges_v3_badge_badges_public_js_1.getBadge);
+exports.deleteBadge = (0, rest_modules_1.createRESTModule)(badges_v3_badge_badges_public_js_1.deleteBadge);
+exports.assignBadge = (0, rest_modules_1.createRESTModule)(badges_v3_badge_badges_public_js_1.assignBadge);
+exports.unassignBadge = (0, rest_modules_1.createRESTModule)(badges_v3_badge_badges_public_js_1.unassignBadge);
+exports.listMembersByBadge = (0, rest_modules_1.createRESTModule)(badges_v3_badge_badges_public_js_1.listMembersByBadge);
+exports.listBadgesPerMember = (0, rest_modules_1.createRESTModule)(badges_v3_badge_badges_public_js_1.listBadgesPerMember);
+exports.getMemberCountsPerBadge = (0, rest_modules_1.createRESTModule)(badges_v3_badge_badges_public_js_1.getMemberCountsPerBadge);
+exports.updateBadgesDisplayOrder = (0, rest_modules_1.createRESTModule)(badges_v3_badge_badges_public_js_1.updateBadgesDisplayOrder);
+/**
+ * Triggered when a member receives a badge.
+ */
+exports.onBadgeAssigned = (0, event_definition_modules_1.createEventModule)(badges_v3_badge_badges_public_js_2.onBadgeAssigned);
+/**
+ * Triggered when a member's badge is removed.
+ */
+exports.onBadgeUnassigned = (0, event_definition_modules_1.createEventModule)(badges_v3_badge_badges_public_js_3.onBadgeUnassigned);
+/**
+ * Triggered when a badge is created.
+ */
+exports.onBadgeCreated = (0, event_definition_modules_1.createEventModule)(badges_v3_badge_badges_public_js_4.onBadgeCreated);
+/**
+ * Triggered when a badge is deleted.
+ */
+exports.onBadgeDeleted = (0, event_definition_modules_1.createEventModule)(badges_v3_badge_badges_public_js_5.onBadgeDeleted);
+/**
+ * Triggered when a badge is updated.
+ */
+exports.onBadgeUpdated = (0, event_definition_modules_1.createEventModule)(badges_v3_badge_badges_public_js_6.onBadgeUpdated);
+var badges_v3_badge_badges_universal_js_1 = require("./badges-v3-badge-badges.universal.js");
+Object.defineProperty(exports, "SortOrder", { enumerable: true, get: function () { return badges_v3_badge_badges_universal_js_1.SortOrder; } });
+Object.defineProperty(exports, "WebhookIdentityType", { enumerable: true, get: function () { return badges_v3_badge_badges_universal_js_1.WebhookIdentityType; } });
+//# sourceMappingURL=badges-v3-badge-badges.context.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"badges-v3-badge-badges.context.js","sourceRoot":"","sources":["../../../src/badges-v3-badge-badges.context.ts"],"names":[],"mappings":";;;AAAA,yFAY4C;AAC5C,gEAAiE;AACjE,wFAA8E;AAE9E,yFAA8F;AAC9F,yFAAkG;AAClG,yFAA4F;AAC5F,yFAA4F;AAC5F,yFAA4F;AAE/E,QAAA,WAAW,GAEN,IAAA,+BAAgB,EAAC,8CAAiB,CAAC,CAAC;AACzC,QAAA,WAAW,GAEN,IAAA,+BAAgB,EAAC,8CAAiB,CAAC,CAAC;AACzC,QAAA,UAAU,GAEL,IAAA,+BAAgB,EAAC,6CAAgB,CAAC,CAAC;AACxC,QAAA,QAAQ,GAEH,IAAA,+BAAgB,EAAC,2CAAc,CAAC,CAAC;AACtC,QAAA,WAAW,GAEN,IAAA,+BAAgB,EAAC,8CAAiB,CAAC,CAAC;AACzC,QAAA,WAAW,GAEN,IAAA,+BAAgB,EAAC,8CAAiB,CAAC,CAAC;AACzC,QAAA,aAAa,GAER,IAAA,+BAAgB,EAAC,gDAAmB,CAAC,CAAC;AAC3C,QAAA,kBAAkB,GAGb,IAAA,+BAAgB,EAAC,qDAAwB,CAAC,CAAC;AAChD,QAAA,mBAAmB,GAGd,IAAA,+BAAgB,EAAC,sDAAyB,CAAC,CAAC;AACjD,QAAA,uBAAuB,GAGlB,IAAA,+BAAgB,EAAC,0DAA6B,CAAC,CAAC;AACrD,QAAA,wBAAwB,GAGnB,IAAA,+BAAgB,EAAC,2DAA8B,CAAC,CAAC;AACnE;;GAEG;AACU,QAAA,eAAe,GAExB,IAAA,4CAAiB,EAAC,kDAAqB,CAAC,CAAC;AAC7C;;GAEG;AACU,QAAA,iBAAiB,GAE1B,IAAA,4CAAiB,EAAC,oDAAuB,CAAC,CAAC;AAC/C;;GAEG;AACU,QAAA,cAAc,GAEvB,IAAA,4CAAiB,EAAC,iDAAoB,CAAC,CAAC;AAC5C;;GAEG;AACU,QAAA,cAAc,GAEvB,IAAA,4CAAiB,EAAC,iDAAoB,CAAC,CAAC;AAC5C;;GAEG;AACU,QAAA,cAAc,GAEvB,IAAA,4CAAiB,EAAC,iDAAoB,CAAC,CAAC;AAE5C,6FAG+C;AAF7C,gIAAA,SAAS,OAAA;AACT,0IAAA,mBAAmB,OAAA"}

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

@@ -0,0 +1,111 @@
+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.
+ *
+ * If `backgroundColor` or `textColor` are not specified, they default to `"#796EFF"` (purple) and `"#FFFFFF"` (white) respectively.
+ */
+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.
+ */
+export declare function updateBadge(payload: object): RequestOptionsFactory<any>;
+/**
+ * Lists the badges.
+ *
+ *
+ * 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.
+ *
+ * This function is not a universal function and runs only on the backend.
+ */
+export declare function listBadges(payload: object): RequestOptionsFactory<any>;
+/**
+ * Retrieves information about 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.
+ */
+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.
+ */
+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.
+ */
+export declare function assignBadge(payload: object): RequestOptionsFactory<any>;
+/**
+ * Removes site members from an assigned badge.
+ *
+ *
+ * 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.
+ */
+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 1000 site members who have a specified badge. Default `paging.limit` is 100, `paging.offset` - 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.
+ */
+export declare function listMembers(payload: object): RequestOptionsFactory<any>;
+/**
+ * Lists the badges assigned to each of the specified site members.
+ *
+ *
+ * The `listBadgesPerMember()` function returns a Promise that resolves to a list of badge IDs associated with each of the specified members.
+ *
+ * This function is not a universal function and runs only on the backend.
+ */
+export declare function listMembersBadgeIds(payload: object): RequestOptionsFactory<any>;
+/**
+ * Retrieves 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.
+ */
+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.
+ *
+ * This function is not a universal function and runs only on the backend
+ */
+export declare function updateBadgesDisplayOrder(payload: object): RequestOptionsFactory<any>;