@wix/auto_sdk_events_guests 1.0.2 → 1.0.3
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-guests-v1-guest-guests.types.d.ts +412 -98
- package/build/cjs/src/events-guests-v1-guest-guests.types.js.map +1 -1
- package/build/cjs/src/events-guests-v1-guest-guests.universal.d.ts +430 -99
- package/build/cjs/src/events-guests-v1-guest-guests.universal.js.map +1 -1
- package/build/es/src/events-guests-v1-guest-guests.types.d.ts +412 -98
- package/build/es/src/events-guests-v1-guest-guests.types.js.map +1 -1
- package/build/es/src/events-guests-v1-guest-guests.universal.d.ts +430 -99
- package/build/es/src/events-guests-v1-guest-guests.universal.js.map +1 -1
- package/build/internal/cjs/src/events-guests-v1-guest-guests.types.d.ts +412 -98
- package/build/internal/cjs/src/events-guests-v1-guest-guests.types.js.map +1 -1
- package/build/internal/cjs/src/events-guests-v1-guest-guests.universal.d.ts +430 -99
- package/build/internal/cjs/src/events-guests-v1-guest-guests.universal.js.map +1 -1
- package/build/internal/es/src/events-guests-v1-guest-guests.types.d.ts +412 -98
- package/build/internal/es/src/events-guests-v1-guest-guests.types.js.map +1 -1
- package/build/internal/es/src/events-guests-v1-guest-guests.universal.d.ts +430 -99
- package/build/internal/es/src/events-guests-v1-guest-guests.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,23 +1,47 @@
|
|
|
1
1
|
export interface EventGuest {
|
|
2
|
-
/**
|
|
2
|
+
/**
|
|
3
|
+
* Guest ID.
|
|
4
|
+
* @format GUID
|
|
5
|
+
*/
|
|
3
6
|
id?: string | null;
|
|
4
|
-
/**
|
|
7
|
+
/**
|
|
8
|
+
* Event ID.
|
|
9
|
+
* @format GUID
|
|
10
|
+
*/
|
|
5
11
|
eventId?: string | null;
|
|
6
|
-
/**
|
|
12
|
+
/**
|
|
13
|
+
* RSVP ID. <br/> <br/> **Note:** Only applicable when `guestType` is `RSVP`.
|
|
14
|
+
* @format GUID
|
|
15
|
+
*/
|
|
7
16
|
rsvpId?: string | null;
|
|
8
|
-
/**
|
|
17
|
+
/**
|
|
18
|
+
* Order number. <br/> <br/> **Note:** Only applicable when `guestType` is `BUYER` or `TICKET_HOLDER`.
|
|
19
|
+
* @maxLength 36
|
|
20
|
+
*/
|
|
9
21
|
orderNumber?: string | null;
|
|
10
|
-
/**
|
|
22
|
+
/**
|
|
23
|
+
* Ticket number. <br/> <br/> **Note:** Only applicable when `guestType` is `TICKET_HOLDER`.
|
|
24
|
+
* @maxLength 36
|
|
25
|
+
*/
|
|
11
26
|
ticketNumber?: string | null;
|
|
12
|
-
/**
|
|
27
|
+
/**
|
|
28
|
+
* List of names, numbers, and definition IDs for each ticket.
|
|
29
|
+
* @maxSize 50
|
|
30
|
+
*/
|
|
13
31
|
tickets?: TicketDetails[];
|
|
14
|
-
/**
|
|
32
|
+
/**
|
|
33
|
+
* Guest's contact ID. See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details.
|
|
34
|
+
* @format GUID
|
|
35
|
+
*/
|
|
15
36
|
contactId?: string | null;
|
|
16
37
|
/** Guest details. <br/> <br/> Returned only when the `guestDetails` fieldset is sent in the request. */
|
|
17
38
|
guestDetails?: GuestDetails;
|
|
18
39
|
/** Attendance status. The attendance status updates based on status values in an RSVP object (for RSVP events) or in an Order object (for ticketed events). For more information read [this article](https://dev.wix.com/docs/rest/business-solutions/events/event-guests/guest-attendance-status-mapping). <br/> <br/> **Note:** For `guestType` `BUYER` or `TICKET_HOLDER` the `IN_WAITLIST` value is not applicable. */
|
|
19
40
|
attendanceStatus?: AttendanceStatus;
|
|
20
|
-
/**
|
|
41
|
+
/**
|
|
42
|
+
* Secondary language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Used when the event ticket should be translated into another language.
|
|
43
|
+
* @format LANGUAGE
|
|
44
|
+
*/
|
|
21
45
|
secondaryLanguageCode?: string | null;
|
|
22
46
|
/** Date and time the guest was created in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
23
47
|
createdDate?: Date | null;
|
|
@@ -25,11 +49,17 @@ export interface EventGuest {
|
|
|
25
49
|
updatedDate?: Date | null;
|
|
26
50
|
/** Date and time of guest's latest attendance status update. */
|
|
27
51
|
attendanceStatusUpdatedDate?: Date | null;
|
|
28
|
-
/**
|
|
52
|
+
/**
|
|
53
|
+
* Site member ID.
|
|
54
|
+
* @format GUID
|
|
55
|
+
*/
|
|
29
56
|
memberId?: string | null;
|
|
30
57
|
/** Guest type. */
|
|
31
58
|
guestType?: GuestType;
|
|
32
|
-
/**
|
|
59
|
+
/**
|
|
60
|
+
* Locale in [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. Used when the event date and time on a ticket should be formatted into another locale.
|
|
61
|
+
* @format LANGUAGE_TAG
|
|
62
|
+
*/
|
|
33
63
|
locale?: string | null;
|
|
34
64
|
/**
|
|
35
65
|
* Number of total guests in an event (registered guests + additional ones).
|
|
@@ -43,24 +73,41 @@ export interface EventGuest {
|
|
|
43
73
|
revision?: string | null;
|
|
44
74
|
}
|
|
45
75
|
export interface TicketDetails {
|
|
46
|
-
/**
|
|
76
|
+
/**
|
|
77
|
+
* Ticket number.
|
|
78
|
+
* @maxLength 36
|
|
79
|
+
*/
|
|
47
80
|
number?: string;
|
|
48
|
-
/**
|
|
81
|
+
/**
|
|
82
|
+
* Ticket definition ID.
|
|
83
|
+
* @format GUID
|
|
84
|
+
*/
|
|
49
85
|
definitionId?: string | null;
|
|
50
|
-
/**
|
|
86
|
+
/**
|
|
87
|
+
* Ticket name.
|
|
88
|
+
* @minLength 1
|
|
89
|
+
* @maxLength 30
|
|
90
|
+
*/
|
|
51
91
|
name?: string | null;
|
|
52
92
|
}
|
|
53
93
|
export interface TicketGuestDetails {
|
|
54
94
|
/** The login details for the guest to access the online conference event. */
|
|
55
95
|
onlineConferencingLogin?: OnlineConferencingLogin;
|
|
56
|
-
/**
|
|
96
|
+
/**
|
|
97
|
+
* First name.
|
|
98
|
+
* @maxLength 255
|
|
99
|
+
*/
|
|
57
100
|
firstName?: string | null;
|
|
58
|
-
/**
|
|
101
|
+
/**
|
|
102
|
+
* Last name.
|
|
103
|
+
* @maxLength 255
|
|
104
|
+
*/
|
|
59
105
|
lastName?: string | null;
|
|
60
106
|
}
|
|
61
107
|
export interface OnlineConferencingLogin {
|
|
62
108
|
/**
|
|
63
109
|
* Link URL to the online conference.
|
|
110
|
+
* @format WEB_URL
|
|
64
111
|
* @readonly
|
|
65
112
|
*/
|
|
66
113
|
link?: string;
|
|
@@ -71,11 +118,20 @@ export interface OnlineConferencingLogin {
|
|
|
71
118
|
password?: string | null;
|
|
72
119
|
}
|
|
73
120
|
export interface GuestDetails {
|
|
74
|
-
/**
|
|
121
|
+
/**
|
|
122
|
+
* Email.
|
|
123
|
+
* @format EMAIL
|
|
124
|
+
*/
|
|
75
125
|
email?: string | null;
|
|
76
|
-
/**
|
|
126
|
+
/**
|
|
127
|
+
* First name.
|
|
128
|
+
* @maxLength 255
|
|
129
|
+
*/
|
|
77
130
|
firstName?: string | null;
|
|
78
|
-
/**
|
|
131
|
+
/**
|
|
132
|
+
* Last name.
|
|
133
|
+
* @maxLength 255
|
|
134
|
+
*/
|
|
79
135
|
lastName?: string | null;
|
|
80
136
|
/** Form response. */
|
|
81
137
|
formResponse?: FormResponse;
|
|
@@ -83,25 +139,47 @@ export interface GuestDetails {
|
|
|
83
139
|
checkedIn?: boolean;
|
|
84
140
|
/** The login details for the guest to access the online conference event. */
|
|
85
141
|
onlineConferencingLogin?: OnlineConferencingLogin;
|
|
86
|
-
/**
|
|
142
|
+
/**
|
|
143
|
+
* Phone extracted from form response. If multiples phone inputs are present, first one is returned.
|
|
144
|
+
* @maxLength 200
|
|
145
|
+
*/
|
|
87
146
|
phone?: string | null;
|
|
88
|
-
/**
|
|
147
|
+
/**
|
|
148
|
+
* Address extracted from form response. If multiples address inputs are present, first one is returned.
|
|
149
|
+
* @maxLength 200
|
|
150
|
+
*/
|
|
89
151
|
address?: string | null;
|
|
90
152
|
}
|
|
91
153
|
export interface FormResponse {
|
|
92
|
-
/**
|
|
154
|
+
/**
|
|
155
|
+
* Input values entered when filling the form.
|
|
156
|
+
* @maxSize 200
|
|
157
|
+
*/
|
|
93
158
|
inputValues?: InputValue[];
|
|
94
159
|
}
|
|
95
160
|
export interface InputValue {
|
|
96
|
-
/**
|
|
161
|
+
/**
|
|
162
|
+
* Input field name.
|
|
163
|
+
* @maxLength 100
|
|
164
|
+
*/
|
|
97
165
|
inputName?: string;
|
|
98
|
-
/**
|
|
166
|
+
/**
|
|
167
|
+
* Text entered into the input field.
|
|
168
|
+
* @maxLength 5000
|
|
169
|
+
*/
|
|
99
170
|
value?: string;
|
|
100
|
-
/**
|
|
171
|
+
/**
|
|
172
|
+
* Multiple selection values. For example, the array is filled if several checkboxes are ticked.
|
|
173
|
+
* @maxSize 100
|
|
174
|
+
* @maxLength 5000
|
|
175
|
+
*/
|
|
101
176
|
values?: string[];
|
|
102
177
|
}
|
|
103
178
|
export interface FormattedAddress {
|
|
104
|
-
/**
|
|
179
|
+
/**
|
|
180
|
+
* One line address representation.
|
|
181
|
+
* @maxLength 200
|
|
182
|
+
*/
|
|
105
183
|
formatted?: string;
|
|
106
184
|
/** Address components (optional). */
|
|
107
185
|
address?: Address;
|
|
@@ -112,7 +190,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
112
190
|
streetAddress?: StreetAddress;
|
|
113
191
|
/** Main address line, usually street and number as free text. */
|
|
114
192
|
addressLine?: string | null;
|
|
115
|
-
/**
|
|
193
|
+
/**
|
|
194
|
+
* Country code.
|
|
195
|
+
* @format COUNTRY
|
|
196
|
+
*/
|
|
116
197
|
country?: string | null;
|
|
117
198
|
/** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
|
|
118
199
|
subdivision?: string | null;
|
|
@@ -165,7 +246,10 @@ export declare enum SubdivisionType {
|
|
|
165
246
|
}
|
|
166
247
|
/** Subdivision Concordance values */
|
|
167
248
|
export interface StandardDetails {
|
|
168
|
-
/**
|
|
249
|
+
/**
|
|
250
|
+
* subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30
|
|
251
|
+
* @maxLength 20
|
|
252
|
+
*/
|
|
169
253
|
iso31662?: string | null;
|
|
170
254
|
}
|
|
171
255
|
export declare enum AttendanceStatus {
|
|
@@ -187,7 +271,10 @@ export declare enum GuestType {
|
|
|
187
271
|
export interface GuestCountUpdated {
|
|
188
272
|
/** Guest. */
|
|
189
273
|
guest?: EventGuest;
|
|
190
|
-
/**
|
|
274
|
+
/**
|
|
275
|
+
* Guest count updates.
|
|
276
|
+
* @maxSize 2
|
|
277
|
+
*/
|
|
191
278
|
guestCountUpdates?: GuestCountUpdate[];
|
|
192
279
|
}
|
|
193
280
|
export interface GuestCountUpdate {
|
|
@@ -199,9 +286,15 @@ export interface GuestCountUpdate {
|
|
|
199
286
|
countDelta?: number;
|
|
200
287
|
}
|
|
201
288
|
export interface MemberEventStatusUpdated {
|
|
202
|
-
/**
|
|
289
|
+
/**
|
|
290
|
+
* Event id.
|
|
291
|
+
* @format GUID
|
|
292
|
+
*/
|
|
203
293
|
eventId?: string | null;
|
|
204
|
-
/**
|
|
294
|
+
/**
|
|
295
|
+
* Member id.
|
|
296
|
+
* @format GUID
|
|
297
|
+
*/
|
|
205
298
|
memberId?: string | null;
|
|
206
299
|
/** Member event status. */
|
|
207
300
|
status?: MemberEventStatusUpdatedEventType;
|
|
@@ -230,9 +323,15 @@ export declare enum MemberEventStatusUpdatedEventType {
|
|
|
230
323
|
LAST_ATTENDING_MEMBER_LEFT = "LAST_ATTENDING_MEMBER_LEFT"
|
|
231
324
|
}
|
|
232
325
|
export interface ContactEventStatusUpdated {
|
|
233
|
-
/**
|
|
326
|
+
/**
|
|
327
|
+
* Event id.
|
|
328
|
+
* @format GUID
|
|
329
|
+
*/
|
|
234
330
|
eventId?: string | null;
|
|
235
|
-
/**
|
|
331
|
+
/**
|
|
332
|
+
* Contact id.
|
|
333
|
+
* @format GUID
|
|
334
|
+
*/
|
|
236
335
|
contactId?: string | null;
|
|
237
336
|
/** Contact event status. */
|
|
238
337
|
status?: EventType;
|
|
@@ -264,11 +363,14 @@ export interface GuestCheckedIn {
|
|
|
264
363
|
export interface EventDetails {
|
|
265
364
|
/**
|
|
266
365
|
* Event title.
|
|
366
|
+
* @minLength 1
|
|
367
|
+
* @maxLength 120
|
|
267
368
|
* @readonly
|
|
268
369
|
*/
|
|
269
370
|
title?: string | null;
|
|
270
371
|
/**
|
|
271
372
|
* Event short description.
|
|
373
|
+
* @maxLength 500
|
|
272
374
|
* @readonly
|
|
273
375
|
*/
|
|
274
376
|
shortDescription?: string | null;
|
|
@@ -294,7 +396,10 @@ export interface EventDetails {
|
|
|
294
396
|
status?: Status;
|
|
295
397
|
}
|
|
296
398
|
export interface Location {
|
|
297
|
-
/**
|
|
399
|
+
/**
|
|
400
|
+
* Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`.
|
|
401
|
+
* @maxLength 50
|
|
402
|
+
*/
|
|
298
403
|
name?: string | null;
|
|
299
404
|
/** Location type. */
|
|
300
405
|
type?: LocationType;
|
|
@@ -315,42 +420,83 @@ export declare enum LocationType {
|
|
|
315
420
|
export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
316
421
|
/** Street address. */
|
|
317
422
|
streetAddress?: CommonStreetAddress;
|
|
318
|
-
/**
|
|
423
|
+
/**
|
|
424
|
+
* Primary address information (street and building number).
|
|
425
|
+
* @maxLength 250
|
|
426
|
+
*/
|
|
319
427
|
addressLine?: string | null;
|
|
320
|
-
/**
|
|
428
|
+
/**
|
|
429
|
+
* 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.
|
|
430
|
+
* @format COUNTRY
|
|
431
|
+
*/
|
|
321
432
|
country?: string | null;
|
|
322
|
-
/**
|
|
433
|
+
/**
|
|
434
|
+
* Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
|
|
435
|
+
* @maxLength 20
|
|
436
|
+
*/
|
|
323
437
|
subdivision?: string | null;
|
|
324
|
-
/**
|
|
438
|
+
/**
|
|
439
|
+
* City name.
|
|
440
|
+
* @maxLength 100
|
|
441
|
+
*/
|
|
325
442
|
city?: string | null;
|
|
326
|
-
/**
|
|
443
|
+
/**
|
|
444
|
+
* Zip or postal code.
|
|
445
|
+
* @maxLength 100
|
|
446
|
+
*/
|
|
327
447
|
postalCode?: string | null;
|
|
328
|
-
/**
|
|
448
|
+
/**
|
|
449
|
+
* Secondary address information (suite or apartment number and room number).
|
|
450
|
+
* @maxLength 250
|
|
451
|
+
*/
|
|
329
452
|
addressLine2?: string | null;
|
|
330
453
|
}
|
|
331
454
|
/** @oneof */
|
|
332
455
|
export interface CommonAddressStreetOneOf {
|
|
333
456
|
/** Street address. */
|
|
334
457
|
streetAddress?: CommonStreetAddress;
|
|
335
|
-
/**
|
|
458
|
+
/**
|
|
459
|
+
* Primary address information (street and building number).
|
|
460
|
+
* @maxLength 250
|
|
461
|
+
*/
|
|
336
462
|
addressLine?: string | null;
|
|
337
463
|
}
|
|
338
464
|
export interface CommonStreetAddress {
|
|
339
|
-
/**
|
|
465
|
+
/**
|
|
466
|
+
* Street number.
|
|
467
|
+
* @maxLength 100
|
|
468
|
+
*/
|
|
340
469
|
number?: string;
|
|
341
|
-
/**
|
|
470
|
+
/**
|
|
471
|
+
* Street name.
|
|
472
|
+
* @maxLength 250
|
|
473
|
+
*/
|
|
342
474
|
name?: string;
|
|
343
475
|
}
|
|
344
476
|
export interface CommonAddressLocation {
|
|
345
|
-
/**
|
|
477
|
+
/**
|
|
478
|
+
* Address latitude coordinates.
|
|
479
|
+
* @min -90
|
|
480
|
+
* @max 90
|
|
481
|
+
*/
|
|
346
482
|
latitude?: number | null;
|
|
347
|
-
/**
|
|
483
|
+
/**
|
|
484
|
+
* Address longitude coordinates.
|
|
485
|
+
* @min -180
|
|
486
|
+
* @max 180
|
|
487
|
+
*/
|
|
348
488
|
longitude?: number | null;
|
|
349
489
|
}
|
|
350
490
|
export interface CommonSubdivision {
|
|
351
|
-
/**
|
|
491
|
+
/**
|
|
492
|
+
* Short subdivision code.
|
|
493
|
+
* @maxLength 100
|
|
494
|
+
*/
|
|
352
495
|
code?: string;
|
|
353
|
-
/**
|
|
496
|
+
/**
|
|
497
|
+
* Subdivision full name.
|
|
498
|
+
* @maxLength 250
|
|
499
|
+
*/
|
|
354
500
|
name?: string;
|
|
355
501
|
}
|
|
356
502
|
export declare enum SubdivisionSubdivisionType {
|
|
@@ -371,13 +517,19 @@ export declare enum SubdivisionSubdivisionType {
|
|
|
371
517
|
export interface DateAndTimeSettings {
|
|
372
518
|
/** Whether the event date and time are TBD. */
|
|
373
519
|
dateAndTimeTbd?: boolean | null;
|
|
374
|
-
/**
|
|
520
|
+
/**
|
|
521
|
+
* Message that is displayed when time and date is TBD.
|
|
522
|
+
* @maxLength 100
|
|
523
|
+
*/
|
|
375
524
|
dateAndTimeTbdMessage?: string | null;
|
|
376
525
|
/** Event start date. */
|
|
377
526
|
startDate?: Date | null;
|
|
378
527
|
/** Event end date. */
|
|
379
528
|
endDate?: Date | null;
|
|
380
|
-
/**
|
|
529
|
+
/**
|
|
530
|
+
* Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
|
|
531
|
+
* @maxLength 100
|
|
532
|
+
*/
|
|
381
533
|
timeZoneId?: string | null;
|
|
382
534
|
/** Whether the end date is hidden in the formatted date and time. */
|
|
383
535
|
hideEndDate?: boolean | null;
|
|
@@ -408,11 +560,15 @@ export declare enum RecurrenceStatusStatus {
|
|
|
408
560
|
RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
|
|
409
561
|
}
|
|
410
562
|
export interface Recurrences {
|
|
411
|
-
/**
|
|
563
|
+
/**
|
|
564
|
+
* Individual event dates.
|
|
565
|
+
* @maxSize 1000
|
|
566
|
+
*/
|
|
412
567
|
individualEventDates?: Occurrence[];
|
|
413
568
|
/**
|
|
414
569
|
* Recurring event category ID.
|
|
415
570
|
* @readonly
|
|
571
|
+
* @maxLength 100
|
|
416
572
|
*/
|
|
417
573
|
categoryId?: string | null;
|
|
418
574
|
}
|
|
@@ -421,7 +577,10 @@ export interface Occurrence {
|
|
|
421
577
|
startDate?: Date | null;
|
|
422
578
|
/** Event end date. */
|
|
423
579
|
endDate?: Date | null;
|
|
424
|
-
/**
|
|
580
|
+
/**
|
|
581
|
+
* Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
|
|
582
|
+
* @maxLength 100
|
|
583
|
+
*/
|
|
425
584
|
timeZoneId?: string | null;
|
|
426
585
|
/** Whether the time zone is displayed in a formatted schedule. */
|
|
427
586
|
showTimeZone?: boolean;
|
|
@@ -432,33 +591,44 @@ export interface Formatted {
|
|
|
432
591
|
* 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>
|
|
433
592
|
* 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`.
|
|
434
593
|
* @readonly
|
|
594
|
+
* @maxLength 500
|
|
435
595
|
*/
|
|
436
596
|
dateAndTime?: string | null;
|
|
437
597
|
/**
|
|
438
598
|
* Formatted start date of the event. Empty for TBD schedules.
|
|
439
599
|
* @readonly
|
|
600
|
+
* @maxLength 500
|
|
440
601
|
*/
|
|
441
602
|
startDate?: string | null;
|
|
442
603
|
/**
|
|
443
604
|
* Formatted start time of the event. Empty for TBD schedules.
|
|
444
605
|
* @readonly
|
|
606
|
+
* @maxLength 500
|
|
445
607
|
*/
|
|
446
608
|
startTime?: string | null;
|
|
447
609
|
/**
|
|
448
610
|
* Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.
|
|
449
611
|
* @readonly
|
|
612
|
+
* @maxLength 500
|
|
450
613
|
*/
|
|
451
614
|
endDate?: string | null;
|
|
452
615
|
/**
|
|
453
616
|
* Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.
|
|
454
617
|
* @readonly
|
|
618
|
+
* @maxLength 500
|
|
455
619
|
*/
|
|
456
620
|
endTime?: string | null;
|
|
457
621
|
}
|
|
458
622
|
export interface PageUrl {
|
|
459
|
-
/**
|
|
623
|
+
/**
|
|
624
|
+
* 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`).
|
|
625
|
+
* @maxLength 500
|
|
626
|
+
*/
|
|
460
627
|
base?: string;
|
|
461
|
-
/**
|
|
628
|
+
/**
|
|
629
|
+
* The path to the page. For example, `/product-page/a-product`.
|
|
630
|
+
* @maxLength 500
|
|
631
|
+
*/
|
|
462
632
|
path?: string;
|
|
463
633
|
}
|
|
464
634
|
export declare enum Status {
|
|
@@ -583,9 +753,16 @@ export interface Invoice {
|
|
|
583
753
|
previewUrl?: string | null;
|
|
584
754
|
}
|
|
585
755
|
export interface Item {
|
|
586
|
-
/**
|
|
756
|
+
/**
|
|
757
|
+
* Unique line item ID.
|
|
758
|
+
* @format GUID
|
|
759
|
+
*/
|
|
587
760
|
id?: string;
|
|
588
|
-
/**
|
|
761
|
+
/**
|
|
762
|
+
* Line item quantity.
|
|
763
|
+
* @min 1
|
|
764
|
+
* @max 50
|
|
765
|
+
*/
|
|
589
766
|
quantity?: number;
|
|
590
767
|
/** Line item name. */
|
|
591
768
|
name?: string;
|
|
@@ -606,12 +783,19 @@ export interface Item {
|
|
|
606
783
|
export interface Money {
|
|
607
784
|
/**
|
|
608
785
|
* *Deprecated:** Use `value` instead.
|
|
786
|
+
* @format DECIMAL_VALUE
|
|
609
787
|
* @deprecated
|
|
610
788
|
*/
|
|
611
789
|
amount?: string;
|
|
612
|
-
/**
|
|
790
|
+
/**
|
|
791
|
+
* ISO 4217 format of the currency e.g., `USD`.
|
|
792
|
+
* @format CURRENCY
|
|
793
|
+
*/
|
|
613
794
|
currency?: string;
|
|
614
|
-
/**
|
|
795
|
+
/**
|
|
796
|
+
* 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.
|
|
797
|
+
* @format DECIMAL_VALUE
|
|
798
|
+
*/
|
|
615
799
|
value?: string | null;
|
|
616
800
|
}
|
|
617
801
|
export interface Discount {
|
|
@@ -672,7 +856,10 @@ export interface PaidPlanDiscountDiscountOneOf {
|
|
|
672
856
|
percentDiscount?: PercentDiscount;
|
|
673
857
|
}
|
|
674
858
|
export interface PercentDiscount {
|
|
675
|
-
/**
|
|
859
|
+
/**
|
|
860
|
+
* Percent rate.
|
|
861
|
+
* @decimalValue options - {gte:0.01,lte:100,maxScale:2}
|
|
862
|
+
*/
|
|
676
863
|
rate?: string;
|
|
677
864
|
/** Number of discounted tickets. */
|
|
678
865
|
quantityDiscounted?: number;
|
|
@@ -685,7 +872,10 @@ export interface Tax {
|
|
|
685
872
|
* @readonly
|
|
686
873
|
*/
|
|
687
874
|
name?: string;
|
|
688
|
-
/**
|
|
875
|
+
/**
|
|
876
|
+
* Tax rate.
|
|
877
|
+
* @format DECIMAL_VALUE
|
|
878
|
+
*/
|
|
689
879
|
rate?: string;
|
|
690
880
|
/** Taxable amount. */
|
|
691
881
|
taxable?: Money;
|
|
@@ -707,6 +897,7 @@ export interface Fee {
|
|
|
707
897
|
type?: FeeType;
|
|
708
898
|
/**
|
|
709
899
|
* Fee rate.
|
|
900
|
+
* @format DECIMAL_VALUE
|
|
710
901
|
* @readonly
|
|
711
902
|
*/
|
|
712
903
|
rate?: string;
|
|
@@ -820,9 +1011,15 @@ export interface ActionEvent {
|
|
|
820
1011
|
bodyAsJson?: string;
|
|
821
1012
|
}
|
|
822
1013
|
export interface MessageEnvelope {
|
|
823
|
-
/**
|
|
1014
|
+
/**
|
|
1015
|
+
* App instance ID.
|
|
1016
|
+
* @format GUID
|
|
1017
|
+
*/
|
|
824
1018
|
instanceId?: string | null;
|
|
825
|
-
/**
|
|
1019
|
+
/**
|
|
1020
|
+
* Event type.
|
|
1021
|
+
* @maxLength 150
|
|
1022
|
+
*/
|
|
826
1023
|
eventType?: string;
|
|
827
1024
|
/** The identification type and identity data. */
|
|
828
1025
|
identity?: IdentificationData;
|
|
@@ -830,26 +1027,50 @@ export interface MessageEnvelope {
|
|
|
830
1027
|
data?: string;
|
|
831
1028
|
}
|
|
832
1029
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
833
|
-
/**
|
|
1030
|
+
/**
|
|
1031
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1032
|
+
* @format GUID
|
|
1033
|
+
*/
|
|
834
1034
|
anonymousVisitorId?: string;
|
|
835
|
-
/**
|
|
1035
|
+
/**
|
|
1036
|
+
* ID of a site visitor that has logged in to the site.
|
|
1037
|
+
* @format GUID
|
|
1038
|
+
*/
|
|
836
1039
|
memberId?: string;
|
|
837
|
-
/**
|
|
1040
|
+
/**
|
|
1041
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1042
|
+
* @format GUID
|
|
1043
|
+
*/
|
|
838
1044
|
wixUserId?: string;
|
|
839
|
-
/**
|
|
1045
|
+
/**
|
|
1046
|
+
* ID of an app.
|
|
1047
|
+
* @format GUID
|
|
1048
|
+
*/
|
|
840
1049
|
appId?: string;
|
|
841
1050
|
/** @readonly */
|
|
842
1051
|
identityType?: WebhookIdentityType;
|
|
843
1052
|
}
|
|
844
1053
|
/** @oneof */
|
|
845
1054
|
export interface IdentificationDataIdOneOf {
|
|
846
|
-
/**
|
|
1055
|
+
/**
|
|
1056
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1057
|
+
* @format GUID
|
|
1058
|
+
*/
|
|
847
1059
|
anonymousVisitorId?: string;
|
|
848
|
-
/**
|
|
1060
|
+
/**
|
|
1061
|
+
* ID of a site visitor that has logged in to the site.
|
|
1062
|
+
* @format GUID
|
|
1063
|
+
*/
|
|
849
1064
|
memberId?: string;
|
|
850
|
-
/**
|
|
1065
|
+
/**
|
|
1066
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1067
|
+
* @format GUID
|
|
1068
|
+
*/
|
|
851
1069
|
wixUserId?: string;
|
|
852
|
-
/**
|
|
1070
|
+
/**
|
|
1071
|
+
* ID of an app.
|
|
1072
|
+
* @format GUID
|
|
1073
|
+
*/
|
|
853
1074
|
appId?: string;
|
|
854
1075
|
}
|
|
855
1076
|
export declare enum WebhookIdentityType {
|
|
@@ -862,7 +1083,10 @@ export declare enum WebhookIdentityType {
|
|
|
862
1083
|
export interface QueryEventGuestsRequest {
|
|
863
1084
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
864
1085
|
query: QueryV2;
|
|
865
|
-
/**
|
|
1086
|
+
/**
|
|
1087
|
+
* Predefined sets of fields to return.
|
|
1088
|
+
* @maxSize 3
|
|
1089
|
+
*/
|
|
866
1090
|
fields?: RequestedFieldsEnumRequestedFields[];
|
|
867
1091
|
}
|
|
868
1092
|
export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
@@ -890,7 +1114,10 @@ export interface QueryV2PagingMethodOneOf {
|
|
|
890
1114
|
cursorPaging?: CursorPaging;
|
|
891
1115
|
}
|
|
892
1116
|
export interface Sorting {
|
|
893
|
-
/**
|
|
1117
|
+
/**
|
|
1118
|
+
* Name of the field to sort by.
|
|
1119
|
+
* @maxLength 512
|
|
1120
|
+
*/
|
|
894
1121
|
fieldName?: string;
|
|
895
1122
|
/** Sort order. */
|
|
896
1123
|
order?: SortOrder;
|
|
@@ -900,19 +1127,26 @@ export declare enum SortOrder {
|
|
|
900
1127
|
DESC = "DESC"
|
|
901
1128
|
}
|
|
902
1129
|
export interface Paging {
|
|
903
|
-
/**
|
|
1130
|
+
/**
|
|
1131
|
+
* Number of items to load.
|
|
1132
|
+
* @max 1000
|
|
1133
|
+
*/
|
|
904
1134
|
limit?: number | null;
|
|
905
1135
|
/** Number of items to skip in the current sort order. */
|
|
906
1136
|
offset?: number | null;
|
|
907
1137
|
}
|
|
908
1138
|
export interface CursorPaging {
|
|
909
|
-
/**
|
|
1139
|
+
/**
|
|
1140
|
+
* Maximum number of items to return in the results.
|
|
1141
|
+
* @max 1000
|
|
1142
|
+
*/
|
|
910
1143
|
limit?: number | null;
|
|
911
1144
|
/**
|
|
912
1145
|
* Pointer to the next or previous page in the list of results.
|
|
913
1146
|
*
|
|
914
1147
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
915
1148
|
* Not relevant for the first request.
|
|
1149
|
+
* @maxLength 16000
|
|
916
1150
|
*/
|
|
917
1151
|
cursor?: string | null;
|
|
918
1152
|
}
|
|
@@ -943,9 +1177,15 @@ export interface PagingMetadataV2 {
|
|
|
943
1177
|
cursors?: Cursors;
|
|
944
1178
|
}
|
|
945
1179
|
export interface Cursors {
|
|
946
|
-
/**
|
|
1180
|
+
/**
|
|
1181
|
+
* Cursor string pointing to the next page in the list of results.
|
|
1182
|
+
* @maxLength 16000
|
|
1183
|
+
*/
|
|
947
1184
|
next?: string | null;
|
|
948
|
-
/**
|
|
1185
|
+
/**
|
|
1186
|
+
* Cursor pointing to the previous page in the list of results.
|
|
1187
|
+
* @maxLength 16000
|
|
1188
|
+
*/
|
|
949
1189
|
prev?: string | null;
|
|
950
1190
|
}
|
|
951
1191
|
export interface StreamEventGuestsRequest {
|
|
@@ -957,37 +1197,61 @@ export interface StreamEventGuestsRequest {
|
|
|
957
1197
|
export interface Empty {
|
|
958
1198
|
}
|
|
959
1199
|
export interface SecondaryLanguagesRequest {
|
|
960
|
-
/**
|
|
1200
|
+
/**
|
|
1201
|
+
* Guest event id.
|
|
1202
|
+
* @format GUID
|
|
1203
|
+
*/
|
|
961
1204
|
eventId?: string;
|
|
962
1205
|
}
|
|
963
1206
|
export interface SecondaryLanguagesResponse {
|
|
964
|
-
/**
|
|
1207
|
+
/**
|
|
1208
|
+
* Aggregated guests secondary languages.
|
|
1209
|
+
* @format LANGUAGE
|
|
1210
|
+
*/
|
|
965
1211
|
secondaryLanguages?: string[];
|
|
966
1212
|
/** Aggregated guests languages. */
|
|
967
1213
|
languages?: Language[];
|
|
968
1214
|
}
|
|
969
1215
|
export interface Language {
|
|
970
|
-
/**
|
|
1216
|
+
/**
|
|
1217
|
+
* Guest language.
|
|
1218
|
+
* @format LANGUAGE
|
|
1219
|
+
*/
|
|
971
1220
|
language?: string | null;
|
|
972
|
-
/**
|
|
1221
|
+
/**
|
|
1222
|
+
* Guest locale.
|
|
1223
|
+
* @format LANGUAGE_TAG
|
|
1224
|
+
*/
|
|
973
1225
|
locale?: string | null;
|
|
974
1226
|
}
|
|
975
1227
|
export interface OrderConfirmed {
|
|
976
1228
|
/** Order confirmation timestamp in ISO UTC. */
|
|
977
1229
|
timestamp?: Date | null;
|
|
978
|
-
/**
|
|
1230
|
+
/**
|
|
1231
|
+
* Site language when Order initiated
|
|
1232
|
+
* @format LANGUAGE
|
|
1233
|
+
*/
|
|
979
1234
|
language?: string | null;
|
|
980
1235
|
/** Notifications silenced for this domain event. */
|
|
981
1236
|
silent?: boolean | null;
|
|
982
|
-
/**
|
|
1237
|
+
/**
|
|
1238
|
+
* Locale in which Order was created.
|
|
1239
|
+
* @format LANGUAGE_TAG
|
|
1240
|
+
*/
|
|
983
1241
|
locale?: string | null;
|
|
984
|
-
/**
|
|
1242
|
+
/**
|
|
1243
|
+
* Event ID.
|
|
1244
|
+
* @format GUID
|
|
1245
|
+
*/
|
|
985
1246
|
eventId?: string;
|
|
986
1247
|
/** Unique order number. */
|
|
987
1248
|
orderNumber?: string;
|
|
988
1249
|
/** Contact ID associated with this order. */
|
|
989
1250
|
contactId?: string;
|
|
990
|
-
/**
|
|
1251
|
+
/**
|
|
1252
|
+
* Member ID associated with this order.
|
|
1253
|
+
* @format GUID
|
|
1254
|
+
*/
|
|
991
1255
|
memberId?: string | null;
|
|
992
1256
|
/**
|
|
993
1257
|
* Order created timestamp
|
|
@@ -1016,7 +1280,10 @@ export interface OrderConfirmed {
|
|
|
1016
1280
|
export interface Ticket {
|
|
1017
1281
|
/** Unique issued ticket number. */
|
|
1018
1282
|
ticketNumber?: string;
|
|
1019
|
-
/**
|
|
1283
|
+
/**
|
|
1284
|
+
* Ticket definition ID.
|
|
1285
|
+
* @format GUID
|
|
1286
|
+
*/
|
|
1020
1287
|
ticketDefinitionId?: string;
|
|
1021
1288
|
/** Ticket check-in. */
|
|
1022
1289
|
checkIn?: CheckIn;
|
|
@@ -1030,11 +1297,17 @@ export interface Ticket {
|
|
|
1030
1297
|
lastName?: string | null;
|
|
1031
1298
|
/** Guest email. */
|
|
1032
1299
|
email?: string | null;
|
|
1033
|
-
/**
|
|
1300
|
+
/**
|
|
1301
|
+
* Contact ID associated with this ticket.
|
|
1302
|
+
* @format GUID
|
|
1303
|
+
*/
|
|
1034
1304
|
contactId?: string | null;
|
|
1035
1305
|
/** Whether ticket is confirmed */
|
|
1036
1306
|
confirmed?: boolean;
|
|
1037
|
-
/**
|
|
1307
|
+
/**
|
|
1308
|
+
* Member ID associated with this ticket.
|
|
1309
|
+
* @format GUID
|
|
1310
|
+
*/
|
|
1038
1311
|
memberId?: string | null;
|
|
1039
1312
|
/** Ticket form response (only assigned tickets contain separate forms). */
|
|
1040
1313
|
form?: FormResponse;
|
|
@@ -1044,7 +1317,10 @@ export interface Ticket {
|
|
|
1044
1317
|
anonymized?: boolean;
|
|
1045
1318
|
/** URL and password to online conference */
|
|
1046
1319
|
onlineConferencingLogin?: OnlineConferencingLogin;
|
|
1047
|
-
/**
|
|
1320
|
+
/**
|
|
1321
|
+
* Seat ID associated with this ticket.
|
|
1322
|
+
* @maxLength 36
|
|
1323
|
+
*/
|
|
1048
1324
|
seatId?: string | null;
|
|
1049
1325
|
/** Whether ticket is canceled. */
|
|
1050
1326
|
canceled?: boolean | null;
|
|
@@ -1056,17 +1332,29 @@ export interface CheckIn {
|
|
|
1056
1332
|
export interface OrderUpdated {
|
|
1057
1333
|
/** Order updated timestamp in ISO UTC format. */
|
|
1058
1334
|
timestamp?: Date | null;
|
|
1059
|
-
/**
|
|
1335
|
+
/**
|
|
1336
|
+
* Site language when Order initiated
|
|
1337
|
+
* @format LANGUAGE
|
|
1338
|
+
*/
|
|
1060
1339
|
language?: string | null;
|
|
1061
|
-
/**
|
|
1340
|
+
/**
|
|
1341
|
+
* Locale in which Order was created.
|
|
1342
|
+
* @format LANGUAGE_TAG
|
|
1343
|
+
*/
|
|
1062
1344
|
locale?: string | null;
|
|
1063
|
-
/**
|
|
1345
|
+
/**
|
|
1346
|
+
* Event ID.
|
|
1347
|
+
* @format GUID
|
|
1348
|
+
*/
|
|
1064
1349
|
eventId?: string;
|
|
1065
1350
|
/** Unique order number. */
|
|
1066
1351
|
orderNumber?: string;
|
|
1067
1352
|
/** Contact ID associated with this order. */
|
|
1068
1353
|
contactId?: string;
|
|
1069
|
-
/**
|
|
1354
|
+
/**
|
|
1355
|
+
* Member ID associated with this order.
|
|
1356
|
+
* @format GUID
|
|
1357
|
+
*/
|
|
1070
1358
|
memberId?: string | null;
|
|
1071
1359
|
/**
|
|
1072
1360
|
* Order created timestamp.
|
|
@@ -1102,13 +1390,19 @@ export interface OrderUpdated {
|
|
|
1102
1390
|
export interface OrderDeleted {
|
|
1103
1391
|
/** Order deleted timestamp in ISO UTC format. */
|
|
1104
1392
|
timestamp?: Date | null;
|
|
1105
|
-
/**
|
|
1393
|
+
/**
|
|
1394
|
+
* Event ID.
|
|
1395
|
+
* @format GUID
|
|
1396
|
+
*/
|
|
1106
1397
|
eventId?: string;
|
|
1107
1398
|
/** Unique order number. */
|
|
1108
1399
|
orderNumber?: string;
|
|
1109
1400
|
/** Contact ID associated with this order */
|
|
1110
1401
|
contactId?: string;
|
|
1111
|
-
/**
|
|
1402
|
+
/**
|
|
1403
|
+
* Member ID associated with this order.
|
|
1404
|
+
* @format GUID
|
|
1405
|
+
*/
|
|
1112
1406
|
memberId?: string | null;
|
|
1113
1407
|
/**
|
|
1114
1408
|
* Order created timestamp.
|
|
@@ -1138,11 +1432,17 @@ export declare enum OrderType {
|
|
|
1138
1432
|
export interface EventDeleted {
|
|
1139
1433
|
/** Event deleted timestamp in ISO UTC format. */
|
|
1140
1434
|
timestamp?: Date | null;
|
|
1141
|
-
/**
|
|
1435
|
+
/**
|
|
1436
|
+
* Event ID.
|
|
1437
|
+
* @format GUID
|
|
1438
|
+
*/
|
|
1142
1439
|
eventId?: string;
|
|
1143
1440
|
/** Event title. */
|
|
1144
1441
|
title?: string;
|
|
1145
|
-
/**
|
|
1442
|
+
/**
|
|
1443
|
+
* Event creator user ID.
|
|
1444
|
+
* @format GUID
|
|
1445
|
+
*/
|
|
1146
1446
|
userId?: string | null;
|
|
1147
1447
|
}
|
|
1148
1448
|
export interface Task {
|
|
@@ -1156,11 +1456,18 @@ export interface TaskKey {
|
|
|
1156
1456
|
subjectId?: string | null;
|
|
1157
1457
|
}
|
|
1158
1458
|
export interface ListGuestListPreviewsRequest {
|
|
1159
|
-
/**
|
|
1459
|
+
/**
|
|
1460
|
+
* Event ids.
|
|
1461
|
+
* @format GUID
|
|
1462
|
+
* @maxSize 50
|
|
1463
|
+
*/
|
|
1160
1464
|
eventIds?: string[];
|
|
1161
1465
|
/** Cursor paging. */
|
|
1162
1466
|
cursorPaging?: CursorPaging;
|
|
1163
|
-
/**
|
|
1467
|
+
/**
|
|
1468
|
+
* Requested fields.
|
|
1469
|
+
* @maxSize 5
|
|
1470
|
+
*/
|
|
1164
1471
|
fields?: RequestedFields[];
|
|
1165
1472
|
}
|
|
1166
1473
|
export declare enum RequestedFields {
|
|
@@ -1172,13 +1479,19 @@ export declare enum RequestedFields {
|
|
|
1172
1479
|
WAITLIST_COUNT = "WAITLIST_COUNT"
|
|
1173
1480
|
}
|
|
1174
1481
|
export interface ListGuestListPreviewsResponse {
|
|
1175
|
-
/**
|
|
1482
|
+
/**
|
|
1483
|
+
* List of guests.
|
|
1484
|
+
* @maxSize 50
|
|
1485
|
+
*/
|
|
1176
1486
|
previews?: GuestListPreview[];
|
|
1177
1487
|
/** Metadata for the paginated results. */
|
|
1178
1488
|
pagingMetadata?: PagingMetadataV2;
|
|
1179
1489
|
}
|
|
1180
1490
|
export interface GuestListPreview {
|
|
1181
|
-
/**
|
|
1491
|
+
/**
|
|
1492
|
+
* Event id.
|
|
1493
|
+
* @format GUID
|
|
1494
|
+
*/
|
|
1182
1495
|
eventId?: string;
|
|
1183
1496
|
/** Latest attending members. */
|
|
1184
1497
|
latestAttendingMembers?: EventGuests;
|
|
@@ -1190,6 +1503,7 @@ export interface GuestListPreview {
|
|
|
1190
1503
|
notAttending?: GuestCount;
|
|
1191
1504
|
}
|
|
1192
1505
|
export interface EventGuests {
|
|
1506
|
+
/** @maxSize 8 */
|
|
1193
1507
|
guests?: EventGuest[];
|
|
1194
1508
|
}
|
|
1195
1509
|
export interface GuestCount {
|