@wix/auto_sdk_events_wix-events-v-2 1.0.5 → 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.context.d.ts +1 -1
- package/build/cjs/src/events-v3-event-wix-events-v-2.http.js +11 -0
- package/build/cjs/src/events-v3-event-wix-events-v-2.http.js.map +1 -1
- package/build/cjs/src/events-v3-event-wix-events-v-2.public.d.ts +1 -1
- package/build/cjs/src/events-v3-event-wix-events-v-2.public.js +3 -0
- package/build/cjs/src/events-v3-event-wix-events-v-2.public.js.map +1 -1
- package/build/cjs/src/events-v3-event-wix-events-v-2.types.d.ts +661 -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 +725 -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.context.d.ts +1 -1
- package/build/es/src/events-v3-event-wix-events-v-2.http.js +11 -0
- package/build/es/src/events-v3-event-wix-events-v-2.http.js.map +1 -1
- package/build/es/src/events-v3-event-wix-events-v-2.public.d.ts +1 -1
- package/build/es/src/events-v3-event-wix-events-v-2.public.js +3 -0
- package/build/es/src/events-v3-event-wix-events-v-2.public.js.map +1 -1
- package/build/es/src/events-v3-event-wix-events-v-2.types.d.ts +661 -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 +725 -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.context.d.ts +1 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.http.js +11 -0
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.http.js.map +1 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.public.d.ts +1 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.public.js +3 -0
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.public.js.map +1 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.types.d.ts +661 -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 +725 -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.context.d.ts +1 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.http.js +11 -0
- package/build/internal/es/src/events-v3-event-wix-events-v-2.http.js.map +1 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.public.d.ts +1 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.public.js +3 -0
- package/build/internal/es/src/events-v3-event-wix-events-v-2.public.js.map +1 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.types.d.ts +661 -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 +725 -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
|
/**
|
|
@@ -118,9 +128,17 @@ export interface V3Event {
|
|
|
118
128
|
* For the event description to appear on your site, connect the [Rich Content Viewer](https://dev.wix.com/docs/velo/velo-only-apis/$w/rich-content-viewer/introduction) element, and assign the description value to the viewer.
|
|
119
129
|
*/
|
|
120
130
|
description?: RichContent;
|
|
131
|
+
/**
|
|
132
|
+
* Event publish timestamp.
|
|
133
|
+
* @readonly
|
|
134
|
+
*/
|
|
135
|
+
publishedDate?: Date | null;
|
|
121
136
|
}
|
|
122
137
|
export interface Location {
|
|
123
|
-
/**
|
|
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
|
+
*/
|
|
124
142
|
name?: string | null;
|
|
125
143
|
/**
|
|
126
144
|
* Location type:
|
|
@@ -146,42 +164,83 @@ export declare enum LocationType {
|
|
|
146
164
|
export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
147
165
|
/** Street address. */
|
|
148
166
|
streetAddress?: CommonStreetAddress;
|
|
149
|
-
/**
|
|
167
|
+
/**
|
|
168
|
+
* Primary address information (street and building number).
|
|
169
|
+
* @maxLength 250
|
|
170
|
+
*/
|
|
150
171
|
addressLine1?: string | null;
|
|
151
|
-
/**
|
|
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
|
+
*/
|
|
152
176
|
country?: string | null;
|
|
153
|
-
/**
|
|
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
|
+
*/
|
|
154
181
|
subdivision?: string | null;
|
|
155
|
-
/**
|
|
182
|
+
/**
|
|
183
|
+
* City name.
|
|
184
|
+
* @maxLength 100
|
|
185
|
+
*/
|
|
156
186
|
city?: string | null;
|
|
157
|
-
/**
|
|
187
|
+
/**
|
|
188
|
+
* Zip or postal code.
|
|
189
|
+
* @maxLength 100
|
|
190
|
+
*/
|
|
158
191
|
postalCode?: string | null;
|
|
159
|
-
/**
|
|
192
|
+
/**
|
|
193
|
+
* Secondary address information (suite or apartment number and room number).
|
|
194
|
+
* @maxLength 250
|
|
195
|
+
*/
|
|
160
196
|
addressLine2?: string | null;
|
|
161
197
|
}
|
|
162
198
|
/** @oneof */
|
|
163
199
|
export interface CommonAddressStreetOneOf {
|
|
164
200
|
/** Street address. */
|
|
165
201
|
streetAddress?: CommonStreetAddress;
|
|
166
|
-
/**
|
|
202
|
+
/**
|
|
203
|
+
* Primary address information (street and building number).
|
|
204
|
+
* @maxLength 250
|
|
205
|
+
*/
|
|
167
206
|
addressLine?: string | null;
|
|
168
207
|
}
|
|
169
208
|
export interface CommonStreetAddress {
|
|
170
|
-
/**
|
|
209
|
+
/**
|
|
210
|
+
* Street number.
|
|
211
|
+
* @maxLength 100
|
|
212
|
+
*/
|
|
171
213
|
number?: string;
|
|
172
|
-
/**
|
|
214
|
+
/**
|
|
215
|
+
* Street name.
|
|
216
|
+
* @maxLength 250
|
|
217
|
+
*/
|
|
173
218
|
name?: string;
|
|
174
219
|
}
|
|
175
220
|
export interface CommonAddressLocation {
|
|
176
|
-
/**
|
|
221
|
+
/**
|
|
222
|
+
* Address latitude coordinates.
|
|
223
|
+
* @min -90
|
|
224
|
+
* @max 90
|
|
225
|
+
*/
|
|
177
226
|
latitude?: number | null;
|
|
178
|
-
/**
|
|
227
|
+
/**
|
|
228
|
+
* Address longitude coordinates.
|
|
229
|
+
* @min -180
|
|
230
|
+
* @max 180
|
|
231
|
+
*/
|
|
179
232
|
longitude?: number | null;
|
|
180
233
|
}
|
|
181
234
|
export interface CommonSubdivision {
|
|
182
|
-
/**
|
|
235
|
+
/**
|
|
236
|
+
* Short subdivision code.
|
|
237
|
+
* @maxLength 100
|
|
238
|
+
*/
|
|
183
239
|
code?: string;
|
|
184
|
-
/**
|
|
240
|
+
/**
|
|
241
|
+
* Subdivision full name.
|
|
242
|
+
* @maxLength 250
|
|
243
|
+
*/
|
|
185
244
|
name?: string;
|
|
186
245
|
}
|
|
187
246
|
export declare enum SubdivisionSubdivisionType {
|
|
@@ -202,7 +261,10 @@ export declare enum SubdivisionSubdivisionType {
|
|
|
202
261
|
export interface DateAndTimeSettings {
|
|
203
262
|
/** Whether the event date and time are TBD. */
|
|
204
263
|
dateAndTimeTbd?: boolean | null;
|
|
205
|
-
/**
|
|
264
|
+
/**
|
|
265
|
+
* Message that is displayed when time and date is TBD.
|
|
266
|
+
* @maxLength 100
|
|
267
|
+
*/
|
|
206
268
|
dateAndTimeTbdMessage?: string | null;
|
|
207
269
|
/**
|
|
208
270
|
* Event start date.
|
|
@@ -220,6 +282,7 @@ export interface DateAndTimeSettings {
|
|
|
220
282
|
* Event time zone ID in the TZ database format.
|
|
221
283
|
*
|
|
222
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
|
|
223
286
|
*/
|
|
224
287
|
timeZoneId?: string | null;
|
|
225
288
|
/** Whether the end date is hidden in the formatted date and time. */
|
|
@@ -257,11 +320,15 @@ export declare enum RecurrenceStatusStatus {
|
|
|
257
320
|
RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
|
|
258
321
|
}
|
|
259
322
|
export interface Recurrences {
|
|
260
|
-
/**
|
|
323
|
+
/**
|
|
324
|
+
* Individual event dates info.
|
|
325
|
+
* @maxSize 1000
|
|
326
|
+
*/
|
|
261
327
|
individualEventDates?: Occurrence[];
|
|
262
328
|
/**
|
|
263
329
|
* Recurring event category ID.
|
|
264
330
|
* @readonly
|
|
331
|
+
* @maxLength 100
|
|
265
332
|
*/
|
|
266
333
|
categoryId?: string | null;
|
|
267
334
|
}
|
|
@@ -270,7 +337,10 @@ export interface Occurrence {
|
|
|
270
337
|
startDate?: Date | null;
|
|
271
338
|
/** Event end date. */
|
|
272
339
|
endDate?: Date | null;
|
|
273
|
-
/**
|
|
340
|
+
/**
|
|
341
|
+
* Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
|
|
342
|
+
* @maxLength 100
|
|
343
|
+
*/
|
|
274
344
|
timeZoneId?: string | null;
|
|
275
345
|
/** Whether the time zone is displayed in a formatted schedule. */
|
|
276
346
|
showTimeZone?: boolean;
|
|
@@ -282,26 +352,31 @@ export interface Formatted {
|
|
|
282
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`.
|
|
283
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`.
|
|
284
354
|
* @readonly
|
|
355
|
+
* @maxLength 500
|
|
285
356
|
*/
|
|
286
357
|
dateAndTime?: string | null;
|
|
287
358
|
/**
|
|
288
359
|
* Formatted start date of the event. Empty for TBD schedules.
|
|
289
360
|
* @readonly
|
|
361
|
+
* @maxLength 500
|
|
290
362
|
*/
|
|
291
363
|
startDate?: string | null;
|
|
292
364
|
/**
|
|
293
365
|
* Formatted start time of the event. Empty for TBD schedules.
|
|
294
366
|
* @readonly
|
|
367
|
+
* @maxLength 500
|
|
295
368
|
*/
|
|
296
369
|
startTime?: string | null;
|
|
297
370
|
/**
|
|
298
371
|
* Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.
|
|
299
372
|
* @readonly
|
|
373
|
+
* @maxLength 500
|
|
300
374
|
*/
|
|
301
375
|
endDate?: string | null;
|
|
302
376
|
/**
|
|
303
377
|
* Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.
|
|
304
378
|
* @readonly
|
|
379
|
+
* @maxLength 500
|
|
305
380
|
*/
|
|
306
381
|
endTime?: string | null;
|
|
307
382
|
}
|
|
@@ -312,9 +387,15 @@ export interface Formatted {
|
|
|
312
387
|
export interface TimeDuration {
|
|
313
388
|
/** Number of days. */
|
|
314
389
|
days?: number;
|
|
315
|
-
/**
|
|
390
|
+
/**
|
|
391
|
+
* Number of hours.
|
|
392
|
+
* @max 24
|
|
393
|
+
*/
|
|
316
394
|
hours?: number;
|
|
317
|
-
/**
|
|
395
|
+
/**
|
|
396
|
+
* Number of minutes.
|
|
397
|
+
* @max 60
|
|
398
|
+
*/
|
|
318
399
|
minutes?: number;
|
|
319
400
|
}
|
|
320
401
|
export declare enum Status {
|
|
@@ -377,6 +458,7 @@ export interface Registration {
|
|
|
377
458
|
* - `TICKETING`: Guests register by buying tickets.
|
|
378
459
|
*
|
|
379
460
|
* This property value never changes.
|
|
461
|
+
* @immutable
|
|
380
462
|
*/
|
|
381
463
|
initialType?: InitialRegistrationTypeType;
|
|
382
464
|
/** Whether the registration is paused. */
|
|
@@ -440,6 +522,7 @@ export interface TicketsRegistration {
|
|
|
440
522
|
/**
|
|
441
523
|
* Ticket limit per order.
|
|
442
524
|
* Default: 20 tickets.
|
|
525
|
+
* @max 50
|
|
443
526
|
*/
|
|
444
527
|
ticketLimitPerOrder?: number;
|
|
445
528
|
/** Ticket price currency. */
|
|
@@ -467,9 +550,15 @@ export interface TicketsRegistration {
|
|
|
467
550
|
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
468
551
|
*/
|
|
469
552
|
export interface Money {
|
|
470
|
-
/**
|
|
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
|
+
*/
|
|
471
557
|
value?: string;
|
|
472
|
-
/**
|
|
558
|
+
/**
|
|
559
|
+
* Currency code in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
560
|
+
* @format CURRENCY
|
|
561
|
+
*/
|
|
473
562
|
currency?: string;
|
|
474
563
|
/**
|
|
475
564
|
* Amount of money in decimal form. A period or comma are used as a decimal separator (for example, `1 000,30`).
|
|
@@ -485,9 +574,16 @@ export interface TaxSettings {
|
|
|
485
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.
|
|
486
575
|
*/
|
|
487
576
|
type?: TaxType;
|
|
488
|
-
/**
|
|
577
|
+
/**
|
|
578
|
+
* Tax name.
|
|
579
|
+
* @minLength 1
|
|
580
|
+
* @maxLength 10
|
|
581
|
+
*/
|
|
489
582
|
name?: string | null;
|
|
490
|
-
/**
|
|
583
|
+
/**
|
|
584
|
+
* Tax rate (for example,`21.55`).
|
|
585
|
+
* @decimalValue options - {gte:0.001,lte:100,maxScale:3}
|
|
586
|
+
*/
|
|
491
587
|
rate?: string | null;
|
|
492
588
|
/** Apply tax to donations. */
|
|
493
589
|
appliedToDonations?: boolean | null;
|
|
@@ -502,7 +598,10 @@ export declare enum TaxType {
|
|
|
502
598
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
503
599
|
}
|
|
504
600
|
export interface ExternalRegistration {
|
|
505
|
-
/**
|
|
601
|
+
/**
|
|
602
|
+
* External event registration URL.
|
|
603
|
+
* @format WEB_URL
|
|
604
|
+
*/
|
|
506
605
|
url?: string | null;
|
|
507
606
|
}
|
|
508
607
|
export declare enum GuestTypeType {
|
|
@@ -657,21 +756,29 @@ export declare enum ValueType {
|
|
|
657
756
|
* Defaults to first (0th) option if not configured.
|
|
658
757
|
*/
|
|
659
758
|
export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
660
|
-
/**
|
|
759
|
+
/**
|
|
760
|
+
* 0-based index from predefined `input.options` which is selected initially.
|
|
761
|
+
* @max 199
|
|
762
|
+
*/
|
|
661
763
|
optionIndex?: number;
|
|
662
764
|
/**
|
|
663
765
|
* Placeholder hint describing expected choices (such as "Please select").
|
|
664
766
|
* Considered an empty choice.
|
|
767
|
+
* @maxLength 200
|
|
665
768
|
*/
|
|
666
769
|
placeholderText?: string;
|
|
667
770
|
}
|
|
668
771
|
/** @oneof */
|
|
669
772
|
export interface OptionSelectionSelectedOptionOneOf {
|
|
670
|
-
/**
|
|
773
|
+
/**
|
|
774
|
+
* 0-based index from predefined `input.options` which is selected initially.
|
|
775
|
+
* @max 199
|
|
776
|
+
*/
|
|
671
777
|
optionIndex?: number;
|
|
672
778
|
/**
|
|
673
779
|
* Placeholder hint describing expected choices (such as "Please select").
|
|
674
780
|
* Considered an empty choice.
|
|
781
|
+
* @maxLength 200
|
|
675
782
|
*/
|
|
676
783
|
placeholderText?: string;
|
|
677
784
|
}
|
|
@@ -783,12 +890,19 @@ export interface Summaries {
|
|
|
783
890
|
export interface EventsMoney {
|
|
784
891
|
/**
|
|
785
892
|
* *Deprecated:** Use `value` instead.
|
|
893
|
+
* @format DECIMAL_VALUE
|
|
786
894
|
* @deprecated
|
|
787
895
|
*/
|
|
788
896
|
amount?: string;
|
|
789
|
-
/**
|
|
897
|
+
/**
|
|
898
|
+
* ISO 4217 format of the currency e.g., `USD`.
|
|
899
|
+
* @format CURRENCY
|
|
900
|
+
*/
|
|
790
901
|
currency?: string;
|
|
791
|
-
/**
|
|
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
|
+
*/
|
|
792
906
|
value?: string | null;
|
|
793
907
|
}
|
|
794
908
|
export interface Rsvps {
|
|
@@ -851,7 +965,10 @@ export interface Feed {
|
|
|
851
965
|
export interface OnlineConferencing {
|
|
852
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. */
|
|
853
967
|
enabled?: boolean;
|
|
854
|
-
/**
|
|
968
|
+
/**
|
|
969
|
+
* Conference host ID.
|
|
970
|
+
* @format GUID
|
|
971
|
+
*/
|
|
855
972
|
providerId?: string | null;
|
|
856
973
|
/**
|
|
857
974
|
* Conference type. Possible values:
|
|
@@ -899,7 +1016,10 @@ export interface OnlineConferencingSession {
|
|
|
899
1016
|
sessionId?: string | null;
|
|
900
1017
|
}
|
|
901
1018
|
export interface SeoSettings {
|
|
902
|
-
/**
|
|
1019
|
+
/**
|
|
1020
|
+
* URL slug.
|
|
1021
|
+
* @maxLength 130
|
|
1022
|
+
*/
|
|
903
1023
|
slug?: string;
|
|
904
1024
|
/** Advanced SEO data. */
|
|
905
1025
|
advancedSeoData?: SeoSchema;
|
|
@@ -925,7 +1045,10 @@ export interface Keyword {
|
|
|
925
1045
|
term?: string;
|
|
926
1046
|
/** Whether the keyword is the main focus keyword. */
|
|
927
1047
|
isMain?: boolean;
|
|
928
|
-
/**
|
|
1048
|
+
/**
|
|
1049
|
+
* The source that added the keyword terms to the SEO settings.
|
|
1050
|
+
* @maxLength 1000
|
|
1051
|
+
*/
|
|
929
1052
|
origin?: string | null;
|
|
930
1053
|
}
|
|
931
1054
|
export interface Tag {
|
|
@@ -958,7 +1081,10 @@ export interface Settings {
|
|
|
958
1081
|
* Default: `false` (Auto Redirect is enabled.)
|
|
959
1082
|
*/
|
|
960
1083
|
preventAutoRedirect?: boolean;
|
|
961
|
-
/**
|
|
1084
|
+
/**
|
|
1085
|
+
* User-selected keyword terms for a specific page.
|
|
1086
|
+
* @maxSize 5
|
|
1087
|
+
*/
|
|
962
1088
|
keywords?: Keyword[];
|
|
963
1089
|
}
|
|
964
1090
|
export interface AgendaSettings {
|
|
@@ -971,16 +1097,24 @@ export interface AgendaSettings {
|
|
|
971
1097
|
pageUrl?: string;
|
|
972
1098
|
}
|
|
973
1099
|
export interface EventCategories {
|
|
974
|
-
/**
|
|
1100
|
+
/**
|
|
1101
|
+
* Event categories.
|
|
1102
|
+
* @maxSize 10
|
|
1103
|
+
*/
|
|
975
1104
|
categories?: EventCategory[];
|
|
976
1105
|
}
|
|
977
1106
|
export interface EventCategory {
|
|
978
1107
|
/**
|
|
979
1108
|
* Category ID.
|
|
1109
|
+
* @format GUID
|
|
980
1110
|
* @readonly
|
|
981
1111
|
*/
|
|
982
1112
|
_id?: string;
|
|
983
|
-
/**
|
|
1113
|
+
/**
|
|
1114
|
+
* Category name.
|
|
1115
|
+
* @minLength 1
|
|
1116
|
+
* @maxLength 30
|
|
1117
|
+
*/
|
|
984
1118
|
name?: string;
|
|
985
1119
|
/**
|
|
986
1120
|
* Category creation timestamp.
|
|
@@ -1610,11 +1744,20 @@ export interface GIFData {
|
|
|
1610
1744
|
gifType?: GIFType;
|
|
1611
1745
|
}
|
|
1612
1746
|
export interface GIF {
|
|
1613
|
-
/**
|
|
1747
|
+
/**
|
|
1748
|
+
* GIF format URL.
|
|
1749
|
+
* @format WEB_URL
|
|
1750
|
+
*/
|
|
1614
1751
|
gif?: string | null;
|
|
1615
|
-
/**
|
|
1752
|
+
/**
|
|
1753
|
+
* MP4 format URL.
|
|
1754
|
+
* @format WEB_URL
|
|
1755
|
+
*/
|
|
1616
1756
|
mp4?: string | null;
|
|
1617
|
-
/**
|
|
1757
|
+
/**
|
|
1758
|
+
* Thumbnail URL.
|
|
1759
|
+
* @format WEB_URL
|
|
1760
|
+
*/
|
|
1618
1761
|
still?: string | null;
|
|
1619
1762
|
}
|
|
1620
1763
|
export declare enum GIFType {
|
|
@@ -1680,6 +1823,22 @@ export interface ImageData {
|
|
|
1680
1823
|
caption?: string | null;
|
|
1681
1824
|
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
|
1682
1825
|
disableDownload?: boolean | null;
|
|
1826
|
+
/** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
|
|
1827
|
+
decorative?: boolean | null;
|
|
1828
|
+
/** Styling for the image. */
|
|
1829
|
+
styles?: ImageDataStyles;
|
|
1830
|
+
}
|
|
1831
|
+
export interface StylesBorder {
|
|
1832
|
+
/** Border width in pixels. */
|
|
1833
|
+
width?: number | null;
|
|
1834
|
+
/** Border color. */
|
|
1835
|
+
color?: string | null;
|
|
1836
|
+
/** Border radius in pixels. */
|
|
1837
|
+
radius?: number | null;
|
|
1838
|
+
}
|
|
1839
|
+
export interface ImageDataStyles {
|
|
1840
|
+
/** Border attributes. */
|
|
1841
|
+
border?: StylesBorder;
|
|
1683
1842
|
}
|
|
1684
1843
|
export interface LinkPreviewData {
|
|
1685
1844
|
/** Styling for the link preview's container. */
|
|
@@ -1826,13 +1985,22 @@ export declare enum BackgroundType {
|
|
|
1826
1985
|
export interface Gradient {
|
|
1827
1986
|
/** The gradient angle in degrees. */
|
|
1828
1987
|
angle?: number | null;
|
|
1829
|
-
/**
|
|
1988
|
+
/**
|
|
1989
|
+
* The start color as a hexademical value.
|
|
1990
|
+
* @format COLOR_HEX
|
|
1991
|
+
*/
|
|
1830
1992
|
startColor?: string | null;
|
|
1831
|
-
/**
|
|
1993
|
+
/**
|
|
1994
|
+
* The end color as a hexademical value.
|
|
1995
|
+
* @format COLOR_HEX
|
|
1996
|
+
*/
|
|
1832
1997
|
lastColor?: string | null;
|
|
1833
1998
|
}
|
|
1834
1999
|
export interface Background extends BackgroundBackgroundOneOf {
|
|
1835
|
-
/**
|
|
2000
|
+
/**
|
|
2001
|
+
* The background color as a hexademical value.
|
|
2002
|
+
* @format COLOR_HEX
|
|
2003
|
+
*/
|
|
1836
2004
|
color?: string | null;
|
|
1837
2005
|
/** An image to use for the background. */
|
|
1838
2006
|
image?: Media;
|
|
@@ -1843,7 +2011,10 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1843
2011
|
}
|
|
1844
2012
|
/** @oneof */
|
|
1845
2013
|
export interface BackgroundBackgroundOneOf {
|
|
1846
|
-
/**
|
|
2014
|
+
/**
|
|
2015
|
+
* The background color as a hexademical value.
|
|
2016
|
+
* @format COLOR_HEX
|
|
2017
|
+
*/
|
|
1847
2018
|
color?: string | null;
|
|
1848
2019
|
/** An image to use for the background. */
|
|
1849
2020
|
image?: Media;
|
|
@@ -2155,17 +2326,32 @@ export declare enum VerticalAlignment {
|
|
|
2155
2326
|
export interface CellStyle {
|
|
2156
2327
|
/** Vertical alignment for the cell's text. */
|
|
2157
2328
|
verticalAlignment?: VerticalAlignment;
|
|
2158
|
-
/**
|
|
2329
|
+
/**
|
|
2330
|
+
* Cell background color as a hexadecimal value.
|
|
2331
|
+
* @format COLOR_HEX
|
|
2332
|
+
*/
|
|
2159
2333
|
backgroundColor?: string | null;
|
|
2160
2334
|
}
|
|
2161
2335
|
export interface BorderColors {
|
|
2162
|
-
/**
|
|
2336
|
+
/**
|
|
2337
|
+
* Left border color as a hexadecimal value.
|
|
2338
|
+
* @format COLOR_HEX
|
|
2339
|
+
*/
|
|
2163
2340
|
left?: string | null;
|
|
2164
|
-
/**
|
|
2341
|
+
/**
|
|
2342
|
+
* Right border color as a hexadecimal value.
|
|
2343
|
+
* @format COLOR_HEX
|
|
2344
|
+
*/
|
|
2165
2345
|
right?: string | null;
|
|
2166
|
-
/**
|
|
2346
|
+
/**
|
|
2347
|
+
* Top border color as a hexadecimal value.
|
|
2348
|
+
* @format COLOR_HEX
|
|
2349
|
+
*/
|
|
2167
2350
|
top?: string | null;
|
|
2168
|
-
/**
|
|
2351
|
+
/**
|
|
2352
|
+
* Bottom border color as a hexadecimal value.
|
|
2353
|
+
* @format COLOR_HEX
|
|
2354
|
+
*/
|
|
2169
2355
|
bottom?: string | null;
|
|
2170
2356
|
}
|
|
2171
2357
|
/**
|
|
@@ -2276,27 +2462,43 @@ export interface TextNodeStyle {
|
|
|
2276
2462
|
export interface EventEventStarted {
|
|
2277
2463
|
/** Event schedule configuration. */
|
|
2278
2464
|
timestamp?: Date | null;
|
|
2279
|
-
/**
|
|
2465
|
+
/**
|
|
2466
|
+
* Event ID.
|
|
2467
|
+
* @format GUID
|
|
2468
|
+
*/
|
|
2280
2469
|
eventId?: string;
|
|
2281
2470
|
}
|
|
2282
2471
|
export interface EventEventEnded {
|
|
2283
2472
|
/** Event end timestamp in ISO UTC format. */
|
|
2284
2473
|
timestamp?: Date | null;
|
|
2285
|
-
/**
|
|
2474
|
+
/**
|
|
2475
|
+
* Event ID.
|
|
2476
|
+
* @format GUID
|
|
2477
|
+
*/
|
|
2286
2478
|
eventId?: string;
|
|
2287
2479
|
}
|
|
2288
2480
|
export interface EventEventReminder {
|
|
2289
2481
|
/** Reminder timestamp in ISO UTC format. */
|
|
2290
2482
|
timestamp?: Date | null;
|
|
2291
|
-
/**
|
|
2483
|
+
/**
|
|
2484
|
+
* Event ID.
|
|
2485
|
+
* @format GUID
|
|
2486
|
+
*/
|
|
2292
2487
|
eventId?: string;
|
|
2293
2488
|
/** Event location. */
|
|
2294
2489
|
location?: Location;
|
|
2295
2490
|
/** Event schedule configuration. */
|
|
2296
2491
|
dateAndTimeSettings?: DateAndTimeSettings;
|
|
2297
|
-
/**
|
|
2492
|
+
/**
|
|
2493
|
+
* Event title.
|
|
2494
|
+
* @minLength 1
|
|
2495
|
+
* @maxLength 120
|
|
2496
|
+
*/
|
|
2298
2497
|
title?: string;
|
|
2299
|
-
/**
|
|
2498
|
+
/**
|
|
2499
|
+
* ID of the user who created the event.
|
|
2500
|
+
* @format GUID
|
|
2501
|
+
*/
|
|
2300
2502
|
userId?: string | null;
|
|
2301
2503
|
/** Time until the start of event (currently, reminder letter is triggered 1 day before the start of event). */
|
|
2302
2504
|
startsIn?: TimeDuration;
|
|
@@ -2304,18 +2506,29 @@ export interface EventEventReminder {
|
|
|
2304
2506
|
export interface EventEventPublished {
|
|
2305
2507
|
/** Event publishing timestamp in ISO UTC format. */
|
|
2306
2508
|
timestamp?: Date | null;
|
|
2307
|
-
/**
|
|
2509
|
+
/**
|
|
2510
|
+
* Event ID.
|
|
2511
|
+
* @format GUID
|
|
2512
|
+
*/
|
|
2308
2513
|
eventId?: string;
|
|
2309
2514
|
/** Event status. */
|
|
2310
2515
|
status?: Status;
|
|
2311
2516
|
/**
|
|
2312
2517
|
* Event ID. Indicates the original event from which the current event was derived from.
|
|
2313
2518
|
* Can be used to track the original event and add missing information.
|
|
2519
|
+
* @format GUID
|
|
2314
2520
|
*/
|
|
2315
2521
|
derivedFromEventId?: string | null;
|
|
2316
|
-
/**
|
|
2522
|
+
/**
|
|
2523
|
+
* Event title.
|
|
2524
|
+
* @minLength 1
|
|
2525
|
+
* @maxLength 120
|
|
2526
|
+
*/
|
|
2317
2527
|
title?: string | null;
|
|
2318
|
-
/**
|
|
2528
|
+
/**
|
|
2529
|
+
* Short description that appears under the event title.
|
|
2530
|
+
* @maxLength 500
|
|
2531
|
+
*/
|
|
2319
2532
|
shortDescription?: string | null;
|
|
2320
2533
|
/** Event location. */
|
|
2321
2534
|
location?: Location;
|
|
@@ -2329,21 +2542,37 @@ export interface EventEventPublished {
|
|
|
2329
2542
|
export interface EventCloned {
|
|
2330
2543
|
/** Event creation timestamp in ISO UTC format. */
|
|
2331
2544
|
timestamp?: Date | null;
|
|
2332
|
-
/**
|
|
2545
|
+
/**
|
|
2546
|
+
* Event ID.
|
|
2547
|
+
* @format GUID
|
|
2548
|
+
*/
|
|
2333
2549
|
eventId?: string;
|
|
2334
2550
|
/** Event location. */
|
|
2335
2551
|
location?: Location;
|
|
2336
2552
|
/** Event date and time settings. */
|
|
2337
2553
|
dateAndTimeSettings?: DateAndTimeSettings;
|
|
2338
|
-
/**
|
|
2554
|
+
/**
|
|
2555
|
+
* Event title.
|
|
2556
|
+
* @minLength 1
|
|
2557
|
+
* @maxLength 120
|
|
2558
|
+
*/
|
|
2339
2559
|
title?: string;
|
|
2340
|
-
/**
|
|
2560
|
+
/**
|
|
2561
|
+
* ID of the user who created the event.
|
|
2562
|
+
* @format GUID
|
|
2563
|
+
*/
|
|
2341
2564
|
userId?: string | null;
|
|
2342
2565
|
/** Event status. */
|
|
2343
2566
|
status?: Status;
|
|
2344
|
-
/**
|
|
2567
|
+
/**
|
|
2568
|
+
* Instance ID. Indicates the original app instance from which current event was derived from.
|
|
2569
|
+
* @format GUID
|
|
2570
|
+
*/
|
|
2345
2571
|
derivedFromInstanceId?: string | null;
|
|
2346
|
-
/**
|
|
2572
|
+
/**
|
|
2573
|
+
* Event ID. Indicates the original event from which current event was derived from.
|
|
2574
|
+
* @format GUID
|
|
2575
|
+
*/
|
|
2347
2576
|
derivedFromEventId?: string | null;
|
|
2348
2577
|
/**
|
|
2349
2578
|
* Map of copied ticket definitions from the original event. <br>
|
|
@@ -2355,11 +2584,21 @@ export interface EventCloned {
|
|
|
2355
2584
|
export interface EventEventCanceled {
|
|
2356
2585
|
/** Event cancelation timestamp in ISO UTC format. */
|
|
2357
2586
|
timestamp?: Date | null;
|
|
2358
|
-
/**
|
|
2587
|
+
/**
|
|
2588
|
+
* Event ID.
|
|
2589
|
+
* @format GUID
|
|
2590
|
+
*/
|
|
2359
2591
|
eventId?: string;
|
|
2360
|
-
/**
|
|
2592
|
+
/**
|
|
2593
|
+
* Event title.
|
|
2594
|
+
* @minLength 1
|
|
2595
|
+
* @maxLength 120
|
|
2596
|
+
*/
|
|
2361
2597
|
title?: string;
|
|
2362
|
-
/**
|
|
2598
|
+
/**
|
|
2599
|
+
* ID of the user who created the event.
|
|
2600
|
+
* @format GUID
|
|
2601
|
+
*/
|
|
2363
2602
|
userId?: string | null;
|
|
2364
2603
|
}
|
|
2365
2604
|
export interface CreateEventRequest {
|
|
@@ -2367,7 +2606,10 @@ export interface CreateEventRequest {
|
|
|
2367
2606
|
event: V3Event;
|
|
2368
2607
|
/** Whether to create the event as a draft. */
|
|
2369
2608
|
draft?: boolean;
|
|
2370
|
-
/**
|
|
2609
|
+
/**
|
|
2610
|
+
* Predefined sets of fields to return.
|
|
2611
|
+
* @maxSize 20
|
|
2612
|
+
*/
|
|
2371
2613
|
fields?: RequestedFields[];
|
|
2372
2614
|
}
|
|
2373
2615
|
export declare enum RequestedFields {
|
|
@@ -2401,13 +2643,19 @@ export interface CreateEventResponse {
|
|
|
2401
2643
|
event?: V3Event;
|
|
2402
2644
|
}
|
|
2403
2645
|
export interface CloneEventRequest {
|
|
2404
|
-
/**
|
|
2646
|
+
/**
|
|
2647
|
+
* Event ID.
|
|
2648
|
+
* @format GUID
|
|
2649
|
+
*/
|
|
2405
2650
|
eventId: string;
|
|
2406
2651
|
/** Field values to be changed when cloning the event. */
|
|
2407
2652
|
event?: V3Event;
|
|
2408
2653
|
/** Whether to clone the event as a draft. */
|
|
2409
2654
|
draft?: boolean;
|
|
2410
|
-
/**
|
|
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
|
+
*/
|
|
2411
2659
|
fields?: RequestedFields[];
|
|
2412
2660
|
}
|
|
2413
2661
|
export interface CloneEventResponse {
|
|
@@ -2417,7 +2665,10 @@ export interface CloneEventResponse {
|
|
|
2417
2665
|
export interface UpdateEventRequest {
|
|
2418
2666
|
/** Field values to be changed. */
|
|
2419
2667
|
event?: V3Event;
|
|
2420
|
-
/**
|
|
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
|
+
*/
|
|
2421
2672
|
fields?: RequestedFields[];
|
|
2422
2673
|
}
|
|
2423
2674
|
export interface UpdateEventResponse {
|
|
@@ -2425,9 +2676,15 @@ export interface UpdateEventResponse {
|
|
|
2425
2676
|
event?: V3Event;
|
|
2426
2677
|
}
|
|
2427
2678
|
export interface PublishDraftEventRequest {
|
|
2428
|
-
/**
|
|
2679
|
+
/**
|
|
2680
|
+
* Event ID.
|
|
2681
|
+
* @format GUID
|
|
2682
|
+
*/
|
|
2429
2683
|
eventId: string;
|
|
2430
|
-
/**
|
|
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
|
+
*/
|
|
2431
2688
|
fields?: RequestedFields[];
|
|
2432
2689
|
}
|
|
2433
2690
|
export interface PublishDraftEventResponse {
|
|
@@ -2435,9 +2692,15 @@ export interface PublishDraftEventResponse {
|
|
|
2435
2692
|
event?: V3Event;
|
|
2436
2693
|
}
|
|
2437
2694
|
export interface CancelEventRequest {
|
|
2438
|
-
/**
|
|
2695
|
+
/**
|
|
2696
|
+
* Event ID.
|
|
2697
|
+
* @format GUID
|
|
2698
|
+
*/
|
|
2439
2699
|
eventId: string;
|
|
2440
|
-
/**
|
|
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
|
+
*/
|
|
2441
2704
|
fields?: RequestedFields[];
|
|
2442
2705
|
}
|
|
2443
2706
|
export interface CancelEventResponse {
|
|
@@ -2462,6 +2725,7 @@ export interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
|
|
|
2462
2725
|
/**
|
|
2463
2726
|
* Sort object in the following format:
|
|
2464
2727
|
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
2728
|
+
* @maxSize 20
|
|
2465
2729
|
*/
|
|
2466
2730
|
sort?: CommonSorting[];
|
|
2467
2731
|
}
|
|
@@ -2471,7 +2735,10 @@ export interface CommonQueryV2PagingMethodOneOf {
|
|
|
2471
2735
|
paging?: CommonPaging;
|
|
2472
2736
|
}
|
|
2473
2737
|
export interface CommonSorting {
|
|
2474
|
-
/**
|
|
2738
|
+
/**
|
|
2739
|
+
* Name of the field to sort by.
|
|
2740
|
+
* @maxLength 100
|
|
2741
|
+
*/
|
|
2475
2742
|
fieldName?: string;
|
|
2476
2743
|
/**
|
|
2477
2744
|
* Sort order.
|
|
@@ -2486,7 +2753,10 @@ export declare enum CommonSortOrder {
|
|
|
2486
2753
|
DESC = "DESC"
|
|
2487
2754
|
}
|
|
2488
2755
|
export interface CommonPaging {
|
|
2489
|
-
/**
|
|
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
|
+
*/
|
|
2490
2760
|
limit?: number | null;
|
|
2491
2761
|
/** Number of items to skip in the current sort order. */
|
|
2492
2762
|
offset?: number | null;
|
|
@@ -2494,11 +2764,17 @@ export interface CommonPaging {
|
|
|
2494
2764
|
export interface BulkCancelEventsByFilterResponse {
|
|
2495
2765
|
}
|
|
2496
2766
|
export interface DeleteEventRequest {
|
|
2497
|
-
/**
|
|
2767
|
+
/**
|
|
2768
|
+
* Event ID.
|
|
2769
|
+
* @format GUID
|
|
2770
|
+
*/
|
|
2498
2771
|
eventId: string;
|
|
2499
2772
|
}
|
|
2500
2773
|
export interface DeleteEventResponse {
|
|
2501
|
-
/**
|
|
2774
|
+
/**
|
|
2775
|
+
* Deleted event ID.
|
|
2776
|
+
* @format GUID
|
|
2777
|
+
*/
|
|
2502
2778
|
eventId?: string;
|
|
2503
2779
|
}
|
|
2504
2780
|
export interface BulkDeleteEventsByFilterRequest {
|
|
@@ -2510,7 +2786,10 @@ export interface BulkDeleteEventsByFilterResponse {
|
|
|
2510
2786
|
export interface QueryEventsRequest {
|
|
2511
2787
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
2512
2788
|
query?: CommonQueryV2;
|
|
2513
|
-
/**
|
|
2789
|
+
/**
|
|
2790
|
+
* Predefined sets of fields to return.
|
|
2791
|
+
* @maxSize 20
|
|
2792
|
+
*/
|
|
2514
2793
|
fields?: RequestedFields[];
|
|
2515
2794
|
/**
|
|
2516
2795
|
* Whether draft events should be returned in the response. <br>
|
|
@@ -2576,7 +2855,10 @@ export interface QueryV2PagingMethodOneOf {
|
|
|
2576
2855
|
cursorPaging?: CursorPaging;
|
|
2577
2856
|
}
|
|
2578
2857
|
export interface Sorting {
|
|
2579
|
-
/**
|
|
2858
|
+
/**
|
|
2859
|
+
* Name of the field to sort by.
|
|
2860
|
+
* @maxLength 512
|
|
2861
|
+
*/
|
|
2580
2862
|
fieldName?: string;
|
|
2581
2863
|
/** Sort order. */
|
|
2582
2864
|
order?: SortOrder;
|
|
@@ -2592,13 +2874,17 @@ export interface Paging {
|
|
|
2592
2874
|
offset?: number | null;
|
|
2593
2875
|
}
|
|
2594
2876
|
export interface CursorPaging {
|
|
2595
|
-
/**
|
|
2877
|
+
/**
|
|
2878
|
+
* Maximum number of items to return in the results.
|
|
2879
|
+
* @max 100
|
|
2880
|
+
*/
|
|
2596
2881
|
limit?: number | null;
|
|
2597
2882
|
/**
|
|
2598
2883
|
* Pointer to the next or previous page in the list of results.
|
|
2599
2884
|
*
|
|
2600
2885
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
2601
2886
|
* Not relevant for the first request.
|
|
2887
|
+
* @maxLength 16000
|
|
2602
2888
|
*/
|
|
2603
2889
|
cursor?: string | null;
|
|
2604
2890
|
}
|
|
@@ -2621,15 +2907,25 @@ export interface PagingMetadataV2 {
|
|
|
2621
2907
|
cursors?: Cursors;
|
|
2622
2908
|
}
|
|
2623
2909
|
export interface Cursors {
|
|
2624
|
-
/**
|
|
2910
|
+
/**
|
|
2911
|
+
* Cursor string pointing to the next page in the list of results.
|
|
2912
|
+
* @maxLength 16000
|
|
2913
|
+
*/
|
|
2625
2914
|
next?: string | null;
|
|
2626
|
-
/**
|
|
2915
|
+
/**
|
|
2916
|
+
* Cursor pointing to the previous page in the list of results.
|
|
2917
|
+
* @maxLength 16000
|
|
2918
|
+
*/
|
|
2627
2919
|
prev?: string | null;
|
|
2628
2920
|
}
|
|
2629
2921
|
export interface CountEventsByStatusRequest {
|
|
2630
2922
|
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
|
|
2631
2923
|
filter?: Record<string, any> | null;
|
|
2632
|
-
/**
|
|
2924
|
+
/**
|
|
2925
|
+
* Parameters to count events by.
|
|
2926
|
+
* @maxLength 100
|
|
2927
|
+
* @maxSize 20
|
|
2928
|
+
*/
|
|
2633
2929
|
facet?: string[];
|
|
2634
2930
|
/**
|
|
2635
2931
|
* Whether draft events should be returned in the response. <br>
|
|
@@ -2653,22 +2949,35 @@ export interface ListUserEventsRequest {
|
|
|
2653
2949
|
/**
|
|
2654
2950
|
* Sort order, defaults to `"created:asc"`.
|
|
2655
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
|
|
2656
2953
|
*/
|
|
2657
2954
|
sort?: CommonSorting[];
|
|
2658
|
-
/**
|
|
2955
|
+
/**
|
|
2956
|
+
* Event status.
|
|
2957
|
+
* @maxSize 20
|
|
2958
|
+
*/
|
|
2659
2959
|
status?: Status[];
|
|
2660
2960
|
/** Allows to filter events by user relation to the event among all wix sites. */
|
|
2661
2961
|
userFilter?: UserFilter;
|
|
2662
2962
|
/**
|
|
2663
2963
|
* Filter facets to include in the response.
|
|
2664
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
|
|
2665
2967
|
*/
|
|
2666
2968
|
facet?: string[];
|
|
2667
2969
|
}
|
|
2668
2970
|
export interface UserFilter {
|
|
2669
|
-
/**
|
|
2971
|
+
/**
|
|
2972
|
+
* User who is related to event
|
|
2973
|
+
* @format GUID
|
|
2974
|
+
*/
|
|
2670
2975
|
userId?: string;
|
|
2671
|
-
/**
|
|
2976
|
+
/**
|
|
2977
|
+
* Relation of user to event.
|
|
2978
|
+
* @minSize 1
|
|
2979
|
+
* @maxSize 20
|
|
2980
|
+
*/
|
|
2672
2981
|
relation?: Relation[];
|
|
2673
2982
|
}
|
|
2674
2983
|
export declare enum Relation {
|
|
@@ -2684,11 +2993,17 @@ export interface ListUserEventsResponse {
|
|
|
2684
2993
|
facets?: Record<string, FacetCounts>;
|
|
2685
2994
|
}
|
|
2686
2995
|
export interface ListEventsByCategoryRequest {
|
|
2687
|
-
/**
|
|
2996
|
+
/**
|
|
2997
|
+
* Category ID.
|
|
2998
|
+
* @format GUID
|
|
2999
|
+
*/
|
|
2688
3000
|
categoryId?: string;
|
|
2689
3001
|
/** Paging options to limit and skip the number of items. */
|
|
2690
3002
|
paging?: CommonPaging;
|
|
2691
|
-
/**
|
|
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
|
+
*/
|
|
2692
3007
|
fields?: RequestedFields[];
|
|
2693
3008
|
}
|
|
2694
3009
|
export interface ListEventsByCategoryResponse {
|
|
@@ -2698,9 +3013,15 @@ export interface ListEventsByCategoryResponse {
|
|
|
2698
3013
|
events?: V3Event[];
|
|
2699
3014
|
}
|
|
2700
3015
|
export interface GetEventRequest {
|
|
2701
|
-
/**
|
|
3016
|
+
/**
|
|
3017
|
+
* Event ID.
|
|
3018
|
+
* @format GUID
|
|
3019
|
+
*/
|
|
2702
3020
|
eventId: string | null;
|
|
2703
|
-
/**
|
|
3021
|
+
/**
|
|
3022
|
+
* Predefined sets of fields to return.
|
|
3023
|
+
* @maxSize 20
|
|
3024
|
+
*/
|
|
2704
3025
|
fields?: RequestedFields[];
|
|
2705
3026
|
}
|
|
2706
3027
|
export interface GetEventResponse {
|
|
@@ -2708,8 +3029,13 @@ export interface GetEventResponse {
|
|
|
2708
3029
|
event?: V3Event;
|
|
2709
3030
|
}
|
|
2710
3031
|
export interface GetEventBySlugRequest {
|
|
2711
|
-
/**
|
|
3032
|
+
/**
|
|
3033
|
+
* URL slug.
|
|
3034
|
+
* @minLength 1
|
|
3035
|
+
* @maxLength 130
|
|
3036
|
+
*/
|
|
2712
3037
|
slug: string | null;
|
|
3038
|
+
/** @maxSize 20 */
|
|
2713
3039
|
fields?: RequestedFields[];
|
|
2714
3040
|
}
|
|
2715
3041
|
export interface GetEventBySlugResponse {
|
|
@@ -2717,18 +3043,35 @@ export interface GetEventBySlugResponse {
|
|
|
2717
3043
|
event?: V3Event;
|
|
2718
3044
|
}
|
|
2719
3045
|
export interface FindEventRequest extends FindEventRequestFindByOneOf {
|
|
2720
|
-
/**
|
|
3046
|
+
/**
|
|
3047
|
+
* Event ID.
|
|
3048
|
+
* @format GUID
|
|
3049
|
+
*/
|
|
2721
3050
|
eventId?: string | null;
|
|
2722
|
-
/**
|
|
3051
|
+
/**
|
|
3052
|
+
* URL slug.
|
|
3053
|
+
* @minLength 1
|
|
3054
|
+
* @maxLength 130
|
|
3055
|
+
*/
|
|
2723
3056
|
slug?: string | null;
|
|
2724
|
-
/**
|
|
3057
|
+
/**
|
|
3058
|
+
* Predefined sets of fields to return.
|
|
3059
|
+
* @maxSize 20
|
|
3060
|
+
*/
|
|
2725
3061
|
fields?: RequestedFields[];
|
|
2726
3062
|
}
|
|
2727
3063
|
/** @oneof */
|
|
2728
3064
|
export interface FindEventRequestFindByOneOf {
|
|
2729
|
-
/**
|
|
3065
|
+
/**
|
|
3066
|
+
* Event ID.
|
|
3067
|
+
* @format GUID
|
|
3068
|
+
*/
|
|
2730
3069
|
eventId?: string | null;
|
|
2731
|
-
/**
|
|
3070
|
+
/**
|
|
3071
|
+
* URL slug.
|
|
3072
|
+
* @minLength 1
|
|
3073
|
+
* @maxLength 130
|
|
3074
|
+
*/
|
|
2732
3075
|
slug?: string | null;
|
|
2733
3076
|
}
|
|
2734
3077
|
export interface FindEventResponse {
|
|
@@ -2738,7 +3081,10 @@ export interface FindEventResponse {
|
|
|
2738
3081
|
export interface EventCreated {
|
|
2739
3082
|
/** Event created timestamp in ISO UTC format. */
|
|
2740
3083
|
timestamp?: Date | null;
|
|
2741
|
-
/**
|
|
3084
|
+
/**
|
|
3085
|
+
* Event ID.
|
|
3086
|
+
* @format GUID
|
|
3087
|
+
*/
|
|
2742
3088
|
eventId?: string;
|
|
2743
3089
|
/** Event location. */
|
|
2744
3090
|
location?: EventsLocation;
|
|
@@ -2746,23 +3092,38 @@ export interface EventCreated {
|
|
|
2746
3092
|
scheduleConfig?: ScheduleConfig;
|
|
2747
3093
|
/** Event title. */
|
|
2748
3094
|
title?: string;
|
|
2749
|
-
/**
|
|
3095
|
+
/**
|
|
3096
|
+
* Event creator user ID.
|
|
3097
|
+
* @maxLength 36
|
|
3098
|
+
*/
|
|
2750
3099
|
userId?: string | null;
|
|
2751
3100
|
/** Event status. */
|
|
2752
3101
|
status?: EventStatus;
|
|
2753
|
-
/**
|
|
3102
|
+
/**
|
|
3103
|
+
* Instance ID. Indicates the original app instance which current event was derived from.
|
|
3104
|
+
* @format GUID
|
|
3105
|
+
*/
|
|
2754
3106
|
derivedFromInstanceId?: string | null;
|
|
2755
|
-
/**
|
|
3107
|
+
/**
|
|
3108
|
+
* Event ID. Indicates the original event which current event was derived from.
|
|
3109
|
+
* @format GUID
|
|
3110
|
+
*/
|
|
2756
3111
|
derivedFromEventId?: string | null;
|
|
2757
3112
|
/** Event that was created. */
|
|
2758
3113
|
event?: Event;
|
|
2759
3114
|
}
|
|
2760
3115
|
export interface EventsLocation {
|
|
2761
|
-
/**
|
|
3116
|
+
/**
|
|
3117
|
+
* Location name.
|
|
3118
|
+
* @maxLength 50
|
|
3119
|
+
*/
|
|
2762
3120
|
name?: string | null;
|
|
2763
3121
|
/** Location map coordinates. */
|
|
2764
3122
|
coordinates?: MapCoordinates;
|
|
2765
|
-
/**
|
|
3123
|
+
/**
|
|
3124
|
+
* Single line address representation.
|
|
3125
|
+
* @maxLength 300
|
|
3126
|
+
*/
|
|
2766
3127
|
address?: string | null;
|
|
2767
3128
|
/** Location type. */
|
|
2768
3129
|
type?: LocationLocationType;
|
|
@@ -2784,9 +3145,17 @@ export interface EventsLocation {
|
|
|
2784
3145
|
tbd?: boolean | null;
|
|
2785
3146
|
}
|
|
2786
3147
|
export interface MapCoordinates {
|
|
2787
|
-
/**
|
|
3148
|
+
/**
|
|
3149
|
+
* Latitude.
|
|
3150
|
+
* @min -90
|
|
3151
|
+
* @max 90
|
|
3152
|
+
*/
|
|
2788
3153
|
lat?: number;
|
|
2789
|
-
/**
|
|
3154
|
+
/**
|
|
3155
|
+
* Longitude.
|
|
3156
|
+
* @min -180
|
|
3157
|
+
* @max 180
|
|
3158
|
+
*/
|
|
2790
3159
|
lng?: number;
|
|
2791
3160
|
}
|
|
2792
3161
|
export declare enum LocationLocationType {
|
|
@@ -2799,7 +3168,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
2799
3168
|
streetAddress?: StreetAddress;
|
|
2800
3169
|
/** Main address line (usually street and number) as free text */
|
|
2801
3170
|
addressLine1?: string | null;
|
|
2802
|
-
/**
|
|
3171
|
+
/**
|
|
3172
|
+
* country code
|
|
3173
|
+
* @format COUNTRY
|
|
3174
|
+
*/
|
|
2803
3175
|
country?: string | null;
|
|
2804
3176
|
/** subdivision (usually state or region) code according to ISO 3166-2 */
|
|
2805
3177
|
subdivision?: string | null;
|
|
@@ -2815,7 +3187,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
2815
3187
|
location?: AddressLocation;
|
|
2816
3188
|
/** country full-name */
|
|
2817
3189
|
countryFullname?: string | null;
|
|
2818
|
-
/**
|
|
3190
|
+
/**
|
|
3191
|
+
* multi-level subdivisions from top to bottom
|
|
3192
|
+
* @maxSize 6
|
|
3193
|
+
*/
|
|
2819
3194
|
subdivisions?: Subdivision[];
|
|
2820
3195
|
}
|
|
2821
3196
|
/** @oneof */
|
|
@@ -2832,9 +3207,17 @@ export interface StreetAddress {
|
|
|
2832
3207
|
name?: string;
|
|
2833
3208
|
}
|
|
2834
3209
|
export interface AddressLocation {
|
|
2835
|
-
/**
|
|
3210
|
+
/**
|
|
3211
|
+
* address latitude coordinates
|
|
3212
|
+
* @min -90
|
|
3213
|
+
* @max 90
|
|
3214
|
+
*/
|
|
2836
3215
|
latitude?: number | null;
|
|
2837
|
-
/**
|
|
3216
|
+
/**
|
|
3217
|
+
* address longitude coordinates
|
|
3218
|
+
* @min -180
|
|
3219
|
+
* @max 180
|
|
3220
|
+
*/
|
|
2838
3221
|
longitude?: number | null;
|
|
2839
3222
|
}
|
|
2840
3223
|
export interface Subdivision {
|
|
@@ -2865,13 +3248,19 @@ export interface ScheduleConfig {
|
|
|
2865
3248
|
* `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
|
|
2866
3249
|
*/
|
|
2867
3250
|
scheduleTbd?: boolean;
|
|
2868
|
-
/**
|
|
3251
|
+
/**
|
|
3252
|
+
* TBD message.
|
|
3253
|
+
* @maxLength 100
|
|
3254
|
+
*/
|
|
2869
3255
|
scheduleTbdMessage?: string | null;
|
|
2870
3256
|
/** Event start timestamp. */
|
|
2871
3257
|
startDate?: Date | null;
|
|
2872
3258
|
/** Event end timestamp. */
|
|
2873
3259
|
endDate?: Date | null;
|
|
2874
|
-
/**
|
|
3260
|
+
/**
|
|
3261
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
3262
|
+
* @maxLength 100
|
|
3263
|
+
*/
|
|
2875
3264
|
timeZoneId?: string | null;
|
|
2876
3265
|
/** Whether end date is hidden in the formatted schedule. */
|
|
2877
3266
|
endDateHidden?: boolean;
|
|
@@ -2881,7 +3270,10 @@ export interface ScheduleConfig {
|
|
|
2881
3270
|
recurrences?: EventsRecurrences;
|
|
2882
3271
|
}
|
|
2883
3272
|
export interface EventsRecurrences {
|
|
2884
|
-
/**
|
|
3273
|
+
/**
|
|
3274
|
+
* Event occurrences.
|
|
3275
|
+
* @maxSize 1000
|
|
3276
|
+
*/
|
|
2885
3277
|
occurrences?: EventsOccurrence[];
|
|
2886
3278
|
/**
|
|
2887
3279
|
* Recurring event category ID.
|
|
@@ -2899,7 +3291,10 @@ export interface EventsOccurrence {
|
|
|
2899
3291
|
startDate?: Date | null;
|
|
2900
3292
|
/** Event end timestamp. */
|
|
2901
3293
|
endDate?: Date | null;
|
|
2902
|
-
/**
|
|
3294
|
+
/**
|
|
3295
|
+
* Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
3296
|
+
* @maxLength 100
|
|
3297
|
+
*/
|
|
2903
3298
|
timeZoneId?: string | null;
|
|
2904
3299
|
/** Whether time zone is displayed in formatted schedule. */
|
|
2905
3300
|
showTimeZone?: boolean;
|
|
@@ -2929,6 +3324,7 @@ export declare enum EventStatus {
|
|
|
2929
3324
|
export interface Event {
|
|
2930
3325
|
/**
|
|
2931
3326
|
* Event ID.
|
|
3327
|
+
* @format GUID
|
|
2932
3328
|
* @readonly
|
|
2933
3329
|
*/
|
|
2934
3330
|
_id?: string;
|
|
@@ -2968,7 +3364,10 @@ export interface Event {
|
|
|
2968
3364
|
instanceId?: string;
|
|
2969
3365
|
/** Guest list configuration. */
|
|
2970
3366
|
guestListConfig?: GuestListConfig;
|
|
2971
|
-
/**
|
|
3367
|
+
/**
|
|
3368
|
+
* Event creator user ID.
|
|
3369
|
+
* @maxLength 36
|
|
3370
|
+
*/
|
|
2972
3371
|
userId?: string;
|
|
2973
3372
|
/** Event discussion feed. For internal use. */
|
|
2974
3373
|
feed?: EventsFeed;
|
|
@@ -3123,17 +3522,31 @@ export interface TicketingConfig {
|
|
|
3123
3522
|
guestAssignedTickets?: boolean;
|
|
3124
3523
|
/** Tax configuration. */
|
|
3125
3524
|
taxConfig?: TaxConfig;
|
|
3126
|
-
/**
|
|
3525
|
+
/**
|
|
3526
|
+
* Limit of tickets that can be purchased per order, default 20.
|
|
3527
|
+
* @max 50
|
|
3528
|
+
*/
|
|
3127
3529
|
ticketLimitPerOrder?: number;
|
|
3128
|
-
/**
|
|
3530
|
+
/**
|
|
3531
|
+
* Duration for which the tickets being bought are reserved.
|
|
3532
|
+
* @min 5
|
|
3533
|
+
* @max 30
|
|
3534
|
+
*/
|
|
3129
3535
|
reservationDurationInMinutes?: number | null;
|
|
3130
3536
|
}
|
|
3131
3537
|
export interface TaxConfig {
|
|
3132
3538
|
/** Tax application settings. */
|
|
3133
3539
|
type?: EventsTaxType;
|
|
3134
|
-
/**
|
|
3540
|
+
/**
|
|
3541
|
+
* Tax name.
|
|
3542
|
+
* @minLength 1
|
|
3543
|
+
* @maxLength 10
|
|
3544
|
+
*/
|
|
3135
3545
|
name?: string | null;
|
|
3136
|
-
/**
|
|
3546
|
+
/**
|
|
3547
|
+
* Tax rate (e.g.,`21.55`).
|
|
3548
|
+
* @decimalValue options - {gte:0.001,lte:100,maxScale:3}
|
|
3549
|
+
*/
|
|
3137
3550
|
rate?: string | null;
|
|
3138
3551
|
/** Applies taxes for donations, default true. */
|
|
3139
3552
|
appliesToDonations?: boolean | null;
|
|
@@ -3226,7 +3639,10 @@ export interface OnlineConferencingConfig {
|
|
|
3226
3639
|
* When enabled, links to join conferencing are generated and provided to guests.
|
|
3227
3640
|
*/
|
|
3228
3641
|
enabled?: boolean;
|
|
3229
|
-
/**
|
|
3642
|
+
/**
|
|
3643
|
+
* Conferencing provider ID.
|
|
3644
|
+
* @format GUID
|
|
3645
|
+
*/
|
|
3230
3646
|
providerId?: string | null;
|
|
3231
3647
|
/** Conference type */
|
|
3232
3648
|
conferenceType?: ConferenceType;
|
|
@@ -3265,7 +3681,10 @@ export interface EventsOnlineConferencingSession {
|
|
|
3265
3681
|
sessionId?: string | null;
|
|
3266
3682
|
}
|
|
3267
3683
|
export interface EventsSeoSettings {
|
|
3268
|
-
/**
|
|
3684
|
+
/**
|
|
3685
|
+
* URL slug
|
|
3686
|
+
* @maxLength 130
|
|
3687
|
+
*/
|
|
3269
3688
|
slug?: string;
|
|
3270
3689
|
/** Advanced SEO data */
|
|
3271
3690
|
advancedSeoData?: SeoSchema;
|
|
@@ -3287,10 +3706,15 @@ export interface Agenda {
|
|
|
3287
3706
|
export interface Category {
|
|
3288
3707
|
/**
|
|
3289
3708
|
* Category ID.
|
|
3709
|
+
* @format GUID
|
|
3290
3710
|
* @readonly
|
|
3291
3711
|
*/
|
|
3292
3712
|
_id?: string;
|
|
3293
|
-
/**
|
|
3713
|
+
/**
|
|
3714
|
+
* Category name.
|
|
3715
|
+
* @minLength 1
|
|
3716
|
+
* @maxLength 30
|
|
3717
|
+
*/
|
|
3294
3718
|
name?: string;
|
|
3295
3719
|
/**
|
|
3296
3720
|
* Date and time when category was created.
|
|
@@ -3313,6 +3737,7 @@ export interface Category {
|
|
|
3313
3737
|
* Default: `MANUAL`.
|
|
3314
3738
|
*
|
|
3315
3739
|
* **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
|
|
3740
|
+
* @maxSize 3
|
|
3316
3741
|
*/
|
|
3317
3742
|
states?: State[];
|
|
3318
3743
|
}
|
|
@@ -3345,7 +3770,10 @@ export interface Empty {
|
|
|
3345
3770
|
export interface EventUpdated {
|
|
3346
3771
|
/** Event update timestamp in ISO UTC format. */
|
|
3347
3772
|
timestamp?: Date | null;
|
|
3348
|
-
/**
|
|
3773
|
+
/**
|
|
3774
|
+
* Event ID.
|
|
3775
|
+
* @format GUID
|
|
3776
|
+
*/
|
|
3349
3777
|
eventId?: string;
|
|
3350
3778
|
/** Event location. */
|
|
3351
3779
|
location?: EventsLocation;
|
|
@@ -3364,17 +3792,26 @@ export interface EventUpdated {
|
|
|
3364
3792
|
export interface EventDeleted {
|
|
3365
3793
|
/** Event deleted timestamp in ISO UTC format. */
|
|
3366
3794
|
timestamp?: Date | null;
|
|
3367
|
-
/**
|
|
3795
|
+
/**
|
|
3796
|
+
* Event ID.
|
|
3797
|
+
* @format GUID
|
|
3798
|
+
*/
|
|
3368
3799
|
eventId?: string;
|
|
3369
3800
|
/** Event title. */
|
|
3370
3801
|
title?: string;
|
|
3371
|
-
/**
|
|
3802
|
+
/**
|
|
3803
|
+
* Event creator user ID.
|
|
3804
|
+
* @format GUID
|
|
3805
|
+
*/
|
|
3372
3806
|
userId?: string | null;
|
|
3373
3807
|
}
|
|
3374
3808
|
export interface EventCopied {
|
|
3375
3809
|
/** Event created timestamp in ISO UTC format. */
|
|
3376
3810
|
timestamp?: Date | null;
|
|
3377
|
-
/**
|
|
3811
|
+
/**
|
|
3812
|
+
* Event ID.
|
|
3813
|
+
* @format GUID
|
|
3814
|
+
*/
|
|
3378
3815
|
eventId?: string;
|
|
3379
3816
|
/** Event location. */
|
|
3380
3817
|
location?: EventsLocation;
|
|
@@ -3382,13 +3819,22 @@ export interface EventCopied {
|
|
|
3382
3819
|
scheduleConfig?: ScheduleConfig;
|
|
3383
3820
|
/** Event title. */
|
|
3384
3821
|
title?: string;
|
|
3385
|
-
/**
|
|
3822
|
+
/**
|
|
3823
|
+
* Event creator user ID.
|
|
3824
|
+
* @format GUID
|
|
3825
|
+
*/
|
|
3386
3826
|
userId?: string | null;
|
|
3387
3827
|
/** Event status. */
|
|
3388
3828
|
status?: EventStatus;
|
|
3389
|
-
/**
|
|
3829
|
+
/**
|
|
3830
|
+
* Instance ID. Indicates the original app instance which current event was derived from.
|
|
3831
|
+
* @format GUID
|
|
3832
|
+
*/
|
|
3390
3833
|
derivedFromInstanceId?: string | null;
|
|
3391
|
-
/**
|
|
3834
|
+
/**
|
|
3835
|
+
* Event ID. Indicates the original event which current event was derived from.
|
|
3836
|
+
* @format GUID
|
|
3837
|
+
*/
|
|
3392
3838
|
derivedFromEventId?: string | null;
|
|
3393
3839
|
/**
|
|
3394
3840
|
* Map of copied ticket definitions from original event.
|
|
@@ -3400,7 +3846,10 @@ export interface EventCopied {
|
|
|
3400
3846
|
export interface EventPublished {
|
|
3401
3847
|
/** Event publish timestamp in ISO UTC format. */
|
|
3402
3848
|
timestamp?: Date | null;
|
|
3403
|
-
/**
|
|
3849
|
+
/**
|
|
3850
|
+
* Event ID.
|
|
3851
|
+
* @format GUID
|
|
3852
|
+
*/
|
|
3404
3853
|
eventId?: string;
|
|
3405
3854
|
/** Event status. */
|
|
3406
3855
|
status?: EventStatus;
|
|
@@ -3425,29 +3874,44 @@ export interface EventPublished {
|
|
|
3425
3874
|
export interface EventCanceled {
|
|
3426
3875
|
/** Event canceled timestamp in ISO UTC format. */
|
|
3427
3876
|
timestamp?: Date | null;
|
|
3428
|
-
/**
|
|
3877
|
+
/**
|
|
3878
|
+
* Event ID.
|
|
3879
|
+
* @format GUID
|
|
3880
|
+
*/
|
|
3429
3881
|
eventId?: string;
|
|
3430
3882
|
/** Event title */
|
|
3431
3883
|
title?: string;
|
|
3432
|
-
/**
|
|
3884
|
+
/**
|
|
3885
|
+
* Event creator user ID.
|
|
3886
|
+
* @format GUID
|
|
3887
|
+
*/
|
|
3433
3888
|
userId?: string | null;
|
|
3434
3889
|
}
|
|
3435
3890
|
export interface EventStarted {
|
|
3436
3891
|
/** Event start timestamp in ISO UTC format. */
|
|
3437
3892
|
timestamp?: Date | null;
|
|
3438
|
-
/**
|
|
3893
|
+
/**
|
|
3894
|
+
* Event ID.
|
|
3895
|
+
* @format GUID
|
|
3896
|
+
*/
|
|
3439
3897
|
eventId?: string;
|
|
3440
3898
|
}
|
|
3441
3899
|
export interface EventEnded {
|
|
3442
3900
|
/** Event end timestamp in ISO UTC format. */
|
|
3443
3901
|
timestamp?: Date | null;
|
|
3444
|
-
/**
|
|
3902
|
+
/**
|
|
3903
|
+
* Event ID.
|
|
3904
|
+
* @format GUID
|
|
3905
|
+
*/
|
|
3445
3906
|
eventId?: string;
|
|
3446
3907
|
}
|
|
3447
3908
|
export interface EventReminder {
|
|
3448
3909
|
/** Reminder timestamp in ISO UTC format. */
|
|
3449
3910
|
timestamp?: Date | null;
|
|
3450
|
-
/**
|
|
3911
|
+
/**
|
|
3912
|
+
* Event ID.
|
|
3913
|
+
* @format GUID
|
|
3914
|
+
*/
|
|
3451
3915
|
eventId?: string;
|
|
3452
3916
|
/** Event location. */
|
|
3453
3917
|
location?: EventsLocation;
|
|
@@ -3455,7 +3919,10 @@ export interface EventReminder {
|
|
|
3455
3919
|
scheduleConfig?: ScheduleConfig;
|
|
3456
3920
|
/** Event title. */
|
|
3457
3921
|
title?: string;
|
|
3458
|
-
/**
|
|
3922
|
+
/**
|
|
3923
|
+
* Event creator user ID.
|
|
3924
|
+
* @format GUID
|
|
3925
|
+
*/
|
|
3459
3926
|
userId?: string | null;
|
|
3460
3927
|
/** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
|
|
3461
3928
|
startsIn?: TimeDuration;
|
|
@@ -3531,9 +3998,15 @@ export interface ActionEvent {
|
|
|
3531
3998
|
body?: string;
|
|
3532
3999
|
}
|
|
3533
4000
|
export interface MessageEnvelope {
|
|
3534
|
-
/**
|
|
4001
|
+
/**
|
|
4002
|
+
* App instance ID.
|
|
4003
|
+
* @format GUID
|
|
4004
|
+
*/
|
|
3535
4005
|
instanceId?: string | null;
|
|
3536
|
-
/**
|
|
4006
|
+
/**
|
|
4007
|
+
* Event type.
|
|
4008
|
+
* @maxLength 150
|
|
4009
|
+
*/
|
|
3537
4010
|
eventType?: string;
|
|
3538
4011
|
/** The identification type and identity data. */
|
|
3539
4012
|
identity?: IdentificationData;
|
|
@@ -3541,26 +4014,50 @@ export interface MessageEnvelope {
|
|
|
3541
4014
|
data?: string;
|
|
3542
4015
|
}
|
|
3543
4016
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3544
|
-
/**
|
|
4017
|
+
/**
|
|
4018
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4019
|
+
* @format GUID
|
|
4020
|
+
*/
|
|
3545
4021
|
anonymousVisitorId?: string;
|
|
3546
|
-
/**
|
|
4022
|
+
/**
|
|
4023
|
+
* ID of a site visitor that has logged in to the site.
|
|
4024
|
+
* @format GUID
|
|
4025
|
+
*/
|
|
3547
4026
|
memberId?: string;
|
|
3548
|
-
/**
|
|
4027
|
+
/**
|
|
4028
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4029
|
+
* @format GUID
|
|
4030
|
+
*/
|
|
3549
4031
|
wixUserId?: string;
|
|
3550
|
-
/**
|
|
4032
|
+
/**
|
|
4033
|
+
* ID of an app.
|
|
4034
|
+
* @format GUID
|
|
4035
|
+
*/
|
|
3551
4036
|
appId?: string;
|
|
3552
4037
|
/** @readonly */
|
|
3553
4038
|
identityType?: WebhookIdentityType;
|
|
3554
4039
|
}
|
|
3555
4040
|
/** @oneof */
|
|
3556
4041
|
export interface IdentificationDataIdOneOf {
|
|
3557
|
-
/**
|
|
4042
|
+
/**
|
|
4043
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4044
|
+
* @format GUID
|
|
4045
|
+
*/
|
|
3558
4046
|
anonymousVisitorId?: string;
|
|
3559
|
-
/**
|
|
4047
|
+
/**
|
|
4048
|
+
* ID of a site visitor that has logged in to the site.
|
|
4049
|
+
* @format GUID
|
|
4050
|
+
*/
|
|
3560
4051
|
memberId?: string;
|
|
3561
|
-
/**
|
|
4052
|
+
/**
|
|
4053
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4054
|
+
* @format GUID
|
|
4055
|
+
*/
|
|
3562
4056
|
wixUserId?: string;
|
|
3563
|
-
/**
|
|
4057
|
+
/**
|
|
4058
|
+
* ID of an app.
|
|
4059
|
+
* @format GUID
|
|
4060
|
+
*/
|
|
3564
4061
|
appId?: string;
|
|
3565
4062
|
}
|
|
3566
4063
|
export declare enum WebhookIdentityType {
|
|
@@ -4082,9 +4579,15 @@ export interface GetEventBySlugResponseNonNullableFields {
|
|
|
4082
4579
|
event?: V3EventNonNullableFields;
|
|
4083
4580
|
}
|
|
4084
4581
|
export interface BaseEventMetadata {
|
|
4085
|
-
/**
|
|
4582
|
+
/**
|
|
4583
|
+
* App instance ID.
|
|
4584
|
+
* @format GUID
|
|
4585
|
+
*/
|
|
4086
4586
|
instanceId?: string | null;
|
|
4087
|
-
/**
|
|
4587
|
+
/**
|
|
4588
|
+
* Event type.
|
|
4589
|
+
* @maxLength 150
|
|
4590
|
+
*/
|
|
4088
4591
|
eventType?: string;
|
|
4089
4592
|
/** The identification type and identity data. */
|
|
4090
4593
|
identity?: IdentificationData;
|
|
@@ -4149,6 +4652,8 @@ export interface EventCanceledEnvelope {
|
|
|
4149
4652
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4150
4653
|
* @permissionScope Manage Restaurants - all permissions
|
|
4151
4654
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4655
|
+
* @permissionScope Set Up Automations
|
|
4656
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4152
4657
|
* @permissionScope Manage Guest List
|
|
4153
4658
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4154
4659
|
* @permissionScope Manage Events
|
|
@@ -4181,6 +4686,8 @@ export interface EventClonedEnvelope {
|
|
|
4181
4686
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4182
4687
|
* @permissionScope Manage Restaurants - all permissions
|
|
4183
4688
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4689
|
+
* @permissionScope Set Up Automations
|
|
4690
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4184
4691
|
* @permissionScope Manage Guest List
|
|
4185
4692
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4186
4693
|
* @permissionScope Manage Events
|
|
@@ -4213,6 +4720,8 @@ export interface EventCreatedEnvelope {
|
|
|
4213
4720
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4214
4721
|
* @permissionScope Manage Restaurants - all permissions
|
|
4215
4722
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4723
|
+
* @permissionScope Set Up Automations
|
|
4724
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4216
4725
|
* @permissionScope Manage Guest List
|
|
4217
4726
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4218
4727
|
* @permissionScope Manage Events
|
|
@@ -4244,6 +4753,8 @@ export interface EventDeletedEnvelope {
|
|
|
4244
4753
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4245
4754
|
* @permissionScope Manage Restaurants - all permissions
|
|
4246
4755
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4756
|
+
* @permissionScope Set Up Automations
|
|
4757
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4247
4758
|
* @permissionScope Manage Guest List
|
|
4248
4759
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4249
4760
|
* @permissionScope Manage Events
|
|
@@ -4276,6 +4787,8 @@ export interface EventEndedEnvelope {
|
|
|
4276
4787
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4277
4788
|
* @permissionScope Manage Restaurants - all permissions
|
|
4278
4789
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4790
|
+
* @permissionScope Set Up Automations
|
|
4791
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4279
4792
|
* @permissionScope Manage Guest List
|
|
4280
4793
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4281
4794
|
* @permissionScope Manage Events
|
|
@@ -4308,6 +4821,8 @@ export interface EventPublishedEnvelope {
|
|
|
4308
4821
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4309
4822
|
* @permissionScope Manage Restaurants - all permissions
|
|
4310
4823
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4824
|
+
* @permissionScope Set Up Automations
|
|
4825
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4311
4826
|
* @permissionScope Manage Guest List
|
|
4312
4827
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4313
4828
|
* @permissionScope Manage Events
|
|
@@ -4346,6 +4861,8 @@ export interface EventReminderEnvelope {
|
|
|
4346
4861
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4347
4862
|
* @permissionScope Manage Restaurants - all permissions
|
|
4348
4863
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4864
|
+
* @permissionScope Set Up Automations
|
|
4865
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4349
4866
|
* @permissionScope Manage Guest List
|
|
4350
4867
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4351
4868
|
* @permissionScope Manage Events
|
|
@@ -4378,6 +4895,8 @@ export interface EventStartedEnvelope {
|
|
|
4378
4895
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4379
4896
|
* @permissionScope Manage Restaurants - all permissions
|
|
4380
4897
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4898
|
+
* @permissionScope Set Up Automations
|
|
4899
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4381
4900
|
* @permissionScope Manage Guest List
|
|
4382
4901
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4383
4902
|
* @permissionScope Manage Events
|
|
@@ -4410,6 +4929,8 @@ export interface EventUpdatedEnvelope {
|
|
|
4410
4929
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4411
4930
|
* @permissionScope Manage Restaurants - all permissions
|
|
4412
4931
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4932
|
+
* @permissionScope Set Up Automations
|
|
4933
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4413
4934
|
* @permissionScope Manage Guest List
|
|
4414
4935
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4415
4936
|
* @permissionScope Manage Events
|
|
@@ -4452,7 +4973,10 @@ export declare function createEvent(event: V3Event, options?: CreateEventOptions
|
|
|
4452
4973
|
export interface CreateEventOptions {
|
|
4453
4974
|
/** Whether to create the event as a draft. */
|
|
4454
4975
|
draft?: boolean;
|
|
4455
|
-
/**
|
|
4976
|
+
/**
|
|
4977
|
+
* Predefined sets of fields to return.
|
|
4978
|
+
* @maxSize 20
|
|
4979
|
+
*/
|
|
4456
4980
|
fields?: RequestedFields[];
|
|
4457
4981
|
}
|
|
4458
4982
|
/**
|
|
@@ -4481,7 +5005,10 @@ export interface CloneEventOptions {
|
|
|
4481
5005
|
event?: V3Event;
|
|
4482
5006
|
/** Whether to clone the event as a draft. */
|
|
4483
5007
|
draft?: boolean;
|
|
4484
|
-
/**
|
|
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
|
+
*/
|
|
4485
5012
|
fields?: RequestedFields[];
|
|
4486
5013
|
}
|
|
4487
5014
|
/**
|
|
@@ -4507,6 +5034,7 @@ export interface UpdateEventOptions {
|
|
|
4507
5034
|
event: {
|
|
4508
5035
|
/**
|
|
4509
5036
|
* Event ID.
|
|
5037
|
+
* @format GUID
|
|
4510
5038
|
* @readonly
|
|
4511
5039
|
*/
|
|
4512
5040
|
_id?: string;
|
|
@@ -4514,12 +5042,20 @@ export interface UpdateEventOptions {
|
|
|
4514
5042
|
location?: Location;
|
|
4515
5043
|
/** Event date and time settings. */
|
|
4516
5044
|
dateAndTimeSettings?: DateAndTimeSettings;
|
|
4517
|
-
/**
|
|
5045
|
+
/**
|
|
5046
|
+
* Event title.
|
|
5047
|
+
* @minLength 1
|
|
5048
|
+
* @maxLength 120
|
|
5049
|
+
*/
|
|
4518
5050
|
title?: string | null;
|
|
4519
|
-
/**
|
|
5051
|
+
/**
|
|
5052
|
+
* Short description that appears under the event title.
|
|
5053
|
+
* @maxLength 500
|
|
5054
|
+
*/
|
|
4520
5055
|
shortDescription?: string | null;
|
|
4521
5056
|
/**
|
|
4522
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
|
|
4523
5059
|
* @deprecated Detailed description of an event.
|
|
4524
5060
|
*
|
|
4525
5061
|
* This field is deprecated.
|
|
@@ -4594,6 +5130,7 @@ export interface UpdateEventOptions {
|
|
|
4594
5130
|
/**
|
|
4595
5131
|
* ID of the user who created the event.
|
|
4596
5132
|
* @readonly
|
|
5133
|
+
* @format GUID
|
|
4597
5134
|
*/
|
|
4598
5135
|
userId?: string;
|
|
4599
5136
|
/**
|
|
@@ -4624,8 +5161,16 @@ export interface UpdateEventOptions {
|
|
|
4624
5161
|
* For the event description to appear on your site, connect the [Rich Content Viewer](https://dev.wix.com/docs/velo/velo-only-apis/$w/rich-content-viewer/introduction) element, and assign the description value to the viewer.
|
|
4625
5162
|
*/
|
|
4626
5163
|
description?: RichContent;
|
|
5164
|
+
/**
|
|
5165
|
+
* Event publish timestamp.
|
|
5166
|
+
* @readonly
|
|
5167
|
+
*/
|
|
5168
|
+
publishedDate?: Date | null;
|
|
4627
5169
|
};
|
|
4628
|
-
/**
|
|
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
|
+
*/
|
|
4629
5174
|
fields?: RequestedFields[];
|
|
4630
5175
|
}
|
|
4631
5176
|
/**
|
|
@@ -4649,7 +5194,10 @@ export interface UpdateEventOptions {
|
|
|
4649
5194
|
*/
|
|
4650
5195
|
export declare function publishDraftEvent(eventId: string, options?: PublishDraftEventOptions): Promise<PublishDraftEventResponse & PublishDraftEventResponseNonNullableFields>;
|
|
4651
5196
|
export interface PublishDraftEventOptions {
|
|
4652
|
-
/**
|
|
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
|
+
*/
|
|
4653
5201
|
fields?: RequestedFields[];
|
|
4654
5202
|
}
|
|
4655
5203
|
/**
|
|
@@ -4674,7 +5222,10 @@ export interface PublishDraftEventOptions {
|
|
|
4674
5222
|
*/
|
|
4675
5223
|
export declare function cancelEvent(eventId: string, options?: CancelEventOptions): Promise<CancelEventResponse & CancelEventResponseNonNullableFields>;
|
|
4676
5224
|
export interface CancelEventOptions {
|
|
4677
|
-
/**
|
|
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
|
+
*/
|
|
4678
5229
|
fields?: RequestedFields[];
|
|
4679
5230
|
}
|
|
4680
5231
|
/**
|
|
@@ -4776,6 +5327,8 @@ export interface BulkDeleteEventsByFilterOptions {
|
|
|
4776
5327
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4777
5328
|
* @permissionScope Manage Restaurants - all permissions
|
|
4778
5329
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
5330
|
+
* @permissionScope Set Up Automations
|
|
5331
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4779
5332
|
* @permissionScope Manage Guest List
|
|
4780
5333
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4781
5334
|
* @permissionScope Manage Events
|
|
@@ -4787,7 +5340,10 @@ export interface BulkDeleteEventsByFilterOptions {
|
|
|
4787
5340
|
*/
|
|
4788
5341
|
export declare function queryEvents(options?: QueryEventsOptions): EventsQueryBuilder;
|
|
4789
5342
|
export interface QueryEventsOptions {
|
|
4790
|
-
/**
|
|
5343
|
+
/**
|
|
5344
|
+
* Predefined sets of fields to return.
|
|
5345
|
+
* @maxSize 20
|
|
5346
|
+
*/
|
|
4791
5347
|
fields?: RequestedFields[] | undefined;
|
|
4792
5348
|
/**
|
|
4793
5349
|
* Whether draft events should be returned in the response. <br>
|
|
@@ -4867,6 +5423,8 @@ export interface EventsQueryBuilder {
|
|
|
4867
5423
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4868
5424
|
* @permissionScope Manage Restaurants - all permissions
|
|
4869
5425
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
5426
|
+
* @permissionScope Set Up Automations
|
|
5427
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4870
5428
|
* @permissionScope Manage Guest List
|
|
4871
5429
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4872
5430
|
* @permissionScope Manage Events
|
|
@@ -4879,7 +5437,11 @@ export declare function countEventsByStatus(options?: CountEventsByStatusOptions
|
|
|
4879
5437
|
export interface CountEventsByStatusOptions {
|
|
4880
5438
|
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
|
|
4881
5439
|
filter?: Record<string, any> | null;
|
|
4882
|
-
/**
|
|
5440
|
+
/**
|
|
5441
|
+
* Parameters to count events by.
|
|
5442
|
+
* @maxLength 100
|
|
5443
|
+
* @maxSize 20
|
|
5444
|
+
*/
|
|
4883
5445
|
facet?: string[];
|
|
4884
5446
|
/**
|
|
4885
5447
|
* Whether draft events should be returned in the response. <br>
|
|
@@ -4910,6 +5472,8 @@ export interface CountEventsByStatusOptions {
|
|
|
4910
5472
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4911
5473
|
* @permissionScope Manage Restaurants - all permissions
|
|
4912
5474
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
5475
|
+
* @permissionScope Set Up Automations
|
|
5476
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4913
5477
|
* @permissionScope Manage Guest List
|
|
4914
5478
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4915
5479
|
* @permissionScope Manage Events
|
|
@@ -4921,7 +5485,10 @@ export interface CountEventsByStatusOptions {
|
|
|
4921
5485
|
*/
|
|
4922
5486
|
export declare function getEvent(eventId: string | null, options?: GetEventOptions): Promise<V3Event & V3EventNonNullableFields>;
|
|
4923
5487
|
export interface GetEventOptions {
|
|
4924
|
-
/**
|
|
5488
|
+
/**
|
|
5489
|
+
* Predefined sets of fields to return.
|
|
5490
|
+
* @maxSize 20
|
|
5491
|
+
*/
|
|
4925
5492
|
fields?: RequestedFields[];
|
|
4926
5493
|
}
|
|
4927
5494
|
/**
|
|
@@ -4950,6 +5517,8 @@ export interface GetEventOptions {
|
|
|
4950
5517
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
4951
5518
|
* @permissionScope Manage Restaurants - all permissions
|
|
4952
5519
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
5520
|
+
* @permissionScope Set Up Automations
|
|
5521
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4953
5522
|
* @permissionScope Manage Guest List
|
|
4954
5523
|
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
4955
5524
|
* @permissionScope Manage Events
|
|
@@ -4960,6 +5529,7 @@ export interface GetEventOptions {
|
|
|
4960
5529
|
*/
|
|
4961
5530
|
export declare function getEventBySlug(slug: string | null, options?: GetEventBySlugOptions): Promise<GetEventBySlugResponse & GetEventBySlugResponseNonNullableFields>;
|
|
4962
5531
|
export interface GetEventBySlugOptions {
|
|
5532
|
+
/** @maxSize 20 */
|
|
4963
5533
|
fields?: RequestedFields[];
|
|
4964
5534
|
}
|
|
4965
5535
|
export {};
|