@wix/auto_sdk_events_guests 1.0.7 → 1.0.9

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.
Files changed (134) hide show
  1. package/build/{internal/cjs/src/events-guests-v1-guest-guests.universal.d.ts → events-guests-v1-guest-guests.universal-Cj6-k5Jw.d.mts} +122 -331
  2. package/build/{cjs/src/events-guests-v1-guest-guests.universal.d.ts → events-guests-v1-guest-guests.universal-Cj6-k5Jw.d.ts} +122 -331
  3. package/build/index.d.mts +61 -0
  4. package/build/index.d.ts +61 -0
  5. package/build/index.js +711 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +660 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/{es/src/events-guests-v1-guest-guests.universal.d.ts → events-guests-v1-guest-guests.universal-Cj6-k5Jw.d.mts} +122 -331
  10. package/build/{es/src/events-guests-v1-guest-guests.universal.d.ts → internal/events-guests-v1-guest-guests.universal-Cj6-k5Jw.d.ts} +122 -331
  11. package/build/internal/index.d.mts +61 -0
  12. package/build/internal/index.d.ts +61 -0
  13. package/build/internal/index.js +711 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +660 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +303 -0
  18. package/build/internal/meta.d.ts +303 -0
  19. package/build/internal/meta.js +149 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +122 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +303 -0
  24. package/build/meta.d.ts +303 -0
  25. package/build/meta.js +149 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +122 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +13 -12
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/events-guests-v1-guest-guests.context.d.ts +0 -41
  40. package/build/cjs/src/events-guests-v1-guest-guests.context.js +0 -64
  41. package/build/cjs/src/events-guests-v1-guest-guests.context.js.map +0 -1
  42. package/build/cjs/src/events-guests-v1-guest-guests.http.d.ts +0 -22
  43. package/build/cjs/src/events-guests-v1-guest-guests.http.js +0 -122
  44. package/build/cjs/src/events-guests-v1-guest-guests.http.js.map +0 -1
  45. package/build/cjs/src/events-guests-v1-guest-guests.meta.d.ts +0 -13
  46. package/build/cjs/src/events-guests-v1-guest-guests.meta.js +0 -47
  47. package/build/cjs/src/events-guests-v1-guest-guests.meta.js.map +0 -1
  48. package/build/cjs/src/events-guests-v1-guest-guests.public.d.ts +0 -37
  49. package/build/cjs/src/events-guests-v1-guest-guests.public.js +0 -282
  50. package/build/cjs/src/events-guests-v1-guest-guests.public.js.map +0 -1
  51. package/build/cjs/src/events-guests-v1-guest-guests.types.d.ts +0 -1586
  52. package/build/cjs/src/events-guests-v1-guest-guests.types.js +0 -251
  53. package/build/cjs/src/events-guests-v1-guest-guests.types.js.map +0 -1
  54. package/build/cjs/src/events-guests-v1-guest-guests.universal.js +0 -371
  55. package/build/cjs/src/events-guests-v1-guest-guests.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/events-guests-v1-guest-guests.context.d.ts +0 -41
  67. package/build/es/src/events-guests-v1-guest-guests.context.js +0 -41
  68. package/build/es/src/events-guests-v1-guest-guests.context.js.map +0 -1
  69. package/build/es/src/events-guests-v1-guest-guests.http.d.ts +0 -22
  70. package/build/es/src/events-guests-v1-guest-guests.http.js +0 -118
  71. package/build/es/src/events-guests-v1-guest-guests.http.js.map +0 -1
  72. package/build/es/src/events-guests-v1-guest-guests.meta.d.ts +0 -13
  73. package/build/es/src/events-guests-v1-guest-guests.meta.js +0 -20
  74. package/build/es/src/events-guests-v1-guest-guests.meta.js.map +0 -1
  75. package/build/es/src/events-guests-v1-guest-guests.public.d.ts +0 -37
  76. package/build/es/src/events-guests-v1-guest-guests.public.js +0 -258
  77. package/build/es/src/events-guests-v1-guest-guests.public.js.map +0 -1
  78. package/build/es/src/events-guests-v1-guest-guests.types.d.ts +0 -1586
  79. package/build/es/src/events-guests-v1-guest-guests.types.js +0 -248
  80. package/build/es/src/events-guests-v1-guest-guests.types.js.map +0 -1
  81. package/build/es/src/events-guests-v1-guest-guests.universal.js +0 -344
  82. package/build/es/src/events-guests-v1-guest-guests.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/events-guests-v1-guest-guests.context.d.ts +0 -41
  93. package/build/internal/cjs/src/events-guests-v1-guest-guests.context.js +0 -64
  94. package/build/internal/cjs/src/events-guests-v1-guest-guests.context.js.map +0 -1
  95. package/build/internal/cjs/src/events-guests-v1-guest-guests.http.d.ts +0 -22
  96. package/build/internal/cjs/src/events-guests-v1-guest-guests.http.js +0 -122
  97. package/build/internal/cjs/src/events-guests-v1-guest-guests.http.js.map +0 -1
  98. package/build/internal/cjs/src/events-guests-v1-guest-guests.meta.d.ts +0 -13
  99. package/build/internal/cjs/src/events-guests-v1-guest-guests.meta.js +0 -47
  100. package/build/internal/cjs/src/events-guests-v1-guest-guests.meta.js.map +0 -1
  101. package/build/internal/cjs/src/events-guests-v1-guest-guests.public.d.ts +0 -37
  102. package/build/internal/cjs/src/events-guests-v1-guest-guests.public.js +0 -282
  103. package/build/internal/cjs/src/events-guests-v1-guest-guests.public.js.map +0 -1
  104. package/build/internal/cjs/src/events-guests-v1-guest-guests.types.d.ts +0 -1586
  105. package/build/internal/cjs/src/events-guests-v1-guest-guests.types.js +0 -251
  106. package/build/internal/cjs/src/events-guests-v1-guest-guests.types.js.map +0 -1
  107. package/build/internal/cjs/src/events-guests-v1-guest-guests.universal.js +0 -371
  108. package/build/internal/cjs/src/events-guests-v1-guest-guests.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/events-guests-v1-guest-guests.context.d.ts +0 -41
  119. package/build/internal/es/src/events-guests-v1-guest-guests.context.js +0 -41
  120. package/build/internal/es/src/events-guests-v1-guest-guests.context.js.map +0 -1
  121. package/build/internal/es/src/events-guests-v1-guest-guests.http.d.ts +0 -22
  122. package/build/internal/es/src/events-guests-v1-guest-guests.http.js +0 -118
  123. package/build/internal/es/src/events-guests-v1-guest-guests.http.js.map +0 -1
  124. package/build/internal/es/src/events-guests-v1-guest-guests.meta.d.ts +0 -13
  125. package/build/internal/es/src/events-guests-v1-guest-guests.meta.js +0 -20
  126. package/build/internal/es/src/events-guests-v1-guest-guests.meta.js.map +0 -1
  127. package/build/internal/es/src/events-guests-v1-guest-guests.public.d.ts +0 -37
  128. package/build/internal/es/src/events-guests-v1-guest-guests.public.js +0 -258
  129. package/build/internal/es/src/events-guests-v1-guest-guests.public.js.map +0 -1
  130. package/build/internal/es/src/events-guests-v1-guest-guests.types.d.ts +0 -1586
  131. package/build/internal/es/src/events-guests-v1-guest-guests.types.js +0 -248
  132. package/build/internal/es/src/events-guests-v1-guest-guests.types.js.map +0 -1
  133. package/build/internal/es/src/events-guests-v1-guest-guests.universal.js +0 -344
  134. package/build/internal/es/src/events-guests-v1-guest-guests.universal.js.map +0 -1
