@wix/auto_sdk_ecom_discount-rules 1.0.15 → 1.0.16

package/build/internal/es/src/ecom-discounts-v1-discount-rule-discount-rules.types.d.ts

@@ -1,831 +0,0 @@
-export interface DiscountRule {
-    /**
-     * Discount rule ID.
-     * @format GUID
-     * @readonly
-     */
-    id?: string | null;
-    /**
-     * Revision number, which increments by 1 each time the discount rule is updated.
-     * To prevent conflicting changes, the current `revision` must be passed when updating the discount rule.
-     * @readonly
-     */
-    revision?: string | null;
-    /**
-     * Date and time the discount rule was created.
-     * @readonly
-     */
-    createdDate?: Date | null;
-    /**
-     * Date and time the discount rule was last updated.
-     * @readonly
-     */
-    updatedDate?: Date | null;
-    /**
-     * Whether the discount rule is active.
-     *
-     * Default: `true`
-     */
-    active?: boolean | null;
-    /**
-     * Discount rule name.
-     * @minLength 1
-     * @maxLength 50
-     */
-    name?: string | null;
-    /**
-     * Discount rule trigger.
-     * A set of conditions that must be met for the `discounts` to be applied.
-     * Not passing a trigger will cause the discount to always apply.
-     */
-    trigger?: DiscountTrigger;
-    /** Time frame in which the discount rule is active. */
-    activeTimeInfo?: ActiveTimeInfo;
-    /**
-     * List of discounts that are applied when one or more triggers are met.
-     *
-     * > **Notes:**
-     * >
-     * > + Currently, only 1 discount can be defined per discount rule.
-     * > + A discount rule can be applied on multiple items per cart.
-     * > + A discount rule can only be applied once per item.
-     */
-    discounts?: Discounts;
-    /**
-     * Discount rule status.
-     * Default: `UNDEFINED`
-     * @readonly
-     */
-    status?: StatusWithLiterals;
-    /**
-     * Number of times the discount rule was used.
-     * @readonly
-     */
-    usageCount?: number;
-}
-/** DiscountTrigger - description of a set of conditions, that if met, will trigger the associated rule actions */
-export interface DiscountTrigger extends DiscountTriggerTriggerOneOf {
-    /** Chain multiple triggers with the `and` operator. */
-    and?: And;
-    /** Chain multiple triggers with the `or` operator. */
-    or?: Or;
-    /** Custom trigger. */
-    customTrigger?: Custom;
-    /** Subtotal trigger range. */
-    subtotalRange?: SubtotalRange;
-    /** Item quantity trigger range. */
-    itemQuantityRange?: ItemQuantityRange;
-    /** Trigger type. */
-    triggerType?: TriggerTypeWithLiterals;
-}
-/** @oneof */
-export interface DiscountTriggerTriggerOneOf {
-    /** Chain multiple triggers with the `and` operator. */
-    and?: And;
-    /** Chain multiple triggers with the `or` operator. */
-    or?: Or;
-    /** Custom trigger. */
-    customTrigger?: Custom;
-    /** Subtotal trigger range. */
-    subtotalRange?: SubtotalRange;
-    /** Item quantity trigger range. */
-    itemQuantityRange?: ItemQuantityRange;
-}
-/**
- * This object represents a scope of catalog items. Examples:
- * 1. All catalog items of a specific app - type = CATALOG_ITEM, CatalogItemFilter with `catalog_app_id`
- * 2. Specific catalog item - type = CATALOG_ITEM, CatalogItemFilter with `catalog_app_id` + `catalog_item_ids`
- * 3. External catalog filter - type = CUSTOM_FILTER, CustomFilter with 'app_id' + 'params'
- */
-export interface Scope extends ScopeScopeItemsOneOf {
-    /** Catalog item filter. Must be passed with `type."CATALOG_ITEM"`. */
-    catalogItemFilter?: CatalogItemFilter;
-    /** Custom filter. Must be passed with `type."CATALOG_ITEM"`. */
-    customFilter?: CustomFilter;
-    /**
-     * Scope ID.
-     * @minLength 1
-     * @maxLength 100
-     */
-    id?: string;
-    /** Scope type. */
-    type?: ScopeTypeWithLiterals;
-}
-/** @oneof */
-export interface ScopeScopeItemsOneOf {
-    /** Catalog item filter. Must be passed with `type."CATALOG_ITEM"`. */
-    catalogItemFilter?: CatalogItemFilter;
-    /** Custom filter. Must be passed with `type."CATALOG_ITEM"`. */
-    customFilter?: CustomFilter;
-}
-export declare enum ScopeType {
-    UNDEFINED_SCOPE = "UNDEFINED_SCOPE",
-    /** Specific catalog items */
-    CATALOG_ITEM = "CATALOG_ITEM",
-    /** Specific items by custom filters */
-    CUSTOM_FILTER = "CUSTOM_FILTER"
-}
-/** @enumType */
-export type ScopeTypeWithLiterals = ScopeType | 'UNDEFINED_SCOPE' | 'CATALOG_ITEM' | 'CUSTOM_FILTER';
-export interface CatalogItemFilter {
-    /**
-     * Catalog App ID. For example, the Wix Stores, Wix Bookings, or 3rd-party `appId`.
-     * @format GUID
-     */
-    catalogAppId?: string;
-    /**
-     * ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores.
-     * @minLength 1
-     * @maxLength 36
-     * @maxSize 50
-     */
-    catalogItemIds?: string[];
-}
-export interface CustomFilter {
-    /**
-     * Custom filter app ID, when relevant.
-     * @format GUID
-     */
-    appId?: string;
-    /**
-     * Custom filter in `{ "key": "value" }` form.
-     * For example, an array of `collectionIDs`:
-     * `{ ["collectionId": "12345"], ["collectionId": "67890"] }`.
-     */
-    params?: Record<string, any> | null;
-}
-export interface And {
-    /**
-     * List of triggers to have an "AND" operator between their results.
-     * @minSize 2
-     * @maxSize 5
-     */
-    triggers?: DiscountTrigger[];
-}
-export interface Or {
-    /**
-     * List of triggers to have an "OR" operator between their results.
-     * @minSize 2
-     * @maxSize 5
-     */
-    triggers?: DiscountTrigger[];
-}
-export interface Custom {
-    /**
-     * Trigger ID.
-     * @minLength 1
-     * @maxLength 100
-     */
-    id?: string;
-    /**
-     * ID of the app that created the trigger.
-     * @format GUID
-     */
-    appId?: string;
-}
-export interface SubtotalRange {
-    /**
-     * Relevant scopes for `SPECIFIC_ITEMS` target type.
-     * @maxSize 50
-     */
-    scopes?: Scope[];
-    /**
-     * Minimum subtotal price (inclusive).
-     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
-     */
-    from?: string | null;
-    /**
-     * Maximum subtotal price (inclusive).
-     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
-     */
-    to?: string | null;
-}
-export interface ItemQuantityRange {
-    /**
-     * Relevant scopes for `SPECIFIC_ITEMS` target type.
-     * @maxSize 50
-     */
-    scopes?: Scope[];
-    /**
-     * Minimum item quantity (inclusive).
-     * @min 1
-     */
-    from?: number | null;
-    /**
-     * Maximum item quantity (inclusive).
-     * @min 1
-     */
-    to?: number | null;
-}
-export declare enum TriggerType {
-    UNDEFINED = "UNDEFINED",
-    /** Operator used for chaining multiple triggers. Currently 1 `AND` chain operator is supported. */
-    AND = "AND",
-    /** Subtotal must be within the specified `subtotalRange` values. */
-    SUBTOTAL_RANGE = "SUBTOTAL_RANGE",
-    /** Quantity of items in scope must be within specified `itemQuantityRange` values. */
-    ITEM_QUANTITY_RANGE = "ITEM_QUANTITY_RANGE",
-    /** Custom trigger type defined in `customTrigger` object. */
-    CUSTOM = "CUSTOM",
-    /** Chain multiple triggers with OR operator */
-    OR = "OR"
-}
-/** @enumType */
-export type TriggerTypeWithLiterals = TriggerType | 'UNDEFINED' | 'AND' | 'SUBTOTAL_RANGE' | 'ITEM_QUANTITY_RANGE' | 'CUSTOM' | 'OR';
-export interface ActiveTimeInfo {
-    /** Date and time the discount rule is active **from**, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
-    start?: Date | null;
-    /** Date and time the discount rule is active **till**, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
-    end?: Date | null;
-}
-export interface Discounts {
-    /**
-     * Discounts.
-     * @minSize 1
-     * @maxSize 1
-     */
-    values?: Discount[];
-}
-export interface Discount extends DiscountDiscountOneOf {
-    /**
-     * Percentage to discount from original price.
-     * @min 0.1
-     * @max 100
-     */
-    percentage?: number;
-    /**
-     * Amount to discount from original price.
-     * @decimalValue options { gt:0, lte:1000000000000000, maxScale:4 }
-     */
-    fixedAmount?: string;
-    /**
-     * Fixed price. Line item will be fixed to this price.
-     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
-     */
-    fixedPrice?: string;
-    /**
-     * Discount target.
-     *
-     * + `SPECIFIC_ITEMS`: Discount applies to a specific set of items.
-     */
-    targetType?: TypeWithLiterals;
-    /** Data related to `SPECIFIC_ITEMS` target type. */
-    specificItemsInfo?: SpecificItemsInfo;
-    /** Discount type. */
-    discountType?: DiscountTypeWithLiterals;
-}
-/** @oneof */
-export interface DiscountDiscountOneOf {
-    /**
-     * Percentage to discount from original price.
-     * @min 0.1
-     * @max 100
-     */
-    percentage?: number;
-    /**
-     * Amount to discount from original price.
-     * @decimalValue options { gt:0, lte:1000000000000000, maxScale:4 }
-     */
-    fixedAmount?: string;
-    /**
-     * Fixed price. Line item will be fixed to this price.
-     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
-     */
-    fixedPrice?: string;
-}
-export declare enum Type {
-    /** Target type is not defined */
-    UNDEFINED = "UNDEFINED",
-    /** Target type is a set of specific items */
-    SPECIFIC_ITEMS = "SPECIFIC_ITEMS"
-}
-/** @enumType */
-export type TypeWithLiterals = Type | 'UNDEFINED' | 'SPECIFIC_ITEMS';
-export interface SpecificItemsInfo {
-    /**
-     * All associated scopes for `SPECIFIC_ITEMS` target type.
-     * @minSize 1
-     * @maxSize 50
-     */
-    scopes?: Scope[];
-}
-export declare enum DiscountType {
-    UNDEFINED = "UNDEFINED",
-    /** Price is reduced by percentage value. */
-    PERCENTAGE = "PERCENTAGE",
-    /** Price is reduced by fixed amount. */
-    FIXED_AMOUNT = "FIXED_AMOUNT",
-    /** Price will be set to fixed amount. */
-    FIXED_PRICE = "FIXED_PRICE"
-}
-/** @enumType */
-export type DiscountTypeWithLiterals = DiscountType | 'UNDEFINED' | 'PERCENTAGE' | 'FIXED_AMOUNT' | 'FIXED_PRICE';
-export interface BuyXGetYInfo {
-    /** Information about which items must be in the cart (buy X) for the discount to apply (get Y). */
-    customerBuys?: CustomerBuy;
-    /** Information about which items will be discounted (get Y). */
-    customerGets?: CustomerGet;
-    /**
-     * The maximum number of times the 'buy X get Y' discount can be applied.
-     * For example, when the value of `limit` is `2`, with a "2+1" sale on all items, the following logic applies:
-     * + Buy 2 get 1, buy 3 get 1.
-     * + Buy 4 get 2, buy 6 get 2, buy 9 get 2, and so on.
-     * @min 1
-     */
-    limit?: number | null;
-}
-export interface CustomerBuy extends CustomerBuyConditionOneOf {
-    /**
-     * Minimum number of items the customer must add to the cart to be eligible for a discount.
-     * @min 1
-     */
-    minimumQuantity?: number;
-    /**
-     * Minimum price the customer must add to the cart to be eligible for a discount.
-     * @decimalValue options { gte:0, lte:1000000000000000 }
-     */
-    minimumSpend?: string | null;
-    /**
-     * Scopes of the items that must be added to the cart to enable the discount.
-     * @minSize 1
-     * @maxSize 50
-     */
-    scopes?: Scope[];
-}
-/** @oneof */
-export interface CustomerBuyConditionOneOf {
-    /**
-     * Minimum number of items the customer must add to the cart to be eligible for a discount.
-     * @min 1
-     */
-    minimumQuantity?: number;
-    /**
-     * Minimum price the customer must add to the cart to be eligible for a discount.
-     * @decimalValue options { gte:0, lte:1000000000000000 }
-     */
-    minimumSpend?: string | null;
-}
-export interface CustomerGet {
-    /**
-     * Exact number of items in the cart that will be discounted.
-     * If the cart contains fewer items than the value of quantity, the discount will not apply.
-     * @min 1
-     */
-    quantity?: number;
-    /**
-     * Scopes of the items that will be discounted.
-     * @minSize 1
-     * @maxSize 50
-     */
-    scopes?: Scope[];
-}
-export declare enum Status {
-    /** Rule status is not defined. */
-    UNDEFINED = "UNDEFINED",
-    /** Rule status is live. */
-    LIVE = "LIVE",
-    /** Rule status is expired, it might have been live in the past. */
-    EXPIRED = "EXPIRED",
-    /** Rule status is pending, it might be live in the future. */
-    PENDING = "PENDING"
-}
-/** @enumType */
-export type StatusWithLiterals = Status | 'UNDEFINED' | 'LIVE' | 'EXPIRED' | 'PENDING';
-/** The discount settings */
-export interface DiscountSettings {
-    /** Discount applies to either `ALL_ITEMS`, or to the `LOWEST_PRICED_ITEM`. */
-    appliesTo?: AppliedSubjectTypeWithLiterals;
-    /**
-     * Whether the discount will apply to subscriptions.
-     *
-     * Default: `false`
-     */
-    includeSubscription?: boolean | null;
-    /**
-     * Maximum total number of uses allowed for the discount rule.
-     * @min 1
-     * @max 2147483646
-     */
-    usageLimit?: number | null;
-    /**
-     * The usage limit per user per discount.
-     * When not provided, this setting will not apply.
-     * @min 1
-     * @max 2147483646
-     */
-    usageLimitPerUser?: number | null;
-}
-/** TODO: check if can be removed */
-export declare enum AppliedSubjectType {
-    UNDEFINED = "UNDEFINED",
-    /** Discount applies to all items at checkout. */
-    ALL_ITEMS = "ALL_ITEMS",
-    /** Discount applies to the lowest priced item at checkout. */
-    LOWEST_PRICED_ITEM = "LOWEST_PRICED_ITEM"
-}
-/** @enumType */
-export type AppliedSubjectTypeWithLiterals = AppliedSubjectType | 'UNDEFINED' | 'ALL_ITEMS' | 'LOWEST_PRICED_ITEM';
-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 CreateDiscountRuleRequest {
-    /** Discount rule info. */
-    discountRule: DiscountRule;
-}
-export interface CreateDiscountRuleResponse {
-    /** Discount rule. */
-    discountRule?: DiscountRule;
-}
-export interface GetDiscountRuleRequest {
-    /**
-     * ID of the discount rule to retrieve.
-     * @format GUID
-     */
-    discountRuleId: string;
-}
-export interface GetDiscountRuleResponse {
-    /** The requested discount rule. */
-    discountRule?: DiscountRule;
-}
-export interface UpdateDiscountRuleRequest {
-    /** Discount rule info. */
-    discountRule: DiscountRule;
-}
-export interface UpdateDiscountRuleResponse {
-    /** Updated discount rule. */
-    discountRule?: DiscountRule;
-}
-export interface DeleteDiscountRuleRequest {
-    /**
-     * ID of the discount rule to delete.
-     * @format GUID
-     */
-    discountRuleId: string;
-}
-export interface DeleteDiscountRuleResponse {
-}
-export interface QueryDiscountRulesRequest {
-    /** Query options. */
-    query?: PlatformQuery;
-}
-export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
-    /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
-    paging?: PlatformPaging;
-    /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
-    cursorPaging?: CursorPaging;
-    /** Filter object. */
-    filter?: Record<string, any> | null;
-    /** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
-    sort?: Sorting[];
-}
-/** @oneof */
-export interface PlatformQueryPagingMethodOneOf {
-    /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
-    paging?: PlatformPaging;
-    /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
-    cursorPaging?: CursorPaging;
-}
-export interface Sorting {
-    /**
-     * Name of the field to sort by.
-     * @maxLength 512
-     */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrderWithLiterals;
-}
-export declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-/** @enumType */
-export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-export interface PlatformPaging {
-    /**
-     * Number of items to load.
-     * @max 100
-     */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-export interface CursorPaging {
-    /**
-     * Maximum number of items to return in the results.
-     * @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 QueryDiscountRulesResponse {
-    /** List of discount rules. */
-    discountRules?: DiscountRule[];
-    /** Details on the paged set of results returned. */
-    pagingMetadata?: PlatformPagingMetadata;
-}
-export interface PlatformPagingMetadata {
-    /** The number of items returned in this response. */
-    count?: number | null;
-    /** The offset which was requested. Returned if offset paging was used. */
-    offset?: number | null;
-    /** The total number of items that match the query. Returned if offset paging was used. */
-    total?: number | null;
-    /** Cursors to navigate through result pages. Returned if cursor paging was used. */
-    cursors?: Cursors;
-}
-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 GetAppliedDiscountsRequest {
-    /**
-     * Line items for which to check for discount rules.
-     * @maxSize 1000
-     */
-    lineItems?: LineItem[];
-    /**
-     * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
-     * @format GUID
-     */
-    purchaseFlowId?: string | null;
-}
-export interface LineItem {
-    /**
-     * Line item ID.
-     * @minLength 1
-     * @maxLength 100
-     */
-    id?: string;
-    /**
-     * Line item quantity.
-     * @max 100000
-     */
-    quantity?: number | null;
-    /** Catalog and item reference info. Learn more about [integrating Wix Stores products with Wix eCommerce](https://dev.wix.com/api/rest/wix-stores/catalog/ecommerce-integration). */
-    catalogReference?: CatalogReference;
-    /**
-     * Line item price.
-     * @decimalValue options { gte:0 }
-     */
-    price?: string;
-}
-/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
-export interface CatalogReference {
-    /**
-     * ID of the item within the catalog it belongs to.
-     * @minLength 1
-     * @maxLength 36
-     */
-    catalogItemId?: string;
-    /**
-     * ID of the app providing the catalog.
-     *
-     * You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
-     *
-     * For items from Wix catalogs, the following values always apply:
-     * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
-     * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
-     * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
-     * @minLength 1
-     */
-    appId?: string;
-    /**
-     * Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
-     *
-     * For products and variants from a Wix Stores catalog, learn more about eCommerce integration ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)).
-     */
-    options?: Record<string, any> | null;
-}
-export interface GetAppliedDiscountsResponse {
-    /** All eligible discounts. */
-    appliedDiscounts?: AppliedDiscount[];
-}
-export interface AppliedDiscount {
-    /** Discount type. */
-    discountType?: TypeWithLiterals;
-    /**
-     * IDs of line items the discount applies to, in GUID format.
-     * @format GUID
-     * @maxSize 1000
-     */
-    lineItemIds?: string[];
-    /** Applied discount rule. */
-    appliedDiscountRule?: AppliedDiscountRule;
-}
-export interface AppliedDiscountRule {
-    /**
-     * Applied discount rule ID.
-     * @format GUID
-     */
-    id?: string;
-    /** Discount rule name. */
-    name?: DiscountRuleName;
-    /** Total amount reduced from all discounted line items. */
-    amount?: MultiCurrencyPrice;
-    /** Discount rule type. */
-    discountRuleType?: DiscountTypeWithLiterals;
-}
-export interface DiscountRuleName {
-    /**
-     * Original discount rule name (in site's default language).
-     * @minLength 1
-     * @maxLength 256
-     */
-    original?: string;
-    /**
-     * Translated discount rule name according to buyer language.
-     *
-     * Default: `original`
-     * @minLength 1
-     * @maxLength 500
-     */
-    translated?: string | null;
-}
-export interface MultiCurrencyPrice {
-    /**
-     * Amount.
-     * @decimalValue options { gte:0, lte:1000000000000000 }
-     */
-    amount?: string;
-    /**
-     * Converted amount.
-     * @readonly
-     * @decimalValue options { gte:0, lte:1000000000000000 }
-     */
-    convertedAmount?: string;
-    /**
-     * Amount formatted with currency symbol.
-     * @readonly
-     */
-    formattedAmount?: string;
-    /**
-     * Converted amount formatted with currency symbol.
-     * @readonly
-     */
-    formattedConvertedAmount?: string;
-}
-export 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 */
-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 Empty {
-}
-export interface DiscountRuleUsageLimitReached {
-    /** Discount Rule */
-    rule?: DiscountRule;
-}
-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?: WebhookIdentityTypeWithLiterals;
-}
-/** @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"
-}
-/** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';