@wix/auto_sdk_members_badges 1.0.11 → 1.0.13

package/build/{internal/cjs/src/badges-v3-badge-badges.types.d.ts → cjs/badges-v3-badge-badges.universal-DVnY9Z3c.d.ts}

@@ -1,32 +1,33 @@
-export interface Badge {
+interface Badge {
     /**
      * Badge ID.
      * @format GUID
      * @readonly
      */
-    id?: string;
+    _id?: string;
     /** Text displayed on the badge. */
     title?: string | null;
     /** Badge description. */
     description?: string | null;
     /**
-     * Badge background color in hexadecimal RGB format. <br/><br/>
-     * Uppercase letters only.<br/>
-     * Example: `#FFFFFF`.
+     * Badge background color in hexadecimal RGB format. Uppercase letters only.
+     *
+     * Default: `#796EFF ` (purple).
      * @format COLOR_HEX
      */
     backgroundColor?: string | null;
     /**
-     * Badge text color in hexadecimal RGB format. <br/><br/>
-     * Uppercase letters only.<br/>
-     * Example: `#C81B53`.
+     * Badge text color in hexadecimal RGB format. Uppercase letters only.
+     *
+     * Default: `"#FFFFFF"` (white).
      * @format COLOR_HEX
      */
     textColor?: string | null;
     /**
-     * URL of the badge icon image. <br/><br/>
+     * Badge icon as an SVG image. One of:
      *
-     * It is recommended to use an `SVG` image format as it's resolution independent and looks good at any scale.
+     * - An external web URL in the following format: `http(s)://<image url>`.
+     * - The [`sourceUrl`](https://dev.wix.com/docs/sdk/backend-modules/media/files/get-file-descriptor) for a Wix Media Manager file. Wix Media Manager file names in a `wix:image://...` format are not supported.
      */
     icon?: string | null;
     /**
@@ -47,49 +48,46 @@ export interface Badge {
      * Date the badge was created.
      * @readonly
      */
-    createdDate?: Date | null;
+    _createdDate?: Date | null;
     /**
      * Date the badge was updated.
      * @readonly
      */
-    updatedDate?: Date | null;
+    _updatedDate?: Date | null;
 }
-export interface CreateBadgeRequest {
+interface CreateBadgeRequest {
     /** Badge to create. */
     badge: Badge;
 }
-export interface CreateBadgeResponse {
+interface CreateBadgeResponse {
     /** Created badge. */
     badge?: Badge;
 }
-export interface UpdateBadgeRequest {
+interface UpdateBadgeRequest {
     /** Badge to update. */
     badge: Badge;
 }
-export interface UpdateBadgeResponse {
+interface UpdateBadgeResponse {
     /** Updated badge. */
     badge?: Badge;
 }
-export interface ListBadgesRequest {
-    /**
-     * Pagination options. For more information, see
-     * [API Query Language: Paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging).
-     */
+interface ListBadgesRequest {
+    /** Pagination options. */
     paging?: Paging;
 }
-export interface Paging {
+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 {
+interface ListBadgesResponse {
     /** Retrieved badges. */
     badges?: Badge[];
     /** Metadata for the paginated results. */
     metadata?: PagingMetadata;
 }
-export interface PagingMetadata {
+interface PagingMetadata {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Offset that was requested. */
@@ -99,7 +97,7 @@ export interface PagingMetadata {
     /** Flag that indicates the server failed to calculate the `total` field. */
     tooManyToCount?: boolean | null;
 }
-export interface QueryBadgesRequest {
+interface QueryBadgesRequest {
     /**
      * Filter options.
      * Currently supported fields for filtering:
@@ -115,13 +113,10 @@ export interface QueryBadgesRequest {
      * see [API Query Language: Sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting)
      */
     sort?: Sorting[];
-    /**
-     * Pagination options. For more information, see
-     * [API Query Language: Paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging).
-     */
+    /** Pagination options.  */
     paging?: Paging;
 }
-export interface Sorting {
+interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
@@ -130,39 +125,39 @@ export interface Sorting {
     /** Sort order. */
     order?: SortOrderWithLiterals;
 }
-export declare enum SortOrder {
+declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
 /** @enumType */
-export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-export interface QueryBadgesResponse {
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface QueryBadgesResponse {
     /** Retrieved badges. */
     badges?: Badge[];
     /** Metadata for the paginated results. */
     metadata?: PagingMetadata;
 }
-export interface GetBadgeRequest {
+interface GetBadgeRequest {
     /**
      * Badge ID.
      * @format GUID
      */
-    id: string;
+    _id: string;
 }
-export interface GetBadgeResponse {
+interface GetBadgeResponse {
     /** Badge. */
     badge?: Badge;
 }
-export interface DeleteBadgeRequest {
+interface DeleteBadgeRequest {
     /**
      * Badge ID.
      * @format GUID
      */
-    id: string;
+    _id: string;
 }
-export interface DeleteBadgeResponse {
+interface DeleteBadgeResponse {
 }
-export interface CountBadgesRequest {
+interface CountBadgesRequest {
     /**
      * Filter options.
      * Currently supported fields for filtering:
@@ -173,37 +168,37 @@ export interface CountBadgesRequest {
      */
     filter?: Record<string, any> | null;
 }
-export interface CountBadgesResponse {
+interface CountBadgesResponse {
     /** Amount of badges. */
     count?: string;
 }
-export interface AssignBadgeRequest {
+interface AssignBadgeRequest {
     /**
      * Badge ID.
      * @format GUID
      */
-    id: string;
+    _id: string;
     /**
      * Member IDs to assign to the badge.
      * @format GUID
      */
     memberIds: string[];
 }
-export interface AssignBadgeResponse {
+interface AssignBadgeResponse {
     /**
      * Member IDs assigned to the badge.
      * @format GUID
      */
     memberIds?: string[];
 }
-export interface BadgeAssigned {
+interface BadgeAssigned {
     /**
      * ID of the member who received the badge.
      * @format GUID
      */
     memberId?: string;
 }
-export interface AssignBadgesRequest {
+interface AssignBadgesRequest {
     /**
      * Badge IDs to assign to the member.
      * @format GUID
@@ -217,47 +212,44 @@ export interface AssignBadgesRequest {
      */
     memberId?: string;
 }
-export interface AssignBadgesResponse {
+interface AssignBadgesResponse {
     /**
      * Badge IDs newly assigned to the member.
      * @format GUID
      */
     ids?: string[];
 }
-export interface UnassignBadgeRequest {
+interface UnassignBadgeRequest {
     /**
      * Badge ID.
      * @format GUID
      */
-    id: string;
+    _id: string;
     /**
      * List of members to remove.
      * @format GUID
      */
     memberIds: string[];
 }
-export interface UnassignBadgeResponse {
+interface UnassignBadgeResponse {
 }
-export interface BadgeUnassigned {
+interface BadgeUnassigned {
     /**
      * ID of the member who lost the badge.
      * @format GUID
      */
     memberId?: string;
 }
-export interface ListMembersRequest {
+interface ListMembersRequest {
     /**
      * Badge ID.
      * @format GUID
      */
-    id: string;
-    /**
-     * Pagination options. For more information, see
-     * [API Query Language: Paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging).
-     */
+    _id: string;
+    /** Pagination options. */
     paging?: Paging;
 }
-export interface ListMembersResponse {
+interface ListMembersResponse {
     /**
      * Member IDs assigned to the badge.
      * @format GUID
@@ -266,7 +258,7 @@ export interface ListMembersResponse {
     /** Metadata for the paginated results. */
     metadata?: PagingMetadata;
 }
-export interface ListMembersBadgeIdsRequest {
+interface ListMembersBadgeIdsRequest {
     /**
      * Member IDs to retrieve badges for.
      * @format GUID
@@ -275,11 +267,11 @@ export interface ListMembersBadgeIdsRequest {
      */
     memberIds: string[];
 }
-export interface ListMembersBadgeIdsResponse {
+interface ListMembersBadgeIdsResponse {
     /** List of members and the badges they're assigned to. */
     memberBadgeIds?: MemberBadgeIds[];
 }
-export interface MemberBadgeIds {
+interface MemberBadgeIds {
     /**
      * Member ID.
      * @format GUID
@@ -291,13 +283,13 @@ export interface MemberBadgeIds {
      */
     badgeIds?: string[];
 }
-export interface GetMemberCountsPerBadgeRequest {
+interface GetMemberCountsPerBadgeRequest {
 }
-export interface GetMemberCountsPerBadgeResponse {
+interface GetMemberCountsPerBadgeResponse {
     /** Badges and the amount of members who have each badge. */
     badgeMemberCounts?: BadgeMemberCount[];
 }
-export interface BadgeMemberCount {
+interface BadgeMemberCount {
     /**
      * Badge ID.
      * @format GUID
@@ -306,7 +298,7 @@ export interface BadgeMemberCount {
     /** Badge member count. */
     memberCount?: number;
 }
-export interface UpdateBadgesDisplayOrderRequest {
+interface UpdateBadgesDisplayOrderRequest {
     /**
      * Badge IDs in the order to display.
      * @format GUID
@@ -314,15 +306,15 @@ export interface UpdateBadgesDisplayOrderRequest {
      */
     badgeIds: string[];
 }
-export interface UpdateBadgesDisplayOrderResponse {
+interface UpdateBadgesDisplayOrderResponse {
     /** Reordered badges list. */
     badges?: Badge[];
 }
-export interface ListMembersWithBadgesRequest {
+interface ListMembersWithBadgesRequest {
     /** Cursor paging options. */
     paging?: CursorPaging;
 }
-export interface CursorPaging {
+interface CursorPaging {
     /**
      * Maximum number of items to return in the results.
      * @max 100
@@ -337,7 +329,7 @@ export interface CursorPaging {
      */
     cursor?: string | null;
 }
-export interface ListMembersWithBadgesResponse {
+interface ListMembersWithBadgesResponse {
     /**
      * List of members.
      * @format GUID
@@ -346,7 +338,7 @@ export interface ListMembersWithBadgesResponse {
     /** Metadata for the paginated results. */
     pagingMetadata?: CursorPagingMetadata;
 }
-export interface CursorPagingMetadata {
+interface CursorPagingMetadata {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
@@ -359,7 +351,7 @@ export interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-export interface Cursors {
+interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -371,13 +363,13 @@ export interface Cursors {
      */
     prev?: string | null;
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+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;
+    _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`.
@@ -406,36 +398,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent {
-    entityAsJson?: string;
-    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
-    restoreInfo?: RestoreInfo;
+interface EntityCreatedEvent {
+    entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+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.
      */
-    currentEntityAsJson?: string;
+    currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted. */
-    deletedEntityAsJson?: string | null;
+    deletedEntity?: string | null;
 }
-export interface ActionEvent {
-    bodyAsJson?: string;
+interface ActionEvent {
+    body?: string;
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -451,7 +441,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -476,7 +466,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityTypeWithLiterals;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -498,7 +488,7 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
@@ -506,4 +496,134 @@ export declare enum WebhookIdentityType {
     APP = "APP"
 }
 /** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** 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;
+}
+interface BadgeAssignedEnvelope {
+    data: BadgeAssigned;
+    metadata: EventMetadata;
+}
+interface BadgeUnassignedEnvelope {
+    data: BadgeUnassigned;
+    metadata: EventMetadata;
+}
+interface BadgeCreatedEnvelope {
+    entity: Badge;
+    metadata: EventMetadata;
+}
+interface BadgeDeletedEnvelope {
+    metadata: EventMetadata;
+}
+interface BadgeUpdatedEnvelope {
+    entity: Badge;
+    metadata: EventMetadata;
+}
+interface UpdateBadge {
+    /**
+     * Badge ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string;
+    /** Text displayed on the badge. */
+    title?: string | null;
+    /** Badge description. */
+    description?: string | null;
+    /**
+     * Badge background color in hexadecimal RGB format. Uppercase letters only.
+     *
+     * Default: `#796EFF ` (purple).
+     * @format COLOR_HEX
+     */
+    backgroundColor?: string | null;
+    /**
+     * Badge text color in hexadecimal RGB format. Uppercase letters only.
+     *
+     * Default: `"#FFFFFF"` (white).
+     * @format COLOR_HEX
+     */
+    textColor?: string | null;
+    /**
+     * Badge icon as an SVG image. One of:
+     *
+     * - An external web URL in the following format: `http(s)://<image url>`.
+     * - The [`sourceUrl`](https://dev.wix.com/docs/sdk/backend-modules/media/files/get-file-descriptor) 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. <br/><br/>
+     * When `true`, members with the badge receive special permissions,
+     * and Wix users can
+     * [manage badge permissions in the dashboard](https://support.wix.com/en/article/site-members-creating-and-managing-member-badges?tabs=Dashboard-2#managing-member-badges).
+     * 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;
+}
+interface ListBadgesOptions {
+    /** Pagination options.  */
+    paging?: Paging;
+}
+interface ListMembersByBadgeOptions {
+    /** Pagination options. */
+    paging?: Paging;
+}
+
+export { type EntityCreatedEvent as $, type AssignBadgeResponse as A, type Badge as B, type CreateBadgeRequest as C, type DeleteBadgeRequest as D, type UnassignBadgeRequest as E, type UnassignBadgeResponse as F, type GetMemberCountsPerBadgeResponse as G, type BadgeUnassigned as H, type ListMembersRequest as I, type ListMembersBadgeIdsRequest as J, type GetMemberCountsPerBadgeRequest as K, type ListBadgesOptions as L, type MemberBadgeIds as M, type BadgeMemberCount as N, type UpdateBadgesDisplayOrderRequest as O, type Paging as P, type QueryBadgesRequest as Q, type ListMembersWithBadgesRequest as R, SortOrder as S, type CursorPaging as T, type UpdateBadge as U, type ListMembersWithBadgesResponse as V, WebhookIdentityType as W, type CursorPagingMetadata as X, type Cursors as Y, type DomainEvent as Z, type DomainEventBodyOneOf as _, type ListBadgesResponse as a, type RestoreInfo as a0, type EntityUpdatedEvent as a1, type EntityDeletedEvent as a2, type ActionEvent as a3, type MessageEnvelope as a4, type IdentificationData as a5, type IdentificationDataIdOneOf as a6, type BaseEventMetadata as a7, type EventMetadata as a8, type ListMembersByBadgeOptions as b, type ListMembersResponse as c, type ListMembersBadgeIdsResponse as d, type UpdateBadgesDisplayOrderResponse as e, type BadgeAssignedEnvelope as f, type BadgeUnassignedEnvelope as g, type BadgeCreatedEnvelope as h, type BadgeDeletedEnvelope as i, type BadgeUpdatedEnvelope as j, type CreateBadgeResponse as k, type UpdateBadgeRequest as l, type UpdateBadgeResponse as m, type ListBadgesRequest as n, type PagingMetadata as o, type Sorting as p, type QueryBadgesResponse as q, type GetBadgeRequest as r, type GetBadgeResponse as s, type DeleteBadgeResponse as t, type CountBadgesRequest as u, type CountBadgesResponse as v, type AssignBadgeRequest as w, type BadgeAssigned as x, type AssignBadgesRequest as y, type AssignBadgesResponse as z };