@wix/events 1.0.154 → 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 +4 -6
- package/build/cjs/src/events-guests-v1-guest.universal.js +5 -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 +14 -6
- package/build/cjs/src/events-v2-policy.universal.js +15 -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 +6 -6
- package/build/cjs/src/events-v3-event.public.js +8 -1
- package/build/cjs/src/events-v3-event.public.js.map +1 -1
- package/build/cjs/src/events-v3-event.types.d.ts +485 -38
- package/build/cjs/src/events-v3-event.types.js +78 -1
- package/build/cjs/src/events-v3-event.types.js.map +1 -1
- package/build/cjs/src/events-v3-event.universal.d.ts +523 -48
- package/build/cjs/src/events-v3-event.universal.js +154 -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 +4 -6
- package/build/es/src/events-guests-v1-guest.universal.js +4 -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 +14 -6
- package/build/es/src/events-v2-policy.universal.js +14 -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 +6 -6
- package/build/es/src/events-v3-event.public.js +1 -1
- package/build/es/src/events-v3-event.public.js.map +1 -1
- package/build/es/src/events-v3-event.types.d.ts +485 -38
- package/build/es/src/events-v3-event.types.js +77 -0
- package/build/es/src/events-v3-event.types.js.map +1 -1
- package/build/es/src/events-v3-event.universal.d.ts +523 -48
- package/build/es/src/events-v3-event.universal.js +153 -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
|
@@ -1,10 +1,4 @@
|
|
|
1
|
-
export
|
|
2
|
-
verboseLogging: {
|
|
3
|
-
on: () => boolean;
|
|
4
|
-
off: () => boolean;
|
|
5
|
-
};
|
|
6
|
-
};
|
|
7
|
-
export interface Event {
|
|
1
|
+
export interface V3Event {
|
|
8
2
|
/**
|
|
9
3
|
* Event ID.
|
|
10
4
|
* @readonly
|
|
@@ -67,7 +61,7 @@ export interface Event {
|
|
|
67
61
|
/** Event schedule details. */
|
|
68
62
|
agendaSettings?: AgendaSettings;
|
|
69
63
|
/** Visual settings for event. */
|
|
70
|
-
eventDisplaySettings?:
|
|
64
|
+
eventDisplaySettings?: V3EventDisplaySettings;
|
|
71
65
|
}
|
|
72
66
|
export interface Location {
|
|
73
67
|
name?: string | null;
|
|
@@ -832,7 +826,7 @@ export declare enum Type {
|
|
|
832
826
|
/** Created automatically and used to store component events. */
|
|
833
827
|
COMPONENT = "COMPONENT"
|
|
834
828
|
}
|
|
835
|
-
export interface
|
|
829
|
+
export interface V3EventDisplaySettings {
|
|
836
830
|
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
837
831
|
hideEventDetailsButton?: boolean | null;
|
|
838
832
|
}
|
|
@@ -878,7 +872,7 @@ export interface V3EventEnded {
|
|
|
878
872
|
}
|
|
879
873
|
export interface CreateEventRequest {
|
|
880
874
|
/** Event data. */
|
|
881
|
-
event:
|
|
875
|
+
event: V3Event;
|
|
882
876
|
/** Whether to create the event as a draft. */
|
|
883
877
|
draft?: boolean;
|
|
884
878
|
/**
|
|
@@ -925,7 +919,7 @@ export declare enum RequestedFields {
|
|
|
925
919
|
}
|
|
926
920
|
export interface CreateEventResponse {
|
|
927
921
|
/** Created event. */
|
|
928
|
-
event?:
|
|
922
|
+
event?: V3Event;
|
|
929
923
|
}
|
|
930
924
|
export interface V3EventPublished {
|
|
931
925
|
/** Event publishing timestamp in ISO UTC format. */
|
|
@@ -944,7 +938,7 @@ export interface CloneEventRequest {
|
|
|
944
938
|
/** Event ID. */
|
|
945
939
|
eventId: string;
|
|
946
940
|
/** Field values to be changed when cloning the event. */
|
|
947
|
-
event?:
|
|
941
|
+
event?: V3Event;
|
|
948
942
|
/** Whether to clone the event as a draft. */
|
|
949
943
|
draft?: boolean;
|
|
950
944
|
/**
|
|
@@ -965,7 +959,7 @@ export interface CloneEventRequest {
|
|
|
965
959
|
}
|
|
966
960
|
export interface CloneEventResponse {
|
|
967
961
|
/** Cloned event. */
|
|
968
|
-
event?:
|
|
962
|
+
event?: V3Event;
|
|
969
963
|
}
|
|
970
964
|
export interface EventCloned {
|
|
971
965
|
/** Event creation timestamp in ISO UTC format. */
|
|
@@ -995,7 +989,7 @@ export interface EventCloned {
|
|
|
995
989
|
}
|
|
996
990
|
export interface UpdateEventRequest {
|
|
997
991
|
/** Field values to be changed. */
|
|
998
|
-
event?:
|
|
992
|
+
event?: V3Event;
|
|
999
993
|
/**
|
|
1000
994
|
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
1001
995
|
* - `DETAILS`: Returns `shortDescription`, `mainImage` and `calendarUrls`.
|
|
@@ -1014,7 +1008,7 @@ export interface UpdateEventRequest {
|
|
|
1014
1008
|
}
|
|
1015
1009
|
export interface UpdateEventResponse {
|
|
1016
1010
|
/** Updated event. */
|
|
1017
|
-
event?:
|
|
1011
|
+
event?: V3Event;
|
|
1018
1012
|
}
|
|
1019
1013
|
export interface PublishDraftEventRequest {
|
|
1020
1014
|
/** Event ID. */
|
|
@@ -1037,7 +1031,7 @@ export interface PublishDraftEventRequest {
|
|
|
1037
1031
|
}
|
|
1038
1032
|
export interface PublishDraftEventResponse {
|
|
1039
1033
|
/** Published event. */
|
|
1040
|
-
event?:
|
|
1034
|
+
event?: V3Event;
|
|
1041
1035
|
}
|
|
1042
1036
|
export interface CancelEventRequest {
|
|
1043
1037
|
/** Event ID. */
|
|
@@ -1060,7 +1054,7 @@ export interface CancelEventRequest {
|
|
|
1060
1054
|
}
|
|
1061
1055
|
export interface CancelEventResponse {
|
|
1062
1056
|
/** Canceled event. */
|
|
1063
|
-
event?:
|
|
1057
|
+
event?: V3Event;
|
|
1064
1058
|
}
|
|
1065
1059
|
export interface V3EventCanceled {
|
|
1066
1060
|
/** Event cancelation timestamp in ISO UTC format. */
|
|
@@ -1163,7 +1157,7 @@ export interface QueryEventsResponse {
|
|
|
1163
1157
|
/** Metadata for the paginated results. */
|
|
1164
1158
|
pagingMetadata?: PagingMetadataV2;
|
|
1165
1159
|
/** List of events. */
|
|
1166
|
-
events?:
|
|
1160
|
+
events?: V3Event[];
|
|
1167
1161
|
}
|
|
1168
1162
|
export interface PagingMetadataV2 {
|
|
1169
1163
|
/** Number of items to return. See [Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information. */
|
|
@@ -1246,7 +1240,7 @@ export interface ListUserEventsResponse {
|
|
|
1246
1240
|
/** Metadata for the paginated results. */
|
|
1247
1241
|
pagingMetadata?: PagingMetadataV2;
|
|
1248
1242
|
/** List of events. */
|
|
1249
|
-
events?:
|
|
1243
|
+
events?: V3Event[];
|
|
1250
1244
|
/** Filter facets. */
|
|
1251
1245
|
facets?: Record<string, FacetCounts>;
|
|
1252
1246
|
}
|
|
@@ -1275,7 +1269,7 @@ export interface ListEventsByCategoryResponse {
|
|
|
1275
1269
|
/** Metadata for the paginated results. */
|
|
1276
1270
|
pagingMetadata?: PagingMetadataV2;
|
|
1277
1271
|
/** List of events. */
|
|
1278
|
-
events?:
|
|
1272
|
+
events?: V3Event[];
|
|
1279
1273
|
}
|
|
1280
1274
|
export interface GetEventRequest {
|
|
1281
1275
|
/** Event ID. */
|
|
@@ -1298,7 +1292,7 @@ export interface GetEventRequest {
|
|
|
1298
1292
|
}
|
|
1299
1293
|
export interface GetEventResponse {
|
|
1300
1294
|
/** Event. */
|
|
1301
|
-
event?:
|
|
1295
|
+
event?: V3Event;
|
|
1302
1296
|
}
|
|
1303
1297
|
export interface GetEventBySlugRequest {
|
|
1304
1298
|
/** URL slug. */
|
|
@@ -1321,7 +1315,7 @@ export interface GetEventBySlugRequest {
|
|
|
1321
1315
|
}
|
|
1322
1316
|
export interface GetEventBySlugResponse {
|
|
1323
1317
|
/** Event. */
|
|
1324
|
-
event?:
|
|
1318
|
+
event?: V3Event;
|
|
1325
1319
|
}
|
|
1326
1320
|
export interface FindEventRequest extends FindEventRequestFindByOneOf {
|
|
1327
1321
|
/** Event ID. */
|
|
@@ -1344,21 +1338,9 @@ export interface FindEventRequestFindByOneOf {
|
|
|
1344
1338
|
}
|
|
1345
1339
|
export interface FindEventResponse {
|
|
1346
1340
|
/** Event. */
|
|
1347
|
-
event?:
|
|
1348
|
-
}
|
|
1349
|
-
export interface EventDeleted {
|
|
1350
|
-
/** Event deleted timestamp in ISO UTC format. */
|
|
1351
|
-
timestamp?: Date;
|
|
1352
|
-
/** Event ID. */
|
|
1353
|
-
eventId?: string;
|
|
1354
|
-
/** Event title. */
|
|
1355
|
-
title?: string;
|
|
1356
|
-
/** Event creator user ID. */
|
|
1357
|
-
userId?: string | null;
|
|
1358
|
-
}
|
|
1359
|
-
export interface Empty {
|
|
1341
|
+
event?: V3Event;
|
|
1360
1342
|
}
|
|
1361
|
-
export interface
|
|
1343
|
+
export interface EventCreated {
|
|
1362
1344
|
/** Event created timestamp in ISO UTC format. */
|
|
1363
1345
|
timestamp?: Date;
|
|
1364
1346
|
/** Event ID. */
|
|
@@ -1377,12 +1359,8 @@ export interface EventCopied {
|
|
|
1377
1359
|
derivedFromInstanceId?: string | null;
|
|
1378
1360
|
/** Event ID. Indicates the original event which current event was derived from. */
|
|
1379
1361
|
derivedFromEventId?: string | null;
|
|
1380
|
-
/**
|
|
1381
|
-
|
|
1382
|
-
* Key represents ticket def id in the original event.
|
|
1383
|
-
* Value represents ticket def id in the newly created event.
|
|
1384
|
-
*/
|
|
1385
|
-
ticketDefinitions?: Record<string, string>;
|
|
1362
|
+
/** Event that was created. */
|
|
1363
|
+
event?: Event;
|
|
1386
1364
|
}
|
|
1387
1365
|
export interface EventsLocation {
|
|
1388
1366
|
/** Location name. */
|
|
@@ -1551,6 +1529,457 @@ export declare enum EventStatus {
|
|
|
1551
1529
|
/** Event is not public and needs to be published */
|
|
1552
1530
|
DRAFT = "DRAFT"
|
|
1553
1531
|
}
|
|
1532
|
+
export interface Event {
|
|
1533
|
+
/**
|
|
1534
|
+
* Event ID.
|
|
1535
|
+
* @readonly
|
|
1536
|
+
*/
|
|
1537
|
+
_id?: string;
|
|
1538
|
+
/** Event location. */
|
|
1539
|
+
location?: EventsLocation;
|
|
1540
|
+
/** Event scheduling. */
|
|
1541
|
+
scheduling?: Scheduling;
|
|
1542
|
+
/** Event title. */
|
|
1543
|
+
title?: string;
|
|
1544
|
+
/** Event description. */
|
|
1545
|
+
description?: string;
|
|
1546
|
+
/** Rich-text content displayed in Wix UI - "About Event" section (HTML). */
|
|
1547
|
+
about?: string;
|
|
1548
|
+
/** Main event image. */
|
|
1549
|
+
mainImage?: string;
|
|
1550
|
+
/** Event slug URL (generated from event title). */
|
|
1551
|
+
slug?: string;
|
|
1552
|
+
/** ISO 639-1 language code of the event (used in content translations). */
|
|
1553
|
+
language?: string;
|
|
1554
|
+
/** Event creation timestamp. */
|
|
1555
|
+
created?: Date;
|
|
1556
|
+
/** Event modified timestamp. */
|
|
1557
|
+
modified?: Date;
|
|
1558
|
+
/** Event status. */
|
|
1559
|
+
status?: EventStatus;
|
|
1560
|
+
/** RSVP or ticketing registration details. */
|
|
1561
|
+
registration?: EventsRegistration;
|
|
1562
|
+
/** "Add to calendar" URLs. */
|
|
1563
|
+
calendarLinks?: CalendarLinks;
|
|
1564
|
+
/** Event page URL components. */
|
|
1565
|
+
eventPageUrl?: SiteUrl;
|
|
1566
|
+
/** Event registration form. */
|
|
1567
|
+
form?: Form;
|
|
1568
|
+
/** Event dashboard summary of RSVP / ticket sales. */
|
|
1569
|
+
dashboard?: Dashboard;
|
|
1570
|
+
/** Instance ID of the site where event is hosted. */
|
|
1571
|
+
instanceId?: string;
|
|
1572
|
+
/** Guest list configuration. */
|
|
1573
|
+
guestListConfig?: GuestListConfig;
|
|
1574
|
+
/** Event creator user ID. */
|
|
1575
|
+
userId?: string;
|
|
1576
|
+
/** Event discussion feed. For internal use. */
|
|
1577
|
+
feed?: EventsFeed;
|
|
1578
|
+
/** Online conferencing details. */
|
|
1579
|
+
onlineConferencing?: EventsOnlineConferencing;
|
|
1580
|
+
/** SEO settings. */
|
|
1581
|
+
seoSettings?: EventsSeoSettings;
|
|
1582
|
+
/** Assigned contacts label key. */
|
|
1583
|
+
assignedContactsLabel?: string | null;
|
|
1584
|
+
/** Agenda details. */
|
|
1585
|
+
agenda?: Agenda;
|
|
1586
|
+
/** Categories this event is assigned to. */
|
|
1587
|
+
categories?: Category[];
|
|
1588
|
+
/** Visual settings for event. */
|
|
1589
|
+
eventDisplaySettings?: EventDisplaySettings;
|
|
1590
|
+
}
|
|
1591
|
+
export interface Scheduling {
|
|
1592
|
+
/** Schedule configuration. */
|
|
1593
|
+
config?: ScheduleConfig;
|
|
1594
|
+
/** Formatted schedule representation. */
|
|
1595
|
+
formatted?: string;
|
|
1596
|
+
/** Formatted start date of the event (empty for TBD schedules). */
|
|
1597
|
+
startDateFormatted?: string;
|
|
1598
|
+
/** Formatted start time of the event (empty for TBD schedules). */
|
|
1599
|
+
startTimeFormatted?: string;
|
|
1600
|
+
/** Formatted end date of the event (empty for TBD schedules or when end date is hidden). */
|
|
1601
|
+
endDateFormatted?: string;
|
|
1602
|
+
/** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */
|
|
1603
|
+
endTimeFormatted?: string;
|
|
1604
|
+
}
|
|
1605
|
+
export interface EventsRegistration {
|
|
1606
|
+
/** Event type. */
|
|
1607
|
+
type?: EventType;
|
|
1608
|
+
/** Event registration status. */
|
|
1609
|
+
status?: RegistrationStatus;
|
|
1610
|
+
/** RSVP collection details. */
|
|
1611
|
+
rsvpCollection?: RsvpCollection;
|
|
1612
|
+
/** Ticketing details. */
|
|
1613
|
+
ticketing?: Ticketing;
|
|
1614
|
+
/** External registration details. */
|
|
1615
|
+
external?: ExternalEvent;
|
|
1616
|
+
/** Types of users allowed to register. */
|
|
1617
|
+
restrictedTo?: VisitorType;
|
|
1618
|
+
/** Initial event type which was set when creating an event. */
|
|
1619
|
+
initialType?: EventType;
|
|
1620
|
+
}
|
|
1621
|
+
export declare enum EventType {
|
|
1622
|
+
/** Type not available for this request fieldset */
|
|
1623
|
+
NA_EVENT_TYPE = "NA_EVENT_TYPE",
|
|
1624
|
+
/** Registration via RSVP */
|
|
1625
|
+
RSVP = "RSVP",
|
|
1626
|
+
/** Registration via ticket purchase */
|
|
1627
|
+
TICKETS = "TICKETS",
|
|
1628
|
+
/** External registration */
|
|
1629
|
+
EXTERNAL = "EXTERNAL",
|
|
1630
|
+
/** Registration not available */
|
|
1631
|
+
NO_REGISTRATION = "NO_REGISTRATION"
|
|
1632
|
+
}
|
|
1633
|
+
export declare enum RegistrationStatus {
|
|
1634
|
+
/** Registration status is not applicable */
|
|
1635
|
+
NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
|
|
1636
|
+
/** Registration to event is closed */
|
|
1637
|
+
CLOSED = "CLOSED",
|
|
1638
|
+
/** Registration to event is closed manually */
|
|
1639
|
+
CLOSED_MANUALLY = "CLOSED_MANUALLY",
|
|
1640
|
+
/** Registration is open via RSVP */
|
|
1641
|
+
OPEN_RSVP = "OPEN_RSVP",
|
|
1642
|
+
/** Registration to event waitlist is open via RSVP */
|
|
1643
|
+
OPEN_RSVP_WAITLIST = "OPEN_RSVP_WAITLIST",
|
|
1644
|
+
/** Registration is open via ticket purchase */
|
|
1645
|
+
OPEN_TICKETS = "OPEN_TICKETS",
|
|
1646
|
+
/** Registration is open via external URL */
|
|
1647
|
+
OPEN_EXTERNAL = "OPEN_EXTERNAL",
|
|
1648
|
+
/** Registration will be open via RSVP */
|
|
1649
|
+
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
1650
|
+
}
|
|
1651
|
+
export interface RsvpCollection {
|
|
1652
|
+
/** RSVP collection configuration. */
|
|
1653
|
+
config?: RsvpCollectionConfig;
|
|
1654
|
+
}
|
|
1655
|
+
export interface RsvpCollectionConfig {
|
|
1656
|
+
/** Defines the supported RSVP statuses. */
|
|
1657
|
+
rsvpStatusOptions?: RsvpStatusOptions;
|
|
1658
|
+
/**
|
|
1659
|
+
* Total guest limit available to register to the event.
|
|
1660
|
+
* Additional guests per RSVP are counted towards total guests.
|
|
1661
|
+
*/
|
|
1662
|
+
limit?: number | null;
|
|
1663
|
+
/** Whether a waitlist is opened when total guest limit is reached, allowing guests to create RSVP with WAITING RSVP status. */
|
|
1664
|
+
waitlist?: boolean;
|
|
1665
|
+
/** Registration start timestamp. */
|
|
1666
|
+
startDate?: Date;
|
|
1667
|
+
/** Registration end timestamp. */
|
|
1668
|
+
endDate?: Date;
|
|
1669
|
+
}
|
|
1670
|
+
export declare enum RsvpStatusOptions {
|
|
1671
|
+
/** Only YES RSVP status is available for RSVP registration */
|
|
1672
|
+
YES_ONLY = "YES_ONLY",
|
|
1673
|
+
/** YES and NO RSVP status options are available for the registration */
|
|
1674
|
+
YES_AND_NO = "YES_AND_NO"
|
|
1675
|
+
}
|
|
1676
|
+
export interface Ticketing {
|
|
1677
|
+
/** Deprecated. */
|
|
1678
|
+
lowestPrice?: string | null;
|
|
1679
|
+
/** Deprecated. */
|
|
1680
|
+
highestPrice?: string | null;
|
|
1681
|
+
/** Currency used in event transactions. */
|
|
1682
|
+
currency?: string | null;
|
|
1683
|
+
/** Ticketing configuration. */
|
|
1684
|
+
config?: TicketingConfig;
|
|
1685
|
+
/**
|
|
1686
|
+
* Price of lowest priced ticket.
|
|
1687
|
+
* @readonly
|
|
1688
|
+
*/
|
|
1689
|
+
lowestTicketPrice?: EventsMoney;
|
|
1690
|
+
/**
|
|
1691
|
+
* Price of highest priced ticket.
|
|
1692
|
+
* @readonly
|
|
1693
|
+
*/
|
|
1694
|
+
highestTicketPrice?: EventsMoney;
|
|
1695
|
+
/**
|
|
1696
|
+
* Formatted price of lowest priced ticket.
|
|
1697
|
+
* @readonly
|
|
1698
|
+
*/
|
|
1699
|
+
lowestTicketPriceFormatted?: string | null;
|
|
1700
|
+
/**
|
|
1701
|
+
* Formatted price of highest priced ticket.
|
|
1702
|
+
* @readonly
|
|
1703
|
+
*/
|
|
1704
|
+
highestTicketPriceFormatted?: string | null;
|
|
1705
|
+
/**
|
|
1706
|
+
* Whether all tickets are sold for this event.
|
|
1707
|
+
* @readonly
|
|
1708
|
+
*/
|
|
1709
|
+
soldOut?: boolean | null;
|
|
1710
|
+
}
|
|
1711
|
+
export interface TicketingConfig {
|
|
1712
|
+
/** Whether the form must be filled out separately for each ticket. */
|
|
1713
|
+
guestAssignedTickets?: boolean;
|
|
1714
|
+
/** Tax configuration. */
|
|
1715
|
+
taxConfig?: TaxConfig;
|
|
1716
|
+
/** Limit of tickets that can be purchased per order, default 20. */
|
|
1717
|
+
ticketLimitPerOrder?: number;
|
|
1718
|
+
/** Duration for which the tickets being bought are reserved. */
|
|
1719
|
+
reservationDurationInMinutes?: number | null;
|
|
1720
|
+
}
|
|
1721
|
+
export interface TaxConfig {
|
|
1722
|
+
/** Tax application settings. */
|
|
1723
|
+
type?: EventsTaxType;
|
|
1724
|
+
/** Tax name. */
|
|
1725
|
+
name?: string | null;
|
|
1726
|
+
/** Tax rate (e.g.,`21.55`). */
|
|
1727
|
+
rate?: string | null;
|
|
1728
|
+
/** Applies taxes for donations, default true. */
|
|
1729
|
+
appliesToDonations?: boolean | null;
|
|
1730
|
+
}
|
|
1731
|
+
export declare enum EventsTaxType {
|
|
1732
|
+
/** Tax is included in the ticket price */
|
|
1733
|
+
INCLUDED = "INCLUDED",
|
|
1734
|
+
/** Tax is added to the order at the checkout */
|
|
1735
|
+
ADDED = "ADDED",
|
|
1736
|
+
/** Tax is added to the final total at the checkout */
|
|
1737
|
+
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
1738
|
+
}
|
|
1739
|
+
export interface ExternalEvent {
|
|
1740
|
+
/** External event registration URL. */
|
|
1741
|
+
registration?: string;
|
|
1742
|
+
}
|
|
1743
|
+
export declare enum VisitorType {
|
|
1744
|
+
/** Site visitor (including member) */
|
|
1745
|
+
VISITOR = "VISITOR",
|
|
1746
|
+
/** Site member */
|
|
1747
|
+
MEMBER = "MEMBER",
|
|
1748
|
+
/** Site visitor or member */
|
|
1749
|
+
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
|
|
1750
|
+
}
|
|
1751
|
+
export interface CalendarLinks {
|
|
1752
|
+
/** "Add to Google calendar" URL. */
|
|
1753
|
+
google?: string;
|
|
1754
|
+
/** "Download ICS calendar file" URL. */
|
|
1755
|
+
ics?: string;
|
|
1756
|
+
}
|
|
1757
|
+
/** Site URL components */
|
|
1758
|
+
export interface SiteUrl {
|
|
1759
|
+
/**
|
|
1760
|
+
* Base URL. For premium sites, this will be the domain.
|
|
1761
|
+
* For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)
|
|
1762
|
+
*/
|
|
1763
|
+
base?: string;
|
|
1764
|
+
/** The path to that page - e.g `/my-events/weekly-meetup-2` */
|
|
1765
|
+
path?: string;
|
|
1766
|
+
}
|
|
1767
|
+
export interface Dashboard {
|
|
1768
|
+
/** Guest RSVP summary. */
|
|
1769
|
+
rsvpSummary?: RsvpSummary;
|
|
1770
|
+
/**
|
|
1771
|
+
* Summary of revenue and tickets sold.
|
|
1772
|
+
* (Archived orders are not included).
|
|
1773
|
+
*/
|
|
1774
|
+
ticketingSummary?: TicketingSummary;
|
|
1775
|
+
}
|
|
1776
|
+
export interface RsvpSummary {
|
|
1777
|
+
/** Total number of RSVPs. */
|
|
1778
|
+
total?: number;
|
|
1779
|
+
/** Number of RSVPs with status `YES`. */
|
|
1780
|
+
yes?: number;
|
|
1781
|
+
/** Number of RSVPs with status `NO`. */
|
|
1782
|
+
no?: number;
|
|
1783
|
+
/** Number of RSVPs in waitlist. */
|
|
1784
|
+
waitlist?: number;
|
|
1785
|
+
}
|
|
1786
|
+
export interface TicketingSummary {
|
|
1787
|
+
/** Number of tickets sold. */
|
|
1788
|
+
tickets?: number;
|
|
1789
|
+
/**
|
|
1790
|
+
* Total revenue, excluding fees.
|
|
1791
|
+
* (taxes and payment provider fees are not deducted.)
|
|
1792
|
+
*/
|
|
1793
|
+
revenue?: EventsMoney;
|
|
1794
|
+
/** Whether currency is locked and cannot be changed (generally occurs after the first order in the specified currency has been created). */
|
|
1795
|
+
currencyLocked?: boolean;
|
|
1796
|
+
/** Number of orders placed. */
|
|
1797
|
+
orders?: number;
|
|
1798
|
+
/** Total balance of confirmed transactions. */
|
|
1799
|
+
totalSales?: EventsMoney;
|
|
1800
|
+
}
|
|
1801
|
+
export interface GuestListConfig {
|
|
1802
|
+
/** Whether members can see other members attending the event (defaults to true). */
|
|
1803
|
+
publicGuestList?: boolean;
|
|
1804
|
+
}
|
|
1805
|
+
export interface EventsFeed {
|
|
1806
|
+
/** Event discussion feed token. */
|
|
1807
|
+
token?: string;
|
|
1808
|
+
}
|
|
1809
|
+
export interface EventsOnlineConferencing {
|
|
1810
|
+
config?: OnlineConferencingConfig;
|
|
1811
|
+
session?: EventsOnlineConferencingSession;
|
|
1812
|
+
}
|
|
1813
|
+
export interface OnlineConferencingConfig {
|
|
1814
|
+
/**
|
|
1815
|
+
* Whether online conferencing is enabled (not supported for TBD schedules).
|
|
1816
|
+
* When enabled, links to join conferencing are generated and provided to guests.
|
|
1817
|
+
*/
|
|
1818
|
+
enabled?: boolean;
|
|
1819
|
+
/** Conferencing provider ID. */
|
|
1820
|
+
providerId?: string | null;
|
|
1821
|
+
/** Conference type */
|
|
1822
|
+
conferenceType?: ConferenceType;
|
|
1823
|
+
}
|
|
1824
|
+
export declare enum ConferenceType {
|
|
1825
|
+
/** Everyone in the meeting can publish and subscribe video and audio. */
|
|
1826
|
+
MEETING = "MEETING",
|
|
1827
|
+
/** Guests can only subscribe to video and audio. */
|
|
1828
|
+
WEBINAR = "WEBINAR"
|
|
1829
|
+
}
|
|
1830
|
+
export interface EventsOnlineConferencingSession {
|
|
1831
|
+
/**
|
|
1832
|
+
* Link for event host to start the online conference session.
|
|
1833
|
+
* @readonly
|
|
1834
|
+
*/
|
|
1835
|
+
hostLink?: string;
|
|
1836
|
+
/**
|
|
1837
|
+
* Link for guests to join the online conference session.
|
|
1838
|
+
* @readonly
|
|
1839
|
+
*/
|
|
1840
|
+
guestLink?: string;
|
|
1841
|
+
/**
|
|
1842
|
+
* The password required to join online conferencing session (when relevant).
|
|
1843
|
+
* @readonly
|
|
1844
|
+
*/
|
|
1845
|
+
password?: string | null;
|
|
1846
|
+
/**
|
|
1847
|
+
* Indicates that session was created successfully on providers side.
|
|
1848
|
+
* @readonly
|
|
1849
|
+
*/
|
|
1850
|
+
sessionCreated?: boolean | null;
|
|
1851
|
+
/**
|
|
1852
|
+
* Unique session id
|
|
1853
|
+
* @readonly
|
|
1854
|
+
*/
|
|
1855
|
+
sessionId?: string | null;
|
|
1856
|
+
}
|
|
1857
|
+
export interface EventsSeoSettings {
|
|
1858
|
+
/** URL slug */
|
|
1859
|
+
slug?: string;
|
|
1860
|
+
/** Advanced SEO data */
|
|
1861
|
+
advancedSeoData?: SeoSchema;
|
|
1862
|
+
/**
|
|
1863
|
+
* Hidden from SEO Site Map
|
|
1864
|
+
* @readonly
|
|
1865
|
+
*/
|
|
1866
|
+
hidden?: boolean | null;
|
|
1867
|
+
}
|
|
1868
|
+
export interface Agenda {
|
|
1869
|
+
/** Whether the schedule is enabled for the event. */
|
|
1870
|
+
enabled?: boolean;
|
|
1871
|
+
/**
|
|
1872
|
+
* Agenda page URL.
|
|
1873
|
+
* @readonly
|
|
1874
|
+
*/
|
|
1875
|
+
pageUrl?: SiteUrl;
|
|
1876
|
+
}
|
|
1877
|
+
export interface Category {
|
|
1878
|
+
/**
|
|
1879
|
+
* Category ID.
|
|
1880
|
+
* @readonly
|
|
1881
|
+
*/
|
|
1882
|
+
_id?: string;
|
|
1883
|
+
/** Category name. */
|
|
1884
|
+
name?: string;
|
|
1885
|
+
/**
|
|
1886
|
+
* Category creation timestamp.
|
|
1887
|
+
* @readonly
|
|
1888
|
+
*/
|
|
1889
|
+
_createdDate?: Date;
|
|
1890
|
+
/**
|
|
1891
|
+
* Assigned events count. Deleted events are excluded.
|
|
1892
|
+
* @readonly
|
|
1893
|
+
*/
|
|
1894
|
+
assignedEventsCount?: number | null;
|
|
1895
|
+
/**
|
|
1896
|
+
* Assigned and assigned draft event counts.
|
|
1897
|
+
* @readonly
|
|
1898
|
+
*/
|
|
1899
|
+
counts?: CategoryCounts;
|
|
1900
|
+
/**
|
|
1901
|
+
* Category state. Default - MANUAL.
|
|
1902
|
+
* WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission is required to use other states.
|
|
1903
|
+
* Field will be ignored on update requests.
|
|
1904
|
+
*/
|
|
1905
|
+
states?: State[];
|
|
1906
|
+
}
|
|
1907
|
+
export interface CategoryCounts {
|
|
1908
|
+
/** Assigned events count. Deleted events are excluded. */
|
|
1909
|
+
assignedEventsCount?: number | null;
|
|
1910
|
+
/** Assigned draft events count. */
|
|
1911
|
+
assignedDraftEventsCount?: number | null;
|
|
1912
|
+
}
|
|
1913
|
+
export declare enum State {
|
|
1914
|
+
/** Created manually by the user. */
|
|
1915
|
+
MANUAL = "MANUAL",
|
|
1916
|
+
/** Created automatically. */
|
|
1917
|
+
AUTO = "AUTO",
|
|
1918
|
+
/** Created when publishing recurring events. */
|
|
1919
|
+
RECURRING_EVENT = "RECURRING_EVENT",
|
|
1920
|
+
/** Category is hidden. */
|
|
1921
|
+
HIDDEN = "HIDDEN",
|
|
1922
|
+
/** Category is used to store component events. */
|
|
1923
|
+
COMPONENT = "COMPONENT"
|
|
1924
|
+
}
|
|
1925
|
+
export interface EventDisplaySettings {
|
|
1926
|
+
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
1927
|
+
hideEventDetailsButton?: boolean | null;
|
|
1928
|
+
}
|
|
1929
|
+
export interface Empty {
|
|
1930
|
+
}
|
|
1931
|
+
export interface EventUpdated {
|
|
1932
|
+
/** Event update timestamp in ISO UTC format. */
|
|
1933
|
+
timestamp?: Date;
|
|
1934
|
+
/** Event ID. */
|
|
1935
|
+
eventId?: string;
|
|
1936
|
+
/** Event location. */
|
|
1937
|
+
location?: EventsLocation;
|
|
1938
|
+
/** Event schedule configuration. */
|
|
1939
|
+
scheduleConfig?: ScheduleConfig;
|
|
1940
|
+
/** Event title. */
|
|
1941
|
+
title?: string;
|
|
1942
|
+
/** Whether schedule configuration was updated. */
|
|
1943
|
+
scheduleConfigUpdated?: boolean;
|
|
1944
|
+
/** Updated event */
|
|
1945
|
+
event?: Event;
|
|
1946
|
+
}
|
|
1947
|
+
export interface EventDeleted {
|
|
1948
|
+
/** Event deleted timestamp in ISO UTC format. */
|
|
1949
|
+
timestamp?: Date;
|
|
1950
|
+
/** Event ID. */
|
|
1951
|
+
eventId?: string;
|
|
1952
|
+
/** Event title. */
|
|
1953
|
+
title?: string;
|
|
1954
|
+
/** Event creator user ID. */
|
|
1955
|
+
userId?: string | null;
|
|
1956
|
+
}
|
|
1957
|
+
export interface EventCopied {
|
|
1958
|
+
/** Event created timestamp in ISO UTC format. */
|
|
1959
|
+
timestamp?: Date;
|
|
1960
|
+
/** Event ID. */
|
|
1961
|
+
eventId?: string;
|
|
1962
|
+
/** Event location. */
|
|
1963
|
+
location?: EventsLocation;
|
|
1964
|
+
/** Event schedule configuration. */
|
|
1965
|
+
scheduleConfig?: ScheduleConfig;
|
|
1966
|
+
/** Event title. */
|
|
1967
|
+
title?: string;
|
|
1968
|
+
/** Event creator user ID. */
|
|
1969
|
+
userId?: string | null;
|
|
1970
|
+
/** Event status. */
|
|
1971
|
+
status?: EventStatus;
|
|
1972
|
+
/** Instance ID. Indicates the original app instance which current event was derived from. */
|
|
1973
|
+
derivedFromInstanceId?: string | null;
|
|
1974
|
+
/** Event ID. Indicates the original event which current event was derived from. */
|
|
1975
|
+
derivedFromEventId?: string | null;
|
|
1976
|
+
/**
|
|
1977
|
+
* Map of copied ticket definitions from original event.
|
|
1978
|
+
* Key represents ticket def id in the original event.
|
|
1979
|
+
* Value represents ticket def id in the newly created event.
|
|
1980
|
+
*/
|
|
1981
|
+
ticketDefinitions?: Record<string, string>;
|
|
1982
|
+
}
|
|
1554
1983
|
export interface EventPublished {
|
|
1555
1984
|
/** Event publish timestamp in ISO UTC format. */
|
|
1556
1985
|
timestamp?: Date;
|
|
@@ -3350,11 +3779,13 @@ export interface FindEventResponseNonNullableFields {
|
|
|
3350
3779
|
* @requiredField event.location
|
|
3351
3780
|
* @requiredField event.title
|
|
3352
3781
|
* @permissionScope Manage Events - all permissions
|
|
3782
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3353
3783
|
* @permissionScope Manage Events
|
|
3784
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3354
3785
|
* @applicableIdentity APP
|
|
3355
3786
|
* @returns Created event.
|
|
3356
3787
|
*/
|
|
3357
|
-
export declare function createEvent(event:
|
|
3788
|
+
export declare function createEvent(event: V3Event, options?: CreateEventOptions): Promise<V3Event & NonNullable<CreateEventResponseNonNullableFields>['event']>;
|
|
3358
3789
|
export interface CreateEventOptions {
|
|
3359
3790
|
/** Whether to create the event as a draft. */
|
|
3360
3791
|
draft?: boolean;
|
|
@@ -3384,13 +3815,15 @@ export interface CreateEventOptions {
|
|
|
3384
3815
|
* @documentationMaturity preview
|
|
3385
3816
|
* @requiredField eventId
|
|
3386
3817
|
* @permissionScope Manage Events - all permissions
|
|
3818
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3387
3819
|
* @permissionScope Manage Events
|
|
3820
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3388
3821
|
* @applicableIdentity APP
|
|
3389
3822
|
*/
|
|
3390
3823
|
export declare function cloneEvent(eventId: string, options?: CloneEventOptions): Promise<CloneEventResponse & CloneEventResponseNonNullableFields>;
|
|
3391
3824
|
export interface CloneEventOptions {
|
|
3392
3825
|
/** Field values to be changed when cloning the event. */
|
|
3393
|
-
event?:
|
|
3826
|
+
event?: V3Event;
|
|
3394
3827
|
/** Whether to clone the event as a draft. */
|
|
3395
3828
|
draft?: boolean;
|
|
3396
3829
|
/**
|
|
@@ -3416,11 +3849,13 @@ export interface CloneEventOptions {
|
|
|
3416
3849
|
* @documentationMaturity preview
|
|
3417
3850
|
* @requiredField _id
|
|
3418
3851
|
* @permissionScope Manage Events - all permissions
|
|
3852
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3419
3853
|
* @permissionScope Manage Events
|
|
3854
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3420
3855
|
* @applicableIdentity APP
|
|
3421
3856
|
* @returns Updated event.
|
|
3422
3857
|
*/
|
|
3423
|
-
export declare function updateEvent(_id: string, options?: UpdateEventOptions): Promise<
|
|
3858
|
+
export declare function updateEvent(_id: string, options?: UpdateEventOptions): Promise<V3Event & NonNullable<UpdateEventResponseNonNullableFields>['event']>;
|
|
3424
3859
|
export interface UpdateEventOptions {
|
|
3425
3860
|
event: {
|
|
3426
3861
|
/**
|
|
@@ -3485,7 +3920,7 @@ export interface UpdateEventOptions {
|
|
|
3485
3920
|
/** Event schedule details. */
|
|
3486
3921
|
agendaSettings?: AgendaSettings;
|
|
3487
3922
|
/** Visual settings for event. */
|
|
3488
|
-
eventDisplaySettings?:
|
|
3923
|
+
eventDisplaySettings?: V3EventDisplaySettings;
|
|
3489
3924
|
};
|
|
3490
3925
|
/**
|
|
3491
3926
|
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
@@ -3511,7 +3946,9 @@ export interface UpdateEventOptions {
|
|
|
3511
3946
|
* @documentationMaturity preview
|
|
3512
3947
|
* @requiredField eventId
|
|
3513
3948
|
* @permissionScope Manage Events - all permissions
|
|
3949
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3514
3950
|
* @permissionScope Manage Events
|
|
3951
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3515
3952
|
* @applicableIdentity APP
|
|
3516
3953
|
*/
|
|
3517
3954
|
export declare function publishDraftEvent(eventId: string, options?: PublishDraftEventOptions): Promise<PublishDraftEventResponse & PublishDraftEventResponseNonNullableFields>;
|
|
@@ -3541,7 +3978,9 @@ export interface PublishDraftEventOptions {
|
|
|
3541
3978
|
* @documentationMaturity preview
|
|
3542
3979
|
* @requiredField eventId
|
|
3543
3980
|
* @permissionScope Manage Events - all permissions
|
|
3981
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3544
3982
|
* @permissionScope Manage Events
|
|
3983
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3545
3984
|
* @applicableIdentity APP
|
|
3546
3985
|
*/
|
|
3547
3986
|
export declare function cancelEvent(eventId: string, options?: CancelEventOptions): Promise<CancelEventResponse & CancelEventResponseNonNullableFields>;
|
|
@@ -3570,7 +4009,9 @@ export interface CancelEventOptions {
|
|
|
3570
4009
|
* @documentationMaturity preview
|
|
3571
4010
|
* @requiredField options.filter.filter
|
|
3572
4011
|
* @permissionScope Manage Events - all permissions
|
|
4012
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3573
4013
|
* @permissionScope Manage Events
|
|
4014
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3574
4015
|
* @applicableIdentity APP
|
|
3575
4016
|
*/
|
|
3576
4017
|
export declare function bulkCancelEventsByFilter(options?: BulkCancelEventsByFilterOptions): Promise<void>;
|
|
@@ -3586,7 +4027,9 @@ export interface BulkCancelEventsByFilterOptions {
|
|
|
3586
4027
|
* @documentationMaturity preview
|
|
3587
4028
|
* @requiredField eventId
|
|
3588
4029
|
* @permissionScope Manage Events - all permissions
|
|
4030
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3589
4031
|
* @permissionScope Manage Events
|
|
4032
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3590
4033
|
* @applicableIdentity APP
|
|
3591
4034
|
*/
|
|
3592
4035
|
export declare function deleteEvent(eventId: string): Promise<DeleteEventResponse & DeleteEventResponseNonNullableFields>;
|
|
@@ -3597,7 +4040,9 @@ export declare function deleteEvent(eventId: string): Promise<DeleteEventRespons
|
|
|
3597
4040
|
* @documentationMaturity preview
|
|
3598
4041
|
* @requiredField options.filter.filter
|
|
3599
4042
|
* @permissionScope Manage Events - all permissions
|
|
4043
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3600
4044
|
* @permissionScope Manage Events
|
|
4045
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3601
4046
|
* @applicableIdentity APP
|
|
3602
4047
|
*/
|
|
3603
4048
|
export declare function bulkDeleteEventsByFilter(options?: BulkDeleteEventsByFilterOptions): Promise<void>;
|
|
@@ -3616,11 +4061,17 @@ export interface BulkDeleteEventsByFilterOptions {
|
|
|
3616
4061
|
* @public
|
|
3617
4062
|
* @documentationMaturity preview
|
|
3618
4063
|
* @permissionScope Read Events - all read permissions
|
|
4064
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3619
4065
|
* @permissionScope Manage Bookings Services and Settings
|
|
4066
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
3620
4067
|
* @permissionScope Manage Events - all permissions
|
|
4068
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3621
4069
|
* @permissionScope Read Events
|
|
4070
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3622
4071
|
* @permissionScope Manage Guest List
|
|
4072
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3623
4073
|
* @permissionScope Manage Events
|
|
4074
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3624
4075
|
* @applicableIdentity APP
|
|
3625
4076
|
* @applicableIdentity MEMBER
|
|
3626
4077
|
* @applicableIdentity VISITOR
|
|
@@ -3658,7 +4109,7 @@ interface QueryOffsetResult {
|
|
|
3658
4109
|
pageSize: number;
|
|
3659
4110
|
}
|
|
3660
4111
|
export interface EventsQueryResult extends QueryOffsetResult {
|
|
3661
|
-
items:
|
|
4112
|
+
items: V3Event[];
|
|
3662
4113
|
query: EventsQueryBuilder;
|
|
3663
4114
|
next: () => Promise<EventsQueryResult>;
|
|
3664
4115
|
prev: () => Promise<EventsQueryResult>;
|
|
@@ -3721,11 +4172,17 @@ export interface EventsQueryBuilder {
|
|
|
3721
4172
|
* @public
|
|
3722
4173
|
* @documentationMaturity preview
|
|
3723
4174
|
* @permissionScope Read Events - all read permissions
|
|
4175
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3724
4176
|
* @permissionScope Manage Bookings Services and Settings
|
|
4177
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
3725
4178
|
* @permissionScope Manage Events - all permissions
|
|
4179
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3726
4180
|
* @permissionScope Read Events
|
|
4181
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3727
4182
|
* @permissionScope Manage Guest List
|
|
4183
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3728
4184
|
* @permissionScope Manage Events
|
|
4185
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3729
4186
|
* @applicableIdentity APP
|
|
3730
4187
|
* @applicableIdentity MEMBER
|
|
3731
4188
|
* @applicableIdentity VISITOR
|
|
@@ -3753,17 +4210,23 @@ export interface CountEventsByStatusOptions {
|
|
|
3753
4210
|
* @documentationMaturity preview
|
|
3754
4211
|
* @requiredField eventId
|
|
3755
4212
|
* @permissionScope Read Events - all read permissions
|
|
4213
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3756
4214
|
* @permissionScope Manage Bookings Services and Settings
|
|
4215
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
3757
4216
|
* @permissionScope Manage Events - all permissions
|
|
4217
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3758
4218
|
* @permissionScope Read Events
|
|
4219
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3759
4220
|
* @permissionScope Manage Guest List
|
|
4221
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3760
4222
|
* @permissionScope Manage Events
|
|
4223
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3761
4224
|
* @applicableIdentity APP
|
|
3762
4225
|
* @applicableIdentity MEMBER
|
|
3763
4226
|
* @applicableIdentity VISITOR
|
|
3764
4227
|
* @returns Event.
|
|
3765
4228
|
*/
|
|
3766
|
-
export declare function getEvent(eventId: string | null, options?: GetEventOptions): Promise<
|
|
4229
|
+
export declare function getEvent(eventId: string | null, options?: GetEventOptions): Promise<V3Event & NonNullable<GetEventResponseNonNullableFields>['event']>;
|
|
3767
4230
|
export interface GetEventOptions {
|
|
3768
4231
|
/**
|
|
3769
4232
|
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
@@ -3788,11 +4251,17 @@ export interface GetEventOptions {
|
|
|
3788
4251
|
* @documentationMaturity preview
|
|
3789
4252
|
* @requiredField slug
|
|
3790
4253
|
* @permissionScope Read Events - all read permissions
|
|
4254
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3791
4255
|
* @permissionScope Manage Bookings Services and Settings
|
|
4256
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
3792
4257
|
* @permissionScope Manage Events - all permissions
|
|
4258
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3793
4259
|
* @permissionScope Read Events
|
|
4260
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3794
4261
|
* @permissionScope Manage Guest List
|
|
4262
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3795
4263
|
* @permissionScope Manage Events
|
|
4264
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3796
4265
|
* @applicableIdentity APP
|
|
3797
4266
|
* @applicableIdentity MEMBER
|
|
3798
4267
|
* @applicableIdentity VISITOR
|
|
@@ -3821,11 +4290,17 @@ export interface GetEventBySlugOptions {
|
|
|
3821
4290
|
* @public
|
|
3822
4291
|
* @documentationMaturity preview
|
|
3823
4292
|
* @permissionScope Read Events - all read permissions
|
|
4293
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
3824
4294
|
* @permissionScope Manage Bookings Services and Settings
|
|
4295
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
3825
4296
|
* @permissionScope Manage Events - all permissions
|
|
4297
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
3826
4298
|
* @permissionScope Read Events
|
|
4299
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
3827
4300
|
* @permissionScope Manage Guest List
|
|
4301
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
3828
4302
|
* @permissionScope Manage Events
|
|
4303
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
3829
4304
|
* @applicableIdentity APP
|
|
3830
4305
|
* @applicableIdentity MEMBER
|
|
3831
4306
|
* @applicableIdentity VISITOR
|