@wix/members 1.0.0

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

@@ -0,0 +1,456 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+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.
+     * Example: `#FFFFFF`.
+     */
+    backgroundColor?: string | null;
+    /**
+     * Badge text color in hexadecimal RGB format.
+     * Uppercase letters only.
+     * Example: `#C81B53`.
+     */
+    textColor?: string | null;
+    /**
+     * URL of the badge icon image.
+     * _Recommended_ to use `SVG` image format as it is resolution independent and looks great at any scale.
+     */
+    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 site 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;
+    /**
+     * Date the badge was updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+}
+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. For more information, see
+     * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
+     */
+    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. For more information, see
+     * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
+     */
+    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. For more information, see
+     * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
+     */
+    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[];
+}
+/**
+ * Creates a new badge.
+ * @param badge - Badge to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField badge
+ * @requiredField badge.backgroundColor
+ * @requiredField badge.textColor
+ * @requiredField badge.title
+ */
+export declare function createBadge(badge: Badge): Promise<CreateBadgeResponse>;
+/**
+ * Updates a badge's specified properties.
+ * @param _id - Badge ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField badge
+ */
+export declare function updateBadge(_id: string, badge: UpdateBadge): Promise<UpdateBadgeResponse>;
+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.
+     * Example: `#FFFFFF`.
+     */
+    backgroundColor?: string | null;
+    /**
+     * Badge text color in hexadecimal RGB format.
+     * Uppercase letters only.
+     * Example: `#C81B53`.
+     */
+    textColor?: string | null;
+    /**
+     * URL of the badge icon image.
+     * _Recommended_ to use `SVG` image format as it is resolution independent and looks great at any scale.
+     */
+    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 site 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;
+    /**
+     * Date the badge was updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+}
+/**
+ * Retrieves up to 1000 badges, given the requested paging.
+ * Default `paging.limit` is 100, `paging.offset` - 0.
+ * For more information, see
+ * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function listBadges(options?: ListBadgesOptions): Promise<ListBadgesResponse>;
+export interface ListBadgesOptions {
+    /**
+     * Pagination options. For more information, see
+     * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
+     */
+    paging?: Paging;
+}
+/**
+ * Retrieves up to 1000 badges, given the requested query options, paging, and sorting.
+ * Default `paging.limit` is 100, `paging.offset` - 0.
+ * For more information, see
+ * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function queryBadges(options?: QueryBadgesOptions): Promise<QueryBadgesResponse>;
+export interface QueryBadgesOptions {
+    /**
+     * 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. For more information, see
+     * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
+     */
+    paging?: Paging;
+}
+/**
+ * Retrieves a badge.
+ * @param _id - Badge ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function getBadge(_id: string): Promise<GetBadgeResponse>;
+/**
+ * Deletes a badge.
+ * @param _id - Badge ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function deleteBadge(_id: string): Promise<void>;
+/**
+ * Assigns a badge to the specified members.
+ * The members inherit the badge's permissions when they receive the badge, if applicable.
+ * Badge permissions are added to previous member permissions (they don't replace existing permissions).
+ * @param _id - Badge ID.
+ * @param memberIds - List of member IDs to assign to the badge.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField memberIds
+ */
+export declare function assignBadge(_id: string, memberIds: string[]): Promise<AssignBadgeResponse>;
+/**
+ * Removes the requested members from a badge.
+ * Members removed from a badge lose the badge's permissions, if applicable.
+ * @param _id - Badge ID.
+ * @param memberIds - List of members to remove.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField memberIds
+ */
+export declare function unassignBadge(_id: string, memberIds: string[]): Promise<void>;
+/**
+ * Retrieves up to 1000 site members
+ * who have a specified badge.
+ * Default `paging.limit` is 100, `paging.offset` - 0.
+ * For more details on how to use paging, see documentation
+ * [here](https://dev.wix.com/api/rest/getting-started/pagination).
+ * @param _id - Badge ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+export declare function listMembers(_id: string, options?: ListMembersOptions): Promise<ListMembersResponse>;
+export interface ListMembersOptions {
+    /**
+     * Pagination options. For more information, see
+     * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).
+     */
+    paging?: Paging;
+}
+/**
+ * Retrieves badges assigned to the requested members.
+ * @param memberIds - List of members.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField memberIds
+ */
+export declare function listMembersBadgeIds(memberIds: string[]): Promise<ListMembersBadgeIdsResponse>;
+/**
+ * Retrieves member count per badge.
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function getMemberCountsPerBadge(): Promise<GetMemberCountsPerBadgeResponse>;
+/**
+ * Updates badges' display order.
+ * @param badgeIds - Ordered badge IDs.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField badgeIds
+ */
+export declare function updateBadgesDisplayOrder(badgeIds: string[]): Promise<UpdateBadgesDisplayOrderResponse>;