@wix/events 1.0.155 → 1.0.156
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/context.d.ts +11 -0
- package/build/cjs/context.js +38 -0
- package/build/cjs/context.js.map +1 -0
- package/build/cjs/index.d.ts +4 -4
- package/build/cjs/index.js +5 -5
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +4 -4
- package/build/cjs/index.typings.js +5 -5
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +4 -4
- package/build/cjs/meta.js +5 -5
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/src/events-guests-v1-guest.context.d.ts +3 -0
- package/build/cjs/src/events-guests-v1-guest.context.js +16 -0
- package/build/cjs/src/events-guests-v1-guest.context.js.map +1 -0
- package/build/cjs/src/events-guests-v1-guest.universal.d.ts +0 -6
- package/build/cjs/src/events-guests-v1-guest.universal.js +1 -8
- package/build/cjs/src/events-guests-v1-guest.universal.js.map +1 -1
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.context.d.ts +5 -0
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.context.js +38 -0
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.context.js.map +1 -0
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.http.d.ts +9 -60
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.http.js +9 -60
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.http.js.map +1 -1
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.d.ts +0 -12
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.js +1 -23
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.js.map +1 -1
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule.context.d.ts +11 -0
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule.context.js +104 -0
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule.context.js.map +1 -0
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule.http.d.ts +9 -60
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule.http.js +9 -60
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule.http.js.map +1 -1
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule.universal.d.ts +0 -33
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule.universal.js +1 -49
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule.universal.js.map +1 -1
- package/build/cjs/src/events-v1-category.context.d.ts +15 -0
- package/build/cjs/src/events-v1-category.context.js +148 -0
- package/build/cjs/src/events-v1-category.context.js.map +1 -0
- package/build/cjs/src/events-v1-category.universal.d.ts +0 -6
- package/build/cjs/src/events-v1-category.universal.js +1 -26
- package/build/cjs/src/events-v1-category.universal.js.map +1 -1
- package/build/cjs/src/events-v1-form.context.d.ts +9 -0
- package/build/cjs/src/events-v1-form.context.js +82 -0
- package/build/cjs/src/events-v1-form.context.js.map +1 -0
- package/build/cjs/src/events-v1-form.http.d.ts +25 -0
- package/build/cjs/src/events-v1-form.http.js +403 -0
- package/build/cjs/src/events-v1-form.http.js.map +1 -0
- package/build/cjs/src/events-v1-form.meta.d.ts +35 -0
- package/build/cjs/src/{events-v1-order-orders.meta.js → events-v1-form.meta.js} +57 -38
- package/build/cjs/src/events-v1-form.meta.js.map +1 -0
- package/build/cjs/src/events-v1-form.public.d.ts +91 -0
- package/build/cjs/src/events-v1-form.public.js +62 -0
- package/build/cjs/src/events-v1-form.public.js.map +1 -0
- package/build/cjs/src/events-v1-form.types.d.ts +1775 -0
- package/build/cjs/src/events-v1-form.types.js +159 -0
- package/build/cjs/src/events-v1-form.types.js.map +1 -0
- package/build/cjs/src/events-v1-form.universal.d.ts +1923 -0
- package/build/cjs/src/events-v1-form.universal.js +676 -0
- package/build/cjs/src/events-v1-form.universal.js.map +1 -0
- package/build/cjs/src/events-v1-order.context.d.ts +16 -0
- package/build/cjs/src/events-v1-order.context.js +159 -0
- package/build/cjs/src/events-v1-order.context.js.map +1 -0
- package/build/cjs/src/{events-v1-order-orders.http.d.ts → events-v1-order.http.d.ts} +1 -1
- package/build/cjs/src/{events-v1-order-orders.http.js → events-v1-order.http.js} +1 -1
- package/build/cjs/src/events-v1-order.http.js.map +1 -0
- package/build/{es/src/events-v1-order-checkout.meta.d.ts → cjs/src/events-v1-order.meta.d.ts} +18 -2
- package/build/cjs/src/{events-v1-order-checkout.meta.js → events-v1-order.meta.js} +117 -3
- package/build/cjs/src/events-v1-order.meta.js.map +1 -0
- package/build/cjs/src/{events-v1-order-orders.public.d.ts → events-v1-order.public.d.ts} +27 -19
- package/build/cjs/src/events-v1-order.public.js +105 -0
- package/build/cjs/src/events-v1-order.public.js.map +1 -0
- package/build/cjs/src/{events-v1-order-orders.types.js → events-v1-order.types.js} +1 -1
- package/build/cjs/src/events-v1-order.types.js.map +1 -0
- package/build/{es/src/events-v1-order-checkout.universal.d.ts → cjs/src/events-v1-order.universal.d.ts} +225 -6
- package/build/cjs/src/{events-v1-order-checkout.universal.js → events-v1-order.universal.js} +511 -24
- package/build/cjs/src/events-v1-order.universal.js.map +1 -0
- package/build/cjs/src/events-v1-rsvp.context.d.ts +11 -0
- package/build/cjs/src/events-v1-rsvp.context.js +104 -0
- package/build/cjs/src/events-v1-rsvp.context.js.map +1 -0
- package/build/cjs/src/events-v1-rsvp.http.js +235 -5
- package/build/cjs/src/events-v1-rsvp.http.js.map +1 -1
- package/build/cjs/src/events-v1-rsvp.universal.d.ts +18 -6
- package/build/cjs/src/events-v1-rsvp.universal.js +19 -23
- package/build/cjs/src/events-v1-rsvp.universal.js.map +1 -1
- package/build/cjs/src/events-v1-ticket-definition.context.d.ts +9 -0
- package/build/cjs/src/events-v1-ticket-definition.context.js +82 -0
- package/build/cjs/src/events-v1-ticket-definition.context.js.map +1 -0
- package/build/cjs/src/events-v1-ticket-definition.public.d.ts +1 -1
- package/build/cjs/src/events-v1-ticket-definition.types.d.ts +2 -2
- package/build/cjs/src/events-v1-ticket-definition.universal.d.ts +19 -8
- package/build/cjs/src/events-v1-ticket-definition.universal.js +18 -21
- package/build/cjs/src/events-v1-ticket-definition.universal.js.map +1 -1
- package/build/cjs/src/events-v1-ticket.context.d.ts +8 -0
- package/build/cjs/src/events-v1-ticket.context.js +71 -0
- package/build/cjs/src/events-v1-ticket.context.js.map +1 -0
- package/build/cjs/src/events-v1-ticket.universal.d.ts +12 -6
- package/build/cjs/src/events-v1-ticket.universal.js +13 -20
- package/build/cjs/src/events-v1-ticket.universal.js.map +1 -1
- package/build/cjs/src/events-v2-policy.context.d.ts +8 -0
- package/build/cjs/src/events-v2-policy.context.js +71 -0
- package/build/cjs/src/events-v2-policy.context.js.map +1 -0
- package/build/cjs/src/events-v2-policy.universal.d.ts +0 -6
- package/build/cjs/src/events-v2-policy.universal.js +1 -19
- package/build/cjs/src/events-v2-policy.universal.js.map +1 -1
- package/build/cjs/src/events-v3-event.context.d.ts +15 -0
- package/build/cjs/src/events-v3-event.context.js +148 -0
- package/build/cjs/src/events-v3-event.context.js.map +1 -0
- package/build/cjs/src/events-v3-event.http.js +6 -0
- package/build/cjs/src/events-v3-event.http.js.map +1 -1
- package/build/cjs/src/events-v3-event.public.d.ts +5 -5
- package/build/cjs/src/events-v3-event.public.js.map +1 -1
- package/build/cjs/src/events-v3-event.types.d.ts +22 -22
- package/build/cjs/src/events-v3-event.universal.d.ts +28 -34
- package/build/cjs/src/events-v3-event.universal.js +31 -56
- package/build/cjs/src/events-v3-event.universal.js.map +1 -1
- package/build/es/context.d.ts +11 -0
- package/build/es/context.js +12 -0
- package/build/es/context.js.map +1 -0
- package/build/es/index.d.ts +4 -4
- package/build/es/index.js +4 -4
- package/build/es/index.js.map +1 -1
- package/build/es/index.typings.d.ts +4 -4
- package/build/es/index.typings.js +4 -4
- package/build/es/index.typings.js.map +1 -1
- package/build/es/meta.d.ts +4 -4
- package/build/es/meta.js +4 -4
- package/build/es/meta.js.map +1 -1
- package/build/es/src/events-guests-v1-guest.context.d.ts +3 -0
- package/build/es/src/events-guests-v1-guest.context.js +12 -0
- package/build/es/src/events-guests-v1-guest.context.js.map +1 -0
- package/build/es/src/events-guests-v1-guest.universal.d.ts +0 -6
- package/build/es/src/events-guests-v1-guest.universal.js +0 -7
- package/build/es/src/events-guests-v1-guest.universal.js.map +1 -1
- package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.context.d.ts +5 -0
- package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.context.js +32 -0
- package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.context.js.map +1 -0
- package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.http.d.ts +9 -60
- package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.http.js +9 -60
- package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.http.js.map +1 -1
- package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.d.ts +0 -12
- package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.js +0 -22
- package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.js.map +1 -1
- package/build/es/src/events-schedule-v1-schedule-item-schedule.context.d.ts +11 -0
- package/build/es/src/events-schedule-v1-schedule-item-schedule.context.js +92 -0
- package/build/es/src/events-schedule-v1-schedule-item-schedule.context.js.map +1 -0
- package/build/es/src/events-schedule-v1-schedule-item-schedule.http.d.ts +9 -60
- package/build/es/src/events-schedule-v1-schedule-item-schedule.http.js +9 -60
- package/build/es/src/events-schedule-v1-schedule-item-schedule.http.js.map +1 -1
- package/build/es/src/events-schedule-v1-schedule-item-schedule.universal.d.ts +0 -33
- package/build/es/src/events-schedule-v1-schedule-item-schedule.universal.js +0 -48
- package/build/es/src/events-schedule-v1-schedule-item-schedule.universal.js.map +1 -1
- package/build/es/src/events-v1-category.context.d.ts +15 -0
- package/build/es/src/events-v1-category.context.js +132 -0
- package/build/es/src/events-v1-category.context.js.map +1 -0
- package/build/es/src/events-v1-category.universal.d.ts +0 -6
- package/build/es/src/events-v1-category.universal.js +0 -25
- package/build/es/src/events-v1-category.universal.js.map +1 -1
- package/build/es/src/events-v1-form.context.d.ts +9 -0
- package/build/es/src/events-v1-form.context.js +72 -0
- package/build/es/src/events-v1-form.context.js.map +1 -0
- package/build/es/src/events-v1-form.http.d.ts +25 -0
- package/build/es/src/events-v1-form.http.js +393 -0
- package/build/es/src/events-v1-form.http.js.map +1 -0
- package/build/es/src/events-v1-form.meta.d.ts +35 -0
- package/build/es/src/events-v1-form.meta.js +128 -0
- package/build/es/src/events-v1-form.meta.js.map +1 -0
- package/build/es/src/events-v1-form.public.d.ts +91 -0
- package/build/es/src/events-v1-form.public.js +39 -0
- package/build/es/src/events-v1-form.public.js.map +1 -0
- package/build/es/src/events-v1-form.types.d.ts +1775 -0
- package/build/es/src/events-v1-form.types.js +156 -0
- package/build/es/src/events-v1-form.types.js.map +1 -0
- package/build/es/src/events-v1-form.universal.d.ts +1923 -0
- package/build/es/src/events-v1-form.universal.js +643 -0
- package/build/es/src/events-v1-form.universal.js.map +1 -0
- package/build/es/src/events-v1-order.context.d.ts +16 -0
- package/build/es/src/events-v1-order.context.js +142 -0
- package/build/es/src/events-v1-order.context.js.map +1 -0
- package/build/es/src/{events-v1-order-orders.http.d.ts → events-v1-order.http.d.ts} +1 -1
- package/build/es/src/{events-v1-order-orders.http.js → events-v1-order.http.js} +1 -1
- package/build/es/src/events-v1-order.http.js.map +1 -0
- package/build/{cjs/src/events-v1-order-checkout.meta.d.ts → es/src/events-v1-order.meta.d.ts} +18 -2
- package/build/es/src/{events-v1-order-checkout.meta.js → events-v1-order.meta.js} +110 -2
- package/build/es/src/events-v1-order.meta.js.map +1 -0
- package/build/es/src/{events-v1-order-orders.public.d.ts → events-v1-order.public.d.ts} +27 -19
- package/build/es/src/events-v1-order.public.js +74 -0
- package/build/es/src/events-v1-order.public.js.map +1 -0
- package/build/es/src/{events-v1-order-orders.types.js → events-v1-order.types.js} +1 -1
- package/build/es/src/events-v1-order.types.js.map +1 -0
- package/build/{cjs/src/events-v1-order-checkout.universal.d.ts → es/src/events-v1-order.universal.d.ts} +225 -6
- package/build/es/src/{events-v1-order-checkout.universal.js → events-v1-order.universal.js} +504 -23
- package/build/es/src/events-v1-order.universal.js.map +1 -0
- package/build/es/src/events-v1-rsvp.context.d.ts +11 -0
- package/build/es/src/events-v1-rsvp.context.js +92 -0
- package/build/es/src/events-v1-rsvp.context.js.map +1 -0
- package/build/es/src/events-v1-rsvp.http.js +235 -5
- package/build/es/src/events-v1-rsvp.http.js.map +1 -1
- package/build/es/src/events-v1-rsvp.universal.d.ts +18 -6
- package/build/es/src/events-v1-rsvp.universal.js +18 -22
- package/build/es/src/events-v1-rsvp.universal.js.map +1 -1
- package/build/es/src/events-v1-ticket-definition.context.d.ts +9 -0
- package/build/es/src/events-v1-ticket-definition.context.js +72 -0
- package/build/es/src/events-v1-ticket-definition.context.js.map +1 -0
- package/build/es/src/events-v1-ticket-definition.public.d.ts +1 -1
- package/build/es/src/events-v1-ticket-definition.types.d.ts +2 -2
- package/build/es/src/events-v1-ticket-definition.universal.d.ts +19 -8
- package/build/es/src/events-v1-ticket-definition.universal.js +17 -20
- package/build/es/src/events-v1-ticket-definition.universal.js.map +1 -1
- package/build/es/src/events-v1-ticket.context.d.ts +8 -0
- package/build/es/src/events-v1-ticket.context.js +62 -0
- package/build/es/src/events-v1-ticket.context.js.map +1 -0
- package/build/es/src/events-v1-ticket.universal.d.ts +12 -6
- package/build/es/src/events-v1-ticket.universal.js +12 -19
- package/build/es/src/events-v1-ticket.universal.js.map +1 -1
- package/build/es/src/events-v2-policy.context.d.ts +8 -0
- package/build/es/src/events-v2-policy.context.js +62 -0
- package/build/es/src/events-v2-policy.context.js.map +1 -0
- package/build/es/src/events-v2-policy.universal.d.ts +0 -6
- package/build/es/src/events-v2-policy.universal.js +0 -18
- package/build/es/src/events-v2-policy.universal.js.map +1 -1
- package/build/es/src/events-v3-event.context.d.ts +15 -0
- package/build/es/src/events-v3-event.context.js +132 -0
- package/build/es/src/events-v3-event.context.js.map +1 -0
- package/build/es/src/events-v3-event.http.js +6 -0
- package/build/es/src/events-v3-event.http.js.map +1 -1
- package/build/es/src/events-v3-event.public.d.ts +5 -5
- package/build/es/src/events-v3-event.public.js.map +1 -1
- package/build/es/src/events-v3-event.types.d.ts +22 -22
- package/build/es/src/events-v3-event.universal.d.ts +28 -34
- package/build/es/src/events-v3-event.universal.js +30 -55
- package/build/es/src/events-v3-event.universal.js.map +1 -1
- package/context/package.json +6 -0
- package/package.json +6 -4
- package/build/cjs/src/events-v1-order-checkout.http.d.ts +0 -89
- package/build/cjs/src/events-v1-order-checkout.http.js +0 -1083
- package/build/cjs/src/events-v1-order-checkout.http.js.map +0 -1
- package/build/cjs/src/events-v1-order-checkout.meta.js.map +0 -1
- package/build/cjs/src/events-v1-order-checkout.public.d.ts +0 -15
- package/build/cjs/src/events-v1-order-checkout.public.js +0 -69
- package/build/cjs/src/events-v1-order-checkout.public.js.map +0 -1
- package/build/cjs/src/events-v1-order-checkout.types.js +0 -145
- package/build/cjs/src/events-v1-order-checkout.types.js.map +0 -1
- package/build/cjs/src/events-v1-order-checkout.universal.js.map +0 -1
- package/build/cjs/src/events-v1-order-orders.http.js.map +0 -1
- package/build/cjs/src/events-v1-order-orders.meta.d.ts +0 -28
- package/build/cjs/src/events-v1-order-orders.meta.js.map +0 -1
- package/build/cjs/src/events-v1-order-orders.public.js +0 -57
- package/build/cjs/src/events-v1-order-orders.public.js.map +0 -1
- package/build/cjs/src/events-v1-order-orders.types.js.map +0 -1
- package/build/cjs/src/events-v1-order-orders.universal.d.ts +0 -3620
- package/build/cjs/src/events-v1-order-orders.universal.js +0 -679
- package/build/cjs/src/events-v1-order-orders.universal.js.map +0 -1
- package/build/es/src/events-v1-order-checkout.http.d.ts +0 -89
- package/build/es/src/events-v1-order-checkout.http.js +0 -1066
- package/build/es/src/events-v1-order-checkout.http.js.map +0 -1
- package/build/es/src/events-v1-order-checkout.meta.js.map +0 -1
- package/build/es/src/events-v1-order-checkout.public.d.ts +0 -15
- package/build/es/src/events-v1-order-checkout.public.js +0 -44
- package/build/es/src/events-v1-order-checkout.public.js.map +0 -1
- package/build/es/src/events-v1-order-checkout.types.d.ts +0 -3631
- package/build/es/src/events-v1-order-checkout.types.js +0 -142
- package/build/es/src/events-v1-order-checkout.types.js.map +0 -1
- package/build/es/src/events-v1-order-checkout.universal.js.map +0 -1
- package/build/es/src/events-v1-order-orders.http.js.map +0 -1
- package/build/es/src/events-v1-order-orders.meta.d.ts +0 -28
- package/build/es/src/events-v1-order-orders.meta.js +0 -110
- package/build/es/src/events-v1-order-orders.meta.js.map +0 -1
- package/build/es/src/events-v1-order-orders.public.js +0 -34
- package/build/es/src/events-v1-order-orders.public.js.map +0 -1
- package/build/es/src/events-v1-order-orders.types.d.ts +0 -3631
- package/build/es/src/events-v1-order-orders.types.js.map +0 -1
- package/build/es/src/events-v1-order-orders.universal.d.ts +0 -3620
- package/build/es/src/events-v1-order-orders.universal.js +0 -647
- package/build/es/src/events-v1-order-orders.universal.js.map +0 -1
- /package/build/cjs/src/{events-v1-order-checkout.types.d.ts → events-v1-order.types.d.ts} +0 -0
- /package/build/{cjs/src/events-v1-order-orders.types.d.ts → es/src/events-v1-order.types.d.ts} +0 -0
|
@@ -0,0 +1,1923 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The form defines which elements are rendered in the Wix UI during the registration process (RSVP or checkout).
|
|
3
|
+
* It also contains customizable messages and labels.
|
|
4
|
+
*
|
|
5
|
+
*
|
|
6
|
+
* A form is an ordered list of controls (blocks), which accept guest information into a field input.
|
|
7
|
+
*
|
|
8
|
+
* Each control contains one or more nested inputs. For example, `Name` control has two inputs:
|
|
9
|
+
* - First Name
|
|
10
|
+
* - Last Name
|
|
11
|
+
*
|
|
12
|
+
* By default, name and email controls are always required and are pinned to the top of the form.
|
|
13
|
+
*/
|
|
14
|
+
export interface Form {
|
|
15
|
+
/** Nested fields as an ordered list. */
|
|
16
|
+
controls?: InputControl[];
|
|
17
|
+
/** Set of configured form messages. */
|
|
18
|
+
messages?: FormMessages;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* A block of nested fields.
|
|
22
|
+
* Used to aggregate similar inputs like First Name and Last Name.
|
|
23
|
+
*/
|
|
24
|
+
export interface InputControl {
|
|
25
|
+
/** Field control type. */
|
|
26
|
+
type?: InputControlType;
|
|
27
|
+
/** Whether control is mandatory (such as name & email). When true, only label can be changed. */
|
|
28
|
+
system?: boolean;
|
|
29
|
+
/** Deprecated: Use `id`. */
|
|
30
|
+
name?: string;
|
|
31
|
+
/** Child inputs. */
|
|
32
|
+
inputs?: Input[];
|
|
33
|
+
/** Deprecated: use `inputs.label`. */
|
|
34
|
+
label?: string;
|
|
35
|
+
/** Field controls are sorted by this value in ascending order. */
|
|
36
|
+
orderIndex?: number;
|
|
37
|
+
/** Unique control ID. */
|
|
38
|
+
_id?: string;
|
|
39
|
+
}
|
|
40
|
+
export declare enum InputControlType {
|
|
41
|
+
/** Single text value field. */
|
|
42
|
+
INPUT = "INPUT",
|
|
43
|
+
/** Single text value field. */
|
|
44
|
+
TEXTAREA = "TEXTAREA",
|
|
45
|
+
/** Single-choice field of predefined values. */
|
|
46
|
+
DROPDOWN = "DROPDOWN",
|
|
47
|
+
/** Single-choice field of predefined values. */
|
|
48
|
+
RADIO = "RADIO",
|
|
49
|
+
/** Multiple-choice field of predefined values. */
|
|
50
|
+
CHECKBOX = "CHECKBOX",
|
|
51
|
+
/** First and last name fields. */
|
|
52
|
+
NAME = "NAME",
|
|
53
|
+
/** Additional guests and respective guest names fields. */
|
|
54
|
+
GUEST_CONTROL = "GUEST_CONTROL",
|
|
55
|
+
/** Single-line address field. */
|
|
56
|
+
ADDRESS_SHORT = "ADDRESS_SHORT",
|
|
57
|
+
/** Full address field. */
|
|
58
|
+
ADDRESS_FULL = "ADDRESS_FULL",
|
|
59
|
+
/** Year, month and day fields. */
|
|
60
|
+
DATE = "DATE"
|
|
61
|
+
}
|
|
62
|
+
/** An input of one or multiple text values */
|
|
63
|
+
export interface Input {
|
|
64
|
+
/** Field name. */
|
|
65
|
+
name?: string;
|
|
66
|
+
/** Deprecated: use `ValueType.TEXT_ARRAY`. */
|
|
67
|
+
array?: boolean;
|
|
68
|
+
/** Main field label */
|
|
69
|
+
label?: string;
|
|
70
|
+
/** Additional labels for multi-valued fields such as address. */
|
|
71
|
+
additionalLabels?: Record<string, string>;
|
|
72
|
+
/** Predefined choice options for fields, such as dropdown. */
|
|
73
|
+
options?: string[];
|
|
74
|
+
/** Whether field is mandatory. */
|
|
75
|
+
mandatory?: boolean;
|
|
76
|
+
/** Maximum number of accepted characters (relevant for text fields). */
|
|
77
|
+
maxLength?: number;
|
|
78
|
+
/**
|
|
79
|
+
* Type which determines field format.
|
|
80
|
+
* Used to validate submitted response.
|
|
81
|
+
*/
|
|
82
|
+
type?: ValueType;
|
|
83
|
+
/**
|
|
84
|
+
* A maximum accepted values for array input.
|
|
85
|
+
* Only applicable for inputs of valueType: TEXT_ARRAY.
|
|
86
|
+
*/
|
|
87
|
+
maxSize?: number | null;
|
|
88
|
+
/**
|
|
89
|
+
* Preselected option.
|
|
90
|
+
* Currently only applicable for dropdown.
|
|
91
|
+
*/
|
|
92
|
+
defaultOptionSelection?: OptionSelection;
|
|
93
|
+
/**
|
|
94
|
+
* Additional labels for multi-valued fields such as address.
|
|
95
|
+
* @readonly
|
|
96
|
+
*/
|
|
97
|
+
labels?: Label[];
|
|
98
|
+
}
|
|
99
|
+
export declare enum ValueType {
|
|
100
|
+
TEXT = "TEXT",
|
|
101
|
+
NUMBER = "NUMBER",
|
|
102
|
+
TEXT_ARRAY = "TEXT_ARRAY",
|
|
103
|
+
DATE_TIME = "DATE_TIME",
|
|
104
|
+
ADDRESS = "ADDRESS"
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* Describes initially selected option when an input has multiple choices.
|
|
108
|
+
* Defaults to first (0th) option if not configured.
|
|
109
|
+
*/
|
|
110
|
+
export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
111
|
+
/** 0-based index from predefined `input.options` which is selected initially. */
|
|
112
|
+
optionIndex?: number;
|
|
113
|
+
/**
|
|
114
|
+
* Placeholder hint describing expected choices (such as "Please select").
|
|
115
|
+
* Considered an empty choice.
|
|
116
|
+
*/
|
|
117
|
+
placeholderText?: string;
|
|
118
|
+
}
|
|
119
|
+
/** @oneof */
|
|
120
|
+
export interface OptionSelectionSelectedOptionOneOf {
|
|
121
|
+
/** 0-based index from predefined `input.options` which is selected initially. */
|
|
122
|
+
optionIndex?: number;
|
|
123
|
+
/**
|
|
124
|
+
* Placeholder hint describing expected choices (such as "Please select").
|
|
125
|
+
* Considered an empty choice.
|
|
126
|
+
*/
|
|
127
|
+
placeholderText?: string;
|
|
128
|
+
}
|
|
129
|
+
export interface Label {
|
|
130
|
+
/** Field name. */
|
|
131
|
+
name?: string;
|
|
132
|
+
/** Field label. */
|
|
133
|
+
label?: string;
|
|
134
|
+
}
|
|
135
|
+
/**
|
|
136
|
+
* Defines form messages shown in UI before, during, and after registration flow.
|
|
137
|
+
* It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
138
|
+
*/
|
|
139
|
+
export interface FormMessages {
|
|
140
|
+
/** RSVP form messages. */
|
|
141
|
+
rsvp?: RsvpFormMessages;
|
|
142
|
+
/** Checkout form messages. */
|
|
143
|
+
checkout?: CheckoutFormMessages;
|
|
144
|
+
/** Messages shown when event registration is closed. */
|
|
145
|
+
registrationClosed?: RegistrationClosedMessages;
|
|
146
|
+
/** Messages shown when event tickets are unavailable. */
|
|
147
|
+
ticketsUnavailable?: TicketsUnavailableMessages;
|
|
148
|
+
}
|
|
149
|
+
export interface RsvpFormMessages {
|
|
150
|
+
/** Label text indicating RSVP `YES` response. */
|
|
151
|
+
rsvpYesOption?: string;
|
|
152
|
+
/** Label text indicating RSVP `NO` response. */
|
|
153
|
+
rsvpNoOption?: string;
|
|
154
|
+
/** Messages shown for RSVP = `YES`. */
|
|
155
|
+
positiveMessages?: Positive;
|
|
156
|
+
/** Messages shown for RSVP = `WAITING` (when event is full and waitlist is available). */
|
|
157
|
+
waitlistMessages?: Positive;
|
|
158
|
+
/** Messages shown for RSVP = `NO`. */
|
|
159
|
+
negativeMessages?: Negative;
|
|
160
|
+
/** "Submit form" call-to-action label text. */
|
|
161
|
+
submitActionLabel?: string;
|
|
162
|
+
}
|
|
163
|
+
/** Confirmation messages shown after registration. */
|
|
164
|
+
export interface PositiveResponseConfirmation {
|
|
165
|
+
/** Confirmation message title. */
|
|
166
|
+
title?: string;
|
|
167
|
+
/** Confirmation message text. */
|
|
168
|
+
message?: string;
|
|
169
|
+
/** "Add to calendar" call-to-action label text. */
|
|
170
|
+
addToCalendarActionLabel?: string;
|
|
171
|
+
/** "Share event" call-to-action label text. */
|
|
172
|
+
shareActionLabel?: string;
|
|
173
|
+
}
|
|
174
|
+
/** Confirmation messages shown after registration. */
|
|
175
|
+
export interface NegativeResponseConfirmation {
|
|
176
|
+
/** Confirmation message title. */
|
|
177
|
+
title?: string;
|
|
178
|
+
/** "Share event" call-to-action label text. */
|
|
179
|
+
shareActionLabel?: string;
|
|
180
|
+
}
|
|
181
|
+
/** Set of messages shown during registration when RSVP response is positive. */
|
|
182
|
+
export interface Positive {
|
|
183
|
+
/** Main form title for positive response. */
|
|
184
|
+
title?: string;
|
|
185
|
+
/** Confirmation messages shown after registration. */
|
|
186
|
+
confirmation?: PositiveResponseConfirmation;
|
|
187
|
+
}
|
|
188
|
+
/** A set of messages shown during registration with negative response */
|
|
189
|
+
export interface Negative {
|
|
190
|
+
/** Main form title for negative response. */
|
|
191
|
+
title?: string;
|
|
192
|
+
/** Confirmation messages shown after registration. */
|
|
193
|
+
confirmation?: NegativeResponseConfirmation;
|
|
194
|
+
}
|
|
195
|
+
export interface CheckoutFormMessages {
|
|
196
|
+
/** Main form title for response. */
|
|
197
|
+
title?: string;
|
|
198
|
+
/** Submit form call-to-action label text. */
|
|
199
|
+
submitActionLabel?: string;
|
|
200
|
+
/** Confirmation messages shown after checkout. */
|
|
201
|
+
confirmation?: ResponseConfirmation;
|
|
202
|
+
}
|
|
203
|
+
/** Confirmation messages shown after checkout. */
|
|
204
|
+
export interface ResponseConfirmation {
|
|
205
|
+
/** Confirmation message title. */
|
|
206
|
+
title?: string;
|
|
207
|
+
/** Confirmation message text. */
|
|
208
|
+
message?: string;
|
|
209
|
+
/** "Download tickets" call-to-action label text. */
|
|
210
|
+
downloadTicketsLabel?: string;
|
|
211
|
+
/** "Add to calendar" call-to-action label text. */
|
|
212
|
+
addToCalendarLabel?: string;
|
|
213
|
+
/** "Share event" call-to-action label text. */
|
|
214
|
+
shareEventLabel?: string;
|
|
215
|
+
}
|
|
216
|
+
export interface RegistrationClosedMessages {
|
|
217
|
+
/** Message shown when event registration is closed. */
|
|
218
|
+
message?: string;
|
|
219
|
+
/** "Explore other events" call-to-action label text. */
|
|
220
|
+
exploreEventsActionLabel?: string;
|
|
221
|
+
}
|
|
222
|
+
export interface TicketsUnavailableMessages {
|
|
223
|
+
/** Message shown when event tickets are unavailable. */
|
|
224
|
+
message?: string;
|
|
225
|
+
/** "Explore other events" call-to-action label text. */
|
|
226
|
+
exploreEventsActionLabel?: string;
|
|
227
|
+
}
|
|
228
|
+
export interface FormInputControlAdded {
|
|
229
|
+
/** Event ID. */
|
|
230
|
+
eventId?: string;
|
|
231
|
+
/** Input control. */
|
|
232
|
+
inputControl?: InputControl;
|
|
233
|
+
}
|
|
234
|
+
export interface FormInputControlUpdated {
|
|
235
|
+
/** Event ID. */
|
|
236
|
+
eventId?: string;
|
|
237
|
+
/** Input control. */
|
|
238
|
+
updatedInputControl?: InputControl;
|
|
239
|
+
}
|
|
240
|
+
export interface FormInputControlDeleted {
|
|
241
|
+
/** Event ID. */
|
|
242
|
+
eventId?: string;
|
|
243
|
+
/** Input control. */
|
|
244
|
+
deletedInputControl?: InputControl;
|
|
245
|
+
}
|
|
246
|
+
export interface GetFormRequest {
|
|
247
|
+
/** Event ID. */
|
|
248
|
+
eventId: string;
|
|
249
|
+
}
|
|
250
|
+
export interface GetFormResponse {
|
|
251
|
+
/**
|
|
252
|
+
* Currently published event form.
|
|
253
|
+
* Published form is visible to site visitors.
|
|
254
|
+
*/
|
|
255
|
+
form?: Form;
|
|
256
|
+
/**
|
|
257
|
+
* Draft event form.
|
|
258
|
+
* Not available to visitors unless published.
|
|
259
|
+
*/
|
|
260
|
+
draftForm?: Form;
|
|
261
|
+
}
|
|
262
|
+
export interface AddControlRequest extends AddControlRequestControlOneOf {
|
|
263
|
+
/** Phone number input control. */
|
|
264
|
+
phone?: PhoneControl;
|
|
265
|
+
/** Single-line or full address input control. */
|
|
266
|
+
address?: AddressControl;
|
|
267
|
+
/** Day, month, year date input control. */
|
|
268
|
+
date?: DateControl;
|
|
269
|
+
/** Additional guests input control. */
|
|
270
|
+
additionalGuests?: AdditionalGuestsControl;
|
|
271
|
+
/** Single-choice dropdown style input control. */
|
|
272
|
+
dropdown?: DropdownControl;
|
|
273
|
+
/** Multiple-choice checkbox style input control. */
|
|
274
|
+
checkbox?: CheckboxControl;
|
|
275
|
+
/** Free-form text input control. */
|
|
276
|
+
text?: TextControl;
|
|
277
|
+
/** Single-choice radio button style input control. */
|
|
278
|
+
radioButton?: RadioButtonControl;
|
|
279
|
+
/** Event ID. */
|
|
280
|
+
eventId: string;
|
|
281
|
+
}
|
|
282
|
+
/** @oneof */
|
|
283
|
+
export interface AddControlRequestControlOneOf {
|
|
284
|
+
/** Phone number input control. */
|
|
285
|
+
phone?: PhoneControl;
|
|
286
|
+
/** Single-line or full address input control. */
|
|
287
|
+
address?: AddressControl;
|
|
288
|
+
/** Day, month, year date input control. */
|
|
289
|
+
date?: DateControl;
|
|
290
|
+
/** Additional guests input control. */
|
|
291
|
+
additionalGuests?: AdditionalGuestsControl;
|
|
292
|
+
/** Single-choice dropdown style input control. */
|
|
293
|
+
dropdown?: DropdownControl;
|
|
294
|
+
/** Multiple-choice checkbox style input control. */
|
|
295
|
+
checkbox?: CheckboxControl;
|
|
296
|
+
/** Free-form text input control. */
|
|
297
|
+
text?: TextControl;
|
|
298
|
+
/** Single-choice radio button style input control. */
|
|
299
|
+
radioButton?: RadioButtonControl;
|
|
300
|
+
}
|
|
301
|
+
export interface PhoneControl {
|
|
302
|
+
/** Phone input label. */
|
|
303
|
+
label?: string;
|
|
304
|
+
/** Whether phone input is required. */
|
|
305
|
+
mandatory?: boolean;
|
|
306
|
+
}
|
|
307
|
+
export interface AddressControl {
|
|
308
|
+
/** Address control labels for each input. */
|
|
309
|
+
labels?: AddressControlLabels;
|
|
310
|
+
/** Whether address is multi-line (consisting of multiple fields such as country, city, postal code). When false, address is single-line. */
|
|
311
|
+
full?: boolean;
|
|
312
|
+
/** Whether address input is required. */
|
|
313
|
+
mandatory?: boolean;
|
|
314
|
+
}
|
|
315
|
+
export interface AddressControlLabels {
|
|
316
|
+
/** Single-line address input label. */
|
|
317
|
+
addressLine?: string;
|
|
318
|
+
/** Country input label. */
|
|
319
|
+
country?: string;
|
|
320
|
+
/** Subdivision input label. */
|
|
321
|
+
subdivision?: string;
|
|
322
|
+
/** City input label. */
|
|
323
|
+
city?: string;
|
|
324
|
+
/** Postal code input label. */
|
|
325
|
+
postalCode?: string;
|
|
326
|
+
/** Street address input label. */
|
|
327
|
+
streetAddress?: string;
|
|
328
|
+
}
|
|
329
|
+
export interface DateControl {
|
|
330
|
+
/** Input control label. */
|
|
331
|
+
label?: string;
|
|
332
|
+
/** Whether date input is required */
|
|
333
|
+
mandatory?: boolean;
|
|
334
|
+
}
|
|
335
|
+
export interface AdditionalGuestsControl {
|
|
336
|
+
/** Additional guests control labels for each input. */
|
|
337
|
+
labels?: Labels;
|
|
338
|
+
/** Whether individual guest names are required. */
|
|
339
|
+
namesMandatory?: boolean;
|
|
340
|
+
/** Maximum number of additional guests. */
|
|
341
|
+
maxGuests?: number;
|
|
342
|
+
}
|
|
343
|
+
export interface Labels {
|
|
344
|
+
/** Input label for a single guest. */
|
|
345
|
+
single?: string;
|
|
346
|
+
/** Input label for multiple guests. */
|
|
347
|
+
multiple?: string;
|
|
348
|
+
}
|
|
349
|
+
export interface DropdownControl {
|
|
350
|
+
/** Input control label. */
|
|
351
|
+
label?: string;
|
|
352
|
+
/** Predefined options guests can choose from. */
|
|
353
|
+
options?: string[];
|
|
354
|
+
/** Whether choice is required. */
|
|
355
|
+
mandatory?: boolean;
|
|
356
|
+
/** Preselected option. */
|
|
357
|
+
defaultOptionSelection?: OptionSelection;
|
|
358
|
+
}
|
|
359
|
+
export interface RadioButtonControl {
|
|
360
|
+
/** Input control label. */
|
|
361
|
+
label?: string;
|
|
362
|
+
/** Predefined options guests can choose from. */
|
|
363
|
+
options?: string[];
|
|
364
|
+
}
|
|
365
|
+
export interface CheckboxControl {
|
|
366
|
+
/** Input control label. */
|
|
367
|
+
label?: string;
|
|
368
|
+
/** Whether at least one checkbox is required. */
|
|
369
|
+
mandatory?: boolean;
|
|
370
|
+
/** Predefined options guests can choose from. */
|
|
371
|
+
options?: string[];
|
|
372
|
+
}
|
|
373
|
+
export interface TextControl {
|
|
374
|
+
/** Input control label. */
|
|
375
|
+
label?: string;
|
|
376
|
+
/** Whether text input is required. */
|
|
377
|
+
mandatory?: boolean;
|
|
378
|
+
/** Maximum number of characters allowed. */
|
|
379
|
+
maxLength?: number;
|
|
380
|
+
/** Whether input control should allow multiple lines in text. */
|
|
381
|
+
multiLine?: boolean;
|
|
382
|
+
/** Whether input control should be displayed as a comment. */
|
|
383
|
+
comment?: boolean;
|
|
384
|
+
}
|
|
385
|
+
export interface AddControlResponse {
|
|
386
|
+
/** Generated unique input control ID. */
|
|
387
|
+
_id?: string;
|
|
388
|
+
/** Modified draft event form. */
|
|
389
|
+
form?: Form;
|
|
390
|
+
}
|
|
391
|
+
export interface UpdateControlRequest extends UpdateControlRequestControlOneOf {
|
|
392
|
+
/** Phone number input control. */
|
|
393
|
+
phone?: PhoneControl;
|
|
394
|
+
/** Single-line or full address input control. */
|
|
395
|
+
address?: AddressControl;
|
|
396
|
+
/** Day, month, year date input control. */
|
|
397
|
+
date?: DateControl;
|
|
398
|
+
/** Additional guests input control. */
|
|
399
|
+
additionalGuests?: AdditionalGuestsControl;
|
|
400
|
+
/** Single-choice dropdown style input control. */
|
|
401
|
+
dropdown?: DropdownControl;
|
|
402
|
+
/** Multiple-choice checkbox style input control. */
|
|
403
|
+
checkbox?: CheckboxControl;
|
|
404
|
+
/** Free-form text input control. */
|
|
405
|
+
text?: TextControl;
|
|
406
|
+
/** Main guest name input control. */
|
|
407
|
+
name?: NameControl;
|
|
408
|
+
/** Main guest email input control. */
|
|
409
|
+
email?: EmailControl;
|
|
410
|
+
/** Single-choice radio style input control. */
|
|
411
|
+
radioButton?: RadioButtonControl;
|
|
412
|
+
/** Event ID. */
|
|
413
|
+
eventId: string;
|
|
414
|
+
/** Unique input control ID. */
|
|
415
|
+
_id: string;
|
|
416
|
+
/** Index used to sort input controls in ascending order. */
|
|
417
|
+
orderIndex?: number;
|
|
418
|
+
}
|
|
419
|
+
/** @oneof */
|
|
420
|
+
export interface UpdateControlRequestControlOneOf {
|
|
421
|
+
/** Phone number input control. */
|
|
422
|
+
phone?: PhoneControl;
|
|
423
|
+
/** Single-line or full address input control. */
|
|
424
|
+
address?: AddressControl;
|
|
425
|
+
/** Day, month, year date input control. */
|
|
426
|
+
date?: DateControl;
|
|
427
|
+
/** Additional guests input control. */
|
|
428
|
+
additionalGuests?: AdditionalGuestsControl;
|
|
429
|
+
/** Single-choice dropdown style input control. */
|
|
430
|
+
dropdown?: DropdownControl;
|
|
431
|
+
/** Multiple-choice checkbox style input control. */
|
|
432
|
+
checkbox?: CheckboxControl;
|
|
433
|
+
/** Free-form text input control. */
|
|
434
|
+
text?: TextControl;
|
|
435
|
+
/** Main guest name input control. */
|
|
436
|
+
name?: NameControl;
|
|
437
|
+
/** Main guest email input control. */
|
|
438
|
+
email?: EmailControl;
|
|
439
|
+
/** Single-choice radio style input control. */
|
|
440
|
+
radioButton?: RadioButtonControl;
|
|
441
|
+
}
|
|
442
|
+
export interface NameControl {
|
|
443
|
+
/** Name control labels of each input */
|
|
444
|
+
labels?: NameControlLabels;
|
|
445
|
+
}
|
|
446
|
+
export interface NameControlLabels {
|
|
447
|
+
/** First name input label */
|
|
448
|
+
firstName?: string;
|
|
449
|
+
/** Last name input label */
|
|
450
|
+
lastName?: string;
|
|
451
|
+
}
|
|
452
|
+
export interface EmailControl {
|
|
453
|
+
/** Email input label. */
|
|
454
|
+
label?: string;
|
|
455
|
+
}
|
|
456
|
+
export interface UpdateControlResponse {
|
|
457
|
+
/** Modified draft event form. */
|
|
458
|
+
form?: Form;
|
|
459
|
+
}
|
|
460
|
+
export interface DeleteControlRequest {
|
|
461
|
+
/** Event ID. */
|
|
462
|
+
eventId: string;
|
|
463
|
+
/** Unique input control ID. */
|
|
464
|
+
_id: string;
|
|
465
|
+
}
|
|
466
|
+
export interface DeleteControlResponse {
|
|
467
|
+
/** Modified draft event form */
|
|
468
|
+
form?: Form;
|
|
469
|
+
}
|
|
470
|
+
export interface UpdateMessagesRequest {
|
|
471
|
+
/** Event ID. */
|
|
472
|
+
eventId: string;
|
|
473
|
+
/** Set of configured form messages. */
|
|
474
|
+
messages?: FormMessages;
|
|
475
|
+
}
|
|
476
|
+
export interface UpdateMessagesResponse {
|
|
477
|
+
/** Modified draft event form. */
|
|
478
|
+
form?: Form;
|
|
479
|
+
}
|
|
480
|
+
export interface PublishDraftRequest {
|
|
481
|
+
/** Event ID. */
|
|
482
|
+
eventId: string;
|
|
483
|
+
}
|
|
484
|
+
export interface PublishDraftResponse {
|
|
485
|
+
/** Published event form. */
|
|
486
|
+
form?: Form;
|
|
487
|
+
}
|
|
488
|
+
export interface EventUpdated {
|
|
489
|
+
/** Event update timestamp in ISO UTC format. */
|
|
490
|
+
timestamp?: Date;
|
|
491
|
+
/** Event ID. */
|
|
492
|
+
eventId?: string;
|
|
493
|
+
/** Event location. */
|
|
494
|
+
location?: Location;
|
|
495
|
+
/** Event schedule configuration. */
|
|
496
|
+
scheduleConfig?: ScheduleConfig;
|
|
497
|
+
/** Event title. */
|
|
498
|
+
title?: string;
|
|
499
|
+
/** Whether schedule configuration was updated. */
|
|
500
|
+
scheduleConfigUpdated?: boolean;
|
|
501
|
+
/** Updated event */
|
|
502
|
+
event?: Event;
|
|
503
|
+
}
|
|
504
|
+
export interface Location {
|
|
505
|
+
/** Location name. */
|
|
506
|
+
name?: string | null;
|
|
507
|
+
/** Location map coordinates. */
|
|
508
|
+
coordinates?: MapCoordinates;
|
|
509
|
+
/** Single line address representation. */
|
|
510
|
+
address?: string | null;
|
|
511
|
+
/** Location type. */
|
|
512
|
+
type?: LocationType;
|
|
513
|
+
/**
|
|
514
|
+
* Full address derived from formatted single line `address`.
|
|
515
|
+
* When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
|
|
516
|
+
* If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.
|
|
517
|
+
*
|
|
518
|
+
* Migration notes:
|
|
519
|
+
* - `full_address.formatted_address` is equivalent to `address`.
|
|
520
|
+
* - `full_address.geocode` is equivalent to `coordinates`.
|
|
521
|
+
*/
|
|
522
|
+
fullAddress?: Address;
|
|
523
|
+
/**
|
|
524
|
+
* Defines event location as TBD (To Be Determined).
|
|
525
|
+
* When event location is not yet defined, `name` is displayed instead of location address.
|
|
526
|
+
* `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.
|
|
527
|
+
*/
|
|
528
|
+
tbd?: boolean | null;
|
|
529
|
+
}
|
|
530
|
+
export interface MapCoordinates {
|
|
531
|
+
/** Latitude. */
|
|
532
|
+
lat?: number;
|
|
533
|
+
/** Longitude. */
|
|
534
|
+
lng?: number;
|
|
535
|
+
}
|
|
536
|
+
export declare enum LocationType {
|
|
537
|
+
VENUE = "VENUE",
|
|
538
|
+
ONLINE = "ONLINE"
|
|
539
|
+
}
|
|
540
|
+
/** Physical address */
|
|
541
|
+
export interface Address extends AddressStreetOneOf {
|
|
542
|
+
/** a break down of the street to number and street name */
|
|
543
|
+
streetAddress?: StreetAddress;
|
|
544
|
+
/** Main address line (usually street and number) as free text */
|
|
545
|
+
addressLine1?: string | null;
|
|
546
|
+
/** country code */
|
|
547
|
+
country?: string | null;
|
|
548
|
+
/** subdivision (usually state or region) code according to ISO 3166-2 */
|
|
549
|
+
subdivision?: string | null;
|
|
550
|
+
/** city name */
|
|
551
|
+
city?: string | null;
|
|
552
|
+
/** zip/postal code */
|
|
553
|
+
postalCode?: string | null;
|
|
554
|
+
/** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
|
|
555
|
+
addressLine2?: string | null;
|
|
556
|
+
/** A string containing the human-readable address of this location */
|
|
557
|
+
formatted?: string | null;
|
|
558
|
+
/** coordinates of the physical address */
|
|
559
|
+
location?: AddressLocation;
|
|
560
|
+
}
|
|
561
|
+
/** @oneof */
|
|
562
|
+
export interface AddressStreetOneOf {
|
|
563
|
+
/** a break down of the street to number and street name */
|
|
564
|
+
streetAddress?: StreetAddress;
|
|
565
|
+
/** Main address line (usually street and number) as free text */
|
|
566
|
+
addressLine?: string | null;
|
|
567
|
+
}
|
|
568
|
+
export interface StreetAddress {
|
|
569
|
+
/** street number */
|
|
570
|
+
number?: string;
|
|
571
|
+
/** street name */
|
|
572
|
+
name?: string;
|
|
573
|
+
}
|
|
574
|
+
export interface AddressLocation {
|
|
575
|
+
/** address latitude coordinates */
|
|
576
|
+
latitude?: number | null;
|
|
577
|
+
/** address longitude coordinates */
|
|
578
|
+
longitude?: number | null;
|
|
579
|
+
}
|
|
580
|
+
export interface Subdivision {
|
|
581
|
+
/** subdivision short code */
|
|
582
|
+
code?: string;
|
|
583
|
+
/** subdivision full-name */
|
|
584
|
+
name?: string;
|
|
585
|
+
}
|
|
586
|
+
export declare enum SubdivisionType {
|
|
587
|
+
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
588
|
+
/** State */
|
|
589
|
+
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
590
|
+
/** County */
|
|
591
|
+
ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
|
|
592
|
+
/** City/town */
|
|
593
|
+
ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
|
|
594
|
+
/** Neighborhood/quarter */
|
|
595
|
+
ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
|
|
596
|
+
/** Street/block */
|
|
597
|
+
ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
|
|
598
|
+
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
599
|
+
COUNTRY = "COUNTRY"
|
|
600
|
+
}
|
|
601
|
+
export interface ScheduleConfig {
|
|
602
|
+
/**
|
|
603
|
+
* Defines event as TBD (To Be Determined) schedule.
|
|
604
|
+
* When event time is not yet defined, TBD message is displayed instead of event start and end times.
|
|
605
|
+
* `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
|
|
606
|
+
*/
|
|
607
|
+
scheduleTbd?: boolean;
|
|
608
|
+
/** TBD message. */
|
|
609
|
+
scheduleTbdMessage?: string | null;
|
|
610
|
+
/** Event start timestamp. */
|
|
611
|
+
startDate?: Date;
|
|
612
|
+
/** Event end timestamp. */
|
|
613
|
+
endDate?: Date;
|
|
614
|
+
/** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
|
|
615
|
+
timeZoneId?: string | null;
|
|
616
|
+
/** Whether end date is hidden in the formatted schedule. */
|
|
617
|
+
endDateHidden?: boolean;
|
|
618
|
+
/** Whether time zone is displayed in formatted schedule. */
|
|
619
|
+
showTimeZone?: boolean;
|
|
620
|
+
/** Event recurrences. */
|
|
621
|
+
recurrences?: Recurrences;
|
|
622
|
+
}
|
|
623
|
+
export interface Recurrences {
|
|
624
|
+
/** Event occurrences. */
|
|
625
|
+
occurrences?: Occurrence[];
|
|
626
|
+
/**
|
|
627
|
+
* Recurring event category ID.
|
|
628
|
+
* @readonly
|
|
629
|
+
*/
|
|
630
|
+
categoryId?: string | null;
|
|
631
|
+
/**
|
|
632
|
+
* Recurrence status.
|
|
633
|
+
* @readonly
|
|
634
|
+
*/
|
|
635
|
+
status?: Status;
|
|
636
|
+
}
|
|
637
|
+
export interface Occurrence {
|
|
638
|
+
/** Event start timestamp. */
|
|
639
|
+
startDate?: Date;
|
|
640
|
+
/** Event end timestamp. */
|
|
641
|
+
endDate?: Date;
|
|
642
|
+
/** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
|
|
643
|
+
timeZoneId?: string | null;
|
|
644
|
+
/** Whether time zone is displayed in formatted schedule. */
|
|
645
|
+
showTimeZone?: boolean;
|
|
646
|
+
}
|
|
647
|
+
export declare enum Status {
|
|
648
|
+
/** Event occurs only once. */
|
|
649
|
+
ONE_TIME = "ONE_TIME",
|
|
650
|
+
/** Event is recurring. */
|
|
651
|
+
RECURRING = "RECURRING",
|
|
652
|
+
/** Marks the next upcoming occurrence of the recurring event. */
|
|
653
|
+
RECURRING_NEXT = "RECURRING_NEXT",
|
|
654
|
+
/** Marks the most recent ended occurrence of the recurring event. */
|
|
655
|
+
RECURRING_LAST_ENDED = "RECURRING_LAST_ENDED",
|
|
656
|
+
/** Marks the most recent canceled occurrence of the recurring event. */
|
|
657
|
+
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
658
|
+
}
|
|
659
|
+
export interface Event {
|
|
660
|
+
/**
|
|
661
|
+
* Event ID.
|
|
662
|
+
* @readonly
|
|
663
|
+
*/
|
|
664
|
+
_id?: string;
|
|
665
|
+
/** Event location. */
|
|
666
|
+
location?: Location;
|
|
667
|
+
/** Event scheduling. */
|
|
668
|
+
scheduling?: Scheduling;
|
|
669
|
+
/** Event title. */
|
|
670
|
+
title?: string;
|
|
671
|
+
/** Event description. */
|
|
672
|
+
description?: string;
|
|
673
|
+
/** Rich-text content displayed in Wix UI - "About Event" section (HTML). */
|
|
674
|
+
about?: string;
|
|
675
|
+
/** Main event image. */
|
|
676
|
+
mainImage?: string;
|
|
677
|
+
/** Event slug URL (generated from event title). */
|
|
678
|
+
slug?: string;
|
|
679
|
+
/** ISO 639-1 language code of the event (used in content translations). */
|
|
680
|
+
language?: string;
|
|
681
|
+
/** Event creation timestamp. */
|
|
682
|
+
created?: Date;
|
|
683
|
+
/** Event modified timestamp. */
|
|
684
|
+
modified?: Date;
|
|
685
|
+
/** Event status. */
|
|
686
|
+
status?: EventStatus;
|
|
687
|
+
/** RSVP or ticketing registration details. */
|
|
688
|
+
registration?: Registration;
|
|
689
|
+
/** "Add to calendar" URLs. */
|
|
690
|
+
calendarLinks?: CalendarLinks;
|
|
691
|
+
/** Event page URL components. */
|
|
692
|
+
eventPageUrl?: SiteUrl;
|
|
693
|
+
/** Event registration form. */
|
|
694
|
+
form?: Form;
|
|
695
|
+
/** Event dashboard summary of RSVP / ticket sales. */
|
|
696
|
+
dashboard?: Dashboard;
|
|
697
|
+
/** Instance ID of the site where event is hosted. */
|
|
698
|
+
instanceId?: string;
|
|
699
|
+
/** Guest list configuration. */
|
|
700
|
+
guestListConfig?: GuestListConfig;
|
|
701
|
+
/** Event creator user ID. */
|
|
702
|
+
userId?: string;
|
|
703
|
+
/** Event discussion feed. For internal use. */
|
|
704
|
+
feed?: Feed;
|
|
705
|
+
/** Online conferencing details. */
|
|
706
|
+
onlineConferencing?: OnlineConferencing;
|
|
707
|
+
/** SEO settings. */
|
|
708
|
+
seoSettings?: SeoSettings;
|
|
709
|
+
/** Assigned contacts label key. */
|
|
710
|
+
assignedContactsLabel?: string | null;
|
|
711
|
+
/** Agenda details. */
|
|
712
|
+
agenda?: Agenda;
|
|
713
|
+
/** Categories this event is assigned to. */
|
|
714
|
+
categories?: Category[];
|
|
715
|
+
/** Visual settings for event. */
|
|
716
|
+
eventDisplaySettings?: EventDisplaySettings;
|
|
717
|
+
}
|
|
718
|
+
export interface Scheduling {
|
|
719
|
+
/** Schedule configuration. */
|
|
720
|
+
config?: ScheduleConfig;
|
|
721
|
+
/** Formatted schedule representation. */
|
|
722
|
+
formatted?: string;
|
|
723
|
+
/** Formatted start date of the event (empty for TBD schedules). */
|
|
724
|
+
startDateFormatted?: string;
|
|
725
|
+
/** Formatted start time of the event (empty for TBD schedules). */
|
|
726
|
+
startTimeFormatted?: string;
|
|
727
|
+
/** Formatted end date of the event (empty for TBD schedules or when end date is hidden). */
|
|
728
|
+
endDateFormatted?: string;
|
|
729
|
+
/** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */
|
|
730
|
+
endTimeFormatted?: string;
|
|
731
|
+
}
|
|
732
|
+
export declare enum EventStatus {
|
|
733
|
+
/** Event is public and scheduled to start */
|
|
734
|
+
SCHEDULED = "SCHEDULED",
|
|
735
|
+
/** Event has started */
|
|
736
|
+
STARTED = "STARTED",
|
|
737
|
+
/** Event has ended */
|
|
738
|
+
ENDED = "ENDED",
|
|
739
|
+
/** Event was canceled */
|
|
740
|
+
CANCELED = "CANCELED",
|
|
741
|
+
/** Event is not public and needs to be published */
|
|
742
|
+
DRAFT = "DRAFT"
|
|
743
|
+
}
|
|
744
|
+
export interface Registration {
|
|
745
|
+
/** Event type. */
|
|
746
|
+
type?: EventType;
|
|
747
|
+
/** Event registration status. */
|
|
748
|
+
status?: RegistrationStatus;
|
|
749
|
+
/** RSVP collection details. */
|
|
750
|
+
rsvpCollection?: RsvpCollection;
|
|
751
|
+
/** Ticketing details. */
|
|
752
|
+
ticketing?: Ticketing;
|
|
753
|
+
/** External registration details. */
|
|
754
|
+
external?: ExternalEvent;
|
|
755
|
+
/** Types of users allowed to register. */
|
|
756
|
+
restrictedTo?: VisitorType;
|
|
757
|
+
/** Initial event type which was set when creating an event. */
|
|
758
|
+
initialType?: EventType;
|
|
759
|
+
}
|
|
760
|
+
export declare enum EventType {
|
|
761
|
+
/** Type not available for this request fieldset */
|
|
762
|
+
NA_EVENT_TYPE = "NA_EVENT_TYPE",
|
|
763
|
+
/** Registration via RSVP */
|
|
764
|
+
RSVP = "RSVP",
|
|
765
|
+
/** Registration via ticket purchase */
|
|
766
|
+
TICKETS = "TICKETS",
|
|
767
|
+
/** External registration */
|
|
768
|
+
EXTERNAL = "EXTERNAL",
|
|
769
|
+
/** Registration not available */
|
|
770
|
+
NO_REGISTRATION = "NO_REGISTRATION"
|
|
771
|
+
}
|
|
772
|
+
export declare enum RegistrationStatus {
|
|
773
|
+
/** Registration status is not applicable */
|
|
774
|
+
NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
|
|
775
|
+
/** Registration to event is closed */
|
|
776
|
+
CLOSED = "CLOSED",
|
|
777
|
+
/** Registration to event is closed manually */
|
|
778
|
+
CLOSED_MANUALLY = "CLOSED_MANUALLY",
|
|
779
|
+
/** Registration is open via RSVP */
|
|
780
|
+
OPEN_RSVP = "OPEN_RSVP",
|
|
781
|
+
/** Registration to event waitlist is open via RSVP */
|
|
782
|
+
OPEN_RSVP_WAITLIST = "OPEN_RSVP_WAITLIST",
|
|
783
|
+
/** Registration is open via ticket purchase */
|
|
784
|
+
OPEN_TICKETS = "OPEN_TICKETS",
|
|
785
|
+
/** Registration is open via external URL */
|
|
786
|
+
OPEN_EXTERNAL = "OPEN_EXTERNAL",
|
|
787
|
+
/** Registration will be open via RSVP */
|
|
788
|
+
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
789
|
+
}
|
|
790
|
+
export interface RsvpCollection {
|
|
791
|
+
/** RSVP collection configuration. */
|
|
792
|
+
config?: RsvpCollectionConfig;
|
|
793
|
+
}
|
|
794
|
+
export interface RsvpCollectionConfig {
|
|
795
|
+
/** Defines the supported RSVP statuses. */
|
|
796
|
+
rsvpStatusOptions?: RsvpStatusOptions;
|
|
797
|
+
/**
|
|
798
|
+
* Total guest limit available to register to the event.
|
|
799
|
+
* Additional guests per RSVP are counted towards total guests.
|
|
800
|
+
*/
|
|
801
|
+
limit?: number | null;
|
|
802
|
+
/** Whether a waitlist is opened when total guest limit is reached, allowing guests to create RSVP with WAITING RSVP status. */
|
|
803
|
+
waitlist?: boolean;
|
|
804
|
+
/** Registration start timestamp. */
|
|
805
|
+
startDate?: Date;
|
|
806
|
+
/** Registration end timestamp. */
|
|
807
|
+
endDate?: Date;
|
|
808
|
+
}
|
|
809
|
+
export declare enum RsvpStatusOptions {
|
|
810
|
+
/** Only YES RSVP status is available for RSVP registration */
|
|
811
|
+
YES_ONLY = "YES_ONLY",
|
|
812
|
+
/** YES and NO RSVP status options are available for the registration */
|
|
813
|
+
YES_AND_NO = "YES_AND_NO"
|
|
814
|
+
}
|
|
815
|
+
export interface Ticketing {
|
|
816
|
+
/** Deprecated. */
|
|
817
|
+
lowestPrice?: string | null;
|
|
818
|
+
/** Deprecated. */
|
|
819
|
+
highestPrice?: string | null;
|
|
820
|
+
/** Currency used in event transactions. */
|
|
821
|
+
currency?: string | null;
|
|
822
|
+
/** Ticketing configuration. */
|
|
823
|
+
config?: TicketingConfig;
|
|
824
|
+
/**
|
|
825
|
+
* Price of lowest priced ticket.
|
|
826
|
+
* @readonly
|
|
827
|
+
*/
|
|
828
|
+
lowestTicketPrice?: Money;
|
|
829
|
+
/**
|
|
830
|
+
* Price of highest priced ticket.
|
|
831
|
+
* @readonly
|
|
832
|
+
*/
|
|
833
|
+
highestTicketPrice?: Money;
|
|
834
|
+
/**
|
|
835
|
+
* Formatted price of lowest priced ticket.
|
|
836
|
+
* @readonly
|
|
837
|
+
*/
|
|
838
|
+
lowestTicketPriceFormatted?: string | null;
|
|
839
|
+
/**
|
|
840
|
+
* Formatted price of highest priced ticket.
|
|
841
|
+
* @readonly
|
|
842
|
+
*/
|
|
843
|
+
highestTicketPriceFormatted?: string | null;
|
|
844
|
+
/**
|
|
845
|
+
* Whether all tickets are sold for this event.
|
|
846
|
+
* @readonly
|
|
847
|
+
*/
|
|
848
|
+
soldOut?: boolean | null;
|
|
849
|
+
}
|
|
850
|
+
export interface TicketingConfig {
|
|
851
|
+
/** Whether the form must be filled out separately for each ticket. */
|
|
852
|
+
guestAssignedTickets?: boolean;
|
|
853
|
+
/** Tax configuration. */
|
|
854
|
+
taxConfig?: TaxConfig;
|
|
855
|
+
/** Limit of tickets that can be purchased per order, default 20. */
|
|
856
|
+
ticketLimitPerOrder?: number;
|
|
857
|
+
/** Duration for which the tickets being bought are reserved. */
|
|
858
|
+
reservationDurationInMinutes?: number | null;
|
|
859
|
+
}
|
|
860
|
+
export interface TaxConfig {
|
|
861
|
+
/** Tax application settings. */
|
|
862
|
+
type?: TaxType;
|
|
863
|
+
/** Tax name. */
|
|
864
|
+
name?: string | null;
|
|
865
|
+
/** Tax rate (e.g.,`21.55`). */
|
|
866
|
+
rate?: string | null;
|
|
867
|
+
/** Applies taxes for donations, default true. */
|
|
868
|
+
appliesToDonations?: boolean | null;
|
|
869
|
+
}
|
|
870
|
+
export declare enum TaxType {
|
|
871
|
+
/** Tax is included in the ticket price */
|
|
872
|
+
INCLUDED = "INCLUDED",
|
|
873
|
+
/** Tax is added to the order at the checkout */
|
|
874
|
+
ADDED = "ADDED",
|
|
875
|
+
/** Tax is added to the final total at the checkout */
|
|
876
|
+
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
877
|
+
}
|
|
878
|
+
export interface Money {
|
|
879
|
+
/** *Deprecated:** Use `value` instead. */
|
|
880
|
+
amount?: string;
|
|
881
|
+
/** ISO 4217 format of the currency i.e. `USD`. */
|
|
882
|
+
currency?: string;
|
|
883
|
+
/** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */
|
|
884
|
+
value?: string | null;
|
|
885
|
+
}
|
|
886
|
+
export interface ExternalEvent {
|
|
887
|
+
/** External event registration URL. */
|
|
888
|
+
registration?: string;
|
|
889
|
+
}
|
|
890
|
+
export declare enum VisitorType {
|
|
891
|
+
/** Site visitor (including member) */
|
|
892
|
+
VISITOR = "VISITOR",
|
|
893
|
+
/** Site member */
|
|
894
|
+
MEMBER = "MEMBER",
|
|
895
|
+
/** Site visitor or member */
|
|
896
|
+
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
|
|
897
|
+
}
|
|
898
|
+
export interface CalendarLinks {
|
|
899
|
+
/** "Add to Google calendar" URL. */
|
|
900
|
+
google?: string;
|
|
901
|
+
/** "Download ICS calendar file" URL. */
|
|
902
|
+
ics?: string;
|
|
903
|
+
}
|
|
904
|
+
/** Site URL components */
|
|
905
|
+
export interface SiteUrl {
|
|
906
|
+
/**
|
|
907
|
+
* Base URL. For premium sites, this will be the domain.
|
|
908
|
+
* For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)
|
|
909
|
+
*/
|
|
910
|
+
base?: string;
|
|
911
|
+
/** The path to that page - e.g `/my-events/weekly-meetup-2` */
|
|
912
|
+
path?: string;
|
|
913
|
+
}
|
|
914
|
+
export interface Dashboard {
|
|
915
|
+
/** Guest RSVP summary. */
|
|
916
|
+
rsvpSummary?: RsvpSummary;
|
|
917
|
+
/**
|
|
918
|
+
* Summary of revenue and tickets sold.
|
|
919
|
+
* (Archived orders are not included).
|
|
920
|
+
*/
|
|
921
|
+
ticketingSummary?: TicketingSummary;
|
|
922
|
+
}
|
|
923
|
+
export interface RsvpSummary {
|
|
924
|
+
/** Total number of RSVPs. */
|
|
925
|
+
total?: number;
|
|
926
|
+
/** Number of RSVPs with status `YES`. */
|
|
927
|
+
yes?: number;
|
|
928
|
+
/** Number of RSVPs with status `NO`. */
|
|
929
|
+
no?: number;
|
|
930
|
+
/** Number of RSVPs in waitlist. */
|
|
931
|
+
waitlist?: number;
|
|
932
|
+
}
|
|
933
|
+
export interface TicketingSummary {
|
|
934
|
+
/** Number of tickets sold. */
|
|
935
|
+
tickets?: number;
|
|
936
|
+
/**
|
|
937
|
+
* Total revenue, excluding fees.
|
|
938
|
+
* (taxes and payment provider fees are not deducted.)
|
|
939
|
+
*/
|
|
940
|
+
revenue?: Money;
|
|
941
|
+
/** Whether currency is locked and cannot be changed (generally occurs after the first order in the specified currency has been created). */
|
|
942
|
+
currencyLocked?: boolean;
|
|
943
|
+
/** Number of orders placed. */
|
|
944
|
+
orders?: number;
|
|
945
|
+
/** Total balance of confirmed transactions. */
|
|
946
|
+
totalSales?: Money;
|
|
947
|
+
}
|
|
948
|
+
export interface GuestListConfig {
|
|
949
|
+
/** Whether members can see other members attending the event (defaults to true). */
|
|
950
|
+
publicGuestList?: boolean;
|
|
951
|
+
}
|
|
952
|
+
export interface Feed {
|
|
953
|
+
/** Event discussion feed token. */
|
|
954
|
+
token?: string;
|
|
955
|
+
}
|
|
956
|
+
export interface OnlineConferencing {
|
|
957
|
+
config?: OnlineConferencingConfig;
|
|
958
|
+
session?: OnlineConferencingSession;
|
|
959
|
+
}
|
|
960
|
+
export interface OnlineConferencingConfig {
|
|
961
|
+
/**
|
|
962
|
+
* Whether online conferencing is enabled (not supported for TBD schedules).
|
|
963
|
+
* When enabled, links to join conferencing are generated and provided to guests.
|
|
964
|
+
*/
|
|
965
|
+
enabled?: boolean;
|
|
966
|
+
/** Conferencing provider ID. */
|
|
967
|
+
providerId?: string | null;
|
|
968
|
+
/** Conference type */
|
|
969
|
+
conferenceType?: ConferenceType;
|
|
970
|
+
}
|
|
971
|
+
export declare enum ConferenceType {
|
|
972
|
+
/** Everyone in the meeting can publish and subscribe video and audio. */
|
|
973
|
+
MEETING = "MEETING",
|
|
974
|
+
/** Guests can only subscribe to video and audio. */
|
|
975
|
+
WEBINAR = "WEBINAR"
|
|
976
|
+
}
|
|
977
|
+
export interface OnlineConferencingSession {
|
|
978
|
+
/**
|
|
979
|
+
* Link for event host to start the online conference session.
|
|
980
|
+
* @readonly
|
|
981
|
+
*/
|
|
982
|
+
hostLink?: string;
|
|
983
|
+
/**
|
|
984
|
+
* Link for guests to join the online conference session.
|
|
985
|
+
* @readonly
|
|
986
|
+
*/
|
|
987
|
+
guestLink?: string;
|
|
988
|
+
/**
|
|
989
|
+
* The password required to join online conferencing session (when relevant).
|
|
990
|
+
* @readonly
|
|
991
|
+
*/
|
|
992
|
+
password?: string | null;
|
|
993
|
+
/**
|
|
994
|
+
* Indicates that session was created successfully on providers side.
|
|
995
|
+
* @readonly
|
|
996
|
+
*/
|
|
997
|
+
sessionCreated?: boolean | null;
|
|
998
|
+
/**
|
|
999
|
+
* Unique session id
|
|
1000
|
+
* @readonly
|
|
1001
|
+
*/
|
|
1002
|
+
sessionId?: string | null;
|
|
1003
|
+
}
|
|
1004
|
+
export interface SeoSettings {
|
|
1005
|
+
/** URL slug */
|
|
1006
|
+
slug?: string;
|
|
1007
|
+
/** Advanced SEO data */
|
|
1008
|
+
advancedSeoData?: SeoSchema;
|
|
1009
|
+
/**
|
|
1010
|
+
* Hidden from SEO Site Map
|
|
1011
|
+
* @readonly
|
|
1012
|
+
*/
|
|
1013
|
+
hidden?: boolean | null;
|
|
1014
|
+
}
|
|
1015
|
+
/**
|
|
1016
|
+
* The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
|
|
1017
|
+
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
1018
|
+
* This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
|
|
1019
|
+
*/
|
|
1020
|
+
export interface SeoSchema {
|
|
1021
|
+
/** SEO tag information. */
|
|
1022
|
+
tags?: Tag[];
|
|
1023
|
+
/** SEO general settings. */
|
|
1024
|
+
settings?: Settings;
|
|
1025
|
+
}
|
|
1026
|
+
export interface Keyword {
|
|
1027
|
+
/** Keyword value. */
|
|
1028
|
+
term?: string;
|
|
1029
|
+
/** Whether the keyword is the main focus keyword. */
|
|
1030
|
+
isMain?: boolean;
|
|
1031
|
+
}
|
|
1032
|
+
export interface Tag {
|
|
1033
|
+
/**
|
|
1034
|
+
* SEO tag type.
|
|
1035
|
+
*
|
|
1036
|
+
*
|
|
1037
|
+
* Supported values: `title`, `meta`, `script`, `link`.
|
|
1038
|
+
*/
|
|
1039
|
+
type?: string;
|
|
1040
|
+
/**
|
|
1041
|
+
* A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.
|
|
1042
|
+
* For example: `{'name': 'description', 'content': 'the description itself'}`.
|
|
1043
|
+
*/
|
|
1044
|
+
props?: Record<string, any> | null;
|
|
1045
|
+
/** SEO tag meta data. For example, `{height: 300, width: 240}`. */
|
|
1046
|
+
meta?: Record<string, any> | null;
|
|
1047
|
+
/** SEO tag inner content. For example, `<title> inner content </title>`. */
|
|
1048
|
+
children?: string;
|
|
1049
|
+
/** Whether the tag is a custom tag. */
|
|
1050
|
+
custom?: boolean;
|
|
1051
|
+
/** Whether the tag is disabled. */
|
|
1052
|
+
disabled?: boolean;
|
|
1053
|
+
}
|
|
1054
|
+
export interface Settings {
|
|
1055
|
+
/**
|
|
1056
|
+
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
1057
|
+
*
|
|
1058
|
+
*
|
|
1059
|
+
* Default: `false` (Auto Redirect is enabled.)
|
|
1060
|
+
*/
|
|
1061
|
+
preventAutoRedirect?: boolean;
|
|
1062
|
+
/** User-selected keyword terms for a specific page. */
|
|
1063
|
+
keywords?: Keyword[];
|
|
1064
|
+
}
|
|
1065
|
+
export interface Agenda {
|
|
1066
|
+
/** Whether the schedule is enabled for the event. */
|
|
1067
|
+
enabled?: boolean;
|
|
1068
|
+
/**
|
|
1069
|
+
* Agenda page URL.
|
|
1070
|
+
* @readonly
|
|
1071
|
+
*/
|
|
1072
|
+
pageUrl?: SiteUrl;
|
|
1073
|
+
}
|
|
1074
|
+
export interface Category {
|
|
1075
|
+
/**
|
|
1076
|
+
* Category ID.
|
|
1077
|
+
* @readonly
|
|
1078
|
+
*/
|
|
1079
|
+
_id?: string;
|
|
1080
|
+
/** Category name. */
|
|
1081
|
+
name?: string;
|
|
1082
|
+
/**
|
|
1083
|
+
* Category creation timestamp.
|
|
1084
|
+
* @readonly
|
|
1085
|
+
*/
|
|
1086
|
+
_createdDate?: Date;
|
|
1087
|
+
/**
|
|
1088
|
+
* Assigned events count. Deleted events are excluded.
|
|
1089
|
+
* @readonly
|
|
1090
|
+
*/
|
|
1091
|
+
assignedEventsCount?: number | null;
|
|
1092
|
+
/**
|
|
1093
|
+
* Assigned and assigned draft event counts.
|
|
1094
|
+
* @readonly
|
|
1095
|
+
*/
|
|
1096
|
+
counts?: CategoryCounts;
|
|
1097
|
+
/**
|
|
1098
|
+
* Category state. Default - MANUAL.
|
|
1099
|
+
* WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission is required to use other states.
|
|
1100
|
+
* Field will be ignored on update requests.
|
|
1101
|
+
*/
|
|
1102
|
+
states?: State[];
|
|
1103
|
+
}
|
|
1104
|
+
export interface CategoryCounts {
|
|
1105
|
+
/** Assigned events count. Deleted events are excluded. */
|
|
1106
|
+
assignedEventsCount?: number | null;
|
|
1107
|
+
/** Assigned draft events count. */
|
|
1108
|
+
assignedDraftEventsCount?: number | null;
|
|
1109
|
+
}
|
|
1110
|
+
export declare enum State {
|
|
1111
|
+
/** Created manually by the user. */
|
|
1112
|
+
MANUAL = "MANUAL",
|
|
1113
|
+
/** Created automatically. */
|
|
1114
|
+
AUTO = "AUTO",
|
|
1115
|
+
/** Created when publishing recurring events. */
|
|
1116
|
+
RECURRING_EVENT = "RECURRING_EVENT",
|
|
1117
|
+
/** Category is hidden. */
|
|
1118
|
+
HIDDEN = "HIDDEN",
|
|
1119
|
+
/** Category is used to store component events. */
|
|
1120
|
+
COMPONENT = "COMPONENT"
|
|
1121
|
+
}
|
|
1122
|
+
export interface EventDisplaySettings {
|
|
1123
|
+
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
1124
|
+
hideEventDetailsButton?: boolean | null;
|
|
1125
|
+
}
|
|
1126
|
+
export interface DiscardDraftRequest {
|
|
1127
|
+
/** Event ID. */
|
|
1128
|
+
eventId: string;
|
|
1129
|
+
}
|
|
1130
|
+
export interface DiscardDraftResponse {
|
|
1131
|
+
}
|
|
1132
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1133
|
+
createdEvent?: EntityCreatedEvent;
|
|
1134
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1135
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1136
|
+
actionEvent?: ActionEvent;
|
|
1137
|
+
/**
|
|
1138
|
+
* Unique event ID.
|
|
1139
|
+
* Allows clients to ignore duplicate webhooks.
|
|
1140
|
+
*/
|
|
1141
|
+
_id?: string;
|
|
1142
|
+
/**
|
|
1143
|
+
* Assumes actions are also always typed to an entity_type
|
|
1144
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1145
|
+
*/
|
|
1146
|
+
entityFqdn?: string;
|
|
1147
|
+
/**
|
|
1148
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1149
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1150
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
1151
|
+
*/
|
|
1152
|
+
slug?: string;
|
|
1153
|
+
/** ID of the entity associated with the event. */
|
|
1154
|
+
entityId?: string;
|
|
1155
|
+
/** Event timestamp. */
|
|
1156
|
+
eventTime?: Date;
|
|
1157
|
+
/**
|
|
1158
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1159
|
+
* (for example, GDPR).
|
|
1160
|
+
*/
|
|
1161
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1162
|
+
/** If present, indicates the action that triggered the event. */
|
|
1163
|
+
originatedFrom?: string | null;
|
|
1164
|
+
/**
|
|
1165
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
1166
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1167
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1168
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1169
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1170
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1171
|
+
*/
|
|
1172
|
+
entityEventSequence?: string | null;
|
|
1173
|
+
}
|
|
1174
|
+
/** @oneof */
|
|
1175
|
+
export interface DomainEventBodyOneOf {
|
|
1176
|
+
createdEvent?: EntityCreatedEvent;
|
|
1177
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1178
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1179
|
+
actionEvent?: ActionEvent;
|
|
1180
|
+
}
|
|
1181
|
+
export interface EntityCreatedEvent {
|
|
1182
|
+
entityAsJson?: string;
|
|
1183
|
+
}
|
|
1184
|
+
export interface EntityUpdatedEvent {
|
|
1185
|
+
/**
|
|
1186
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1187
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1188
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1189
|
+
*/
|
|
1190
|
+
currentEntityAsJson?: string;
|
|
1191
|
+
}
|
|
1192
|
+
export interface EntityDeletedEvent {
|
|
1193
|
+
/** Entity that was deleted */
|
|
1194
|
+
deletedEntityAsJson?: string | null;
|
|
1195
|
+
}
|
|
1196
|
+
export interface ActionEvent {
|
|
1197
|
+
bodyAsJson?: string;
|
|
1198
|
+
}
|
|
1199
|
+
export interface GetFormResponseNonNullableFields {
|
|
1200
|
+
form?: {
|
|
1201
|
+
controls: {
|
|
1202
|
+
type: InputControlType;
|
|
1203
|
+
system: boolean;
|
|
1204
|
+
name: string;
|
|
1205
|
+
inputs: {
|
|
1206
|
+
name: string;
|
|
1207
|
+
array: boolean;
|
|
1208
|
+
label: string;
|
|
1209
|
+
options: string[];
|
|
1210
|
+
mandatory: boolean;
|
|
1211
|
+
maxLength: number;
|
|
1212
|
+
type: ValueType;
|
|
1213
|
+
defaultOptionSelection?: {
|
|
1214
|
+
optionIndex: number;
|
|
1215
|
+
placeholderText: string;
|
|
1216
|
+
};
|
|
1217
|
+
labels: {
|
|
1218
|
+
name: string;
|
|
1219
|
+
label: string;
|
|
1220
|
+
}[];
|
|
1221
|
+
}[];
|
|
1222
|
+
label: string;
|
|
1223
|
+
orderIndex: number;
|
|
1224
|
+
_id: string;
|
|
1225
|
+
}[];
|
|
1226
|
+
messages?: {
|
|
1227
|
+
rsvp?: {
|
|
1228
|
+
rsvpYesOption: string;
|
|
1229
|
+
rsvpNoOption: string;
|
|
1230
|
+
positiveMessages?: {
|
|
1231
|
+
title: string;
|
|
1232
|
+
confirmation?: {
|
|
1233
|
+
title: string;
|
|
1234
|
+
message: string;
|
|
1235
|
+
addToCalendarActionLabel: string;
|
|
1236
|
+
shareActionLabel: string;
|
|
1237
|
+
};
|
|
1238
|
+
};
|
|
1239
|
+
waitlistMessages?: {
|
|
1240
|
+
title: string;
|
|
1241
|
+
confirmation?: {
|
|
1242
|
+
title: string;
|
|
1243
|
+
message: string;
|
|
1244
|
+
addToCalendarActionLabel: string;
|
|
1245
|
+
shareActionLabel: string;
|
|
1246
|
+
};
|
|
1247
|
+
};
|
|
1248
|
+
negativeMessages?: {
|
|
1249
|
+
title: string;
|
|
1250
|
+
confirmation?: {
|
|
1251
|
+
title: string;
|
|
1252
|
+
shareActionLabel: string;
|
|
1253
|
+
};
|
|
1254
|
+
};
|
|
1255
|
+
submitActionLabel: string;
|
|
1256
|
+
};
|
|
1257
|
+
checkout?: {
|
|
1258
|
+
title: string;
|
|
1259
|
+
submitActionLabel: string;
|
|
1260
|
+
confirmation?: {
|
|
1261
|
+
title: string;
|
|
1262
|
+
message: string;
|
|
1263
|
+
downloadTicketsLabel: string;
|
|
1264
|
+
addToCalendarLabel: string;
|
|
1265
|
+
shareEventLabel: string;
|
|
1266
|
+
};
|
|
1267
|
+
};
|
|
1268
|
+
registrationClosed?: {
|
|
1269
|
+
message: string;
|
|
1270
|
+
exploreEventsActionLabel: string;
|
|
1271
|
+
};
|
|
1272
|
+
ticketsUnavailable?: {
|
|
1273
|
+
message: string;
|
|
1274
|
+
exploreEventsActionLabel: string;
|
|
1275
|
+
};
|
|
1276
|
+
};
|
|
1277
|
+
};
|
|
1278
|
+
draftForm?: {
|
|
1279
|
+
controls: {
|
|
1280
|
+
type: InputControlType;
|
|
1281
|
+
system: boolean;
|
|
1282
|
+
name: string;
|
|
1283
|
+
inputs: {
|
|
1284
|
+
name: string;
|
|
1285
|
+
array: boolean;
|
|
1286
|
+
label: string;
|
|
1287
|
+
options: string[];
|
|
1288
|
+
mandatory: boolean;
|
|
1289
|
+
maxLength: number;
|
|
1290
|
+
type: ValueType;
|
|
1291
|
+
defaultOptionSelection?: {
|
|
1292
|
+
optionIndex: number;
|
|
1293
|
+
placeholderText: string;
|
|
1294
|
+
};
|
|
1295
|
+
labels: {
|
|
1296
|
+
name: string;
|
|
1297
|
+
label: string;
|
|
1298
|
+
}[];
|
|
1299
|
+
}[];
|
|
1300
|
+
label: string;
|
|
1301
|
+
orderIndex: number;
|
|
1302
|
+
_id: string;
|
|
1303
|
+
}[];
|
|
1304
|
+
messages?: {
|
|
1305
|
+
rsvp?: {
|
|
1306
|
+
rsvpYesOption: string;
|
|
1307
|
+
rsvpNoOption: string;
|
|
1308
|
+
positiveMessages?: {
|
|
1309
|
+
title: string;
|
|
1310
|
+
confirmation?: {
|
|
1311
|
+
title: string;
|
|
1312
|
+
message: string;
|
|
1313
|
+
addToCalendarActionLabel: string;
|
|
1314
|
+
shareActionLabel: string;
|
|
1315
|
+
};
|
|
1316
|
+
};
|
|
1317
|
+
waitlistMessages?: {
|
|
1318
|
+
title: string;
|
|
1319
|
+
confirmation?: {
|
|
1320
|
+
title: string;
|
|
1321
|
+
message: string;
|
|
1322
|
+
addToCalendarActionLabel: string;
|
|
1323
|
+
shareActionLabel: string;
|
|
1324
|
+
};
|
|
1325
|
+
};
|
|
1326
|
+
negativeMessages?: {
|
|
1327
|
+
title: string;
|
|
1328
|
+
confirmation?: {
|
|
1329
|
+
title: string;
|
|
1330
|
+
shareActionLabel: string;
|
|
1331
|
+
};
|
|
1332
|
+
};
|
|
1333
|
+
submitActionLabel: string;
|
|
1334
|
+
};
|
|
1335
|
+
checkout?: {
|
|
1336
|
+
title: string;
|
|
1337
|
+
submitActionLabel: string;
|
|
1338
|
+
confirmation?: {
|
|
1339
|
+
title: string;
|
|
1340
|
+
message: string;
|
|
1341
|
+
downloadTicketsLabel: string;
|
|
1342
|
+
addToCalendarLabel: string;
|
|
1343
|
+
shareEventLabel: string;
|
|
1344
|
+
};
|
|
1345
|
+
};
|
|
1346
|
+
registrationClosed?: {
|
|
1347
|
+
message: string;
|
|
1348
|
+
exploreEventsActionLabel: string;
|
|
1349
|
+
};
|
|
1350
|
+
ticketsUnavailable?: {
|
|
1351
|
+
message: string;
|
|
1352
|
+
exploreEventsActionLabel: string;
|
|
1353
|
+
};
|
|
1354
|
+
};
|
|
1355
|
+
};
|
|
1356
|
+
}
|
|
1357
|
+
export interface AddControlResponseNonNullableFields {
|
|
1358
|
+
_id: string;
|
|
1359
|
+
form?: {
|
|
1360
|
+
controls: {
|
|
1361
|
+
type: InputControlType;
|
|
1362
|
+
system: boolean;
|
|
1363
|
+
name: string;
|
|
1364
|
+
inputs: {
|
|
1365
|
+
name: string;
|
|
1366
|
+
array: boolean;
|
|
1367
|
+
label: string;
|
|
1368
|
+
options: string[];
|
|
1369
|
+
mandatory: boolean;
|
|
1370
|
+
maxLength: number;
|
|
1371
|
+
type: ValueType;
|
|
1372
|
+
defaultOptionSelection?: {
|
|
1373
|
+
optionIndex: number;
|
|
1374
|
+
placeholderText: string;
|
|
1375
|
+
};
|
|
1376
|
+
labels: {
|
|
1377
|
+
name: string;
|
|
1378
|
+
label: string;
|
|
1379
|
+
}[];
|
|
1380
|
+
}[];
|
|
1381
|
+
label: string;
|
|
1382
|
+
orderIndex: number;
|
|
1383
|
+
_id: string;
|
|
1384
|
+
}[];
|
|
1385
|
+
messages?: {
|
|
1386
|
+
rsvp?: {
|
|
1387
|
+
rsvpYesOption: string;
|
|
1388
|
+
rsvpNoOption: string;
|
|
1389
|
+
positiveMessages?: {
|
|
1390
|
+
title: string;
|
|
1391
|
+
confirmation?: {
|
|
1392
|
+
title: string;
|
|
1393
|
+
message: string;
|
|
1394
|
+
addToCalendarActionLabel: string;
|
|
1395
|
+
shareActionLabel: string;
|
|
1396
|
+
};
|
|
1397
|
+
};
|
|
1398
|
+
waitlistMessages?: {
|
|
1399
|
+
title: string;
|
|
1400
|
+
confirmation?: {
|
|
1401
|
+
title: string;
|
|
1402
|
+
message: string;
|
|
1403
|
+
addToCalendarActionLabel: string;
|
|
1404
|
+
shareActionLabel: string;
|
|
1405
|
+
};
|
|
1406
|
+
};
|
|
1407
|
+
negativeMessages?: {
|
|
1408
|
+
title: string;
|
|
1409
|
+
confirmation?: {
|
|
1410
|
+
title: string;
|
|
1411
|
+
shareActionLabel: string;
|
|
1412
|
+
};
|
|
1413
|
+
};
|
|
1414
|
+
submitActionLabel: string;
|
|
1415
|
+
};
|
|
1416
|
+
checkout?: {
|
|
1417
|
+
title: string;
|
|
1418
|
+
submitActionLabel: string;
|
|
1419
|
+
confirmation?: {
|
|
1420
|
+
title: string;
|
|
1421
|
+
message: string;
|
|
1422
|
+
downloadTicketsLabel: string;
|
|
1423
|
+
addToCalendarLabel: string;
|
|
1424
|
+
shareEventLabel: string;
|
|
1425
|
+
};
|
|
1426
|
+
};
|
|
1427
|
+
registrationClosed?: {
|
|
1428
|
+
message: string;
|
|
1429
|
+
exploreEventsActionLabel: string;
|
|
1430
|
+
};
|
|
1431
|
+
ticketsUnavailable?: {
|
|
1432
|
+
message: string;
|
|
1433
|
+
exploreEventsActionLabel: string;
|
|
1434
|
+
};
|
|
1435
|
+
};
|
|
1436
|
+
};
|
|
1437
|
+
}
|
|
1438
|
+
export interface UpdateControlResponseNonNullableFields {
|
|
1439
|
+
form?: {
|
|
1440
|
+
controls: {
|
|
1441
|
+
type: InputControlType;
|
|
1442
|
+
system: boolean;
|
|
1443
|
+
name: string;
|
|
1444
|
+
inputs: {
|
|
1445
|
+
name: string;
|
|
1446
|
+
array: boolean;
|
|
1447
|
+
label: string;
|
|
1448
|
+
options: string[];
|
|
1449
|
+
mandatory: boolean;
|
|
1450
|
+
maxLength: number;
|
|
1451
|
+
type: ValueType;
|
|
1452
|
+
defaultOptionSelection?: {
|
|
1453
|
+
optionIndex: number;
|
|
1454
|
+
placeholderText: string;
|
|
1455
|
+
};
|
|
1456
|
+
labels: {
|
|
1457
|
+
name: string;
|
|
1458
|
+
label: string;
|
|
1459
|
+
}[];
|
|
1460
|
+
}[];
|
|
1461
|
+
label: string;
|
|
1462
|
+
orderIndex: number;
|
|
1463
|
+
_id: string;
|
|
1464
|
+
}[];
|
|
1465
|
+
messages?: {
|
|
1466
|
+
rsvp?: {
|
|
1467
|
+
rsvpYesOption: string;
|
|
1468
|
+
rsvpNoOption: string;
|
|
1469
|
+
positiveMessages?: {
|
|
1470
|
+
title: string;
|
|
1471
|
+
confirmation?: {
|
|
1472
|
+
title: string;
|
|
1473
|
+
message: string;
|
|
1474
|
+
addToCalendarActionLabel: string;
|
|
1475
|
+
shareActionLabel: string;
|
|
1476
|
+
};
|
|
1477
|
+
};
|
|
1478
|
+
waitlistMessages?: {
|
|
1479
|
+
title: string;
|
|
1480
|
+
confirmation?: {
|
|
1481
|
+
title: string;
|
|
1482
|
+
message: string;
|
|
1483
|
+
addToCalendarActionLabel: string;
|
|
1484
|
+
shareActionLabel: string;
|
|
1485
|
+
};
|
|
1486
|
+
};
|
|
1487
|
+
negativeMessages?: {
|
|
1488
|
+
title: string;
|
|
1489
|
+
confirmation?: {
|
|
1490
|
+
title: string;
|
|
1491
|
+
shareActionLabel: string;
|
|
1492
|
+
};
|
|
1493
|
+
};
|
|
1494
|
+
submitActionLabel: string;
|
|
1495
|
+
};
|
|
1496
|
+
checkout?: {
|
|
1497
|
+
title: string;
|
|
1498
|
+
submitActionLabel: string;
|
|
1499
|
+
confirmation?: {
|
|
1500
|
+
title: string;
|
|
1501
|
+
message: string;
|
|
1502
|
+
downloadTicketsLabel: string;
|
|
1503
|
+
addToCalendarLabel: string;
|
|
1504
|
+
shareEventLabel: string;
|
|
1505
|
+
};
|
|
1506
|
+
};
|
|
1507
|
+
registrationClosed?: {
|
|
1508
|
+
message: string;
|
|
1509
|
+
exploreEventsActionLabel: string;
|
|
1510
|
+
};
|
|
1511
|
+
ticketsUnavailable?: {
|
|
1512
|
+
message: string;
|
|
1513
|
+
exploreEventsActionLabel: string;
|
|
1514
|
+
};
|
|
1515
|
+
};
|
|
1516
|
+
};
|
|
1517
|
+
}
|
|
1518
|
+
export interface DeleteControlResponseNonNullableFields {
|
|
1519
|
+
form?: {
|
|
1520
|
+
controls: {
|
|
1521
|
+
type: InputControlType;
|
|
1522
|
+
system: boolean;
|
|
1523
|
+
name: string;
|
|
1524
|
+
inputs: {
|
|
1525
|
+
name: string;
|
|
1526
|
+
array: boolean;
|
|
1527
|
+
label: string;
|
|
1528
|
+
options: string[];
|
|
1529
|
+
mandatory: boolean;
|
|
1530
|
+
maxLength: number;
|
|
1531
|
+
type: ValueType;
|
|
1532
|
+
defaultOptionSelection?: {
|
|
1533
|
+
optionIndex: number;
|
|
1534
|
+
placeholderText: string;
|
|
1535
|
+
};
|
|
1536
|
+
labels: {
|
|
1537
|
+
name: string;
|
|
1538
|
+
label: string;
|
|
1539
|
+
}[];
|
|
1540
|
+
}[];
|
|
1541
|
+
label: string;
|
|
1542
|
+
orderIndex: number;
|
|
1543
|
+
_id: string;
|
|
1544
|
+
}[];
|
|
1545
|
+
messages?: {
|
|
1546
|
+
rsvp?: {
|
|
1547
|
+
rsvpYesOption: string;
|
|
1548
|
+
rsvpNoOption: string;
|
|
1549
|
+
positiveMessages?: {
|
|
1550
|
+
title: string;
|
|
1551
|
+
confirmation?: {
|
|
1552
|
+
title: string;
|
|
1553
|
+
message: string;
|
|
1554
|
+
addToCalendarActionLabel: string;
|
|
1555
|
+
shareActionLabel: string;
|
|
1556
|
+
};
|
|
1557
|
+
};
|
|
1558
|
+
waitlistMessages?: {
|
|
1559
|
+
title: string;
|
|
1560
|
+
confirmation?: {
|
|
1561
|
+
title: string;
|
|
1562
|
+
message: string;
|
|
1563
|
+
addToCalendarActionLabel: string;
|
|
1564
|
+
shareActionLabel: string;
|
|
1565
|
+
};
|
|
1566
|
+
};
|
|
1567
|
+
negativeMessages?: {
|
|
1568
|
+
title: string;
|
|
1569
|
+
confirmation?: {
|
|
1570
|
+
title: string;
|
|
1571
|
+
shareActionLabel: string;
|
|
1572
|
+
};
|
|
1573
|
+
};
|
|
1574
|
+
submitActionLabel: string;
|
|
1575
|
+
};
|
|
1576
|
+
checkout?: {
|
|
1577
|
+
title: string;
|
|
1578
|
+
submitActionLabel: string;
|
|
1579
|
+
confirmation?: {
|
|
1580
|
+
title: string;
|
|
1581
|
+
message: string;
|
|
1582
|
+
downloadTicketsLabel: string;
|
|
1583
|
+
addToCalendarLabel: string;
|
|
1584
|
+
shareEventLabel: string;
|
|
1585
|
+
};
|
|
1586
|
+
};
|
|
1587
|
+
registrationClosed?: {
|
|
1588
|
+
message: string;
|
|
1589
|
+
exploreEventsActionLabel: string;
|
|
1590
|
+
};
|
|
1591
|
+
ticketsUnavailable?: {
|
|
1592
|
+
message: string;
|
|
1593
|
+
exploreEventsActionLabel: string;
|
|
1594
|
+
};
|
|
1595
|
+
};
|
|
1596
|
+
};
|
|
1597
|
+
}
|
|
1598
|
+
export interface UpdateMessagesResponseNonNullableFields {
|
|
1599
|
+
form?: {
|
|
1600
|
+
controls: {
|
|
1601
|
+
type: InputControlType;
|
|
1602
|
+
system: boolean;
|
|
1603
|
+
name: string;
|
|
1604
|
+
inputs: {
|
|
1605
|
+
name: string;
|
|
1606
|
+
array: boolean;
|
|
1607
|
+
label: string;
|
|
1608
|
+
options: string[];
|
|
1609
|
+
mandatory: boolean;
|
|
1610
|
+
maxLength: number;
|
|
1611
|
+
type: ValueType;
|
|
1612
|
+
defaultOptionSelection?: {
|
|
1613
|
+
optionIndex: number;
|
|
1614
|
+
placeholderText: string;
|
|
1615
|
+
};
|
|
1616
|
+
labels: {
|
|
1617
|
+
name: string;
|
|
1618
|
+
label: string;
|
|
1619
|
+
}[];
|
|
1620
|
+
}[];
|
|
1621
|
+
label: string;
|
|
1622
|
+
orderIndex: number;
|
|
1623
|
+
_id: string;
|
|
1624
|
+
}[];
|
|
1625
|
+
messages?: {
|
|
1626
|
+
rsvp?: {
|
|
1627
|
+
rsvpYesOption: string;
|
|
1628
|
+
rsvpNoOption: string;
|
|
1629
|
+
positiveMessages?: {
|
|
1630
|
+
title: string;
|
|
1631
|
+
confirmation?: {
|
|
1632
|
+
title: string;
|
|
1633
|
+
message: string;
|
|
1634
|
+
addToCalendarActionLabel: string;
|
|
1635
|
+
shareActionLabel: string;
|
|
1636
|
+
};
|
|
1637
|
+
};
|
|
1638
|
+
waitlistMessages?: {
|
|
1639
|
+
title: string;
|
|
1640
|
+
confirmation?: {
|
|
1641
|
+
title: string;
|
|
1642
|
+
message: string;
|
|
1643
|
+
addToCalendarActionLabel: string;
|
|
1644
|
+
shareActionLabel: string;
|
|
1645
|
+
};
|
|
1646
|
+
};
|
|
1647
|
+
negativeMessages?: {
|
|
1648
|
+
title: string;
|
|
1649
|
+
confirmation?: {
|
|
1650
|
+
title: string;
|
|
1651
|
+
shareActionLabel: string;
|
|
1652
|
+
};
|
|
1653
|
+
};
|
|
1654
|
+
submitActionLabel: string;
|
|
1655
|
+
};
|
|
1656
|
+
checkout?: {
|
|
1657
|
+
title: string;
|
|
1658
|
+
submitActionLabel: string;
|
|
1659
|
+
confirmation?: {
|
|
1660
|
+
title: string;
|
|
1661
|
+
message: string;
|
|
1662
|
+
downloadTicketsLabel: string;
|
|
1663
|
+
addToCalendarLabel: string;
|
|
1664
|
+
shareEventLabel: string;
|
|
1665
|
+
};
|
|
1666
|
+
};
|
|
1667
|
+
registrationClosed?: {
|
|
1668
|
+
message: string;
|
|
1669
|
+
exploreEventsActionLabel: string;
|
|
1670
|
+
};
|
|
1671
|
+
ticketsUnavailable?: {
|
|
1672
|
+
message: string;
|
|
1673
|
+
exploreEventsActionLabel: string;
|
|
1674
|
+
};
|
|
1675
|
+
};
|
|
1676
|
+
};
|
|
1677
|
+
}
|
|
1678
|
+
export interface PublishDraftResponseNonNullableFields {
|
|
1679
|
+
form?: {
|
|
1680
|
+
controls: {
|
|
1681
|
+
type: InputControlType;
|
|
1682
|
+
system: boolean;
|
|
1683
|
+
name: string;
|
|
1684
|
+
inputs: {
|
|
1685
|
+
name: string;
|
|
1686
|
+
array: boolean;
|
|
1687
|
+
label: string;
|
|
1688
|
+
options: string[];
|
|
1689
|
+
mandatory: boolean;
|
|
1690
|
+
maxLength: number;
|
|
1691
|
+
type: ValueType;
|
|
1692
|
+
defaultOptionSelection?: {
|
|
1693
|
+
optionIndex: number;
|
|
1694
|
+
placeholderText: string;
|
|
1695
|
+
};
|
|
1696
|
+
labels: {
|
|
1697
|
+
name: string;
|
|
1698
|
+
label: string;
|
|
1699
|
+
}[];
|
|
1700
|
+
}[];
|
|
1701
|
+
label: string;
|
|
1702
|
+
orderIndex: number;
|
|
1703
|
+
_id: string;
|
|
1704
|
+
}[];
|
|
1705
|
+
messages?: {
|
|
1706
|
+
rsvp?: {
|
|
1707
|
+
rsvpYesOption: string;
|
|
1708
|
+
rsvpNoOption: string;
|
|
1709
|
+
positiveMessages?: {
|
|
1710
|
+
title: string;
|
|
1711
|
+
confirmation?: {
|
|
1712
|
+
title: string;
|
|
1713
|
+
message: string;
|
|
1714
|
+
addToCalendarActionLabel: string;
|
|
1715
|
+
shareActionLabel: string;
|
|
1716
|
+
};
|
|
1717
|
+
};
|
|
1718
|
+
waitlistMessages?: {
|
|
1719
|
+
title: string;
|
|
1720
|
+
confirmation?: {
|
|
1721
|
+
title: string;
|
|
1722
|
+
message: string;
|
|
1723
|
+
addToCalendarActionLabel: string;
|
|
1724
|
+
shareActionLabel: string;
|
|
1725
|
+
};
|
|
1726
|
+
};
|
|
1727
|
+
negativeMessages?: {
|
|
1728
|
+
title: string;
|
|
1729
|
+
confirmation?: {
|
|
1730
|
+
title: string;
|
|
1731
|
+
shareActionLabel: string;
|
|
1732
|
+
};
|
|
1733
|
+
};
|
|
1734
|
+
submitActionLabel: string;
|
|
1735
|
+
};
|
|
1736
|
+
checkout?: {
|
|
1737
|
+
title: string;
|
|
1738
|
+
submitActionLabel: string;
|
|
1739
|
+
confirmation?: {
|
|
1740
|
+
title: string;
|
|
1741
|
+
message: string;
|
|
1742
|
+
downloadTicketsLabel: string;
|
|
1743
|
+
addToCalendarLabel: string;
|
|
1744
|
+
shareEventLabel: string;
|
|
1745
|
+
};
|
|
1746
|
+
};
|
|
1747
|
+
registrationClosed?: {
|
|
1748
|
+
message: string;
|
|
1749
|
+
exploreEventsActionLabel: string;
|
|
1750
|
+
};
|
|
1751
|
+
ticketsUnavailable?: {
|
|
1752
|
+
message: string;
|
|
1753
|
+
exploreEventsActionLabel: string;
|
|
1754
|
+
};
|
|
1755
|
+
};
|
|
1756
|
+
};
|
|
1757
|
+
}
|
|
1758
|
+
/**
|
|
1759
|
+
* Retrieves an event registration form (both the draft and published versions).
|
|
1760
|
+
* @param eventId - Event ID.
|
|
1761
|
+
* @public
|
|
1762
|
+
* @documentationMaturity preview
|
|
1763
|
+
* @requiredField eventId
|
|
1764
|
+
* @permissionScope Read Events - all read permissions
|
|
1765
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
1766
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
1767
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1768
|
+
* @permissionScope Manage Events - all permissions
|
|
1769
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1770
|
+
* @permissionScope Read Events
|
|
1771
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
1772
|
+
* @permissionScope Manage Guest List
|
|
1773
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
1774
|
+
* @permissionScope Manage Events
|
|
1775
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
1776
|
+
* @applicableIdentity APP
|
|
1777
|
+
* @applicableIdentity MEMBER
|
|
1778
|
+
* @applicableIdentity VISITOR
|
|
1779
|
+
* @returns Currently published event form.
|
|
1780
|
+
* Published form is visible to site visitors.
|
|
1781
|
+
*/
|
|
1782
|
+
export declare function getForm(eventId: string): Promise<Form & NonNullable<GetFormResponseNonNullableFields>['form']>;
|
|
1783
|
+
/**
|
|
1784
|
+
* Adds an input control to the draft form.
|
|
1785
|
+
* @param eventId - Event ID.
|
|
1786
|
+
* @public
|
|
1787
|
+
* @documentationMaturity preview
|
|
1788
|
+
* @requiredField eventId
|
|
1789
|
+
* @permissionScope Manage Events - all permissions
|
|
1790
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1791
|
+
* @permissionScope Manage Events
|
|
1792
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
1793
|
+
* @applicableIdentity APP
|
|
1794
|
+
*/
|
|
1795
|
+
export declare function addControl(eventId: string, options?: AddControlOptions): Promise<AddControlResponse & AddControlResponseNonNullableFields>;
|
|
1796
|
+
export interface AddControlOptions extends AddControlRequestControlOneOf {
|
|
1797
|
+
/** Phone number input control. */
|
|
1798
|
+
phone?: PhoneControl;
|
|
1799
|
+
/** Single-line or full address input control. */
|
|
1800
|
+
address?: AddressControl;
|
|
1801
|
+
/** Day, month, year date input control. */
|
|
1802
|
+
date?: DateControl;
|
|
1803
|
+
/** Additional guests input control. */
|
|
1804
|
+
additionalGuests?: AdditionalGuestsControl;
|
|
1805
|
+
/** Single-choice dropdown style input control. */
|
|
1806
|
+
dropdown?: DropdownControl;
|
|
1807
|
+
/** Multiple-choice checkbox style input control. */
|
|
1808
|
+
checkbox?: CheckboxControl;
|
|
1809
|
+
/** Free-form text input control. */
|
|
1810
|
+
text?: TextControl;
|
|
1811
|
+
/** Single-choice radio button style input control. */
|
|
1812
|
+
radioButton?: RadioButtonControl;
|
|
1813
|
+
}
|
|
1814
|
+
/**
|
|
1815
|
+
* Updates an existing input control in the draft form.
|
|
1816
|
+
* @public
|
|
1817
|
+
* @documentationMaturity preview
|
|
1818
|
+
* @requiredField identifiers
|
|
1819
|
+
* @requiredField identifiers.eventId
|
|
1820
|
+
* @requiredField identifiers.id
|
|
1821
|
+
* @permissionScope Manage Events - all permissions
|
|
1822
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1823
|
+
* @permissionScope Manage Events
|
|
1824
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
1825
|
+
* @applicableIdentity APP
|
|
1826
|
+
*/
|
|
1827
|
+
export declare function updateControl(identifiers: UpdateControlIdentifiers, options?: UpdateControlOptions): Promise<UpdateControlResponse & UpdateControlResponseNonNullableFields>;
|
|
1828
|
+
export interface UpdateControlIdentifiers extends UpdateControlRequestControlOneOf {
|
|
1829
|
+
/** Event ID. */
|
|
1830
|
+
eventId: string;
|
|
1831
|
+
/** Unique input control ID. */
|
|
1832
|
+
_id: string;
|
|
1833
|
+
}
|
|
1834
|
+
export interface UpdateControlOptions extends UpdateControlRequestControlOneOf {
|
|
1835
|
+
/** Index used to sort input controls in ascending order. */
|
|
1836
|
+
orderIndex?: number;
|
|
1837
|
+
/** Phone number input control. */
|
|
1838
|
+
phone?: PhoneControl;
|
|
1839
|
+
/** Single-line or full address input control. */
|
|
1840
|
+
address?: AddressControl;
|
|
1841
|
+
/** Day, month, year date input control. */
|
|
1842
|
+
date?: DateControl;
|
|
1843
|
+
/** Additional guests input control. */
|
|
1844
|
+
additionalGuests?: AdditionalGuestsControl;
|
|
1845
|
+
/** Single-choice dropdown style input control. */
|
|
1846
|
+
dropdown?: DropdownControl;
|
|
1847
|
+
/** Multiple-choice checkbox style input control. */
|
|
1848
|
+
checkbox?: CheckboxControl;
|
|
1849
|
+
/** Free-form text input control. */
|
|
1850
|
+
text?: TextControl;
|
|
1851
|
+
/** Main guest name input control. */
|
|
1852
|
+
name?: NameControl;
|
|
1853
|
+
/** Main guest email input control. */
|
|
1854
|
+
email?: EmailControl;
|
|
1855
|
+
/** Single-choice radio style input control. */
|
|
1856
|
+
radioButton?: RadioButtonControl;
|
|
1857
|
+
}
|
|
1858
|
+
/**
|
|
1859
|
+
* Deletes an input control from the draft form.
|
|
1860
|
+
* @public
|
|
1861
|
+
* @documentationMaturity preview
|
|
1862
|
+
* @requiredField identifiers
|
|
1863
|
+
* @requiredField identifiers.eventId
|
|
1864
|
+
* @requiredField identifiers.id
|
|
1865
|
+
* @permissionScope Manage Events - all permissions
|
|
1866
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1867
|
+
* @permissionScope Manage Events
|
|
1868
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
1869
|
+
* @applicableIdentity APP
|
|
1870
|
+
*/
|
|
1871
|
+
export declare function deleteControl(identifiers: DeleteControlIdentifiers): Promise<DeleteControlResponse & DeleteControlResponseNonNullableFields>;
|
|
1872
|
+
export interface DeleteControlIdentifiers {
|
|
1873
|
+
/** Event ID. */
|
|
1874
|
+
eventId: string;
|
|
1875
|
+
/** Unique input control ID. */
|
|
1876
|
+
_id: string;
|
|
1877
|
+
}
|
|
1878
|
+
/**
|
|
1879
|
+
* Updates draft form messages, as displayed in the Wix UI before, during, and after the registration flow.
|
|
1880
|
+
* Configurable messages include form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
1881
|
+
* @param eventId - Event ID.
|
|
1882
|
+
* @public
|
|
1883
|
+
* @documentationMaturity preview
|
|
1884
|
+
* @requiredField eventId
|
|
1885
|
+
* @permissionScope Manage Events - all permissions
|
|
1886
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1887
|
+
* @permissionScope Manage Events
|
|
1888
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
1889
|
+
* @applicableIdentity APP
|
|
1890
|
+
*/
|
|
1891
|
+
export declare function updateMessages(eventId: string, options?: UpdateMessagesOptions): Promise<UpdateMessagesResponse & UpdateMessagesResponseNonNullableFields>;
|
|
1892
|
+
export interface UpdateMessagesOptions {
|
|
1893
|
+
/** Set of configured form messages. */
|
|
1894
|
+
messages?: FormMessages;
|
|
1895
|
+
}
|
|
1896
|
+
/**
|
|
1897
|
+
* Publishes the draft form.
|
|
1898
|
+
* Sets event registration form equal to contents of draft form.
|
|
1899
|
+
* @param eventId - Event ID.
|
|
1900
|
+
* @public
|
|
1901
|
+
* @documentationMaturity preview
|
|
1902
|
+
* @requiredField eventId
|
|
1903
|
+
* @permissionScope Manage Events - all permissions
|
|
1904
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1905
|
+
* @permissionScope Manage Events
|
|
1906
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
1907
|
+
* @applicableIdentity APP
|
|
1908
|
+
*/
|
|
1909
|
+
export declare function publishDraft(eventId: string): Promise<PublishDraftResponse & PublishDraftResponseNonNullableFields>;
|
|
1910
|
+
/**
|
|
1911
|
+
* Clears all changes to the draft form.
|
|
1912
|
+
* (Does not affect the published form.)
|
|
1913
|
+
* @param eventId - Event ID.
|
|
1914
|
+
* @public
|
|
1915
|
+
* @documentationMaturity preview
|
|
1916
|
+
* @requiredField eventId
|
|
1917
|
+
* @permissionScope Manage Events - all permissions
|
|
1918
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1919
|
+
* @permissionScope Manage Events
|
|
1920
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
1921
|
+
* @applicableIdentity APP
|
|
1922
|
+
*/
|
|
1923
|
+
export declare function discardDraft(eventId: string): Promise<void>;
|