@wix/auto_sdk_events_wix-events-v-2 1.0.37 → 1.0.39
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/index.d.ts +65 -58
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/{events-v3-event-wix-events-v-2.universal-DItP6oop.d.ts → index.typings.d.ts} +647 -126
- package/build/cjs/index.typings.js +2154 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +25 -24
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +65 -58
- package/build/es/index.mjs.map +1 -1
- package/build/es/{events-v3-event-wix-events-v-2.universal-DItP6oop.d.mts → index.typings.d.mts} +647 -126
- package/build/es/index.typings.mjs +2057 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +25 -24
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +65 -58
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/{events-v3-event-wix-events-v-2.universal-DItP6oop.d.ts → index.typings.d.ts} +647 -126
- package/build/internal/cjs/index.typings.js +2154 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +25 -24
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +65 -58
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/{events-v3-event-wix-events-v-2.universal-DItP6oop.d.mts → index.typings.d.mts} +647 -126
- package/build/internal/es/index.typings.mjs +2057 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +25 -24
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -3
package/build/es/{events-v3-event-wix-events-v-2.universal-DItP6oop.d.mts → index.typings.d.mts}
RENAMED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
interface V3Event {
|
|
2
4
|
/**
|
|
3
5
|
* Event ID.
|
|
@@ -17,11 +19,14 @@ interface V3Event {
|
|
|
17
19
|
title?: string | null;
|
|
18
20
|
/**
|
|
19
21
|
* Short description that appears under the event title.
|
|
22
|
+
* **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.
|
|
20
23
|
* @maxLength 500
|
|
21
24
|
*/
|
|
22
25
|
shortDescription?: string | null;
|
|
23
26
|
/**
|
|
24
|
-
* Detailed description of an event.
|
|
27
|
+
* Detailed description of an event.
|
|
28
|
+
*
|
|
29
|
+
* This field is deprecated.
|
|
25
30
|
* @maxLength 50000
|
|
26
31
|
* @deprecated Detailed description of an event.
|
|
27
32
|
*
|
|
@@ -51,13 +56,7 @@ interface V3Event {
|
|
|
51
56
|
*/
|
|
52
57
|
_updatedDate?: Date | null;
|
|
53
58
|
/**
|
|
54
|
-
* Event status
|
|
55
|
-
*
|
|
56
|
-
* - `UPCOMING`: Event is published and scheduled to start.
|
|
57
|
-
* - `STARTED`: Event has started.
|
|
58
|
-
* - `ENDED`: Event has ended.
|
|
59
|
-
* - `CANCELED`: Event is canceled.
|
|
60
|
-
* - `DRAFT`: Event is not published.
|
|
59
|
+
* Event status.
|
|
61
60
|
* @readonly
|
|
62
61
|
*/
|
|
63
62
|
status?: StatusWithLiterals;
|
|
@@ -122,11 +121,7 @@ interface V3Event {
|
|
|
122
121
|
agendaSettings?: AgendaSettings;
|
|
123
122
|
/** Visual settings for event. */
|
|
124
123
|
eventDisplaySettings?: V3EventDisplaySettings;
|
|
125
|
-
/**
|
|
126
|
-
* Event description with rich content.
|
|
127
|
-
*
|
|
128
|
-
* For the event description to appear on your site, connect the [Rich Content Viewer](https://dev.wix.com/docs/velo/velo-only-apis/$w/rich-content-viewer/introduction) element, and assign the description value to the viewer.
|
|
129
|
-
*/
|
|
124
|
+
/** Event description. <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="emoji,audio,codeBlock,collapsibleList,divider,emoji,file,gallery,giphy,hashtag,heading,html,image,indent,lineSpacing,link,linkPreview,spoiler,video" exampleid="9b569a8d-0fc1-40f4-987f-8bd40ecc72d0">Fallback Message for SSR and Error</widget> */
|
|
130
125
|
description?: RichContent;
|
|
131
126
|
/**
|
|
132
127
|
* Event publish timestamp.
|
|
@@ -140,12 +135,7 @@ interface Location {
|
|
|
140
135
|
* @maxLength 50
|
|
141
136
|
*/
|
|
142
137
|
name?: string | null;
|
|
143
|
-
/**
|
|
144
|
-
* Location type:
|
|
145
|
-
*
|
|
146
|
-
* - `VENUE`: The event is on-site at a specific physical location.
|
|
147
|
-
* - `ONLINE`: The event is online, such as a virtual video conference.
|
|
148
|
-
*/
|
|
138
|
+
/** Location type. */
|
|
149
139
|
type?: LocationTypeWithLiterals;
|
|
150
140
|
/** Exact location address. */
|
|
151
141
|
address?: CommonAddress;
|
|
@@ -260,11 +250,15 @@ declare enum SubdivisionSubdivisionType {
|
|
|
260
250
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
261
251
|
COUNTRY = "COUNTRY"
|
|
262
252
|
}
|
|
253
|
+
/** @enumType */
|
|
254
|
+
type SubdivisionSubdivisionTypeWithLiterals = SubdivisionSubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
263
255
|
interface DateAndTimeSettings {
|
|
264
256
|
/** Whether the event date and time are TBD. */
|
|
265
257
|
dateAndTimeTbd?: boolean | null;
|
|
266
258
|
/**
|
|
267
259
|
* Message that is displayed when time and date is TBD.
|
|
260
|
+
*
|
|
261
|
+
* **Note:** This field is only used when the `dateAndTimeTbd` field value is `true`.
|
|
268
262
|
* @maxLength 100
|
|
269
263
|
*/
|
|
270
264
|
dateAndTimeTbdMessage?: string | null;
|
|
@@ -292,13 +286,7 @@ interface DateAndTimeSettings {
|
|
|
292
286
|
/** Whether the time zone is displayed in the formatted schedule. */
|
|
293
287
|
showTimeZone?: boolean | null;
|
|
294
288
|
/**
|
|
295
|
-
* Repeating event status.
|
|
296
|
-
*
|
|
297
|
-
* - `ONE_TIME`: The event happens only once and can last multiple days.
|
|
298
|
-
* - `RECURRING`: A series of events that repeat.
|
|
299
|
-
* - `RECURRING_UPCOMING`: Next event in a schedule of recurring events.
|
|
300
|
-
* - `RECURRING_RECENTLY_ENDED`: Latest event that ended in a schedule of recurring events.
|
|
301
|
-
* - `RECURRING_RECENTLY_CANCELED`: Latest canceled event tin a schedule of recurring events.
|
|
289
|
+
* Repeating event status.
|
|
302
290
|
* @readonly
|
|
303
291
|
*/
|
|
304
292
|
recurrenceStatus?: RecurrenceStatusStatusWithLiterals;
|
|
@@ -325,7 +313,7 @@ declare enum RecurrenceStatusStatus {
|
|
|
325
313
|
type RecurrenceStatusStatusWithLiterals = RecurrenceStatusStatus | 'UNKNOWN_STATUS' | 'ONE_TIME' | 'RECURRING' | 'RECURRING_UPCOMING' | 'RECURRING_RECENTLY_ENDED' | 'RECURRING_RECENTLY_CANCELED';
|
|
326
314
|
interface Recurrences {
|
|
327
315
|
/**
|
|
328
|
-
* Individual event dates
|
|
316
|
+
* Individual event dates.
|
|
329
317
|
* @maxSize 1000
|
|
330
318
|
*/
|
|
331
319
|
individualEventDates?: Occurrence[];
|
|
@@ -351,9 +339,8 @@ interface Occurrence {
|
|
|
351
339
|
}
|
|
352
340
|
interface Formatted {
|
|
353
341
|
/**
|
|
354
|
-
* Formatted date and time representation.
|
|
355
|
-
*
|
|
356
|
-
* Example of formatting when an event lasts multiple days and is in the UTC time zone: `September 1, 2015 at 10:20 AM – September 5, 2015 at 12:14 PM`.
|
|
342
|
+
* Formatted date and time representation. <br>
|
|
343
|
+
* Example of formatting when an event lasts multiple days and is in the UTC time zone: `September 1, 2015 at 10:20 AM – September 5, 2015 at 12:14 PM`. <br>
|
|
357
344
|
* Example of formatting when an event lasts 1 day and is in the GMT+2 time zone: `February 1, 2018, 12:10 – 2:50 PM GMT+2`.
|
|
358
345
|
* @readonly
|
|
359
346
|
* @maxLength 500
|
|
@@ -420,27 +407,12 @@ declare enum Status {
|
|
|
420
407
|
type StatusWithLiterals = Status | 'UNKNOWN_EVENT_STATUS' | 'UPCOMING' | 'STARTED' | 'ENDED' | 'CANCELED' | 'DRAFT';
|
|
421
408
|
interface Registration {
|
|
422
409
|
/**
|
|
423
|
-
* Current registration type
|
|
424
|
-
*
|
|
425
|
-
* - `RSVP`: Guests register by RSVPing to the event.
|
|
426
|
-
* - `TICKETING`: Guests register by buying tickets.
|
|
427
|
-
* - `EXTERNAL`: Guests register externally using some other site or platform.
|
|
428
|
-
* - `NONE`: No registration is required, all guests can attend. This registration type is for only displaying the event details on a site.
|
|
429
|
-
*
|
|
430
|
-
* The property value might change to `EXTERNAL` or `NONE` after initial event creation, depending on any additional configuration applied to the event.
|
|
410
|
+
* Current registration type.
|
|
431
411
|
* @readonly
|
|
432
412
|
*/
|
|
433
413
|
type?: RegistrationTypeTypeWithLiterals;
|
|
434
414
|
/**
|
|
435
|
-
* Registration status.
|
|
436
|
-
*
|
|
437
|
-
* - `CLOSED_AUTOMATICALLY`: Registration is closed after tickets are sold out.
|
|
438
|
-
* - `CLOSED_MANUALLY`: Registration is closed when the `registration.registrationDisabled` property is set to `true`.
|
|
439
|
-
* - `OPEN_RSVP`: Guests can start RSVPing to the event.
|
|
440
|
-
* - `OPEN_RSVP_WAITLIST_ONLY`: Guest list has reached the maximum, new guests are added to a waitlist.
|
|
441
|
-
* - `OPEN_TICKETS`: Guests can buy tickets to the event.
|
|
442
|
-
* - `OPEN_EXTERNAL`: Guests register on a different page or web address.
|
|
443
|
-
* - `SCHEDULED_RSVP`: Registration via RSVP is scheduled for the future.
|
|
415
|
+
* Registration status.
|
|
444
416
|
* @readonly
|
|
445
417
|
*/
|
|
446
418
|
status?: RegistrationStatusStatusWithLiterals;
|
|
@@ -450,20 +422,10 @@ interface Registration {
|
|
|
450
422
|
tickets?: TicketsRegistration;
|
|
451
423
|
/** External registration details. */
|
|
452
424
|
external?: ExternalRegistration;
|
|
453
|
-
/**
|
|
454
|
-
* Types of guests allowed to register. Possible values:
|
|
455
|
-
*
|
|
456
|
-
* - `VISITOR_OR_MEMBER`: All site visitors can RSVP to the event.
|
|
457
|
-
* - `MEMBER`: Only people who have signed up as members of your site are able to RSVP to the event.
|
|
458
|
-
*/
|
|
425
|
+
/** Types of guests allowed to register. */
|
|
459
426
|
allowedGuestTypes?: GuestTypeTypeWithLiterals;
|
|
460
427
|
/**
|
|
461
|
-
* Initial event type which is set when creating an event.
|
|
462
|
-
*
|
|
463
|
-
* - `RSVP`: Guests register by RSVPing to the event.
|
|
464
|
-
* - `TICKETING`: Guests register by buying tickets.
|
|
465
|
-
*
|
|
466
|
-
* This property value never changes.
|
|
428
|
+
* Initial event type which is set when creating an event.
|
|
467
429
|
* @immutable
|
|
468
430
|
*/
|
|
469
431
|
initialType?: InitialRegistrationTypeTypeWithLiterals;
|
|
@@ -481,13 +443,13 @@ declare enum RegistrationTypeType {
|
|
|
481
443
|
TICKETING = "TICKETING",
|
|
482
444
|
/** Guests register externally using some other site or platform. */
|
|
483
445
|
EXTERNAL = "EXTERNAL",
|
|
484
|
-
/** No registration is required, all guests can attend. This registration type is for only displaying the event details on a site. The property value can be changed from RSVP
|
|
446
|
+
/** No registration is required, all guests can attend. This registration type is for only displaying the event details on a site. The property value can be changed from `RSVP` or `TICKETING `to `EXTERNAL` or `NONE` after the event is created, depending on any additional configurations applied to the event. */
|
|
485
447
|
NONE = "NONE"
|
|
486
448
|
}
|
|
487
449
|
/** @enumType */
|
|
488
450
|
type RegistrationTypeTypeWithLiterals = RegistrationTypeType | 'UNKNOWN_REGISTRATION_TYPE' | 'RSVP' | 'TICKETING' | 'EXTERNAL' | 'NONE';
|
|
489
451
|
declare enum RegistrationStatusStatus {
|
|
490
|
-
/** Registration status
|
|
452
|
+
/** Registration status isn't applicable. */
|
|
491
453
|
UNKNOWN_REGISTRATION_STATUS = "UNKNOWN_REGISTRATION_STATUS",
|
|
492
454
|
/** Registration is closed after tickets are sold out. */
|
|
493
455
|
CLOSED_AUTOMATICALLY = "CLOSED_AUTOMATICALLY",
|
|
@@ -511,7 +473,7 @@ interface RsvpRegistration {
|
|
|
511
473
|
responseType?: ResponseTypeWithLiterals;
|
|
512
474
|
/** How many guests can RSVP to an event. */
|
|
513
475
|
limit?: number | null;
|
|
514
|
-
/** Whether a waitlist is opened when the total guest limit is reached. If `true`, guests can RSVP to an event and are automatically
|
|
476
|
+
/** Whether a waitlist is opened when the total guest limit is reached. If `true`, guests can RSVP to an event and are automatically added to the waitlist with the `IN_WAITLIST` status. */
|
|
515
477
|
waitlistEnabled?: boolean;
|
|
516
478
|
/** Registration start date. */
|
|
517
479
|
startDate?: Date | null;
|
|
@@ -532,7 +494,7 @@ interface TicketsRegistration {
|
|
|
532
494
|
/** Whether the registration form must be filled out separately for each ticket. */
|
|
533
495
|
guestsAssignedSeparately?: boolean;
|
|
534
496
|
/**
|
|
535
|
-
* Ticket limit per order.
|
|
497
|
+
* Ticket limit per order. <br>
|
|
536
498
|
* Default: 20 tickets.
|
|
537
499
|
* @max 50
|
|
538
500
|
*/
|
|
@@ -585,12 +547,7 @@ interface Money {
|
|
|
585
547
|
formattedValue?: string | null;
|
|
586
548
|
}
|
|
587
549
|
interface TaxSettings {
|
|
588
|
-
/**
|
|
589
|
-
* Tax application settings:
|
|
590
|
-
*
|
|
591
|
-
* - `INCLUDED_IN_PRICE`: Deduct the fee from the ticket price for a seller. For example, if you're selling tickets for $10, a ticket service fee of $0.25 is deducted from the price and you'll get $9.75.
|
|
592
|
-
* - `ADDED_AT_CHECKOUT`: Show the fee iin addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer sees a ticket service fee of $0.25 and pays $10.25 in total.
|
|
593
|
-
*/
|
|
550
|
+
/** Tax application settings. */
|
|
594
551
|
type?: TaxTypeWithLiterals;
|
|
595
552
|
/**
|
|
596
553
|
* Tax name.
|
|
@@ -599,7 +556,7 @@ interface TaxSettings {
|
|
|
599
556
|
*/
|
|
600
557
|
name?: string | null;
|
|
601
558
|
/**
|
|
602
|
-
* Tax rate
|
|
559
|
+
* Tax rate. For example, `21.55`.
|
|
603
560
|
* @decimalValue options { gte:0.001, lte:100, maxScale:3 }
|
|
604
561
|
*/
|
|
605
562
|
rate?: string | null;
|
|
@@ -610,9 +567,9 @@ interface TaxSettings {
|
|
|
610
567
|
declare enum TaxType {
|
|
611
568
|
/** Unknown tax type. */
|
|
612
569
|
UNKNOWN_TAX_TYPE = "UNKNOWN_TAX_TYPE",
|
|
613
|
-
/** Deduct the fee from the ticket price for a seller. For example, if you're selling tickets for $10, a ticket
|
|
570
|
+
/** Deduct the fee from the ticket price for a seller. For example, if you're selling tickets for $10, a ticket service fee of $0.25 is deducted from the price and you'll get $9.75. */
|
|
614
571
|
INCLUDED_IN_PRICE = "INCLUDED_IN_PRICE",
|
|
615
|
-
/** Show the fee in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer sees a ticket
|
|
572
|
+
/** Show the fee in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer sees a ticket service fee of $0.25 and pays $10.25 in total. */
|
|
616
573
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
617
574
|
}
|
|
618
575
|
/** @enumType */
|
|
@@ -646,7 +603,7 @@ declare enum InitialRegistrationTypeType {
|
|
|
646
603
|
type InitialRegistrationTypeTypeWithLiterals = InitialRegistrationTypeType | 'UNKNOWN_INITIAL_REGISTRATION_TYPE' | 'RSVP' | 'TICKETING';
|
|
647
604
|
interface CalendarUrls {
|
|
648
605
|
/**
|
|
649
|
-
* "Add to Google
|
|
606
|
+
* "Add to Google Calendar" URL.
|
|
650
607
|
* @readonly
|
|
651
608
|
*/
|
|
652
609
|
google?: string;
|
|
@@ -918,7 +875,7 @@ interface TicketsUnavailableMessages {
|
|
|
918
875
|
interface Summaries {
|
|
919
876
|
/** RSVP summary of guests. */
|
|
920
877
|
rsvps?: Rsvps;
|
|
921
|
-
/** Summary of revenue and sold tickets. Archived orders
|
|
878
|
+
/** Summary of revenue and sold tickets. Archived orders aren't included. */
|
|
922
879
|
tickets?: Tickets;
|
|
923
880
|
}
|
|
924
881
|
interface EventsMoney {
|
|
@@ -929,7 +886,7 @@ interface EventsMoney {
|
|
|
929
886
|
*/
|
|
930
887
|
amount?: string;
|
|
931
888
|
/**
|
|
932
|
-
*
|
|
889
|
+
* 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `USD`.
|
|
933
890
|
* @format CURRENCY
|
|
934
891
|
*/
|
|
935
892
|
currency?: string;
|
|
@@ -973,7 +930,7 @@ interface Tickets {
|
|
|
973
930
|
*/
|
|
974
931
|
revenue?: EventsMoney;
|
|
975
932
|
/**
|
|
976
|
-
* Whether the currency is locked and can
|
|
933
|
+
* Whether the currency is locked and can't be changed.
|
|
977
934
|
* @readonly
|
|
978
935
|
*/
|
|
979
936
|
currencyLocked?: boolean;
|
|
@@ -989,7 +946,7 @@ interface Tickets {
|
|
|
989
946
|
totalSales?: EventsMoney;
|
|
990
947
|
}
|
|
991
948
|
interface GuestListSettings {
|
|
992
|
-
/** Whether the guest list is
|
|
949
|
+
/** Whether the guest list is displayed publicly to all guests. */
|
|
993
950
|
displayedPublicly?: boolean;
|
|
994
951
|
}
|
|
995
952
|
interface Feed {
|
|
@@ -997,19 +954,14 @@ interface Feed {
|
|
|
997
954
|
token?: string;
|
|
998
955
|
}
|
|
999
956
|
interface OnlineConferencing {
|
|
1000
|
-
/** Whether online conferencing is enabled. Not applicable for events
|
|
957
|
+
/** Whether online conferencing is enabled. Not applicable for events where date and time are TBD. When enabled, links to join the conference are generated and provided to guests. */
|
|
1001
958
|
enabled?: boolean;
|
|
1002
959
|
/**
|
|
1003
960
|
* Conference host ID.
|
|
1004
961
|
* @format GUID
|
|
1005
962
|
*/
|
|
1006
963
|
providerId?: string | null;
|
|
1007
|
-
/**
|
|
1008
|
-
* Conference type. Possible values:
|
|
1009
|
-
*
|
|
1010
|
-
* - `MEETING`: Guests can do some actions during the conference, for example talk, turn on camera and show their screen.
|
|
1011
|
-
* - `WEBINAR`: Guests can only watch the conference.
|
|
1012
|
-
*/
|
|
964
|
+
/** Conference type. */
|
|
1013
965
|
type?: ConferenceTypeTypeWithLiterals;
|
|
1014
966
|
/** Online conferencing session information. */
|
|
1015
967
|
session?: OnlineConferencingSession;
|
|
@@ -1060,7 +1012,7 @@ interface SeoSettings {
|
|
|
1060
1012
|
/** Advanced SEO data. */
|
|
1061
1013
|
advancedSeoData?: SeoSchema;
|
|
1062
1014
|
/**
|
|
1063
|
-
* Whether the slug is hidden from the SEO
|
|
1015
|
+
* Whether the slug is hidden from the SEO sitemap.
|
|
1064
1016
|
* @readonly
|
|
1065
1017
|
*/
|
|
1066
1018
|
hidden?: boolean | null;
|
|
@@ -2585,6 +2537,8 @@ declare enum NullValue {
|
|
|
2585
2537
|
/** Null value. */
|
|
2586
2538
|
NULL_VALUE = "NULL_VALUE"
|
|
2587
2539
|
}
|
|
2540
|
+
/** @enumType */
|
|
2541
|
+
type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
2588
2542
|
/**
|
|
2589
2543
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
2590
2544
|
*
|
|
@@ -2716,7 +2670,7 @@ interface EventEventStarted {
|
|
|
2716
2670
|
* @format GUID
|
|
2717
2671
|
*/
|
|
2718
2672
|
eventId?: string;
|
|
2719
|
-
/**
|
|
2673
|
+
/** Whether at least 1 guest is registered to the event with any attendance status. */
|
|
2720
2674
|
hasGuests?: boolean | null;
|
|
2721
2675
|
}
|
|
2722
2676
|
interface EventEventEnded {
|
|
@@ -2727,7 +2681,7 @@ interface EventEventEnded {
|
|
|
2727
2681
|
* @format GUID
|
|
2728
2682
|
*/
|
|
2729
2683
|
eventId?: string;
|
|
2730
|
-
/**
|
|
2684
|
+
/** Whether at least 1 guest is registered to the event with any attendance status. */
|
|
2731
2685
|
hasGuests?: boolean | null;
|
|
2732
2686
|
}
|
|
2733
2687
|
interface EventEventReminder {
|
|
@@ -2753,9 +2707,9 @@ interface EventEventReminder {
|
|
|
2753
2707
|
* @format GUID
|
|
2754
2708
|
*/
|
|
2755
2709
|
userId?: string | null;
|
|
2756
|
-
/** Time until the start of event
|
|
2710
|
+
/** Time until the start of event. By default, the reminder letter is triggered 1 day before the start of event. */
|
|
2757
2711
|
startsIn?: TimeDuration;
|
|
2758
|
-
/**
|
|
2712
|
+
/** Whether at least 1 guest is registered to the event with any attendance status. */
|
|
2759
2713
|
hasGuests?: boolean | null;
|
|
2760
2714
|
}
|
|
2761
2715
|
interface EventEventPublished {
|
|
@@ -2837,7 +2791,7 @@ interface EventCloned {
|
|
|
2837
2791
|
ticketDefinitions?: Record<string, string>;
|
|
2838
2792
|
}
|
|
2839
2793
|
interface EventEventCanceled {
|
|
2840
|
-
/** Event
|
|
2794
|
+
/** Event cancellation timestamp in ISO UTC format. */
|
|
2841
2795
|
timestamp?: Date | null;
|
|
2842
2796
|
/**
|
|
2843
2797
|
* Event ID.
|
|
@@ -2855,7 +2809,7 @@ interface EventEventCanceled {
|
|
|
2855
2809
|
* @format GUID
|
|
2856
2810
|
*/
|
|
2857
2811
|
userId?: string | null;
|
|
2858
|
-
/**
|
|
2812
|
+
/** Whether at least 1 guest is registered to the event with any attendance status. */
|
|
2859
2813
|
hasGuests?: boolean | null;
|
|
2860
2814
|
}
|
|
2861
2815
|
interface CreateEventRequest {
|
|
@@ -2907,12 +2861,12 @@ interface CloneEventRequest {
|
|
|
2907
2861
|
* @format GUID
|
|
2908
2862
|
*/
|
|
2909
2863
|
eventId: string;
|
|
2910
|
-
/**
|
|
2864
|
+
/** Event info to change in the cloned event. */
|
|
2911
2865
|
event?: V3Event;
|
|
2912
2866
|
/** Whether to clone the event as a draft. */
|
|
2913
2867
|
draft?: boolean;
|
|
2914
2868
|
/**
|
|
2915
|
-
* Predefined sets of fields to return.
|
|
2869
|
+
* Predefined sets of fields to return.
|
|
2916
2870
|
* @maxSize 20
|
|
2917
2871
|
*/
|
|
2918
2872
|
fields?: RequestedFieldsWithLiterals[];
|
|
@@ -2933,7 +2887,7 @@ interface CloneEventFromOtherSiteRequest {
|
|
|
2933
2887
|
*/
|
|
2934
2888
|
instanceId?: string | null;
|
|
2935
2889
|
/**
|
|
2936
|
-
* Predefined sets of fields to return.
|
|
2890
|
+
* Predefined sets of fields to return.
|
|
2937
2891
|
* @maxSize 20
|
|
2938
2892
|
*/
|
|
2939
2893
|
fields?: RequestedFieldsWithLiterals[];
|
|
@@ -2943,10 +2897,10 @@ interface CloneEventFromOtherSiteResponse {
|
|
|
2943
2897
|
event?: V3Event;
|
|
2944
2898
|
}
|
|
2945
2899
|
interface UpdateEventRequest {
|
|
2946
|
-
/**
|
|
2900
|
+
/** Event info to update. */
|
|
2947
2901
|
event?: V3Event;
|
|
2948
2902
|
/**
|
|
2949
|
-
* Predefined sets of fields to return.
|
|
2903
|
+
* Predefined sets of fields to return.
|
|
2950
2904
|
* @maxSize 20
|
|
2951
2905
|
*/
|
|
2952
2906
|
fields?: RequestedFieldsWithLiterals[];
|
|
@@ -2962,7 +2916,7 @@ interface PublishDraftEventRequest {
|
|
|
2962
2916
|
*/
|
|
2963
2917
|
eventId: string;
|
|
2964
2918
|
/**
|
|
2965
|
-
* Predefined sets of fields to return.
|
|
2919
|
+
* Predefined sets of fields to return.
|
|
2966
2920
|
* @maxSize 20
|
|
2967
2921
|
*/
|
|
2968
2922
|
fields?: RequestedFieldsWithLiterals[];
|
|
@@ -2978,7 +2932,7 @@ interface CancelEventRequest {
|
|
|
2978
2932
|
*/
|
|
2979
2933
|
eventId: string;
|
|
2980
2934
|
/**
|
|
2981
|
-
* Predefined sets of fields to return.
|
|
2935
|
+
* Predefined sets of fields to return.
|
|
2982
2936
|
* @maxSize 20
|
|
2983
2937
|
*/
|
|
2984
2938
|
fields?: RequestedFieldsWithLiterals[];
|
|
@@ -2988,7 +2942,7 @@ interface CancelEventResponse {
|
|
|
2988
2942
|
event?: V3Event;
|
|
2989
2943
|
}
|
|
2990
2944
|
interface BulkCancelEventsByFilterRequest {
|
|
2991
|
-
/** Filter. */
|
|
2945
|
+
/** Filter. For supported filters, see the table in [Query Events](https://dev.wix.com/docs/sdk/backend-modules/events/wix-events-v2/query-events). */
|
|
2992
2946
|
filter?: CommonQueryV2;
|
|
2993
2947
|
}
|
|
2994
2948
|
interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
|
|
@@ -3060,13 +3014,13 @@ interface DeleteEventResponse {
|
|
|
3060
3014
|
eventId?: string;
|
|
3061
3015
|
}
|
|
3062
3016
|
interface BulkDeleteEventsByFilterRequest {
|
|
3063
|
-
/** Query options. See [API Query Language](https://dev.wix.com/
|
|
3017
|
+
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language) for more details. */
|
|
3064
3018
|
filter?: CommonQueryV2;
|
|
3065
3019
|
}
|
|
3066
3020
|
interface BulkDeleteEventsByFilterResponse {
|
|
3067
3021
|
}
|
|
3068
3022
|
interface QueryEventsRequest {
|
|
3069
|
-
/** Query options. See [API Query Language](https://dev.wix.com/
|
|
3023
|
+
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language) for more details. */
|
|
3070
3024
|
query?: CommonQueryV2;
|
|
3071
3025
|
/**
|
|
3072
3026
|
* Predefined sets of fields to return.
|
|
@@ -3104,7 +3058,7 @@ interface CommonCursors {
|
|
|
3104
3058
|
prev?: string | null;
|
|
3105
3059
|
}
|
|
3106
3060
|
interface ExportEventsRequest {
|
|
3107
|
-
/** Query options. See [API Query Language](https://dev.wix.com/
|
|
3061
|
+
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language) for more details. */
|
|
3108
3062
|
query?: QueryV2;
|
|
3109
3063
|
}
|
|
3110
3064
|
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
@@ -3253,12 +3207,12 @@ interface ListUserEventsRequest {
|
|
|
3253
3207
|
}
|
|
3254
3208
|
interface UserFilter {
|
|
3255
3209
|
/**
|
|
3256
|
-
* User who is related to event
|
|
3210
|
+
* User who is related to the event.
|
|
3257
3211
|
* @format GUID
|
|
3258
3212
|
*/
|
|
3259
3213
|
userId?: string;
|
|
3260
3214
|
/**
|
|
3261
|
-
* Relation of user to event.
|
|
3215
|
+
* Relation of user to the event.
|
|
3262
3216
|
* @minSize 1
|
|
3263
3217
|
* @maxSize 20
|
|
3264
3218
|
*/
|
|
@@ -3529,6 +3483,8 @@ declare enum SubdivisionType {
|
|
|
3529
3483
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
3530
3484
|
COUNTRY = "COUNTRY"
|
|
3531
3485
|
}
|
|
3486
|
+
/** @enumType */
|
|
3487
|
+
type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
3532
3488
|
interface ScheduleConfig {
|
|
3533
3489
|
/**
|
|
3534
3490
|
* Defines event as TBD (To Be Determined) schedule.
|
|
@@ -4396,6 +4352,62 @@ declare enum WebhookIdentityType {
|
|
|
4396
4352
|
}
|
|
4397
4353
|
/** @enumType */
|
|
4398
4354
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
4355
|
+
type CreateEventApplicationErrors = {
|
|
4356
|
+
code?: 'INVALID_SLUG_FORMAT';
|
|
4357
|
+
description?: string;
|
|
4358
|
+
data?: Record<string, any>;
|
|
4359
|
+
} | {
|
|
4360
|
+
code?: 'EVENT_LIMIT_REACHED';
|
|
4361
|
+
description?: string;
|
|
4362
|
+
data?: Record<string, any>;
|
|
4363
|
+
} | {
|
|
4364
|
+
code?: 'SLUG_ALREADY_IN_USE';
|
|
4365
|
+
description?: string;
|
|
4366
|
+
data?: Record<string, any>;
|
|
4367
|
+
};
|
|
4368
|
+
type CreateEventValidationErrors = {
|
|
4369
|
+
ruleName?: 'INVALID_EVENT_CONFIGURATION';
|
|
4370
|
+
};
|
|
4371
|
+
type UpdateEventApplicationErrors = {
|
|
4372
|
+
code?: 'INVALID_EVENT_STATUS_TRANSITION';
|
|
4373
|
+
description?: string;
|
|
4374
|
+
data?: Record<string, any>;
|
|
4375
|
+
} | {
|
|
4376
|
+
code?: 'INVALID_SLUG_FORMAT';
|
|
4377
|
+
description?: string;
|
|
4378
|
+
data?: Record<string, any>;
|
|
4379
|
+
} | {
|
|
4380
|
+
code?: 'SLUG_ALREADY_IN_USE';
|
|
4381
|
+
description?: string;
|
|
4382
|
+
data?: Record<string, any>;
|
|
4383
|
+
};
|
|
4384
|
+
type UpdateEventValidationErrors = {
|
|
4385
|
+
ruleName?: 'INVALID_EVENT_CONFIGURATION';
|
|
4386
|
+
};
|
|
4387
|
+
type PublishDraftEventApplicationErrors = {
|
|
4388
|
+
code?: 'INVALID_EVENT_STATUS_TRANSITION';
|
|
4389
|
+
description?: string;
|
|
4390
|
+
data?: Record<string, any>;
|
|
4391
|
+
} | {
|
|
4392
|
+
code?: 'EVENT_ALREADY_PUBLISHED';
|
|
4393
|
+
description?: string;
|
|
4394
|
+
data?: Record<string, any>;
|
|
4395
|
+
};
|
|
4396
|
+
type CancelEventApplicationErrors = {
|
|
4397
|
+
code?: 'INVALID_EVENT_STATUS_TRANSITION';
|
|
4398
|
+
description?: string;
|
|
4399
|
+
data?: Record<string, any>;
|
|
4400
|
+
};
|
|
4401
|
+
type QueryEventsApplicationErrors = {
|
|
4402
|
+
code?: 'FILTER_PARSER_ERROR';
|
|
4403
|
+
description?: string;
|
|
4404
|
+
data?: Record<string, any>;
|
|
4405
|
+
};
|
|
4406
|
+
type CountEventsByStatusApplicationErrors = {
|
|
4407
|
+
code?: 'FILTER_PARSER_ERROR';
|
|
4408
|
+
description?: string;
|
|
4409
|
+
data?: Record<string, any>;
|
|
4410
|
+
};
|
|
4399
4411
|
interface BaseEventMetadata {
|
|
4400
4412
|
/**
|
|
4401
4413
|
* App instance ID.
|
|
@@ -4444,37 +4456,390 @@ interface EventCanceledEnvelope {
|
|
|
4444
4456
|
data: EventEventCanceled;
|
|
4445
4457
|
metadata: EventMetadata;
|
|
4446
4458
|
}
|
|
4459
|
+
/**
|
|
4460
|
+
* Triggered when an event is canceled.
|
|
4461
|
+
* @permissionScope Manage Stores
|
|
4462
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4463
|
+
* @permissionScope Read Events - all read permissions
|
|
4464
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
4465
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
4466
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
4467
|
+
* @permissionScope Manage Events - all permissions
|
|
4468
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4469
|
+
* @permissionScope Manage Events
|
|
4470
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4471
|
+
* @permissionScope Read Events
|
|
4472
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
4473
|
+
* @permissionScope Manage Challenges
|
|
4474
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
4475
|
+
* @permissionScope Manage Portfolio
|
|
4476
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
4477
|
+
* @permissionScope Manage Blog
|
|
4478
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
4479
|
+
* @permissionScope Access Verticals by Automations
|
|
4480
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4481
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4482
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4483
|
+
* @permissionScope Set Up Automations
|
|
4484
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4485
|
+
* @permissionScope Manage Guest List
|
|
4486
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4487
|
+
* @permissionScope Manage Events
|
|
4488
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
4489
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
4490
|
+
* @webhook
|
|
4491
|
+
* @eventType wix.events.v3.event_canceled
|
|
4492
|
+
* @slug canceled
|
|
4493
|
+
*/
|
|
4494
|
+
declare function onEventCanceled(handler: (event: EventCanceledEnvelope) => void | Promise<void>): void;
|
|
4447
4495
|
interface EventClonedEnvelope {
|
|
4448
4496
|
data: EventCloned;
|
|
4449
4497
|
metadata: EventMetadata;
|
|
4450
4498
|
}
|
|
4499
|
+
/**
|
|
4500
|
+
* Triggered when an event is cloned.
|
|
4501
|
+
* @permissionScope Manage Stores
|
|
4502
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4503
|
+
* @permissionScope Read Events - all read permissions
|
|
4504
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
4505
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
4506
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
4507
|
+
* @permissionScope Manage Events - all permissions
|
|
4508
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4509
|
+
* @permissionScope Manage Events
|
|
4510
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4511
|
+
* @permissionScope Read Events
|
|
4512
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
4513
|
+
* @permissionScope Manage Challenges
|
|
4514
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
4515
|
+
* @permissionScope Manage Portfolio
|
|
4516
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
4517
|
+
* @permissionScope Manage Blog
|
|
4518
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
4519
|
+
* @permissionScope Access Verticals by Automations
|
|
4520
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4521
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4522
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4523
|
+
* @permissionScope Set Up Automations
|
|
4524
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4525
|
+
* @permissionScope Manage Guest List
|
|
4526
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4527
|
+
* @permissionScope Manage Events
|
|
4528
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
4529
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
4530
|
+
* @webhook
|
|
4531
|
+
* @eventType wix.events.v3.event_cloned
|
|
4532
|
+
* @slug cloned
|
|
4533
|
+
*/
|
|
4534
|
+
declare function onEventCloned(handler: (event: EventClonedEnvelope) => void | Promise<void>): void;
|
|
4451
4535
|
interface EventCreatedEnvelope {
|
|
4452
4536
|
entity: V3Event;
|
|
4453
4537
|
metadata: EventMetadata;
|
|
4454
4538
|
}
|
|
4539
|
+
/**
|
|
4540
|
+
* Triggered when an event is created.
|
|
4541
|
+
* @permissionScope Manage Stores
|
|
4542
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4543
|
+
* @permissionScope Read Events - all read permissions
|
|
4544
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
4545
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
4546
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
4547
|
+
* @permissionScope Manage Events - all permissions
|
|
4548
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4549
|
+
* @permissionScope Manage Events
|
|
4550
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4551
|
+
* @permissionScope Read Events
|
|
4552
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
4553
|
+
* @permissionScope Manage Challenges
|
|
4554
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
4555
|
+
* @permissionScope Manage Portfolio
|
|
4556
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
4557
|
+
* @permissionScope Manage Blog
|
|
4558
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
4559
|
+
* @permissionScope Access Verticals by Automations
|
|
4560
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4561
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4562
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4563
|
+
* @permissionScope Set Up Automations
|
|
4564
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4565
|
+
* @permissionScope Manage Guest List
|
|
4566
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4567
|
+
* @permissionScope Manage Events
|
|
4568
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
4569
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
4570
|
+
* @webhook
|
|
4571
|
+
* @eventType wix.events.v3.event_created
|
|
4572
|
+
* @slug created
|
|
4573
|
+
*/
|
|
4574
|
+
declare function onEventCreated(handler: (event: EventCreatedEnvelope) => void | Promise<void>): void;
|
|
4455
4575
|
interface EventDeletedEnvelope {
|
|
4456
4576
|
metadata: EventMetadata;
|
|
4457
4577
|
}
|
|
4578
|
+
/**
|
|
4579
|
+
* Triggered when an event is deleted.
|
|
4580
|
+
* @permissionScope Manage Stores
|
|
4581
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4582
|
+
* @permissionScope Read Events - all read permissions
|
|
4583
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
4584
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
4585
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
4586
|
+
* @permissionScope Manage Events - all permissions
|
|
4587
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4588
|
+
* @permissionScope Manage Events
|
|
4589
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4590
|
+
* @permissionScope Read Events
|
|
4591
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
4592
|
+
* @permissionScope Manage Challenges
|
|
4593
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
4594
|
+
* @permissionScope Manage Portfolio
|
|
4595
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
4596
|
+
* @permissionScope Manage Blog
|
|
4597
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
4598
|
+
* @permissionScope Access Verticals by Automations
|
|
4599
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4600
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4601
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4602
|
+
* @permissionScope Set Up Automations
|
|
4603
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4604
|
+
* @permissionScope Manage Guest List
|
|
4605
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4606
|
+
* @permissionScope Manage Events
|
|
4607
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
4608
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
4609
|
+
* @webhook
|
|
4610
|
+
* @eventType wix.events.v3.event_deleted
|
|
4611
|
+
* @slug deleted
|
|
4612
|
+
*/
|
|
4613
|
+
declare function onEventDeleted(handler: (event: EventDeletedEnvelope) => void | Promise<void>): void;
|
|
4458
4614
|
interface EventEndedEnvelope {
|
|
4459
4615
|
data: EventEventEnded;
|
|
4460
4616
|
metadata: EventMetadata;
|
|
4461
4617
|
}
|
|
4618
|
+
/**
|
|
4619
|
+
* Triggered when an event has ended.
|
|
4620
|
+
* @permissionScope Manage Stores
|
|
4621
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4622
|
+
* @permissionScope Read Events - all read permissions
|
|
4623
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
4624
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
4625
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
4626
|
+
* @permissionScope Manage Events - all permissions
|
|
4627
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4628
|
+
* @permissionScope Manage Events
|
|
4629
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4630
|
+
* @permissionScope Read Events
|
|
4631
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
4632
|
+
* @permissionScope Manage Challenges
|
|
4633
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
4634
|
+
* @permissionScope Manage Portfolio
|
|
4635
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
4636
|
+
* @permissionScope Manage Blog
|
|
4637
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
4638
|
+
* @permissionScope Access Verticals by Automations
|
|
4639
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4640
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4641
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4642
|
+
* @permissionScope Set Up Automations
|
|
4643
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4644
|
+
* @permissionScope Manage Guest List
|
|
4645
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4646
|
+
* @permissionScope Manage Events
|
|
4647
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
4648
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
4649
|
+
* @webhook
|
|
4650
|
+
* @eventType wix.events.v3.event_ended
|
|
4651
|
+
* @slug ended
|
|
4652
|
+
*/
|
|
4653
|
+
declare function onEventEnded(handler: (event: EventEndedEnvelope) => void | Promise<void>): void;
|
|
4462
4654
|
interface EventPublishedEnvelope {
|
|
4463
4655
|
data: EventEventPublished;
|
|
4464
4656
|
metadata: EventMetadata;
|
|
4465
4657
|
}
|
|
4658
|
+
/**
|
|
4659
|
+
* Triggered when an event is published.
|
|
4660
|
+
* @permissionScope Manage Stores
|
|
4661
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4662
|
+
* @permissionScope Read Events - all read permissions
|
|
4663
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
4664
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
4665
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
4666
|
+
* @permissionScope Manage Events - all permissions
|
|
4667
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4668
|
+
* @permissionScope Manage Events
|
|
4669
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4670
|
+
* @permissionScope Read Events
|
|
4671
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
4672
|
+
* @permissionScope Manage Challenges
|
|
4673
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
4674
|
+
* @permissionScope Manage Portfolio
|
|
4675
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
4676
|
+
* @permissionScope Manage Blog
|
|
4677
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
4678
|
+
* @permissionScope Access Verticals by Automations
|
|
4679
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4680
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4681
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4682
|
+
* @permissionScope Set Up Automations
|
|
4683
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4684
|
+
* @permissionScope Manage Guest List
|
|
4685
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4686
|
+
* @permissionScope Manage Events
|
|
4687
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
4688
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
4689
|
+
* @webhook
|
|
4690
|
+
* @eventType wix.events.v3.event_published
|
|
4691
|
+
* @slug published
|
|
4692
|
+
*/
|
|
4693
|
+
declare function onEventPublished(handler: (event: EventPublishedEnvelope) => void | Promise<void>): void;
|
|
4466
4694
|
interface EventReminderEnvelope {
|
|
4467
4695
|
data: EventEventReminder;
|
|
4468
4696
|
metadata: EventMetadata;
|
|
4469
4697
|
}
|
|
4698
|
+
/**
|
|
4699
|
+
* Triggered when a certain amount of time is left until the event. In total there are 6 reminders:
|
|
4700
|
+
* - 7 days
|
|
4701
|
+
* - 3 days
|
|
4702
|
+
* - 1 day
|
|
4703
|
+
* - 2 hours
|
|
4704
|
+
* - 1 hour
|
|
4705
|
+
* - 30 minutes
|
|
4706
|
+
* @permissionScope Manage Stores
|
|
4707
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4708
|
+
* @permissionScope Read Events - all read permissions
|
|
4709
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
4710
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
4711
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
4712
|
+
* @permissionScope Manage Events - all permissions
|
|
4713
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4714
|
+
* @permissionScope Manage Events
|
|
4715
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4716
|
+
* @permissionScope Read Events
|
|
4717
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
4718
|
+
* @permissionScope Manage Challenges
|
|
4719
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
4720
|
+
* @permissionScope Manage Portfolio
|
|
4721
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
4722
|
+
* @permissionScope Manage Blog
|
|
4723
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
4724
|
+
* @permissionScope Access Verticals by Automations
|
|
4725
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4726
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4727
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4728
|
+
* @permissionScope Set Up Automations
|
|
4729
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4730
|
+
* @permissionScope Manage Guest List
|
|
4731
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4732
|
+
* @permissionScope Manage Events
|
|
4733
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
4734
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
4735
|
+
* @webhook
|
|
4736
|
+
* @eventType wix.events.v3.event_reminder
|
|
4737
|
+
* @slug reminder
|
|
4738
|
+
*/
|
|
4739
|
+
declare function onEventReminder(handler: (event: EventReminderEnvelope) => void | Promise<void>): void;
|
|
4470
4740
|
interface EventStartedEnvelope {
|
|
4471
4741
|
data: EventEventStarted;
|
|
4472
4742
|
metadata: EventMetadata;
|
|
4473
4743
|
}
|
|
4744
|
+
/**
|
|
4745
|
+
* Triggered when an event has started.
|
|
4746
|
+
* @permissionScope Manage Stores
|
|
4747
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4748
|
+
* @permissionScope Read Events - all read permissions
|
|
4749
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
4750
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
4751
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
4752
|
+
* @permissionScope Manage Events - all permissions
|
|
4753
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4754
|
+
* @permissionScope Manage Events
|
|
4755
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4756
|
+
* @permissionScope Read Events
|
|
4757
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
4758
|
+
* @permissionScope Manage Challenges
|
|
4759
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
4760
|
+
* @permissionScope Manage Portfolio
|
|
4761
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
4762
|
+
* @permissionScope Manage Blog
|
|
4763
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
4764
|
+
* @permissionScope Access Verticals by Automations
|
|
4765
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4766
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4767
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4768
|
+
* @permissionScope Set Up Automations
|
|
4769
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4770
|
+
* @permissionScope Manage Guest List
|
|
4771
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4772
|
+
* @permissionScope Manage Events
|
|
4773
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
4774
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
4775
|
+
* @webhook
|
|
4776
|
+
* @eventType wix.events.v3.event_started
|
|
4777
|
+
* @slug started
|
|
4778
|
+
*/
|
|
4779
|
+
declare function onEventStarted(handler: (event: EventStartedEnvelope) => void | Promise<void>): void;
|
|
4474
4780
|
interface EventUpdatedEnvelope {
|
|
4475
4781
|
entity: V3Event;
|
|
4476
4782
|
metadata: EventMetadata;
|
|
4477
4783
|
}
|
|
4784
|
+
/**
|
|
4785
|
+
* Triggered when an event is updated.
|
|
4786
|
+
* @permissionScope Manage Stores
|
|
4787
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4788
|
+
* @permissionScope Read Events - all read permissions
|
|
4789
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
4790
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
4791
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
4792
|
+
* @permissionScope Manage Events - all permissions
|
|
4793
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4794
|
+
* @permissionScope Manage Events
|
|
4795
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4796
|
+
* @permissionScope Read Events
|
|
4797
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
|
|
4798
|
+
* @permissionScope Manage Challenges
|
|
4799
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
4800
|
+
* @permissionScope Manage Portfolio
|
|
4801
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
4802
|
+
* @permissionScope Manage Blog
|
|
4803
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
4804
|
+
* @permissionScope Access Verticals by Automations
|
|
4805
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4806
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
4807
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4808
|
+
* @permissionScope Set Up Automations
|
|
4809
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4810
|
+
* @permissionScope Manage Guest List
|
|
4811
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4812
|
+
* @permissionScope Manage Events
|
|
4813
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
|
|
4814
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
4815
|
+
* @webhook
|
|
4816
|
+
* @eventType wix.events.v3.event_updated
|
|
4817
|
+
* @slug updated
|
|
4818
|
+
*/
|
|
4819
|
+
declare function onEventUpdated(handler: (event: EventUpdatedEnvelope) => void | Promise<void>): void;
|
|
4820
|
+
type EventNonNullablePaths = `_id` | `location.type` | `location.address.streetAddress.number` | `location.address.streetAddress.name` | `dateAndTimeSettings.recurrenceStatus` | `dateAndTimeSettings.recurringEvents.individualEventDates` | `dateAndTimeSettings.recurringEvents.individualEventDates.${number}.showTimeZone` | `slug` | `status` | `registration.type` | `registration.status` | `registration.rsvp.responseType` | `registration.rsvp.waitlistEnabled` | `registration.tickets.guestsAssignedSeparately` | `registration.tickets.ticketLimitPerOrder` | `registration.tickets.lowestPrice.value` | `registration.tickets.lowestPrice.currency` | `registration.tickets.taxSettings.type` | `registration.allowedGuestTypes` | `registration.initialType` | `registration.registrationPaused` | `registration.registrationDisabled` | `calendarUrls.google` | `calendarUrls.ics` | `form.controls` | `form.controls.${number}.type` | `form.controls.${number}.system` | `form.controls.${number}.name` | `form.controls.${number}.label` | `form.controls.${number}.orderIndex` | `form.controls.${number}._id` | `form.messages.rsvp.rsvpYesOption` | `form.messages.rsvp.rsvpNoOption` | `form.messages.rsvp.positiveMessages.title` | `form.messages.rsvp.positiveMessages.confirmation.title` | `form.messages.rsvp.positiveMessages.confirmation.message` | `form.messages.rsvp.positiveMessages.confirmation.addToCalendarActionLabel` | `form.messages.rsvp.positiveMessages.confirmation.shareActionLabel` | `form.messages.rsvp.negativeMessages.title` | `form.messages.rsvp.negativeMessages.confirmation.title` | `form.messages.rsvp.negativeMessages.confirmation.shareActionLabel` | `form.messages.rsvp.submitActionLabel` | `form.messages.checkout.title` | `form.messages.checkout.submitActionLabel` | `form.messages.checkout.confirmation.title` | `form.messages.checkout.confirmation.message` | `form.messages.checkout.confirmation.downloadTicketsLabel` | `form.messages.checkout.confirmation.addToCalendarLabel` | `form.messages.checkout.confirmation.shareEventLabel` | `form.messages.registrationClosed.message` | `form.messages.registrationClosed.exploreEventsActionLabel` | `form.messages.ticketsUnavailable.message` | `form.messages.ticketsUnavailable.exploreEventsActionLabel` | `summaries.rsvps.totalCount` | `summaries.rsvps.yesCount` | `summaries.rsvps.noCount` | `summaries.rsvps.waitlistCount` | `summaries.tickets.ticketsSold` | `summaries.tickets.revenue.amount` | `summaries.tickets.revenue.currency` | `summaries.tickets.currencyLocked` | `summaries.tickets.totalOrders` | `instanceId` | `guestListSettings.displayedPublicly` | `userId` | `onlineConferencing.enabled` | `onlineConferencing.type` | `onlineConferencing.session.hostLink` | `onlineConferencing.session.guestLink` | `seoSettings.slug` | `seoSettings.advancedSeoData.tags` | `seoSettings.advancedSeoData.tags.${number}.type` | `seoSettings.advancedSeoData.tags.${number}.children` | `seoSettings.advancedSeoData.tags.${number}.custom` | `seoSettings.advancedSeoData.tags.${number}.disabled` | `seoSettings.advancedSeoData.settings.preventAutoRedirect` | `seoSettings.advancedSeoData.settings.keywords` | `seoSettings.advancedSeoData.settings.keywords.${number}.term` | `seoSettings.advancedSeoData.settings.keywords.${number}.isMain` | `agendaSettings.enabled`;
|
|
4821
|
+
/**
|
|
4822
|
+
* Creates an event. <br> <br>
|
|
4823
|
+
* The event includes a default registration form in the selected language, which consists of input fields for first name, last name, and email. See the Registration Form API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/events/forms/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/events/form/about-the-registration-form-api)) for more information. <br> <br>
|
|
4824
|
+
* You can create the event as a draft by setting `draft` to `true`. Otherwise, the event is published right away. <br> <br>
|
|
4825
|
+
* The event is automatically set up to send daily summary reports of new guests to your business email.
|
|
4826
|
+
* @param event - Event data.
|
|
4827
|
+
* @public
|
|
4828
|
+
* @requiredField event
|
|
4829
|
+
* @requiredField event.dateAndTimeSettings
|
|
4830
|
+
* @requiredField event.location
|
|
4831
|
+
* @requiredField event.registration.initialType
|
|
4832
|
+
* @requiredField event.title
|
|
4833
|
+
* @param options - Optional fields.
|
|
4834
|
+
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
4835
|
+
* @applicableIdentity APP
|
|
4836
|
+
* @returns Created event.
|
|
4837
|
+
* @fqn wix.events.events.v3.EventManagement.CreateEvent
|
|
4838
|
+
*/
|
|
4839
|
+
declare function createEvent(event: NonNullablePaths<V3Event, `dateAndTimeSettings` | `location` | `registration.initialType` | `title`>, options?: CreateEventOptions): Promise<NonNullablePaths<V3Event, EventNonNullablePaths> & {
|
|
4840
|
+
__applicationErrorsType?: CreateEventApplicationErrors;
|
|
4841
|
+
__validationErrorsType?: CreateEventValidationErrors;
|
|
4842
|
+
}>;
|
|
4478
4843
|
interface CreateEventOptions {
|
|
4479
4844
|
/** Whether to create the event as a draft. */
|
|
4480
4845
|
draft?: boolean;
|
|
@@ -4484,19 +4849,49 @@ interface CreateEventOptions {
|
|
|
4484
4849
|
*/
|
|
4485
4850
|
fields?: RequestedFieldsWithLiterals[];
|
|
4486
4851
|
}
|
|
4852
|
+
/**
|
|
4853
|
+
* Clones an event, including the registration form, notifications, multilingual translations and ticket configuration from the original event. <br> <br>
|
|
4854
|
+
* The new event's date is automatically set to 14 days from the original event date. <br> <br>
|
|
4855
|
+
* If an event with the same `title` already exists, the new event's `title` gets a sequence number. For example, if you clone an event named `"Leather Crafting 101"`, the new event's title is `"Leather Crafting 101 (1)"`. <br> <br>
|
|
4856
|
+
* You can change the required entity field values while cloning an event.
|
|
4857
|
+
* @param eventId - Event ID.
|
|
4858
|
+
* @public
|
|
4859
|
+
* @requiredField eventId
|
|
4860
|
+
* @param options - Optional fields.
|
|
4861
|
+
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
4862
|
+
* @applicableIdentity APP
|
|
4863
|
+
* @fqn wix.events.events.v3.EventManagement.CloneEvent
|
|
4864
|
+
*/
|
|
4865
|
+
declare function cloneEvent(eventId: string, options?: CloneEventOptions): Promise<NonNullablePaths<CloneEventResponse, {
|
|
4866
|
+
[P in EventNonNullablePaths]: `event.${P}`;
|
|
4867
|
+
}[EventNonNullablePaths]>>;
|
|
4487
4868
|
interface CloneEventOptions {
|
|
4488
|
-
/**
|
|
4869
|
+
/** Event info to change in the cloned event. */
|
|
4489
4870
|
event?: V3Event;
|
|
4490
4871
|
/** Whether to clone the event as a draft. */
|
|
4491
4872
|
draft?: boolean;
|
|
4492
4873
|
/**
|
|
4493
|
-
* Predefined sets of fields to return.
|
|
4874
|
+
* Predefined sets of fields to return.
|
|
4494
4875
|
* @maxSize 20
|
|
4495
4876
|
*/
|
|
4496
4877
|
fields?: RequestedFieldsWithLiterals[];
|
|
4497
4878
|
}
|
|
4879
|
+
/**
|
|
4880
|
+
* Updates an event.
|
|
4881
|
+
* @param _id - Event ID.
|
|
4882
|
+
* @public
|
|
4883
|
+
* @requiredField _id
|
|
4884
|
+
* @param options - Optional fields.
|
|
4885
|
+
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
4886
|
+
* @applicableIdentity APP
|
|
4887
|
+
* @returns Updated event.
|
|
4888
|
+
* @fqn wix.events.events.v3.EventManagement.UpdateEvent
|
|
4889
|
+
*/
|
|
4890
|
+
declare function updateEvent(_id: string, options?: UpdateEventOptions): Promise<NonNullablePaths<V3Event, EventNonNullablePaths> & {
|
|
4891
|
+
__applicationErrorsType?: UpdateEventApplicationErrors;
|
|
4892
|
+
__validationErrorsType?: UpdateEventValidationErrors;
|
|
4893
|
+
}>;
|
|
4498
4894
|
interface UpdateEventOptions {
|
|
4499
|
-
/** Event to update. */
|
|
4500
4895
|
event: {
|
|
4501
4896
|
/**
|
|
4502
4897
|
* Event ID.
|
|
@@ -4516,11 +4911,14 @@ interface UpdateEventOptions {
|
|
|
4516
4911
|
title?: string | null;
|
|
4517
4912
|
/**
|
|
4518
4913
|
* Short description that appears under the event title.
|
|
4914
|
+
* **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.
|
|
4519
4915
|
* @maxLength 500
|
|
4520
4916
|
*/
|
|
4521
4917
|
shortDescription?: string | null;
|
|
4522
4918
|
/**
|
|
4523
|
-
* Detailed description of an event.
|
|
4919
|
+
* Detailed description of an event.
|
|
4920
|
+
*
|
|
4921
|
+
* This field is deprecated.
|
|
4524
4922
|
* @maxLength 50000
|
|
4525
4923
|
* @deprecated Detailed description of an event.
|
|
4526
4924
|
*
|
|
@@ -4550,13 +4948,7 @@ interface UpdateEventOptions {
|
|
|
4550
4948
|
*/
|
|
4551
4949
|
_updatedDate?: Date | null;
|
|
4552
4950
|
/**
|
|
4553
|
-
* Event status.
|
|
4554
|
-
*
|
|
4555
|
-
* - `UPCOMING`: The event is published and scheduled to start.
|
|
4556
|
-
* - `STARTED`: The event has started.
|
|
4557
|
-
* - `ENDED`: The event has ended.
|
|
4558
|
-
* - `CANCELED`: The event is canceled.
|
|
4559
|
-
* - `DRAFT`: The event is not published.
|
|
4951
|
+
* Event status.
|
|
4560
4952
|
* @readonly
|
|
4561
4953
|
*/
|
|
4562
4954
|
status?: StatusWithLiterals;
|
|
@@ -4621,11 +5013,7 @@ interface UpdateEventOptions {
|
|
|
4621
5013
|
agendaSettings?: AgendaSettings;
|
|
4622
5014
|
/** Visual settings for event. */
|
|
4623
5015
|
eventDisplaySettings?: V3EventDisplaySettings;
|
|
4624
|
-
/**
|
|
4625
|
-
* Event description with rich content.
|
|
4626
|
-
*
|
|
4627
|
-
* For the event description to appear on your site, connect the [Rich Content Viewer](https://dev.wix.com/docs/velo/velo-only-apis/$w/rich-content-viewer/introduction) element, and assign the description value to the viewer.
|
|
4628
|
-
*/
|
|
5016
|
+
/** Event description. <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="emoji,audio,codeBlock,collapsibleList,divider,emoji,file,gallery,giphy,hashtag,heading,html,image,indent,lineSpacing,link,linkPreview,spoiler,video" exampleid="9b569a8d-0fc1-40f4-987f-8bd40ecc72d0">Fallback Message for SSR and Error</widget> */
|
|
4629
5017
|
description?: RichContent;
|
|
4630
5018
|
/**
|
|
4631
5019
|
* Event publish timestamp.
|
|
@@ -4634,33 +5022,125 @@ interface UpdateEventOptions {
|
|
|
4634
5022
|
publishedDate?: Date | null;
|
|
4635
5023
|
};
|
|
4636
5024
|
/**
|
|
4637
|
-
* Predefined sets of fields to return.
|
|
5025
|
+
* Predefined sets of fields to return.
|
|
4638
5026
|
* @maxSize 20
|
|
4639
5027
|
*/
|
|
4640
5028
|
fields?: RequestedFieldsWithLiterals[];
|
|
4641
5029
|
}
|
|
5030
|
+
/**
|
|
5031
|
+
* Publishes a draft event to your live site. Once published, the event's status changes from `"DRAFT"` to `"UPCOMING"`. <br> <br>
|
|
5032
|
+
* It's impossible to revert the `"DRAFT"` status after publishing. The only option is to clone the event, then delete the original.
|
|
5033
|
+
* @param eventId - Event ID.
|
|
5034
|
+
* @public
|
|
5035
|
+
* @requiredField eventId
|
|
5036
|
+
* @param options - Optional fields.
|
|
5037
|
+
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
5038
|
+
* @applicableIdentity APP
|
|
5039
|
+
* @fqn wix.events.events.v3.EventManagement.PublishDraftEvent
|
|
5040
|
+
*/
|
|
5041
|
+
declare function publishDraftEvent(eventId: string, options?: PublishDraftEventOptions): Promise<NonNullablePaths<PublishDraftEventResponse, {
|
|
5042
|
+
[P in EventNonNullablePaths]: `event.${P}`;
|
|
5043
|
+
}[EventNonNullablePaths]> & {
|
|
5044
|
+
__applicationErrorsType?: PublishDraftEventApplicationErrors;
|
|
5045
|
+
}>;
|
|
4642
5046
|
interface PublishDraftEventOptions {
|
|
4643
5047
|
/**
|
|
4644
|
-
* Predefined sets of fields to return.
|
|
5048
|
+
* Predefined sets of fields to return.
|
|
4645
5049
|
* @maxSize 20
|
|
4646
5050
|
*/
|
|
4647
5051
|
fields?: RequestedFieldsWithLiterals[];
|
|
4648
5052
|
}
|
|
5053
|
+
/**
|
|
5054
|
+
* Cancels an event. <br> <br>
|
|
5055
|
+
* After cancellation, registration for an event is closed. To reuse the event, call Clone Event and Publish Event to publish it again. <br> <br>
|
|
5056
|
+
* If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
|
|
5057
|
+
* @param eventId - Event ID.
|
|
5058
|
+
* @public
|
|
5059
|
+
* @requiredField eventId
|
|
5060
|
+
* @param options - Optional fields.
|
|
5061
|
+
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
5062
|
+
* @applicableIdentity APP
|
|
5063
|
+
* @fqn wix.events.events.v3.EventManagement.CancelEvent
|
|
5064
|
+
*/
|
|
5065
|
+
declare function cancelEvent(eventId: string, options?: CancelEventOptions): Promise<NonNullablePaths<CancelEventResponse, {
|
|
5066
|
+
[P in EventNonNullablePaths]: `event.${P}`;
|
|
5067
|
+
}[EventNonNullablePaths]> & {
|
|
5068
|
+
__applicationErrorsType?: CancelEventApplicationErrors;
|
|
5069
|
+
}>;
|
|
4649
5070
|
interface CancelEventOptions {
|
|
4650
5071
|
/**
|
|
4651
|
-
* Predefined sets of fields to return.
|
|
5072
|
+
* Predefined sets of fields to return.
|
|
4652
5073
|
* @maxSize 20
|
|
4653
5074
|
*/
|
|
4654
5075
|
fields?: RequestedFieldsWithLiterals[];
|
|
4655
5076
|
}
|
|
5077
|
+
/**
|
|
5078
|
+
* Cancels multiple events that meet the specified criteria. <br> <br>
|
|
5079
|
+
* After cancellation, registration for an event is closed. To reuse the event, call Clone Event and Publish Event to publish it again. <br> <br>
|
|
5080
|
+
* If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
|
|
5081
|
+
* @public
|
|
5082
|
+
* @requiredField options.filter.filter
|
|
5083
|
+
* @param options - Optional fields.
|
|
5084
|
+
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
5085
|
+
* @applicableIdentity APP
|
|
5086
|
+
* @fqn wix.events.events.v3.EventManagement.BulkCancelEventsByFilter
|
|
5087
|
+
*/
|
|
5088
|
+
declare function bulkCancelEventsByFilter(options?: NonNullablePaths<BulkCancelEventsByFilterOptions, `filter.filter`>): Promise<void>;
|
|
4656
5089
|
interface BulkCancelEventsByFilterOptions {
|
|
4657
|
-
/** Filter. */
|
|
5090
|
+
/** Filter.For supported filters, see the table in [Query Events](https://dev.wix.com/docs/sdk/backend-modules/events/wix-events-v2/query-events). */
|
|
4658
5091
|
filter?: CommonQueryV2;
|
|
4659
5092
|
}
|
|
5093
|
+
/**
|
|
5094
|
+
* Deletes an event. <br> <br>
|
|
5095
|
+
* You can retrieve the deleted event through a GDPR access request.
|
|
5096
|
+
* @param eventId - Event ID.
|
|
5097
|
+
* @public
|
|
5098
|
+
* @requiredField eventId
|
|
5099
|
+
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
5100
|
+
* @applicableIdentity APP
|
|
5101
|
+
* @fqn wix.events.events.v3.EventManagement.DeleteEvent
|
|
5102
|
+
*/
|
|
5103
|
+
declare function deleteEvent(eventId: string): Promise<NonNullablePaths<DeleteEventResponse, `eventId`>>;
|
|
5104
|
+
/**
|
|
5105
|
+
* Deletes multiple events that meet the specified criteria. <br> <br>
|
|
5106
|
+
* You can retrieve the deleted events through a GDPR access request.
|
|
5107
|
+
* @public
|
|
5108
|
+
* @requiredField options.filter.filter
|
|
5109
|
+
* @param options - Optional fields.
|
|
5110
|
+
* @permissionId WIX_EVENTS.MANAGE_EVENTS
|
|
5111
|
+
* @applicableIdentity APP
|
|
5112
|
+
* @fqn wix.events.events.v3.EventManagement.BulkDeleteEventsByFilter
|
|
5113
|
+
*/
|
|
5114
|
+
declare function bulkDeleteEventsByFilter(options?: NonNullablePaths<BulkDeleteEventsByFilterOptions, `filter.filter`>): Promise<void>;
|
|
4660
5115
|
interface BulkDeleteEventsByFilterOptions {
|
|
4661
|
-
/** Query options. See [API Query Language](https://dev.wix.com/
|
|
5116
|
+
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language) for more details. */
|
|
4662
5117
|
filter?: CommonQueryV2;
|
|
4663
5118
|
}
|
|
5119
|
+
/**
|
|
5120
|
+
* Creates a query to retrieve a list of events.
|
|
5121
|
+
*
|
|
5122
|
+
*
|
|
5123
|
+
* The `queryEvents()` method builds a query to retrieve a list of events and returns a [`EventsQueryBuilder`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder) object.
|
|
5124
|
+
*
|
|
5125
|
+
* The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/find) method.
|
|
5126
|
+
*
|
|
5127
|
+
* You can refine the query by chaining `EventsQueryBuilder` methods onto the query. `EventsQueryBuilder` methods enable you to sort, filter, and control the results `queryEvents()` returns.
|
|
5128
|
+
*
|
|
5129
|
+
* `queryEvents()` runs with these `EventsQueryBuilder` defaults, which you can override:
|
|
5130
|
+
*
|
|
5131
|
+
* - [`skip(0)`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/skip)
|
|
5132
|
+
* - [`limit(50)`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/limit)
|
|
5133
|
+
* - [`descending("_createdDate")`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/descending)
|
|
5134
|
+
*
|
|
5135
|
+
* The methods that are chained to `queryEvents()` are applied in the order they're called. For example, if you apply `ascending('title')` and then `descending('status')`, the results are sorted first by the `title`, and then, if there are multiple results with the same `title`, the items are sorted by `status`.
|
|
5136
|
+
* @public
|
|
5137
|
+
* @param options - Optional fields.
|
|
5138
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
5139
|
+
* @applicableIdentity APP
|
|
5140
|
+
* @applicableIdentity VISITOR
|
|
5141
|
+
* @fqn wix.events.events.v3.EventManagement.QueryEvents
|
|
5142
|
+
*/
|
|
5143
|
+
declare function queryEvents(options?: QueryEventsOptions): EventsQueryBuilder;
|
|
4664
5144
|
interface QueryEventsOptions {
|
|
4665
5145
|
/**
|
|
4666
5146
|
* Predefined sets of fields to return.
|
|
@@ -4724,6 +5204,18 @@ interface EventsQueryBuilder {
|
|
|
4724
5204
|
skip: (skip: number) => EventsQueryBuilder;
|
|
4725
5205
|
find: () => Promise<EventsQueryResult>;
|
|
4726
5206
|
}
|
|
5207
|
+
/**
|
|
5208
|
+
* Counts events by status.
|
|
5209
|
+
* @public
|
|
5210
|
+
* @param options - Optional fields.
|
|
5211
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
5212
|
+
* @applicableIdentity APP
|
|
5213
|
+
* @applicableIdentity VISITOR
|
|
5214
|
+
* @fqn wix.events.events.v3.EventManagement.CountEventsByStatus
|
|
5215
|
+
*/
|
|
5216
|
+
declare function countEventsByStatus(options?: CountEventsByStatusOptions): Promise<CountEventsByStatusResponse & {
|
|
5217
|
+
__applicationErrorsType?: CountEventsByStatusApplicationErrors;
|
|
5218
|
+
}>;
|
|
4727
5219
|
interface CountEventsByStatusOptions {
|
|
4728
5220
|
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
|
|
4729
5221
|
filter?: Record<string, any> | null;
|
|
@@ -4739,6 +5231,19 @@ interface CountEventsByStatusOptions {
|
|
|
4739
5231
|
*/
|
|
4740
5232
|
includeDrafts?: boolean;
|
|
4741
5233
|
}
|
|
5234
|
+
/**
|
|
5235
|
+
* Retrieves an event by ID.
|
|
5236
|
+
* @param eventId - Event ID.
|
|
5237
|
+
* @public
|
|
5238
|
+
* @requiredField eventId
|
|
5239
|
+
* @param options - Optional fields.
|
|
5240
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
5241
|
+
* @applicableIdentity APP
|
|
5242
|
+
* @applicableIdentity VISITOR
|
|
5243
|
+
* @returns Event.
|
|
5244
|
+
* @fqn wix.events.events.v3.EventManagement.GetEvent
|
|
5245
|
+
*/
|
|
5246
|
+
declare function getEvent(eventId: string, options?: GetEventOptions): Promise<NonNullablePaths<V3Event, EventNonNullablePaths>>;
|
|
4742
5247
|
interface GetEventOptions {
|
|
4743
5248
|
/**
|
|
4744
5249
|
* Predefined sets of fields to return.
|
|
@@ -4746,9 +5251,25 @@ interface GetEventOptions {
|
|
|
4746
5251
|
*/
|
|
4747
5252
|
fields?: RequestedFieldsWithLiterals[];
|
|
4748
5253
|
}
|
|
5254
|
+
/**
|
|
5255
|
+
* Retrieves an event by the slug URL.
|
|
5256
|
+
*
|
|
5257
|
+
* The slug is the end of an event URL that refers to a specific event. For example, if an event's URL is `https://example.com/events/event/{my-event-slug}`, the slug is `my-event-slug`.
|
|
5258
|
+
* @param slug - URL slug.
|
|
5259
|
+
* @public
|
|
5260
|
+
* @requiredField slug
|
|
5261
|
+
* @param options - Optional fields.
|
|
5262
|
+
* @permissionId WIX_EVENTS.READ_EVENTS
|
|
5263
|
+
* @applicableIdentity APP
|
|
5264
|
+
* @applicableIdentity VISITOR
|
|
5265
|
+
* @fqn wix.events.events.v3.EventManagement.GetEventBySlug
|
|
5266
|
+
*/
|
|
5267
|
+
declare function getEventBySlug(slug: string, options?: GetEventBySlugOptions): Promise<NonNullablePaths<GetEventBySlugResponse, {
|
|
5268
|
+
[P in EventNonNullablePaths]: `event.${P}`;
|
|
5269
|
+
}[EventNonNullablePaths]>>;
|
|
4749
5270
|
interface GetEventBySlugOptions {
|
|
4750
5271
|
/** @maxSize 20 */
|
|
4751
5272
|
fields?: RequestedFieldsWithLiterals[];
|
|
4752
5273
|
}
|
|
4753
5274
|
|
|
4754
|
-
export {
|
|
5275
|
+
export { type ActionEvent, type Address, type AddressLocation, type AddressStreetOneOf, type Agenda, type AgendaSettings, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, BackgroundType, type BackgroundTypeWithLiterals, type Badge, type BadgeList, BadgeTypeType, type BadgeTypeTypeWithLiterals, type BaseEventMetadata, type BlockquoteData, type BookingData, type Border, type BorderColors, type BulkCancelEventsByFilterOptions, type BulkCancelEventsByFilterRequest, type BulkCancelEventsByFilterResponse, type BulkDeleteEventsByFilterOptions, type BulkDeleteEventsByFilterRequest, type BulkDeleteEventsByFilterResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type CalendarLinks, type CalendarUrls, type CancelEventApplicationErrors, type CancelEventOptions, type CancelEventRequest, type CancelEventResponse, type CaptionData, type Category, type CategoryCounts, CategoryTypeType, type CategoryTypeTypeWithLiterals, type CellStyle, type CheckoutFormMessages, type CloneEventFromOtherSiteRequest, type CloneEventFromOtherSiteResponse, type CloneEventOptions, type CloneEventRequest, type CloneEventResponse, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type CommonAddress, type CommonAddressLocation, type CommonAddressStreetOneOf, type CommonCursors, type CommonPaging, type CommonPagingMetadataV2, type CommonQueryV2, type CommonQueryV2PagingMethodOneOf, CommonSortOrder, type CommonSortOrderWithLiterals, type CommonSorting, type CommonStreetAddress, type CommonSubdivision, ConferenceType, ConferenceTypeType, type ConferenceTypeTypeWithLiterals, type ConferenceTypeWithLiterals, type CountEventsByStatusApplicationErrors, type CountEventsByStatusOptions, type CountEventsByStatusRequest, type CountEventsByStatusResponse, type CreateEventApplicationErrors, type CreateEventOptions, type CreateEventRequest, type CreateEventResponse, type CreateEventValidationErrors, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Dashboard, type DateAndTimeSettings, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeleteEventRequest, type DeleteEventResponse, type Design, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type Event, type EventCanceled, type EventCanceledEnvelope, type EventCategories, type EventCategory, type EventCloned, type EventClonedEnvelope, type EventCopied, type EventCreated, type EventCreatedEnvelope, type EventData, type EventDeleted, type EventDeletedEnvelope, type EventDisplaySettings, type EventEnded, type EventEndedEnvelope, type EventEventCanceled, type EventEventEnded, type EventEventPublished, type EventEventReminder, type EventEventStarted, type EventMetadata, type EventPublished, type EventPublishedEnvelope, type EventReminder, type EventReminderEnvelope, type EventStarted, type EventStartedEnvelope, EventStatus, type EventStatusWithLiterals, EventType, type EventTypeWithLiterals, type EventUpdated, type EventUpdatedEnvelope, type EventsFeed, type EventsLabellingSettings, type EventsLocation, type EventsMoney, type EventsOccurrence, type EventsOnlineConferencing, type EventsOnlineConferencingSession, type EventsQueryBuilder, type EventsQueryResult, EventsRecurrenceStatusStatus, type EventsRecurrenceStatusStatusWithLiterals, type EventsRecurrences, type EventsRegistration, type EventsSeoSettings, EventsTaxType, type EventsTaxTypeWithLiterals, type ExportEventsRequest, type ExportEventsResponse, type ExternalEvent, type ExternalRegistration, type FacetCounts, type Feed, type FileData, type FileSource, type FileSourceDataOneOf, type FindEventRequest, type FindEventRequestFindByOneOf, type FindEventResponse, type FontSizeData, FontType, type FontTypeWithLiterals, type Form, type FormMessages, type Formatted, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GetEventBySlugOptions, type GetEventBySlugRequest, type GetEventBySlugResponse, type GetEventOptions, type GetEventRequest, type GetEventResponse, type Gradient, type GuestListConfig, type GuestListSettings, GuestTypeType, type GuestTypeTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, InitialRegistrationTypeType, type InitialRegistrationTypeTypeWithLiterals, type Input, type InputControl, InputControlType, type InputControlTypeWithLiterals, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, type Label, type LabellingSettings, type Layout, type LayoutCellData, LayoutType, type LayoutTypeWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListEventsByCategoryRequest, type ListEventsByCategoryResponse, type ListUserEventsRequest, type ListUserEventsResponse, type ListValue, type Location, LocationLocationType, type LocationLocationTypeWithLiterals, LocationType, type LocationTypeWithLiterals, type MapCoordinates, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MentionData, type MessageEnvelope, type Metadata, type Money, type Negative, type NegativeResponseConfirmation, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Occurrence, type Oembed, type OnlineConferencing, type OnlineConferencingConfig, type OnlineConferencingSession, type Option, type OptionDesign, type OptionLayout, type OptionSelection, type OptionSelectionSelectedOptionOneOf, type OrderedListData, Orientation, type OrientationWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type Permissions, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Positive, type PositiveResponseConfirmation, type PublishDraftEventApplicationErrors, type PublishDraftEventOptions, type PublishDraftEventRequest, type PublishDraftEventResponse, type QueryEventsApplicationErrors, type QueryEventsOptions, type QueryEventsRequest, type QueryEventsResponse, type QueryV2, type QueryV2PagingMethodOneOf, RecurrenceStatusStatus, type RecurrenceStatusStatusWithLiterals, type Recurrences, type Registration, type RegistrationClosedMessages, RegistrationStatus, RegistrationStatusStatus, type RegistrationStatusStatusWithLiterals, type RegistrationStatusWithLiterals, RegistrationTypeType, type RegistrationTypeTypeWithLiterals, type Rel, Relation, type RelationWithLiterals, RequestedFields, type RequestedFieldsWithLiterals, type ResponseConfirmation, ResponseType, type ResponseTypeWithLiterals, type RestoreInfo, type RichContent, type RsvpCollection, type RsvpCollectionConfig, type RsvpFormMessages, type RsvpRegistration, RsvpStatusOptions, type RsvpStatusOptionsWithLiterals, type RsvpSummary, type Rsvps, type ScheduleConfig, type Scheduling, type SeoSchema, type SeoSettings, type Settings, type SiteUrl, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, State, type StateWithLiterals, Status, type StatusWithLiterals, type StreetAddress, type Styles, type StylesBorder, type Subdivision, SubdivisionSubdivisionType, type SubdivisionSubdivisionTypeWithLiterals, SubdivisionType, type SubdivisionTypeWithLiterals, type Summaries, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, type TaxConfig, type TaxSettings, TaxType, type TaxTypeWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type Ticketing, type TicketingConfig, type TicketingSummary, type Tickets, type TicketsRegistration, type TicketsUnavailableMessages, type TimeDuration, Type, type TypeWithLiterals, type UpdateEventApplicationErrors, type UpdateEventOptions, type UpdateEventRequest, type UpdateEventResponse, type UpdateEventValidationErrors, type UserFilter, type V3Badge, type V3Event, type V3EventDisplaySettings, ValueType, type ValueTypeWithLiterals, VerticalAlignment, type VerticalAlignmentWithLiterals, type Video, type VideoData, ViewMode, type ViewModeWithLiterals, ViewRole, type ViewRoleWithLiterals, VisitorType, type VisitorTypeWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, bulkCancelEventsByFilter, bulkDeleteEventsByFilter, cancelEvent, cloneEvent, countEventsByStatus, createEvent, deleteEvent, getEvent, getEventBySlug, onEventCanceled, onEventCloned, onEventCreated, onEventDeleted, onEventEnded, onEventPublished, onEventReminder, onEventStarted, onEventUpdated, publishDraftEvent, queryEvents, updateEvent };
|