@wix/auto_sdk_members_badges 1.0.11 → 1.0.13

package/build/cjs/index.d.ts

@@ -1 +1,163 @@
-export * from './src/badges-v3-badge-badges.context.js';
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { B as Badge, U as UpdateBadge, L as ListBadgesOptions, a as ListBadgesResponse, A as AssignBadgeResponse, b as ListMembersByBadgeOptions, c as ListMembersResponse, d as ListMembersBadgeIdsResponse, G as GetMemberCountsPerBadgeResponse, e as UpdateBadgesDisplayOrderResponse, f as BadgeAssignedEnvelope, g as BadgeUnassignedEnvelope, h as BadgeCreatedEnvelope, i as BadgeDeletedEnvelope, j as BadgeUpdatedEnvelope } from './badges-v3-badge-badges.universal-DVnY9Z3c.js';
+export { a3 as ActionEvent, w as AssignBadgeRequest, y as AssignBadgesRequest, z as AssignBadgesResponse, x as BadgeAssigned, N as BadgeMemberCount, H as BadgeUnassigned, a7 as BaseEventMetadata, u as CountBadgesRequest, v as CountBadgesResponse, C as CreateBadgeRequest, k as CreateBadgeResponse, T as CursorPaging, X as CursorPagingMetadata, Y as Cursors, D as DeleteBadgeRequest, t as DeleteBadgeResponse, Z as DomainEvent, _ as DomainEventBodyOneOf, $ as EntityCreatedEvent, a2 as EntityDeletedEvent, a1 as EntityUpdatedEvent, a8 as EventMetadata, r as GetBadgeRequest, s as GetBadgeResponse, K as GetMemberCountsPerBadgeRequest, a5 as IdentificationData, a6 as IdentificationDataIdOneOf, n as ListBadgesRequest, J as ListMembersBadgeIdsRequest, I as ListMembersRequest, R as ListMembersWithBadgesRequest, V as ListMembersWithBadgesResponse, M as MemberBadgeIds, a4 as MessageEnvelope, P as Paging, o as PagingMetadata, Q as QueryBadgesRequest, q as QueryBadgesResponse, a0 as RestoreInfo, S as SortOrder, p as Sorting, E as UnassignBadgeRequest, F as UnassignBadgeResponse, l as UpdateBadgeRequest, m as UpdateBadgeResponse, O as UpdateBadgesDisplayOrderRequest, W as WebhookIdentityType } from './badges-v3-badge-badges.universal-DVnY9Z3c.js';
+
+declare function createBadge$1(httpClient: HttpClient): CreateBadgeSignature;
+interface CreateBadgeSignature {
+    /**
+     * Creates a badge.
+     *
+     * 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.
+     * @returns Created badge.
+     */
+    (badge: Badge): Promise<Badge>;
+}
+declare function updateBadge$1(httpClient: HttpClient): UpdateBadgeSignature;
+interface UpdateBadgeSignature {
+    /**
+     * Updates a badge.
+     *
+     * 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.
+     */
+    (_id: string, badge: UpdateBadge): Promise<Badge>;
+}
+declare function listBadges$1(httpClient: HttpClient): ListBadgesSignature;
+interface ListBadgesSignature {
+    /**
+     * Retrieves up to 1,000 badges, given the requested paging.
+     *
+     * Default `paging.limit` is `100` and `paging.offset` is `0`.
+     *
+     * This method is not universal and only runs on the backend.
+     */
+    (options?: ListBadgesOptions | undefined): Promise<ListBadgesResponse>;
+}
+declare function getBadge$1(httpClient: HttpClient): GetBadgeSignature;
+interface GetBadgeSignature {
+    /**
+     * Retrieves a badge.
+     *
+     * This method is not universal and only runs on the backend.
+     * @param - Badge ID.
+     * @returns Badge.
+     */
+    (_id: string): Promise<Badge>;
+}
+declare function deleteBadge$1(httpClient: HttpClient): DeleteBadgeSignature;
+interface DeleteBadgeSignature {
+    /**
+     * Deletes a badge.
+     * @param - Badge ID.
+     */
+    (_id: string): Promise<void>;
+}
+declare function assignBadge$1(httpClient: HttpClient): AssignBadgeSignature;
+interface AssignBadgeSignature {
+    /**
+     * Assigns a badge to site members.
+     *
+     * 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 - Member IDs to assign to the badge.
+     */
+    (_id: string, memberIds: string[]): Promise<AssignBadgeResponse>;
+}
+declare function unassignBadge$1(httpClient: HttpClient): UnassignBadgeSignature;
+interface UnassignBadgeSignature {
+    /**
+     * Removes an assigned badge from multiple site members.
+     *
+     * The members lose the badge's permissions when the badge is removed.
+     * @param - Badge ID.
+     * @param - List of members to remove.
+     */
+    (_id: string, memberIds: string[]): Promise<void>;
+}
+declare function listMembersByBadge$1(httpClient: HttpClient): ListMembersByBadgeSignature;
+interface ListMembersByBadgeSignature {
+    /**
+     * Retrieves up to 1,000 site members assigned to a badge.
+     *
+     * Default `paging.limit` is `100` and `paging.offset` is `0`.
+     *
+     * This method is not universal and only runs on the backend.
+     * @param - Badge ID.
+     */
+    (_id: string, options?: ListMembersByBadgeOptions | undefined): Promise<ListMembersResponse>;
+}
+declare function listBadgesPerMember$1(httpClient: HttpClient): ListBadgesPerMemberSignature;
+interface ListBadgesPerMemberSignature {
+    /**
+     * Retrieves badges assigned to 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 method is not universal and only runs on the backend.
+     * @param - Member IDs to retrieve badges for.
+     */
+    (memberIds: string[]): Promise<ListMembersBadgeIdsResponse>;
+}
+declare function getMemberCountsPerBadge$1(httpClient: HttpClient): GetMemberCountsPerBadgeSignature;
+interface GetMemberCountsPerBadgeSignature {
+    /**
+     * Retrieves a member count per badge.
+     *
+     * This method is not universal function and only runs on the backend.
+     */
+    (): Promise<GetMemberCountsPerBadgeResponse>;
+}
+declare function updateBadgesDisplayOrder$1(httpClient: HttpClient): UpdateBadgesDisplayOrderSignature;
+interface UpdateBadgesDisplayOrderSignature {
+    /**
+     * Updates the display order of badges.
+     *
+     * This method is not universal function and only runs on the backend
+     * @param - Badge IDs in the order to display.
+     */
+    (badgeIds: string[]): Promise<UpdateBadgesDisplayOrderResponse>;
+}
+declare const onBadgeAssigned$1: EventDefinition<BadgeAssignedEnvelope, "wix.badges.v3.badge_badge_assigned">;
+declare const onBadgeUnassigned$1: EventDefinition<BadgeUnassignedEnvelope, "wix.badges.v3.badge_badge_unassigned">;
+declare const onBadgeCreated$1: EventDefinition<BadgeCreatedEnvelope, "wix.badges.v3.badge_created">;
+declare const onBadgeDeleted$1: EventDefinition<BadgeDeletedEnvelope, "wix.badges.v3.badge_deleted">;
+declare const onBadgeUpdated$1: EventDefinition<BadgeUpdatedEnvelope, "wix.badges.v3.badge_updated">;
+
+declare const createBadge: MaybeContext<BuildRESTFunction<typeof createBadge$1> & typeof createBadge$1>;
+declare const updateBadge: MaybeContext<BuildRESTFunction<typeof updateBadge$1> & typeof updateBadge$1>;
+declare const listBadges: MaybeContext<BuildRESTFunction<typeof listBadges$1> & typeof listBadges$1>;
+declare const getBadge: MaybeContext<BuildRESTFunction<typeof getBadge$1> & typeof getBadge$1>;
+declare const deleteBadge: MaybeContext<BuildRESTFunction<typeof deleteBadge$1> & typeof deleteBadge$1>;
+declare const assignBadge: MaybeContext<BuildRESTFunction<typeof assignBadge$1> & typeof assignBadge$1>;
+declare const unassignBadge: MaybeContext<BuildRESTFunction<typeof unassignBadge$1> & typeof unassignBadge$1>;
+declare const listMembersByBadge: MaybeContext<BuildRESTFunction<typeof listMembersByBadge$1> & typeof listMembersByBadge$1>;
+declare const listBadgesPerMember: MaybeContext<BuildRESTFunction<typeof listBadgesPerMember$1> & typeof listBadgesPerMember$1>;
+declare const getMemberCountsPerBadge: MaybeContext<BuildRESTFunction<typeof getMemberCountsPerBadge$1> & typeof getMemberCountsPerBadge$1>;
+declare const updateBadgesDisplayOrder: MaybeContext<BuildRESTFunction<typeof updateBadgesDisplayOrder$1> & typeof updateBadgesDisplayOrder$1>;
+/**
+ * Triggered when a member receives a badge.
+ */
+declare const onBadgeAssigned: BuildEventDefinition<typeof onBadgeAssigned$1>;
+/**
+ * Triggered when a member's badge is removed.
+ */
+declare const onBadgeUnassigned: BuildEventDefinition<typeof onBadgeUnassigned$1>;
+/**
+ * Triggered when a badge is created.
+ */
+declare const onBadgeCreated: BuildEventDefinition<typeof onBadgeCreated$1>;
+/**
+ * Triggered when a badge is deleted.
+ */
+declare const onBadgeDeleted: BuildEventDefinition<typeof onBadgeDeleted$1>;
+/**
+ * Triggered when a badge is updated.
+ */
+declare const onBadgeUpdated: BuildEventDefinition<typeof onBadgeUpdated$1>;
+
+export { AssignBadgeResponse, Badge, BadgeAssignedEnvelope, BadgeCreatedEnvelope, BadgeDeletedEnvelope, BadgeUnassignedEnvelope, BadgeUpdatedEnvelope, GetMemberCountsPerBadgeResponse, ListBadgesOptions, ListBadgesResponse, ListMembersBadgeIdsResponse, ListMembersByBadgeOptions, ListMembersResponse, UpdateBadge, UpdateBadgesDisplayOrderResponse, assignBadge, createBadge, deleteBadge, getBadge, getMemberCountsPerBadge, listBadges, listBadgesPerMember, listMembersByBadge, onBadgeAssigned, onBadgeCreated, onBadgeDeleted, onBadgeUnassigned, onBadgeUpdated, unassignBadge, updateBadge, updateBadgesDisplayOrder };