@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,17 +9,23 @@ 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
|
/**
|
|
14
19
|
* Short description that appears under the event title. <br>
|
|
15
20
|
* **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.
|
|
21
|
+
* @maxLength 500
|
|
16
22
|
*/
|
|
17
23
|
shortDescription?: string | null;
|
|
18
24
|
/**
|
|
19
25
|
* Detailed description of an event.
|
|
20
26
|
*
|
|
21
27
|
* This field is deprecated.
|
|
28
|
+
* @maxLength 50000
|
|
22
29
|
* @deprecated Detailed description of an event.
|
|
23
30
|
*
|
|
24
31
|
* This field is deprecated.
|
|
@@ -87,6 +94,7 @@ export interface V3Event {
|
|
|
87
94
|
/**
|
|
88
95
|
* ID of the user who created the event.
|
|
89
96
|
* @readonly
|
|
97
|
+
* @format GUID
|
|
90
98
|
*/
|
|
91
99
|
userId?: string;
|
|
92
100
|
/**
|
|
@@ -120,7 +128,10 @@ export interface V3Event {
|
|
|
120
128
|
publishedDate?: Date | null;
|
|
121
129
|
}
|
|
122
130
|
export interface Location {
|
|
123
|
-
/**
|
|
131
|
+
/**
|
|
132
|
+
* Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`.
|
|
133
|
+
* @maxLength 50
|
|
134
|
+
*/
|
|
124
135
|
name?: string | null;
|
|
125
136
|
/** Location type. */
|
|
126
137
|
type?: LocationType;
|
|
@@ -141,42 +152,83 @@ export declare enum LocationType {
|
|
|
141
152
|
export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
142
153
|
/** Street address. */
|
|
143
154
|
streetAddress?: CommonStreetAddress;
|
|
144
|
-
/**
|
|
155
|
+
/**
|
|
156
|
+
* Primary address information (street and building number).
|
|
157
|
+
* @maxLength 250
|
|
158
|
+
*/
|
|
145
159
|
addressLine?: string | null;
|
|
146
|
-
/**
|
|
160
|
+
/**
|
|
161
|
+
* 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.
|
|
162
|
+
* @format COUNTRY
|
|
163
|
+
*/
|
|
147
164
|
country?: string | null;
|
|
148
|
-
/**
|
|
165
|
+
/**
|
|
166
|
+
* Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
|
|
167
|
+
* @maxLength 20
|
|
168
|
+
*/
|
|
149
169
|
subdivision?: string | null;
|
|
150
|
-
/**
|
|
170
|
+
/**
|
|
171
|
+
* City name.
|
|
172
|
+
* @maxLength 100
|
|
173
|
+
*/
|
|
151
174
|
city?: string | null;
|
|
152
|
-
/**
|
|
175
|
+
/**
|
|
176
|
+
* Zip or postal code.
|
|
177
|
+
* @maxLength 100
|
|
178
|
+
*/
|
|
153
179
|
postalCode?: string | null;
|
|
154
|
-
/**
|
|
180
|
+
/**
|
|
181
|
+
* Secondary address information (suite or apartment number and room number).
|
|
182
|
+
* @maxLength 250
|
|
183
|
+
*/
|
|
155
184
|
addressLine2?: string | null;
|
|
156
185
|
}
|
|
157
186
|
/** @oneof */
|
|
158
187
|
export interface CommonAddressStreetOneOf {
|
|
159
188
|
/** Street address. */
|
|
160
189
|
streetAddress?: CommonStreetAddress;
|
|
161
|
-
/**
|
|
190
|
+
/**
|
|
191
|
+
* Primary address information (street and building number).
|
|
192
|
+
* @maxLength 250
|
|
193
|
+
*/
|
|
162
194
|
addressLine?: string | null;
|
|
163
195
|
}
|
|
164
196
|
export interface CommonStreetAddress {
|
|
165
|
-
/**
|
|
197
|
+
/**
|
|
198
|
+
* Street number.
|
|
199
|
+
* @maxLength 100
|
|
200
|
+
*/
|
|
166
201
|
number?: string;
|
|
167
|
-
/**
|
|
202
|
+
/**
|
|
203
|
+
* Street name.
|
|
204
|
+
* @maxLength 250
|
|
205
|
+
*/
|
|
168
206
|
name?: string;
|
|
169
207
|
}
|
|
170
208
|
export interface CommonAddressLocation {
|
|
171
|
-
/**
|
|
209
|
+
/**
|
|
210
|
+
* Address latitude coordinates.
|
|
211
|
+
* @min -90
|
|
212
|
+
* @max 90
|
|
213
|
+
*/
|
|
172
214
|
latitude?: number | null;
|
|
173
|
-
/**
|
|
215
|
+
/**
|
|
216
|
+
* Address longitude coordinates.
|
|
217
|
+
* @min -180
|
|
218
|
+
* @max 180
|
|
219
|
+
*/
|
|
174
220
|
longitude?: number | null;
|
|
175
221
|
}
|
|
176
222
|
export interface CommonSubdivision {
|
|
177
|
-
/**
|
|
223
|
+
/**
|
|
224
|
+
* Short subdivision code.
|
|
225
|
+
* @maxLength 100
|
|
226
|
+
*/
|
|
178
227
|
code?: string;
|
|
179
|
-
/**
|
|
228
|
+
/**
|
|
229
|
+
* Subdivision full name.
|
|
230
|
+
* @maxLength 250
|
|
231
|
+
*/
|
|
180
232
|
name?: string;
|
|
181
233
|
}
|
|
182
234
|
export declare enum SubdivisionSubdivisionType {
|
|
@@ -197,13 +249,19 @@ export declare enum SubdivisionSubdivisionType {
|
|
|
197
249
|
export interface DateAndTimeSettings {
|
|
198
250
|
/** Whether the event date and time are TBD. */
|
|
199
251
|
dateAndTimeTbd?: boolean | null;
|
|
200
|
-
/**
|
|
252
|
+
/**
|
|
253
|
+
* Message that is displayed when time and date is TBD.
|
|
254
|
+
* @maxLength 100
|
|
255
|
+
*/
|
|
201
256
|
dateAndTimeTbdMessage?: string | null;
|
|
202
257
|
/** Event start date. */
|
|
203
258
|
startDate?: Date | null;
|
|
204
259
|
/** Event end date. */
|
|
205
260
|
endDate?: Date | null;
|
|
206
|
-
/**
|
|
261
|
+
/**
|
|
262
|
+
* Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
|
|
263
|
+
* @maxLength 100
|
|
264
|
+
*/
|
|
207
265
|
timeZoneId?: string | null;
|
|
208
266
|
/** Whether the end date is hidden in the formatted date and time. */
|
|
209
267
|
hideEndDate?: boolean | null;
|
|
@@ -234,11 +292,15 @@ export declare enum RecurrenceStatusStatus {
|
|
|
234
292
|
RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
|
|
235
293
|
}
|
|
236
294
|
export interface Recurrences {
|
|
237
|
-
/**
|
|
295
|
+
/**
|
|
296
|
+
* Individual event dates.
|
|
297
|
+
* @maxSize 1000
|
|
298
|
+
*/
|
|
238
299
|
individualEventDates?: Occurrence[];
|
|
239
300
|
/**
|
|
240
301
|
* Recurring event category ID.
|
|
241
302
|
* @readonly
|
|
303
|
+
* @maxLength 100
|
|
242
304
|
*/
|
|
243
305
|
categoryId?: string | null;
|
|
244
306
|
}
|
|
@@ -247,7 +309,10 @@ export interface Occurrence {
|
|
|
247
309
|
startDate?: Date | null;
|
|
248
310
|
/** Event end date. */
|
|
249
311
|
endDate?: Date | null;
|
|
250
|
-
/**
|
|
312
|
+
/**
|
|
313
|
+
* Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
|
|
314
|
+
* @maxLength 100
|
|
315
|
+
*/
|
|
251
316
|
timeZoneId?: string | null;
|
|
252
317
|
/** Whether the time zone is displayed in a formatted schedule. */
|
|
253
318
|
showTimeZone?: boolean;
|
|
@@ -258,26 +323,31 @@ export interface Formatted {
|
|
|
258
323
|
* 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>
|
|
259
324
|
* 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`.
|
|
260
325
|
* @readonly
|
|
326
|
+
* @maxLength 500
|
|
261
327
|
*/
|
|
262
328
|
dateAndTime?: string | null;
|
|
263
329
|
/**
|
|
264
330
|
* Formatted start date of the event. Empty for TBD schedules.
|
|
265
331
|
* @readonly
|
|
332
|
+
* @maxLength 500
|
|
266
333
|
*/
|
|
267
334
|
startDate?: string | null;
|
|
268
335
|
/**
|
|
269
336
|
* Formatted start time of the event. Empty for TBD schedules.
|
|
270
337
|
* @readonly
|
|
338
|
+
* @maxLength 500
|
|
271
339
|
*/
|
|
272
340
|
startTime?: string | null;
|
|
273
341
|
/**
|
|
274
342
|
* Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.
|
|
275
343
|
* @readonly
|
|
344
|
+
* @maxLength 500
|
|
276
345
|
*/
|
|
277
346
|
endDate?: string | null;
|
|
278
347
|
/**
|
|
279
348
|
* Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.
|
|
280
349
|
* @readonly
|
|
350
|
+
* @maxLength 500
|
|
281
351
|
*/
|
|
282
352
|
endTime?: string | null;
|
|
283
353
|
}
|
|
@@ -288,9 +358,15 @@ export interface Formatted {
|
|
|
288
358
|
export interface TimeDuration {
|
|
289
359
|
/** Number of days. */
|
|
290
360
|
days?: number;
|
|
291
|
-
/**
|
|
361
|
+
/**
|
|
362
|
+
* Number of hours.
|
|
363
|
+
* @max 24
|
|
364
|
+
*/
|
|
292
365
|
hours?: number;
|
|
293
|
-
/**
|
|
366
|
+
/**
|
|
367
|
+
* Number of minutes.
|
|
368
|
+
* @max 60
|
|
369
|
+
*/
|
|
294
370
|
minutes?: number;
|
|
295
371
|
}
|
|
296
372
|
export declare enum Status {
|
|
@@ -308,9 +384,15 @@ export declare enum Status {
|
|
|
308
384
|
DRAFT = "DRAFT"
|
|
309
385
|
}
|
|
310
386
|
export interface PageUrl {
|
|
311
|
-
/**
|
|
387
|
+
/**
|
|
388
|
+
* The base URL. For premium sites, the base is the domain. For free sites, the base is the Wix site URL (for example, `https://mysite.wixsite.com/mysite`).
|
|
389
|
+
* @maxLength 500
|
|
390
|
+
*/
|
|
312
391
|
base?: string;
|
|
313
|
-
/**
|
|
392
|
+
/**
|
|
393
|
+
* The path to the page. For example, `/product-page/a-product`.
|
|
394
|
+
* @maxLength 500
|
|
395
|
+
*/
|
|
314
396
|
path?: string;
|
|
315
397
|
}
|
|
316
398
|
export interface Registration {
|
|
@@ -332,7 +414,10 @@ export interface Registration {
|
|
|
332
414
|
external?: ExternalRegistration;
|
|
333
415
|
/** Types of guests allowed to register. */
|
|
334
416
|
allowedGuestTypes?: GuestTypeType;
|
|
335
|
-
/**
|
|
417
|
+
/**
|
|
418
|
+
* Initial event type which is set when creating an event.
|
|
419
|
+
* @immutable
|
|
420
|
+
*/
|
|
336
421
|
initialType?: InitialRegistrationTypeType;
|
|
337
422
|
/** Whether the registration is paused. */
|
|
338
423
|
registrationPaused?: boolean;
|
|
@@ -395,6 +480,7 @@ export interface TicketsRegistration {
|
|
|
395
480
|
/**
|
|
396
481
|
* Ticket limit per order. <br>
|
|
397
482
|
* Default: 20 tickets.
|
|
483
|
+
* @max 50
|
|
398
484
|
*/
|
|
399
485
|
ticketLimitPerOrder?: number;
|
|
400
486
|
/** Ticket price currency. */
|
|
@@ -422,9 +508,15 @@ export interface TicketsRegistration {
|
|
|
422
508
|
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
423
509
|
*/
|
|
424
510
|
export interface Money {
|
|
425
|
-
/**
|
|
511
|
+
/**
|
|
512
|
+
* Amount of money in decimal form. A period is used as a decimal separator (for example, `3.99`).
|
|
513
|
+
* @format DECIMAL_VALUE
|
|
514
|
+
*/
|
|
426
515
|
value?: string;
|
|
427
|
-
/**
|
|
516
|
+
/**
|
|
517
|
+
* Currency code in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
518
|
+
* @format CURRENCY
|
|
519
|
+
*/
|
|
428
520
|
currency?: string;
|
|
429
521
|
/**
|
|
430
522
|
* Amount of money in decimal form. A period or comma are used as a decimal separator (for example, `1 000,30`).
|
|
@@ -435,9 +527,16 @@ export interface Money {
|
|
|
435
527
|
export interface TaxSettings {
|
|
436
528
|
/** Tax application settings. */
|
|
437
529
|
type?: TaxType;
|
|
438
|
-
/**
|
|
530
|
+
/**
|
|
531
|
+
* Tax name.
|
|
532
|
+
* @minLength 1
|
|
533
|
+
* @maxLength 10
|
|
534
|
+
*/
|
|
439
535
|
name?: string | null;
|
|
440
|
-
/**
|
|
536
|
+
/**
|
|
537
|
+
* Tax rate (for example,`21.55`).
|
|
538
|
+
* @decimalValue options - {gte:0.001,lte:100,maxScale:3}
|
|
539
|
+
*/
|
|
441
540
|
rate?: string | null;
|
|
442
541
|
/** Apply tax to donations. */
|
|
443
542
|
appliedToDonations?: boolean | null;
|
|
@@ -452,7 +551,10 @@ export declare enum TaxType {
|
|
|
452
551
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
453
552
|
}
|
|
454
553
|
export interface ExternalRegistration {
|
|
455
|
-
/**
|
|
554
|
+
/**
|
|
555
|
+
* External event registration URL.
|
|
556
|
+
* @format WEB_URL
|
|
557
|
+
*/
|
|
456
558
|
url?: string | null;
|
|
457
559
|
}
|
|
458
560
|
export declare enum GuestTypeType {
|
|
@@ -472,7 +574,11 @@ export declare enum InitialRegistrationTypeType {
|
|
|
472
574
|
TICKETING = "TICKETING"
|
|
473
575
|
}
|
|
474
576
|
export interface CommonImage {
|
|
475
|
-
/**
|
|
577
|
+
/**
|
|
578
|
+
* WixMedia image ID.
|
|
579
|
+
* @minLength 1
|
|
580
|
+
* @maxLength 200
|
|
581
|
+
*/
|
|
476
582
|
id?: string;
|
|
477
583
|
/** Image URL. */
|
|
478
584
|
url?: string;
|
|
@@ -627,21 +733,29 @@ export declare enum ValueType {
|
|
|
627
733
|
* Defaults to first (0th) option if not configured.
|
|
628
734
|
*/
|
|
629
735
|
export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
630
|
-
/**
|
|
736
|
+
/**
|
|
737
|
+
* 0-based index from predefined `input.options` which is selected initially.
|
|
738
|
+
* @max 199
|
|
739
|
+
*/
|
|
631
740
|
optionIndex?: number;
|
|
632
741
|
/**
|
|
633
742
|
* Placeholder hint describing expected choices (such as "Please select").
|
|
634
743
|
* Considered an empty choice.
|
|
744
|
+
* @maxLength 200
|
|
635
745
|
*/
|
|
636
746
|
placeholderText?: string;
|
|
637
747
|
}
|
|
638
748
|
/** @oneof */
|
|
639
749
|
export interface OptionSelectionSelectedOptionOneOf {
|
|
640
|
-
/**
|
|
750
|
+
/**
|
|
751
|
+
* 0-based index from predefined `input.options` which is selected initially.
|
|
752
|
+
* @max 199
|
|
753
|
+
*/
|
|
641
754
|
optionIndex?: number;
|
|
642
755
|
/**
|
|
643
756
|
* Placeholder hint describing expected choices (such as "Please select").
|
|
644
757
|
* Considered an empty choice.
|
|
758
|
+
* @maxLength 200
|
|
645
759
|
*/
|
|
646
760
|
placeholderText?: string;
|
|
647
761
|
}
|
|
@@ -753,12 +867,19 @@ export interface Summaries {
|
|
|
753
867
|
export interface EventsMoney {
|
|
754
868
|
/**
|
|
755
869
|
* *Deprecated:** Use `value` instead.
|
|
870
|
+
* @format DECIMAL_VALUE
|
|
756
871
|
* @deprecated
|
|
757
872
|
*/
|
|
758
873
|
amount?: string;
|
|
759
|
-
/**
|
|
874
|
+
/**
|
|
875
|
+
* ISO 4217 format of the currency e.g., `USD`.
|
|
876
|
+
* @format CURRENCY
|
|
877
|
+
*/
|
|
760
878
|
currency?: string;
|
|
761
|
-
/**
|
|
879
|
+
/**
|
|
880
|
+
* 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.
|
|
881
|
+
* @format DECIMAL_VALUE
|
|
882
|
+
*/
|
|
762
883
|
value?: string | null;
|
|
763
884
|
}
|
|
764
885
|
export interface Rsvps {
|
|
@@ -821,7 +942,10 @@ export interface Feed {
|
|
|
821
942
|
export interface OnlineConferencing {
|
|
822
943
|
/** 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. */
|
|
823
944
|
enabled?: boolean;
|
|
824
|
-
/**
|
|
945
|
+
/**
|
|
946
|
+
* Conference host ID.
|
|
947
|
+
* @format GUID
|
|
948
|
+
*/
|
|
825
949
|
providerId?: string | null;
|
|
826
950
|
/** Conference type. */
|
|
827
951
|
type?: ConferenceTypeType;
|
|
@@ -864,7 +988,10 @@ export interface OnlineConferencingSession {
|
|
|
864
988
|
sessionId?: string | null;
|
|
865
989
|
}
|
|
866
990
|
export interface SeoSettings {
|
|
867
|
-
/**
|
|
991
|
+
/**
|
|
992
|
+
* URL slug.
|
|
993
|
+
* @maxLength 130
|
|
994
|
+
*/
|
|
868
995
|
slug?: string;
|
|
869
996
|
/** Advanced SEO data. */
|
|
870
997
|
advancedSeoData?: SeoSchema;
|
|
@@ -890,7 +1017,10 @@ export interface Keyword {
|
|
|
890
1017
|
term?: string;
|
|
891
1018
|
/** Whether the keyword is the main focus keyword. */
|
|
892
1019
|
isMain?: boolean;
|
|
893
|
-
/**
|
|
1020
|
+
/**
|
|
1021
|
+
* The source that added the keyword terms to the SEO settings.
|
|
1022
|
+
* @maxLength 1000
|
|
1023
|
+
*/
|
|
894
1024
|
origin?: string | null;
|
|
895
1025
|
}
|
|
896
1026
|
export interface Tag {
|
|
@@ -923,7 +1053,10 @@ export interface Settings {
|
|
|
923
1053
|
* Default: `false` (Auto Redirect is enabled.)
|
|
924
1054
|
*/
|
|
925
1055
|
preventAutoRedirect?: boolean;
|
|
926
|
-
/**
|
|
1056
|
+
/**
|
|
1057
|
+
* User-selected keyword terms for a specific page.
|
|
1058
|
+
* @maxSize 5
|
|
1059
|
+
*/
|
|
927
1060
|
keywords?: Keyword[];
|
|
928
1061
|
}
|
|
929
1062
|
export interface AgendaSettings {
|
|
@@ -936,16 +1069,24 @@ export interface AgendaSettings {
|
|
|
936
1069
|
pageUrl?: PageUrl;
|
|
937
1070
|
}
|
|
938
1071
|
export interface EventCategories {
|
|
939
|
-
/**
|
|
1072
|
+
/**
|
|
1073
|
+
* Event categories.
|
|
1074
|
+
* @maxSize 10
|
|
1075
|
+
*/
|
|
940
1076
|
categories?: EventCategory[];
|
|
941
1077
|
}
|
|
942
1078
|
export interface EventCategory {
|
|
943
1079
|
/**
|
|
944
1080
|
* Category ID.
|
|
1081
|
+
* @format GUID
|
|
945
1082
|
* @readonly
|
|
946
1083
|
*/
|
|
947
1084
|
id?: string;
|
|
948
|
-
/**
|
|
1085
|
+
/**
|
|
1086
|
+
* Category name.
|
|
1087
|
+
* @minLength 1
|
|
1088
|
+
* @maxLength 30
|
|
1089
|
+
*/
|
|
949
1090
|
name?: string;
|
|
950
1091
|
/**
|
|
951
1092
|
* Category creation timestamp.
|
|
@@ -1575,11 +1716,20 @@ export interface GIFData {
|
|
|
1575
1716
|
gifType?: GIFType;
|
|
1576
1717
|
}
|
|
1577
1718
|
export interface GIF {
|
|
1578
|
-
/**
|
|
1719
|
+
/**
|
|
1720
|
+
* GIF format URL.
|
|
1721
|
+
* @format WEB_URL
|
|
1722
|
+
*/
|
|
1579
1723
|
gif?: string | null;
|
|
1580
|
-
/**
|
|
1724
|
+
/**
|
|
1725
|
+
* MP4 format URL.
|
|
1726
|
+
* @format WEB_URL
|
|
1727
|
+
*/
|
|
1581
1728
|
mp4?: string | null;
|
|
1582
|
-
/**
|
|
1729
|
+
/**
|
|
1730
|
+
* Thumbnail URL.
|
|
1731
|
+
* @format WEB_URL
|
|
1732
|
+
*/
|
|
1583
1733
|
still?: string | null;
|
|
1584
1734
|
}
|
|
1585
1735
|
export declare enum GIFType {
|
|
@@ -1807,13 +1957,22 @@ export declare enum BackgroundType {
|
|
|
1807
1957
|
export interface Gradient {
|
|
1808
1958
|
/** The gradient angle in degrees. */
|
|
1809
1959
|
angle?: number | null;
|
|
1810
|
-
/**
|
|
1960
|
+
/**
|
|
1961
|
+
* The start color as a hexademical value.
|
|
1962
|
+
* @format COLOR_HEX
|
|
1963
|
+
*/
|
|
1811
1964
|
startColor?: string | null;
|
|
1812
|
-
/**
|
|
1965
|
+
/**
|
|
1966
|
+
* The end color as a hexademical value.
|
|
1967
|
+
* @format COLOR_HEX
|
|
1968
|
+
*/
|
|
1813
1969
|
lastColor?: string | null;
|
|
1814
1970
|
}
|
|
1815
1971
|
export interface Background extends BackgroundBackgroundOneOf {
|
|
1816
|
-
/**
|
|
1972
|
+
/**
|
|
1973
|
+
* The background color as a hexademical value.
|
|
1974
|
+
* @format COLOR_HEX
|
|
1975
|
+
*/
|
|
1817
1976
|
color?: string | null;
|
|
1818
1977
|
/** An image to use for the background. */
|
|
1819
1978
|
image?: Media;
|
|
@@ -1824,7 +1983,10 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1824
1983
|
}
|
|
1825
1984
|
/** @oneof */
|
|
1826
1985
|
export interface BackgroundBackgroundOneOf {
|
|
1827
|
-
/**
|
|
1986
|
+
/**
|
|
1987
|
+
* The background color as a hexademical value.
|
|
1988
|
+
* @format COLOR_HEX
|
|
1989
|
+
*/
|
|
1828
1990
|
color?: string | null;
|
|
1829
1991
|
/** An image to use for the background. */
|
|
1830
1992
|
image?: Media;
|
|
@@ -2136,17 +2298,32 @@ export declare enum VerticalAlignment {
|
|
|
2136
2298
|
export interface CellStyle {
|
|
2137
2299
|
/** Vertical alignment for the cell's text. */
|
|
2138
2300
|
verticalAlignment?: VerticalAlignment;
|
|
2139
|
-
/**
|
|
2301
|
+
/**
|
|
2302
|
+
* Cell background color as a hexadecimal value.
|
|
2303
|
+
* @format COLOR_HEX
|
|
2304
|
+
*/
|
|
2140
2305
|
backgroundColor?: string | null;
|
|
2141
2306
|
}
|
|
2142
2307
|
export interface BorderColors {
|
|
2143
|
-
/**
|
|
2308
|
+
/**
|
|
2309
|
+
* Left border color as a hexadecimal value.
|
|
2310
|
+
* @format COLOR_HEX
|
|
2311
|
+
*/
|
|
2144
2312
|
left?: string | null;
|
|
2145
|
-
/**
|
|
2313
|
+
/**
|
|
2314
|
+
* Right border color as a hexadecimal value.
|
|
2315
|
+
* @format COLOR_HEX
|
|
2316
|
+
*/
|
|
2146
2317
|
right?: string | null;
|
|
2147
|
-
/**
|
|
2318
|
+
/**
|
|
2319
|
+
* Top border color as a hexadecimal value.
|
|
2320
|
+
* @format COLOR_HEX
|
|
2321
|
+
*/
|
|
2148
2322
|
top?: string | null;
|
|
2149
|
-
/**
|
|
2323
|
+
/**
|
|
2324
|
+
* Bottom border color as a hexadecimal value.
|
|
2325
|
+
* @format COLOR_HEX
|
|
2326
|
+
*/
|
|
2150
2327
|
bottom?: string | null;
|
|
2151
2328
|
}
|
|
2152
2329
|
/**
|
|
@@ -2257,27 +2434,43 @@ export interface TextNodeStyle {
|
|
|
2257
2434
|
export interface EventEventStarted {
|
|
2258
2435
|
/** Event schedule configuration. */
|
|
2259
2436
|
timestamp?: Date | null;
|
|
2260
|
-
/**
|
|
2437
|
+
/**
|
|
2438
|
+
* Event ID.
|
|
2439
|
+
* @format GUID
|
|
2440
|
+
*/
|
|
2261
2441
|
eventId?: string;
|
|
2262
2442
|
}
|
|
2263
2443
|
export interface EventEventEnded {
|
|
2264
2444
|
/** Event end timestamp in ISO UTC format. */
|
|
2265
2445
|
timestamp?: Date | null;
|
|
2266
|
-
/**
|
|
2446
|
+
/**
|
|
2447
|
+
* Event ID.
|
|
2448
|
+
* @format GUID
|
|
2449
|
+
*/
|
|
2267
2450
|
eventId?: string;
|
|
2268
2451
|
}
|
|
2269
2452
|
export interface EventEventReminder {
|
|
2270
2453
|
/** Reminder timestamp in ISO UTC format. */
|
|
2271
2454
|
timestamp?: Date | null;
|
|
2272
|
-
/**
|
|
2455
|
+
/**
|
|
2456
|
+
* Event ID.
|
|
2457
|
+
* @format GUID
|
|
2458
|
+
*/
|
|
2273
2459
|
eventId?: string;
|
|
2274
2460
|
/** Event location. */
|
|
2275
2461
|
location?: Location;
|
|
2276
2462
|
/** Event schedule configuration. */
|
|
2277
2463
|
dateAndTimeSettings?: DateAndTimeSettings;
|
|
2278
|
-
/**
|
|
2464
|
+
/**
|
|
2465
|
+
* Event title.
|
|
2466
|
+
* @minLength 1
|
|
2467
|
+
* @maxLength 120
|
|
2468
|
+
*/
|
|
2279
2469
|
title?: string;
|
|
2280
|
-
/**
|
|
2470
|
+
/**
|
|
2471
|
+
* ID of the user who created the event.
|
|
2472
|
+
* @format GUID
|
|
2473
|
+
*/
|
|
2281
2474
|
userId?: string | null;
|
|
2282
2475
|
/** Time until the start of event (currently, reminder letter is triggered 1 day before the start of event). */
|
|
2283
2476
|
startsIn?: TimeDuration;
|
|
@@ -2285,18 +2478,29 @@ export interface EventEventReminder {
|
|
|
2285
2478
|
export interface EventEventPublished {
|
|
2286
2479
|
/** Event publishing timestamp in ISO UTC format. */
|
|
2287
2480
|
timestamp?: Date | null;
|
|
2288
|
-
/**
|
|
2481
|
+
/**
|
|
2482
|
+
* Event ID.
|
|
2483
|
+
* @format GUID
|
|
2484
|
+
*/
|
|
2289
2485
|
eventId?: string;
|
|
2290
2486
|
/** Event status. */
|
|
2291
2487
|
status?: Status;
|
|
2292
2488
|
/**
|
|
2293
2489
|
* Event ID. Indicates the original event from which the current event was derived from.
|
|
2294
2490
|
* Can be used to track the original event and add missing information.
|
|
2491
|
+
* @format GUID
|
|
2295
2492
|
*/
|
|
2296
2493
|
derivedFromEventId?: string | null;
|
|
2297
|
-
/**
|
|
2494
|
+
/**
|
|
2495
|
+
* Event title.
|
|
2496
|
+
* @minLength 1
|
|
2497
|
+
* @maxLength 120
|
|
2498
|
+
*/
|
|
2298
2499
|
title?: string | null;
|
|
2299
|
-
/**
|
|
2500
|
+
/**
|
|
2501
|
+
* Short description that appears under the event title.
|
|
2502
|
+
* @maxLength 500
|
|
2503
|
+
*/
|
|
2300
2504
|
shortDescription?: string | null;
|
|
2301
2505
|
/** Event location. */
|
|
2302
2506
|
location?: Location;
|
|
@@ -2310,21 +2514,37 @@ export interface EventEventPublished {
|
|
|
2310
2514
|
export interface EventCloned {
|
|
2311
2515
|
/** Event creation timestamp in ISO UTC format. */
|
|
2312
2516
|
timestamp?: Date | null;
|
|
2313
|
-
/**
|
|
2517
|
+
/**
|
|
2518
|
+
* Event ID.
|
|
2519
|
+
* @format GUID
|
|
2520
|
+
*/
|
|
2314
2521
|
eventId?: string;
|
|
2315
2522
|
/** Event location. */
|
|
2316
2523
|
location?: Location;
|
|
2317
2524
|
/** Event date and time settings. */
|
|
2318
2525
|
dateAndTimeSettings?: DateAndTimeSettings;
|
|
2319
|
-
/**
|
|
2526
|
+
/**
|
|
2527
|
+
* Event title.
|
|
2528
|
+
* @minLength 1
|
|
2529
|
+
* @maxLength 120
|
|
2530
|
+
*/
|
|
2320
2531
|
title?: string;
|
|
2321
|
-
/**
|
|
2532
|
+
/**
|
|
2533
|
+
* ID of the user who created the event.
|
|
2534
|
+
* @format GUID
|
|
2535
|
+
*/
|
|
2322
2536
|
userId?: string | null;
|
|
2323
2537
|
/** Event status. */
|
|
2324
2538
|
status?: Status;
|
|
2325
|
-
/**
|
|
2539
|
+
/**
|
|
2540
|
+
* Instance ID. Indicates the original app instance from which current event was derived from.
|
|
2541
|
+
* @format GUID
|
|
2542
|
+
*/
|
|
2326
2543
|
derivedFromInstanceId?: string | null;
|
|
2327
|
-
/**
|
|
2544
|
+
/**
|
|
2545
|
+
* Event ID. Indicates the original event from which current event was derived from.
|
|
2546
|
+
* @format GUID
|
|
2547
|
+
*/
|
|
2328
2548
|
derivedFromEventId?: string | null;
|
|
2329
2549
|
/**
|
|
2330
2550
|
* Map of copied ticket definitions from the original event. <br>
|
|
@@ -2336,11 +2556,21 @@ export interface EventCloned {
|
|
|
2336
2556
|
export interface EventEventCanceled {
|
|
2337
2557
|
/** Event cancelation timestamp in ISO UTC format. */
|
|
2338
2558
|
timestamp?: Date | null;
|
|
2339
|
-
/**
|
|
2559
|
+
/**
|
|
2560
|
+
* Event ID.
|
|
2561
|
+
* @format GUID
|
|
2562
|
+
*/
|
|
2340
2563
|
eventId?: string;
|
|
2341
|
-
/**
|
|
2564
|
+
/**
|
|
2565
|
+
* Event title.
|
|
2566
|
+
* @minLength 1
|
|
2567
|
+
* @maxLength 120
|
|
2568
|
+
*/
|
|
2342
2569
|
title?: string;
|
|
2343
|
-
/**
|
|
2570
|
+
/**
|
|
2571
|
+
* ID of the user who created the event.
|
|
2572
|
+
* @format GUID
|
|
2573
|
+
*/
|
|
2344
2574
|
userId?: string | null;
|
|
2345
2575
|
}
|
|
2346
2576
|
export interface CreateEventRequest {
|
|
@@ -2348,7 +2578,10 @@ export interface CreateEventRequest {
|
|
|
2348
2578
|
event: V3Event;
|
|
2349
2579
|
/** Whether to create the event as a draft. */
|
|
2350
2580
|
draft?: boolean;
|
|
2351
|
-
/**
|
|
2581
|
+
/**
|
|
2582
|
+
* Predefined sets of fields to return.
|
|
2583
|
+
* @maxSize 20
|
|
2584
|
+
*/
|
|
2352
2585
|
fields?: RequestedFields[];
|
|
2353
2586
|
}
|
|
2354
2587
|
export declare enum RequestedFields {
|
|
@@ -2382,13 +2615,19 @@ export interface CreateEventResponse {
|
|
|
2382
2615
|
event?: V3Event;
|
|
2383
2616
|
}
|
|
2384
2617
|
export interface CloneEventRequest {
|
|
2385
|
-
/**
|
|
2618
|
+
/**
|
|
2619
|
+
* Event ID.
|
|
2620
|
+
* @format GUID
|
|
2621
|
+
*/
|
|
2386
2622
|
eventId: string;
|
|
2387
2623
|
/** Field values to be changed when cloning the event. */
|
|
2388
2624
|
event?: V3Event;
|
|
2389
2625
|
/** Whether to clone the event as a draft. */
|
|
2390
2626
|
draft?: boolean;
|
|
2391
|
-
/**
|
|
2627
|
+
/**
|
|
2628
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
2629
|
+
* @maxSize 20
|
|
2630
|
+
*/
|
|
2392
2631
|
fields?: RequestedFields[];
|
|
2393
2632
|
}
|
|
2394
2633
|
export interface CloneEventResponse {
|
|
@@ -2398,7 +2637,10 @@ export interface CloneEventResponse {
|
|
|
2398
2637
|
export interface UpdateEventRequest {
|
|
2399
2638
|
/** Field values to be changed. */
|
|
2400
2639
|
event?: V3Event;
|
|
2401
|
-
/**
|
|
2640
|
+
/**
|
|
2641
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
2642
|
+
* @maxSize 20
|
|
2643
|
+
*/
|
|
2402
2644
|
fields?: RequestedFields[];
|
|
2403
2645
|
}
|
|
2404
2646
|
export interface UpdateEventResponse {
|
|
@@ -2406,9 +2648,15 @@ export interface UpdateEventResponse {
|
|
|
2406
2648
|
event?: V3Event;
|
|
2407
2649
|
}
|
|
2408
2650
|
export interface PublishDraftEventRequest {
|
|
2409
|
-
/**
|
|
2651
|
+
/**
|
|
2652
|
+
* Event ID.
|
|
2653
|
+
* @format GUID
|
|
2654
|
+
*/
|
|
2410
2655
|
eventId: string;
|
|
2411
|
-
/**
|
|
2656
|
+
/**
|
|
2657
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
2658
|
+
* @maxSize 20
|
|
2659
|
+
*/
|
|
2412
2660
|
fields?: RequestedFields[];
|
|
2413
2661
|
}
|
|
2414
2662
|
export interface PublishDraftEventResponse {
|
|
@@ -2416,9 +2664,15 @@ export interface PublishDraftEventResponse {
|
|
|
2416
2664
|
event?: V3Event;
|
|
2417
2665
|
}
|
|
2418
2666
|
export interface CancelEventRequest {
|
|
2419
|
-
/**
|
|
2667
|
+
/**
|
|
2668
|
+
* Event ID.
|
|
2669
|
+
* @format GUID
|
|
2670
|
+
*/
|
|
2420
2671
|
eventId: string;
|
|
2421
|
-
/**
|
|
2672
|
+
/**
|
|
2673
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
2674
|
+
* @maxSize 20
|
|
2675
|
+
*/
|
|
2422
2676
|
fields?: RequestedFields[];
|
|
2423
2677
|
}
|
|
2424
2678
|
export interface CancelEventResponse {
|
|
@@ -2443,6 +2697,7 @@ export interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
|
|
|
2443
2697
|
/**
|
|
2444
2698
|
* Sort object in the following format:
|
|
2445
2699
|
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
2700
|
+
* @maxSize 20
|
|
2446
2701
|
*/
|
|
2447
2702
|
sort?: CommonSorting[];
|
|
2448
2703
|
}
|
|
@@ -2452,7 +2707,10 @@ export interface CommonQueryV2PagingMethodOneOf {
|
|
|
2452
2707
|
paging?: CommonPaging;
|
|
2453
2708
|
}
|
|
2454
2709
|
export interface CommonSorting {
|
|
2455
|
-
/**
|
|
2710
|
+
/**
|
|
2711
|
+
* Name of the field to sort by.
|
|
2712
|
+
* @maxLength 100
|
|
2713
|
+
*/
|
|
2456
2714
|
fieldName?: string;
|
|
2457
2715
|
/**
|
|
2458
2716
|
* Sort order.
|
|
@@ -2467,7 +2725,10 @@ export declare enum CommonSortOrder {
|
|
|
2467
2725
|
DESC = "DESC"
|
|
2468
2726
|
}
|
|
2469
2727
|
export interface CommonPaging {
|
|
2470
|
-
/**
|
|
2728
|
+
/**
|
|
2729
|
+
* 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.
|
|
2730
|
+
* @max 1000
|
|
2731
|
+
*/
|
|
2471
2732
|
limit?: number | null;
|
|
2472
2733
|
/** Number of items to skip in the current sort order. */
|
|
2473
2734
|
offset?: number | null;
|
|
@@ -2475,11 +2736,17 @@ export interface CommonPaging {
|
|
|
2475
2736
|
export interface BulkCancelEventsByFilterResponse {
|
|
2476
2737
|
}
|
|
2477
2738
|
export interface DeleteEventRequest {
|
|
2478
|
-
/**
|
|
2739
|
+
/**
|
|
2740
|
+
* Event ID.
|
|
2741
|
+
* @format GUID
|
|
2742
|
+
*/
|
|
2479
2743
|
eventId: string;
|
|
2480
2744
|
}
|
|
2481
2745
|
export interface DeleteEventResponse {
|
|
2482
|
-
/**
|
|
2746
|
+
/**
|
|
2747
|
+
* Deleted event ID.
|
|
2748
|
+
* @format GUID
|
|
2749
|
+
*/
|
|
2483
2750
|
eventId?: string;
|
|
2484
2751
|
}
|
|
2485
2752
|
export interface BulkDeleteEventsByFilterRequest {
|
|
@@ -2491,7 +2758,10 @@ export interface BulkDeleteEventsByFilterResponse {
|
|
|
2491
2758
|
export interface QueryEventsRequest {
|
|
2492
2759
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
2493
2760
|
query?: CommonQueryV2;
|
|
2494
|
-
/**
|
|
2761
|
+
/**
|
|
2762
|
+
* Predefined sets of fields to return.
|
|
2763
|
+
* @maxSize 20
|
|
2764
|
+
*/
|
|
2495
2765
|
fields?: RequestedFields[];
|
|
2496
2766
|
/**
|
|
2497
2767
|
* Whether draft events should be returned in the response. <br>
|
|
@@ -2557,7 +2827,10 @@ export interface QueryV2PagingMethodOneOf {
|
|
|
2557
2827
|
cursorPaging?: CursorPaging;
|
|
2558
2828
|
}
|
|
2559
2829
|
export interface Sorting {
|
|
2560
|
-
/**
|
|
2830
|
+
/**
|
|
2831
|
+
* Name of the field to sort by.
|
|
2832
|
+
* @maxLength 512
|
|
2833
|
+
*/
|
|
2561
2834
|
fieldName?: string;
|
|
2562
2835
|
/** Sort order. */
|
|
2563
2836
|
order?: SortOrder;
|
|
@@ -2573,13 +2846,17 @@ export interface Paging {
|
|
|
2573
2846
|
offset?: number | null;
|
|
2574
2847
|
}
|
|
2575
2848
|
export interface CursorPaging {
|
|
2576
|
-
/**
|
|
2849
|
+
/**
|
|
2850
|
+
* Maximum number of items to return in the results.
|
|
2851
|
+
* @max 100
|
|
2852
|
+
*/
|
|
2577
2853
|
limit?: number | null;
|
|
2578
2854
|
/**
|
|
2579
2855
|
* Pointer to the next or previous page in the list of results.
|
|
2580
2856
|
*
|
|
2581
2857
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
2582
2858
|
* Not relevant for the first request.
|
|
2859
|
+
* @maxLength 16000
|
|
2583
2860
|
*/
|
|
2584
2861
|
cursor?: string | null;
|
|
2585
2862
|
}
|
|
@@ -2602,15 +2879,25 @@ export interface PagingMetadataV2 {
|
|
|
2602
2879
|
cursors?: Cursors;
|
|
2603
2880
|
}
|
|
2604
2881
|
export interface Cursors {
|
|
2605
|
-
/**
|
|
2882
|
+
/**
|
|
2883
|
+
* Cursor string pointing to the next page in the list of results.
|
|
2884
|
+
* @maxLength 16000
|
|
2885
|
+
*/
|
|
2606
2886
|
next?: string | null;
|
|
2607
|
-
/**
|
|
2887
|
+
/**
|
|
2888
|
+
* Cursor pointing to the previous page in the list of results.
|
|
2889
|
+
* @maxLength 16000
|
|
2890
|
+
*/
|
|
2608
2891
|
prev?: string | null;
|
|
2609
2892
|
}
|
|
2610
2893
|
export interface CountEventsByStatusRequest {
|
|
2611
2894
|
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
|
|
2612
2895
|
filter?: Record<string, any> | null;
|
|
2613
|
-
/**
|
|
2896
|
+
/**
|
|
2897
|
+
* Parameters to count events by.
|
|
2898
|
+
* @maxLength 100
|
|
2899
|
+
* @maxSize 20
|
|
2900
|
+
*/
|
|
2614
2901
|
facet?: string[];
|
|
2615
2902
|
/**
|
|
2616
2903
|
* Whether draft events should be returned in the response. <br>
|
|
@@ -2634,22 +2921,35 @@ export interface ListUserEventsRequest {
|
|
|
2634
2921
|
/**
|
|
2635
2922
|
* Sort order, defaults to `"created:asc"`.
|
|
2636
2923
|
* 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).
|
|
2924
|
+
* @maxSize 20
|
|
2637
2925
|
*/
|
|
2638
2926
|
sort?: CommonSorting[];
|
|
2639
|
-
/**
|
|
2927
|
+
/**
|
|
2928
|
+
* Event status.
|
|
2929
|
+
* @maxSize 20
|
|
2930
|
+
*/
|
|
2640
2931
|
status?: Status[];
|
|
2641
2932
|
/** Allows to filter events by user relation to the event among all wix sites. */
|
|
2642
2933
|
userFilter?: UserFilter;
|
|
2643
2934
|
/**
|
|
2644
2935
|
* Filter facets to include in the response.
|
|
2645
2936
|
* 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).
|
|
2937
|
+
* @maxLength 100
|
|
2938
|
+
* @maxSize 20
|
|
2646
2939
|
*/
|
|
2647
2940
|
facet?: string[];
|
|
2648
2941
|
}
|
|
2649
2942
|
export interface UserFilter {
|
|
2650
|
-
/**
|
|
2943
|
+
/**
|
|
2944
|
+
* User who is related to event
|
|
2945
|
+
* @format GUID
|
|
2946
|
+
*/
|
|
2651
2947
|
userId?: string;
|
|
2652
|
-
/**
|
|
2948
|
+
/**
|
|
2949
|
+
* Relation of user to event.
|
|
2950
|
+
* @minSize 1
|
|
2951
|
+
* @maxSize 20
|
|
2952
|
+
*/
|
|
2653
2953
|
relation?: Relation[];
|
|
2654
2954
|
}
|
|
2655
2955
|
export declare enum Relation {
|
|
@@ -2665,11 +2965,17 @@ export interface ListUserEventsResponse {
|
|
|
2665
2965
|
facets?: Record<string, FacetCounts>;
|
|
2666
2966
|
}
|
|
2667
2967
|
export interface ListEventsByCategoryRequest {
|
|
2668
|
-
/**
|
|
2968
|
+
/**
|
|
2969
|
+
* Category ID.
|
|
2970
|
+
* @format GUID
|
|
2971
|
+
*/
|
|
2669
2972
|
categoryId?: string;
|
|
2670
2973
|
/** Paging options to limit and skip the number of items. */
|
|
2671
2974
|
paging?: CommonPaging;
|
|
2672
|
-
/**
|
|
2975
|
+
/**
|
|
2976
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
2977
|
+
* @maxSize 20
|
|
2978
|
+
*/
|
|
2673
2979
|
fields?: RequestedFields[];
|
|
2674
2980
|
}
|
|
2675
2981
|
export interface ListEventsByCategoryResponse {
|
|
@@ -2679,9 +2985,15 @@ export interface ListEventsByCategoryResponse {
|
|
|
2679
2985
|
events?: V3Event[];
|
|
2680
2986
|
}
|
|
2681
2987
|
export interface GetEventRequest {
|
|
2682
|
-
/**
|
|
2988
|
+
/**
|
|
2989
|
+
* Event ID.
|
|
2990
|
+
* @format GUID
|
|
2991
|
+
*/
|
|
2683
2992
|
eventId: string | null;
|
|
2684
|
-
/**
|
|
2993
|
+
/**
|
|
2994
|
+
* Predefined sets of fields to return.
|
|
2995
|
+
* @maxSize 20
|
|
2996
|
+
*/
|
|
2685
2997
|
fields?: RequestedFields[];
|
|
2686
2998
|
}
|
|
2687
2999
|
export interface GetEventResponse {
|
|
@@ -2689,8 +3001,13 @@ export interface GetEventResponse {
|
|
|
2689
3001
|
event?: V3Event;
|
|
2690
3002
|
}
|
|
2691
3003
|
export interface GetEventBySlugRequest {
|
|
2692
|
-
/**
|
|
3004
|
+
/**
|
|
3005
|
+
* URL slug.
|
|
3006
|
+
* @minLength 1
|
|
3007
|
+
* @maxLength 130
|
|
3008
|
+
*/
|
|
2693
3009
|
slug: string | null;
|
|
3010
|
+
/** @maxSize 20 */
|
|
2694
3011
|
fields?: RequestedFields[];
|
|
2695
3012
|
}
|
|
2696
3013
|
export interface GetEventBySlugResponse {
|
|
@@ -2698,18 +3015,35 @@ export interface GetEventBySlugResponse {
|
|
|
2698
3015
|
event?: V3Event;
|
|
2699
3016
|
}
|
|
2700
3017
|
export interface FindEventRequest extends FindEventRequestFindByOneOf {
|
|
2701
|
-
/**
|
|
3018
|
+
/**
|
|
3019
|
+
* Event ID.
|
|
3020
|
+
* @format GUID
|
|
3021
|
+
*/
|
|
2702
3022
|
eventId?: string | null;
|
|
2703
|
-
/**
|
|
3023
|
+
/**
|
|
3024
|
+
* URL slug.
|
|
3025
|
+
* @minLength 1
|
|
3026
|
+
* @maxLength 130
|
|
3027
|
+
*/
|
|
2704
3028
|
slug?: string | null;
|
|
2705
|
-
/**
|
|
3029
|
+
/**
|
|
3030
|
+
* Predefined sets of fields to return.
|
|
3031
|
+
* @maxSize 20
|
|
3032
|
+
*/
|
|
2706
3033
|
fields?: RequestedFields[];
|
|
2707
3034
|
}
|
|
2708
3035
|
/** @oneof */
|
|
2709
3036
|
export interface FindEventRequestFindByOneOf {
|
|
2710
|
-
/**
|
|
3037
|
+
/**
|
|
3038
|
+
* Event ID.
|
|
3039
|
+
* @format GUID
|
|
3040
|
+
*/
|
|
2711
3041
|
eventId?: string | null;
|
|
2712
|
-
/**
|
|
3042
|
+
/**
|
|
3043
|
+
* URL slug.
|
|
3044
|
+
* @minLength 1
|
|
3045
|
+
* @maxLength 130
|
|
3046
|
+
*/
|
|
2713
3047
|
slug?: string | null;
|
|
2714
3048
|
}
|
|
2715
3049
|
export interface FindEventResponse {
|
|
@@ -2719,7 +3053,10 @@ export interface FindEventResponse {
|
|
|
2719
3053
|
export interface EventCreated {
|
|
2720
3054
|
/** Event created timestamp in ISO UTC format. */
|
|
2721
3055
|
timestamp?: Date | null;
|
|
2722
|
-
/**
|
|
3056
|
+
/**
|
|
3057
|
+
* Event ID.
|
|
3058
|
+
* @format GUID
|
|
3059
|
+
*/
|
|
2723
3060
|
eventId?: string;
|
|
2724
3061
|
/** Event location. */
|
|
2725
3062
|
location?: EventsLocation;
|
|
@@ -2727,23 +3064,38 @@ export interface EventCreated {
|
|
|
2727
3064
|
scheduleConfig?: ScheduleConfig;
|
|
2728
3065
|
/** Event title. */
|
|
2729
3066
|
title?: string;
|
|
2730
|
-
/**
|
|
3067
|
+
/**
|
|
3068
|
+
* Event creator user ID.
|
|
3069
|
+
* @maxLength 36
|
|
3070
|
+
*/
|
|
2731
3071
|
userId?: string | null;
|
|
2732
3072
|
/** Event status. */
|
|
2733
3073
|
status?: EventStatus;
|
|
2734
|
-
/**
|
|
3074
|
+
/**
|
|
3075
|
+
* Instance ID. Indicates the original app instance which current event was derived from.
|
|
3076
|
+
* @format GUID
|
|
3077
|
+
*/
|
|
2735
3078
|
derivedFromInstanceId?: string | null;
|
|
2736
|
-
/**
|
|
3079
|
+
/**
|
|
3080
|
+
* Event ID. Indicates the original event which current event was derived from.
|
|
3081
|
+
* @format GUID
|
|
3082
|
+
*/
|
|
2737
3083
|
derivedFromEventId?: string | null;
|
|
2738
3084
|
/** Event that was created. */
|
|
2739
3085
|
event?: Event;
|
|
2740
3086
|
}
|
|
2741
3087
|
export interface EventsLocation {
|
|
2742
|
-
/**
|
|
3088
|
+
/**
|
|
3089
|
+
* Location name.
|
|
3090
|
+
* @maxLength 50
|
|
3091
|
+
*/
|
|
2743
3092
|
name?: string | null;
|
|
2744
3093
|
/** Location map coordinates. */
|
|
2745
3094
|
coordinates?: MapCoordinates;
|
|
2746
|
-
/**
|
|
3095
|
+
/**
|
|
3096
|
+
* Single line address representation.
|
|
3097
|
+
* @maxLength 300
|
|
3098
|
+
*/
|
|
2747
3099
|
address?: string | null;
|
|
2748
3100
|
/** Location type. */
|
|
2749
3101
|
type?: LocationLocationType;
|
|
@@ -2765,9 +3117,17 @@ export interface EventsLocation {
|
|
|
2765
3117
|
tbd?: boolean | null;
|
|
2766
3118
|
}
|
|
2767
3119
|
export interface MapCoordinates {
|
|
2768
|
-
/**
|
|
3120
|
+
/**
|
|
3121
|
+
* Latitude.
|
|
3122
|
+
* @min -90
|
|
3123
|
+
* @max 90
|
|
3124
|
+
*/
|
|
2769
3125
|
lat?: number;
|
|
2770
|
-
/**
|
|
3126
|
+
/**
|
|
3127
|
+
* Longitude.
|
|
3128
|
+
* @min -180
|
|
3129
|
+
* @max 180
|
|
3130
|
+
*/
|
|
2771
3131
|
lng?: number;
|
|
2772
3132
|
}
|
|
2773
3133
|
export declare enum LocationLocationType {
|
|
@@ -2780,7 +3140,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
2780
3140
|
streetAddress?: StreetAddress;
|
|
2781
3141
|
/** Main address line (usually street and number) as free text */
|
|
2782
3142
|
addressLine?: string | null;
|
|
2783
|
-
/**
|
|
3143
|
+
/**
|
|
3144
|
+
* country code
|
|
3145
|
+
* @format COUNTRY
|
|
3146
|
+
*/
|
|
2784
3147
|
country?: string | null;
|
|
2785
3148
|
/** subdivision (usually state or region) code according to ISO 3166-2 */
|
|
2786
3149
|
subdivision?: string | null;
|
|
@@ -2798,7 +3161,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
2798
3161
|
geocode?: AddressLocation;
|
|
2799
3162
|
/** country full-name */
|
|
2800
3163
|
countryFullname?: string | null;
|
|
2801
|
-
/**
|
|
3164
|
+
/**
|
|
3165
|
+
* multi-level subdivisions from top to bottom
|
|
3166
|
+
* @maxSize 6
|
|
3167
|
+
*/
|
|
2802
3168
|
subdivisions?: Subdivision[];
|
|
2803
3169
|
}
|
|
2804
3170
|
/** @oneof */
|
|
@@ -2815,9 +3181,17 @@ export interface StreetAddress {
|
|
|
2815
3181
|
name?: string;
|
|
2816
3182
|
}
|
|
2817
3183
|
export interface AddressLocation {
|
|
2818
|
-
/**
|
|
3184
|
+
/**
|
|
3185
|
+
* address latitude coordinates
|
|
3186
|
+
* @min -90
|
|
3187
|
+
* @max 90
|
|
3188
|
+
*/
|
|
2819
3189
|
latitude?: number | null;
|
|
2820
|
-
/**
|
|
3190
|
+
/**
|
|
3191
|
+
* address longitude coordinates
|
|
3192
|
+
* @min -180
|
|
3193
|
+
* @max 180
|
|
3194
|
+
*/
|
|
2821
3195
|
longitude?: number | null;
|
|
2822
3196
|
}
|
|
2823
3197
|
export interface Subdivision {
|
|
@@ -2848,13 +3222,19 @@ export interface ScheduleConfig {
|
|
|
2848
3222
|
* `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
|
|
2849
3223
|
*/
|
|
2850
3224
|
scheduleTbd?: boolean;
|
|
2851
|
-
/**
|
|
3225
|
+
/**
|
|
3226
|
+
* TBD message.
|
|
3227
|
+
* @maxLength 100
|
|
3228
|
+
*/
|
|
2852
3229
|
scheduleTbdMessage?: string | null;
|
|
2853
3230
|
/** Event start timestamp. */
|
|
2854
3231
|
startDate?: Date | null;
|
|
2855
3232
|
/** Event end timestamp. */
|
|
2856
3233
|
endDate?: Date | null;
|
|
2857
|
-
/**
|
|
3234
|
+
/**
|
|
3235
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
3236
|
+
* @maxLength 100
|
|
3237
|
+
*/
|
|
2858
3238
|
timeZoneId?: string | null;
|
|
2859
3239
|
/** Whether end date is hidden in the formatted schedule. */
|
|
2860
3240
|
endDateHidden?: boolean;
|
|
@@ -2864,7 +3244,10 @@ export interface ScheduleConfig {
|
|
|
2864
3244
|
recurrences?: EventsRecurrences;
|
|
2865
3245
|
}
|
|
2866
3246
|
export interface EventsRecurrences {
|
|
2867
|
-
/**
|
|
3247
|
+
/**
|
|
3248
|
+
* Event occurrences.
|
|
3249
|
+
* @maxSize 1000
|
|
3250
|
+
*/
|
|
2868
3251
|
occurrences?: EventsOccurrence[];
|
|
2869
3252
|
/**
|
|
2870
3253
|
* Recurring event category ID.
|
|
@@ -2882,7 +3265,10 @@ export interface EventsOccurrence {
|
|
|
2882
3265
|
startDate?: Date | null;
|
|
2883
3266
|
/** Event end timestamp. */
|
|
2884
3267
|
endDate?: Date | null;
|
|
2885
|
-
/**
|
|
3268
|
+
/**
|
|
3269
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
3270
|
+
* @maxLength 100
|
|
3271
|
+
*/
|
|
2886
3272
|
timeZoneId?: string | null;
|
|
2887
3273
|
/** Whether time zone is displayed in formatted schedule. */
|
|
2888
3274
|
showTimeZone?: boolean;
|
|
@@ -2912,6 +3298,7 @@ export declare enum EventStatus {
|
|
|
2912
3298
|
export interface Event {
|
|
2913
3299
|
/**
|
|
2914
3300
|
* Event ID.
|
|
3301
|
+
* @format GUID
|
|
2915
3302
|
* @readonly
|
|
2916
3303
|
*/
|
|
2917
3304
|
id?: string;
|
|
@@ -2951,7 +3338,10 @@ export interface Event {
|
|
|
2951
3338
|
instanceId?: string;
|
|
2952
3339
|
/** Guest list configuration. */
|
|
2953
3340
|
guestListConfig?: GuestListConfig;
|
|
2954
|
-
/**
|
|
3341
|
+
/**
|
|
3342
|
+
* Event creator user ID.
|
|
3343
|
+
* @maxLength 36
|
|
3344
|
+
*/
|
|
2955
3345
|
userId?: string;
|
|
2956
3346
|
/** Event discussion feed. For internal use. */
|
|
2957
3347
|
feed?: EventsFeed;
|
|
@@ -2990,7 +3380,11 @@ export interface Scheduling {
|
|
|
2990
3380
|
endTimeFormatted?: string;
|
|
2991
3381
|
}
|
|
2992
3382
|
export interface Image {
|
|
2993
|
-
/**
|
|
3383
|
+
/**
|
|
3384
|
+
* WixMedia image ID.
|
|
3385
|
+
* @minLength 1
|
|
3386
|
+
* @maxLength 200
|
|
3387
|
+
*/
|
|
2994
3388
|
id?: string | null;
|
|
2995
3389
|
/** Image URL. */
|
|
2996
3390
|
url?: string;
|
|
@@ -3118,17 +3512,31 @@ export interface TicketingConfig {
|
|
|
3118
3512
|
guestAssignedTickets?: boolean;
|
|
3119
3513
|
/** Tax configuration. */
|
|
3120
3514
|
taxConfig?: TaxConfig;
|
|
3121
|
-
/**
|
|
3515
|
+
/**
|
|
3516
|
+
* Limit of tickets that can be purchased per order, default 20.
|
|
3517
|
+
* @max 50
|
|
3518
|
+
*/
|
|
3122
3519
|
ticketLimitPerOrder?: number;
|
|
3123
|
-
/**
|
|
3520
|
+
/**
|
|
3521
|
+
* Duration for which the tickets being bought are reserved.
|
|
3522
|
+
* @min 5
|
|
3523
|
+
* @max 30
|
|
3524
|
+
*/
|
|
3124
3525
|
reservationDurationInMinutes?: number | null;
|
|
3125
3526
|
}
|
|
3126
3527
|
export interface TaxConfig {
|
|
3127
3528
|
/** Tax application settings. */
|
|
3128
3529
|
type?: EventsTaxType;
|
|
3129
|
-
/**
|
|
3530
|
+
/**
|
|
3531
|
+
* Tax name.
|
|
3532
|
+
* @minLength 1
|
|
3533
|
+
* @maxLength 10
|
|
3534
|
+
*/
|
|
3130
3535
|
name?: string | null;
|
|
3131
|
-
/**
|
|
3536
|
+
/**
|
|
3537
|
+
* Tax rate (e.g.,`21.55`).
|
|
3538
|
+
* @decimalValue options - {gte:0.001,lte:100,maxScale:3}
|
|
3539
|
+
*/
|
|
3132
3540
|
rate?: string | null;
|
|
3133
3541
|
/** Applies taxes for donations, default true. */
|
|
3134
3542
|
appliesToDonations?: boolean | null;
|
|
@@ -3221,7 +3629,10 @@ export interface OnlineConferencingConfig {
|
|
|
3221
3629
|
* When enabled, links to join conferencing are generated and provided to guests.
|
|
3222
3630
|
*/
|
|
3223
3631
|
enabled?: boolean;
|
|
3224
|
-
/**
|
|
3632
|
+
/**
|
|
3633
|
+
* Conferencing provider ID.
|
|
3634
|
+
* @format GUID
|
|
3635
|
+
*/
|
|
3225
3636
|
providerId?: string | null;
|
|
3226
3637
|
/** Conference type */
|
|
3227
3638
|
conferenceType?: ConferenceType;
|
|
@@ -3260,7 +3671,10 @@ export interface EventsOnlineConferencingSession {
|
|
|
3260
3671
|
sessionId?: string | null;
|
|
3261
3672
|
}
|
|
3262
3673
|
export interface EventsSeoSettings {
|
|
3263
|
-
/**
|
|
3674
|
+
/**
|
|
3675
|
+
* URL slug
|
|
3676
|
+
* @maxLength 130
|
|
3677
|
+
*/
|
|
3264
3678
|
slug?: string;
|
|
3265
3679
|
/** Advanced SEO data */
|
|
3266
3680
|
advancedSeoData?: SeoSchema;
|
|
@@ -3282,10 +3696,15 @@ export interface Agenda {
|
|
|
3282
3696
|
export interface Category {
|
|
3283
3697
|
/**
|
|
3284
3698
|
* Category ID.
|
|
3699
|
+
* @format GUID
|
|
3285
3700
|
* @readonly
|
|
3286
3701
|
*/
|
|
3287
3702
|
id?: string;
|
|
3288
|
-
/**
|
|
3703
|
+
/**
|
|
3704
|
+
* Category name.
|
|
3705
|
+
* @minLength 1
|
|
3706
|
+
* @maxLength 30
|
|
3707
|
+
*/
|
|
3289
3708
|
name?: string;
|
|
3290
3709
|
/**
|
|
3291
3710
|
* Date and time when category was created.
|
|
@@ -3308,6 +3727,7 @@ export interface Category {
|
|
|
3308
3727
|
* Default: `MANUAL`.
|
|
3309
3728
|
*
|
|
3310
3729
|
* **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
|
|
3730
|
+
* @maxSize 3
|
|
3311
3731
|
*/
|
|
3312
3732
|
states?: State[];
|
|
3313
3733
|
}
|
|
@@ -3340,7 +3760,10 @@ export interface Empty {
|
|
|
3340
3760
|
export interface EventUpdated {
|
|
3341
3761
|
/** Event update timestamp in ISO UTC format. */
|
|
3342
3762
|
timestamp?: Date | null;
|
|
3343
|
-
/**
|
|
3763
|
+
/**
|
|
3764
|
+
* Event ID.
|
|
3765
|
+
* @format GUID
|
|
3766
|
+
*/
|
|
3344
3767
|
eventId?: string;
|
|
3345
3768
|
/** Event location. */
|
|
3346
3769
|
location?: EventsLocation;
|
|
@@ -3359,17 +3782,26 @@ export interface EventUpdated {
|
|
|
3359
3782
|
export interface EventDeleted {
|
|
3360
3783
|
/** Event deleted timestamp in ISO UTC format. */
|
|
3361
3784
|
timestamp?: Date | null;
|
|
3362
|
-
/**
|
|
3785
|
+
/**
|
|
3786
|
+
* Event ID.
|
|
3787
|
+
* @format GUID
|
|
3788
|
+
*/
|
|
3363
3789
|
eventId?: string;
|
|
3364
3790
|
/** Event title. */
|
|
3365
3791
|
title?: string;
|
|
3366
|
-
/**
|
|
3792
|
+
/**
|
|
3793
|
+
* Event creator user ID.
|
|
3794
|
+
* @format GUID
|
|
3795
|
+
*/
|
|
3367
3796
|
userId?: string | null;
|
|
3368
3797
|
}
|
|
3369
3798
|
export interface EventCopied {
|
|
3370
3799
|
/** Event created timestamp in ISO UTC format. */
|
|
3371
3800
|
timestamp?: Date | null;
|
|
3372
|
-
/**
|
|
3801
|
+
/**
|
|
3802
|
+
* Event ID.
|
|
3803
|
+
* @format GUID
|
|
3804
|
+
*/
|
|
3373
3805
|
eventId?: string;
|
|
3374
3806
|
/** Event location. */
|
|
3375
3807
|
location?: EventsLocation;
|
|
@@ -3377,13 +3809,22 @@ export interface EventCopied {
|
|
|
3377
3809
|
scheduleConfig?: ScheduleConfig;
|
|
3378
3810
|
/** Event title. */
|
|
3379
3811
|
title?: string;
|
|
3380
|
-
/**
|
|
3812
|
+
/**
|
|
3813
|
+
* Event creator user ID.
|
|
3814
|
+
* @format GUID
|
|
3815
|
+
*/
|
|
3381
3816
|
userId?: string | null;
|
|
3382
3817
|
/** Event status. */
|
|
3383
3818
|
status?: EventStatus;
|
|
3384
|
-
/**
|
|
3819
|
+
/**
|
|
3820
|
+
* Instance ID. Indicates the original app instance which current event was derived from.
|
|
3821
|
+
* @format GUID
|
|
3822
|
+
*/
|
|
3385
3823
|
derivedFromInstanceId?: string | null;
|
|
3386
|
-
/**
|
|
3824
|
+
/**
|
|
3825
|
+
* Event ID. Indicates the original event which current event was derived from.
|
|
3826
|
+
* @format GUID
|
|
3827
|
+
*/
|
|
3387
3828
|
derivedFromEventId?: string | null;
|
|
3388
3829
|
/**
|
|
3389
3830
|
* Map of copied ticket definitions from original event.
|
|
@@ -3395,7 +3836,10 @@ export interface EventCopied {
|
|
|
3395
3836
|
export interface EventPublished {
|
|
3396
3837
|
/** Event publish timestamp in ISO UTC format. */
|
|
3397
3838
|
timestamp?: Date | null;
|
|
3398
|
-
/**
|
|
3839
|
+
/**
|
|
3840
|
+
* Event ID.
|
|
3841
|
+
* @format GUID
|
|
3842
|
+
*/
|
|
3399
3843
|
eventId?: string;
|
|
3400
3844
|
/** Event status. */
|
|
3401
3845
|
status?: EventStatus;
|
|
@@ -3420,29 +3864,44 @@ export interface EventPublished {
|
|
|
3420
3864
|
export interface EventCanceled {
|
|
3421
3865
|
/** Event canceled timestamp in ISO UTC format. */
|
|
3422
3866
|
timestamp?: Date | null;
|
|
3423
|
-
/**
|
|
3867
|
+
/**
|
|
3868
|
+
* Event ID.
|
|
3869
|
+
* @format GUID
|
|
3870
|
+
*/
|
|
3424
3871
|
eventId?: string;
|
|
3425
3872
|
/** Event title */
|
|
3426
3873
|
title?: string;
|
|
3427
|
-
/**
|
|
3874
|
+
/**
|
|
3875
|
+
* Event creator user ID.
|
|
3876
|
+
* @format GUID
|
|
3877
|
+
*/
|
|
3428
3878
|
userId?: string | null;
|
|
3429
3879
|
}
|
|
3430
3880
|
export interface EventStarted {
|
|
3431
3881
|
/** Event start timestamp in ISO UTC format. */
|
|
3432
3882
|
timestamp?: Date | null;
|
|
3433
|
-
/**
|
|
3883
|
+
/**
|
|
3884
|
+
* Event ID.
|
|
3885
|
+
* @format GUID
|
|
3886
|
+
*/
|
|
3434
3887
|
eventId?: string;
|
|
3435
3888
|
}
|
|
3436
3889
|
export interface EventEnded {
|
|
3437
3890
|
/** Event end timestamp in ISO UTC format. */
|
|
3438
3891
|
timestamp?: Date | null;
|
|
3439
|
-
/**
|
|
3892
|
+
/**
|
|
3893
|
+
* Event ID.
|
|
3894
|
+
* @format GUID
|
|
3895
|
+
*/
|
|
3440
3896
|
eventId?: string;
|
|
3441
3897
|
}
|
|
3442
3898
|
export interface EventReminder {
|
|
3443
3899
|
/** Reminder timestamp in ISO UTC format. */
|
|
3444
3900
|
timestamp?: Date | null;
|
|
3445
|
-
/**
|
|
3901
|
+
/**
|
|
3902
|
+
* Event ID.
|
|
3903
|
+
* @format GUID
|
|
3904
|
+
*/
|
|
3446
3905
|
eventId?: string;
|
|
3447
3906
|
/** Event location. */
|
|
3448
3907
|
location?: EventsLocation;
|
|
@@ -3450,7 +3909,10 @@ export interface EventReminder {
|
|
|
3450
3909
|
scheduleConfig?: ScheduleConfig;
|
|
3451
3910
|
/** Event title. */
|
|
3452
3911
|
title?: string;
|
|
3453
|
-
/**
|
|
3912
|
+
/**
|
|
3913
|
+
* Event creator user ID.
|
|
3914
|
+
* @format GUID
|
|
3915
|
+
*/
|
|
3454
3916
|
userId?: string | null;
|
|
3455
3917
|
/** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
|
|
3456
3918
|
startsIn?: TimeDuration;
|
|
@@ -3528,9 +3990,15 @@ export interface ActionEvent {
|
|
|
3528
3990
|
bodyAsJson?: string;
|
|
3529
3991
|
}
|
|
3530
3992
|
export interface MessageEnvelope {
|
|
3531
|
-
/**
|
|
3993
|
+
/**
|
|
3994
|
+
* App instance ID.
|
|
3995
|
+
* @format GUID
|
|
3996
|
+
*/
|
|
3532
3997
|
instanceId?: string | null;
|
|
3533
|
-
/**
|
|
3998
|
+
/**
|
|
3999
|
+
* Event type.
|
|
4000
|
+
* @maxLength 150
|
|
4001
|
+
*/
|
|
3534
4002
|
eventType?: string;
|
|
3535
4003
|
/** The identification type and identity data. */
|
|
3536
4004
|
identity?: IdentificationData;
|
|
@@ -3538,26 +4006,50 @@ export interface MessageEnvelope {
|
|
|
3538
4006
|
data?: string;
|
|
3539
4007
|
}
|
|
3540
4008
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3541
|
-
/**
|
|
4009
|
+
/**
|
|
4010
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4011
|
+
* @format GUID
|
|
4012
|
+
*/
|
|
3542
4013
|
anonymousVisitorId?: string;
|
|
3543
|
-
/**
|
|
4014
|
+
/**
|
|
4015
|
+
* ID of a site visitor that has logged in to the site.
|
|
4016
|
+
* @format GUID
|
|
4017
|
+
*/
|
|
3544
4018
|
memberId?: string;
|
|
3545
|
-
/**
|
|
4019
|
+
/**
|
|
4020
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4021
|
+
* @format GUID
|
|
4022
|
+
*/
|
|
3546
4023
|
wixUserId?: string;
|
|
3547
|
-
/**
|
|
4024
|
+
/**
|
|
4025
|
+
* ID of an app.
|
|
4026
|
+
* @format GUID
|
|
4027
|
+
*/
|
|
3548
4028
|
appId?: string;
|
|
3549
4029
|
/** @readonly */
|
|
3550
4030
|
identityType?: WebhookIdentityType;
|
|
3551
4031
|
}
|
|
3552
4032
|
/** @oneof */
|
|
3553
4033
|
export interface IdentificationDataIdOneOf {
|
|
3554
|
-
/**
|
|
4034
|
+
/**
|
|
4035
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4036
|
+
* @format GUID
|
|
4037
|
+
*/
|
|
3555
4038
|
anonymousVisitorId?: string;
|
|
3556
|
-
/**
|
|
4039
|
+
/**
|
|
4040
|
+
* ID of a site visitor that has logged in to the site.
|
|
4041
|
+
* @format GUID
|
|
4042
|
+
*/
|
|
3557
4043
|
memberId?: string;
|
|
3558
|
-
/**
|
|
4044
|
+
/**
|
|
4045
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4046
|
+
* @format GUID
|
|
4047
|
+
*/
|
|
3559
4048
|
wixUserId?: string;
|
|
3560
|
-
/**
|
|
4049
|
+
/**
|
|
4050
|
+
* ID of an app.
|
|
4051
|
+
* @format GUID
|
|
4052
|
+
*/
|
|
3561
4053
|
appId?: string;
|
|
3562
4054
|
}
|
|
3563
4055
|
export declare enum WebhookIdentityType {
|