@wix/auto_sdk_events_notifications 1.0.20 → 1.0.21

package/build/cjs/src/events-notifications-v2-notification-config-notifications.universal.d.ts

@@ -230,25 +230,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
@@ -258,12 +254,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;
 }
@@ -289,7 +281,7 @@ export interface EntityUpdatedEvent {
     currentEntity?: string;
 }
 export interface EntityDeletedEvent {
-    /** Entity that was deleted */
+    /** Entity that was deleted. */
     deletedEntity?: string | null;
 }
 export interface ActionEvent {
@@ -539,7 +531,7 @@ export interface Event {
     title?: string;
     /** Event description. */
     description?: string;
-    /** Rich-text content displayed in Wix UI - "About Event" section (HTML). */
+    /** Rich-text content that are displayed in a site's "About Event" section (HTML). */
     about?: string;
     /** Main event image. */
     mainImage?: string;
@@ -586,7 +578,7 @@ export interface Event {
     categories?: Category[];
     /** Visual settings for event. */
     eventDisplaySettings?: EventDisplaySettings;
-    /** Rich content displayed in Wix UI - "About Event" section. Successor to `about` field. */
+    /** Rich content that are displayed in a site's "About Event" section. Successor to `about` field. */
     longDescription?: RichContent;
     /**
      * Event publish timestamp.
@@ -790,7 +782,7 @@ export interface Money {
      */
     amount?: string;
     /**
-     * ISO 4217 format of the currency e.g., `USD`.
+     * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
      * @format CURRENCY
      */
     currency?: string;
@@ -831,7 +823,7 @@ export interface SiteUrl {
     path?: string;
 }
 /**
- * The form defines which elements are rendered in the Wix UI during the registration process (RSVP or checkout).
+ * The form defines which elements are displayed to a site visitor during the registration process (RSVP or checkout).
  * It also contains customizable messages and labels.
  *
  *
@@ -846,7 +838,10 @@ export interface SiteUrl {
 export interface Form {
     /** Nested fields as an ordered list. */
     controls?: InputControl[];
-    /** Set of configured form messages. */
+    /**
+     * Set of defined form messages displayed in the UI before, during, and after a registration flow.
+     * Includes the configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
+     */
     messages?: FormMessages;
 }
 /**
@@ -856,17 +851,17 @@ export interface Form {
 export interface InputControl {
     /** Field control type. */
     type?: InputControlTypeWithLiterals;
-    /** Whether control is mandatory (such as name & email). When true, only label can be changed. */
+    /** Whether the control is mandatory (such as `name` & `email`). When `true`, only the label can be changed. */
     system?: boolean;
     /**
-     * Deprecated: Use `id`.
+     * Deprecated: Use `id` or `_id`.
      * @deprecated
      */
     name?: string;
     /** Child inputs. */
     inputs?: Input[];
     /**
-     * Deprecated: use `inputs.label`.
+     * *Deprecated:** Use `controls.inputs.label`.
      * @deprecated
      */
     label?: string;
@@ -875,7 +870,7 @@ export interface InputControl {
     /** Unique control ID. */
     _id?: string;
     /**
-     * Whether input control is deleted.
+     * Whether the input control is deleted.
      * @readonly
      */
     deleted?: boolean | null;
@@ -883,37 +878,37 @@ export interface InputControl {
 export declare enum InputControlType {
     /** Single text value field. */
     INPUT = "INPUT",
-    /** Single text value field. */
+    /** Single text value field with multiple lines. */
     TEXTAREA = "TEXTAREA",
-    /** Single-choice field of predefined values. */
+    /** Single-choice field with predefined values. */
     DROPDOWN = "DROPDOWN",
-    /** Single-choice field of predefined values. */
+    /** Single-choice field with predefined values. */
     RADIO = "RADIO",
-    /** Multiple-choice field of predefined values. */
+    /** Multiple-choice field with predefined values. */
     CHECKBOX = "CHECKBOX",
-    /** First and last name fields. */
+    /** Fields for entering first and last names. */
     NAME = "NAME",
-    /** Additional guests and respective guest names fields. */
+    /** Fields for additional guests and their respective names. */
     GUEST_CONTROL = "GUEST_CONTROL",
     /** Single-line address field. */
     ADDRESS_SHORT = "ADDRESS_SHORT",
-    /** Full address field. */
+    /** Full address field with multiple lines. */
     ADDRESS_FULL = "ADDRESS_FULL",
-    /** Year, month and day fields. */
+    /** Fields for entering year, month, and day. */
     DATE = "DATE"
 }
 /** @enumType */
 export type InputControlTypeWithLiterals = InputControlType | 'INPUT' | 'TEXTAREA' | 'DROPDOWN' | 'RADIO' | 'CHECKBOX' | 'NAME' | 'GUEST_CONTROL' | 'ADDRESS_SHORT' | 'ADDRESS_FULL' | 'DATE';
-/** An input of one or multiple text values */
+/** Child inputs. */
 export interface Input {
     /** Field name. */
     name?: string;
     /**
-     * Deprecated: use `ValueType.TEXT_ARRAY`.
+     * *Deprecated:** Use `controls.inputs.type.TEXT_ARRAY`.
      * @deprecated
      */
     array?: boolean;
-    /** Main field label */
+    /** Main field label. */
     label?: string;
     /** Additional labels for multi-valued fields such as address. */
     additionalLabels?: Record<string, string>;
@@ -929,17 +924,20 @@ export interface Input {
      */
     type?: ValueTypeWithLiterals;
     /**
-     * A maximum accepted values for array input.
-     * Only applicable for inputs of valueType: TEXT_ARRAY.
+     * The maximum number of accepted values for array input.
+     *
+     * **Note:** Only applicable for `TEXT_ARRAY` input fields.
      */
     maxSize?: number | null;
     /**
-     * Preselected option.
-     * Currently only applicable for dropdown.
+     * Default option initially selected when an input has multiple choices.
+     *
+     * Defaults to first (0th) option, if not configured.
+     * Currently only applicable for `type.dropdown`.
      */
     defaultOptionSelection?: OptionSelection;
     /**
-     * Additional labels for multi-valued fields such as address.
+     * Additional labels for multi-valued fields, such as address.
      * @readonly
      */
     labels?: Label[];
@@ -959,12 +957,12 @@ export type ValueTypeWithLiterals = ValueType | 'TEXT' | 'NUMBER' | 'TEXT_ARRAY'
  */
 export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
     /**
-     * 0-based index from predefined `input.options` which is selected initially.
+     * 0-based index from predefined `controls.inputs.options` which is initial selection.
      * @max 199
      */
     optionIndex?: number;
     /**
-     * Placeholder hint describing expected choices (such as "Please select").
+     * Placeholder hint describing expected choices, such as "Please select".
      * Considered an empty choice.
      * @maxLength 200
      */
@@ -973,12 +971,12 @@ export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
 /** @oneof */
 export interface OptionSelectionSelectedOptionOneOf {
     /**
-     * 0-based index from predefined `input.options` which is selected initially.
+     * 0-based index from predefined `controls.inputs.options` which is initial selection.
      * @max 199
      */
     optionIndex?: number;
     /**
-     * Placeholder hint describing expected choices (such as "Please select").
+     * Placeholder hint describing expected choices, such as "Please select".
      * Considered an empty choice.
      * @maxLength 200
      */
@@ -995,7 +993,7 @@ export interface Label {
  * It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
  */
 export interface FormMessages {
-    /** RSVP form messages. */
+    /** RSVP form ([SDK](https://dev.wix.com/docs/sdk/backend-modules/events/rsvp-v2/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/events/rsvp-v2/introduction)) messages. */
     rsvp?: RsvpFormMessages;
     /** Checkout form messages. */
     checkout?: CheckoutFormMessages;
@@ -1005,15 +1003,15 @@ export interface FormMessages {
     ticketsUnavailable?: TicketsUnavailableMessages;
 }
 export interface RsvpFormMessages {
-    /** Label text indicating RSVP `YES` response. */
+    /** Label text indicating RSVP's `status` is `"YES"`. */
     rsvpYesOption?: string;
-    /** Label text indicating RSVP `NO` response. */
+    /** Label text indicating RSVP's `status` is `"NO"`. */
     rsvpNoOption?: string;
-    /** Messages shown for RSVP = `YES`. */
+    /** Messages displayed when an RSVP's `status` is set to `"YES"`. */
     positiveMessages?: Positive;
-    /** Messages shown for RSVP = `WAITING` (when event is full and waitlist is available). */
+    /** Messages displayed when an RSVP's `status` is set to `"WAITLIST"`, for when the event is full and a waitlist is available). */
     waitlistMessages?: Positive;
-    /** Messages shown for RSVP = `NO`. */
+    /** Messages displayed when an RSVP's `status` is set to `"NO"`. */
     negativeMessages?: Negative;
     /** "Submit form" call-to-action label text. */
     submitActionLabel?: string;
@@ -1511,17 +1509,32 @@ export interface ButtonData {
     link?: V1Link;
 }
 export interface Border {
-    /** Border width in pixels. */
+    /**
+     * Deprecated: Use `borderWidth` in `styles` instead.
+     * @deprecated
+     */
     width?: number | null;
-    /** Border radius in pixels. */
+    /**
+     * Deprecated: Use `borderRadius` in `styles` instead.
+     * @deprecated
+     */
     radius?: number | null;
 }
 export interface Colors {
-    /** The text color as a hexadecimal value. */
+    /**
+     * Deprecated: Use `textColor` in `styles` instead.
+     * @deprecated
+     */
     text?: string | null;
-    /** The border color as a hexadecimal value. */
+    /**
+     * Deprecated: Use `borderColor` in `styles` instead.
+     * @deprecated
+     */
     border?: string | null;
-    /** The background color as a hexadecimal value. */
+    /**
+     * Deprecated: Use `backgroundColor` in `styles` instead.
+     * @deprecated
+     */
     background?: string | null;
 }
 export interface PluginContainerData {
@@ -1604,10 +1617,57 @@ export declare enum ButtonDataType {
 /** @enumType */
 export type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
 export interface Styles {
-    /** Border attributes. */
+    /**
+     * Deprecated: Use `borderWidth` and `borderRadius` instead.
+     * @deprecated
+     */
     border?: Border;
-    /** Color attributes. */
+    /**
+     * Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
+     * @deprecated
+     */
     colors?: Colors;
+    /** Border width in pixels. */
+    borderWidth?: number | null;
+    /**
+     * Deprecated: Use `borderWidth` for normal/hover states instead.
+     * @deprecated
+     */
+    borderWidthHover?: number | null;
+    /** Border radius in pixels. */
+    borderRadius?: number | null;
+    /**
+     * Border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    borderColor?: string | null;
+    /**
+     * Border color as a hexadecimal value (hover state).
+     * @format COLOR_HEX
+     */
+    borderColorHover?: string | null;
+    /**
+     * Text color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    textColor?: string | null;
+    /**
+     * Text color as a hexadecimal value (hover state).
+     * @format COLOR_HEX
+     */
+    textColorHover?: string | null;
+    /**
+     * Background color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    backgroundColor?: string | null;
+    /**
+     * Background color as a hexadecimal value (hover state).
+     * @format COLOR_HEX
+     */
+    backgroundColorHover?: string | null;
+    /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
+    buttonSize?: string | null;
 }
 export interface V1Link extends V1LinkDataOneOf {
     /** The absolute URL for the linked document. */
@@ -2354,6 +2414,8 @@ export interface Decoration extends DecorationDataOneOf {
     underlineData?: boolean | null;
     /** Data for a spoiler decoration. */
     spoilerData?: SpoilerData;
+    /** Data for a strikethrough decoration. Defaults to `true`. */
+    strikethroughData?: boolean | null;
     /** The type of decoration to apply. */
     type?: DecorationTypeWithLiterals;
 }
@@ -2377,6 +2439,8 @@ export interface DecorationDataOneOf {
     underlineData?: boolean | null;
     /** Data for a spoiler decoration. */
     spoilerData?: SpoilerData;
+    /** Data for a strikethrough decoration. Defaults to `true`. */
+    strikethroughData?: boolean | null;
 }
 export declare enum DecorationType {
     BOLD = "BOLD",
@@ -2388,10 +2452,11 @@ export declare enum DecorationType {
     LINK = "LINK",
     COLOR = "COLOR",
     FONT_SIZE = "FONT_SIZE",
-    EXTERNAL = "EXTERNAL"
+    EXTERNAL = "EXTERNAL",
+    STRIKETHROUGH = "STRIKETHROUGH"
 }
 /** @enumType */
-export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL';
+export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
 export interface AnchorData {
     /** The target node's ID. */
     anchor?: string;
@@ -2756,46 +2821,47 @@ export interface Badge {
 export declare enum Type {
     /** Unknown badge type. */
     UNKNOWN_BADGE_TYPE = "UNKNOWN_BADGE_TYPE",
-    /** Urgent badge type. */
-    URGENT = "URGENT",
-    /** Informational badge type. */
-    INFO = "INFO",
-    /** General badge type. */
-    GENERAL = "GENERAL"
+    /** 1st priority badge type. */
+    FIRST_PRIORITY = "FIRST_PRIORITY",
+    /** 2nd priority badge type. */
+    SECOND_PRIORITY = "SECOND_PRIORITY",
+    /** 3rd priority badge type. */
+    THIRD_PRIORITY = "THIRD_PRIORITY"
 }
 /** @enumType */
-export type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | 'URGENT' | 'INFO' | 'GENERAL';
+export type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | 'FIRST_PRIORITY' | 'SECOND_PRIORITY' | 'THIRD_PRIORITY';
+/** Triggered when an order is confirmed. */
 export interface OrderConfirmed {
-    /** Order confirmation timestamp in ISO UTC. */
+    /** Date and time the order was confirmed. */
     timestamp?: Date | null;
     /**
-     * Site language when Order initiated
+     * Site language when the order was initiated.
      * @format LANGUAGE
      */
     language?: string | null;
     /** Notifications silenced for this domain event. */
     silent?: boolean | null;
     /**
-     * Locale in which Order was created.
+     * Locale in which the order was created.
      * @format LANGUAGE_TAG
      */
     locale?: string | null;
     /**
-     * Event ID.
+     * Event ID to which the order belongs.
      * @format GUID
      */
     eventId?: string;
     /** Unique order number. */
     orderNumber?: string;
-    /** Contact ID associated with this order. */
+    /** Contact ID associated with the order. */
     contactId?: string;
     /**
-     * Member ID associated with this order.
+     * Member ID associated with the order.
      * @format GUID
      */
     memberId?: string | null;
     /**
-     * Order created timestamp
+     * Date and time the order was created.
      * @readonly
      */
     created?: Date | null;
@@ -2815,7 +2881,7 @@ export interface OrderConfirmed {
     tickets?: Ticket[];
     /** Invoice. */
     invoice?: Invoice;
-    /** Reservation ID associated with this order. */
+    /** Reservation ID associated with the order. */
     reservationId?: string;
 }
 export interface FormResponse {
@@ -2837,7 +2903,7 @@ export interface InputValue {
      */
     value?: string;
     /**
-     * Multiple selection values. For example, the array is filled if several checkboxes are ticked.
+     * Multiple input values. For example, the array is filled if several checkboxes are ticked.
      * @maxSize 100
      * @maxLength 5000
      */
@@ -2906,17 +2972,17 @@ export interface StandardDetails {
     iso31662?: string | null;
 }
 export declare enum OrderStatus {
-    /** Order status not available for this request fieldset. */
+    /** Order status is not available for this request fieldset. */
     NA_ORDER_STATUS = "NA_ORDER_STATUS",
-    /** Order is confirmed and payment isn't required. */
+    /** Order is confirmed, no payment is required. */
     FREE = "FREE",
-    /** Order is paid for but the payment gateway has suspended the payment. */
+    /** Order was paid, but the payment gateway suspended the payment. */
     PENDING = "PENDING",
-    /** Order is paid via a payment gateway. */
+    /** Order is paid. */
     PAID = "PAID",
-    /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
+    /** Order is confirmed but has be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
     OFFLINE_PENDING = "OFFLINE_PENDING",
-    /** Order is awaiting payment at the cashier. */
+    /** Order is awaiting for payment at the cashier. */
     INITIATED = "INITIATED",
     /** Order is canceled. */
     CANCELED = "CANCELED",
@@ -2980,7 +3046,7 @@ export interface Ticket {
     canceled?: boolean | null;
 }
 export interface CheckIn {
-    /** Time of check-in */
+    /** Time of check-in. */
     created?: Date | null;
 }
 export interface OnlineConferencingLogin {
@@ -3003,14 +3069,14 @@ export interface Invoice {
      * @deprecated
      */
     total?: Money;
-    /** Discount applied to cart. */
+    /** Discount applied to a cart. */
     discount?: Discount;
-    /** Tax applied to cart. */
+    /** Tax applied to a cart. */
     tax?: Tax;
     /** Total cart amount before discount, tax, and fees. */
     subTotal?: Money;
     /**
-     * Total amount of cart after discount, tax, and fees.
+     * Total amount of a cart after discount, tax, and fees.
      * Grand total is calculated in the following order:
      * 1. Total prices of all items in the cart are calculated.
      * 2. Discount is subtracted from the cart (if applicable).
@@ -3025,7 +3091,7 @@ export interface Invoice {
     fees?: Fee[];
     /** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
     revenue?: Money;
-    /** URL to invoice preview. Returned only if order is paid. */
+    /** Invoice preview URL. Only returned if the order is paid. */
     previewUrl?: string | null;
 }
 export interface Item {
@@ -3059,7 +3125,7 @@ export interface Item {
 export interface Discount {
     /** Total discount amount. */
     amount?: Money;
-    /** Total charge after applied discount. */
+    /** Total sum after the discount. */
     afterDiscount?: Money;
     /**
      * Discount coupon code.
@@ -3095,11 +3161,11 @@ export interface DiscountItemDiscountOneOf {
     paidPlan?: PaidPlanDiscount;
 }
 export interface CouponDiscount {
-    /** Discount coupon name. */
+    /** Discount coupon name. **Deprecated:** Use `invoice.discounts.coupon.name` instead. */
     name?: string;
-    /** Discount coupon code. */
+    /** Discount coupon code. **Deprecated:** Use `invoice.discounts.coupon.code` instead. */
     code?: string;
-    /** Discount coupon ID. */
+    /** Discount coupon ID. **Deprecated:** Use `invoice.discounts.coupon.couponId` instead. */
     couponId?: string;
 }
 export interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
@@ -3163,7 +3229,7 @@ export type FeeNameWithLiterals = FeeName | 'WIX_FEE';
 export declare enum FeeType {
     /** Fee is added to the ticket price at checkout. */
     FEE_ADDED = "FEE_ADDED",
-    /** Seller absorbs the fee. It is deducted from the ticket price. */
+    /** Seller absorbs the fee. It's deducted from the ticket price. */
     FEE_INCLUDED = "FEE_INCLUDED",
     /** Fee is added to the ticket price at checkout. */
     FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
@@ -3315,23 +3381,24 @@ export interface TimeDuration {
      */
     minutes?: number;
 }
+/** Triggered when an order is paid. */
 export interface OrderPaid {
-    /** Order paid timestamp in ISO UTC. */
+    /** Date and time the order was paid. */
     timestamp?: Date | null;
     /**
-     * Site language when Order initiated
+     * Site language when the order was initiated.
      * @format LANGUAGE
      */
     language?: string | null;
     /** Notifications silenced for this domain event. */
     silent?: boolean | null;
     /**
-     * Locale in which Order was created.
+     * Locale in which the order was created.
      * @format LANGUAGE_TAG
      */
     locale?: string | null;
     /**
-     * Event ID.
+     * Event ID to which the order belongs.
      * @format GUID
      */
     eventId?: string;
@@ -3350,7 +3417,7 @@ export interface OrderPaid {
      */
     memberId?: string | null;
     /**
-     * Order created timestamp
+     * Date and time the order was created.
      * @readonly
      */
     created?: Date | null;
@@ -3427,9 +3494,10 @@ export interface TicketPdfResolveDelayed {
      */
     documentId?: string | null;
 }
+/** Triggered when an order is canceled. */
 export interface OrderCanceled {
     /**
-     * Event ID.
+     * Event ID to which the order belongs.
      * @format GUID
      */
     eventId?: string;
@@ -3439,12 +3507,12 @@ export interface OrderCanceled {
      */
     orderNumber?: string;
     /**
-     * Reservation ID associated with this order.
+     * Reservation ID associated with the order.
      * @format GUID
      */
     reservationId?: string;
     /**
-     * Contact ID associated with this order.
+     * Contact ID associated with the order.
      * @maxLength 36
      */
     contactId?: string;
@@ -3663,25 +3731,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
@@ -3691,12 +3755,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;
 }
@@ -3753,15 +3813,16 @@ type NotificationConfigNonNullablePaths = `rsvpConfirmation.notificationType` |
  * Triggers notification
  * @public
  * @documentationMaturity preview
- * @requiredField guests
- * @requiredField notification
+ * @requiredField options
+ * @requiredField options.guests
+ * @requiredField options.notification
  * @permissionId WIX_EVENTS.MANAGE
  * @permissionScope Manage Events
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
  * @applicableIdentity APP
  * @fqn wix.events.notifications.v2.NotificationService.TriggerNotification
  */
-export declare function triggerNotification(options?: TriggerNotificationOptions): Promise<void>;
+export declare function triggerNotification(options: TriggerNotificationOptions): Promise<void>;
 export interface TriggerNotificationOptions extends TriggerNotificationOptionsNotificationOneOf, TriggerNotificationOptionsGuestsOneOf {
     /** Email notification type */
     emailNotificationType?: EmailNotificationTypeWithLiterals;