@wix/auto_sdk_members_badges 1.0.0

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

@@ -0,0 +1,835 @@
+export interface Badge {
+    /**
+     * Badge ID.
+     * @readonly
+     */
+    _id?: string;
+    /** Text displayed on the badge in the Wix UI. */
+    title?: string | null;
+    /** Badge description. */
+    description?: string | null;
+    /**
+     * Badge background color in hexadecimal RGB format. Uppercase letters only.
+     *
+     * Default: `#796EFF ` (purple).
+     */
+    backgroundColor?: string | null;
+    /**
+     * Badge text color in hexadecimal RGB format. Uppercase letters only.
+     *
+     * Default: `"#FFFFFF"` (white).
+     */
+    textColor?: string | null;
+    /**
+     * Badge icon as an SVG image. One of:
+     *
+     * - An external web URL in the following format: `http(s)://<image url>`.
+     * - The [source URL](https://www.wix.com/velo/reference/wix-media-backend/mediamanager-obj/getfileurl) for a Wix Media Manager file. Wix Media Manager file names in a `wix:image://...` format are not supported.
+     */
+    icon?: string | null;
+    /**
+     * Whether the badge has special permissions
+     * to access specific members-only pages.
+     * When `true`, members with the badge receive special permissions,
+     * and site contributors can
+     * [manage badge permissions](https://support.wix.com/en/article/setting-permissions-for-a-member-badge)
+     * in the Dashboard.
+     * When `false`, members with the badge receive no special permissions.
+     */
+    permissionsEnabled?: boolean | null;
+    /**
+     * Slugified name. Used to represent the badge in a URL.
+     * @readonly
+     */
+    slug?: string | null;
+    /**
+     * Date the badge was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date the badge was updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+}
+export interface CreateBadgeRequest {
+    /** Badge to create. */
+    badge: Badge;
+}
+export interface CreateBadgeResponse {
+    /** Created badge. */
+    badge?: Badge;
+}
+export interface UpdateBadgeRequest {
+    /** Badge to update. */
+    badge: Badge;
+}
+export interface UpdateBadgeResponse {
+    /** Updated badge. */
+    badge?: Badge;
+}
+export interface ListBadgesRequest {
+    /** Pagination options. */
+    paging?: Paging;
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface ListBadgesResponse {
+    /** List of badges. */
+    badges?: Badge[];
+    /** Metadata for the paginated results. */
+    metadata?: PagingMetadata;
+}
+export interface PagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+}
+export interface QueryBadgesRequest {
+    /**
+     * Filter options.
+     * Currently supported fields for filtering:
+     * - id
+     * - title
+     * - slug
+     * For more details on how to use filter, see [API Query Language: The Filter Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sorting options.
+     * For more details on how to use sorting,
+     * see [API Query Language: The Sort Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-sort-section)
+     */
+    sort?: Sorting[];
+    /** Pagination options.  */
+    paging?: Paging;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface QueryBadgesResponse {
+    /** List of badges. */
+    badges?: Badge[];
+    /** Metadata for the paginated results. */
+    metadata?: PagingMetadata;
+}
+export interface GetBadgeRequest {
+    /** Badge ID. */
+    _id: string;
+}
+export interface GetBadgeResponse {
+    /** Badge. */
+    badge?: Badge;
+}
+export interface DeleteBadgeRequest {
+    /** Badge ID. */
+    _id: string;
+}
+export interface DeleteBadgeResponse {
+}
+export interface CountBadgesRequest {
+    /**
+     * Filter options.
+     * Currently supported fields for filtering:
+     * - id
+     * - title
+     * - slug
+     * For more details on how to use filter, see [API Query Language: The Filter Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+}
+export interface CountBadgesResponse {
+    /** Badge count. */
+    count?: string;
+}
+export interface AssignBadgeRequest {
+    /** Badge ID. */
+    _id: string;
+    /** List of member IDs to assign to the badge. */
+    memberIds: string[];
+}
+export interface AssignBadgeResponse {
+    /** List of member IDs assigned to the badge. */
+    memberIds?: string[];
+}
+export interface BadgeAssigned {
+    /** ID of the member who received the badge. */
+    memberId?: string;
+}
+export interface AssignBadgesRequest {
+    /** List of badge IDs to assign to the member. */
+    ids?: string[];
+    /** Member ID. */
+    memberId?: string;
+}
+export interface AssignBadgesResponse {
+    /** List of badge IDs newly assigned to the member. */
+    ids?: string[];
+}
+export interface UnassignBadgeRequest {
+    /** Badge ID. */
+    _id: string;
+    /** List of members to remove. */
+    memberIds: string[];
+}
+export interface UnassignBadgeResponse {
+}
+export interface BadgeUnassigned {
+    /** ID of the member who lost the badge. */
+    memberId?: string;
+}
+export interface ListMembersRequest {
+    /** Badge ID. */
+    _id: string;
+    /** Pagination options. */
+    paging?: Paging;
+}
+export interface ListMembersResponse {
+    /** Member IDs assigned to the badge. */
+    memberIds?: string[];
+    /** Metadata for the paginated results. */
+    metadata?: PagingMetadata;
+}
+export interface ListMembersBadgeIdsRequest {
+    /** List of members. */
+    memberIds: string[];
+}
+export interface ListMembersBadgeIdsResponse {
+    /** List of members and the badges they're assigned to. */
+    memberBadgeIds?: MemberBadgeIds[];
+}
+export interface MemberBadgeIds {
+    /** Member ID. */
+    memberId?: string;
+    /** List of badges the member is assigned to. */
+    badgeIds?: string[];
+}
+export interface GetMemberCountsPerBadgeRequest {
+}
+export interface GetMemberCountsPerBadgeResponse {
+    /** List of badges and counts of members who have each badge. */
+    badgeMemberCounts?: BadgeMemberCount[];
+}
+export interface BadgeMemberCount {
+    /** Badge ID. */
+    badgeId?: string;
+    /** Badge member count. */
+    memberCount?: number;
+}
+export interface UpdateBadgesDisplayOrderRequest {
+    /** Ordered badge IDs. */
+    badgeIds: string[];
+}
+export interface UpdateBadgesDisplayOrderResponse {
+    /** Reordered badges list. */
+    badges?: Badge[];
+}
+export interface ListMembersWithBadgesRequest {
+    /** Cursor paging options */
+    paging?: CursorPaging;
+}
+export interface CursorPaging {
+    /** Maximum number of items to return in the results. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+export interface ListMembersWithBadgesResponse {
+    /** List of members */
+    memberIds?: string[];
+    /** Metadata for the paginated results */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+export interface Cursors {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entity?: string;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: string;
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+export interface BadgeNonNullableFields {
+    _id: string;
+}
+export interface CreateBadgeResponseNonNullableFields {
+    badge?: BadgeNonNullableFields;
+}
+export interface UpdateBadgeResponseNonNullableFields {
+    badge?: BadgeNonNullableFields;
+}
+export interface ListBadgesResponseNonNullableFields {
+    badges: BadgeNonNullableFields[];
+}
+export interface GetBadgeResponseNonNullableFields {
+    badge?: BadgeNonNullableFields;
+}
+export interface AssignBadgeResponseNonNullableFields {
+    memberIds: string[];
+}
+export interface ListMembersResponseNonNullableFields {
+    memberIds: string[];
+}
+interface MemberBadgeIdsNonNullableFields {
+    memberId: string;
+    badgeIds: string[];
+}
+export interface ListMembersBadgeIdsResponseNonNullableFields {
+    memberBadgeIds: MemberBadgeIdsNonNullableFields[];
+}
+interface BadgeMemberCountNonNullableFields {
+    badgeId: string;
+    memberCount: number;
+}
+export interface GetMemberCountsPerBadgeResponseNonNullableFields {
+    badgeMemberCounts: BadgeMemberCountNonNullableFields[];
+}
+export interface UpdateBadgesDisplayOrderResponseNonNullableFields {
+    badges: BadgeNonNullableFields[];
+}
+export interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+export interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+export interface BadgeAssignedEnvelope {
+    data: BadgeAssigned;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a member receives a badge.
+ * @permissionScope Manage Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES
+ * @permissionScope Read Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-BADGES
+ * @permissionId BADGES.BADGE_READ
+ * @webhook
+ * @eventType wix.badges.v3.badge_badge_assigned
+ */
+export declare function onBadgeAssigned(handler: (event: BadgeAssignedEnvelope) => void | Promise<void>): void;
+export interface BadgeUnassignedEnvelope {
+    data: BadgeUnassigned;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a member's badge is removed.
+ * @permissionScope Manage Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES
+ * @permissionScope Read Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-BADGES
+ * @permissionId BADGES.BADGE_READ
+ * @webhook
+ * @eventType wix.badges.v3.badge_badge_unassigned
+ */
+export declare function onBadgeUnassigned(handler: (event: BadgeUnassignedEnvelope) => void | Promise<void>): void;
+export interface BadgeCreatedEnvelope {
+    entity: Badge;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a badge is created.
+ * @permissionScope Manage Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES
+ * @permissionScope Read Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-BADGES
+ * @permissionId BADGES.BADGE_READ
+ * @webhook
+ * @eventType wix.badges.v3.badge_created
+ */
+export declare function onBadgeCreated(handler: (event: BadgeCreatedEnvelope) => void | Promise<void>): void;
+export interface BadgeDeletedEnvelope {
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a badge is deleted.
+ * @permissionScope Manage Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES
+ * @permissionScope Read Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-BADGES
+ * @permissionId BADGES.BADGE_READ
+ * @webhook
+ * @eventType wix.badges.v3.badge_deleted
+ */
+export declare function onBadgeDeleted(handler: (event: BadgeDeletedEnvelope) => void | Promise<void>): void;
+export interface BadgeUpdatedEnvelope {
+    entity: Badge;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a badge is updated.
+ * @permissionScope Manage Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES
+ * @permissionScope Read Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-BADGES
+ * @permissionId BADGES.BADGE_READ
+ * @webhook
+ * @eventType wix.badges.v3.badge_updated
+ */
+export declare function onBadgeUpdated(handler: (event: BadgeUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * 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.
+ * @param badge - Badge to create.
+ * @public
+ * @requiredField badge
+ * @requiredField badge.backgroundColor
+ * @requiredField badge.textColor
+ * @requiredField badge.title
+ * @permissionId BADGES.BADGE_CREATE
+ * @permissionScope Manage Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES
+ * @applicableIdentity APP
+ * @returns Created badge.
+ * @fqn com.wixpress.badges.v3.BadgesServiceV3.CreateBadge
+ */
+export declare function createBadge(badge: Badge): Promise<Badge & BadgeNonNullableFields>;
+/**
+ * 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.
+ * @param _id - Badge ID.
+ * @public
+ * @requiredField _id
+ * @requiredField badge
+ * @permissionId BADGES.BADGE_UPDATE
+ * @permissionScope Manage Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES
+ * @applicableIdentity APP
+ * @returns Updated badge.
+ * @fqn com.wixpress.badges.v3.BadgesServiceV3.UpdateBadge
+ */
+export declare function updateBadge(_id: string, badge: UpdateBadge): Promise<Badge & BadgeNonNullableFields>;
+export interface UpdateBadge {
+    /**
+     * Badge ID.
+     * @readonly
+     */
+    _id?: string;
+    /** Text displayed on the badge in the Wix UI. */
+    title?: string | null;
+    /** Badge description. */
+    description?: string | null;
+    /**
+     * Badge background color in hexadecimal RGB format. Uppercase letters only.
+     *
+     * Default: `#796EFF ` (purple).
+     */
+    backgroundColor?: string | null;
+    /**
+     * Badge text color in hexadecimal RGB format. Uppercase letters only.
+     *
+     * Default: `"#FFFFFF"` (white).
+     */
+    textColor?: string | null;
+    /**
+     * Badge icon as an SVG image. One of:
+     *
+     * - An external web URL in the following format: `http(s)://<image url>`.
+     * - The [source URL](https://www.wix.com/velo/reference/wix-media-backend/mediamanager-obj/getfileurl) for a Wix Media Manager file. Wix Media Manager file names in a `wix:image://...` format are not supported.
+     */
+    icon?: string | null;
+    /**
+     * Whether the badge has special permissions
+     * to access specific members-only pages.
+     * When `true`, members with the badge receive special permissions,
+     * and site contributors can
+     * [manage badge permissions](https://support.wix.com/en/article/setting-permissions-for-a-member-badge)
+     * in the Dashboard.
+     * When `false`, members with the badge receive no special permissions.
+     */
+    permissionsEnabled?: boolean | null;
+    /**
+     * Slugified name. Used to represent the badge in a URL.
+     * @readonly
+     */
+    slug?: string | null;
+    /**
+     * Date the badge was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date the badge was updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+}
+/**
+ * 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.
+ * @public
+ * @permissionId BADGES.BADGE_READ
+ * @permissionScope Manage Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES
+ * @permissionScope Read Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-BADGES
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.badges.v3.BadgesServiceV3.ListBadges
+ */
+export declare function listBadges(options?: ListBadgesOptions): Promise<ListBadgesResponse & ListBadgesResponseNonNullableFields>;
+export interface ListBadgesOptions {
+    /** Pagination options.  */
+    paging?: Paging;
+}
+/**
+ * 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.
+ * @param _id - Badge ID.
+ * @public
+ * @requiredField _id
+ * @permissionId BADGES.BADGE_READ
+ * @permissionScope Manage Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES
+ * @permissionScope Read Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-BADGES
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @returns Badge.
+ * @fqn com.wixpress.badges.v3.BadgesServiceV3.GetBadge
+ */
+export declare function getBadge(_id: string): Promise<Badge & BadgeNonNullableFields>;
+/**
+ * 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 _id - Badge ID.
+ * @public
+ * @requiredField _id
+ * @permissionId BADGES.BADGE_DELETE
+ * @permissionScope Manage Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.badges.v3.BadgesServiceV3.DeleteBadge
+ */
+export declare function deleteBadge(_id: string): Promise<void>;
+/**
+ * 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.
+ * @param _id - Badge ID.
+ * @param memberIds - List of member IDs to assign to the badge.
+ * @public
+ * @requiredField _id
+ * @requiredField memberIds
+ * @permissionId BADGES.BADGE_ASSIGN
+ * @permissionScope Manage Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.badges.v3.BadgesServiceV3.AssignBadge
+ */
+export declare function assignBadge(_id: string, memberIds: string[]): Promise<AssignBadgeResponse & AssignBadgeResponseNonNullableFields>;
+/**
+ * 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.
+ * @param _id - Badge ID.
+ * @param memberIds - List of members to remove.
+ * @public
+ * @requiredField _id
+ * @requiredField memberIds
+ * @permissionId BADGES.BADGE_ASSIGN
+ * @permissionScope Manage Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.badges.v3.BadgesServiceV3.UnassignBadge
+ */
+export declare function unassignBadge(_id: string, memberIds: string[]): Promise<void>;
+/**
+ * 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.
+ * @param _id - Badge ID.
+ * @public
+ * @requiredField _id
+ * @permissionId BADGES.BADGE_READ_MEMBERS
+ * @permissionScope Manage Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES
+ * @permissionScope Read Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-BADGES
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.badges.v3.BadgesServiceV3.ListMembers
+ */
+export declare function listMembersByBadge(_id: string, options?: ListMembersByBadgeOptions): Promise<ListMembersResponse & ListMembersResponseNonNullableFields>;
+export interface ListMembersByBadgeOptions {
+    /** Pagination options. */
+    paging?: Paging;
+}
+/**
+ * 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.
+ * @param memberIds - List of members.
+ * @public
+ * @requiredField memberIds
+ * @permissionId BADGES.BADGE_READ_MEMBERS
+ * @permissionScope Manage Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES
+ * @permissionScope Read Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-BADGES
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.badges.v3.BadgesServiceV3.ListMembersBadgeIds
+ */
+export declare function listBadgesPerMember(memberIds: string[]): Promise<ListMembersBadgeIdsResponse & ListMembersBadgeIdsResponseNonNullableFields>;
+/**
+ * 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.
+ * @public
+ * @permissionId BADGES.BADGE_READ_MEMBERS
+ * @permissionScope Manage Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES
+ * @permissionScope Read Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-BADGES
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.badges.v3.BadgesServiceV3.GetMemberCountsPerBadge
+ */
+export declare function getMemberCountsPerBadge(): Promise<GetMemberCountsPerBadgeResponse & GetMemberCountsPerBadgeResponseNonNullableFields>;
+/**
+ * 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
+ * @param badgeIds - Ordered badge IDs.
+ * @public
+ * @requiredField badgeIds
+ * @permissionId BADGES.BADGE_UPDATE_DISPLAY_ORDER
+ * @permissionScope Manage Badges
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-BADGES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.badges.v3.BadgesServiceV3.UpdateBadgesDisplayOrder
+ */
+export declare function updateBadgesDisplayOrder(badgeIds: string[]): Promise<UpdateBadgesDisplayOrderResponse & UpdateBadgesDisplayOrderResponseNonNullableFields>;
+export {};