@wix/auto_sdk_badges_badges-v-2 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,497 @@
+interface Badge {
+    /**
+     * Badge id
+     * @format GUID
+     */
+    _id?: string;
+    /** Badge title */
+    title?: string;
+    /** Badge description */
+    description?: string;
+    /**
+     * Badge background color in 6-digit color hex in upper case (e.g. #FFFFFF)
+     * @format COLOR_HEX
+     */
+    backgroundColor?: string;
+    /**
+     * Badge text color in 6-digit color hex in upper case (e.g. #FFFFFF)
+     * @format COLOR_HEX
+     */
+    textColor?: string;
+    /** Badge icon SVG as 'https://...' */
+    icon?: string;
+    /**
+     * Id of role/group in groups service that badge assignee belongs to
+     * @format GUID
+     */
+    roleId?: string;
+    /**
+     * Indicates whether badge has permissions.
+     *
+     * Badges can have special permissions to access specific members-only pages.
+     *
+     * When the value is set to **true**, badge permissions can be managed in
+     * [permissions table](https://www.wix.com/my-account/site-selector/?buttonText=Manage%20Permissions&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/member-permissions/roles/manage-permissions).
+     * Site members will receive relevant permissions once assigned such badge.
+     *
+     * When the value is set to **false**, badge has no associated permissions
+     * and is not visible in permissions table.
+     * Site member will not receive any permissions once assigned such badge.
+     */
+    hasPermissions?: boolean;
+    /** Badge url keyword operator */
+    slug?: string;
+    /** Date when badge was created */
+    createDate?: Date | null;
+    /** Date when badge was last updated */
+    updateDate?: Date | null;
+}
+interface CreateRequest {
+    /** Badge title */
+    title: string;
+    /** Badge description */
+    description?: string;
+    /**
+     * Badge background color in 6-digit upper-cased color hex (e.g. #FFFFFF)
+     * @format COLOR_HEX
+     */
+    backgroundColor: string;
+    /**
+     * Badge text color in 6-digit upper-cased color hex (e.g. #FFFFFF)
+     * @format COLOR_HEX
+     */
+    textColor: string;
+    /** Badge icon SVG as 'https://...' */
+    icon?: string;
+    /** Indicates whether badge has permissions */
+    hasPermissions?: boolean;
+}
+interface CreateResponse {
+    /** Created badge */
+    badge?: Badge;
+}
+interface UpdateRequest {
+    /**
+     * Badge id
+     * @format GUID
+     */
+    _id: string;
+    /** Badge title */
+    title?: string | null;
+    /** Badge description */
+    description?: string | null;
+    /**
+     * Badge background color in 6-digit upper-cased color hex (e.g. #FFFFFF)
+     * @format COLOR_HEX
+     */
+    backgroundColor?: string | null;
+    /**
+     * Badge text color in 6-digit upper-cased color hex (e.g. #FFFFFF)
+     * @format COLOR_HEX
+     */
+    textColor?: string | null;
+    /** Badge icon SVG as 'https://...' */
+    icon?: string | null;
+    /** Indicates whether badge has permissions */
+    hasPermissions?: boolean | null;
+}
+interface UpdateResponse {
+    /** Updated badge */
+    badge?: Badge;
+}
+interface ListRequest {
+    /**
+     * Limit the number of badges to return
+     * @min 1
+     * @max 1000
+     */
+    limit?: number | null;
+    /** Default offset is 0. */
+    offset?: number | null;
+}
+interface ListResponse {
+    /** List of badges in a site */
+    badges?: Badge[];
+}
+interface QueryRequest {
+    /** Filter criteria */
+    filter?: Record<string, any> | null;
+    /** Sorting criteria */
+    sort?: Sorting[];
+    /** Result paging data */
+    paging?: Paging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface Paging {
+    /**
+     * Limit the number of badges to return
+     * @min 1
+     * @max 1000
+     */
+    limit?: number | null;
+    /** Default offset is 0. */
+    offset?: number | null;
+}
+interface QueryResponse {
+    /** List of sorted badges in a site that satisfy filter and paging */
+    badges?: Badge[];
+    /** Total count of badges in a site that satisfy given filter */
+    count?: string;
+}
+interface GetRequest {
+    /**
+     * Badge id
+     * @format GUID
+     */
+    _id: string;
+}
+interface GetResponse {
+    /** Badge */
+    badge?: Badge;
+}
+interface DeleteRequest {
+    /**
+     * Badge id
+     * @format GUID
+     */
+    _id: string;
+}
+interface DeleteResponse {
+}
+interface CountRequest {
+    /** Filter criteria used for counting */
+    filter?: Record<string, any> | null;
+}
+interface CountResponse {
+    /** Badges count */
+    count?: string;
+}
+interface AssignBadgeRequest {
+    /**
+     * Badge id
+     * @format GUID
+     */
+    _id: string;
+    /**
+     * Ids of members this badge should be assigned to
+     * @format GUID
+     */
+    memberIds: string[];
+}
+interface AssignBadgeResponse {
+    /**
+     * Ids of members given badge has been assigned to
+     * @format GUID
+     */
+    memberIds?: string[];
+}
+interface BadgeAssigned {
+    /**
+     * Member ids who have the given badge assigned
+     * @format GUID
+     */
+    memberId?: string;
+}
+interface UnassignBadgeRequest {
+    /**
+     * Badge id
+     * @format GUID
+     */
+    _id: string;
+    /**
+     * Ids of members given badge will be removed from
+     * @format GUID
+     */
+    memberIds: string[];
+}
+interface UnassignBadgeResponse {
+}
+interface BadgeUnassigned {
+    /**
+     * Member id who had the badge unassigned
+     * @format GUID
+     */
+    memberId?: string;
+}
+interface ListMembersRequest {
+    /**
+     * Badge id
+     * @format GUID
+     */
+    _id: string;
+}
+interface ListMembersResponse {
+    /**
+     * Member ids who have the given badge assigned
+     * @format GUID
+     */
+    memberIds?: string[];
+}
+interface ListMembersBadgeIdsRequest {
+    /**
+     * Ids of members whose badge ids should be listed
+     * @format GUID
+     */
+    memberIds: string[];
+}
+interface ListMembersBadgeIdsResponse {
+    /** List of members with Ids of badges assigned to them */
+    memberBadgeIds?: MemberBadgeIds[];
+}
+interface MemberBadgeIds {
+    /**
+     * Member id
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * Badge ids assigned to a given member
+     * @format GUID
+     */
+    badgeIds?: string[];
+}
+interface GetBadgeCountersRequest {
+}
+interface GetBadgeCountersResponse {
+    /** Ids of badges with a member count with this assigned badge */
+    badgeMemberCounts?: BadgeMemberCount[];
+}
+interface BadgeMemberCount {
+    /**
+     * Badge id
+     * @format GUID
+     */
+    badgeId?: string;
+    /** Number of members with assigned badge */
+    memberCount?: number;
+}
+interface UpdateBadgesOrderRequest {
+    /**
+     * Ordered badges ids
+     * @format GUID
+     * @minSize 1
+     */
+    badgeIds?: string[];
+}
+interface UpdateBadgesOrderResponse {
+    /** Reordered badges */
+    badges?: Badge[];
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For 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 that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+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;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface CreateOptions {
+    /** Badge description */
+    description?: string;
+    /**
+     * Badge background color in 6-digit upper-cased color hex (e.g. #FFFFFF)
+     * @format COLOR_HEX
+     */
+    backgroundColor: string;
+    /**
+     * Badge text color in 6-digit upper-cased color hex (e.g. #FFFFFF)
+     * @format COLOR_HEX
+     */
+    textColor: string;
+    /** Badge icon SVG as 'https://...' */
+    icon?: string;
+    /** Indicates whether badge has permissions */
+    hasPermissions?: boolean;
+}
+interface UpdateOptions {
+    /** Badge title */
+    title?: string | null;
+    /** Badge description */
+    description?: string | null;
+    /**
+     * Badge background color in 6-digit upper-cased color hex (e.g. #FFFFFF)
+     * @format COLOR_HEX
+     */
+    backgroundColor?: string | null;
+    /**
+     * Badge text color in 6-digit upper-cased color hex (e.g. #FFFFFF)
+     * @format COLOR_HEX
+     */
+    textColor?: string | null;
+    /** Badge icon SVG as 'https://...' */
+    icon?: string | null;
+    /** Indicates whether badge has permissions */
+    hasPermissions?: boolean | null;
+}
+interface ListOptions {
+    /**
+     * Limit the number of badges to return
+     * @min 1
+     * @max 1000
+     */
+    limit?: number | null;
+    /** Default offset is 0. */
+    offset?: number | null;
+}
+interface QueryOptions {
+    /** Filter criteria */
+    filter?: Record<string, any> | null;
+    /** Sorting criteria */
+    sort?: Sorting[];
+    /** Result paging data */
+    paging?: Paging;
+}
+interface CountOptions {
+    /** Filter criteria used for counting */
+    filter?: Record<string, any> | null;
+}
+interface UpdateBadgesOrderOptions {
+    /**
+     * Ordered badges ids
+     * @format GUID
+     * @minSize 1
+     */
+    badgeIds?: string[];
+}
+
+export { type ActionEvent, type AssignBadgeRequest, type AssignBadgeResponse, type Badge, type BadgeAssigned, type BadgeMemberCount, type BadgeUnassigned, type CountOptions, type CountRequest, type CountResponse, type CreateOptions, type CreateRequest, type CreateResponse, type DeleteRequest, type DeleteResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type GetBadgeCountersRequest, type GetBadgeCountersResponse, type GetRequest, type GetResponse, type IdentificationData, type IdentificationDataIdOneOf, type ListMembersBadgeIdsRequest, type ListMembersBadgeIdsResponse, type ListMembersRequest, type ListMembersResponse, type ListOptions, type ListRequest, type ListResponse, type MemberBadgeIds, type MessageEnvelope, type Paging, type QueryOptions, type QueryRequest, type QueryResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type UnassignBadgeRequest, type UnassignBadgeResponse, type UpdateBadgesOrderOptions, type UpdateBadgesOrderRequest, type UpdateBadgesOrderResponse, type UpdateOptions, type UpdateRequest, type UpdateResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals };