@wix/auto_sdk_benefit-programs_pool-definitions 1.0.12 → 1.0.14

package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.types.d.ts

@@ -0,0 +1,805 @@
+export interface PoolDefinition {
+    /**
+     * Pool definition ID.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the pool definition is updated.
+     * To prevent conflicting changes, the current revision must be specified when updating the pool definition.
+     *
+     * Ignored when creating a pool definition.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the pool definition was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the pool definition was updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Pool definition name.
+     * @maxLength 128
+     */
+    displayName?: string;
+    /**
+     * List of program definition IDs that are associated with this pool definition.
+     * @format GUID
+     * @maxSize 100
+     */
+    programDefinitionIds?: string[];
+    /** Pool definition benefits and settings. */
+    details?: Details;
+    /**
+     * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
+     * @immutable
+     * @readonly
+     * @minLength 1
+     * @maxLength 50
+     */
+    namespace?: string | null;
+    /**
+     * Custom field data for the pool definition object.
+     *
+     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
+     */
+    extendedFields?: ExtendedFields;
+}
+export interface Details {
+    /**
+     * List of benefits.
+     * @maxSize 10
+     */
+    benefits?: Benefit[];
+    /**
+     * Credit settings.
+     *
+     * If this object is empty, you can't set a price for the benefit.
+     */
+    creditConfiguration?: CreditConfiguration;
+    /** Additional information relating to this object. */
+    additionalData?: Record<string, any> | null;
+}
+export interface Benefit {
+    /**
+     * Unique identifier for this benefit.
+     *
+     * This key is consistent across the pool definition and all associated pools that contain this benefit.
+     * @maxLength 64
+     */
+    benefitKey?: string;
+    /**
+     * ID that is used to associated items with this benefit.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    itemSetId?: string | null;
+    /**
+     * Price of the benefit in credits. The price is the same for all of this benefit's items.
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
+    price?: string | null;
+    /** Additional information for this benefit. */
+    additionalData?: Record<string, any> | null;
+    /**
+     * ID of the app providing the benefit items.
+     * @format GUID
+     * @immutable
+     */
+    providerAppId?: string | null;
+    /**
+     * Benefit name.
+     * @maxLength 40
+     */
+    displayName?: string | null;
+    /**
+     * Benefit description.
+     * @maxLength 255
+     */
+    description?: string | null;
+}
+export interface PolicyExpression extends PolicyExpressionExpressionOneOf {
+    /** Benefits can be redeemed if the expression in this object is not fulfilled. */
+    operatorNotOptions?: PolicyExpressionNot;
+    /** Benefits can be redeemed if all the expression in this object's array are fulfilled. */
+    operatorAndOptions?: PolicyExpressionAnd;
+    /** Benefits can be redeemed if at least one of the expressions in this object's array is fulfilled. */
+    operatorOrOptions?: PolicyExpressionOr;
+    /** Defines when benefits can be redeemed or how many benefits can be redeemed in a specific time period. */
+    policyOptions?: Policy;
+    /** Policy expression type. */
+    type?: PolicyExpressionType;
+}
+/** @oneof */
+export interface PolicyExpressionExpressionOneOf {
+    /** Benefits can be redeemed if the expression in this object is not fulfilled. */
+    operatorNotOptions?: PolicyExpressionNot;
+    /** Benefits can be redeemed if all the expression in this object's array are fulfilled. */
+    operatorAndOptions?: PolicyExpressionAnd;
+    /** Benefits can be redeemed if at least one of the expressions in this object's array is fulfilled. */
+    operatorOrOptions?: PolicyExpressionOr;
+    /** Defines when benefits can be redeemed or how many benefits can be redeemed in a specific time period. */
+    policyOptions?: Policy;
+}
+export declare enum PolicyExpressionType {
+    UNKNOWN = "UNKNOWN",
+    /** Use with `operatorNotOptions`. */
+    OPERATOR_NOT = "OPERATOR_NOT",
+    /** Use with `operatorAndOptions`. */
+    OPERATOR_AND = "OPERATOR_AND",
+    /** Use with `operatorOrOptions`. */
+    OPERATOR_OR = "OPERATOR_OR",
+    /** Use with `policyOptions`. */
+    POLICY = "POLICY"
+}
+export interface PolicyExpressionNot {
+    /** Policy expression. If this expression is not fulfilled, benefits can be redeemed. */
+    expression?: PolicyExpression;
+}
+export interface PolicyExpressionAnd {
+    /**
+     * Array of policy expressions. If all expressions are fulfilled, benefits can be redeemed.
+     * @minSize 2
+     * @maxSize 10
+     */
+    expressions?: PolicyExpression[];
+}
+export interface PolicyExpressionOr {
+    /**
+     * Array of policy expressions. If at least one expression is fulfilled, benefits can be redeemed.
+     * @minSize 2
+     * @maxSize 10
+     */
+    expressions?: PolicyExpression[];
+}
+export interface Policy extends PolicyPolicyOneOf {
+    /**
+     * Defines an interval during which the policy expression is fulfilled.
+     *
+     * If `fromWeekDay` and `toWeekDay` are defined, this interval applies weekly. Otherwise, it applies daily.
+     */
+    fixedIntervalOptions?: FixedIntervalPolicy;
+    /** Maximum amount of times a benefit can be redeemed during a specified time period. */
+    rateLimitedOptions?: RateLimitedPolicy;
+    /** Custom policy defined by a different app. */
+    customOptions?: CustomPolicy;
+    /** Policy type. */
+    type?: Type;
+}
+/** @oneof */
+export interface PolicyPolicyOneOf {
+    /**
+     * Defines an interval during which the policy expression is fulfilled.
+     *
+     * If `fromWeekDay` and `toWeekDay` are defined, this interval applies weekly. Otherwise, it applies daily.
+     */
+    fixedIntervalOptions?: FixedIntervalPolicy;
+    /** Maximum amount of times a benefit can be redeemed during a specified time period. */
+    rateLimitedOptions?: RateLimitedPolicy;
+    /** Custom policy defined by a different app. */
+    customOptions?: CustomPolicy;
+}
+export declare enum Type {
+    /** Unknown policy type. */
+    UNKNOWN = "UNKNOWN",
+    /** Use with `fixedIntervalOptions`. */
+    FIXED_INTERVAL = "FIXED_INTERVAL",
+    /** Use with `rateLimitedOptions`. */
+    RATE_LIMITED = "RATE_LIMITED",
+    /** Use with `customOptions`. */
+    CUSTOM = "CUSTOM"
+}
+export interface FixedIntervalPolicy {
+    /** Weekday that this interval starts from. If this field is defined, then `toWeekDay` is required. */
+    fromWeekDay?: WeekDay;
+    /** Weekday that this interval ends at. If this field is defined, then `fromWeekDay` is required. */
+    toWeekDay?: WeekDay;
+    /**
+     * Hour that this interval starts from. If this field is defined, then `toHour` is required.
+     * @max 23
+     */
+    fromHour?: number | null;
+    /**
+     * Hour that this interval ends at. If this field is defined, then `fromHour` is required.
+     * @max 23
+     */
+    toHour?: number | null;
+    /**
+     * Minute that this interval starts from. If this field is defined, then `toMinute` is required.
+     * @max 59
+     */
+    fromMinute?: number | null;
+    /**
+     * Minute that this interval ends at. If this field is defined, then `fromMinute` is required.
+     * @max 59
+     */
+    toMinute?: number | null;
+}
+export declare enum WeekDay {
+    /** Unknown weekday. */
+    UNKNOWN = "UNKNOWN",
+    /** Monday. */
+    MONDAY = "MONDAY",
+    /** Tuesday. */
+    TUESDAY = "TUESDAY",
+    /** Wednesday. */
+    WEDNESDAY = "WEDNESDAY",
+    /** Thursday. */
+    THURSDAY = "THURSDAY",
+    /** Friday. */
+    FRIDAY = "FRIDAY",
+    /** Saturday. */
+    SATURDAY = "SATURDAY",
+    /** Sunday. */
+    SUNDAY = "SUNDAY"
+}
+export interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
+    /** Fixed interval used to limit benefit redemption. */
+    fixedIntervalOptions?: FixedIntervalPolicy;
+    /** Maximum number of times a benefit can be redeemed per specified time period. */
+    times?: number;
+    /** Time period type. */
+    type?: RateLimitedPolicyType;
+}
+/** @oneof */
+export interface RateLimitedPolicyPeriodOneOf {
+    /** Fixed interval used to limit benefit redemption. */
+    fixedIntervalOptions?: FixedIntervalPolicy;
+}
+export declare enum RateLimitedPolicyType {
+    /** Unknown rate limit method. */
+    UNKNOWN = "UNKNOWN",
+    /** Time period is defined using `fixedIntervalOptions`. */
+    FIXED_INTERVAL = "FIXED_INTERVAL",
+    /** Time period is from one program renewal to the next. */
+    PER_CYCLE = "PER_CYCLE"
+}
+/** Custom policy as implemented by the Entitlement Policy Provider */
+export interface CustomPolicy {
+    /**
+     * Policy ID.
+     * @format GUID
+     */
+    id?: string;
+    /**
+     * ID of the app providing the policy.
+     * @format GUID
+     */
+    appId?: string | null;
+    /** Additional information for this custom policy. */
+    additionalData?: Record<string, any> | null;
+}
+export interface CreditConfiguration {
+    /**
+     * Initial available amount for associated balances.
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
+    amount?: string;
+    /** Rollover settings. */
+    rolloverConfiguration?: RolloverConfiguration;
+    /**
+     * Credit unit display name.
+     * @maxLength 32
+     */
+    unitDisplayName?: string | null;
+}
+export interface RolloverConfiguration {
+    /** Whether unused credits roll over to a new cycle when a program renews. */
+    enabled?: boolean | null;
+    /**
+     * Maximum number of credits that can roll over to the next cycle when a program renews.
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
+    balanceCap?: string | null;
+}
+export interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+export interface PoolDefinitionAddedToProgramDefinition {
+    /** PoolDefinition that was added to the program definition */
+    poolDefinition?: PoolDefinition;
+    /**
+     * Program Definition that the pool definition was added to
+     * @format GUID
+     */
+    programDefinitionId?: string;
+    /** Type of cascade */
+    cascadeType?: Cascade;
+}
+export declare enum Cascade {
+    /** Unknown cascade. */
+    UNKNOWN_CASCADE = "UNKNOWN_CASCADE",
+    /** Changes are applied to existing programs and pools when they are next renewed. */
+    NEXT_RENEWAL = "NEXT_RENEWAL",
+    /** Changes are applied to associated programs and pools immediately. */
+    IMMEDIATELY = "IMMEDIATELY",
+    /** Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. */
+    FUTURE_PROVISIONS = "FUTURE_PROVISIONS"
+}
+export interface PoolDefinitionRemovedFromProgramDefinition {
+    /** PoolDefinition that was removed from the program definition */
+    poolDefinition?: PoolDefinition;
+    /**
+     * Program Definition that the pool definition was removed from
+     * @format GUID
+     */
+    programDefinitionId?: string;
+    /** Type of cascade */
+    cascadeType?: Cascade;
+}
+/** This event is needed to support legacy benefit notification event. Should be only consumed in the proxy. */
+export interface PoolDefinitionUpdatedProxySupport {
+    /** PoolDefinition after the update */
+    currentPoolDefinition?: PoolDefinition;
+    /** PoolDefinition before the update */
+    previousPoolDefinition?: PoolDefinition;
+}
+/** This event is needed to support legacy benefit notification event. Should be only consumed in the proxy. */
+export interface PoolDefinitionDeletedProxySupport {
+    /** PoolDefinition which was deleted */
+    deletedPoolDefinition?: PoolDefinition;
+}
+export interface CreatePoolDefinitionRequest {
+    /** Pool definition to create. */
+    poolDefinition: PoolDefinition;
+    /**
+     * Determines when the changes to the program definitions containing this pool definition will be applied to associated programs.
+     *
+     * Required if the `poolDefinition.programDefinitionIds` parameter is defined.
+     */
+    cascade?: Cascade;
+}
+export interface CreatePoolDefinitionResponse {
+    /** Created pool definition. */
+    poolDefinition?: PoolDefinition;
+}
+export interface BulkCreatePoolDefinitionsRequest {
+    /**
+     * Pool definitions to create.
+     * @minSize 1
+     * @maxSize 100
+     */
+    poolDefinitions: PoolDefinition[];
+    /**
+     * Determines when the changes to the program definitions containing these pool definitions will be applied to associated programs.
+     *
+     * Required if the `poolDefinition.programDefinitionIds` parameter is defined.
+     */
+    cascade?: Cascade;
+    /**
+     * Whether to return the created pool definitions.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+export interface BulkCreatePoolDefinitionsResponse {
+    /**
+     * List of created pool definitions and associated metadata.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkPoolDefinitionResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkPoolDefinitionResult {
+    /** Item metadata. */
+    itemMetadata?: ItemMetadata;
+    /** Pool definition. */
+    poolDefinition?: PoolDefinition;
+}
+export interface ItemMetadata {
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+export interface UpdatePoolDefinitionRequest {
+    /** Pool definition to update. */
+    poolDefinition: PoolDefinition;
+    /** *Required.** Determines when the changes to this pool definition and program definitions containing it will be applied to associated programs and pools. */
+    cascade?: Cascade;
+}
+export interface UpdatePoolDefinitionResponse {
+    /** Updated pool definition. */
+    poolDefinition?: PoolDefinition;
+}
+export interface BulkUpdatePoolDefinitionsRequest {
+    /**
+     * Pool definitions to update.
+     * @minSize 1
+     * @maxSize 100
+     */
+    poolDefinitions?: MaskedPoolDefinition[];
+    /** *Required.** Determines when the changes to these pool definitions program definitions containing them will be applied to associated programs and pools. */
+    cascade?: Cascade;
+    /**
+     * Whether to return the updated pool definitions.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+export interface MaskedPoolDefinition {
+    /** Pool definition to update. */
+    poolDefinition?: PoolDefinition;
+    /** Explicit list of fields to update. */
+    fieldMask?: string[];
+}
+export interface BulkUpdatePoolDefinitionsResponse {
+    /**
+     * List of updated pool definitions and associated metadata.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkPoolDefinitionResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface DeletePoolDefinitionRequest {
+    /**
+     * ID of the pool definition to delete.
+     * @format GUID
+     */
+    poolDefinitionId: string;
+    /** *Required**. Determines when the changes to this pool definition the program definitions containing it will be applied to associated programs and pools. */
+    cascade?: Cascade;
+}
+export interface DeletePoolDefinitionResponse {
+}
+export interface BulkDeletePoolDefinitionsRequest {
+    /**
+     * List of IDs of the pool definitions to delete.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    poolDefinitionIds: string[];
+    /** *Required**. Determines when the changes to these pool definitions the program definitions containing it will be applied to associated programs and pools. */
+    cascade?: Cascade;
+}
+export interface BulkDeletePoolDefinitionsResponse {
+    /**
+     * List of deleted pool definitions and associated metadata.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkPoolDefinitionResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface GetPoolDefinitionRequest {
+    /**
+     * ID of the pool definition to retrieve.
+     * @format GUID
+     */
+    poolDefinitionId: string;
+}
+export interface GetPoolDefinitionResponse {
+    /** Retrieved pool definition. */
+    poolDefinition?: PoolDefinition;
+}
+export interface QueryPoolDefinitionsRequest {
+    /** Filter, sort, and paging to apply to the query. */
+    query?: CursorQuery;
+}
+export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
+     * for more information.
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * List of sort objects.
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+export interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+export interface Sorting {
+    /**
+     * Field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    /** Ascending sort order. */
+    ASC = "ASC",
+    /** Descending sort order. */
+    DESC = "DESC"
+}
+export interface CursorPaging {
+    /**
+     * Maximum number of items to return.
+     * @max 100
+     */
+    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.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+export interface QueryPoolDefinitionsResponse {
+    /** List of retrieved pool definitions. */
+    poolDefinitions?: PoolDefinition[];
+    /** Metadata for the paginated results. */
+    metadata?: 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.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+export interface AddPoolDefinitionToProgramDefinitionRequest {
+    /**
+     * ID of the pool definition to add to the program definition.
+     * @format GUID
+     */
+    poolDefinitionId: string;
+    /**
+     * ID of the program definition to add the pool definition to.
+     * @format GUID
+     */
+    programDefinitionId: string;
+    /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
+    cascade: Cascade;
+}
+export interface AddPoolDefinitionToProgramDefinitionResponse {
+    /** Updated pool definition. */
+    poolDefinition?: PoolDefinition;
+}
+export interface RemovePoolDefinitionFromProgramDefinitionRequest {
+    /**
+     * ID of the pool definition to remove from the program definition.
+     * @format GUID
+     */
+    poolDefinitionId: string;
+    /**
+     * ID of the program definition to remove the pool definition from.
+     * @format GUID
+     */
+    programDefinitionId: string;
+    /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
+    cascade: Cascade;
+}
+export interface RemovePoolDefinitionFromProgramDefinitionResponse {
+    /** Updated pool definition. */
+    poolDefinition?: PoolDefinition;
+}
+export interface FindPoolDefinitionsByProgramDefinitionRequest {
+    /**
+     * ID of the program definition to retrieve its pool definitions.
+     * @format GUID
+     */
+    programDefinitionId: string;
+    /**
+     * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
+     * @minLength 1
+     * @maxLength 50
+     */
+    namespace: string;
+}
+export interface FindPoolDefinitionsByProgramDefinitionResponse {
+    /** Retrieved pool definitions. */
+    poolDefinitions?: PoolDefinition[];
+}
+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 {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+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.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export 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;
+}
+export 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?: WebhookIdentityType;
+}
+/** @oneof */
+export 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;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}