@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.
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +1 -1
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +1 -1
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -1
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +258 -87
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +22 -17
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +266 -103
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +22 -17
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +1 -1
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +1 -1
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -1
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +258 -87
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +22 -17
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +266 -103
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +22 -17
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +1 -1
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +1 -1
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -1
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +258 -87
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +22 -17
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +266 -103
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +22 -17
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +1 -1
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +1 -1
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -1
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +258 -87
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +22 -17
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -1
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts +266 -103
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +22 -17
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -1
- package/package.json +2 -2
package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts
CHANGED
|
@@ -390,15 +390,27 @@ export interface DateAndTimeSettings {
|
|
|
390
390
|
dateAndTimeTbd?: boolean | null;
|
|
391
391
|
/**
|
|
392
392
|
* Message that is displayed when time and date is TBD.
|
|
393
|
+
*
|
|
394
|
+
* **Note:** This field is only used when the `dateAndTimeTbd` field value is `true`.
|
|
393
395
|
* @maxLength 100
|
|
394
396
|
*/
|
|
395
397
|
dateAndTimeTbdMessage?: string | null;
|
|
396
|
-
/**
|
|
398
|
+
/**
|
|
399
|
+
* Event start date.
|
|
400
|
+
*
|
|
401
|
+
* **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`.
|
|
402
|
+
*/
|
|
397
403
|
startDate?: Date | null;
|
|
398
|
-
/**
|
|
404
|
+
/**
|
|
405
|
+
* Event end date.
|
|
406
|
+
*
|
|
407
|
+
* **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`.
|
|
408
|
+
*/
|
|
399
409
|
endDate?: Date | null;
|
|
400
410
|
/**
|
|
401
411
|
* Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
|
|
412
|
+
*
|
|
413
|
+
* **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`.
|
|
402
414
|
* @maxLength 100
|
|
403
415
|
*/
|
|
404
416
|
timeZoneId?: string | null;
|
|
@@ -539,6 +551,8 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
539
551
|
uri?: URI;
|
|
540
552
|
/** Invalidate by file (for media files such as PDFs) */
|
|
541
553
|
file?: File;
|
|
554
|
+
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
555
|
+
customTag?: CustomTag;
|
|
542
556
|
/**
|
|
543
557
|
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
544
558
|
* @maxLength 256
|
|
@@ -568,6 +582,8 @@ export interface InvalidateCacheGetByOneOf {
|
|
|
568
582
|
uri?: URI;
|
|
569
583
|
/** Invalidate by file (for media files such as PDFs) */
|
|
570
584
|
file?: File;
|
|
585
|
+
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
586
|
+
customTag?: CustomTag;
|
|
571
587
|
}
|
|
572
588
|
export interface App {
|
|
573
589
|
/**
|
|
@@ -618,6 +634,19 @@ export interface File {
|
|
|
618
634
|
*/
|
|
619
635
|
fileName?: string;
|
|
620
636
|
}
|
|
637
|
+
export interface CustomTag {
|
|
638
|
+
/**
|
|
639
|
+
* the msid the tag is related to
|
|
640
|
+
* @format GUID
|
|
641
|
+
*/
|
|
642
|
+
metaSiteId?: string;
|
|
643
|
+
/**
|
|
644
|
+
* Tag to invalidate by
|
|
645
|
+
* @minLength 1
|
|
646
|
+
* @maxLength 256
|
|
647
|
+
*/
|
|
648
|
+
tag?: string;
|
|
649
|
+
}
|
|
621
650
|
export interface SalePeriodUpdated {
|
|
622
651
|
/** Ticket definition sale period after update. */
|
|
623
652
|
afterUpdate?: SalePeriod;
|
|
@@ -1263,7 +1292,7 @@ export interface Event {
|
|
|
1263
1292
|
title?: string;
|
|
1264
1293
|
/** Event description. */
|
|
1265
1294
|
description?: string;
|
|
1266
|
-
/** Rich-text content displayed in
|
|
1295
|
+
/** Rich-text content that are displayed in a site's "About Event" section (HTML). */
|
|
1267
1296
|
about?: string;
|
|
1268
1297
|
/** Main event image. */
|
|
1269
1298
|
mainImage?: Image;
|
|
@@ -1310,7 +1339,7 @@ export interface Event {
|
|
|
1310
1339
|
categories?: Category[];
|
|
1311
1340
|
/** Visual settings for event. */
|
|
1312
1341
|
eventDisplaySettings?: EventDisplaySettings;
|
|
1313
|
-
/** Rich content displayed in
|
|
1342
|
+
/** Rich content that are displayed in a site's "About Event" section. Successor to `about` field. */
|
|
1314
1343
|
longDescription?: RichContent;
|
|
1315
1344
|
/**
|
|
1316
1345
|
* Event publish timestamp.
|
|
@@ -1518,7 +1547,7 @@ export interface Money {
|
|
|
1518
1547
|
*/
|
|
1519
1548
|
amount?: string;
|
|
1520
1549
|
/**
|
|
1521
|
-
*
|
|
1550
|
+
* Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
1522
1551
|
* @format CURRENCY
|
|
1523
1552
|
*/
|
|
1524
1553
|
currency?: string;
|
|
@@ -1559,7 +1588,7 @@ export interface SiteUrl {
|
|
|
1559
1588
|
path?: string;
|
|
1560
1589
|
}
|
|
1561
1590
|
/**
|
|
1562
|
-
* The form defines which elements are
|
|
1591
|
+
* The form defines which elements are displayed to a site visitor during the registration process (RSVP or checkout).
|
|
1563
1592
|
* It also contains customizable messages and labels.
|
|
1564
1593
|
*
|
|
1565
1594
|
*
|
|
@@ -1574,7 +1603,10 @@ export interface SiteUrl {
|
|
|
1574
1603
|
export interface Form {
|
|
1575
1604
|
/** Nested fields as an ordered list. */
|
|
1576
1605
|
controls?: InputControl[];
|
|
1577
|
-
/**
|
|
1606
|
+
/**
|
|
1607
|
+
* Set of defined form messages displayed in the UI before, during, and after a registration flow.
|
|
1608
|
+
* Includes the configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
1609
|
+
*/
|
|
1578
1610
|
messages?: FormMessages;
|
|
1579
1611
|
}
|
|
1580
1612
|
/**
|
|
@@ -1584,17 +1616,17 @@ export interface Form {
|
|
|
1584
1616
|
export interface InputControl {
|
|
1585
1617
|
/** Field control type. */
|
|
1586
1618
|
type?: InputControlTypeWithLiterals;
|
|
1587
|
-
/** Whether control is mandatory (such as name & email). When true
|
|
1619
|
+
/** Whether the control is mandatory (such as `name` & `email`). When `true`, only the label can be changed. */
|
|
1588
1620
|
system?: boolean;
|
|
1589
1621
|
/**
|
|
1590
|
-
* Deprecated: Use `id`.
|
|
1622
|
+
* Deprecated: Use `id` or `_id`.
|
|
1591
1623
|
* @deprecated
|
|
1592
1624
|
*/
|
|
1593
1625
|
name?: string;
|
|
1594
1626
|
/** Child inputs. */
|
|
1595
1627
|
inputs?: Input[];
|
|
1596
1628
|
/**
|
|
1597
|
-
* Deprecated
|
|
1629
|
+
* *Deprecated:** Use `controls.inputs.label`.
|
|
1598
1630
|
* @deprecated
|
|
1599
1631
|
*/
|
|
1600
1632
|
label?: string;
|
|
@@ -1603,7 +1635,7 @@ export interface InputControl {
|
|
|
1603
1635
|
/** Unique control ID. */
|
|
1604
1636
|
id?: string;
|
|
1605
1637
|
/**
|
|
1606
|
-
* Whether input control is deleted.
|
|
1638
|
+
* Whether the input control is deleted.
|
|
1607
1639
|
* @readonly
|
|
1608
1640
|
*/
|
|
1609
1641
|
deleted?: boolean | null;
|
|
@@ -1611,37 +1643,37 @@ export interface InputControl {
|
|
|
1611
1643
|
export declare enum InputControlType {
|
|
1612
1644
|
/** Single text value field. */
|
|
1613
1645
|
INPUT = "INPUT",
|
|
1614
|
-
/** Single text value field. */
|
|
1646
|
+
/** Single text value field with multiple lines. */
|
|
1615
1647
|
TEXTAREA = "TEXTAREA",
|
|
1616
|
-
/** Single-choice field
|
|
1648
|
+
/** Single-choice field with predefined values. */
|
|
1617
1649
|
DROPDOWN = "DROPDOWN",
|
|
1618
|
-
/** Single-choice field
|
|
1650
|
+
/** Single-choice field with predefined values. */
|
|
1619
1651
|
RADIO = "RADIO",
|
|
1620
|
-
/** Multiple-choice field
|
|
1652
|
+
/** Multiple-choice field with predefined values. */
|
|
1621
1653
|
CHECKBOX = "CHECKBOX",
|
|
1622
|
-
/**
|
|
1654
|
+
/** Fields for entering first and last names. */
|
|
1623
1655
|
NAME = "NAME",
|
|
1624
|
-
/**
|
|
1656
|
+
/** Fields for additional guests and their respective names. */
|
|
1625
1657
|
GUEST_CONTROL = "GUEST_CONTROL",
|
|
1626
1658
|
/** Single-line address field. */
|
|
1627
1659
|
ADDRESS_SHORT = "ADDRESS_SHORT",
|
|
1628
|
-
/** Full address field. */
|
|
1660
|
+
/** Full address field with multiple lines. */
|
|
1629
1661
|
ADDRESS_FULL = "ADDRESS_FULL",
|
|
1630
|
-
/**
|
|
1662
|
+
/** Fields for entering year, month, and day. */
|
|
1631
1663
|
DATE = "DATE"
|
|
1632
1664
|
}
|
|
1633
1665
|
/** @enumType */
|
|
1634
1666
|
export type InputControlTypeWithLiterals = InputControlType | 'INPUT' | 'TEXTAREA' | 'DROPDOWN' | 'RADIO' | 'CHECKBOX' | 'NAME' | 'GUEST_CONTROL' | 'ADDRESS_SHORT' | 'ADDRESS_FULL' | 'DATE';
|
|
1635
|
-
/**
|
|
1667
|
+
/** Child inputs. */
|
|
1636
1668
|
export interface Input {
|
|
1637
1669
|
/** Field name. */
|
|
1638
1670
|
name?: string;
|
|
1639
1671
|
/**
|
|
1640
|
-
* Deprecated
|
|
1672
|
+
* *Deprecated:** Use `controls.inputs.type.TEXT_ARRAY`.
|
|
1641
1673
|
* @deprecated
|
|
1642
1674
|
*/
|
|
1643
1675
|
array?: boolean;
|
|
1644
|
-
/** Main field label */
|
|
1676
|
+
/** Main field label. */
|
|
1645
1677
|
label?: string;
|
|
1646
1678
|
/** Additional labels for multi-valued fields such as address. */
|
|
1647
1679
|
additionalLabels?: Record<string, string>;
|
|
@@ -1657,17 +1689,20 @@ export interface Input {
|
|
|
1657
1689
|
*/
|
|
1658
1690
|
type?: ValueTypeWithLiterals;
|
|
1659
1691
|
/**
|
|
1660
|
-
*
|
|
1661
|
-
*
|
|
1692
|
+
* The maximum number of accepted values for array input.
|
|
1693
|
+
*
|
|
1694
|
+
* **Note:** Only applicable for `TEXT_ARRAY` input fields.
|
|
1662
1695
|
*/
|
|
1663
1696
|
maxSize?: number | null;
|
|
1664
1697
|
/**
|
|
1665
|
-
*
|
|
1666
|
-
*
|
|
1698
|
+
* Default option initially selected when an input has multiple choices.
|
|
1699
|
+
*
|
|
1700
|
+
* Defaults to first (0th) option, if not configured.
|
|
1701
|
+
* Currently only applicable for `type.dropdown`.
|
|
1667
1702
|
*/
|
|
1668
1703
|
defaultOptionSelection?: OptionSelection;
|
|
1669
1704
|
/**
|
|
1670
|
-
* Additional labels for multi-valued fields such as address.
|
|
1705
|
+
* Additional labels for multi-valued fields, such as address.
|
|
1671
1706
|
* @readonly
|
|
1672
1707
|
*/
|
|
1673
1708
|
labels?: Label[];
|
|
@@ -1687,12 +1722,12 @@ export type ValueTypeWithLiterals = ValueType | 'TEXT' | 'NUMBER' | 'TEXT_ARRAY'
|
|
|
1687
1722
|
*/
|
|
1688
1723
|
export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
1689
1724
|
/**
|
|
1690
|
-
* 0-based index from predefined `
|
|
1725
|
+
* 0-based index from predefined `controls.inputs.options` which is initial selection.
|
|
1691
1726
|
* @max 199
|
|
1692
1727
|
*/
|
|
1693
1728
|
optionIndex?: number;
|
|
1694
1729
|
/**
|
|
1695
|
-
* Placeholder hint describing expected choices
|
|
1730
|
+
* Placeholder hint describing expected choices, such as "Please select".
|
|
1696
1731
|
* Considered an empty choice.
|
|
1697
1732
|
* @maxLength 200
|
|
1698
1733
|
*/
|
|
@@ -1701,12 +1736,12 @@ export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
|
1701
1736
|
/** @oneof */
|
|
1702
1737
|
export interface OptionSelectionSelectedOptionOneOf {
|
|
1703
1738
|
/**
|
|
1704
|
-
* 0-based index from predefined `
|
|
1739
|
+
* 0-based index from predefined `controls.inputs.options` which is initial selection.
|
|
1705
1740
|
* @max 199
|
|
1706
1741
|
*/
|
|
1707
1742
|
optionIndex?: number;
|
|
1708
1743
|
/**
|
|
1709
|
-
* Placeholder hint describing expected choices
|
|
1744
|
+
* Placeholder hint describing expected choices, such as "Please select".
|
|
1710
1745
|
* Considered an empty choice.
|
|
1711
1746
|
* @maxLength 200
|
|
1712
1747
|
*/
|
|
@@ -1723,7 +1758,7 @@ export interface Label {
|
|
|
1723
1758
|
* It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
1724
1759
|
*/
|
|
1725
1760
|
export interface FormMessages {
|
|
1726
|
-
/** RSVP form messages. */
|
|
1761
|
+
/** 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. */
|
|
1727
1762
|
rsvp?: RsvpFormMessages;
|
|
1728
1763
|
/** Checkout form messages. */
|
|
1729
1764
|
checkout?: CheckoutFormMessages;
|
|
@@ -1733,15 +1768,15 @@ export interface FormMessages {
|
|
|
1733
1768
|
ticketsUnavailable?: TicketsUnavailableMessages;
|
|
1734
1769
|
}
|
|
1735
1770
|
export interface RsvpFormMessages {
|
|
1736
|
-
/** Label text indicating RSVP `
|
|
1771
|
+
/** Label text indicating RSVP's `status` is `"YES"`. */
|
|
1737
1772
|
rsvpYesOption?: string;
|
|
1738
|
-
/** Label text indicating RSVP `
|
|
1773
|
+
/** Label text indicating RSVP's `status` is `"NO"`. */
|
|
1739
1774
|
rsvpNoOption?: string;
|
|
1740
|
-
/** Messages
|
|
1775
|
+
/** Messages displayed when an RSVP's `status` is set to `"YES"`. */
|
|
1741
1776
|
positiveMessages?: Positive;
|
|
1742
|
-
/** Messages
|
|
1777
|
+
/** Messages displayed when an RSVP's `status` is set to `"WAITLIST"`, for when the event is full and a waitlist is available). */
|
|
1743
1778
|
waitlistMessages?: Positive;
|
|
1744
|
-
/** Messages
|
|
1779
|
+
/** Messages displayed when an RSVP's `status` is set to `"NO"`. */
|
|
1745
1780
|
negativeMessages?: Negative;
|
|
1746
1781
|
/** "Submit form" call-to-action label text. */
|
|
1747
1782
|
submitActionLabel?: string;
|
|
@@ -2239,17 +2274,32 @@ export interface ButtonData {
|
|
|
2239
2274
|
link?: Link;
|
|
2240
2275
|
}
|
|
2241
2276
|
export interface Border {
|
|
2242
|
-
/**
|
|
2277
|
+
/**
|
|
2278
|
+
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
2279
|
+
* @deprecated
|
|
2280
|
+
*/
|
|
2243
2281
|
width?: number | null;
|
|
2244
|
-
/**
|
|
2282
|
+
/**
|
|
2283
|
+
* Deprecated: Use `borderRadius` in `styles` instead.
|
|
2284
|
+
* @deprecated
|
|
2285
|
+
*/
|
|
2245
2286
|
radius?: number | null;
|
|
2246
2287
|
}
|
|
2247
2288
|
export interface Colors {
|
|
2248
|
-
/**
|
|
2289
|
+
/**
|
|
2290
|
+
* Deprecated: Use `textColor` in `styles` instead.
|
|
2291
|
+
* @deprecated
|
|
2292
|
+
*/
|
|
2249
2293
|
text?: string | null;
|
|
2250
|
-
/**
|
|
2294
|
+
/**
|
|
2295
|
+
* Deprecated: Use `borderColor` in `styles` instead.
|
|
2296
|
+
* @deprecated
|
|
2297
|
+
*/
|
|
2251
2298
|
border?: string | null;
|
|
2252
|
-
/**
|
|
2299
|
+
/**
|
|
2300
|
+
* Deprecated: Use `backgroundColor` in `styles` instead.
|
|
2301
|
+
* @deprecated
|
|
2302
|
+
*/
|
|
2253
2303
|
background?: string | null;
|
|
2254
2304
|
}
|
|
2255
2305
|
export interface PluginContainerData {
|
|
@@ -2332,10 +2382,57 @@ export declare enum ButtonDataType {
|
|
|
2332
2382
|
/** @enumType */
|
|
2333
2383
|
export type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
2334
2384
|
export interface Styles {
|
|
2335
|
-
/**
|
|
2385
|
+
/**
|
|
2386
|
+
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
2387
|
+
* @deprecated
|
|
2388
|
+
*/
|
|
2336
2389
|
border?: Border;
|
|
2337
|
-
/**
|
|
2390
|
+
/**
|
|
2391
|
+
* Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
|
|
2392
|
+
* @deprecated
|
|
2393
|
+
*/
|
|
2338
2394
|
colors?: Colors;
|
|
2395
|
+
/** Border width in pixels. */
|
|
2396
|
+
borderWidth?: number | null;
|
|
2397
|
+
/**
|
|
2398
|
+
* Deprecated: Use `borderWidth` for normal/hover states instead.
|
|
2399
|
+
* @deprecated
|
|
2400
|
+
*/
|
|
2401
|
+
borderWidthHover?: number | null;
|
|
2402
|
+
/** Border radius in pixels. */
|
|
2403
|
+
borderRadius?: number | null;
|
|
2404
|
+
/**
|
|
2405
|
+
* Border color as a hexadecimal value.
|
|
2406
|
+
* @format COLOR_HEX
|
|
2407
|
+
*/
|
|
2408
|
+
borderColor?: string | null;
|
|
2409
|
+
/**
|
|
2410
|
+
* Border color as a hexadecimal value (hover state).
|
|
2411
|
+
* @format COLOR_HEX
|
|
2412
|
+
*/
|
|
2413
|
+
borderColorHover?: string | null;
|
|
2414
|
+
/**
|
|
2415
|
+
* Text color as a hexadecimal value.
|
|
2416
|
+
* @format COLOR_HEX
|
|
2417
|
+
*/
|
|
2418
|
+
textColor?: string | null;
|
|
2419
|
+
/**
|
|
2420
|
+
* Text color as a hexadecimal value (hover state).
|
|
2421
|
+
* @format COLOR_HEX
|
|
2422
|
+
*/
|
|
2423
|
+
textColorHover?: string | null;
|
|
2424
|
+
/**
|
|
2425
|
+
* Background color as a hexadecimal value.
|
|
2426
|
+
* @format COLOR_HEX
|
|
2427
|
+
*/
|
|
2428
|
+
backgroundColor?: string | null;
|
|
2429
|
+
/**
|
|
2430
|
+
* Background color as a hexadecimal value (hover state).
|
|
2431
|
+
* @format COLOR_HEX
|
|
2432
|
+
*/
|
|
2433
|
+
backgroundColorHover?: string | null;
|
|
2434
|
+
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
2435
|
+
buttonSize?: string | null;
|
|
2339
2436
|
}
|
|
2340
2437
|
export interface Link extends LinkDataOneOf {
|
|
2341
2438
|
/** The absolute URL for the linked document. */
|
|
@@ -3082,6 +3179,8 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
3082
3179
|
underlineData?: boolean | null;
|
|
3083
3180
|
/** Data for a spoiler decoration. */
|
|
3084
3181
|
spoilerData?: SpoilerData;
|
|
3182
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
3183
|
+
strikethroughData?: boolean | null;
|
|
3085
3184
|
/** The type of decoration to apply. */
|
|
3086
3185
|
type?: DecorationTypeWithLiterals;
|
|
3087
3186
|
}
|
|
@@ -3105,6 +3204,8 @@ export interface DecorationDataOneOf {
|
|
|
3105
3204
|
underlineData?: boolean | null;
|
|
3106
3205
|
/** Data for a spoiler decoration. */
|
|
3107
3206
|
spoilerData?: SpoilerData;
|
|
3207
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
3208
|
+
strikethroughData?: boolean | null;
|
|
3108
3209
|
}
|
|
3109
3210
|
export declare enum DecorationType {
|
|
3110
3211
|
BOLD = "BOLD",
|
|
@@ -3116,10 +3217,11 @@ export declare enum DecorationType {
|
|
|
3116
3217
|
LINK = "LINK",
|
|
3117
3218
|
COLOR = "COLOR",
|
|
3118
3219
|
FONT_SIZE = "FONT_SIZE",
|
|
3119
|
-
EXTERNAL = "EXTERNAL"
|
|
3220
|
+
EXTERNAL = "EXTERNAL",
|
|
3221
|
+
STRIKETHROUGH = "STRIKETHROUGH"
|
|
3120
3222
|
}
|
|
3121
3223
|
/** @enumType */
|
|
3122
|
-
export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL';
|
|
3224
|
+
export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
3123
3225
|
export interface AnchorData {
|
|
3124
3226
|
/** The target node's ID. */
|
|
3125
3227
|
anchor?: string;
|
|
@@ -3484,15 +3586,15 @@ export interface Badge {
|
|
|
3484
3586
|
export declare enum Type {
|
|
3485
3587
|
/** Unknown badge type. */
|
|
3486
3588
|
UNKNOWN_BADGE_TYPE = "UNKNOWN_BADGE_TYPE",
|
|
3487
|
-
/**
|
|
3488
|
-
|
|
3489
|
-
/**
|
|
3490
|
-
|
|
3491
|
-
/**
|
|
3492
|
-
|
|
3589
|
+
/** 1st priority badge type. */
|
|
3590
|
+
FIRST_PRIORITY = "FIRST_PRIORITY",
|
|
3591
|
+
/** 2nd priority badge type. */
|
|
3592
|
+
SECOND_PRIORITY = "SECOND_PRIORITY",
|
|
3593
|
+
/** 3rd priority badge type. */
|
|
3594
|
+
THIRD_PRIORITY = "THIRD_PRIORITY"
|
|
3493
3595
|
}
|
|
3494
3596
|
/** @enumType */
|
|
3495
|
-
export type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | '
|
|
3597
|
+
export type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | 'FIRST_PRIORITY' | 'SECOND_PRIORITY' | 'THIRD_PRIORITY';
|
|
3496
3598
|
export interface EventUpdated {
|
|
3497
3599
|
/** Event update timestamp in ISO UTC format. */
|
|
3498
3600
|
timestamp?: Date | null;
|
|
@@ -3571,25 +3673,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3571
3673
|
updatedEvent?: EntityUpdatedEvent;
|
|
3572
3674
|
deletedEvent?: EntityDeletedEvent;
|
|
3573
3675
|
actionEvent?: ActionEvent;
|
|
3574
|
-
/**
|
|
3575
|
-
* Unique event ID.
|
|
3576
|
-
* Allows clients to ignore duplicate webhooks.
|
|
3577
|
-
*/
|
|
3676
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3578
3677
|
id?: string;
|
|
3579
3678
|
/**
|
|
3580
|
-
*
|
|
3581
|
-
*
|
|
3679
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3680
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3582
3681
|
*/
|
|
3583
3682
|
entityFqdn?: string;
|
|
3584
3683
|
/**
|
|
3585
|
-
*
|
|
3586
|
-
*
|
|
3587
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
3684
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3685
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3588
3686
|
*/
|
|
3589
3687
|
slug?: string;
|
|
3590
3688
|
/** ID of the entity associated with the event. */
|
|
3591
3689
|
entityId?: string;
|
|
3592
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
3690
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3593
3691
|
eventTime?: Date | null;
|
|
3594
3692
|
/**
|
|
3595
3693
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -3599,12 +3697,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3599
3697
|
/** If present, indicates the action that triggered the event. */
|
|
3600
3698
|
originatedFrom?: string | null;
|
|
3601
3699
|
/**
|
|
3602
|
-
* A sequence number
|
|
3603
|
-
*
|
|
3604
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
3605
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
3606
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
3607
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
3700
|
+
* 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.
|
|
3701
|
+
* 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.
|
|
3608
3702
|
*/
|
|
3609
3703
|
entityEventSequence?: string | null;
|
|
3610
3704
|
}
|
|
@@ -3632,7 +3726,7 @@ export interface EntityUpdatedEvent {
|
|
|
3632
3726
|
currentEntityAsJson?: string;
|
|
3633
3727
|
}
|
|
3634
3728
|
export interface EntityDeletedEvent {
|
|
3635
|
-
/** Entity that was deleted */
|
|
3729
|
+
/** Entity that was deleted. */
|
|
3636
3730
|
deletedEntityAsJson?: string | null;
|
|
3637
3731
|
}
|
|
3638
3732
|
export interface ActionEvent {
|
|
@@ -3669,6 +3763,24 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
3669
3763
|
studioAssigned?: StudioAssigned;
|
|
3670
3764
|
/** Emitted when Studio is detached. */
|
|
3671
3765
|
studioUnassigned?: StudioUnassigned;
|
|
3766
|
+
/**
|
|
3767
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
3768
|
+
* the actual URL.
|
|
3769
|
+
*
|
|
3770
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
3771
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
3772
|
+
*/
|
|
3773
|
+
urlChanged?: SiteUrlChanged;
|
|
3774
|
+
/** Site is marked as PurgedExternally */
|
|
3775
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
3776
|
+
/** Emitted when Odeditor is attached. */
|
|
3777
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
3778
|
+
/** Emitted when Odeditor is detached. */
|
|
3779
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
3780
|
+
/** Emitted when Picasso is attached. */
|
|
3781
|
+
picassoAssigned?: PicassoAssigned;
|
|
3782
|
+
/** Emitted when Picasso is detached. */
|
|
3783
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
3672
3784
|
/**
|
|
3673
3785
|
* A meta site id.
|
|
3674
3786
|
* @format GUID
|
|
@@ -3717,6 +3829,24 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
3717
3829
|
studioAssigned?: StudioAssigned;
|
|
3718
3830
|
/** Emitted when Studio is detached. */
|
|
3719
3831
|
studioUnassigned?: StudioUnassigned;
|
|
3832
|
+
/**
|
|
3833
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
3834
|
+
* the actual URL.
|
|
3835
|
+
*
|
|
3836
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
3837
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
3838
|
+
*/
|
|
3839
|
+
urlChanged?: SiteUrlChanged;
|
|
3840
|
+
/** Site is marked as PurgedExternally */
|
|
3841
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
3842
|
+
/** Emitted when Odeditor is attached. */
|
|
3843
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
3844
|
+
/** Emitted when Odeditor is detached. */
|
|
3845
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
3846
|
+
/** Emitted when Picasso is attached. */
|
|
3847
|
+
picassoAssigned?: PicassoAssigned;
|
|
3848
|
+
/** Emitted when Picasso is detached. */
|
|
3849
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
3720
3850
|
}
|
|
3721
3851
|
export interface Asset {
|
|
3722
3852
|
/**
|
|
@@ -3862,10 +3992,14 @@ export declare enum Namespace {
|
|
|
3862
3992
|
*/
|
|
3863
3993
|
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
3864
3994
|
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
3865
|
-
STANDALONE_FORMS = "STANDALONE_FORMS"
|
|
3995
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
3996
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
3997
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
3998
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
3999
|
+
MIMIR = "MIMIR"
|
|
3866
4000
|
}
|
|
3867
4001
|
/** @enumType */
|
|
3868
|
-
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';
|
|
4002
|
+
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';
|
|
3869
4003
|
/** Site transferred to another user. */
|
|
3870
4004
|
export interface SiteTransferred {
|
|
3871
4005
|
/**
|
|
@@ -4020,6 +4154,41 @@ export interface StudioAssigned {
|
|
|
4020
4154
|
/** Unassigned Studio editor */
|
|
4021
4155
|
export interface StudioUnassigned {
|
|
4022
4156
|
}
|
|
4157
|
+
/**
|
|
4158
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
4159
|
+
*
|
|
4160
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
4161
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
4162
|
+
*
|
|
4163
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
4164
|
+
*/
|
|
4165
|
+
export interface SiteUrlChanged {
|
|
4166
|
+
}
|
|
4167
|
+
/**
|
|
4168
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
4169
|
+
* Consumed by other teams to remove relevant data.
|
|
4170
|
+
*/
|
|
4171
|
+
export interface SitePurgedExternally {
|
|
4172
|
+
/**
|
|
4173
|
+
* @maxLength 2048
|
|
4174
|
+
* @maxSize 100
|
|
4175
|
+
* @deprecated
|
|
4176
|
+
* @targetRemovalDate 2025-04-15
|
|
4177
|
+
*/
|
|
4178
|
+
appDefId?: string[];
|
|
4179
|
+
}
|
|
4180
|
+
/** Assigned Odeditor */
|
|
4181
|
+
export interface OdeditorAssigned {
|
|
4182
|
+
}
|
|
4183
|
+
/** Unassigned Odeditor */
|
|
4184
|
+
export interface OdeditorUnassigned {
|
|
4185
|
+
}
|
|
4186
|
+
/** Assigned Picasso editor */
|
|
4187
|
+
export interface PicassoAssigned {
|
|
4188
|
+
}
|
|
4189
|
+
/** Unassigned Picasso */
|
|
4190
|
+
export interface PicassoUnassigned {
|
|
4191
|
+
}
|
|
4023
4192
|
export interface GetTicketDefinitionFromTrashBinRequest {
|
|
4024
4193
|
/**
|
|
4025
4194
|
* Ticket definition ID.
|
|
@@ -4220,11 +4389,12 @@ export interface EventTicketingSummary {
|
|
|
4220
4389
|
*/
|
|
4221
4390
|
highestTicketPriceFormatted?: string | null;
|
|
4222
4391
|
}
|
|
4392
|
+
/** Triggered when a reservation is created. */
|
|
4223
4393
|
export interface ReservationCreated {
|
|
4224
|
-
/**
|
|
4394
|
+
/** Date and time the reservation was created. */
|
|
4225
4395
|
timestamp?: Date | null;
|
|
4226
4396
|
/**
|
|
4227
|
-
* Event ID.
|
|
4397
|
+
* Event ID to which the reservation belongs.
|
|
4228
4398
|
* @format GUID
|
|
4229
4399
|
*/
|
|
4230
4400
|
eventId?: string;
|
|
@@ -4234,33 +4404,33 @@ export interface ReservationCreated {
|
|
|
4234
4404
|
* @format GUID
|
|
4235
4405
|
*/
|
|
4236
4406
|
reservationId?: string;
|
|
4237
|
-
/**
|
|
4407
|
+
/** Date and time the reservation expires. */
|
|
4238
4408
|
expires?: Date | null;
|
|
4239
4409
|
/** Reservation status. */
|
|
4240
4410
|
status?: ReservationStatusWithLiterals;
|
|
4241
4411
|
/**
|
|
4242
|
-
*
|
|
4412
|
+
* Amount of tickets in the reservation.
|
|
4243
4413
|
* @maxSize 50
|
|
4244
4414
|
*/
|
|
4245
4415
|
quantities?: TicketQuantity[];
|
|
4246
|
-
/**
|
|
4416
|
+
/** Date and time the reservation was updated. */
|
|
4247
4417
|
updatedDate?: Date | null;
|
|
4248
4418
|
/**
|
|
4249
|
-
*
|
|
4419
|
+
* Number of reservations.
|
|
4250
4420
|
* @maxSize 50
|
|
4251
4421
|
*/
|
|
4252
4422
|
counts?: ReservationCount[];
|
|
4253
4423
|
}
|
|
4254
4424
|
export declare enum ReservationStatus {
|
|
4255
|
-
/** The Reservation is pending confirmation
|
|
4425
|
+
/** The Reservation is pending confirmation. It will expire after a certain amount of time. */
|
|
4256
4426
|
RESERVATION_PENDING = "RESERVATION_PENDING",
|
|
4257
4427
|
/** The reservation is confirmed and will not expire. */
|
|
4258
4428
|
RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
|
|
4259
|
-
/** The reservation is canceled because
|
|
4429
|
+
/** The reservation is canceled because it's not paid. */
|
|
4260
4430
|
RESERVATION_CANCELED = "RESERVATION_CANCELED",
|
|
4261
4431
|
/** The reservation is canceled manually by the buyer. */
|
|
4262
4432
|
RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
|
|
4263
|
-
/** The reservation
|
|
4433
|
+
/** The reservation has expired. */
|
|
4264
4434
|
RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
|
|
4265
4435
|
}
|
|
4266
4436
|
/** @enumType */
|
|
@@ -4291,11 +4461,12 @@ export interface ReservationCount {
|
|
|
4291
4461
|
/** True if paid ticket reservation exist. */
|
|
4292
4462
|
paidExists?: boolean;
|
|
4293
4463
|
}
|
|
4464
|
+
/** Triggered when a reservation is updated. */
|
|
4294
4465
|
export interface ReservationUpdated {
|
|
4295
|
-
/**
|
|
4466
|
+
/** Date and time the reservation was updated. */
|
|
4296
4467
|
timestamp?: Date | null;
|
|
4297
4468
|
/**
|
|
4298
|
-
* Event ID.
|
|
4469
|
+
* Event ID to which the reservation belongs.
|
|
4299
4470
|
* @format GUID
|
|
4300
4471
|
*/
|
|
4301
4472
|
eventId?: string;
|
|
@@ -4307,17 +4478,17 @@ export interface ReservationUpdated {
|
|
|
4307
4478
|
reservationId?: string;
|
|
4308
4479
|
/** Reservation status. */
|
|
4309
4480
|
status?: ReservationStatusWithLiterals;
|
|
4310
|
-
/**
|
|
4481
|
+
/** Date and time the reservation expires. */
|
|
4311
4482
|
expires?: Date | null;
|
|
4312
4483
|
/**
|
|
4313
|
-
*
|
|
4484
|
+
* Amount of tickets in the reservation.
|
|
4314
4485
|
* @maxSize 50
|
|
4315
4486
|
*/
|
|
4316
4487
|
quantities?: TicketQuantity[];
|
|
4317
|
-
/**
|
|
4488
|
+
/** Date and time the reservation was updated. */
|
|
4318
4489
|
updatedDate?: Date | null;
|
|
4319
4490
|
/**
|
|
4320
|
-
*
|
|
4491
|
+
* Number of reservations.
|
|
4321
4492
|
* @maxSize 50
|
|
4322
4493
|
*/
|
|
4323
4494
|
counts?: ReservationCount[];
|