@wix/auto_sdk_events_ticket-definitions-v-2 1.0.26 → 1.0.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +1 -1
  2. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +1 -1
  3. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -1
  4. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +258 -87
  5. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +22 -17
  6. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
  7. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +266 -103
  8. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +22 -17
  9. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
  10. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +1 -1
  11. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +1 -1
  12. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -1
  13. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +258 -87
  14. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +22 -17
  15. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
  16. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +266 -103
  17. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +22 -17
  18. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
  19. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +1 -1
  20. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +1 -1
  21. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -1
  22. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +258 -87
  23. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +22 -17
  24. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
  25. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +266 -103
  26. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +22 -17
  27. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
  28. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +1 -1
  29. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +1 -1
  30. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -1
  31. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +258 -87
  32. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +22 -17
  33. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
  34. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +266 -103
  35. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +22 -17
  36. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
  37. package/package.json +2 -2
@@ -391,15 +391,27 @@ export interface DateAndTimeSettings {
391
391
  dateAndTimeTbd?: boolean | null;
392
392
  /**
393
393
  * Message that is displayed when time and date is TBD.
394
+ *
395
+ * **Note:** This field is only used when the `dateAndTimeTbd` field value is `true`.
394
396
  * @maxLength 100
395
397
  */
396
398
  dateAndTimeTbdMessage?: string | null;
397
- /** Event start date. */
399
+ /**
400
+ * Event start date.
401
+ *
402
+ * **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`.
403
+ */
398
404
  startDate?: Date | null;
399
- /** Event end date. */
405
+ /**
406
+ * Event end date.
407
+ *
408
+ * **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`.
409
+ */
400
410
  endDate?: Date | null;
401
411
  /**
402
412
  * Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
413
+ *
414
+ * **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`.
403
415
  * @maxLength 100
404
416
  */
405
417
  timeZoneId?: string | null;
@@ -528,6 +540,8 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
528
540
  uri?: URI;
529
541
  /** Invalidate by file (for media files such as PDFs) */
530
542
  file?: File;
543
+ /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
544
+ customTag?: CustomTag;
531
545
  /**
532
546
  * tell us why you're invalidating the cache. You don't need to add your app name
533
547
  * @maxLength 256
@@ -557,6 +571,8 @@ export interface InvalidateCacheGetByOneOf {
557
571
  uri?: URI;
558
572
  /** Invalidate by file (for media files such as PDFs) */
559
573
  file?: File;
574
+ /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
575
+ customTag?: CustomTag;
560
576
  }
561
577
  export interface App {
562
578
  /**
@@ -607,6 +623,19 @@ export interface File {
607
623
  */
608
624
  fileName?: string;
609
625
  }
