@wix/auto_sdk_loyalty_earning-rules 1.0.8 → 1.0.10

package/build/cjs/src/loyalty-v1-loyalty-earning-rule-earning-rules.universal.d.ts

@@ -156,6 +156,8 @@ export declare enum LoyaltyEarningRuleTypeTagType {
     /** Earning rule for a customer's birthday. */
     BIRTHDAY = "BIRTHDAY"
 }
+export interface CacheInvalidated {
+}
 export interface EarningRuleDisabled {
 }
 export interface CreateLoyaltyEarningRuleRequest {
@@ -361,25 +363,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
-    /**
-     * Unique event ID.
-     * Allows clients to ignore duplicate webhooks.
-     */
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
     _id?: string;
     /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     * 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;
     /**
-     * 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
+     * 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 */
+    /** 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
@@ -389,12 +387,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     /** 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.
+     * 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;
 }
@@ -420,7 +414,7 @@ export interface EntityUpdatedEvent {
     currentEntity?: string;
 }
 export interface EntityDeletedEvent {
-    /** Entity that was deleted */
+    /** Entity that was deleted. */
     deletedEntity?: string | null;
 }
 export interface ActionEvent {
@@ -428,6 +422,459 @@ export interface ActionEvent {
 }
 export interface Empty {
 }
+export interface InvalidateEarningRuleCacheRequest {
+}
+export interface InvalidateEarningRuleCacheResponse {
+}
+export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
+    /** Emitted on a meta site creation. */
+    siteCreated?: SiteCreated;
+    /** Emitted on a meta site transfer completion. */
+    siteTransferred?: SiteTransferred;
+    /** Emitted on a meta site deletion. */
+    siteDeleted?: SiteDeleted;
+    /** Emitted on a meta site restoration. */
+    siteUndeleted?: SiteUndeleted;
+    /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
+    sitePublished?: SitePublished;
+    /** Emitted on a meta site unpublish. */
+    siteUnpublished?: SiteUnpublished;
+    /** Emitted when meta site is marked as template. */
+    siteMarkedAsTemplate?: SiteMarkedAsTemplate;
+    /** Emitted when meta site is marked as a WixSite. */
+    siteMarkedAsWixSite?: SiteMarkedAsWixSite;
+    /** Emitted when an application is provisioned (installed). */
+    serviceProvisioned?: ServiceProvisioned;
+    /** Emitted when an application is removed (uninstalled). */
+    serviceRemoved?: ServiceRemoved;
+    /** Emitted when meta site name (URL slug) is changed. */
+    siteRenamedPayload?: SiteRenamed;
+    /** Emitted when meta site was permanently deleted. */
+    hardDeleted?: SiteHardDeleted;
+    /** Emitted on a namespace change. */
+    namespaceChanged?: NamespaceChanged;
+    /** Emitted when Studio is attached. */
+    studioAssigned?: StudioAssigned;
+    /** Emitted when Studio is detached. */
+    studioUnassigned?: StudioUnassigned;
+    /**
+     * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
+     * the actual URL.
+     *
+     * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
+     * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
+     */
+    urlChanged?: SiteUrlChanged;
+    /** Site is marked as PurgedExternally */
+    sitePurgedExternally?: SitePurgedExternally;
+    /** Emitted when Odeditor is attached. */
+    odeditorAssigned?: OdeditorAssigned;
+    /** Emitted when Odeditor is detached. */
+    odeditorUnassigned?: OdeditorUnassigned;
+    /** Emitted when Picasso is attached. */
+    picassoAssigned?: PicassoAssigned;
+    /** Emitted when Picasso is detached. */
+    picassoUnassigned?: PicassoUnassigned;
+    /**
+     * A meta site id.
+     * @format GUID
+     */
+    metaSiteId?: string;
+    /** A meta site version. Monotonically increasing. */
+    version?: string;
+    /** A timestamp of the event. */
+    timestamp?: string;
+    /**
+     * TODO(meta-site): Change validation once validations are disabled for consumers
+     * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
+     * @maxSize 4000
+     */
+    assets?: Asset[];
+}
+/** @oneof */
+export interface MetaSiteSpecialEventPayloadOneOf {
+    /** Emitted on a meta site creation. */
+    siteCreated?: SiteCreated;
+    /** Emitted on a meta site transfer completion. */
+    siteTransferred?: SiteTransferred;
+    /** Emitted on a meta site deletion. */
+    siteDeleted?: SiteDeleted;
+    /** Emitted on a meta site restoration. */
+    siteUndeleted?: SiteUndeleted;
+    /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
+    sitePublished?: SitePublished;
+    /** Emitted on a meta site unpublish. */
+    siteUnpublished?: SiteUnpublished;
+    /** Emitted when meta site is marked as template. */
+    siteMarkedAsTemplate?: SiteMarkedAsTemplate;
+    /** Emitted when meta site is marked as a WixSite. */
+    siteMarkedAsWixSite?: SiteMarkedAsWixSite;
+    /** Emitted when an application is provisioned (installed). */
+    serviceProvisioned?: ServiceProvisioned;
+    /** Emitted when an application is removed (uninstalled). */
+    serviceRemoved?: ServiceRemoved;
+    /** Emitted when meta site name (URL slug) is changed. */
+    siteRenamedPayload?: SiteRenamed;
+    /** Emitted when meta site was permanently deleted. */
+    hardDeleted?: SiteHardDeleted;
+    /** Emitted on a namespace change. */
+    namespaceChanged?: NamespaceChanged;
+    /** Emitted when Studio is attached. */
+    studioAssigned?: StudioAssigned;
+    /** Emitted when Studio is detached. */
+    studioUnassigned?: StudioUnassigned;
+    /**
+     * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
+     * the actual URL.
+     *
+     * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
+     * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
+     */
+    urlChanged?: SiteUrlChanged;
+    /** Site is marked as PurgedExternally */
+    sitePurgedExternally?: SitePurgedExternally;
+    /** Emitted when Odeditor is attached. */
+    odeditorAssigned?: OdeditorAssigned;
+    /** Emitted when Odeditor is detached. */
+    odeditorUnassigned?: OdeditorUnassigned;
+    /** Emitted when Picasso is attached. */
+    picassoAssigned?: PicassoAssigned;
+    /** Emitted when Picasso is detached. */
+    picassoUnassigned?: PicassoUnassigned;
+}
+export interface Asset {
+    /**
+     * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
+     * @maxLength 36
+     */
+    appDefId?: string;
+    /**
+     * An instance id. For legacy reasons may be UUID or a string.
+     * @maxLength 200
+     */
+    instanceId?: string;
+    /** An application state. */
+    state?: State;
+}
+export declare enum State {
+    UNKNOWN = "UNKNOWN",
+    ENABLED = "ENABLED",
+    DISABLED = "DISABLED",
+    PENDING = "PENDING",
+    DEMO = "DEMO"
+}
+export interface SiteCreated {
+    /**
+     * A template identifier (empty if not created from a template).
+     * @maxLength 36
+     */
+    originTemplateId?: string;
+    /**
+     * An account id of the owner.
+     * @format GUID
+     */
+    ownerId?: string;
+    /** A context in which meta site was created. */
+    context?: SiteCreatedContext;
+    /**
+     * A meta site id from which this site was created.
+     *
+     * In case of a creation from a template it's a template id.
+     * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
+     * @format GUID
+     */
+    originMetaSiteId?: string | null;
+    /**
+     * A meta site name (URL slug).
+     * @maxLength 20
+     */
+    siteName?: string;
+    /** A namespace. */
+    namespace?: Namespace;
+}
+export declare enum SiteCreatedContext {
+    /** A valid option, we don't expose all reasons why site might be created. */
+    OTHER = "OTHER",
+    /** A meta site was created from template. */
+    FROM_TEMPLATE = "FROM_TEMPLATE",
+    /** A meta site was created by copying of the transfferred meta site. */
+    DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
+    /** A copy of existing meta site. */
+    DUPLICATE = "DUPLICATE",
+    /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
+    OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
+    /** deprecated A meta site was created for Flash editor. */
+    FLASH = "FLASH"
+}
+export declare enum Namespace {
+    UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
+    /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
+    WIX = "WIX",
+    /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    SHOUT_OUT = "SHOUT_OUT",
+    /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    ALBUMS = "ALBUMS",
+    /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
+    /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    HOTELS = "HOTELS",
+    /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    CLUBS = "CLUBS",
+    /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
+    /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    DEV_SITE = "DEV_SITE",
+    /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    LOGOS = "LOGOS",
+    /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    VIDEO_MAKER = "VIDEO_MAKER",
+    /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
+    /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
+    /**
+     * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
+     *
+     * Meta site with this namespace will *not* be shown in a user's site list by default.
+     */
+    HTML_DRAFT = "HTML_DRAFT",
+    /**
+     * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
+     * Will be accessible from Site List and will not have a website app.
+     * Once the user attaches a site, the site will become a regular wixsite.
+     */
+    SITELESS_BUSINESS = "SITELESS_BUSINESS",
+    /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
+    CREATOR_ECONOMY = "CREATOR_ECONOMY",
+    /** It is to be used in the Business First efforts. */
+    DASHBOARD_FIRST = "DASHBOARD_FIRST",
+    /** Bookings business flow with no site. */
+    ANYWHERE = "ANYWHERE",
+    /** Namespace for Headless Backoffice with no editor */
+    HEADLESS = "HEADLESS",
+    /**
+     * Namespace for master site that will exist in parent account that will be referenced by subaccounts
+     * The site will be used for account level CSM feature for enterprise
+     */
+    ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
+    /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
+    RISE = "RISE",
+    /**
+     * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
+     * There's a blank site behind the scene but it's blank).
+     * The Mobile company will be the owner of this namespace.
+     */
+    BRANDED_FIRST = "BRANDED_FIRST",
+    /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
+    NOWNIA = "NOWNIA",
+    /**
+     * UGC Templates are templates that are created by users for personal use and to sale to other users.
+     * The Partners company owns this namespace.
+     */
+    UGC_TEMPLATE = "UGC_TEMPLATE",
+    /** Codux Headless Sites */
+    CODUX = "CODUX",
+    /** Bobb - AI Design Creator. */
+    MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
+    /**
+     * Shared Blog Site is a unique single site across Enterprise account,
+     * This site will hold all Blog posts related to the Marketing product.
+     */
+    SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
+    /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    STANDALONE_FORMS = "STANDALONE_FORMS",
+    /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    STANDALONE_EVENTS = "STANDALONE_EVENTS",
+    /** MIMIR - Siteless account for MIMIR Ai Job runner. */
+    MIMIR = "MIMIR"
+}
+/** Site transferred to another user. */
+export interface SiteTransferred {
+    /**
+     * A previous owner id (user that transfers meta site).
+     * @format GUID
+     */
+    oldOwnerId?: string;
+    /**
+     * A new owner id (user that accepts meta site).
+     * @format GUID
+     */
+    newOwnerId?: string;
+}
+/** Soft deletion of the meta site. Could be restored. */
+export interface SiteDeleted {
+    /** A deletion context. */
+    deleteContext?: DeleteContext;
+}
+export interface DeleteContext {
+    /** When the meta site was deleted. */
+    dateDeleted?: Date | null;
+    /** A status. */
+    deleteStatus?: DeleteStatus;
+    /**
+     * A reason (flow).
+     * @maxLength 255
+     */
+    deleteOrigin?: string;
+    /**
+     * A service that deleted it.
+     * @maxLength 255
+     */
+    initiatorId?: string | null;
+}
+export declare enum DeleteStatus {
+    UNKNOWN = "UNKNOWN",
+    TRASH = "TRASH",
+    DELETED = "DELETED",
+    PENDING_PURGE = "PENDING_PURGE",
+    PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
+}
+/** Restoration of the meta site. */
+export interface SiteUndeleted {
+}
+/** First publish of a meta site. Or subsequent publish after unpublish. */
+export interface SitePublished {
+}
+export interface SiteUnpublished {
+    /**
+     * A list of URLs previously associated with the meta site.
+     * @maxLength 4000
+     * @maxSize 10000
+     */
+    urls?: string[];
+}
+export interface SiteMarkedAsTemplate {
+}
+export interface SiteMarkedAsWixSite {
+}
+/**
+ * Represents a service provisioned a site.
+ *
+ * Note on `origin_instance_id`:
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
+ * This is because of the following scenario:
+ *
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
+ * such as a product catalog. When you create a site from this template, you inherit this
+ * default product catalog. However, if the template's product catalog is modified,
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
+ * your site remains consistent with what you initially received and does not include any
+ * changes made to the original template afterward.
+ * To ensure this, the TPA on the template gets a new instance_id.
+ */
+export interface ServiceProvisioned {
+    /**
+     * Either UUID or EmbeddedServiceType.
+     * @maxLength 36
+     */
+    appDefId?: string;
+    /**
+     * Not only UUID. Something here could be something weird.
+     * @maxLength 36
+     */
+    instanceId?: string;
+    /**
+     * An instance id from which this instance is originated.
+     * @maxLength 36
+     */
+    originInstanceId?: string;
+    /**
+     * A version.
+     * @maxLength 500
+     */
+    version?: string | null;
+    /**
+     * The origin meta site id
+     * @format GUID
+     */
+    originMetaSiteId?: string | null;
+}
+export interface ServiceRemoved {
+    /**
+     * Either UUID or EmbeddedServiceType.
+     * @maxLength 36
+     */
+    appDefId?: string;
+    /**
+     * Not only UUID. Something here could be something weird.
+     * @maxLength 36
+     */
+    instanceId?: string;
+    /**
+     * A version.
+     * @maxLength 500
+     */
+    version?: string | null;
+}
+/** Rename of the site. Meaning, free public url has been changed as well. */
+export interface SiteRenamed {
+    /**
+     * A new meta site name (URL slug).
+     * @maxLength 20
+     */
+    newSiteName?: string;
+    /**
+     * A previous meta site name (URL slug).
+     * @maxLength 255
+     */
+    oldSiteName?: string;
+}
+/**
+ * Hard deletion of the meta site.
+ *
+ * Could not be restored. Therefore it's desirable to cleanup data.
+ */
+export interface SiteHardDeleted {
+    /** A deletion context. */
+    deleteContext?: DeleteContext;
+}
+export interface NamespaceChanged {
+    /** A previous namespace. */
+    oldNamespace?: Namespace;
+    /** A new namespace. */
+    newNamespace?: Namespace;
+}
+/** Assigned Studio editor */
+export interface StudioAssigned {
+}
+/** Unassigned Studio editor */
+export interface StudioUnassigned {
+}
+/**
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
+ *
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
+ *
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
+ */
+export interface SiteUrlChanged {
+}
+/**
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
+ * Consumed by other teams to remove relevant data.
+ */
+export interface SitePurgedExternally {
+    /**
+     * @maxLength 2048
+     * @maxSize 100
+     * @deprecated
+     * @targetRemovalDate 2025-04-15
+     */
+    appDefId?: string[];
+}
+/** Assigned Odeditor */
+export interface OdeditorAssigned {
+}
+/** Unassigned Odeditor */
+export interface OdeditorUnassigned {
+}
+/** Assigned Picasso editor */
+export interface PicassoAssigned {
+}
+/** Unassigned Picasso */
+export interface PicassoUnassigned {
+}
 export interface MessageEnvelope {
     /**
      * App instance ID.
@@ -513,25 +960,21 @@ export interface BaseEventMetadata {
     identity?: IdentificationData;
 }
 export interface EventMetadata extends BaseEventMetadata {
-    /**
-     * Unique event ID.
-     * Allows clients to ignore duplicate webhooks.
-     */
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
     _id?: string;
     /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     * 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;
     /**
-     * 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
+     * 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 */
+    /** 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
@@ -541,12 +984,8 @@ export interface EventMetadata extends BaseEventMetadata {
     /** 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.
+     * 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;
 }