@@ -1,1586 +0,0 @@
1
- export interface EventGuest {
2
- /**
3
- * Guest ID.
4
- * @format GUID
5
- */
6
- id?: string | null;
7
- /**
8
- * Event ID.
9
- * @format GUID
10
- */
11
- eventId?: string | null;
12
- /**
13
- * RSVP ID. <br/> <br/> **Note:** Only applicable when `guestType` is `RSVP`.
14
- * @format GUID
15
- */
16
- rsvpId?: string | null;
17
- /**
18
- * Order number. <br/> <br/> **Note:** Only applicable when `guestType` is `BUYER` or `TICKET_HOLDER`.
19
- * @maxLength 36
20
- */
21
- orderNumber?: string | null;
22
- /**
23
- * Ticket number. <br/> <br/> **Note:** Only applicable when `guestType` is `TICKET_HOLDER`.
24
- * @maxLength 36
25
- */
26
- ticketNumber?: string | null;
27
- /**
28
- * List of names, numbers, and definition IDs for each ticket.
29
- * @maxSize 50
30
- */
31
- tickets?: TicketDetails[];
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
- */
36
- contactId?: string | null;
37
- /** Guest details. <br/> <br/> Returned only when the `guestDetails` fieldset is sent in the request. */
38
- guestDetails?: GuestDetails;
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. */
40
- attendanceStatus?: AttendanceStatus;
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
- */
45
- secondaryLanguageCode?: string | null;
46
- /** Date and time the guest was created in `yyyy-mm-ddThh:mm:sssZ` format. */
47
- createdDate?: Date | null;
48
- /** Date and time the guest was updated in `yyyy-mm-ddThh:mm:sssZ` format. */
49
- updatedDate?: Date | null;
50
- /** Date and time of guest's latest attendance status update. */
51
- attendanceStatusUpdatedDate?: Date | null;
52
- /**
53
- * Site member ID.
54
- * @format GUID
55
- */
56
- memberId?: string | null;
57
- /** Guest type. */
58
- guestType?: GuestType;
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
- */
63
- locale?: string | null;
64
- /**
65
- * Number of total guests in an event (registered guests + additional ones).
66
- * @readonly
67
- */
68
- totalGuests?: number | null;
69
- /**
70
- * Revision number, which increments by 1 each time the guest is updated.
71
- * @readonly
72
- */
73
- revision?: string | null;
74
- }
75
- export interface TicketDetails {
76
- /**
77
- * Ticket number.
78
- * @maxLength 36
79
- */
80
- number?: string;
81
- /**
82
- * Ticket definition ID.
83
- * @format GUID
84
- */
85
- definitionId?: string | null;
86
- /**
87
- * Ticket name.
88
- * @minLength 1
89
- * @maxLength 30
90
- */
91
- name?: string | null;
92
- }
93
- export interface TicketGuestDetails {
94
- /** The login details for the guest to access the online conference event. */
95
- onlineConferencingLogin?: OnlineConferencingLogin;
96
- /**
97
- * First name.
98
- * @maxLength 255
99
- */
100
- firstName?: string | null;
101
- /**
102
- * Last name.
103
- * @maxLength 255
104
- */
105
- lastName?: string | null;
106
- }
107
- export interface OnlineConferencingLogin {
108
- /**
109
- * Link URL to the online conference.
110
- * @format WEB_URL
111
- * @readonly
112
- */
113
- link?: string;
114
- /**
115
- * Password for the online conference.
116
- * @readonly
117
- */
118
- password?: string | null;
119
- }
120
- export interface GuestDetails {
121
- /**
122
- * Email.
123
- * @format EMAIL
124
- */
125
- email?: string | null;
126
- /**
127
- * First name.
128
- * @maxLength 255
129
- */
130
- firstName?: string | null;
131
- /**
132
- * Last name.
133
- * @maxLength 255
134
- */
135
- lastName?: string | null;
136
- /** Form response. */
137
- formResponse?: FormResponse;
138
- /** Whether the guest has checked into the event. */
139
- checkedIn?: boolean;
140
- /** The login details for the guest to access the online conference event. */
141
- onlineConferencingLogin?: OnlineConferencingLogin;
142
- /**
143
- * Phone extracted from form response. If multiples phone inputs are present, first one is returned.
144
- * @maxLength 200
145
- */
146
- phone?: string | null;
147
- /**
148
- * Address extracted from form response. If multiples address inputs are present, first one is returned.
149
- * @maxLength 200
150
- */
151
- address?: string | null;
152
- }
153
- export interface FormResponse {
154
- /**
155
- * Input values entered when filling the form.
156
- * @maxSize 200
157
- */
158
- inputValues?: InputValue[];
159
- }
160
- export interface InputValue {
161
- /**
162
- * Input field name.
163
- * @maxLength 100
164
- */
165
- inputName?: string;
166
- /**
167
- * Text entered into the input field.
168
- * @maxLength 5000
169
- */
170
- value?: string;
171
- /**
172
- * Multiple selection values. For example, the array is filled if several checkboxes are ticked.
173
- * @maxSize 100
174
- * @maxLength 5000
175
- */
176
- values?: string[];
177
- }
178
- export interface FormattedAddress {
179
- /**
180
- * One line address representation.
181
- * @maxLength 200
182
- */
183
- formatted?: string;
184
- /** Address components (optional). */
185
- address?: Address;
186
- }
187
- /** Physical address */
188
- export interface Address extends AddressStreetOneOf {
189
- /** Street name and number. */
190
- streetAddress?: StreetAddress;
191
- /** Main address line, usually street and number as free text. */
192
- addressLine?: string | null;
193
- /**
194
- * Country code.
195
- * @format COUNTRY
196
- */
197
- country?: string | null;
198
- /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
199
- subdivision?: string | null;
200
- /** City name. */
201
- city?: string | null;
202
- /** Zip/postal code. */
203
- postalCode?: string | null;
204
- /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
205
- addressLine2?: string | null;
206
- }
207
- /** @oneof */
208
- export interface AddressStreetOneOf {
209
- /** Street name and number. */
210
- streetAddress?: StreetAddress;
211
- /** Main address line, usually street and number as free text. */
212
- addressLine?: string | null;
213
- }
214
- export interface StreetAddress {
215
- /** Street number. */
216
- number?: string;
217
- /** Street name. */
218
- name?: string;
219
- }
220
- export interface AddressLocation {
221
- /** Address latitude. */
222
- latitude?: number | null;
223
- /** Address longitude. */
224
- longitude?: number | null;
225
- }
226
- export interface Subdivision {
227
- /** Short subdivision code. */
228
- code?: string;
229
- /** Subdivision full name. */
230
- name?: string;
231
- }
232
- export declare enum SubdivisionType {
233
- UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
234
- /** State */
235
- ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
236
- /** County */
237
- ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
238
- /** City/town */
239
- ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
240
- /** Neighborhood/quarter */
241
- ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
242
- /** Street/block */
243
- ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
244
- /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
245
- COUNTRY = "COUNTRY"
246
- }
247
- /** Subdivision Concordance values */
248
- export interface StandardDetails {
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
- */
253
- iso31662?: string | null;
254
- }
255
- export declare enum AttendanceStatus {
256
- /** Not attending. */
257
- NOT_ATTENDING = "NOT_ATTENDING",
258
- /** Attending. */
259
- ATTENDING = "ATTENDING",
260
- /** In a waiting list. */
261
- IN_WAITLIST = "IN_WAITLIST"
262
- }
263
- export declare enum GuestType {
264
- /** An invited guest, no ticket necessary. */
265
- RSVP = "RSVP",
266
- /** The guest who bought the ticket. */
267
- BUYER = "BUYER",
268
- /** The guest for whom the ticket was bought. */
269
- TICKET_HOLDER = "TICKET_HOLDER"
270
- }
271
- export interface GuestCountUpdated {
272
- /** Guest. */
273
- guest?: EventGuest;
274
- /**
275
- * Guest count updates.
276
- * @maxSize 2
277
- */
278
- guestCountUpdates?: GuestCountUpdate[];
279
- }
280
- export interface GuestCountUpdate {
281
- /** Attendance status. */
282
- attendanceStatus?: AttendanceStatus;
283
- /** Total guest count change. */
284
- totalGuestsDelta?: number;
285
- /** Guest count change. */
286
- countDelta?: number;
287
- }
288
- export interface MemberEventStatusUpdated {
289
- /**
290
- * Event id.
291
- * @format GUID
292
- */
293
- eventId?: string | null;
294
- /**
295
- * Member id.
296
- * @format GUID
297
- */
298
- memberId?: string | null;
299
- /** Member event status. */
300
- status?: MemberEventStatusUpdatedEventType;
301
- }
302
- export declare enum MemberEventStatusUpdatedEventType {
303
- /**
304
- * Triggered every time a guest with a specified member ID is added to the event.
305
- * This event can also be triggered if an existing guest changed their member ID.
306
- */
307
- MEMBER_JOINED = "MEMBER_JOINED",
308
- /**
309
- * Triggered every time a guest with a specified member ID is removed from the event.
310
- * This event can also be triggered if an existing guest changed their member ID.
311
- */
312
- MEMBER_LEFT = "MEMBER_LEFT",
313
- /**
314
- * Triggered every time a guest with a specified member ID whose status is `ATTENDING` is added to the event.
315
- * This event can also be triggered if an existing guest changed their member ID or changed their status to `ATTENDING`.
316
- */
317
- ATTENDING_MEMBER_JOINED = "ATTENDING_MEMBER_JOINED",
318
- /**
319
- * Triggered when the last guest with a specified member ID is removed from the event or their status changes to `ATTENDING`.
320
- * Once triggered there are no more attending guests with a specified member ID in the event.
321
- * This event can also be triggered if the last existing guest changed their member ID or their status to `NOT_ATTENDING`.
322
- */
323
- LAST_ATTENDING_MEMBER_LEFT = "LAST_ATTENDING_MEMBER_LEFT"
324
- }
325
- export interface ContactEventStatusUpdated {
326
- /**
327
- * Event id.
328
- * @format GUID
329
- */
330
- eventId?: string | null;
331
- /**
332
- * Contact id.
333
- * @format GUID
334
- */
335
- contactId?: string | null;
336
- /** Contact event status. */
337
- status?: EventType;
338
- }
339
- export declare enum EventType {
340
- /**
341
- * Triggered every time a guest with a specified contact ID is added to the event.
342
- * This event can also be triggered if an existing guest changed their contact ID.
343
- */
344
- CONTACT_JOINED = "CONTACT_JOINED",
345
- /**
346
- * Triggered every time a guest with a specified contact ID is removed from the event.
347
- * This event can also be triggered if an existing guest changed their contact ID.
348
- */
349
- CONTACT_LEFT = "CONTACT_LEFT",
350
- /**
351
- * Triggred when the last guest with a specified contact ID is removed from the event.
352
- * Once triggered there are no more guests with a specified contact ID in the event.
353
- * This event can also be triggered if the last existing guest changed their contact ID.
354
- */
355
- LAST_CONTACT_LEFT = "LAST_CONTACT_LEFT"
356
- }
357
- export interface GuestCheckedIn {
358
- /** Event guest */
359
- guest?: EventGuest;
360
- /** Event details */
361
- eventDetails?: EventDetails;
362
- }
363
- export interface EventDetails {
364
- /**
365
- * Event title.
366
- * @minLength 1
367
- * @maxLength 120
368
- * @readonly
369
- */
370
- title?: string | null;
371
- /**
372
- * Event short description.
373
- * @maxLength 500
374
- * @readonly
375
- */
376
- shortDescription?: string | null;
377
- /**
378
- * Event location.
379
- * @readonly
380
- */
381
- location?: Location;
382
- /**
383
- * Event date and time settings.
384
- * @readonly
385
- */
386
- dateAndTimeSettings?: DateAndTimeSettings;
387
- /**
388
- * Event page URL components.
389
- * @readonly
390
- */
391
- eventPageUrl?: PageUrl;
392
- /**
393
- * Event status.
394
- * @readonly
395
- */
396
- status?: Status;
397
- }
398
- export interface Location {
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
- */
403
- name?: string | null;
404
- /** Location type. */
405
- type?: LocationType;
406
- /** Exact location address. */
407
- address?: CommonAddress;
408
- /** Whether the event location is TBD. */
409
- locationTbd?: boolean | null;
410
- }
411
- export declare enum LocationType {
412
- /** Unknown location type. */
413
- UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
414
- /** Event is on-site at a specific physical location. */
415
- VENUE = "VENUE",
416
- /** Event is online, such as a virtual video conference. */
417
- ONLINE = "ONLINE"
418
- }
419
- /** Physical address */
420
- export interface CommonAddress extends CommonAddressStreetOneOf {
421
- /** Street address. */
422
- streetAddress?: CommonStreetAddress;
423
- /**
424
- * Primary address information (street and building number).
425
- * @maxLength 250
426
- */
427
- addressLine?: string | null;
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
- */
432
- country?: string | null;
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
- */
437
- subdivision?: string | null;
438
- /**
439
- * City name.
440
- * @maxLength 100
441
- */
442
- city?: string | null;
443
- /**
444
- * Zip or postal code.
445
- * @maxLength 100
446
- */
447
- postalCode?: string | null;
448
- /**
449
- * Secondary address information (suite or apartment number and room number).
450
- * @maxLength 250
451
- */
452
- addressLine2?: string | null;
453
- }
454
- /** @oneof */
455
- export interface CommonAddressStreetOneOf {
456
- /** Street address. */
457
- streetAddress?: CommonStreetAddress;
458
- /**
459
- * Primary address information (street and building number).
460
- * @maxLength 250
461
- */
462
- addressLine?: string | null;
463
- }
464
- export interface CommonStreetAddress {
465
- /**
466
- * Street number.
467
- * @maxLength 100
468
- */
469
- number?: string;
470
- /**
471
- * Street name.
472
- * @maxLength 250
473
- */
474
- name?: string;
475
- }
476
- export interface CommonAddressLocation {
477
- /**
478
- * Address latitude coordinates.
479
- * @min -90
480
- * @max 90
481
- */
482
- latitude?: number | null;
483
- /**
484
- * Address longitude coordinates.
485
- * @min -180
486
- * @max 180
487
- */
488
- longitude?: number | null;
489
- }
490
- export interface CommonSubdivision {
491
- /**
492
- * Short subdivision code.
493
- * @maxLength 100
494
- */
495
- code?: string;
496
- /**
497
- * Subdivision full name.
498
- * @maxLength 250
499
- */
500
- name?: string;
501
- }
502
- export declare enum SubdivisionSubdivisionType {
503
- UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
504
- /** State */
505
- ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
506
- /** County */
507
- ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
508
- /** City/town */
509
- ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
510
- /** Neighborhood/quarter */
511
- ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
512
- /** Street/block */
513
- ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
514
- /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
515
- COUNTRY = "COUNTRY"
516
- }
517
- export interface DateAndTimeSettings {
518
- /** Whether the event date and time are TBD. */
519
- dateAndTimeTbd?: boolean | null;
520
- /**
521
- * Message that is displayed when time and date is TBD.
522
- * @maxLength 100
523
- */
524
- dateAndTimeTbdMessage?: string | null;
525
- /** Event start date. */
526
- startDate?: Date | null;
527
- /** Event end date. */
528
- endDate?: Date | null;
529
- /**
530
- * Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
531
- * @maxLength 100
532
- */
533
- timeZoneId?: string | null;
534
- /** Whether the end date is hidden in the formatted date and time. */
535
- hideEndDate?: boolean | null;
536
- /** Whether the time zone is displayed in the formatted schedule. */
537
- showTimeZone?: boolean | null;
538
- /**
539
- * Repeating event status.
540
- * @readonly
541
- */
542
- recurrenceStatus?: RecurrenceStatusStatus;
543
- /** Event repetitions. */
544
- recurringEvents?: Recurrences;
545
- /** Formatted date and time settings. */
546
- formatted?: Formatted;
547
- }
548
- export declare enum RecurrenceStatusStatus {
549
- /** Unknown recurrance status. */
550
- UNKNOWN_STATUS = "UNKNOWN_STATUS",
551
- /** Event happens only once and can last multiple days. */
552
- ONE_TIME = "ONE_TIME",
553
- /** A series of events that repeat. */
554
- RECURRING = "RECURRING",
555
- /** Next event in a schedule of recurring events. */
556
- RECURRING_UPCOMING = "RECURRING_UPCOMING",
557
- /** Latest event that ended in a schedule of recurring events. */
558
- RECURRING_RECENTLY_ENDED = "RECURRING_RECENTLY_ENDED",
559
- /** Latest canceled event in a schedule of recurring events */
560
- RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
561
- }
562
- export interface Recurrences {
563
- /**
564
- * Individual event dates.
565
- * @maxSize 1000
566
- */
567
- individualEventDates?: Occurrence[];
568
- /**
569
- * Recurring event category ID.
570
- * @readonly
571
- * @maxLength 100
572
- */
573
- categoryId?: string | null;
574
- }
575
- export interface Occurrence {
576
- /** Event start date. */
577
- startDate?: Date | null;
578
- /** Event end date. */
579
- endDate?: Date | null;
580
- /**
581
- * Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
582
- * @maxLength 100
583
- */
584
- timeZoneId?: string | null;
585
- /** Whether the time zone is displayed in a formatted schedule. */
586
- showTimeZone?: boolean;
587
- }
588
- export interface Formatted {
589
- /**
590
- * Formatted date and time representation. <br>
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>
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`.
593
- * @readonly
594
- * @maxLength 500
595
- */
596
- dateAndTime?: string | null;
597
- /**
598
- * Formatted start date of the event. Empty for TBD schedules.
599
- * @readonly
600
- * @maxLength 500
601
- */
602
- startDate?: string | null;
603
- /**
604
- * Formatted start time of the event. Empty for TBD schedules.
605
- * @readonly
606
- * @maxLength 500
607
- */
608
- startTime?: string | null;
609
- /**
610
- * Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.
611
- * @readonly
612
- * @maxLength 500
613
- */
614
- endDate?: string | null;
615
- /**
616
- * Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.
617
- * @readonly
618
- * @maxLength 500
619
- */
620
- endTime?: string | null;
621
- }
622
- export interface PageUrl {
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
- */
627
- base?: string;
628
- /**
629
- * The path to the page. For example, `/product-page/a-product`.
630
- * @maxLength 500
631
- */
632
- path?: string;
633
- }
634
- export declare enum Status {
635
- /** Unknown event status. */
636
- UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
637
- /** Event is published and scheduled to start. */
638
- UPCOMING = "UPCOMING",
639
- /** Event has started. */
640
- STARTED = "STARTED",
641
- /** Event has ended. */
642
- ENDED = "ENDED",
643
- /** Event is canceled. */
644
- CANCELED = "CANCELED",
645
- /** Event is not public. */
646
- DRAFT = "DRAFT"
647
- }
648
- export interface NotifyGuestAction {
649
- /** Event guest. */
650
- guest?: EventGuest;
651
- /** Task context. */
652
- taskContext?: TaskContext;
653
- }
654
- export interface TaskContext {
655
- /** Task id. */
656
- id?: string | null;
657
- /** Notify action type. */
658
- type?: NotifyActionType;
659
- /** Timing. Used for EVENT_STARTS */
660
- timing?: Timing;
661
- /** Event context. */
662
- event?: EventDetails;
663
- /** Order context. */
664
- order?: OrderDetails;
665
- }
666
- export declare enum NotifyActionType {
667
- UNKNOWN = "UNKNOWN",
668
- EMAIL = "EMAIL",
669
- AUTOMATION_TRIGGER = "AUTOMATION_TRIGGER",
670
- PUSH = "PUSH",
671
- EVENT_CANCELED = "EVENT_CANCELED",
672
- EVENT_STARTS = "EVENT_STARTS",
673
- ORDER_CANCELED = "ORDER_CANCELED"
674
- }
675
- export declare enum Timing {
676
- /** Unknown event start time. */
677
- UNKNOWN_TIMING = "UNKNOWN_TIMING",
678
- /** Instant. */
679
- NOW = "NOW",
680
- /** 24 hours prior. */
681
- STARTS_IN_1_DAY = "STARTS_IN_1_DAY",
682
- /** 3 days prior. */
683
- STARTS_IN_3_DAYS = "STARTS_IN_3_DAYS",
684
- /** 7 days prior. */
685
- STARTS_IN_1_WEEK = "STARTS_IN_1_WEEK",
686
- /** 1 hour prior. */
687
- STARTS_IN_1_HOUR = "STARTS_IN_1_HOUR",
688
- /** 30 minutes prior. */
689
- STARTS_IN_30_MINUTES = "STARTS_IN_30_MINUTES",
690
- /** 2 hours prior. */
691
- STARTS_IN_2_HOURS = "STARTS_IN_2_HOURS"
692
- }
693
- export interface OrderDetails {
694
- /** Order status */
695
- orderStatus?: OrderStatus;
696
- /** Invoice */
697
- invoice?: Invoice;
698
- }
699
- export declare enum OrderStatus {
700
- /** Order status not available for this request fieldset. */
701
- NA_ORDER_STATUS = "NA_ORDER_STATUS",
702
- /** Order is confirmed and payment isn't required. */
703
- FREE = "FREE",
704
- /** Order is paid for but the payment gateway has suspended the payment. */
705
- PENDING = "PENDING",
706
- /** Order is paid via a payment gateway. */
707
- PAID = "PAID",
708
- /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
709
- OFFLINE_PENDING = "OFFLINE_PENDING",
710
- /** Order is awaiting payment at the cashier. */
711
- INITIATED = "INITIATED",
712
- /** Order is canceled. */
713
- CANCELED = "CANCELED",
714
- /** Order payment is declined. */
715
- DECLINED = "DECLINED",
716
- /** Order payment is authorized. */
717
- AUTHORIZED = "AUTHORIZED",
718
- /** Order payment is voided. */
719
- VOIDED = "VOIDED",
720
- /** Order is partially paid with less than the total amount. */
721
- PARTIALLY_PAID = "PARTIALLY_PAID"
722
- }
723
- export interface Invoice {
724
- items?: Item[];
725
- /**
726
- * Total cart amount.
727
- * @deprecated
728
- */
729
- total?: Money;
730
- /** Discount applied to cart. */
731
- discount?: Discount;
732
- /** Tax applied to cart. */
733
- tax?: Tax;
734
- /** Total cart amount before discount, tax, and fees. */
735
- subTotal?: Money;
736
- /**
737
- * Total amount of cart after discount, tax, and fees.
738
- * Grand total is calculated in the following order:
739
- * 1. Total prices of all items in the cart are calculated.
740
- * 2. Discount is subtracted from the cart (if applicable).
741
- * 3. Tax is added (if applicable).
742
- * 4. Wix ticket service fee is added.
743
- */
744
- grandTotal?: Money;
745
- /**
746
- * Fees applied to the cart.
747
- * @readonly
748
- */
749
- fees?: Fee[];
750
- /** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
751
- revenue?: Money;
752
- /** URL to invoice preview. Returned only if order is paid. */
753
- previewUrl?: string | null;
754
- }
755
- export interface Item {
756
- /**
757
- * Unique line item ID.
758
- * @format GUID
759
- */
760
- id?: string;
761
- /**
762
- * Line item quantity.
763
- * @min 1
764
- * @max 50
765
- */
766
- quantity?: number;
767
- /** Line item name. */
768
- name?: string;
769
- /** Line item price. */
770
- price?: Money;
771
- /** Total price for line items. Always equal to price * quantity. */
772
- total?: Money;
773
- /** Discount applied to the line item. */
774
- discount?: Discount;
775
- /** Tax applied to the item. */
776
- tax?: Tax;
777
- /**
778
- * Fees applied to the item.
779
- * @readonly
780
- */
781
- fees?: Fee[];
782
- }
783
- export interface Money {
784
- /**
785
- * *Deprecated:** Use `value` instead.
786
- * @format DECIMAL_VALUE
787
- * @deprecated
788
- */
789
- amount?: string;
790
- /**
791
- * ISO 4217 format of the currency e.g., `USD`.
792
- * @format CURRENCY
793
- */
794
- currency?: string;
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
- */
799
- value?: string | null;
800
- }
801
- export interface Discount {
802
- /** Total discount amount. */
803
- amount?: Money;
804
- /** Total charge after applied discount. */
805
- afterDiscount?: Money;
806
- /**
807
- * Discount coupon code.
808
- * @deprecated
809
- */
810
- code?: string;
811
- /**
812
- * Discount coupon name.
813
- * @deprecated
814
- */
815
- name?: string;
816
- /**
817
- * Discount coupon ID.
818
- * @deprecated
819
- */
820
- couponId?: string;
821
- /** Discount items. */
822
- discounts?: DiscountItem[];
823
- }
824
- export interface DiscountItem extends DiscountItemDiscountOneOf {
825
- /** Coupon discount. */
826
- coupon?: CouponDiscount;
827
- /** Pricing plan discount. */
828
- paidPlan?: PaidPlanDiscount;
829
- /** Total discount amount. */
830
- amount?: Money;
831
- }
832
- /** @oneof */
833
- export interface DiscountItemDiscountOneOf {
834
- /** Coupon discount. */
835
- coupon?: CouponDiscount;
836
- /** Pricing plan discount. */
837
- paidPlan?: PaidPlanDiscount;
838
- }
839
- export interface CouponDiscount {
840
- /** Discount coupon name. */
841
- name?: string;
842
- /** Discount coupon code. */
843
- code?: string;
844
- /** Discount coupon ID. */
845
- couponId?: string;
846
- }
847
- export interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
848
- /** Discount by percentage applied to tickets. */
849
- percentDiscount?: PercentDiscount;
850
- /** Name of pricing plan. */
851
- name?: string;
852
- }
853
- /** @oneof */
854
- export interface PaidPlanDiscountDiscountOneOf {
855
- /** Discount by percentage applied to tickets. */
856
- percentDiscount?: PercentDiscount;
857
- }
858
- export interface PercentDiscount {
859
- /**
860
- * Percent rate.
861
- * @decimalValue options { gte:0.01, lte:100, maxScale:2 }
862
- */
863
- rate?: string;
864
- /** Number of discounted tickets. */
865
- quantityDiscounted?: number;
866
- }
867
- export interface Tax {
868
- /** Tax type. */
869
- type?: TaxType;
870
- /**
871
- * Tax name.
872
- * @readonly
873
- */
874
- name?: string;
875
- /**
876
- * Tax rate.
877
- * @format DECIMAL_VALUE
878
- */
879
- rate?: string;
880
- /** Taxable amount. */
881
- taxable?: Money;
882
- /** Total tax amount. */
883
- amount?: Money;
884
- }
885
- export declare enum TaxType {
886
- /** Tax is included in the ticket price. */
887
- INCLUDED = "INCLUDED",
888
- /** Tax is added to the order at the checkout. */
889
- ADDED = "ADDED",
890
- /** Tax is added to the final total at the checkout. */
891
- ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
892
- }
893
- export interface Fee {
894
- /** Fee identifier. */
895
- name?: FeeName;
896
- /** How fee is calculated. */
897
- type?: FeeType;
898
- /**
899
- * Fee rate.
900
- * @format DECIMAL_VALUE
901
- * @readonly
902
- */
903
- rate?: string;
904
- /** Total amount of fee charges. */
905
- amount?: Money;
906
- }
907
- export declare enum FeeName {
908
- /** Wix ticket service fee charges applied to the line item. */
909
- WIX_FEE = "WIX_FEE"
910
- }
911
- export declare enum FeeType {
912
- /** Fee is added to the ticket price at checkout. */
913
- FEE_ADDED = "FEE_ADDED",
914
- /** Seller absorbs the fee. It is deducted from the ticket price. */
915
- FEE_INCLUDED = "FEE_INCLUDED",
916
- /** Fee is added to the ticket price at checkout. */
917
- FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
918
- }
919
- export interface GuestEventCanceled {
920
- /** Event guest. */
921
- guest?: EventGuest;
922
- /** Event context. */
923
- event?: EventDetails;
924
- }
925
- export interface GuestEventStarts {
926
- /** Event guest. */
927
- guest?: EventGuest;
928
- /** Event context. */
929
- event?: EventDetails;
930
- /** Timing */
931
- timing?: Timing;
932
- }
933
- export interface GuestOrderCanceled {
934
- /** Event guest. */
935
- guest?: EventGuest;
936
- /** Event context. */
937
- event?: EventDetails;
938
- /** Order context. */
939
- order?: OrderDetails;
940
- }
941
- export interface DomainEvent extends DomainEventBodyOneOf {
942
- createdEvent?: EntityCreatedEvent;
943
- updatedEvent?: EntityUpdatedEvent;
944
- deletedEvent?: EntityDeletedEvent;
945
- actionEvent?: ActionEvent;
946
- /**
947
- * Unique event ID.
948
- * Allows clients to ignore duplicate webhooks.
949
- */
950
- id?: string;
951
- /**
952
- * Assumes actions are also always typed to an entity_type
953
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
954
- */
955
- entityFqdn?: string;
956
- /**
957
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
958
- * This is although the created/updated/deleted notion is duplication of the oneof types
959
- * Example: created/updated/deleted/started/completed/email_opened
960
- */
961
- slug?: string;
962
- /** ID of the entity associated with the event. */
963
- entityId?: string;
964
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
965
- eventTime?: Date | null;
966
- /**
967
- * Whether the event was triggered as a result of a privacy regulation application
968
- * (for example, GDPR).
969
- */
970
- triggeredByAnonymizeRequest?: boolean | null;
971
- /** If present, indicates the action that triggered the event. */
972
- originatedFrom?: string | null;
973
- /**
974
- * A sequence number defining the order of updates to the underlying entity.
975
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
976
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
977
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
978
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
979
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
980
- */
981
- entityEventSequence?: string | null;
982
- }
983
- /** @oneof */
984
- export interface DomainEventBodyOneOf {
985
- createdEvent?: EntityCreatedEvent;
986
- updatedEvent?: EntityUpdatedEvent;
987
- deletedEvent?: EntityDeletedEvent;
988
- actionEvent?: ActionEvent;
989
- }
990
- export interface EntityCreatedEvent {
991
- entityAsJson?: string;
992
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
993
- restoreInfo?: RestoreInfo;
994
- }
995
- export interface RestoreInfo {
996
- deletedDate?: Date | null;
997
- }
998
- export interface EntityUpdatedEvent {
999
- /**
1000
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1001
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1002
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1003
- */
1004
- currentEntityAsJson?: string;
1005
- }
1006
- export interface EntityDeletedEvent {
1007
- /** Entity that was deleted */
1008
- deletedEntityAsJson?: string | null;
1009
- }
1010
- export interface ActionEvent {
1011
- bodyAsJson?: string;
1012
- }
1013
- export interface MessageEnvelope {
1014
- /**
1015
- * App instance ID.
1016
- * @format GUID
1017
- */
1018
- instanceId?: string | null;
1019
- /**
1020
- * Event type.
1021
- * @maxLength 150
1022
- */
1023
- eventType?: string;
1024
- /** The identification type and identity data. */
1025
- identity?: IdentificationData;
1026
- /** Stringify payload. */
1027
- data?: string;
1028
- }
1029
- export interface IdentificationData extends IdentificationDataIdOneOf {
1030
- /**
1031
- * ID of a site visitor that has not logged in to the site.
1032
- * @format GUID
1033
- */
1034
- anonymousVisitorId?: string;
1035
- /**
1036
- * ID of a site visitor that has logged in to the site.
1037
- * @format GUID
1038
- */
1039
- memberId?: string;
1040
- /**
1041
- * ID of a Wix user (site owner, contributor, etc.).
1042
- * @format GUID
1043
- */
1044
- wixUserId?: string;
1045
- /**
1046
- * ID of an app.
1047
- * @format GUID
1048
- */
1049
- appId?: string;
1050
- /** @readonly */
1051
- identityType?: WebhookIdentityType;
1052
- }
1053
- /** @oneof */
1054
- export interface IdentificationDataIdOneOf {
1055
- /**
1056
- * ID of a site visitor that has not logged in to the site.
1057
- * @format GUID
1058
- */
1059
- anonymousVisitorId?: string;
1060
- /**
1061
- * ID of a site visitor that has logged in to the site.
1062
- * @format GUID
1063
- */
1064
- memberId?: string;
1065
- /**
1066
- * ID of a Wix user (site owner, contributor, etc.).
1067
- * @format GUID
1068
- */
1069
- wixUserId?: string;
1070
- /**
1071
- * ID of an app.
1072
- * @format GUID
1073
- */
1074
- appId?: string;
1075
- }
1076
- export declare enum WebhookIdentityType {
1077
- UNKNOWN = "UNKNOWN",
1078
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1079
- MEMBER = "MEMBER",
1080
- WIX_USER = "WIX_USER",
1081
- APP = "APP"
1082
- }
1083
- export interface QueryEventGuestsRequest {
1084
- /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
1085
- query: QueryV2;
1086
- /**
1087
- * Predefined sets of fields to return.
1088
- * @maxSize 3
1089
- */
1090
- fields?: RequestedFieldsEnumRequestedFields[];
1091
- }
1092
- export interface QueryV2 extends QueryV2PagingMethodOneOf {
1093
- /** Paging options to limit and skip the number of items. */
1094
- paging?: Paging;
1095
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1096
- cursorPaging?: CursorPaging;
1097
- /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }`. <br/> <br/> **Example:** <br/> `"filter" : { "eventId": "sd3f-jhds-4fs77", "ticketNumber": {"$startsWith":"478"} }` <br/> <br/> See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort) for more information. */
1098
- filter?: Record<string, any> | null;
1099
- /** Sort object in the following format: <br/> `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]` <br/> <br/> **Example:** <br/> `[{"fieldName":"createdDate","direction":"DESC"}]` <br/> <br/> See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort) for more information. */
1100
- sort?: Sorting[];
1101
- /**
1102
- * Currently the only supported fieldset is `guestDetails`. The `WIX_EVENTS.READ_GUESTS_DETAILS` permission is required to access the guest details. <br/> <br/> See [field projection](https://dev.wix.com/api/rest/getting-started/field-projection) for more information.
1103
- * @deprecated Currently the only supported fieldset is `guestDetails`. The `WIX_EVENTS.READ_GUESTS_DETAILS` permission is required to access the guest details. <br/> <br/> See [field projection](https://dev.wix.com/api/rest/getting-started/field-projection) for more information.
1104
- * @replacedBy fields
1105
- * @targetRemovalDate 2024-06-30
1106
- */
1107
- fieldsets?: string[];
1108
- }
1109
- /** @oneof */
1110
- export interface QueryV2PagingMethodOneOf {
1111
- /** Paging options to limit and skip the number of items. */
1112
- paging?: Paging;
1113
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1114
- cursorPaging?: CursorPaging;
1115
- }
1116
- export interface Sorting {
1117
- /**
1118
- * Name of the field to sort by.
1119
- * @maxLength 512
1120
- */
1121
- fieldName?: string;
1122
- /** Sort order. */
1123
- order?: SortOrder;
1124
- }
1125
- export declare enum SortOrder {
1126
- ASC = "ASC",
1127
- DESC = "DESC"
1128
- }
1129
- export interface Paging {
1130
- /**
1131
- * Number of items to load.
1132
- * @max 1000
1133
- */
1134
- limit?: number | null;
1135
- /** Number of items to skip in the current sort order. */
1136
- offset?: number | null;
1137
- }
1138
- export interface CursorPaging {
1139
- /**
1140
- * Maximum number of items to return in the results.
1141
- * @max 1000
1142
- */
1143
- limit?: number | null;
1144
- /**
1145
- * Pointer to the next or previous page in the list of results.
1146
- *
1147
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1148
- * Not relevant for the first request.
1149
- * @maxLength 16000
1150
- */
1151
- cursor?: string | null;
1152
- }
1153
- export declare enum RequestedFieldsEnumRequestedFields {
1154
- /** Unknown requested field. */
1155
- UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
1156
- /** Returns `guestDetails` and `tickets`. */
1157
- GUEST_DETAILS = "GUEST_DETAILS",
1158
- /** Returns `totalGuests`. */
1159
- GUEST_TOTAL = "GUEST_TOTAL"
1160
- }
1161
- export interface QueryEventGuestsResponse {
1162
- /** List of guests. */
1163
- guests?: EventGuest[];
1164
- /** Metadata for the paginated results. */
1165
- pagingMetadata?: PagingMetadataV2;
1166
- }
1167
- export interface PagingMetadataV2 {
1168
- /** Number of items returned in the response. */
1169
- count?: number | null;
1170
- /** Offset that was requested. */
1171
- offset?: number | null;
1172
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
1173
- total?: number | null;
1174
- /** Flag that indicates the server failed to calculate the `total` field. */
1175
- tooManyToCount?: boolean | null;
1176
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
1177
- cursors?: Cursors;
1178
- }
1179
- export interface Cursors {
1180
- /**
1181
- * Cursor string pointing to the next page in the list of results.
1182
- * @maxLength 16000
1183
- */
1184
- next?: string | null;
1185
- /**
1186
- * Cursor pointing to the previous page in the list of results.
1187
- * @maxLength 16000
1188
- */
1189
- prev?: string | null;
1190
- }
1191
- export interface StreamEventGuestsRequest {
1192
- /** Filter. */
1193
- filter?: Record<string, any> | null;
1194
- /** Task context. */
1195
- taskContext?: TaskContext;
1196
- }
1197
- export interface Empty {
1198
- }
1199
- export interface SecondaryLanguagesRequest {
1200
- /**
1201
- * Guest event id.
1202
- * @format GUID
1203
- */
1204
- eventId?: string;
1205
- }
1206
- export interface SecondaryLanguagesResponse {
1207
- /**
1208
- * Aggregated guests secondary languages.
1209
- * @format LANGUAGE
1210
- */
1211
- secondaryLanguages?: string[];
1212
- /** Aggregated guests languages. */
1213
- languages?: Language[];
1214
- }
1215
- export interface Language {
1216
- /**
1217
- * Guest language.
1218
- * @format LANGUAGE
1219
- */
1220
- language?: string | null;
1221
- /**
1222
- * Guest locale.
1223
- * @format LANGUAGE_TAG
1224
- */
1225
- locale?: string | null;
1226
- }
1227
- export interface OrderConfirmed {
1228
- /** Order confirmation timestamp in ISO UTC. */
1229
- timestamp?: Date | null;
1230
- /**
1231
- * Site language when Order initiated
1232
- * @format LANGUAGE
1233
- */
1234
- language?: string | null;
1235
- /** Notifications silenced for this domain event. */
1236
- silent?: boolean | null;
1237
- /**
1238
- * Locale in which Order was created.
1239
- * @format LANGUAGE_TAG
1240
- */
1241
- locale?: string | null;
1242
- /**
1243
- * Event ID.
1244
- * @format GUID
1245
- */
1246
- eventId?: string;
1247
- /** Unique order number. */
1248
- orderNumber?: string;
1249
- /** Contact ID associated with this order. */
1250
- contactId?: string;
1251
- /**
1252
- * Member ID associated with this order.
1253
- * @format GUID
1254
- */
1255
- memberId?: string | null;
1256
- /**
1257
- * Order created timestamp
1258
- * @readonly
1259
- */
1260
- created?: Date | null;
1261
- /** Buyer first name. */
1262
- firstName?: string;
1263
- /** Buyer last name. */
1264
- lastName?: string;
1265
- /** Buyer email address. */
1266
- email?: string;
1267
- /** Checkout form response. */
1268
- checkoutForm?: FormResponse;
1269
- /** Order status. */
1270
- status?: OrderStatus;
1271
- /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
1272
- method?: string | null;
1273
- /** Tickets (generated after payment). */
1274
- tickets?: Ticket[];
1275
- /** Invoice. */
1276
- invoice?: Invoice;
1277
- /** Reservation ID associated with this order. */
1278
- reservationId?: string;
1279
- }
1280
- export interface Ticket {
1281
- /** Unique issued ticket number. */
1282
- ticketNumber?: string;
1283
- /**
1284
- * Ticket definition ID.
1285
- * @format GUID
1286
- */
1287
- ticketDefinitionId?: string;
1288
- /** Ticket check-in. */
1289
- checkIn?: CheckIn;
1290
- /** Ticket price. */
1291
- price?: Money;
1292
- /** Whether ticket is archived. */
1293
- archived?: boolean;
1294
- /** Guest first name. */
1295
- firstName?: string | null;
1296
- /** Guest last name. */
1297
- lastName?: string | null;
1298
- /** Guest email. */
1299
- email?: string | null;
1300
- /**
1301
- * Contact ID associated with this ticket.
1302
- * @format GUID
1303
- */
1304
- contactId?: string | null;
1305
- /** Whether ticket is confirmed */
1306
- confirmed?: boolean;
1307
- /**
1308
- * Member ID associated with this ticket.
1309
- * @format GUID
1310
- */
1311
- memberId?: string | null;
1312
- /** Ticket form response (only assigned tickets contain separate forms). */
1313
- form?: FormResponse;
1314
- /** Ticket name. */
1315
- ticketName?: string;
1316
- /** Anonymized tickets no longer contain personally identifiable information (PII). */
1317
- anonymized?: boolean;
1318
- /** URL and password to online conference */
1319
- onlineConferencingLogin?: OnlineConferencingLogin;
1320
- /**
1321
- * Seat ID associated with this ticket.
1322
- * @maxLength 36
1323
- */
1324
- seatId?: string | null;
1325
- /** Whether ticket is canceled. */
1326
- canceled?: boolean | null;
1327
- }
1328
- export interface CheckIn {
1329
- /** Time of check-in */
1330
- created?: Date | null;
1331
- }
1332
- export interface OrderUpdated {
1333
- /** Order updated timestamp in ISO UTC format. */
1334
- timestamp?: Date | null;
1335
- /**
1336
- * Site language when Order initiated
1337
- * @format LANGUAGE
1338
- */
1339
- language?: string | null;
1340
- /**
1341
- * Locale in which Order was created.
1342
- * @format LANGUAGE_TAG
1343
- */
1344
- locale?: string | null;
1345
- /**
1346
- * Event ID.
1347
- * @format GUID
1348
- */
1349
- eventId?: string;
1350
- /** Unique order number. */
1351
- orderNumber?: string;
1352
- /** Contact ID associated with this order. */
1353
- contactId?: string;
1354
- /**
1355
- * Member ID associated with this order.
1356
- * @format GUID
1357
- */
1358
- memberId?: string | null;
1359
- /**
1360
- * Order created timestamp.
1361
- * @readonly
1362
- */
1363
- created?: Date | null;
1364
- /**
1365
- * Order updated timestamp.
1366
- * @readonly
1367
- */
1368
- updated?: Date | null;
1369
- /** Buyer first name. */
1370
- firstName?: string;
1371
- /** Buyer last name. */
1372
- lastName?: string;
1373
- /** Buyer email. */
1374
- email?: string;
1375
- /** Checkout form response. */
1376
- checkoutForm?: FormResponse;
1377
- /** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
1378
- confirmed?: boolean;
1379
- /** Order status. */
1380
- status?: OrderStatus;
1381
- /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
1382
- method?: string | null;
1383
- /** Tickets generated after payment. */
1384
- tickets?: Ticket[];
1385
- /** Whether order was archived and excluded from results. */
1386
- archived?: boolean;
1387
- /** Whether event was triggered by GDPR delete request. */
1388
- triggeredByAnonymizeRequest?: boolean;
1389
- }
1390
- export interface OrderDeleted {
1391
- /** Order deleted timestamp in ISO UTC format. */
1392
- timestamp?: Date | null;
1393
- /**
1394
- * Event ID.
1395
- * @format GUID
1396
- */
1397
- eventId?: string;
1398
- /** Unique order number. */
1399
- orderNumber?: string;
1400
- /** Contact ID associated with this order */
1401
- contactId?: string;
1402
- /**
1403
- * Member ID associated with this order.
1404
- * @format GUID
1405
- */
1406
- memberId?: string | null;
1407
- /**
1408
- * Order created timestamp.
1409
- * @readonly
1410
- */
1411
- created?: Date | null;
1412
- /**
1413
- * Order updated timestamp.
1414
- * @readonly
1415
- */
1416
- updated?: Date | null;
1417
- /** Whether order was anonymized by GDPR delete. */
1418
- anonymized?: boolean;
1419
- /** Order type. */
1420
- orderType?: OrderType;
1421
- /** Whether event was triggered by GDPR delete request. */
1422
- triggeredByAnonymizeRequest?: boolean;
1423
- /** Tickets generated after payment. */
1424
- tickets?: Ticket[];
1425
- }
1426
- export declare enum OrderType {
1427
- /** Buyer form is used for all tickets. */
1428
- UNASSIGNED_TICKETS = "UNASSIGNED_TICKETS",
1429
- /** Each order ticket has its own form. */
1430
- ASSIGNED_TICKETS = "ASSIGNED_TICKETS"
1431
- }
1432
- export interface EventDeleted {
1433
- /** Event deleted timestamp in ISO UTC format. */
1434
- timestamp?: Date | null;
1435
- /**
1436
- * Event ID.
1437
- * @format GUID
1438
- */
1439
- eventId?: string;
1440
- /** Event title. */
1441
- title?: string;
1442
- /**
1443
- * Event creator user ID.
1444
- * @format GUID
1445
- */
1446
- userId?: string | null;
1447
- }
1448
- export interface Task {
1449
- key?: TaskKey;
1450
- executeAt?: Date | null;
1451
- payload?: string | null;
1452
- }
1453
- export interface TaskKey {
1454
- appId?: string;
1455
- instanceId?: string;
1456
- subjectId?: string | null;
1457
- }
1458
- export interface ListGuestListPreviewsRequest {
1459
- /**
1460
- * Event ids.
1461
- * @format GUID
1462
- * @maxSize 50
1463
- */
1464
- eventIds?: string[];
1465
- /** Cursor paging. */
1466
- cursorPaging?: CursorPaging;
1467
- /**
1468
- * Requested fields.
1469
- * @maxSize 5
1470
- */
1471
- fields?: RequestedFields[];
1472
- }
1473
- export declare enum RequestedFields {
1474
- /** Unknown requested field. */
1475
- UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
1476
- /** Member guests. */
1477
- MEMBER_GUESTS = "MEMBER_GUESTS",
1478
- /** Waitlist count. */
1479
- WAITLIST_COUNT = "WAITLIST_COUNT"
1480
- }
1481
- export interface ListGuestListPreviewsResponse {
1482
- /**
1483
- * List of guests.
1484
- * @maxSize 50
1485
- */
1486
- previews?: GuestListPreview[];
1487
- /** Metadata for the paginated results. */
1488
- pagingMetadata?: PagingMetadataV2;
1489
- }
1490
- export interface GuestListPreview {
1491
- /**
1492
- * Event id.
1493
- * @format GUID
1494
- */
1495
- eventId?: string;
1496
- /** Attending guests count. */
1497
- attending?: GuestCount;
1498
- /** Waiting guests count. */
1499
- inWaitlist?: GuestCount;
1500
- /** Not attending guests count. */
1501
- notAttending?: GuestCount;
1502
- /** Latest attending members. */
1503
- latestAttendingMembers?: MemberGuests;
1504
- }
1505
- export interface GuestCount {
1506
- /** Total guest count. For Rsvp Event every RSVP guest and additional guest count, for Ticketed Event count of TICKET_HOLDER */
1507
- totalEventGuests?: number;
1508
- /** EventGuest count (RSVP, TICKET_HOLDER, BUYER); */
1509
- count?: number;
1510
- }
1511
- export interface MemberGuests {
1512
- /**
1513
- * Member guests
1514
- * @maxSize 8
1515
- */
1516
- guests?: MemberGuest[];
1517
- }
1518
- export interface MemberGuest {
1519
- /**
1520
- * Member id
1521
- * @format GUID
1522
- */
1523
- memberId?: string;
1524
- }
1525
- export interface UpdateGuestRequest {
1526
- /** Updated guest */
1527
- guest?: EventGuest;
1528
- /** Guest revision */
1529
- revision?: string | null;
1530
- }
1531
- export interface UpdateGuestResponse {
1532
- /** Updated guest */
1533
- guest?: EventGuest;
1534
- }
1535
- interface OnlineConferencingLoginNonNullableFields {
1536
- link: string;
1537
- }
1538
- interface TicketGuestDetailsNonNullableFields {
1539
- onlineConferencingLogin?: OnlineConferencingLoginNonNullableFields;
1540
- }
1541
- interface TicketDetailsNonNullableFields {
1542
- number: string;
1543
- guestDetails?: TicketGuestDetailsNonNullableFields;
1544
- }
1545
- interface StreetAddressNonNullableFields {
1546
- number: string;
1547
- name: string;
1548
- apt: string;
1549
- }
1550
- interface SubdivisionNonNullableFields {
1551
- code: string;
1552
- name: string;
1553
- type: SubdivisionType;
1554
- }
1555
- interface AddressNonNullableFields {
1556
- streetAddress?: StreetAddressNonNullableFields;
1557
- subdivisions: SubdivisionNonNullableFields[];
1558
- }
1559
- interface FormattedAddressNonNullableFields {
1560
- formatted: string;
1561
- address?: AddressNonNullableFields;
1562
- }
1563
- interface InputValueNonNullableFields {
1564
- inputName: string;
1565
- value: string;
1566
- values: string[];
1567
- address?: FormattedAddressNonNullableFields;
1568
- }
1569
- interface FormResponseNonNullableFields {
1570
- inputValues: InputValueNonNullableFields[];
1571
- }
1572
- interface GuestDetailsNonNullableFields {
1573
- formResponse?: FormResponseNonNullableFields;
1574
- checkedIn: boolean;
1575
- onlineConferencingLogin?: OnlineConferencingLoginNonNullableFields;
1576
- }
1577
- interface EventGuestNonNullableFields {
1578
- tickets: TicketDetailsNonNullableFields[];
1579
- guestDetails?: GuestDetailsNonNullableFields;
1580
- attendanceStatus: AttendanceStatus;
1581
- guestType: GuestType;
1582
- }
1583
- export interface QueryEventGuestsResponseNonNullableFields {
1584
- guests: EventGuestNonNullableFields[];
1585
- }
1586
- export {};