626
+ export interface CustomTag {
627
+ /**
628
+ * the msid the tag is related to
629
+ * @format GUID
630
+ */
631
+ metaSiteId?: string;
632
+ /**
633
+ * Tag to invalidate by
634
+ * @minLength 1
635
+ * @maxLength 256
636
+ */
637
+ tag?: string;
638
+ }
610
639
  export interface SalePeriodUpdated {
611
640
  /** Ticket definition sale period after update. */
612
641
  afterUpdate?: SalePeriod;
@@ -1250,7 +1279,7 @@ export interface Event {
1250
1279
  title?: string;
1251
1280
  /** Event description. */
1252
1281
  description?: string;
1253
- /** Rich-text content displayed in Wix UI - "About Event" section (HTML). */
1282
+ /** Rich-text content that are displayed in a site's "About Event" section (HTML). */
1254
1283
  about?: string;
1255
1284
  /** Main event image. */
1256
1285
  mainImage?: string;
@@ -1297,7 +1326,7 @@ export interface Event {
1297
1326
  categories?: Category[];
1298
1327
  /** Visual settings for event. */
1299
1328
  eventDisplaySettings?: EventDisplaySettings;
1300
- /** Rich content displayed in Wix UI - "About Event" section. Successor to `about` field. */
1329
+ /** Rich content that are displayed in a site's "About Event" section. Successor to `about` field. */
1301
1330
  longDescription?: RichContent;
1302
1331
  /**
1303
1332
  * Event publish timestamp.
@@ -1489,7 +1518,7 @@ export interface Money {
1489
1518
  */
1490
1519
  amount?: string;
1491
1520
  /**
1492
- * ISO 4217 format of the currency e.g., `USD`.
1521
+ * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
1493
1522
  * @format CURRENCY
1494
1523
  */
1495
1524
  currency?: string;
@@ -1530,7 +1559,7 @@ export interface SiteUrl {
1530
1559
  path?: string;
1531
1560
  }
1532
1561
  /**
1533
- * The form defines which elements are rendered in the Wix UI during the registration process (RSVP or checkout).
1562
+ * The form defines which elements are displayed to a site visitor during the registration process (RSVP or checkout).
1534
1563
  * It also contains customizable messages and labels.
1535
1564
  *
1536
1565
  *
@@ -1545,7 +1574,10 @@ export interface SiteUrl {
1545
1574
  export interface Form {
1546
1575
  /** Nested fields as an ordered list. */
1547
1576
  controls?: InputControl[];
1548
- /** Set of configured form messages. */
1577
+ /**
1578
+ * Set of defined form messages displayed in the UI before, during, and after a registration flow.
1579
+ * Includes the configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
1580
+ */
1549
1581
  messages?: FormMessages;
1550
1582
  }
1551
1583
  /**
@@ -1555,17 +1587,17 @@ export interface Form {
1555
1587
  export interface InputControl {
1556
1588
  /** Field control type. */
1557
1589
  type?: InputControlTypeWithLiterals;
1558
- /** Whether control is mandatory (such as name & email). When true, only label can be changed. */
1590
+ /** Whether the control is mandatory (such as `name` & `email`). When `true`, only the label can be changed. */
1559
1591
  system?: boolean;
1560
1592
  /**
1561
- * Deprecated: Use `id`.
1593
+ * Deprecated: Use `id` or `_id`.
1562
1594
  * @deprecated
1563
1595
  */
1564
1596
  name?: string;
1565
1597
  /** Child inputs. */
1566
1598
  inputs?: Input[];
1567
1599
  /**
1568
- * Deprecated: use `inputs.label`.
1600
+ * *Deprecated:** Use `controls.inputs.label`.
1569
1601
  * @deprecated
1570
1602
  */
1571
1603
  label?: string;
@@ -1574,7 +1606,7 @@ export interface InputControl {
1574
1606
  /** Unique control ID. */
1575
1607
  _id?: string;
1576
1608
  /**
1577
- * Whether input control is deleted.
1609
+ * Whether the input control is deleted.
1578
1610
  * @readonly
1579
1611
  */
1580
1612
  deleted?: boolean | null;
@@ -1582,37 +1614,37 @@ export interface InputControl {
1582
1614
  export declare enum InputControlType {
1583
1615
  /** Single text value field. */
1584
1616
  INPUT = "INPUT",
1585
- /** Single text value field. */
1617
+ /** Single text value field with multiple lines. */
1586
1618
  TEXTAREA = "TEXTAREA",
1587
- /** Single-choice field of predefined values. */
1619
+ /** Single-choice field with predefined values. */
1588
1620
  DROPDOWN = "DROPDOWN",
1589
- /** Single-choice field of predefined values. */
1621
+ /** Single-choice field with predefined values. */
1590
1622
  RADIO = "RADIO",
1591
- /** Multiple-choice field of predefined values. */
1623
+ /** Multiple-choice field with predefined values. */
1592
1624
  CHECKBOX = "CHECKBOX",
1593
- /** First and last name fields. */
1625
+ /** Fields for entering first and last names. */
1594
1626
  NAME = "NAME",
1595
- /** Additional guests and respective guest names fields. */
1627
+ /** Fields for additional guests and their respective names. */
1596
1628
  GUEST_CONTROL = "GUEST_CONTROL",
1597
1629
  /** Single-line address field. */
1598
1630
  ADDRESS_SHORT = "ADDRESS_SHORT",
1599
- /** Full address field. */
1631
+ /** Full address field with multiple lines. */
1600
1632
  ADDRESS_FULL = "ADDRESS_FULL",
1601
- /** Year, month and day fields. */
1633
+ /** Fields for entering year, month, and day. */
1602
1634
  DATE = "DATE"
1603
1635
  }
1604
1636
  /** @enumType */
1605
1637
  export type InputControlTypeWithLiterals = InputControlType | 'INPUT' | 'TEXTAREA' | 'DROPDOWN' | 'RADIO' | 'CHECKBOX' | 'NAME' | 'GUEST_CONTROL' | 'ADDRESS_SHORT' | 'ADDRESS_FULL' | 'DATE';
1606
- /** An input of one or multiple text values */
1638
+ /** Child inputs. */
1607
1639
  export interface Input {
1608
1640
  /** Field name. */
1609
1641
  name?: string;
1610
1642
  /**
1611
- * Deprecated: use `ValueType.TEXT_ARRAY`.
1643
+ * *Deprecated:** Use `controls.inputs.type.TEXT_ARRAY`.
1612
1644
  * @deprecated
1613
1645
  */
1614
1646
  array?: boolean;
1615
- /** Main field label */
1647
+ /** Main field label. */
1616
1648
  label?: string;
1617
1649
  /** Additional labels for multi-valued fields such as address. */
1618
1650
  additionalLabels?: Record<string, string>;
@@ -1628,17 +1660,20 @@ export interface Input {
1628
1660
  */
1629
1661
  type?: ValueTypeWithLiterals;
1630
1662
  /**
1631
- * A maximum accepted values for array input.
1632
- * Only applicable for inputs of valueType: TEXT_ARRAY.
1663
+ * The maximum number of accepted values for array input.
1664
+ *
1665
+ * **Note:** Only applicable for `TEXT_ARRAY` input fields.
1633
1666
  */
1634
1667
  maxSize?: number | null;
1635
1668
  /**
1636
- * Preselected option.
1637
- * Currently only applicable for dropdown.
1669
+ * Default option initially selected when an input has multiple choices.
1670
+ *
1671
+ * Defaults to first (0th) option, if not configured.
1672
+ * Currently only applicable for `type.dropdown`.
1638
1673
  */
1639
1674
  defaultOptionSelection?: OptionSelection;
1640
1675
  /**
1641
- * Additional labels for multi-valued fields such as address.
1676
+ * Additional labels for multi-valued fields, such as address.
1642
1677
  * @readonly
1643
1678
  */
1644
1679
  labels?: Label[];
@@ -1658,12 +1693,12 @@ export type ValueTypeWithLiterals = ValueType | 'TEXT' | 'NUMBER' | 'TEXT_ARRAY'
1658
1693
  */
1659
1694
  export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
1660
1695
  /**
1661
- * 0-based index from predefined `input.options` which is selected initially.
1696
+ * 0-based index from predefined `controls.inputs.options` which is initial selection.
1662
1697
  * @max 199
1663
1698
  */
1664
1699
  optionIndex?: number;
1665
1700
  /**
1666
- * Placeholder hint describing expected choices (such as "Please select").
1701
+ * Placeholder hint describing expected choices, such as "Please select".
1667
1702
  * Considered an empty choice.
1668
1703
  * @maxLength 200
1669
1704
  */
@@ -1672,12 +1707,12 @@ export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
1672
1707
  /** @oneof */
1673
1708
  export interface OptionSelectionSelectedOptionOneOf {
1674
1709
  /**
1675
- * 0-based index from predefined `input.options` which is selected initially.
1710
+ * 0-based index from predefined `controls.inputs.options` which is initial selection.
1676
1711
  * @max 199
1677
1712
  */
1678
1713
  optionIndex?: number;
1679
1714
  /**
1680
- * Placeholder hint describing expected choices (such as "Please select").
1715
+ * Placeholder hint describing expected choices, such as "Please select".
1681
1716
  * Considered an empty choice.
1682
1717
  * @maxLength 200
1683
1718
  */
@@ -1694,7 +1729,7 @@ export interface Label {
1694
1729
  * It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
1695
1730
  */
1696
1731
  export interface FormMessages {
1697
- /** RSVP form messages. */
1732
+ /** 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. */
1698
1733
  rsvp?: RsvpFormMessages;
1699
1734
  /** Checkout form messages. */
1700
1735
  checkout?: CheckoutFormMessages;
@@ -1704,15 +1739,15 @@ export interface FormMessages {
1704
1739
  ticketsUnavailable?: TicketsUnavailableMessages;
1705
1740
  }
1706
1741
  export interface RsvpFormMessages {
1707
- /** Label text indicating RSVP `YES` response. */
1742
+ /** Label text indicating RSVP's `status` is `"YES"`. */
1708
1743
  rsvpYesOption?: string;
1709
- /** Label text indicating RSVP `NO` response. */
1744
+ /** Label text indicating RSVP's `status` is `"NO"`. */
1710
1745
  rsvpNoOption?: string;
1711
- /** Messages shown for RSVP = `YES`. */
1746
+ /** Messages displayed when an RSVP's `status` is set to `"YES"`. */
1712
1747
  positiveMessages?: Positive;
1713
- /** Messages shown for RSVP = `WAITING` (when event is full and waitlist is available). */
1748
+ /** Messages displayed when an RSVP's `status` is set to `"WAITLIST"`, for when the event is full and a waitlist is available). */
1714
1749
  waitlistMessages?: Positive;
1715
- /** Messages shown for RSVP = `NO`. */
1750
+ /** Messages displayed when an RSVP's `status` is set to `"NO"`. */
1716
1751
  negativeMessages?: Negative;
1717
1752
  /** "Submit form" call-to-action label text. */
1718
1753
  submitActionLabel?: string;
@@ -2210,17 +2245,32 @@ export interface ButtonData {
2210
2245
  link?: Link;
2211
2246
  }
2212
2247
  export interface Border {
2213
- /** Border width in pixels. */
2248
+ /**
2249
+ * Deprecated: Use `borderWidth` in `styles` instead.
2250
+ * @deprecated
2251
+ */
2214
2252
  width?: number | null;
2215
- /** Border radius in pixels. */
2253
+ /**
2254
+ * Deprecated: Use `borderRadius` in `styles` instead.
2255
+ * @deprecated
2256
+ */
2216
2257
  radius?: number | null;
2217
2258
  }
2218
2259
  export interface Colors {
2219
- /** The text color as a hexadecimal value. */
2260
+ /**
2261
+ * Deprecated: Use `textColor` in `styles` instead.
2262
+ * @deprecated
2263
+ */
2220
2264
  text?: string | null;
2221
- /** The border color as a hexadecimal value. */
2265
+ /**
2266
+ * Deprecated: Use `borderColor` in `styles` instead.
2267
+ * @deprecated
2268
+ */
2222
2269
  border?: string | null;
2223
- /** The background color as a hexadecimal value. */
2270
+ /**
2271
+ * Deprecated: Use `backgroundColor` in `styles` instead.
2272
+ * @deprecated
2273
+ */
2224
2274
  background?: string | null;
2225
2275
  }
2226
2276
  export interface PluginContainerData {
@@ -2303,10 +2353,57 @@ export declare enum ButtonDataType {
2303
2353
  /** @enumType */
2304
2354
  export type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
2305
2355
  export interface Styles {
2306
- /** Border attributes. */
2356
+ /**
2357
+ * Deprecated: Use `borderWidth` and `borderRadius` instead.
2358
+ * @deprecated
2359
+ */
2307
2360
  border?: Border;
2308
- /** Color attributes. */
2361
+ /**
2362
+ * Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
2363
+ * @deprecated
2364
+ */
2309
2365
  colors?: Colors;
2366
+ /** Border width in pixels. */
2367
+ borderWidth?: number | null;
2368
+ /**
2369
+ * Deprecated: Use `borderWidth` for normal/hover states instead.
2370
+ * @deprecated
2371
+ */
2372
+ borderWidthHover?: number | null;
2373
+ /** Border radius in pixels. */
2374
+ borderRadius?: number | null;
2375
+ /**
2376
+ * Border color as a hexadecimal value.
2377
+ * @format COLOR_HEX
2378
+ */
2379
+ borderColor?: string | null;
2380
+ /**
2381
+ * Border color as a hexadecimal value (hover state).
2382
+ * @format COLOR_HEX
2383
+ */
2384
+ borderColorHover?: string | null;
2385
+ /**
2386
+ * Text color as a hexadecimal value.
2387
+ * @format COLOR_HEX
2388
+ */
2389
+ textColor?: string | null;
2390
+ /**
2391
+ * Text color as a hexadecimal value (hover state).
2392
+ * @format COLOR_HEX
2393
+ */
2394
+ textColorHover?: string | null;
2395
+ /**
2396
+ * Background color as a hexadecimal value.
2397
+ * @format COLOR_HEX
2398
+ */
2399
+ backgroundColor?: string | null;
2400
+ /**
2401
+ * Background color as a hexadecimal value (hover state).
2402
+ * @format COLOR_HEX
2403
+ */
2404
+ backgroundColorHover?: string | null;
2405
+ /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
2406
+ buttonSize?: string | null;
2310
2407
  }
2311
2408
  export interface Link extends LinkDataOneOf {
2312
2409
  /** The absolute URL for the linked document. */
@@ -3053,6 +3150,8 @@ export interface Decoration extends DecorationDataOneOf {
3053
3150
  underlineData?: boolean | null;
3054
3151
  /** Data for a spoiler decoration. */
3055
3152
  spoilerData?: SpoilerData;
3153
+ /** Data for a strikethrough decoration. Defaults to `true`. */
3154
+ strikethroughData?: boolean | null;
3056
3155
  /** The type of decoration to apply. */
3057
3156
  type?: DecorationTypeWithLiterals;
3058
3157
  }
@@ -3076,6 +3175,8 @@ export interface DecorationDataOneOf {
3076
3175
  underlineData?: boolean | null;
3077
3176
  /** Data for a spoiler decoration. */
3078
3177
  spoilerData?: SpoilerData;
3178
+ /** Data for a strikethrough decoration. Defaults to `true`. */
3179
+ strikethroughData?: boolean | null;
3079
3180
  }
3080
3181
  export declare enum DecorationType {
3081
3182
  BOLD = "BOLD",
@@ -3087,10 +3188,11 @@ export declare enum DecorationType {
3087
3188
  LINK = "LINK",
3088
3189
  COLOR = "COLOR",
3089
3190
  FONT_SIZE = "FONT_SIZE",
3090
- EXTERNAL = "EXTERNAL"
3191
+ EXTERNAL = "EXTERNAL",
3192
+ STRIKETHROUGH = "STRIKETHROUGH"
3091
3193
  }
3092
3194
  /** @enumType */
3093
- export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL';
3195
+ export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
3094
3196
  export interface AnchorData {
3095
3197
  /** The target node's ID. */
3096
3198
  anchor?: string;
@@ -3455,15 +3557,15 @@ export interface Badge {
3455
3557
  export declare enum Type {
3456
3558
  /** Unknown badge type. */
3457
3559
  UNKNOWN_BADGE_TYPE = "UNKNOWN_BADGE_TYPE",
3458
- /** Urgent badge type. */
3459
- URGENT = "URGENT",
3460
- /** Informational badge type. */
3461
- INFO = "INFO",
3462
- /** General badge type. */
3463
- GENERAL = "GENERAL"
3560
+ /** 1st priority badge type. */
3561
+ FIRST_PRIORITY = "FIRST_PRIORITY",
3562
+ /** 2nd priority badge type. */
3563
+ SECOND_PRIORITY = "SECOND_PRIORITY",
3564
+ /** 3rd priority badge type. */
3565
+ THIRD_PRIORITY = "THIRD_PRIORITY"
3464
3566
  }
3465
3567
  /** @enumType */
3466
- export type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | 'URGENT' | 'INFO' | 'GENERAL';
3568
+ export type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | 'FIRST_PRIORITY' | 'SECOND_PRIORITY' | 'THIRD_PRIORITY';
3467
3569
  export interface EventUpdated {
3468
3570
  /** Event update timestamp in ISO UTC format. */
3469
3571
  timestamp?: Date | null;
@@ -3542,25 +3644,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
3542
3644
  updatedEvent?: EntityUpdatedEvent;
3543
3645
  deletedEvent?: EntityDeletedEvent;
3544
3646
  actionEvent?: ActionEvent;
3545
- /**
3546
- * Unique event ID.
3547
- * Allows clients to ignore duplicate webhooks.
3548
- */
3647
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
3549
3648
  _id?: string;
3550
3649
  /**
3551
- * Assumes actions are also always typed to an entity_type
3552
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
3650
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
3651
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
3553
3652
  */
3554
3653
  entityFqdn?: string;
3555
3654
  /**
3556
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
3557
- * This is although the created/updated/deleted notion is duplication of the oneof types
3558
- * Example: created/updated/deleted/started/completed/email_opened
3655
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
3656
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
3559
3657
  */
3560
3658
  slug?: string;
3561
3659
  /** ID of the entity associated with the event. */
3562
3660
  entityId?: string;
3563
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
3661
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
3564
3662
  eventTime?: Date | null;
3565
3663
  /**
3566
3664
  * Whether the event was triggered as a result of a privacy regulation application
@@ -3570,12 +3668,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
3570
3668
  /** If present, indicates the action that triggered the event. */
3571
3669
  originatedFrom?: string | null;
3572
3670
  /**
3573
- * A sequence number defining the order of updates to the underlying entity.
3574
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
3575
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
3576
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
3577
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
3578
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
3671
+ * 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.
3672
+ * 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.
3579
3673
  */
3580
3674
  entityEventSequence?: string | null;
3581
3675
  }
@@ -3601,7 +3695,7 @@ export interface EntityUpdatedEvent {
3601
3695
  currentEntity?: string;
3602
3696
  }
3603
3697
  export interface EntityDeletedEvent {
3604
- /** Entity that was deleted */
3698
+ /** Entity that was deleted. */
3605
3699
  deletedEntity?: string | null;
3606
3700
  }
3607
3701
  export interface ActionEvent {
@@ -3638,6 +3732,24 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
3638
3732
  studioAssigned?: StudioAssigned;
3639
3733
  /** Emitted when Studio is detached. */
3640
3734
  studioUnassigned?: StudioUnassigned;
3735
+ /**
3736
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
3737
+ * the actual URL.
3738
+ *
3739
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
3740
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
3741
+ */
3742
+ urlChanged?: SiteUrlChanged;
3743
+ /** Site is marked as PurgedExternally */
3744
+ sitePurgedExternally?: SitePurgedExternally;
3745
+ /** Emitted when Odeditor is attached. */
3746
+ odeditorAssigned?: OdeditorAssigned;
3747
+ /** Emitted when Odeditor is detached. */
3748
+ odeditorUnassigned?: OdeditorUnassigned;
3749
+ /** Emitted when Picasso is attached. */
3750
+ picassoAssigned?: PicassoAssigned;
3751
+ /** Emitted when Picasso is detached. */
3752
+ picassoUnassigned?: PicassoUnassigned;
3641
3753
  /**
3642
3754
  * A meta site id.
3643
3755
  * @format GUID
@@ -3686,6 +3798,24 @@ export interface MetaSiteSpecialEventPayloadOneOf {
3686
3798
  studioAssigned?: StudioAssigned;
3687
3799
  /** Emitted when Studio is detached. */
3688
3800
  studioUnassigned?: StudioUnassigned;
3801
+ /**
3802
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
3803
+ * the actual URL.
3804
+ *
3805
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
3806
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
3807
+ */
3808
+ urlChanged?: SiteUrlChanged;
3809
+ /** Site is marked as PurgedExternally */
3810
+ sitePurgedExternally?: SitePurgedExternally;
3811
+ /** Emitted when Odeditor is attached. */
3812
+ odeditorAssigned?: OdeditorAssigned;
3813
+ /** Emitted when Odeditor is detached. */
3814
+ odeditorUnassigned?: OdeditorUnassigned;
3815
+ /** Emitted when Picasso is attached. */
3816
+ picassoAssigned?: PicassoAssigned;
3817
+ /** Emitted when Picasso is detached. */
3818
+ picassoUnassigned?: PicassoUnassigned;
3689
3819
  }
3690
3820
  export interface Asset {
3691
3821
  /**
@@ -3831,10 +3961,14 @@ export declare enum Namespace {
3831
3961
  */
3832
3962
  SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
3833
3963
  /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
3834
- STANDALONE_FORMS = "STANDALONE_FORMS"
3964
+ STANDALONE_FORMS = "STANDALONE_FORMS",
3965
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
3966
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
3967
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
3968
+ MIMIR = "MIMIR"
3835
3969
  }
3836
3970
  /** @enumType */
3837
- export type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS';
3971
+ export type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
3838
3972
  /** Site transferred to another user. */
3839
3973
  export interface SiteTransferred {
3840
3974
  /**
@@ -3989,6 +4123,41 @@ export interface StudioAssigned {
3989
4123
  /** Unassigned Studio editor */
3990
4124
  export interface StudioUnassigned {
3991
4125
  }
4126
+ /**
4127
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
4128
+ *
4129
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
4130
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
4131
+ *
4132
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
4133
+ */
4134
+ export interface SiteUrlChanged {
4135
+ }
4136
+ /**
4137
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
4138
+ * Consumed by other teams to remove relevant data.
4139
+ */
4140
+ export interface SitePurgedExternally {
4141
+ /**
4142
+ * @maxLength 2048
4143
+ * @maxSize 100
4144
+ * @deprecated
4145
+ * @targetRemovalDate 2025-04-15
4146
+ */
4147
+ appDefId?: string[];
4148
+ }
4149
+ /** Assigned Odeditor */
4150
+ export interface OdeditorAssigned {
4151
+ }
4152
+ /** Unassigned Odeditor */
4153
+ export interface OdeditorUnassigned {
4154
+ }
4155
+ /** Assigned Picasso editor */
4156
+ export interface PicassoAssigned {
4157
+ }
4158
+ /** Unassigned Picasso */
4159
+ export interface PicassoUnassigned {
4160
+ }
3992
4161
  export interface GetTicketDefinitionFromTrashBinRequest {
3993
4162
  /**
3994
4163
  * Ticket definition ID.
@@ -4189,11 +4358,12 @@ export interface EventTicketingSummary {
4189
4358
  */
4190
4359
  highestTicketPriceFormatted?: string | null;
4191
4360
  }
4361
+ /** Triggered when a reservation is created. */
4192
4362
  export interface ReservationCreated {
4193
- /** Reservation created timestamp in ISO UTC format. */
4363
+ /** Date and time the reservation was created. */
4194
4364
  timestamp?: Date | null;
4195
4365
  /**
4196
- * Event ID.
4366
+ * Event ID to which the reservation belongs.
4197
4367
  * @format GUID
4198
4368
  */
4199
4369
  eventId?: string;
@@ -4203,33 +4373,33 @@ export interface ReservationCreated {
4203
4373
  * @format GUID
4204
4374
  */
4205
4375
  reservationId?: string;
4206
- /** Reservation expiration timestamp. */
4376
+ /** Date and time the reservation expires. */
4207
4377
  expires?: Date | null;
4208
4378
  /** Reservation status. */
4209
4379
  status?: ReservationStatusWithLiterals;
4210
4380
  /**
4211
- * Reservation ticket quantities.
4381
+ * Amount of tickets in the reservation.
4212
4382
  * @maxSize 50
4213
4383
  */
4214
4384
  quantities?: TicketQuantity[];
4215
- /** Reservation update timestamp. */
4385
+ /** Date and time the reservation was updated. */
4216
4386
  _updatedDate?: Date | null;
4217
4387
  /**
4218
- * Reservation counts.
4388
+ * Number of reservations.
4219
4389
  * @maxSize 50
4220
4390
  */
4221
4391
  counts?: ReservationCount[];
4222
4392
  }
4223
4393
  export declare enum ReservationStatus {
4224
- /** The Reservation is pending confirmation and will expire after the expiration due time. */
4394
+ /** The Reservation is pending confirmation. It will expire after a certain amount of time. */
4225
4395
  RESERVATION_PENDING = "RESERVATION_PENDING",
4226
4396
  /** The reservation is confirmed and will not expire. */
4227
4397
  RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
4228
- /** The reservation is canceled because of non payment. */
4398
+ /** The reservation is canceled because it's not paid. */
4229
4399
  RESERVATION_CANCELED = "RESERVATION_CANCELED",
4230
4400
  /** The reservation is canceled manually by the buyer. */
4231
4401
  RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
4232
- /** The reservation is expired. */
4402
+ /** The reservation has expired. */
4233
4403
  RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
4234
4404
  }
4235
4405
  /** @enumType */
@@ -4260,11 +4430,12 @@ export interface ReservationCount {
4260
4430
  /** True if paid ticket reservation exist. */
4261
4431
  paidExists?: boolean;
4262
4432
  }
4433
+ /** Triggered when a reservation is updated. */
4263
4434
  export interface ReservationUpdated {
4264
- /** Reservation updated timestamp. */
4435
+ /** Date and time the reservation was updated. */
4265
4436
  timestamp?: Date | null;
4266
4437
  /**
4267
- * Event ID.
4438
+ * Event ID to which the reservation belongs.
4268
4439
  * @format GUID
4269
4440
  */
4270
4441
  eventId?: string;
@@ -4276,17 +4447,17 @@ export interface ReservationUpdated {
4276
4447
  reservationId?: string;
4277
4448
  /** Reservation status. */
4278
4449
  status?: ReservationStatusWithLiterals;
4279
- /** Reservation expiration timestamp. */
4450
+ /** Date and time the reservation expires. */
4280
4451
  expires?: Date | null;
4281
4452
  /**
4282
- * Reservation ticket quantities.
4453
+ * Amount of tickets in the reservation.
4283
4454
  * @maxSize 50
4284
4455
  */
4285
4456
  quantities?: TicketQuantity[];
4286
- /** Reservation update timestamp. */
4457
+ /** Date and time the reservation was updated. */
4287
4458
  _updatedDate?: Date | null;
4288
4459
  /**
4289
- * Reservation counts.
4460
+ * Number of reservations.
4290
4461
  * @maxSize 50
4291
4462
  */
4292
4463
  counts?: ReservationCount[];
@@ -4306,25 +4477,21 @@ export interface BaseEventMetadata {
4306
4477
  identity?: IdentificationData;
4307
4478
  }
4308
4479
  export interface EventMetadata extends BaseEventMetadata {
4309
- /**
4310
- * Unique event ID.
4311
- * Allows clients to ignore duplicate webhooks.
4312
- */
4480
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
4313
4481
  _id?: string;
4314
4482
  /**
4315
- * Assumes actions are also always typed to an entity_type
4316
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
4483
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
4484
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
4317
4485
  */
4318
4486
  entityFqdn?: string;
4319
4487
  /**
4320
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
4321
- * This is although the created/updated/deleted notion is duplication of the oneof types
4322
- * Example: created/updated/deleted/started/completed/email_opened
4488
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
4489
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
4323
4490
  */
4324
4491
  slug?: string;
4325
4492
  /** ID of the entity associated with the event. */
4326
4493
  entityId?: string;
4327
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
4494
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
4328
4495
  eventTime?: Date | null;
4329
4496
  /**
4330
4497
  * Whether the event was triggered as a result of a privacy regulation application
@@ -4334,12 +4501,8 @@ export interface EventMetadata extends BaseEventMetadata {
4334
4501
  /** If present, indicates the action that triggered the event. */
4335
4502
  originatedFrom?: string | null;
4336
4503
  /**
4337
- * A sequence number defining the order of updates to the underlying entity.
4338
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
4339
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
4340
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
4341
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
4342
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
4504
+ * 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.
4505
+ * 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.
4343
4506
  */
4344
4507
  entityEventSequence?: string | null;
4345
4508
  }