@wix/auto_sdk_events_wix-events-v-2 1.0.6 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/events-v3-event-wix-events-v-2.types.d.ts +640 -148
- package/build/cjs/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
- package/build/cjs/src/events-v3-event-wix-events-v-2.universal.d.ts +699 -155
- package/build/cjs/src/events-v3-event-wix-events-v-2.universal.js +8 -0
- package/build/cjs/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
- package/build/es/src/events-v3-event-wix-events-v-2.types.d.ts +640 -148
- package/build/es/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
- package/build/es/src/events-v3-event-wix-events-v-2.universal.d.ts +699 -155
- package/build/es/src/events-v3-event-wix-events-v-2.universal.js +8 -0
- package/build/es/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.types.d.ts +640 -148
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.d.ts +699 -155
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.js +8 -0
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.types.d.ts +640 -148
- package/build/internal/es/src/events-v3-event-wix-events-v-2.types.js.map +1 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.d.ts +699 -155
- package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.js +8 -0
- package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export interface V3Event {
|
|
2
2
|
/**
|
|
3
3
|
* Event ID.
|
|
4
|
+
* @format GUID
|
|
4
5
|
* @readonly
|
|
5
6
|
*/
|
|
6
7
|
_id?: string;
|
|
@@ -8,12 +9,20 @@ export interface V3Event {
|
|
|
8
9
|
location?: Location;
|
|
9
10
|
/** Event date and time settings. */
|
|
10
11
|
dateAndTimeSettings?: DateAndTimeSettings;
|
|
11
|
-
/**
|
|
12
|
+
/**
|
|
13
|
+
* Event title.
|
|
14
|
+
* @minLength 1
|
|
15
|
+
* @maxLength 120
|
|
16
|
+
*/
|
|
12
17
|
title?: string | null;
|
|
13
|
-
/**
|
|
18
|
+
/**
|
|
19
|
+
* Short description that appears under the event title.
|
|
20
|
+
* @maxLength 500
|
|
21
|
+
*/
|
|
14
22
|
shortDescription?: string | null;
|
|
15
23
|
/**
|
|
16
24
|
* Detailed description of an event. You can enter the description using rich text format (add various types of markups, such as underlines, italics, bolding, color codes, bullet lists, and links by using HTML formatting tags).
|
|
25
|
+
* @maxLength 50000
|
|
17
26
|
* @deprecated Detailed description of an event.
|
|
18
27
|
*
|
|
19
28
|
* This field is deprecated.
|
|
@@ -88,6 +97,7 @@ export interface V3Event {
|
|
|
88
97
|
/**
|
|
89
98
|
* ID of the user who created the event.
|
|
90
99
|
* @readonly
|
|
100
|
+
* @format GUID
|
|
91
101
|
*/
|
|
92
102
|
userId?: string;
|
|
93
103
|
/**
|
|
@@ -125,7 +135,10 @@ export interface V3Event {
|
|
|
125
135
|
publishedDate?: Date | null;
|
|
126
136
|
}
|
|
127
137
|
export interface Location {
|
|
128
|
-
/**
|
|
138
|
+
/**
|
|
139
|
+
* Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`.
|
|
140
|
+
* @maxLength 50
|
|
141
|
+
*/
|
|
129
142
|
name?: string | null;
|
|
130
143
|
/**
|
|
131
144
|
* Location type:
|
|
@@ -151,42 +164,83 @@ export declare enum LocationType {
|
|
|
151
164
|
export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
152
165
|
/** Street address. */
|
|
153
166
|
streetAddress?: CommonStreetAddress;
|
|
154
|
-
/**
|
|
167
|
+
/**
|
|
168
|
+
* Primary address information (street and building number).
|
|
169
|
+
* @maxLength 250
|
|
170
|
+
*/
|
|
155
171
|
addressLine1?: string | null;
|
|
156
|
-
/**
|
|
172
|
+
/**
|
|
173
|
+
* 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.
|
|
174
|
+
* @format COUNTRY
|
|
175
|
+
*/
|
|
157
176
|
country?: string | null;
|
|
158
|
-
/**
|
|
177
|
+
/**
|
|
178
|
+
* Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
|
|
179
|
+
* @maxLength 20
|
|
180
|
+
*/
|
|
159
181
|
subdivision?: string | null;
|
|
160
|
-
/**
|
|
182
|
+
/**
|
|
183
|
+
* City name.
|
|
184
|
+
* @maxLength 100
|
|
185
|
+
*/
|
|
161
186
|
city?: string | null;
|
|
162
|
-
/**
|
|
187
|
+
/**
|
|
188
|
+
* Zip or postal code.
|
|
189
|
+
* @maxLength 100
|
|
190
|
+
*/
|
|
163
191
|
postalCode?: string | null;
|
|
164
|
-
/**
|
|
192
|
+
/**
|
|
193
|
+
* Secondary address information (suite or apartment number and room number).
|
|
194
|
+
* @maxLength 250
|
|
195
|
+
*/
|
|
165
196
|
addressLine2?: string | null;
|
|
166
197
|
}
|
|
167
198
|
/** @oneof */
|
|
168
199
|
export interface CommonAddressStreetOneOf {
|
|
169
200
|
/** Street address. */
|
|
170
201
|
streetAddress?: CommonStreetAddress;
|
|
171
|
-
/**
|
|
202
|
+
/**
|
|
203
|
+
* Primary address information (street and building number).
|
|
204
|
+
* @maxLength 250
|
|
205
|
+
*/
|
|
172
206
|
addressLine?: string | null;
|
|
173
207
|
}
|
|
174
208
|
export interface CommonStreetAddress {
|
|
175
|
-
/**
|
|
209
|
+
/**
|
|
210
|
+
* Street number.
|
|
211
|
+
* @maxLength 100
|
|
212
|
+
*/
|
|
176
213
|
number?: string;
|
|
177
|
-
/**
|
|
214
|
+
/**
|
|
215
|
+
* Street name.
|
|
216
|
+
* @maxLength 250
|
|
217
|
+
*/
|
|
178
218
|
name?: string;
|
|
179
219
|
}
|
|
180
220
|
export interface CommonAddressLocation {
|
|
181
|
-
/**
|
|
221
|
+
/**
|
|
222
|
+
* Address latitude coordinates.
|
|
223
|
+
* @min -90
|
|
224
|
+
* @max 90
|
|
225
|
+
*/
|
|
182
226
|
latitude?: number | null;
|
|
183
|
-
/**
|
|
227
|
+
/**
|
|
228
|
+
* Address longitude coordinates.
|
|
229
|
+
* @min -180
|
|
230
|
+
* @max 180
|
|
231
|
+
*/
|
|
184
232
|
longitude?: number | null;
|
|
185
233
|
}
|
|
186
234
|
export interface CommonSubdivision {
|
|
187
|
-
/**
|
|
235
|
+
/**
|
|
236
|
+
* Short subdivision code.
|
|
237
|
+
* @maxLength 100
|
|
238
|
+
*/
|
|
188
239
|
code?: string;
|
|
189
|
-
/**
|
|
240
|
+
/**
|
|
241
|
+
* Subdivision full name.
|
|
242
|
+
* @maxLength 250
|
|
243
|
+
*/
|
|
190
244
|
name?: string;
|
|
191
245
|
}
|
|
192
246
|
export declare enum SubdivisionSubdivisionType {
|
|
@@ -207,7 +261,10 @@ export declare enum SubdivisionSubdivisionType {
|
|
|
207
261
|
export interface DateAndTimeSettings {
|
|
208
262
|
/** Whether the event date and time are TBD. */
|
|
209
263
|
dateAndTimeTbd?: boolean | null;
|
|
210
|
-
/**
|
|
264
|
+
/**
|
|
265
|
+
* Message that is displayed when time and date is TBD.
|
|
266
|
+
* @maxLength 100
|
|
267
|
+
*/
|
|
211
268
|
dateAndTimeTbdMessage?: string | null;
|
|
212
269
|
/**
|
|
213
270
|
* Event start date.
|
|
@@ -225,6 +282,7 @@ export interface DateAndTimeSettings {
|
|
|
225
282
|
* Event time zone ID in the TZ database format.
|
|
226
283
|
*
|
|
227
284
|
* **Note:** You need to write this field in the snake case, instead of a camel case. For example, `time_zone_id`.
|
|
285
|
+
* @maxLength 100
|
|
228
286
|
*/
|
|
229
287
|
timeZoneId?: string | null;
|
|
230
288
|
/** Whether the end date is hidden in the formatted date and time. */
|
|
@@ -262,11 +320,15 @@ export declare enum RecurrenceStatusStatus {
|
|
|
262
320
|
RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
|
|
263
321
|
}
|
|
264
322
|
export interface Recurrences {
|
|
265
|
-
/**
|
|
323
|
+
/**
|
|
324
|
+
* Individual event dates info.
|
|
325
|
+
* @maxSize 1000
|
|
326
|
+
*/
|
|
266
327
|
individualEventDates?: Occurrence[];
|
|
267
328
|
/**
|
|
268
329
|
* Recurring event category ID.
|
|
269
330
|
* @readonly
|
|
331
|
+
* @maxLength 100
|
|
270
332
|
*/
|
|
271
333
|
categoryId?: string | null;
|
|
272
334
|
}
|
|
@@ -275,7 +337,10 @@ export interface Occurrence {
|
|
|
275
337
|
startDate?: Date | null;
|
|
276
338
|
/** Event end date. */
|
|
277
339
|
endDate?: Date | null;
|
|
278
|
-
/**
|
|
340
|
+
/**
|
|
341
|
+
* Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
|
|
342
|
+
* @maxLength 100
|
|
343
|
+
*/
|
|
279
344
|
timeZoneId?: string | null;
|
|
280
345
|
/** Whether the time zone is displayed in a formatted schedule. */
|
|
281
346
|
showTimeZone?: boolean;
|
|
@@ -287,26 +352,31 @@ export interface Formatted {
|
|
|
287
352
|
* 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`.
|
|
288
353
|
* 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`.
|
|
289
354
|
* @readonly
|
|
355
|
+
* @maxLength 500
|
|
290
356
|
*/
|
|
291
357
|
dateAndTime?: string | null;
|
|
292
358
|
/**
|
|
293
359
|
* Formatted start date of the event. Empty for TBD schedules.
|
|
294
360
|
* @readonly
|
|
361
|
+
* @maxLength 500
|
|
295
362
|
*/
|
|
296
363
|
startDate?: string | null;
|
|
297
364
|
/**
|
|
298
365
|
* Formatted start time of the event. Empty for TBD schedules.
|
|
299
366
|
* @readonly
|
|
367
|
+
* @maxLength 500
|
|
300
368
|
*/
|
|
301
369
|
startTime?: string | null;
|
|
302
370
|
/**
|
|
303
371
|
* Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.
|
|
304
372
|
* @readonly
|
|
373
|
+
* @maxLength 500
|
|
305
374
|
*/
|
|
306
375
|
endDate?: string | null;
|
|
307
376
|
/**
|
|
308
377
|
* Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.
|
|
309
378
|
* @readonly
|
|
379
|
+
* @maxLength 500
|
|
310
380
|
*/
|
|
311
381
|
endTime?: string | null;
|
|
312
382
|
}
|
|
@@ -317,9 +387,15 @@ export interface Formatted {
|
|
|
317
387
|
export interface TimeDuration {
|
|
318
388
|
/** Number of days. */
|
|
319
389
|
days?: number;
|
|
320
|
-
/**
|
|
390
|
+
/**
|
|
391
|
+
* Number of hours.
|
|
392
|
+
* @max 24
|
|
393
|
+
*/
|
|
321
394
|
hours?: number;
|
|
322
|
-
/**
|
|
395
|
+
/**
|
|
396
|
+
* Number of minutes.
|
|
397
|
+
* @max 60
|
|
398
|
+
*/
|
|
323
399
|
minutes?: number;
|
|
324
400
|
}
|
|
325
401
|
export declare enum Status {
|
|
@@ -382,6 +458,7 @@ export interface Registration {
|
|
|
382
458
|
* - `TICKETING`: Guests register by buying tickets.
|
|
383
459
|
*
|
|
384
460
|
* This property value never changes.
|
|
461
|
+
* @immutable
|
|
385
462
|
*/
|
|
386
463
|
initialType?: InitialRegistrationTypeType;
|
|
387
464
|
/** Whether the registration is paused. */
|
|
@@ -445,6 +522,7 @@ export interface TicketsRegistration {
|
|
|
445
522
|
/**
|
|
446
523
|
* Ticket limit per order.
|
|
447
524
|
* Default: 20 tickets.
|
|
525
|
+
* @max 50
|
|
448
526
|
*/
|
|
449
527
|
ticketLimitPerOrder?: number;
|
|
450
528
|
/** Ticket price currency. */
|
|
@@ -472,9 +550,15 @@ export interface TicketsRegistration {
|
|
|
472
550
|
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
473
551
|
*/
|
|
474
552
|
export interface Money {
|
|
475
|
-
/**
|
|
553
|
+
/**
|
|
554
|
+
* Amount of money in decimal form. A period is used as a decimal separator (for example, `3.99`).
|
|
555
|
+
* @format DECIMAL_VALUE
|
|
556
|
+
*/
|
|
476
557
|
value?: string;
|
|
477
|
-
/**
|
|
558
|
+
/**
|
|
559
|
+
* Currency code in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
560
|
+
* @format CURRENCY
|
|
561
|
+
*/
|
|
478
562
|
currency?: string;
|
|
479
563
|
/**
|
|
480
564
|
* Amount of money in decimal form. A period or comma are used as a decimal separator (for example, `1 000,30`).
|
|
@@ -490,9 +574,16 @@ export interface TaxSettings {
|
|
|
490
574
|
* - `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.
|
|
491
575
|
*/
|
|
492
576
|
type?: TaxType;
|
|
493
|
-
/**
|
|
577
|
+
/**
|
|
578
|
+
* Tax name.
|
|
579
|
+
* @minLength 1
|
|
580
|
+
* @maxLength 10
|
|
581
|
+
*/
|
|
494
582
|
name?: string | null;
|
|
495
|
-
/**
|
|
583
|
+
/**
|
|
584
|
+
* Tax rate (for example,`21.55`).
|
|
585
|
+
* @decimalValue options - {gte:0.001,lte:100,maxScale:3}
|
|
586
|
+
*/
|
|
496
587
|
rate?: string | null;
|
|
497
588
|
/** Apply tax to donations. */
|
|
498
589
|
appliedToDonations?: boolean | null;
|
|
@@ -507,7 +598,10 @@ export declare enum TaxType {
|
|
|
507
598
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
508
599
|
}
|
|
509
600
|
export interface ExternalRegistration {
|
|
510
|
-
/**
|
|
601
|
+
/**
|
|
602
|
+
* External event registration URL.
|
|
603
|
+
* @format WEB_URL
|
|
604
|
+
*/
|
|
511
605
|
url?: string | null;
|
|
512
606
|
}
|
|
513
607
|
export declare enum GuestTypeType {
|
|
@@ -662,21 +756,29 @@ export declare enum ValueType {
|
|
|
662
756
|
* Defaults to first (0th) option if not configured.
|
|
663
757
|
*/
|
|
664
758
|
export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
665
|
-
/**
|
|
759
|
+
/**
|
|
760
|
+
* 0-based index from predefined `input.options` which is selected initially.
|
|
761
|
+
* @max 199
|
|
762
|
+
*/
|
|
666
763
|
optionIndex?: number;
|
|
667
764
|
/**
|
|
668
765
|
* Placeholder hint describing expected choices (such as "Please select").
|
|
669
766
|
* Considered an empty choice.
|
|
767
|
+
* @maxLength 200
|
|
670
768
|
*/
|
|
671
769
|
placeholderText?: string;
|
|
672
770
|
}
|
|
673
771
|
/** @oneof */
|
|
674
772
|
export interface OptionSelectionSelectedOptionOneOf {
|
|
675
|
-
/**
|
|
773
|
+
/**
|
|
774
|
+
* 0-based index from predefined `input.options` which is selected initially.
|
|
775
|
+
* @max 199
|
|
776
|
+
*/
|
|
676
777
|
optionIndex?: number;
|
|
677
778
|
/**
|
|
678
779
|
* Placeholder hint describing expected choices (such as "Please select").
|
|
679
780
|
* Considered an empty choice.
|
|
781
|
+
* @maxLength 200
|
|
680
782
|
*/
|
|
681
783
|
placeholderText?: string;
|
|
682
784
|
}
|
|
@@ -788,12 +890,19 @@ export interface Summaries {
|
|
|
788
890
|
export interface EventsMoney {
|
|
789
891
|
/**
|
|
790
892
|
* *Deprecated:** Use `value` instead.
|
|
893
|
+
* @format DECIMAL_VALUE
|
|
791
894
|
* @deprecated
|
|
792
895
|
*/
|
|
793
896
|
amount?: string;
|
|
794
|
-
/**
|
|
897
|
+
/**
|
|
898
|
+
* ISO 4217 format of the currency e.g., `USD`.
|
|
899
|
+
* @format CURRENCY
|
|
900
|
+
*/
|
|
795
901
|
currency?: string;
|
|
796
|
-
/**
|
|
902
|
+
/**
|
|
903
|
+
* Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative.
|
|
904
|
+
* @format DECIMAL_VALUE
|
|
905
|
+
*/
|
|
797
906
|
value?: string | null;
|
|
798
907
|
}
|
|
799
908
|
export interface Rsvps {
|
|
@@ -856,7 +965,10 @@ export interface Feed {
|
|
|
856
965
|
export interface OnlineConferencing {
|
|
857
966
|
/** 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. */
|
|
858
967
|
enabled?: boolean;
|
|
859
|
-
/**
|
|
968
|
+
/**
|
|
969
|
+
* Conference host ID.
|
|
970
|
+
* @format GUID
|
|
971
|
+
*/
|
|
860
972
|
providerId?: string | null;
|
|
861
973
|
/**
|
|
862
974
|
* Conference type. Possible values:
|
|
@@ -904,7 +1016,10 @@ export interface OnlineConferencingSession {
|
|
|
904
1016
|
sessionId?: string | null;
|
|
905
1017
|
}
|
|
906
1018
|
export interface SeoSettings {
|
|
907
|
-
/**
|
|
1019
|
+
/**
|
|
1020
|
+
* URL slug.
|
|
1021
|
+
* @maxLength 130
|
|
1022
|
+
*/
|
|
908
1023
|
slug?: string;
|
|
909
1024
|
/** Advanced SEO data. */
|
|
910
1025
|
advancedSeoData?: SeoSchema;
|
|
@@ -930,7 +1045,10 @@ export interface Keyword {
|
|
|
930
1045
|
term?: string;
|
|
931
1046
|
/** Whether the keyword is the main focus keyword. */
|
|
932
1047
|
isMain?: boolean;
|
|
933
|
-
/**
|
|
1048
|
+
/**
|
|
1049
|
+
* The source that added the keyword terms to the SEO settings.
|
|
1050
|
+
* @maxLength 1000
|
|
1051
|
+
*/
|
|
934
1052
|
origin?: string | null;
|
|
935
1053
|
}
|
|
936
1054
|
export interface Tag {
|
|
@@ -963,7 +1081,10 @@ export interface Settings {
|
|
|
963
1081
|
* Default: `false` (Auto Redirect is enabled.)
|
|
964
1082
|
*/
|
|
965
1083
|
preventAutoRedirect?: boolean;
|
|
966
|
-
/**
|
|
1084
|
+
/**
|
|
1085
|
+
* User-selected keyword terms for a specific page.
|
|
1086
|
+
* @maxSize 5
|
|
1087
|
+
*/
|
|
967
1088
|
keywords?: Keyword[];
|
|
968
1089
|
}
|
|
969
1090
|
export interface AgendaSettings {
|
|
@@ -976,16 +1097,24 @@ export interface AgendaSettings {
|
|
|
976
1097
|
pageUrl?: string;
|
|
977
1098
|
}
|
|
978
1099
|
export interface EventCategories {
|
|
979
|
-
/**
|
|
1100
|
+
/**
|
|
1101
|
+
* Event categories.
|
|
1102
|
+
* @maxSize 10
|
|
1103
|
+
*/
|
|
980
1104
|
categories?: EventCategory[];
|
|
981
1105
|
}
|
|
982
1106
|
export interface EventCategory {
|
|
983
1107
|
/**
|
|
984
1108
|
* Category ID.
|
|
1109
|
+
* @format GUID
|
|
985
1110
|
* @readonly
|
|
986
1111
|
*/
|
|
987
1112
|
_id?: string;
|
|
988
|
-
/**
|
|
1113
|
+
/**
|
|
1114
|
+
* Category name.
|
|
1115
|
+
* @minLength 1
|
|
1116
|
+
* @maxLength 30
|
|
1117
|
+
*/
|
|
989
1118
|
name?: string;
|
|
990
1119
|
/**
|
|
991
1120
|
* Category creation timestamp.
|
|
@@ -1615,11 +1744,20 @@ export interface GIFData {
|
|
|
1615
1744
|
gifType?: GIFType;
|
|
1616
1745
|
}
|
|
1617
1746
|
export interface GIF {
|
|
1618
|
-
/**
|
|
1747
|
+
/**
|
|
1748
|
+
* GIF format URL.
|
|
1749
|
+
* @format WEB_URL
|
|
1750
|
+
*/
|
|
1619
1751
|
gif?: string | null;
|
|
1620
|
-
/**
|
|
1752
|
+
/**
|
|
1753
|
+
* MP4 format URL.
|
|
1754
|
+
* @format WEB_URL
|
|
1755
|
+
*/
|
|
1621
1756
|
mp4?: string | null;
|
|
1622
|
-
/**
|
|
1757
|
+
/**
|
|
1758
|
+
* Thumbnail URL.
|
|
1759
|
+
* @format WEB_URL
|
|
1760
|
+
*/
|
|
1623
1761
|
still?: string | null;
|
|
1624
1762
|
}
|
|
1625
1763
|
export declare enum GIFType {
|
|
@@ -1847,13 +1985,22 @@ export declare enum BackgroundType {
|
|
|
1847
1985
|
export interface Gradient {
|
|
1848
1986
|
/** The gradient angle in degrees. */
|
|
1849
1987
|
angle?: number | null;
|
|
1850
|
-
/**
|
|
1988
|
+
/**
|
|
1989
|
+
* The start color as a hexademical value.
|
|
1990
|
+
* @format COLOR_HEX
|
|
1991
|
+
*/
|
|
1851
1992
|
startColor?: string | null;
|
|
1852
|
-
/**
|
|
1993
|
+
/**
|
|
1994
|
+
* The end color as a hexademical value.
|
|
1995
|
+
* @format COLOR_HEX
|
|
1996
|
+
*/
|
|
1853
1997
|
lastColor?: string | null;
|
|
1854
1998
|
}
|
|
1855
1999
|
export interface Background extends BackgroundBackgroundOneOf {
|
|
1856
|
-
/**
|
|
2000
|
+
/**
|
|
2001
|
+
* The background color as a hexademical value.
|
|
2002
|
+
* @format COLOR_HEX
|
|
2003
|
+
*/
|
|
1857
2004
|
color?: string | null;
|
|
1858
2005
|
/** An image to use for the background. */
|
|
1859
2006
|
image?: Media;
|
|
@@ -1864,7 +2011,10 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1864
2011
|
}
|
|
1865
2012
|
/** @oneof */
|
|
1866
2013
|
export interface BackgroundBackgroundOneOf {
|
|
1867
|
-
/**
|
|
2014
|
+
/**
|
|
2015
|
+
* The background color as a hexademical value.
|
|
2016
|
+
* @format COLOR_HEX
|
|
2017
|
+
*/
|
|
1868
2018
|
color?: string | null;
|
|
1869
2019
|
/** An image to use for the background. */
|
|
1870
2020
|
image?: Media;
|
|
@@ -2176,17 +2326,32 @@ export declare enum VerticalAlignment {
|
|
|
2176
2326
|
export interface CellStyle {
|
|
2177
2327
|
/** Vertical alignment for the cell's text. */
|
|
2178
2328
|
verticalAlignment?: VerticalAlignment;
|
|
2179
|
-
/**
|
|
2329
|
+
/**
|
|
2330
|
+
* Cell background color as a hexadecimal value.
|
|
2331
|
+
* @format COLOR_HEX
|
|
2332
|
+
*/
|
|
2180
2333
|
backgroundColor?: string | null;
|
|
2181
2334
|
}
|
|
2182
2335
|
export interface BorderColors {
|
|
2183
|
-
/**
|
|
2336
|
+
/**
|
|
2337
|
+
* Left border color as a hexadecimal value.
|
|
2338
|
+
* @format COLOR_HEX
|
|
2339
|
+
*/
|
|
2184
2340
|
left?: string | null;
|
|
2185
|
-
/**
|
|
2341
|
+
/**
|
|
2342
|
+
* Right border color as a hexadecimal value.
|
|
2343
|
+
* @format COLOR_HEX
|
|
2344
|
+
*/
|
|
2186
2345
|
right?: string | null;
|
|
2187
|
-
/**
|
|
2346
|
+
/**
|
|
2347
|
+
* Top border color as a hexadecimal value.
|
|
2348
|
+
* @format COLOR_HEX
|
|
2349
|
+
*/
|
|
2188
2350
|
top?: string | null;
|
|
2189
|
-
/**
|
|
2351
|
+
/**
|
|
2352
|
+
* Bottom border color as a hexadecimal value.
|
|
2353
|
+
* @format COLOR_HEX
|
|
2354
|
+
*/
|
|
2190
2355
|
bottom?: string | null;
|
|
2191
2356
|
}
|
|
2192
2357
|
/**
|
|
@@ -2297,27 +2462,43 @@ export interface TextNodeStyle {
|
|
|
2297
2462
|
export interface EventEventStarted {
|
|
2298
2463
|
/** Event schedule configuration. */
|
|
2299
2464
|
timestamp?: Date | null;
|
|
2300
|
-
/**
|
|
2465
|
+
/**
|
|
2466
|
+
* Event ID.
|
|
2467
|
+
* @format GUID
|
|
2468
|
+
*/
|
|
2301
2469
|
eventId?: string;
|
|
2302
2470
|
}
|
|
2303
2471
|
export interface EventEventEnded {
|
|
2304
2472
|
/** Event end timestamp in ISO UTC format. */
|
|
2305
2473
|
timestamp?: Date | null;
|
|
2306
|
-
/**
|
|
2474
|
+
/**
|
|
2475
|
+
* Event ID.
|
|
2476
|
+
* @format GUID
|
|
2477
|
+
*/
|
|
2307
2478
|
eventId?: string;
|
|
2308
2479
|
}
|
|
2309
2480
|
export interface EventEventReminder {
|
|
2310
2481
|
/** Reminder timestamp in ISO UTC format. */
|
|
2311
2482
|
timestamp?: Date | null;
|
|
2312
|
-
/**
|
|
2483
|
+
/**
|
|
2484
|
+
* Event ID.
|
|
2485
|
+
* @format GUID
|
|
2486
|
+
*/
|
|
2313
2487
|
eventId?: string;
|
|
2314
2488
|
/** Event location. */
|
|
2315
2489
|
location?: Location;
|
|
2316
2490
|
/** Event schedule configuration. */
|
|
2317
2491
|
dateAndTimeSettings?: DateAndTimeSettings;
|
|
2318
|
-
/**
|
|
2492
|
+
/**
|
|
2493
|
+
* Event title.
|
|
2494
|
+
* @minLength 1
|
|
2495
|
+
* @maxLength 120
|
|
2496
|
+
*/
|
|
2319
2497
|
title?: string;
|
|
2320
|
-
/**
|
|
2498
|
+
/**
|
|
2499
|
+
* ID of the user who created the event.
|
|
2500
|
+
* @format GUID
|
|
2501
|
+
*/
|
|
2321
2502
|
userId?: string | null;
|
|
2322
2503
|
/** Time until the start of event (currently, reminder letter is triggered 1 day before the start of event). */
|
|
2323
2504
|
startsIn?: TimeDuration;
|
|
@@ -2325,18 +2506,29 @@ export interface EventEventReminder {
|
|
|
2325
2506
|
export interface EventEventPublished {
|
|
2326
2507
|
/** Event publishing timestamp in ISO UTC format. */
|
|
2327
2508
|
timestamp?: Date | null;
|
|
2328
|
-
/**
|
|
2509
|
+
/**
|
|
2510
|
+
* Event ID.
|
|
2511
|
+
* @format GUID
|
|
2512
|
+
*/
|
|
2329
2513
|
eventId?: string;
|
|
2330
2514
|
/** Event status. */
|
|
2331
2515
|
status?: Status;
|
|
2332
2516
|
/**
|
|
2333
2517
|
* Event ID. Indicates the original event from which the current event was derived from.
|
|
2334
2518
|
* Can be used to track the original event and add missing information.
|
|
2519
|
+
* @format GUID
|
|
2335
2520
|
*/
|
|
2336
2521
|
derivedFromEventId?: string | null;
|
|
2337
|
-
/**
|
|
2522
|
+
/**
|
|
2523
|
+
* Event title.
|
|
2524
|
+
* @minLength 1
|
|
2525
|
+
* @maxLength 120
|
|
2526
|
+
*/
|
|
2338
2527
|
title?: string | null;
|
|
2339
|
-
/**
|
|
2528
|
+
/**
|
|
2529
|
+
* Short description that appears under the event title.
|
|
2530
|
+
* @maxLength 500
|
|
2531
|
+
*/
|
|
2340
2532
|
shortDescription?: string | null;
|
|
2341
2533
|
/** Event location. */
|
|
2342
2534
|
location?: Location;
|
|
@@ -2350,21 +2542,37 @@ export interface EventEventPublished {
|
|
|
2350
2542
|
export interface EventCloned {
|
|
2351
2543
|
/** Event creation timestamp in ISO UTC format. */
|
|
2352
2544
|
timestamp?: Date | null;
|
|
2353
|
-
/**
|
|
2545
|
+
/**
|
|
2546
|
+
* Event ID.
|
|
2547
|
+
* @format GUID
|
|
2548
|
+
*/
|
|
2354
2549
|
eventId?: string;
|
|
2355
2550
|
/** Event location. */
|
|
2356
2551
|
location?: Location;
|
|
2357
2552
|
/** Event date and time settings. */
|
|
2358
2553
|
dateAndTimeSettings?: DateAndTimeSettings;
|
|
2359
|
-
/**
|
|
2554
|
+
/**
|
|
2555
|
+
* Event title.
|
|
2556
|
+
* @minLength 1
|
|
2557
|
+
* @maxLength 120
|
|
2558
|
+
*/
|
|
2360
2559
|
title?: string;
|
|
2361
|
-
/**
|
|
2560
|
+
/**
|
|
2561
|
+
* ID of the user who created the event.
|
|
2562
|
+
* @format GUID
|
|
2563
|
+
*/
|
|
2362
2564
|
userId?: string | null;
|
|
2363
2565
|
/** Event status. */
|
|
2364
2566
|
status?: Status;
|
|
2365
|
-
/**
|
|
2567
|
+
/**
|
|
2568
|
+
* Instance ID. Indicates the original app instance from which current event was derived from.
|
|
2569
|
+
* @format GUID
|
|
2570
|
+
*/
|
|
2366
2571
|
derivedFromInstanceId?: string | null;
|
|
2367
|
-
/**
|
|
2572
|
+
/**
|
|
2573
|
+
* Event ID. Indicates the original event from which current event was derived from.
|
|
2574
|
+
* @format GUID
|
|
2575
|
+
*/
|
|
2368
2576
|
derivedFromEventId?: string | null;
|
|
2369
2577
|
/**
|
|
2370
2578
|
* Map of copied ticket definitions from the original event. <br>
|
|
@@ -2376,11 +2584,21 @@ export interface EventCloned {
|
|
|
2376
2584
|
export interface EventEventCanceled {
|
|
2377
2585
|
/** Event cancelation timestamp in ISO UTC format. */
|
|
2378
2586
|
timestamp?: Date | null;
|
|
2379
|
-
/**
|
|
2587
|
+
/**
|
|
2588
|
+
* Event ID.
|
|
2589
|
+
* @format GUID
|
|
2590
|
+
*/
|
|
2380
2591
|
eventId?: string;
|
|
2381
|
-
/**
|
|
2592
|
+
/**
|
|
2593
|
+
* Event title.
|
|
2594
|
+
* @minLength 1
|
|
2595
|
+
* @maxLength 120
|
|
2596
|
+
*/
|
|
2382
2597
|
title?: string;
|
|
2383
|
-
/**
|
|
2598
|
+
/**
|
|
2599
|
+
* ID of the user who created the event.
|
|
2600
|
+
* @format GUID
|
|
2601
|
+
*/
|
|
2384
2602
|
userId?: string | null;
|
|
2385
2603
|
}
|
|
2386
2604
|
export interface CreateEventRequest {
|
|
@@ -2388,7 +2606,10 @@ export interface CreateEventRequest {
|
|
|
2388
2606
|
event: V3Event;
|
|
2389
2607
|
/** Whether to create the event as a draft. */
|
|
2390
2608
|
draft?: boolean;
|
|
2391
|
-
/**
|
|
2609
|
+
/**
|
|
2610
|
+
* Predefined sets of fields to return.
|
|
2611
|
+
* @maxSize 20
|
|
2612
|
+
*/
|
|
2392
2613
|
fields?: RequestedFields[];
|
|
2393
2614
|
}
|
|
2394
2615
|
export declare enum RequestedFields {
|
|
@@ -2422,13 +2643,19 @@ export interface CreateEventResponse {
|
|
|
2422
2643
|
event?: V3Event;
|
|
2423
2644
|
}
|
|
2424
2645
|
export interface CloneEventRequest {
|
|
2425
|
-
/**
|
|
2646
|
+
/**
|
|
2647
|
+
* Event ID.
|
|
2648
|
+
* @format GUID
|
|
2649
|
+
*/
|
|
2426
2650
|
eventId: string;
|
|
2427
2651
|
/** Field values to be changed when cloning the event. */
|
|
2428
2652
|
event?: V3Event;
|
|
2429
2653
|
/** Whether to clone the event as a draft. */
|
|
2430
2654
|
draft?: boolean;
|
|
2431
|
-
/**
|
|
2655
|
+
/**
|
|
2656
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
2657
|
+
* @maxSize 20
|
|
2658
|
+
*/
|
|
2432
2659
|
fields?: RequestedFields[];
|
|
2433
2660
|
}
|
|
2434
2661
|
export interface CloneEventResponse {
|
|
@@ -2438,7 +2665,10 @@ export interface CloneEventResponse {
|
|
|
2438
2665
|
export interface UpdateEventRequest {
|
|
2439
2666
|
/** Field values to be changed. */
|
|
2440
2667
|
event?: V3Event;
|
|
2441
|
-
/**
|
|
2668
|
+
/**
|
|
2669
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
2670
|
+
* @maxSize 20
|
|
2671
|
+
*/
|
|
2442
2672
|
fields?: RequestedFields[];
|
|
2443
2673
|
}
|
|
2444
2674
|
export interface UpdateEventResponse {
|
|
@@ -2446,9 +2676,15 @@ export interface UpdateEventResponse {
|
|
|
2446
2676
|
event?: V3Event;
|
|
2447
2677
|
}
|
|
2448
2678
|
export interface PublishDraftEventRequest {
|
|
2449
|
-
/**
|
|
2679
|
+
/**
|
|
2680
|
+
* Event ID.
|
|
2681
|
+
* @format GUID
|
|
2682
|
+
*/
|
|
2450
2683
|
eventId: string;
|
|
2451
|
-
/**
|
|
2684
|
+
/**
|
|
2685
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
2686
|
+
* @maxSize 20
|
|
2687
|
+
*/
|
|
2452
2688
|
fields?: RequestedFields[];
|
|
2453
2689
|
}
|
|
2454
2690
|
export interface PublishDraftEventResponse {
|
|
@@ -2456,9 +2692,15 @@ export interface PublishDraftEventResponse {
|
|
|
2456
2692
|
event?: V3Event;
|
|
2457
2693
|
}
|
|
2458
2694
|
export interface CancelEventRequest {
|
|
2459
|
-
/**
|
|
2695
|
+
/**
|
|
2696
|
+
* Event ID.
|
|
2697
|
+
* @format GUID
|
|
2698
|
+
*/
|
|
2460
2699
|
eventId: string;
|
|
2461
|
-
/**
|
|
2700
|
+
/**
|
|
2701
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
2702
|
+
* @maxSize 20
|
|
2703
|
+
*/
|
|
2462
2704
|
fields?: RequestedFields[];
|
|
2463
2705
|
}
|
|
2464
2706
|
export interface CancelEventResponse {
|
|
@@ -2483,6 +2725,7 @@ export interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
|
|
|
2483
2725
|
/**
|
|
2484
2726
|
* Sort object in the following format:
|
|
2485
2727
|
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
2728
|
+
* @maxSize 20
|
|
2486
2729
|
*/
|
|
2487
2730
|
sort?: CommonSorting[];
|
|
2488
2731
|
}
|
|
@@ -2492,7 +2735,10 @@ export interface CommonQueryV2PagingMethodOneOf {
|
|
|
2492
2735
|
paging?: CommonPaging;
|
|
2493
2736
|
}
|
|
2494
2737
|
export interface CommonSorting {
|
|
2495
|
-
/**
|
|
2738
|
+
/**
|
|
2739
|
+
* Name of the field to sort by.
|
|
2740
|
+
* @maxLength 100
|
|
2741
|
+
*/
|
|
2496
2742
|
fieldName?: string;
|
|
2497
2743
|
/**
|
|
2498
2744
|
* Sort order.
|
|
@@ -2507,7 +2753,10 @@ export declare enum CommonSortOrder {
|
|
|
2507
2753
|
DESC = "DESC"
|
|
2508
2754
|
}
|
|
2509
2755
|
export interface CommonPaging {
|
|
2510
|
-
/**
|
|
2756
|
+
/**
|
|
2757
|
+
* 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.
|
|
2758
|
+
* @max 1000
|
|
2759
|
+
*/
|
|
2511
2760
|
limit?: number | null;
|
|
2512
2761
|
/** Number of items to skip in the current sort order. */
|
|
2513
2762
|
offset?: number | null;
|
|
@@ -2515,11 +2764,17 @@ export interface CommonPaging {
|
|
|
2515
2764
|
export interface BulkCancelEventsByFilterResponse {
|
|
2516
2765
|
}
|
|
2517
2766
|
export interface DeleteEventRequest {
|
|
2518
|
-
/**
|
|
2767
|
+
/**
|
|
2768
|
+
* Event ID.
|
|
2769
|
+
* @format GUID
|
|
2770
|
+
*/
|
|
2519
2771
|
eventId: string;
|
|
2520
2772
|
}
|
|
2521
2773
|
export interface DeleteEventResponse {
|
|
2522
|
-
/**
|
|
2774
|
+
/**
|
|
2775
|
+
* Deleted event ID.
|
|
2776
|
+
* @format GUID
|
|
2777
|
+
*/
|
|
2523
2778
|
eventId?: string;
|
|
2524
2779
|
}
|
|
2525
2780
|
export interface BulkDeleteEventsByFilterRequest {
|
|
@@ -2531,7 +2786,10 @@ export interface BulkDeleteEventsByFilterResponse {
|
|
|
2531
2786
|
export interface QueryEventsRequest {
|
|
2532
2787
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
2533
2788
|
query?: CommonQueryV2;
|
|
2534
|
-
/**
|
|
2789
|
+
/**
|
|
2790
|
+
* Predefined sets of fields to return.
|
|
2791
|
+
* @maxSize 20
|
|
2792
|
+
*/
|
|
2535
2793
|
fields?: RequestedFields[];
|
|
2536
2794
|
/**
|
|
2537
2795
|
* Whether draft events should be returned in the response. <br>
|
|
@@ -2597,7 +2855,10 @@ export interface QueryV2PagingMethodOneOf {
|
|
|
2597
2855
|
cursorPaging?: CursorPaging;
|
|
2598
2856
|
}
|
|
2599
2857
|
export interface Sorting {
|
|
2600
|
-
/**
|
|
2858
|
+
/**
|
|
2859
|
+
* Name of the field to sort by.
|
|
2860
|
+
* @maxLength 512
|
|
2861
|
+
*/
|
|
2601
2862
|
fieldName?: string;
|
|
2602
2863
|
/** Sort order. */
|
|
2603
2864
|
order?: SortOrder;
|
|
@@ -2613,13 +2874,17 @@ export interface Paging {
|
|
|
2613
2874
|
offset?: number | null;
|
|
2614
2875
|
}
|
|
2615
2876
|
export interface CursorPaging {
|
|
2616
|
-
/**
|
|
2877
|
+
/**
|
|
2878
|
+
* Maximum number of items to return in the results.
|
|
2879
|
+
* @max 100
|
|
2880
|
+
*/
|
|
2617
2881
|
limit?: number | null;
|
|
2618
2882
|
/**
|
|
2619
2883
|
* Pointer to the next or previous page in the list of results.
|
|
2620
2884
|
*
|
|
2621
2885
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
2622
2886
|
* Not relevant for the first request.
|
|
2887
|
+
* @maxLength 16000
|
|
2623
2888
|
*/
|
|
2624
2889
|
cursor?: string | null;
|
|
2625
2890
|
}
|
|
@@ -2642,15 +2907,25 @@ export interface PagingMetadataV2 {
|
|
|
2642
2907
|
cursors?: Cursors;
|
|
2643
2908
|
}
|
|
2644
2909
|
export interface Cursors {
|
|
2645
|
-
/**
|
|
2910
|
+
/**
|
|
2911
|
+
* Cursor string pointing to the next page in the list of results.
|
|
2912
|
+
* @maxLength 16000
|
|
2913
|
+
*/
|
|
2646
2914
|
next?: string | null;
|
|
2647
|
-
/**
|
|
2915
|
+
/**
|
|
2916
|
+
* Cursor pointing to the previous page in the list of results.
|
|
2917
|
+
* @maxLength 16000
|
|
2918
|
+
*/
|
|
2648
2919
|
prev?: string | null;
|
|
2649
2920
|
}
|
|
2650
2921
|
export interface CountEventsByStatusRequest {
|
|
2651
2922
|
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
|
|
2652
2923
|
filter?: Record<string, any> | null;
|
|
2653
|
-
/**
|
|
2924
|
+
/**
|
|
2925
|
+
* Parameters to count events by.
|
|
2926
|
+
* @maxLength 100
|
|
2927
|
+
* @maxSize 20
|
|
2928
|
+
*/
|
|
2654
2929
|
facet?: string[];
|
|
2655
2930
|
/**
|
|
2656
2931
|
* Whether draft events should be returned in the response. <br>
|
|
@@ -2674,22 +2949,35 @@ export interface ListUserEventsRequest {
|
|
|
2674
2949
|
/**
|
|
2675
2950
|
* Sort order, defaults to `"created:asc"`.
|
|
2676
2951
|
* See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).
|
|
2952
|
+
* @maxSize 20
|
|
2677
2953
|
*/
|
|
2678
2954
|
sort?: CommonSorting[];
|
|
2679
|
-
/**
|
|
2955
|
+
/**
|
|
2956
|
+
* Event status.
|
|
2957
|
+
* @maxSize 20
|
|
2958
|
+
*/
|
|
2680
2959
|
status?: Status[];
|
|
2681
2960
|
/** Allows to filter events by user relation to the event among all wix sites. */
|
|
2682
2961
|
userFilter?: UserFilter;
|
|
2683
2962
|
/**
|
|
2684
2963
|
* Filter facets to include in the response.
|
|
2685
2964
|
* See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).
|
|
2965
|
+
* @maxLength 100
|
|
2966
|
+
* @maxSize 20
|
|
2686
2967
|
*/
|
|
2687
2968
|
facet?: string[];
|
|
2688
2969
|
}
|
|
2689
2970
|
export interface UserFilter {
|
|
2690
|
-
/**
|
|
2971
|
+
/**
|
|
2972
|
+
* User who is related to event
|
|
2973
|
+
* @format GUID
|
|
2974
|
+
*/
|
|
2691
2975
|
userId?: string;
|
|
2692
|
-
/**
|
|
2976
|
+
/**
|
|
2977
|
+
* Relation of user to event.
|
|
2978
|
+
* @minSize 1
|
|
2979
|
+
* @maxSize 20
|
|
2980
|
+
*/
|
|
2693
2981
|
relation?: Relation[];
|
|
2694
2982
|
}
|
|
2695
2983
|
export declare enum Relation {
|
|
@@ -2705,11 +2993,17 @@ export interface ListUserEventsResponse {
|
|
|
2705
2993
|
facets?: Record<string, FacetCounts>;
|
|
2706
2994
|
}
|
|
2707
2995
|
export interface ListEventsByCategoryRequest {
|
|
2708
|
-
/**
|
|
2996
|
+
/**
|
|
2997
|
+
* Category ID.
|
|
2998
|
+
* @format GUID
|
|
2999
|
+
*/
|
|
2709
3000
|
categoryId?: string;
|
|
2710
3001
|
/** Paging options to limit and skip the number of items. */
|
|
2711
3002
|
paging?: CommonPaging;
|
|
2712
|
-
/**
|
|
3003
|
+
/**
|
|
3004
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
3005
|
+
* @maxSize 20
|
|
3006
|
+
*/
|
|
2713
3007
|
fields?: RequestedFields[];
|
|
2714
3008
|
}
|
|
2715
3009
|
export interface ListEventsByCategoryResponse {
|
|
@@ -2719,9 +3013,15 @@ export interface ListEventsByCategoryResponse {
|
|
|
2719
3013
|
events?: V3Event[];
|
|
2720
3014
|
}
|
|
2721
3015
|
export interface GetEventRequest {
|
|
2722
|
-
/**
|
|
3016
|
+
/**
|
|
3017
|
+
* Event ID.
|
|
3018
|
+
* @format GUID
|
|
3019
|
+
*/
|
|
2723
3020
|
eventId: string | null;
|
|
2724
|
-
/**
|
|
3021
|
+
/**
|
|
3022
|
+
* Predefined sets of fields to return.
|
|
3023
|
+
* @maxSize 20
|
|
3024
|
+
*/
|
|
2725
3025
|
fields?: RequestedFields[];
|
|
2726
3026
|
}
|
|
2727
3027
|
export interface GetEventResponse {
|
|
@@ -2729,8 +3029,13 @@ export interface GetEventResponse {
|
|
|
2729
3029
|
event?: V3Event;
|
|
2730
3030
|
}
|
|
2731
3031
|
export interface GetEventBySlugRequest {
|
|
2732
|
-
/**
|
|
3032
|
+
/**
|
|
3033
|
+
* URL slug.
|
|
3034
|
+
* @minLength 1
|
|
3035
|
+
* @maxLength 130
|
|
3036
|
+
*/
|
|
2733
3037
|
slug: string | null;
|
|
3038
|
+
/** @maxSize 20 */
|
|
2734
3039
|
fields?: RequestedFields[];
|
|
2735
3040
|
}
|
|
2736
3041
|
export interface GetEventBySlugResponse {
|
|
@@ -2738,18 +3043,35 @@ export interface GetEventBySlugResponse {
|
|
|
2738
3043
|
event?: V3Event;
|
|
2739
3044
|
}
|
|
2740
3045
|
export interface FindEventRequest extends FindEventRequestFindByOneOf {
|
|
2741
|
-
/**
|
|
3046
|
+
/**
|
|
3047
|
+
* Event ID.
|
|
3048
|
+
* @format GUID
|
|
3049
|
+
*/
|
|
2742
3050
|
eventId?: string | null;
|
|
2743
|
-
/**
|
|
3051
|
+
/**
|
|
3052
|
+
* URL slug.
|
|
3053
|
+
* @minLength 1
|
|
3054
|
+
* @maxLength 130
|
|
3055
|
+
*/
|
|
2744
3056
|
slug?: string | null;
|
|
2745
|
-
/**
|
|
3057
|
+
/**
|
|
3058
|
+
* Predefined sets of fields to return.
|
|
3059
|
+
* @maxSize 20
|
|
3060
|
+
*/
|
|
2746
3061
|
fields?: RequestedFields[];
|
|
2747
3062
|
}
|
|
2748
3063
|
/** @oneof */
|
|
2749
3064
|
export interface FindEventRequestFindByOneOf {
|
|
2750
|
-
/**
|
|
3065
|
+
/**
|
|
3066
|
+
* Event ID.
|
|
3067
|
+
* @format GUID
|
|
3068
|
+
*/
|
|
2751
3069
|
eventId?: string | null;
|
|
2752
|
-
/**
|
|
3070
|
+
/**
|
|
3071
|
+
* URL slug.
|
|
3072
|
+
* @minLength 1
|
|
3073
|
+
* @maxLength 130
|
|
3074
|
+
*/
|
|
2753
3075
|
slug?: string | null;
|
|
2754
3076
|
}
|
|
2755
3077
|
export interface FindEventResponse {
|
|
@@ -2759,7 +3081,10 @@ export interface FindEventResponse {
|
|
|
2759
3081
|
export interface EventCreated {
|
|
2760
3082
|
/** Event created timestamp in ISO UTC format. */
|
|
2761
3083
|
timestamp?: Date | null;
|
|
2762
|
-
/**
|
|
3084
|
+
/**
|
|
3085
|
+
* Event ID.
|
|
3086
|
+
* @format GUID
|
|
3087
|
+
*/
|
|
2763
3088
|
eventId?: string;
|
|
2764
3089
|
/** Event location. */
|
|
2765
3090
|
location?: EventsLocation;
|
|
@@ -2767,23 +3092,38 @@ export interface EventCreated {
|
|
|
2767
3092
|
scheduleConfig?: ScheduleConfig;
|
|
2768
3093
|
/** Event title. */
|
|
2769
3094
|
title?: string;
|
|
2770
|
-
/**
|
|
3095
|
+
/**
|
|
3096
|
+
* Event creator user ID.
|
|
3097
|
+
* @maxLength 36
|
|
3098
|
+
*/
|
|
2771
3099
|
userId?: string | null;
|
|
2772
3100
|
/** Event status. */
|
|
2773
3101
|
status?: EventStatus;
|
|
2774
|
-
/**
|
|
3102
|
+
/**
|
|
3103
|
+
* Instance ID. Indicates the original app instance which current event was derived from.
|
|
3104
|
+
* @format GUID
|
|
3105
|
+
*/
|
|
2775
3106
|
derivedFromInstanceId?: string | null;
|
|
2776
|
-
/**
|
|
3107
|
+
/**
|
|
3108
|
+
* Event ID. Indicates the original event which current event was derived from.
|
|
3109
|
+
* @format GUID
|
|
3110
|
+
*/
|
|
2777
3111
|
derivedFromEventId?: string | null;
|
|
2778
3112
|
/** Event that was created. */
|
|
2779
3113
|
event?: Event;
|
|
2780
3114
|
}
|
|
2781
3115
|
export interface EventsLocation {
|
|
2782
|
-
/**
|
|
3116
|
+
/**
|
|
3117
|
+
* Location name.
|
|
3118
|
+
* @maxLength 50
|
|
3119
|
+
*/
|
|
2783
3120
|
name?: string | null;
|
|
2784
3121
|
/** Location map coordinates. */
|
|
2785
3122
|
coordinates?: MapCoordinates;
|
|
2786
|
-
/**
|
|
3123
|
+
/**
|
|
3124
|
+
* Single line address representation.
|
|
3125
|
+
* @maxLength 300
|
|
3126
|
+
*/
|
|
2787
3127
|
address?: string | null;
|
|
2788
3128
|
/** Location type. */
|
|
2789
3129
|
type?: LocationLocationType;
|
|
@@ -2805,9 +3145,17 @@ export interface EventsLocation {
|
|
|
2805
3145
|
tbd?: boolean | null;
|
|
2806
3146
|
}
|
|
2807
3147
|
export interface MapCoordinates {
|
|
2808
|
-
/**
|
|
3148
|
+
/**
|
|
3149
|
+
* Latitude.
|
|
3150
|
+
* @min -90
|
|
3151
|
+
* @max 90
|
|
3152
|
+
*/
|
|
2809
3153
|
lat?: number;
|
|
2810
|
-
/**
|
|
3154
|
+
/**
|
|
3155
|
+
* Longitude.
|
|
3156
|
+
* @min -180
|
|
3157
|
+
* @max 180
|
|
3158
|
+
*/
|
|
2811
3159
|
lng?: number;
|
|
2812
3160
|
}
|
|
2813
3161
|
export declare enum LocationLocationType {
|
|
@@ -2820,7 +3168,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
2820
3168
|
streetAddress?: StreetAddress;
|
|
2821
3169
|
/** Main address line (usually street and number) as free text */
|
|
2822
3170
|
addressLine1?: string | null;
|
|
2823
|
-
/**
|
|
3171
|
+
/**
|
|
3172
|
+
* country code
|
|
3173
|
+
* @format COUNTRY
|
|
3174
|
+
*/
|
|
2824
3175
|
country?: string | null;
|
|
2825
3176
|
/** subdivision (usually state or region) code according to ISO 3166-2 */
|
|
2826
3177
|
subdivision?: string | null;
|
|
@@ -2836,7 +3187,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
2836
3187
|
location?: AddressLocation;
|
|
2837
3188
|
/** country full-name */
|
|
2838
3189
|
countryFullname?: string | null;
|
|
2839
|
-
/**
|
|
3190
|
+
/**
|
|
3191
|
+
* multi-level subdivisions from top to bottom
|
|
3192
|
+
* @maxSize 6
|
|
3193
|
+
*/
|
|
2840
3194
|
subdivisions?: Subdivision[];
|
|
2841
3195
|
}
|
|
2842
3196
|
/** @oneof */
|
|
@@ -2853,9 +3207,17 @@ export interface StreetAddress {
|
|
|
2853
3207
|
name?: string;
|
|
2854
3208
|
}
|
|
2855
3209
|
export interface AddressLocation {
|
|
2856
|
-
/**
|
|
3210
|
+
/**
|
|
3211
|
+
* address latitude coordinates
|
|
3212
|
+
* @min -90
|
|
3213
|
+
* @max 90
|
|
3214
|
+
*/
|
|
2857
3215
|
latitude?: number | null;
|
|
2858
|
-
/**
|
|
3216
|
+
/**
|
|
3217
|
+
* address longitude coordinates
|
|
3218
|
+
* @min -180
|
|
3219
|
+
* @max 180
|
|
3220
|
+
*/
|
|
2859
3221
|
longitude?: number | null;
|
|
2860
3222
|
}
|
|
2861
3223
|
export interface Subdivision {
|
|
@@ -2886,13 +3248,19 @@ export interface ScheduleConfig {
|
|
|
2886
3248
|
* `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
|
|
2887
3249
|
*/
|
|
2888
3250
|
scheduleTbd?: boolean;
|
|
2889
|
-
/**
|
|
3251
|
+
/**
|
|
3252
|
+
* TBD message.
|
|
3253
|
+
* @maxLength 100
|
|
3254
|
+
*/
|
|
2890
3255
|
scheduleTbdMessage?: string | null;
|
|
2891
3256
|
/** Event start timestamp. */
|
|
2892
3257
|
startDate?: Date | null;
|
|
2893
3258
|
/** Event end timestamp. */
|
|
2894
3259
|
endDate?: Date | null;
|
|
2895
|
-
/**
|
|
3260
|
+
/**
|
|
3261
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
3262
|
+
* @maxLength 100
|
|
3263
|
+
*/
|
|
2896
3264
|
timeZoneId?: string | null;
|
|
2897
3265
|
/** Whether end date is hidden in the formatted schedule. */
|
|
2898
3266
|
endDateHidden?: boolean;
|
|
@@ -2902,7 +3270,10 @@ export interface ScheduleConfig {
|
|
|
2902
3270
|
recurrences?: EventsRecurrences;
|
|
2903
3271
|
}
|
|
2904
3272
|
export interface EventsRecurrences {
|
|
2905
|
-
/**
|
|
3273
|
+
/**
|
|
3274
|
+
* Event occurrences.
|
|
3275
|
+
* @maxSize 1000
|
|
3276
|
+
*/
|
|
2906
3277
|
occurrences?: EventsOccurrence[];
|
|
2907
3278
|
/**
|
|
2908
3279
|
* Recurring event category ID.
|
|
@@ -2920,7 +3291,10 @@ export interface EventsOccurrence {
|
|
|
2920
3291
|
startDate?: Date | null;
|
|
2921
3292
|
/** Event end timestamp. */
|
|
2922
3293
|
endDate?: Date | null;
|
|
2923
|
-
/**
|
|
3294
|
+
/**
|
|
3295
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
3296
|
+
* @maxLength 100
|
|
3297
|
+
*/
|
|
2924
3298
|
timeZoneId?: string | null;
|
|
2925
3299
|
/** Whether time zone is displayed in formatted schedule. */
|
|
2926
3300
|
showTimeZone?: boolean;
|
|
@@ -2950,6 +3324,7 @@ export declare enum EventStatus {
|
|
|
2950
3324
|
export interface Event {
|
|
2951
3325
|
/**
|
|
2952
3326
|
* Event ID.
|
|
3327
|
+
* @format GUID
|
|
2953
3328
|
* @readonly
|
|
2954
3329
|
*/
|
|
2955
3330
|
_id?: string;
|
|
@@ -2989,7 +3364,10 @@ export interface Event {
|
|
|
2989
3364
|
instanceId?: string;
|
|
2990
3365
|
/** Guest list configuration. */
|
|
2991
3366
|
guestListConfig?: GuestListConfig;
|
|
2992
|
-
/**
|
|
3367
|
+
/**
|
|
3368
|
+
* Event creator user ID.
|
|
3369
|
+
* @maxLength 36
|
|
3370
|
+
*/
|
|
2993
3371
|
userId?: string;
|
|
2994
3372
|
/** Event discussion feed. For internal use. */
|
|
2995
3373
|
feed?: EventsFeed;
|
|
@@ -3144,17 +3522,31 @@ export interface TicketingConfig {
|
|
|
3144
3522
|
guestAssignedTickets?: boolean;
|
|
3145
3523
|
/** Tax configuration. */
|
|
3146
3524
|
taxConfig?: TaxConfig;
|
|
3147
|
-
/**
|
|
3525
|
+
/**
|
|
3526
|
+
* Limit of tickets that can be purchased per order, default 20.
|
|
3527
|
+
* @max 50
|
|
3528
|
+
*/
|
|
3148
3529
|
ticketLimitPerOrder?: number;
|
|
3149
|
-
/**
|
|
3530
|
+
/**
|
|
3531
|
+
* Duration for which the tickets being bought are reserved.
|
|
3532
|
+
* @min 5
|
|
3533
|
+
* @max 30
|
|
3534
|
+
*/
|
|
3150
3535
|
reservationDurationInMinutes?: number | null;
|
|
3151
3536
|
}
|
|
3152
3537
|
export interface TaxConfig {
|
|
3153
3538
|
/** Tax application settings. */
|
|
3154
3539
|
type?: EventsTaxType;
|
|
3155
|
-
/**
|
|
3540
|
+
/**
|
|
3541
|
+
* Tax name.
|
|
3542
|
+
* @minLength 1
|
|
3543
|
+
* @maxLength 10
|
|
3544
|
+
*/
|
|
3156
3545
|
name?: string | null;
|
|
3157
|
-
/**
|
|
3546
|
+
/**
|
|
3547
|
+
* Tax rate (e.g.,`21.55`).
|
|
3548
|
+
* @decimalValue options - {gte:0.001,lte:100,maxScale:3}
|
|
3549
|
+
*/
|
|
3158
3550
|
rate?: string | null;
|
|
3159
3551
|
/** Applies taxes for donations, default true. */
|
|
3160
3552
|
appliesToDonations?: boolean | null;
|
|
@@ -3247,7 +3639,10 @@ export interface OnlineConferencingConfig {
|
|
|
3247
3639
|
* When enabled, links to join conferencing are generated and provided to guests.
|
|
3248
3640
|
*/
|
|
3249
3641
|
enabled?: boolean;
|
|
3250
|
-
/**
|
|
3642
|
+
/**
|
|
3643
|
+
* Conferencing provider ID.
|
|
3644
|
+
* @format GUID
|
|
3645
|
+
*/
|
|
3251
3646
|
providerId?: string | null;
|
|
3252
3647
|
/** Conference type */
|
|
3253
3648
|
conferenceType?: ConferenceType;
|
|
@@ -3286,7 +3681,10 @@ export interface EventsOnlineConferencingSession {
|
|
|
3286
3681
|
sessionId?: string | null;
|
|
3287
3682
|
}
|
|
3288
3683
|
export interface EventsSeoSettings {
|
|
3289
|
-
/**
|
|
3684
|
+
/**
|
|
3685
|
+
* URL slug
|
|
3686
|
+
* @maxLength 130
|
|
3687
|
+
*/
|
|
3290
3688
|
slug?: string;
|
|
3291
3689
|
/** Advanced SEO data */
|
|
3292
3690
|
advancedSeoData?: SeoSchema;
|
|
@@ -3308,10 +3706,15 @@ export interface Agenda {
|
|
|
3308
3706
|
export interface Category {
|
|
3309
3707
|
/**
|
|
3310
3708
|
* Category ID.
|
|
3709
|
+
* @format GUID
|
|
3311
3710
|
* @readonly
|
|
3312
3711
|
*/
|
|
3313
3712
|
_id?: string;
|
|
3314
|
-
/**
|
|
3713
|
+
/**
|
|
3714
|
+
* Category name.
|
|
3715
|
+
* @minLength 1
|
|
3716
|
+
* @maxLength 30
|
|
3717
|
+
*/
|
|
3315
3718
|
name?: string;
|
|
3316
3719
|
/**
|
|
3317
3720
|
* Date and time when category was created.
|
|
@@ -3334,6 +3737,7 @@ export interface Category {
|
|
|
3334
3737
|
* Default: `MANUAL`.
|
|
3335
3738
|
*
|
|
3336
3739
|
* **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
|
|
3740
|
+
* @maxSize 3
|
|
3337
3741
|
*/
|
|
3338
3742
|
states?: State[];
|
|
3339
3743
|
}
|
|
@@ -3366,7 +3770,10 @@ export interface Empty {
|
|
|
3366
3770
|
export interface EventUpdated {
|
|
3367
3771
|
/** Event update timestamp in ISO UTC format. */
|
|
3368
3772
|
timestamp?: Date | null;
|
|
3369
|
-
/**
|
|
3773
|
+
/**
|
|
3774
|
+
* Event ID.
|
|
3775
|
+
* @format GUID
|
|
3776
|
+
*/
|
|
3370
3777
|
eventId?: string;
|
|
3371
3778
|
/** Event location. */
|
|
3372
3779
|
location?: EventsLocation;
|
|
@@ -3385,17 +3792,26 @@ export interface EventUpdated {
|
|
|
3385
3792
|
export interface EventDeleted {
|
|
3386
3793
|
/** Event deleted timestamp in ISO UTC format. */
|
|
3387
3794
|
timestamp?: Date | null;
|
|
3388
|
-
/**
|
|
3795
|
+
/**
|
|
3796
|
+
* Event ID.
|
|
3797
|
+
* @format GUID
|
|
3798
|
+
*/
|
|
3389
3799
|
eventId?: string;
|
|
3390
3800
|
/** Event title. */
|
|
3391
3801
|
title?: string;
|
|
3392
|
-
/**
|
|
3802
|
+
/**
|
|
3803
|
+
* Event creator user ID.
|
|
3804
|
+
* @format GUID
|
|
3805
|
+
*/
|
|
3393
3806
|
userId?: string | null;
|
|
3394
3807
|
}
|
|
3395
3808
|
export interface EventCopied {
|
|
3396
3809
|
/** Event created timestamp in ISO UTC format. */
|
|
3397
3810
|
timestamp?: Date | null;
|
|
3398
|
-
/**
|
|
3811
|
+
/**
|
|
3812
|
+
* Event ID.
|
|
3813
|
+
* @format GUID
|
|
3814
|
+
*/
|
|
3399
3815
|
eventId?: string;
|
|
3400
3816
|
/** Event location. */
|
|
3401
3817
|
location?: EventsLocation;
|
|
@@ -3403,13 +3819,22 @@ export interface EventCopied {
|
|
|
3403
3819
|
scheduleConfig?: ScheduleConfig;
|
|
3404
3820
|
/** Event title. */
|
|
3405
3821
|
title?: string;
|
|
3406
|
-
/**
|
|
3822
|
+
/**
|
|
3823
|
+
* Event creator user ID.
|
|
3824
|
+
* @format GUID
|
|
3825
|
+
*/
|
|
3407
3826
|
userId?: string | null;
|
|
3408
3827
|
/** Event status. */
|
|
3409
3828
|
status?: EventStatus;
|
|
3410
|
-
/**
|
|
3829
|
+
/**
|
|
3830
|
+
* Instance ID. Indicates the original app instance which current event was derived from.
|
|
3831
|
+
* @format GUID
|
|
3832
|
+
*/
|
|
3411
3833
|
derivedFromInstanceId?: string | null;
|
|
3412
|
-
/**
|
|
3834
|
+
/**
|
|
3835
|
+
* Event ID. Indicates the original event which current event was derived from.
|
|
3836
|
+
* @format GUID
|
|
3837
|
+
*/
|
|
3413
3838
|
derivedFromEventId?: string | null;
|
|
3414
3839
|
/**
|
|
3415
3840
|
* Map of copied ticket definitions from original event.
|
|
@@ -3421,7 +3846,10 @@ export interface EventCopied {
|
|
|
3421
3846
|
export interface EventPublished {
|
|
3422
3847
|
/** Event publish timestamp in ISO UTC format. */
|
|
3423
3848
|
timestamp?: Date | null;
|
|
3424
|
-
/**
|
|
3849
|
+
/**
|
|
3850
|
+
* Event ID.
|
|
3851
|
+
* @format GUID
|
|
3852
|
+
*/
|
|
3425
3853
|
eventId?: string;
|
|
3426
3854
|
/** Event status. */
|
|
3427
3855
|
status?: EventStatus;
|
|
@@ -3446,29 +3874,44 @@ export interface EventPublished {
|
|
|
3446
3874
|
export interface EventCanceled {
|
|
3447
3875
|
/** Event canceled timestamp in ISO UTC format. */
|
|
3448
3876
|
timestamp?: Date | null;
|
|
3449
|
-
/**
|
|
3877
|
+
/**
|
|
3878
|
+
* Event ID.
|
|
3879
|
+
* @format GUID
|
|
3880
|
+
*/
|
|
3450
3881
|
eventId?: string;
|
|
3451
3882
|
/** Event title */
|
|
3452
3883
|
title?: string;
|
|
3453
|
-
/**
|
|
3884
|
+
/**
|
|
3885
|
+
* Event creator user ID.
|
|
3886
|
+
* @format GUID
|
|
3887
|
+
*/
|
|
3454
3888
|
userId?: string | null;
|
|
3455
3889
|
}
|
|
3456
3890
|
export interface EventStarted {
|
|
3457
3891
|
/** Event start timestamp in ISO UTC format. */
|
|
3458
3892
|
timestamp?: Date | null;
|
|
3459
|
-
/**
|
|
3893
|
+
/**
|
|
3894
|
+
* Event ID.
|
|
3895
|
+
* @format GUID
|
|
3896
|
+
*/
|
|
3460
3897
|
eventId?: string;
|
|
3461
3898
|
}
|
|
3462
3899
|
export interface EventEnded {
|
|
3463
3900
|
/** Event end timestamp in ISO UTC format. */
|
|
3464
3901
|
timestamp?: Date | null;
|
|
3465
|
-
/**
|
|
3902
|
+
/**
|
|
3903
|
+
* Event ID.
|
|
3904
|
+
* @format GUID
|
|
3905
|
+
*/
|
|
3466
3906
|
eventId?: string;
|
|
3467
3907
|
}
|
|
3468
3908
|
export interface EventReminder {
|
|
3469
3909
|
/** Reminder timestamp in ISO UTC format. */
|
|
3470
3910
|
timestamp?: Date | null;
|
|
3471
|
-
/**
|
|
3911
|
+
/**
|
|
3912
|
+
* Event ID.
|
|
3913
|
+
* @format GUID
|
|
3914
|
+
*/
|
|
3472
3915
|
eventId?: string;
|
|
3473
3916
|
/** Event location. */
|
|
3474
3917
|
location?: EventsLocation;
|
|
@@ -3476,7 +3919,10 @@ export interface EventReminder {
|
|
|
3476
3919
|
scheduleConfig?: ScheduleConfig;
|
|
3477
3920
|
/** Event title. */
|
|
3478
3921
|
title?: string;
|
|
3479
|
-
/**
|
|
3922
|
+
/**
|
|
3923
|
+
* Event creator user ID.
|
|
3924
|
+
* @format GUID
|
|
3925
|
+
*/
|
|
3480
3926
|
userId?: string | null;
|
|
3481
3927
|
/** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
|
|
3482
3928
|
startsIn?: TimeDuration;
|
|
@@ -3552,9 +3998,15 @@ export interface ActionEvent {
|
|
|
3552
3998
|
body?: string;
|
|
3553
3999
|
}
|
|
3554
4000
|
export interface MessageEnvelope {
|
|
3555
|
-
/**
|
|
4001
|
+
/**
|
|
4002
|
+
* App instance ID.
|
|
4003
|
+
* @format GUID
|
|
4004
|
+
*/
|
|
3556
4005
|
instanceId?: string | null;
|
|
3557
|
-
/**
|
|
4006
|
+
/**
|
|
4007
|
+
* Event type.
|
|
4008
|
+
* @maxLength 150
|
|
4009
|
+
*/
|
|
3558
4010
|
eventType?: string;
|
|
3559
4011
|
/** The identification type and identity data. */
|
|
3560
4012
|
identity?: IdentificationData;
|
|
@@ -3562,26 +4014,50 @@ export interface MessageEnvelope {
|
|
|
3562
4014
|
data?: string;
|
|
3563
4015
|
}
|
|
3564
4016
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3565
|
-
/**
|
|
4017
|
+
/**
|
|
4018
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4019
|
+
* @format GUID
|
|
4020
|
+
*/
|
|
3566
4021
|
anonymousVisitorId?: string;
|
|
3567
|
-
/**
|
|
4022
|
+
/**
|
|
4023
|
+
* ID of a site visitor that has logged in to the site.
|
|
4024
|
+
* @format GUID
|
|
4025
|
+
*/
|
|
3568
4026
|
memberId?: string;
|
|
3569
|
-
/**
|
|
4027
|
+
/**
|
|
4028
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4029
|
+
* @format GUID
|
|
4030
|
+
*/
|
|
3570
4031
|
wixUserId?: string;
|
|
3571
|
-
/**
|
|
4032
|
+
/**
|
|
4033
|
+
* ID of an app.
|
|
4034
|
+
* @format GUID
|
|
4035
|
+
*/
|
|
3572
4036
|
appId?: string;
|
|
3573
4037
|
/** @readonly */
|
|
3574
4038
|
identityType?: WebhookIdentityType;
|
|
3575
4039
|
}
|
|
3576
4040
|
/** @oneof */
|
|
3577
4041
|
export interface IdentificationDataIdOneOf {
|
|
3578
|
-
/**
|
|
4042
|
+
/**
|
|
4043
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4044
|
+
* @format GUID
|
|
4045
|
+
*/
|
|
3579
4046
|
anonymousVisitorId?: string;
|
|
3580
|
-
/**
|
|
4047
|
+
/**
|
|
4048
|
+
* ID of a site visitor that has logged in to the site.
|
|
4049
|
+
* @format GUID
|
|
4050
|
+
*/
|
|
3581
4051
|
memberId?: string;
|
|
3582
|
-
/**
|
|
4052
|
+
/**
|
|
4053
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4054
|
+
* @format GUID
|
|
4055
|
+
*/
|
|
3583
4056
|
wixUserId?: string;
|
|
3584
|
-
/**
|
|
4057
|
+
/**
|
|
4058
|
+
* ID of an app.
|
|
4059
|
+
* @format GUID
|
|
4060
|
+
*/
|
|
3585
4061
|
appId?: string;
|
|
3586
4062
|
}
|
|
3587
4063
|
export declare enum WebhookIdentityType {
|
|
@@ -4103,9 +4579,15 @@ export interface GetEventBySlugResponseNonNullableFields {
|
|
|
4103
4579
|
event?: V3EventNonNullableFields;
|
|
4104
4580
|
}
|
|
4105
4581
|
export interface BaseEventMetadata {
|
|
4106
|
-
/**
|
|
4582
|
+
/**
|
|
4583
|
+
* App instance ID.
|
|
4584
|
+
* @format GUID
|
|
4585
|
+
*/
|
|
4107
4586
|
instanceId?: string | null;
|
|
4108
|
-
/**
|
|
4587
|
+
/**
|
|
4588
|
+
* Event type.
|
|
4589
|
+
* @maxLength 150
|
|
4590
|
+
*/
|
|
4109
4591
|
eventType?: string;
|
|
4110
4592
|
/** The identification type and identity data. */
|
|
4111
4593
|
identity?: IdentificationData;
|
|
@@ -4170,6 +4652,8 @@ export interface EventCanceledEnvelope {
|
|
|
4170
4652
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4171
4653
|
* @permissionScope Manage Restaurants - all permissions
|
|
4172
4654
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4655
|
+
* @permissionScope Set Up Automations
|
|
4656
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4173
4657
|
* @permissionScope Manage Guest List
|
|
4174
4658
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4175
4659
|
* @permissionScope Manage Events
|
|
@@ -4202,6 +4686,8 @@ export interface EventClonedEnvelope {
|
|
|
4202
4686
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4203
4687
|
* @permissionScope Manage Restaurants - all permissions
|
|
4204
4688
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4689
|
+
* @permissionScope Set Up Automations
|
|
4690
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4205
4691
|
* @permissionScope Manage Guest List
|
|
4206
4692
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4207
4693
|
* @permissionScope Manage Events
|
|
@@ -4234,6 +4720,8 @@ export interface EventCreatedEnvelope {
|
|
|
4234
4720
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4235
4721
|
* @permissionScope Manage Restaurants - all permissions
|
|
4236
4722
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4723
|
+
* @permissionScope Set Up Automations
|
|
4724
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4237
4725
|
* @permissionScope Manage Guest List
|
|
4238
4726
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4239
4727
|
* @permissionScope Manage Events
|
|
@@ -4265,6 +4753,8 @@ export interface EventDeletedEnvelope {
|
|
|
4265
4753
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4266
4754
|
* @permissionScope Manage Restaurants - all permissions
|
|
4267
4755
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4756
|
+
* @permissionScope Set Up Automations
|
|
4757
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4268
4758
|
* @permissionScope Manage Guest List
|
|
4269
4759
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4270
4760
|
* @permissionScope Manage Events
|
|
@@ -4297,6 +4787,8 @@ export interface EventEndedEnvelope {
|
|
|
4297
4787
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4298
4788
|
* @permissionScope Manage Restaurants - all permissions
|
|
4299
4789
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4790
|
+
* @permissionScope Set Up Automations
|
|
4791
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4300
4792
|
* @permissionScope Manage Guest List
|
|
4301
4793
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4302
4794
|
* @permissionScope Manage Events
|
|
@@ -4329,6 +4821,8 @@ export interface EventPublishedEnvelope {
|
|
|
4329
4821
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4330
4822
|
* @permissionScope Manage Restaurants - all permissions
|
|
4331
4823
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4824
|
+
* @permissionScope Set Up Automations
|
|
4825
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4332
4826
|
* @permissionScope Manage Guest List
|
|
4333
4827
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4334
4828
|
* @permissionScope Manage Events
|
|
@@ -4367,6 +4861,8 @@ export interface EventReminderEnvelope {
|
|
|
4367
4861
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4368
4862
|
* @permissionScope Manage Restaurants - all permissions
|
|
4369
4863
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4864
|
+
* @permissionScope Set Up Automations
|
|
4865
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4370
4866
|
* @permissionScope Manage Guest List
|
|
4371
4867
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4372
4868
|
* @permissionScope Manage Events
|
|
@@ -4399,6 +4895,8 @@ export interface EventStartedEnvelope {
|
|
|
4399
4895
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4400
4896
|
* @permissionScope Manage Restaurants - all permissions
|
|
4401
4897
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4898
|
+
* @permissionScope Set Up Automations
|
|
4899
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4402
4900
|
* @permissionScope Manage Guest List
|
|
4403
4901
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4404
4902
|
* @permissionScope Manage Events
|
|
@@ -4431,6 +4929,8 @@ export interface EventUpdatedEnvelope {
|
|
|
4431
4929
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4432
4930
|
* @permissionScope Manage Restaurants - all permissions
|
|
4433
4931
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4932
|
+
* @permissionScope Set Up Automations
|
|
4933
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4434
4934
|
* @permissionScope Manage Guest List
|
|
4435
4935
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4436
4936
|
* @permissionScope Manage Events
|
|
@@ -4473,7 +4973,10 @@ export declare function createEvent(event: V3Event, options?: CreateEventOptions
|
|
|
4473
4973
|
export interface CreateEventOptions {
|
|
4474
4974
|
/** Whether to create the event as a draft. */
|
|
4475
4975
|
draft?: boolean;
|
|
4476
|
-
/**
|
|
4976
|
+
/**
|
|
4977
|
+
* Predefined sets of fields to return.
|
|
4978
|
+
* @maxSize 20
|
|
4979
|
+
*/
|
|
4477
4980
|
fields?: RequestedFields[];
|
|
4478
4981
|
}
|
|
4479
4982
|
/**
|
|
@@ -4502,7 +5005,10 @@ export interface CloneEventOptions {
|
|
|
4502
5005
|
event?: V3Event;
|
|
4503
5006
|
/** Whether to clone the event as a draft. */
|
|
4504
5007
|
draft?: boolean;
|
|
4505
|
-
/**
|
|
5008
|
+
/**
|
|
5009
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
5010
|
+
* @maxSize 20
|
|
5011
|
+
*/
|
|
4506
5012
|
fields?: RequestedFields[];
|
|
4507
5013
|
}
|
|
4508
5014
|
/**
|
|
@@ -4528,6 +5034,7 @@ export interface UpdateEventOptions {
|
|
|
4528
5034
|
event: {
|
|
4529
5035
|
/**
|
|
4530
5036
|
* Event ID.
|
|
5037
|
+
* @format GUID
|
|
4531
5038
|
* @readonly
|
|
4532
5039
|
*/
|
|
4533
5040
|
_id?: string;
|
|
@@ -4535,12 +5042,20 @@ export interface UpdateEventOptions {
|
|
|
4535
5042
|
location?: Location;
|
|
4536
5043
|
/** Event date and time settings. */
|
|
4537
5044
|
dateAndTimeSettings?: DateAndTimeSettings;
|
|
4538
|
-
/**
|
|
5045
|
+
/**
|
|
5046
|
+
* Event title.
|
|
5047
|
+
* @minLength 1
|
|
5048
|
+
* @maxLength 120
|
|
5049
|
+
*/
|
|
4539
5050
|
title?: string | null;
|
|
4540
|
-
/**
|
|
5051
|
+
/**
|
|
5052
|
+
* Short description that appears under the event title.
|
|
5053
|
+
* @maxLength 500
|
|
5054
|
+
*/
|
|
4541
5055
|
shortDescription?: string | null;
|
|
4542
5056
|
/**
|
|
4543
5057
|
* Detailed description of an event. You can enter the description using rich text format (add various types of markups, such as underlines, italics, bolding, color codes, bullet lists, and links by using HTML formatting tags).
|
|
5058
|
+
* @maxLength 50000
|
|
4544
5059
|
* @deprecated Detailed description of an event.
|
|
4545
5060
|
*
|
|
4546
5061
|
* This field is deprecated.
|
|
@@ -4615,6 +5130,7 @@ export interface UpdateEventOptions {
|
|
|
4615
5130
|
/**
|
|
4616
5131
|
* ID of the user who created the event.
|
|
4617
5132
|
* @readonly
|
|
5133
|
+
* @format GUID
|
|
4618
5134
|
*/
|
|
4619
5135
|
userId?: string;
|
|
4620
5136
|
/**
|
|
@@ -4651,7 +5167,10 @@ export interface UpdateEventOptions {
|
|
|
4651
5167
|
*/
|
|
4652
5168
|
publishedDate?: Date | null;
|
|
4653
5169
|
};
|
|
4654
|
-
/**
|
|
5170
|
+
/**
|
|
5171
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
5172
|
+
* @maxSize 20
|
|
5173
|
+
*/
|
|
4655
5174
|
fields?: RequestedFields[];
|
|
4656
5175
|
}
|
|
4657
5176
|
/**
|
|
@@ -4675,7 +5194,10 @@ export interface UpdateEventOptions {
|
|
|
4675
5194
|
*/
|
|
4676
5195
|
export declare function publishDraftEvent(eventId: string, options?: PublishDraftEventOptions): Promise<PublishDraftEventResponse & PublishDraftEventResponseNonNullableFields>;
|
|
4677
5196
|
export interface PublishDraftEventOptions {
|
|
4678
|
-
/**
|
|
5197
|
+
/**
|
|
5198
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
5199
|
+
* @maxSize 20
|
|
5200
|
+
*/
|
|
4679
5201
|
fields?: RequestedFields[];
|
|
4680
5202
|
}
|
|
4681
5203
|
/**
|
|
@@ -4700,7 +5222,10 @@ export interface PublishDraftEventOptions {
|
|
|
4700
5222
|
*/
|
|
4701
5223
|
export declare function cancelEvent(eventId: string, options?: CancelEventOptions): Promise<CancelEventResponse & CancelEventResponseNonNullableFields>;
|
|
4702
5224
|
export interface CancelEventOptions {
|
|
4703
|
-
/**
|
|
5225
|
+
/**
|
|
5226
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
5227
|
+
* @maxSize 20
|
|
5228
|
+
*/
|
|
4704
5229
|
fields?: RequestedFields[];
|
|
4705
5230
|
}
|
|
4706
5231
|
/**
|
|
@@ -4802,6 +5327,8 @@ export interface BulkDeleteEventsByFilterOptions {
|
|
|
4802
5327
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4803
5328
|
* @permissionScope Manage Restaurants - all permissions
|
|
4804
5329
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
5330
|
+
* @permissionScope Set Up Automations
|
|
5331
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4805
5332
|
* @permissionScope Manage Guest List
|
|
4806
5333
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4807
5334
|
* @permissionScope Manage Events
|
|
@@ -4813,7 +5340,10 @@ export interface BulkDeleteEventsByFilterOptions {
|
|
|
4813
5340
|
*/
|
|
4814
5341
|
export declare function queryEvents(options?: QueryEventsOptions): EventsQueryBuilder;
|
|
4815
5342
|
export interface QueryEventsOptions {
|
|
4816
|
-
/**
|
|
5343
|
+
/**
|
|
5344
|
+
* Predefined sets of fields to return.
|
|
5345
|
+
* @maxSize 20
|
|
5346
|
+
*/
|
|
4817
5347
|
fields?: RequestedFields[] | undefined;
|
|
4818
5348
|
/**
|
|
4819
5349
|
* Whether draft events should be returned in the response. <br>
|
|
@@ -4893,6 +5423,8 @@ export interface EventsQueryBuilder {
|
|
|
4893
5423
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4894
5424
|
* @permissionScope Manage Restaurants - all permissions
|
|
4895
5425
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
5426
|
+
* @permissionScope Set Up Automations
|
|
5427
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4896
5428
|
* @permissionScope Manage Guest List
|
|
4897
5429
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4898
5430
|
* @permissionScope Manage Events
|
|
@@ -4905,7 +5437,11 @@ export declare function countEventsByStatus(options?: CountEventsByStatusOptions
|
|
|
4905
5437
|
export interface CountEventsByStatusOptions {
|
|
4906
5438
|
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
|
|
4907
5439
|
filter?: Record<string, any> | null;
|
|
4908
|
-
/**
|
|
5440
|
+
/**
|
|
5441
|
+
* Parameters to count events by.
|
|
5442
|
+
* @maxLength 100
|
|
5443
|
+
* @maxSize 20
|
|
5444
|
+
*/
|
|
4909
5445
|
facet?: string[];
|
|
4910
5446
|
/**
|
|
4911
5447
|
* Whether draft events should be returned in the response. <br>
|
|
@@ -4936,6 +5472,8 @@ export interface CountEventsByStatusOptions {
|
|
|
4936
5472
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4937
5473
|
* @permissionScope Manage Restaurants - all permissions
|
|
4938
5474
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
5475
|
+
* @permissionScope Set Up Automations
|
|
5476
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4939
5477
|
* @permissionScope Manage Guest List
|
|
4940
5478
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4941
5479
|
* @permissionScope Manage Events
|
|
@@ -4947,7 +5485,10 @@ export interface CountEventsByStatusOptions {
|
|
|
4947
5485
|
*/
|
|
4948
5486
|
export declare function getEvent(eventId: string | null, options?: GetEventOptions): Promise<V3Event & V3EventNonNullableFields>;
|
|
4949
5487
|
export interface GetEventOptions {
|
|
4950
|
-
/**
|
|
5488
|
+
/**
|
|
5489
|
+
* Predefined sets of fields to return.
|
|
5490
|
+
* @maxSize 20
|
|
5491
|
+
*/
|
|
4951
5492
|
fields?: RequestedFields[];
|
|
4952
5493
|
}
|
|
4953
5494
|
/**
|
|
@@ -4976,6 +5517,8 @@ export interface GetEventOptions {
|
|
|
4976
5517
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4977
5518
|
* @permissionScope Manage Restaurants - all permissions
|
|
4978
5519
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
5520
|
+
* @permissionScope Set Up Automations
|
|
5521
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4979
5522
|
* @permissionScope Manage Guest List
|
|
4980
5523
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4981
5524
|
* @permissionScope Manage Events
|
|
@@ -4986,6 +5529,7 @@ export interface GetEventOptions {
|
|
|
4986
5529
|
*/
|
|
4987
5530
|
export declare function getEventBySlug(slug: string | null, options?: GetEventBySlugOptions): Promise<GetEventBySlugResponse & GetEventBySlugResponseNonNullableFields>;
|
|
4988
5531
|
export interface GetEventBySlugOptions {
|
|
5532
|
+
/** @maxSize 20 */
|
|
4989
5533
|
fields?: RequestedFields[];
|
|
4990
5534
|
}
|
|
4991
5535
|
export {};
|