@wix/auto_sdk_events_guests 1.0.18 → 1.0.20

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