@wix/auto_sdk_events_notifications 1.0.20 → 1.0.21
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-notifications-v2-notification-config-notifications.public.d.ts +1 -1
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.public.js.map +1 -1
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.types.d.ts +169 -101
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.types.js +22 -21
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.types.js.map +1 -1
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.universal.d.ts +181 -120
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.universal.js +25 -23
- package/build/cjs/src/events-notifications-v2-notification-config-notifications.universal.js.map +1 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.public.d.ts +1 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.public.js.map +1 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.types.d.ts +169 -101
- package/build/es/src/events-notifications-v2-notification-config-notifications.types.js +22 -21
- package/build/es/src/events-notifications-v2-notification-config-notifications.types.js.map +1 -1
- package/build/es/src/events-notifications-v2-notification-config-notifications.universal.d.ts +181 -120
- package/build/es/src/events-notifications-v2-notification-config-notifications.universal.js +25 -23
- package/build/es/src/events-notifications-v2-notification-config-notifications.universal.js.map +1 -1
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.public.d.ts +1 -1
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.public.js.map +1 -1
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.types.d.ts +169 -101
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.types.js +22 -21
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.types.js.map +1 -1
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.universal.d.ts +181 -120
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.universal.js +25 -23
- package/build/internal/cjs/src/events-notifications-v2-notification-config-notifications.universal.js.map +1 -1
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.public.d.ts +1 -1
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.public.js.map +1 -1
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.types.d.ts +169 -101
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.types.js +22 -21
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.types.js.map +1 -1
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.universal.d.ts +181 -120
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.universal.js +25 -23
- package/build/internal/es/src/events-notifications-v2-notification-config-notifications.universal.js.map +1 -1
- package/package.json +2 -2
package/build/internal/es/src/events-notifications-v2-notification-config-notifications.types.d.ts
CHANGED
|
@@ -229,25 +229,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
229
229
|
updatedEvent?: EntityUpdatedEvent;
|
|
230
230
|
deletedEvent?: EntityDeletedEvent;
|
|
231
231
|
actionEvent?: ActionEvent;
|
|
232
|
-
/**
|
|
233
|
-
* Unique event ID.
|
|
234
|
-
* Allows clients to ignore duplicate webhooks.
|
|
235
|
-
*/
|
|
232
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
236
233
|
id?: string;
|
|
237
234
|
/**
|
|
238
|
-
*
|
|
239
|
-
*
|
|
235
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
236
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
240
237
|
*/
|
|
241
238
|
entityFqdn?: string;
|
|
242
239
|
/**
|
|
243
|
-
*
|
|
244
|
-
*
|
|
245
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
240
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
241
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
246
242
|
*/
|
|
247
243
|
slug?: string;
|
|
248
244
|
/** ID of the entity associated with the event. */
|
|
249
245
|
entityId?: string;
|
|
250
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
246
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
251
247
|
eventTime?: Date | null;
|
|
252
248
|
/**
|
|
253
249
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -257,12 +253,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
257
253
|
/** If present, indicates the action that triggered the event. */
|
|
258
254
|
originatedFrom?: string | null;
|
|
259
255
|
/**
|
|
260
|
-
* A sequence number
|
|
261
|
-
*
|
|
262
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
263
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
264
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
265
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
256
|
+
* 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.
|
|
257
|
+
* 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.
|
|
266
258
|
*/
|
|
267
259
|
entityEventSequence?: string | null;
|
|
268
260
|
}
|
|
@@ -290,7 +282,7 @@ export interface EntityUpdatedEvent {
|
|
|
290
282
|
currentEntityAsJson?: string;
|
|
291
283
|
}
|
|
292
284
|
export interface EntityDeletedEvent {
|
|
293
|
-
/** Entity that was deleted */
|
|
285
|
+
/** Entity that was deleted. */
|
|
294
286
|
deletedEntityAsJson?: string | null;
|
|
295
287
|
}
|
|
296
288
|
export interface ActionEvent {
|
|
@@ -542,7 +534,7 @@ export interface Event {
|
|
|
542
534
|
title?: string;
|
|
543
535
|
/** Event description. */
|
|
544
536
|
description?: string;
|
|
545
|
-
/** Rich-text content displayed in
|
|
537
|
+
/** Rich-text content that are displayed in a site's "About Event" section (HTML). */
|
|
546
538
|
about?: string;
|
|
547
539
|
/** Main event image. */
|
|
548
540
|
mainImage?: Image;
|
|
@@ -589,7 +581,7 @@ export interface Event {
|
|
|
589
581
|
categories?: Category[];
|
|
590
582
|
/** Visual settings for event. */
|
|
591
583
|
eventDisplaySettings?: EventDisplaySettings;
|
|
592
|
-
/** Rich content displayed in
|
|
584
|
+
/** Rich content that are displayed in a site's "About Event" section. Successor to `about` field. */
|
|
593
585
|
longDescription?: RichContent;
|
|
594
586
|
/**
|
|
595
587
|
* Event publish timestamp.
|
|
@@ -809,7 +801,7 @@ export interface Money {
|
|
|
809
801
|
*/
|
|
810
802
|
amount?: string;
|
|
811
803
|
/**
|
|
812
|
-
*
|
|
804
|
+
* Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
813
805
|
* @format CURRENCY
|
|
814
806
|
*/
|
|
815
807
|
currency?: string;
|
|
@@ -850,7 +842,7 @@ export interface SiteUrl {
|
|
|
850
842
|
path?: string;
|
|
851
843
|
}
|
|
852
844
|
/**
|
|
853
|
-
* The form defines which elements are
|
|
845
|
+
* The form defines which elements are displayed to a site visitor during the registration process (RSVP or checkout).
|
|
854
846
|
* It also contains customizable messages and labels.
|
|
855
847
|
*
|
|
856
848
|
*
|
|
@@ -865,7 +857,10 @@ export interface SiteUrl {
|
|
|
865
857
|
export interface Form {
|
|
866
858
|
/** Nested fields as an ordered list. */
|
|
867
859
|
controls?: InputControl[];
|
|
868
|
-
/**
|
|
860
|
+
/**
|
|
861
|
+
* Set of defined form messages displayed in the UI before, during, and after a registration flow.
|
|
862
|
+
* Includes the configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
863
|
+
*/
|
|
869
864
|
messages?: FormMessages;
|
|
870
865
|
}
|
|
871
866
|
/**
|
|
@@ -875,17 +870,17 @@ export interface Form {
|
|
|
875
870
|
export interface InputControl {
|
|
876
871
|
/** Field control type. */
|
|
877
872
|
type?: InputControlTypeWithLiterals;
|
|
878
|
-
/** Whether control is mandatory (such as name & email). When true
|
|
873
|
+
/** Whether the control is mandatory (such as `name` & `email`). When `true`, only the label can be changed. */
|
|
879
874
|
system?: boolean;
|
|
880
875
|
/**
|
|
881
|
-
* Deprecated: Use `id`.
|
|
876
|
+
* Deprecated: Use `id` or `_id`.
|
|
882
877
|
* @deprecated
|
|
883
878
|
*/
|
|
884
879
|
name?: string;
|
|
885
880
|
/** Child inputs. */
|
|
886
881
|
inputs?: Input[];
|
|
887
882
|
/**
|
|
888
|
-
* Deprecated
|
|
883
|
+
* *Deprecated:** Use `controls.inputs.label`.
|
|
889
884
|
* @deprecated
|
|
890
885
|
*/
|
|
891
886
|
label?: string;
|
|
@@ -894,7 +889,7 @@ export interface InputControl {
|
|
|
894
889
|
/** Unique control ID. */
|
|
895
890
|
id?: string;
|
|
896
891
|
/**
|
|
897
|
-
* Whether input control is deleted.
|
|
892
|
+
* Whether the input control is deleted.
|
|
898
893
|
* @readonly
|
|
899
894
|
*/
|
|
900
895
|
deleted?: boolean | null;
|
|
@@ -902,37 +897,37 @@ export interface InputControl {
|
|
|
902
897
|
export declare enum InputControlType {
|
|
903
898
|
/** Single text value field. */
|
|
904
899
|
INPUT = "INPUT",
|
|
905
|
-
/** Single text value field. */
|
|
900
|
+
/** Single text value field with multiple lines. */
|
|
906
901
|
TEXTAREA = "TEXTAREA",
|
|
907
|
-
/** Single-choice field
|
|
902
|
+
/** Single-choice field with predefined values. */
|
|
908
903
|
DROPDOWN = "DROPDOWN",
|
|
909
|
-
/** Single-choice field
|
|
904
|
+
/** Single-choice field with predefined values. */
|
|
910
905
|
RADIO = "RADIO",
|
|
911
|
-
/** Multiple-choice field
|
|
906
|
+
/** Multiple-choice field with predefined values. */
|
|
912
907
|
CHECKBOX = "CHECKBOX",
|
|
913
|
-
/**
|
|
908
|
+
/** Fields for entering first and last names. */
|
|
914
909
|
NAME = "NAME",
|
|
915
|
-
/**
|
|
910
|
+
/** Fields for additional guests and their respective names. */
|
|
916
911
|
GUEST_CONTROL = "GUEST_CONTROL",
|
|
917
912
|
/** Single-line address field. */
|
|
918
913
|
ADDRESS_SHORT = "ADDRESS_SHORT",
|
|
919
|
-
/** Full address field. */
|
|
914
|
+
/** Full address field with multiple lines. */
|
|
920
915
|
ADDRESS_FULL = "ADDRESS_FULL",
|
|
921
|
-
/**
|
|
916
|
+
/** Fields for entering year, month, and day. */
|
|
922
917
|
DATE = "DATE"
|
|
923
918
|
}
|
|
924
919
|
/** @enumType */
|
|
925
920
|
export type InputControlTypeWithLiterals = InputControlType | 'INPUT' | 'TEXTAREA' | 'DROPDOWN' | 'RADIO' | 'CHECKBOX' | 'NAME' | 'GUEST_CONTROL' | 'ADDRESS_SHORT' | 'ADDRESS_FULL' | 'DATE';
|
|
926
|
-
/**
|
|
921
|
+
/** Child inputs. */
|
|
927
922
|
export interface Input {
|
|
928
923
|
/** Field name. */
|
|
929
924
|
name?: string;
|
|
930
925
|
/**
|
|
931
|
-
* Deprecated
|
|
926
|
+
* *Deprecated:** Use `controls.inputs.type.TEXT_ARRAY`.
|
|
932
927
|
* @deprecated
|
|
933
928
|
*/
|
|
934
929
|
array?: boolean;
|
|
935
|
-
/** Main field label */
|
|
930
|
+
/** Main field label. */
|
|
936
931
|
label?: string;
|
|
937
932
|
/** Additional labels for multi-valued fields such as address. */
|
|
938
933
|
additionalLabels?: Record<string, string>;
|
|
@@ -948,17 +943,20 @@ export interface Input {
|
|
|
948
943
|
*/
|
|
949
944
|
type?: ValueTypeWithLiterals;
|
|
950
945
|
/**
|
|
951
|
-
*
|
|
952
|
-
*
|
|
946
|
+
* The maximum number of accepted values for array input.
|
|
947
|
+
*
|
|
948
|
+
* **Note:** Only applicable for `TEXT_ARRAY` input fields.
|
|
953
949
|
*/
|
|
954
950
|
maxSize?: number | null;
|
|
955
951
|
/**
|
|
956
|
-
*
|
|
957
|
-
*
|
|
952
|
+
* Default option initially selected when an input has multiple choices.
|
|
953
|
+
*
|
|
954
|
+
* Defaults to first (0th) option, if not configured.
|
|
955
|
+
* Currently only applicable for `type.dropdown`.
|
|
958
956
|
*/
|
|
959
957
|
defaultOptionSelection?: OptionSelection;
|
|
960
958
|
/**
|
|
961
|
-
* Additional labels for multi-valued fields such as address.
|
|
959
|
+
* Additional labels for multi-valued fields, such as address.
|
|
962
960
|
* @readonly
|
|
963
961
|
*/
|
|
964
962
|
labels?: Label[];
|
|
@@ -978,12 +976,12 @@ export type ValueTypeWithLiterals = ValueType | 'TEXT' | 'NUMBER' | 'TEXT_ARRAY'
|
|
|
978
976
|
*/
|
|
979
977
|
export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
980
978
|
/**
|
|
981
|
-
* 0-based index from predefined `
|
|
979
|
+
* 0-based index from predefined `controls.inputs.options` which is initial selection.
|
|
982
980
|
* @max 199
|
|
983
981
|
*/
|
|
984
982
|
optionIndex?: number;
|
|
985
983
|
/**
|
|
986
|
-
* Placeholder hint describing expected choices
|
|
984
|
+
* Placeholder hint describing expected choices, such as "Please select".
|
|
987
985
|
* Considered an empty choice.
|
|
988
986
|
* @maxLength 200
|
|
989
987
|
*/
|
|
@@ -992,12 +990,12 @@ export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
|
992
990
|
/** @oneof */
|
|
993
991
|
export interface OptionSelectionSelectedOptionOneOf {
|
|
994
992
|
/**
|
|
995
|
-
* 0-based index from predefined `
|
|
993
|
+
* 0-based index from predefined `controls.inputs.options` which is initial selection.
|
|
996
994
|
* @max 199
|
|
997
995
|
*/
|
|
998
996
|
optionIndex?: number;
|
|
999
997
|
/**
|
|
1000
|
-
* Placeholder hint describing expected choices
|
|
998
|
+
* Placeholder hint describing expected choices, such as "Please select".
|
|
1001
999
|
* Considered an empty choice.
|
|
1002
1000
|
* @maxLength 200
|
|
1003
1001
|
*/
|
|
@@ -1014,7 +1012,7 @@ export interface Label {
|
|
|
1014
1012
|
* It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
1015
1013
|
*/
|
|
1016
1014
|
export interface FormMessages {
|
|
1017
|
-
/** RSVP form messages. */
|
|
1015
|
+
/** 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. */
|
|
1018
1016
|
rsvp?: RsvpFormMessages;
|
|
1019
1017
|
/** Checkout form messages. */
|
|
1020
1018
|
checkout?: CheckoutFormMessages;
|
|
@@ -1024,15 +1022,15 @@ export interface FormMessages {
|
|
|
1024
1022
|
ticketsUnavailable?: TicketsUnavailableMessages;
|
|
1025
1023
|
}
|
|
1026
1024
|
export interface RsvpFormMessages {
|
|
1027
|
-
/** Label text indicating RSVP `
|
|
1025
|
+
/** Label text indicating RSVP's `status` is `"YES"`. */
|
|
1028
1026
|
rsvpYesOption?: string;
|
|
1029
|
-
/** Label text indicating RSVP `
|
|
1027
|
+
/** Label text indicating RSVP's `status` is `"NO"`. */
|
|
1030
1028
|
rsvpNoOption?: string;
|
|
1031
|
-
/** Messages
|
|
1029
|
+
/** Messages displayed when an RSVP's `status` is set to `"YES"`. */
|
|
1032
1030
|
positiveMessages?: Positive;
|
|
1033
|
-
/** Messages
|
|
1031
|
+
/** Messages displayed when an RSVP's `status` is set to `"WAITLIST"`, for when the event is full and a waitlist is available). */
|
|
1034
1032
|
waitlistMessages?: Positive;
|
|
1035
|
-
/** Messages
|
|
1033
|
+
/** Messages displayed when an RSVP's `status` is set to `"NO"`. */
|
|
1036
1034
|
negativeMessages?: Negative;
|
|
1037
1035
|
/** "Submit form" call-to-action label text. */
|
|
1038
1036
|
submitActionLabel?: string;
|
|
@@ -1530,17 +1528,32 @@ export interface ButtonData {
|
|
|
1530
1528
|
link?: V1Link;
|
|
1531
1529
|
}
|
|
1532
1530
|
export interface Border {
|
|
1533
|
-
/**
|
|
1531
|
+
/**
|
|
1532
|
+
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
1533
|
+
* @deprecated
|
|
1534
|
+
*/
|
|
1534
1535
|
width?: number | null;
|
|
1535
|
-
/**
|
|
1536
|
+
/**
|
|
1537
|
+
* Deprecated: Use `borderRadius` in `styles` instead.
|
|
1538
|
+
* @deprecated
|
|
1539
|
+
*/
|
|
1536
1540
|
radius?: number | null;
|
|
1537
1541
|
}
|
|
1538
1542
|
export interface Colors {
|
|
1539
|
-
/**
|
|
1543
|
+
/**
|
|
1544
|
+
* Deprecated: Use `textColor` in `styles` instead.
|
|
1545
|
+
* @deprecated
|
|
1546
|
+
*/
|
|
1540
1547
|
text?: string | null;
|
|
1541
|
-
/**
|
|
1548
|
+
/**
|
|
1549
|
+
* Deprecated: Use `borderColor` in `styles` instead.
|
|
1550
|
+
* @deprecated
|
|
1551
|
+
*/
|
|
1542
1552
|
border?: string | null;
|
|
1543
|
-
/**
|
|
1553
|
+
/**
|
|
1554
|
+
* Deprecated: Use `backgroundColor` in `styles` instead.
|
|
1555
|
+
* @deprecated
|
|
1556
|
+
*/
|
|
1544
1557
|
background?: string | null;
|
|
1545
1558
|
}
|
|
1546
1559
|
export interface PluginContainerData {
|
|
@@ -1623,10 +1636,57 @@ export declare enum ButtonDataType {
|
|
|
1623
1636
|
/** @enumType */
|
|
1624
1637
|
export type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
1625
1638
|
export interface Styles {
|
|
1626
|
-
/**
|
|
1639
|
+
/**
|
|
1640
|
+
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
1641
|
+
* @deprecated
|
|
1642
|
+
*/
|
|
1627
1643
|
border?: Border;
|
|
1628
|
-
/**
|
|
1644
|
+
/**
|
|
1645
|
+
* Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
|
|
1646
|
+
* @deprecated
|
|
1647
|
+
*/
|
|
1629
1648
|
colors?: Colors;
|
|
1649
|
+
/** Border width in pixels. */
|
|
1650
|
+
borderWidth?: number | null;
|
|
1651
|
+
/**
|
|
1652
|
+
* Deprecated: Use `borderWidth` for normal/hover states instead.
|
|
1653
|
+
* @deprecated
|
|
1654
|
+
*/
|
|
1655
|
+
borderWidthHover?: number | null;
|
|
1656
|
+
/** Border radius in pixels. */
|
|
1657
|
+
borderRadius?: number | null;
|
|
1658
|
+
/**
|
|
1659
|
+
* Border color as a hexadecimal value.
|
|
1660
|
+
* @format COLOR_HEX
|
|
1661
|
+
*/
|
|
1662
|
+
borderColor?: string | null;
|
|
1663
|
+
/**
|
|
1664
|
+
* Border color as a hexadecimal value (hover state).
|
|
1665
|
+
* @format COLOR_HEX
|
|
1666
|
+
*/
|
|
1667
|
+
borderColorHover?: string | null;
|
|
1668
|
+
/**
|
|
1669
|
+
* Text color as a hexadecimal value.
|
|
1670
|
+
* @format COLOR_HEX
|
|
1671
|
+
*/
|
|
1672
|
+
textColor?: string | null;
|
|
1673
|
+
/**
|
|
1674
|
+
* Text color as a hexadecimal value (hover state).
|
|
1675
|
+
* @format COLOR_HEX
|
|
1676
|
+
*/
|
|
1677
|
+
textColorHover?: string | null;
|
|
1678
|
+
/**
|
|
1679
|
+
* Background color as a hexadecimal value.
|
|
1680
|
+
* @format COLOR_HEX
|
|
1681
|
+
*/
|
|
1682
|
+
backgroundColor?: string | null;
|
|
1683
|
+
/**
|
|
1684
|
+
* Background color as a hexadecimal value (hover state).
|
|
1685
|
+
* @format COLOR_HEX
|
|
1686
|
+
*/
|
|
1687
|
+
backgroundColorHover?: string | null;
|
|
1688
|
+
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
1689
|
+
buttonSize?: string | null;
|
|
1630
1690
|
}
|
|
1631
1691
|
export interface V1Link extends V1LinkDataOneOf {
|
|
1632
1692
|
/** The absolute URL for the linked document. */
|
|
@@ -2373,6 +2433,8 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
2373
2433
|
underlineData?: boolean | null;
|
|
2374
2434
|
/** Data for a spoiler decoration. */
|
|
2375
2435
|
spoilerData?: SpoilerData;
|
|
2436
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
2437
|
+
strikethroughData?: boolean | null;
|
|
2376
2438
|
/** The type of decoration to apply. */
|
|
2377
2439
|
type?: DecorationTypeWithLiterals;
|
|
2378
2440
|
}
|
|
@@ -2396,6 +2458,8 @@ export interface DecorationDataOneOf {
|
|
|
2396
2458
|
underlineData?: boolean | null;
|
|
2397
2459
|
/** Data for a spoiler decoration. */
|
|
2398
2460
|
spoilerData?: SpoilerData;
|
|
2461
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
2462
|
+
strikethroughData?: boolean | null;
|
|
2399
2463
|
}
|
|
2400
2464
|
export declare enum DecorationType {
|
|
2401
2465
|
BOLD = "BOLD",
|
|
@@ -2407,10 +2471,11 @@ export declare enum DecorationType {
|
|
|
2407
2471
|
LINK = "LINK",
|
|
2408
2472
|
COLOR = "COLOR",
|
|
2409
2473
|
FONT_SIZE = "FONT_SIZE",
|
|
2410
|
-
EXTERNAL = "EXTERNAL"
|
|
2474
|
+
EXTERNAL = "EXTERNAL",
|
|
2475
|
+
STRIKETHROUGH = "STRIKETHROUGH"
|
|
2411
2476
|
}
|
|
2412
2477
|
/** @enumType */
|
|
2413
|
-
export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL';
|
|
2478
|
+
export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
2414
2479
|
export interface AnchorData {
|
|
2415
2480
|
/** The target node's ID. */
|
|
2416
2481
|
anchor?: string;
|
|
@@ -2775,46 +2840,47 @@ export interface Badge {
|
|
|
2775
2840
|
export declare enum Type {
|
|
2776
2841
|
/** Unknown badge type. */
|
|
2777
2842
|
UNKNOWN_BADGE_TYPE = "UNKNOWN_BADGE_TYPE",
|
|
2778
|
-
/**
|
|
2779
|
-
|
|
2780
|
-
/**
|
|
2781
|
-
|
|
2782
|
-
/**
|
|
2783
|
-
|
|
2843
|
+
/** 1st priority badge type. */
|
|
2844
|
+
FIRST_PRIORITY = "FIRST_PRIORITY",
|
|
2845
|
+
/** 2nd priority badge type. */
|
|
2846
|
+
SECOND_PRIORITY = "SECOND_PRIORITY",
|
|
2847
|
+
/** 3rd priority badge type. */
|
|
2848
|
+
THIRD_PRIORITY = "THIRD_PRIORITY"
|
|
2784
2849
|
}
|
|
2785
2850
|
/** @enumType */
|
|
2786
|
-
export type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | '
|
|
2851
|
+
export type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | 'FIRST_PRIORITY' | 'SECOND_PRIORITY' | 'THIRD_PRIORITY';
|
|
2852
|
+
/** Triggered when an order is confirmed. */
|
|
2787
2853
|
export interface OrderConfirmed {
|
|
2788
|
-
/**
|
|
2854
|
+
/** Date and time the order was confirmed. */
|
|
2789
2855
|
timestamp?: Date | null;
|
|
2790
2856
|
/**
|
|
2791
|
-
* Site language when
|
|
2857
|
+
* Site language when the order was initiated.
|
|
2792
2858
|
* @format LANGUAGE
|
|
2793
2859
|
*/
|
|
2794
2860
|
language?: string | null;
|
|
2795
2861
|
/** Notifications silenced for this domain event. */
|
|
2796
2862
|
silent?: boolean | null;
|
|
2797
2863
|
/**
|
|
2798
|
-
* Locale in which
|
|
2864
|
+
* Locale in which the order was created.
|
|
2799
2865
|
* @format LANGUAGE_TAG
|
|
2800
2866
|
*/
|
|
2801
2867
|
locale?: string | null;
|
|
2802
2868
|
/**
|
|
2803
|
-
* Event ID.
|
|
2869
|
+
* Event ID to which the order belongs.
|
|
2804
2870
|
* @format GUID
|
|
2805
2871
|
*/
|
|
2806
2872
|
eventId?: string;
|
|
2807
2873
|
/** Unique order number. */
|
|
2808
2874
|
orderNumber?: string;
|
|
2809
|
-
/** Contact ID associated with
|
|
2875
|
+
/** Contact ID associated with the order. */
|
|
2810
2876
|
contactId?: string;
|
|
2811
2877
|
/**
|
|
2812
|
-
* Member ID associated with
|
|
2878
|
+
* Member ID associated with the order.
|
|
2813
2879
|
* @format GUID
|
|
2814
2880
|
*/
|
|
2815
2881
|
memberId?: string | null;
|
|
2816
2882
|
/**
|
|
2817
|
-
*
|
|
2883
|
+
* Date and time the order was created.
|
|
2818
2884
|
* @readonly
|
|
2819
2885
|
*/
|
|
2820
2886
|
created?: Date | null;
|
|
@@ -2834,7 +2900,7 @@ export interface OrderConfirmed {
|
|
|
2834
2900
|
tickets?: Ticket[];
|
|
2835
2901
|
/** Invoice. */
|
|
2836
2902
|
invoice?: Invoice;
|
|
2837
|
-
/** Reservation ID associated with
|
|
2903
|
+
/** Reservation ID associated with the order. */
|
|
2838
2904
|
reservationId?: string;
|
|
2839
2905
|
}
|
|
2840
2906
|
export interface FormResponse {
|
|
@@ -2856,7 +2922,7 @@ export interface InputValue {
|
|
|
2856
2922
|
*/
|
|
2857
2923
|
value?: string;
|
|
2858
2924
|
/**
|
|
2859
|
-
* Multiple
|
|
2925
|
+
* Multiple input values. For example, the array is filled if several checkboxes are ticked.
|
|
2860
2926
|
* @maxSize 100
|
|
2861
2927
|
* @maxLength 5000
|
|
2862
2928
|
*/
|
|
@@ -2925,17 +2991,17 @@ export interface StandardDetails {
|
|
|
2925
2991
|
iso31662?: string | null;
|
|
2926
2992
|
}
|
|
2927
2993
|
export declare enum OrderStatus {
|
|
2928
|
-
/** Order status not available for this request fieldset. */
|
|
2994
|
+
/** Order status is not available for this request fieldset. */
|
|
2929
2995
|
NA_ORDER_STATUS = "NA_ORDER_STATUS",
|
|
2930
|
-
/** Order is confirmed
|
|
2996
|
+
/** Order is confirmed, no payment is required. */
|
|
2931
2997
|
FREE = "FREE",
|
|
2932
|
-
/** Order
|
|
2998
|
+
/** Order was paid, but the payment gateway suspended the payment. */
|
|
2933
2999
|
PENDING = "PENDING",
|
|
2934
|
-
/** Order is paid
|
|
3000
|
+
/** Order is paid. */
|
|
2935
3001
|
PAID = "PAID",
|
|
2936
|
-
/** Order is confirmed but
|
|
3002
|
+
/** Order is confirmed but has be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
|
|
2937
3003
|
OFFLINE_PENDING = "OFFLINE_PENDING",
|
|
2938
|
-
/** Order is awaiting payment at the cashier. */
|
|
3004
|
+
/** Order is awaiting for payment at the cashier. */
|
|
2939
3005
|
INITIATED = "INITIATED",
|
|
2940
3006
|
/** Order is canceled. */
|
|
2941
3007
|
CANCELED = "CANCELED",
|
|
@@ -2999,7 +3065,7 @@ export interface Ticket {
|
|
|
2999
3065
|
canceled?: boolean | null;
|
|
3000
3066
|
}
|
|
3001
3067
|
export interface CheckIn {
|
|
3002
|
-
/** Time of check-in */
|
|
3068
|
+
/** Time of check-in. */
|
|
3003
3069
|
created?: Date | null;
|
|
3004
3070
|
}
|
|
3005
3071
|
export interface OnlineConferencingLogin {
|
|
@@ -3022,14 +3088,14 @@ export interface Invoice {
|
|
|
3022
3088
|
* @deprecated
|
|
3023
3089
|
*/
|
|
3024
3090
|
total?: Money;
|
|
3025
|
-
/** Discount applied to cart. */
|
|
3091
|
+
/** Discount applied to a cart. */
|
|
3026
3092
|
discount?: Discount;
|
|
3027
|
-
/** Tax applied to cart. */
|
|
3093
|
+
/** Tax applied to a cart. */
|
|
3028
3094
|
tax?: Tax;
|
|
3029
3095
|
/** Total cart amount before discount, tax, and fees. */
|
|
3030
3096
|
subTotal?: Money;
|
|
3031
3097
|
/**
|
|
3032
|
-
* Total amount of cart after discount, tax, and fees.
|
|
3098
|
+
* Total amount of a cart after discount, tax, and fees.
|
|
3033
3099
|
* Grand total is calculated in the following order:
|
|
3034
3100
|
* 1. Total prices of all items in the cart are calculated.
|
|
3035
3101
|
* 2. Discount is subtracted from the cart (if applicable).
|
|
@@ -3044,7 +3110,7 @@ export interface Invoice {
|
|
|
3044
3110
|
fees?: Fee[];
|
|
3045
3111
|
/** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
|
|
3046
3112
|
revenue?: Money;
|
|
3047
|
-
/**
|
|
3113
|
+
/** Invoice preview URL. Only returned if the order is paid. */
|
|
3048
3114
|
previewUrl?: string | null;
|
|
3049
3115
|
}
|
|
3050
3116
|
export interface Item {
|
|
@@ -3078,7 +3144,7 @@ export interface Item {
|
|
|
3078
3144
|
export interface Discount {
|
|
3079
3145
|
/** Total discount amount. */
|
|
3080
3146
|
amount?: Money;
|
|
3081
|
-
/** Total
|
|
3147
|
+
/** Total sum after the discount. */
|
|
3082
3148
|
afterDiscount?: Money;
|
|
3083
3149
|
/**
|
|
3084
3150
|
* Discount coupon code.
|
|
@@ -3114,11 +3180,11 @@ export interface DiscountItemDiscountOneOf {
|
|
|
3114
3180
|
paidPlan?: PaidPlanDiscount;
|
|
3115
3181
|
}
|
|
3116
3182
|
export interface CouponDiscount {
|
|
3117
|
-
/** Discount coupon name. */
|
|
3183
|
+
/** Discount coupon name. **Deprecated:** Use `invoice.discounts.coupon.name` instead. */
|
|
3118
3184
|
name?: string;
|
|
3119
|
-
/** Discount coupon code. */
|
|
3185
|
+
/** Discount coupon code. **Deprecated:** Use `invoice.discounts.coupon.code` instead. */
|
|
3120
3186
|
code?: string;
|
|
3121
|
-
/** Discount coupon ID. */
|
|
3187
|
+
/** Discount coupon ID. **Deprecated:** Use `invoice.discounts.coupon.couponId` instead. */
|
|
3122
3188
|
couponId?: string;
|
|
3123
3189
|
}
|
|
3124
3190
|
export interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
|
|
@@ -3182,7 +3248,7 @@ export type FeeNameWithLiterals = FeeName | 'WIX_FEE';
|
|
|
3182
3248
|
export declare enum FeeType {
|
|
3183
3249
|
/** Fee is added to the ticket price at checkout. */
|
|
3184
3250
|
FEE_ADDED = "FEE_ADDED",
|
|
3185
|
-
/** Seller absorbs the fee. It
|
|
3251
|
+
/** Seller absorbs the fee. It's deducted from the ticket price. */
|
|
3186
3252
|
FEE_INCLUDED = "FEE_INCLUDED",
|
|
3187
3253
|
/** Fee is added to the ticket price at checkout. */
|
|
3188
3254
|
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
|
|
@@ -3334,23 +3400,24 @@ export interface TimeDuration {
|
|
|
3334
3400
|
*/
|
|
3335
3401
|
minutes?: number;
|
|
3336
3402
|
}
|
|
3403
|
+
/** Triggered when an order is paid. */
|
|
3337
3404
|
export interface OrderPaid {
|
|
3338
|
-
/**
|
|
3405
|
+
/** Date and time the order was paid. */
|
|
3339
3406
|
timestamp?: Date | null;
|
|
3340
3407
|
/**
|
|
3341
|
-
* Site language when
|
|
3408
|
+
* Site language when the order was initiated.
|
|
3342
3409
|
* @format LANGUAGE
|
|
3343
3410
|
*/
|
|
3344
3411
|
language?: string | null;
|
|
3345
3412
|
/** Notifications silenced for this domain event. */
|
|
3346
3413
|
silent?: boolean | null;
|
|
3347
3414
|
/**
|
|
3348
|
-
* Locale in which
|
|
3415
|
+
* Locale in which the order was created.
|
|
3349
3416
|
* @format LANGUAGE_TAG
|
|
3350
3417
|
*/
|
|
3351
3418
|
locale?: string | null;
|
|
3352
3419
|
/**
|
|
3353
|
-
* Event ID.
|
|
3420
|
+
* Event ID to which the order belongs.
|
|
3354
3421
|
* @format GUID
|
|
3355
3422
|
*/
|
|
3356
3423
|
eventId?: string;
|
|
@@ -3369,7 +3436,7 @@ export interface OrderPaid {
|
|
|
3369
3436
|
*/
|
|
3370
3437
|
memberId?: string | null;
|
|
3371
3438
|
/**
|
|
3372
|
-
*
|
|
3439
|
+
* Date and time the order was created.
|
|
3373
3440
|
* @readonly
|
|
3374
3441
|
*/
|
|
3375
3442
|
created?: Date | null;
|
|
@@ -3446,9 +3513,10 @@ export interface TicketPdfResolveDelayed {
|
|
|
3446
3513
|
*/
|
|
3447
3514
|
documentId?: string | null;
|
|
3448
3515
|
}
|
|
3516
|
+
/** Triggered when an order is canceled. */
|
|
3449
3517
|
export interface OrderCanceled {
|
|
3450
3518
|
/**
|
|
3451
|
-
* Event ID.
|
|
3519
|
+
* Event ID to which the order belongs.
|
|
3452
3520
|
* @format GUID
|
|
3453
3521
|
*/
|
|
3454
3522
|
eventId?: string;
|
|
@@ -3458,12 +3526,12 @@ export interface OrderCanceled {
|
|
|
3458
3526
|
*/
|
|
3459
3527
|
orderNumber?: string;
|
|
3460
3528
|
/**
|
|
3461
|
-
* Reservation ID associated with
|
|
3529
|
+
* Reservation ID associated with the order.
|
|
3462
3530
|
* @format GUID
|
|
3463
3531
|
*/
|
|
3464
3532
|
reservationId?: string;
|
|
3465
3533
|
/**
|
|
3466
|
-
* Contact ID associated with
|
|
3534
|
+
* Contact ID associated with the order.
|
|
3467
3535
|
* @maxLength 36
|
|
3468
3536
|
*/
|
|
3469
3537
|
contactId?: string;
|