@wix/auto_sdk_events_guests 1.0.11 → 1.0.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/events-guests-v1-guest-guests.context.d.ts +41 -0
- package/build/cjs/src/events-guests-v1-guest-guests.context.js +64 -0
- package/build/cjs/src/events-guests-v1-guest-guests.context.js.map +1 -0
- package/build/cjs/src/events-guests-v1-guest-guests.http.d.ts +22 -0
- package/build/cjs/src/events-guests-v1-guest-guests.http.js +122 -0
- package/build/cjs/src/events-guests-v1-guest-guests.http.js.map +1 -0
- package/build/cjs/src/events-guests-v1-guest-guests.meta.d.ts +13 -0
- package/build/cjs/src/events-guests-v1-guest-guests.meta.js +47 -0
- package/build/cjs/src/events-guests-v1-guest-guests.meta.js.map +1 -0
- package/build/cjs/src/events-guests-v1-guest-guests.public.d.ts +37 -0
- package/build/cjs/src/events-guests-v1-guest-guests.public.js +282 -0
- package/build/cjs/src/events-guests-v1-guest-guests.public.js.map +1 -0
- package/build/cjs/src/events-guests-v1-guest-guests.types.d.ts +1534 -0
- package/build/cjs/src/events-guests-v1-guest-guests.types.js +251 -0
- package/build/cjs/src/events-guests-v1-guest-guests.types.js.map +1 -0
- package/build/{events-guests-v1-guest-guests.universal-Cj6-k5Jw.d.mts → cjs/src/events-guests-v1-guest-guests.universal.d.ts} +282 -122
- package/build/cjs/src/events-guests-v1-guest-guests.universal.js +371 -0
- package/build/cjs/src/events-guests-v1-guest-guests.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/events-guests-v1-guest-guests.context.d.ts +41 -0
- package/build/es/src/events-guests-v1-guest-guests.context.js +41 -0
- package/build/es/src/events-guests-v1-guest-guests.context.js.map +1 -0
- package/build/es/src/events-guests-v1-guest-guests.http.d.ts +22 -0
- package/build/es/src/events-guests-v1-guest-guests.http.js +118 -0
- package/build/es/src/events-guests-v1-guest-guests.http.js.map +1 -0
- package/build/es/src/events-guests-v1-guest-guests.meta.d.ts +13 -0
- package/build/es/src/events-guests-v1-guest-guests.meta.js +20 -0
- package/build/es/src/events-guests-v1-guest-guests.meta.js.map +1 -0
- package/build/es/src/events-guests-v1-guest-guests.public.d.ts +37 -0
- package/build/es/src/events-guests-v1-guest-guests.public.js +258 -0
- package/build/es/src/events-guests-v1-guest-guests.public.js.map +1 -0
- package/build/es/src/events-guests-v1-guest-guests.types.d.ts +1534 -0
- package/build/es/src/events-guests-v1-guest-guests.types.js +248 -0
- package/build/es/src/events-guests-v1-guest-guests.types.js.map +1 -0
- package/build/{events-guests-v1-guest-guests.universal-Cj6-k5Jw.d.ts → es/src/events-guests-v1-guest-guests.universal.d.ts} +282 -122
- package/build/es/src/events-guests-v1-guest-guests.universal.js +344 -0
- package/build/es/src/events-guests-v1-guest-guests.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.context.d.ts +41 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.context.js +64 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.context.js.map +1 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.http.d.ts +22 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.http.js +122 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.http.js.map +1 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.meta.d.ts +13 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.meta.js +47 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.meta.js.map +1 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.public.d.ts +37 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.public.js +282 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.public.js.map +1 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.types.d.ts +1534 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.types.js +251 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.types.js.map +1 -0
- package/build/internal/{events-guests-v1-guest-guests.universal-Cj6-k5Jw.d.mts → cjs/src/events-guests-v1-guest-guests.universal.d.ts} +282 -122
- package/build/internal/cjs/src/events-guests-v1-guest-guests.universal.js +371 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.context.d.ts +41 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.context.js +41 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.context.js.map +1 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.http.d.ts +22 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.http.js +118 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.http.js.map +1 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.meta.d.ts +13 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.meta.js +20 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.meta.js.map +1 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.public.d.ts +37 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.public.js +258 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.public.js.map +1 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.types.d.ts +1534 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.types.js +248 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.types.js.map +1 -0
- package/build/internal/{events-guests-v1-guest-guests.universal-Cj6-k5Jw.d.ts → es/src/events-guests-v1-guest-guests.universal.d.ts} +282 -122
- package/build/internal/es/src/events-guests-v1-guest-guests.universal.js +344 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.universal.js.map +1 -0
- package/package.json +13 -14
- package/build/index.d.mts +0 -61
- package/build/index.d.ts +0 -61
- package/build/index.js +0 -711
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -660
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -61
- package/build/internal/index.d.ts +0 -61
- package/build/internal/index.js +0 -711
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -660
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.d.mts +0 -303
- package/build/internal/meta.d.ts +0 -303
- package/build/internal/meta.js +0 -149
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -122
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.d.mts +0 -303
- package/build/meta.d.ts +0 -303
- package/build/meta.js +0 -149
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -122
- package/build/meta.mjs.map +0 -1
package/build/meta.d.mts
DELETED
|
@@ -1,303 +0,0 @@
|
|
|
1
|
-
import { aq as QueryEventGuestsRequest$1, aw as QueryEventGuestsResponse$1 } from './events-guests-v1-guest-guests.universal-Cj6-k5Jw.mjs';
|
|
2
|
-
|
|
3
|
-
interface EventGuest {
|
|
4
|
-
/**
|
|
5
|
-
* Guest ID.
|
|
6
|
-
* @format GUID
|
|
7
|
-
*/
|
|
8
|
-
id?: string | null;
|
|
9
|
-
/**
|
|
10
|
-
* Event ID.
|
|
11
|
-
* @format GUID
|
|
12
|
-
*/
|
|
13
|
-
eventId?: string | null;
|
|
14
|
-
/**
|
|
15
|
-
* RSVP ID. <br/> <br/> **Note:** Only applicable when `guestType` is `RSVP`.
|
|
16
|
-
* @format GUID
|
|
17
|
-
*/
|
|
18
|
-
rsvpId?: string | null;
|
|
19
|
-
/**
|
|
20
|
-
* Order number. <br/> <br/> **Note:** Only applicable when `guestType` is `BUYER` or `TICKET_HOLDER`.
|
|
21
|
-
* @maxLength 36
|
|
22
|
-
*/
|
|
23
|
-
orderNumber?: string | null;
|
|
24
|
-
/**
|
|
25
|
-
* Ticket number. <br/> <br/> **Note:** Only applicable when `guestType` is `TICKET_HOLDER`.
|
|
26
|
-
* @maxLength 36
|
|
27
|
-
*/
|
|
28
|
-
ticketNumber?: string | null;
|
|
29
|
-
/**
|
|
30
|
-
* List of names, numbers, and definition IDs for each ticket.
|
|
31
|
-
* @maxSize 50
|
|
32
|
-
*/
|
|
33
|
-
tickets?: TicketDetails[];
|
|
34
|
-
/**
|
|
35
|
-
* Guest's contact ID. See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details.
|
|
36
|
-
* @format GUID
|
|
37
|
-
*/
|
|
38
|
-
contactId?: string | null;
|
|
39
|
-
/** Guest details. <br/> <br/> Returned only when the `guestDetails` fieldset is sent in the request. */
|
|
40
|
-
guestDetails?: GuestDetails;
|
|
41
|
-
/** 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. */
|
|
42
|
-
attendanceStatus?: AttendanceStatus;
|
|
43
|
-
/**
|
|
44
|
-
* 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.
|
|
45
|
-
* @format LANGUAGE
|
|
46
|
-
*/
|
|
47
|
-
secondaryLanguageCode?: string | null;
|
|
48
|
-
/** Date and time the guest was created in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
49
|
-
createdDate?: Date | null;
|
|
50
|
-
/** Date and time the guest was updated in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
51
|
-
updatedDate?: Date | null;
|
|
52
|
-
/** Date and time of guest's latest attendance status update. */
|
|
53
|
-
attendanceStatusUpdatedDate?: Date | null;
|
|
54
|
-
/**
|
|
55
|
-
* Site member ID.
|
|
56
|
-
* @format GUID
|
|
57
|
-
*/
|
|
58
|
-
memberId?: string | null;
|
|
59
|
-
/** Guest type. */
|
|
60
|
-
guestType?: GuestType;
|
|
61
|
-
/**
|
|
62
|
-
* 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.
|
|
63
|
-
* @format LANGUAGE_TAG
|
|
64
|
-
*/
|
|
65
|
-
locale?: string | null;
|
|
66
|
-
/**
|
|
67
|
-
* Number of total guests in an event (registered guests + additional ones).
|
|
68
|
-
* @readonly
|
|
69
|
-
*/
|
|
70
|
-
totalGuests?: number | null;
|
|
71
|
-
/**
|
|
72
|
-
* Revision number, which increments by 1 each time the guest is updated.
|
|
73
|
-
* @readonly
|
|
74
|
-
*/
|
|
75
|
-
revision?: string | null;
|
|
76
|
-
}
|
|
77
|
-
interface TicketDetails {
|
|
78
|
-
/**
|
|
79
|
-
* Ticket number.
|
|
80
|
-
* @maxLength 36
|
|
81
|
-
*/
|
|
82
|
-
number?: string;
|
|
83
|
-
/**
|
|
84
|
-
* Ticket definition ID.
|
|
85
|
-
* @format GUID
|
|
86
|
-
*/
|
|
87
|
-
definitionId?: string | null;
|
|
88
|
-
/**
|
|
89
|
-
* Ticket name.
|
|
90
|
-
* @minLength 1
|
|
91
|
-
* @maxLength 30
|
|
92
|
-
*/
|
|
93
|
-
name?: string | null;
|
|
94
|
-
}
|
|
95
|
-
interface OnlineConferencingLogin {
|
|
96
|
-
/**
|
|
97
|
-
* Link URL to the online conference.
|
|
98
|
-
* @format WEB_URL
|
|
99
|
-
* @readonly
|
|
100
|
-
*/
|
|
101
|
-
link?: string;
|
|
102
|
-
/**
|
|
103
|
-
* Password for the online conference.
|
|
104
|
-
* @readonly
|
|
105
|
-
*/
|
|
106
|
-
password?: string | null;
|
|
107
|
-
}
|
|
108
|
-
interface GuestDetails {
|
|
109
|
-
/**
|
|
110
|
-
* Email.
|
|
111
|
-
* @format EMAIL
|
|
112
|
-
*/
|
|
113
|
-
email?: string | null;
|
|
114
|
-
/**
|
|
115
|
-
* First name.
|
|
116
|
-
* @maxLength 255
|
|
117
|
-
*/
|
|
118
|
-
firstName?: string | null;
|
|
119
|
-
/**
|
|
120
|
-
* Last name.
|
|
121
|
-
* @maxLength 255
|
|
122
|
-
*/
|
|
123
|
-
lastName?: string | null;
|
|
124
|
-
/** Form response. */
|
|
125
|
-
formResponse?: FormResponse;
|
|
126
|
-
/** Whether the guest has checked into the event. */
|
|
127
|
-
checkedIn?: boolean;
|
|
128
|
-
/** The login details for the guest to access the online conference event. */
|
|
129
|
-
onlineConferencingLogin?: OnlineConferencingLogin;
|
|
130
|
-
/**
|
|
131
|
-
* Phone extracted from form response. If multiples phone inputs are present, first one is returned.
|
|
132
|
-
* @maxLength 200
|
|
133
|
-
*/
|
|
134
|
-
phone?: string | null;
|
|
135
|
-
/**
|
|
136
|
-
* Address extracted from form response. If multiples address inputs are present, first one is returned.
|
|
137
|
-
* @maxLength 200
|
|
138
|
-
*/
|
|
139
|
-
address?: string | null;
|
|
140
|
-
}
|
|
141
|
-
interface FormResponse {
|
|
142
|
-
/**
|
|
143
|
-
* Input values entered when filling the form.
|
|
144
|
-
* @maxSize 200
|
|
145
|
-
*/
|
|
146
|
-
inputValues?: InputValue[];
|
|
147
|
-
}
|
|
148
|
-
interface InputValue {
|
|
149
|
-
/**
|
|
150
|
-
* Input field name.
|
|
151
|
-
* @maxLength 100
|
|
152
|
-
*/
|
|
153
|
-
inputName?: string;
|
|
154
|
-
/**
|
|
155
|
-
* Text entered into the input field.
|
|
156
|
-
* @maxLength 5000
|
|
157
|
-
*/
|
|
158
|
-
value?: string;
|
|
159
|
-
/**
|
|
160
|
-
* Multiple selection values. For example, the array is filled if several checkboxes are ticked.
|
|
161
|
-
* @maxSize 100
|
|
162
|
-
* @maxLength 5000
|
|
163
|
-
*/
|
|
164
|
-
values?: string[];
|
|
165
|
-
}
|
|
166
|
-
declare enum AttendanceStatus {
|
|
167
|
-
/** Not attending. */
|
|
168
|
-
NOT_ATTENDING = "NOT_ATTENDING",
|
|
169
|
-
/** Attending. */
|
|
170
|
-
ATTENDING = "ATTENDING",
|
|
171
|
-
/** In a waiting list. */
|
|
172
|
-
IN_WAITLIST = "IN_WAITLIST"
|
|
173
|
-
}
|
|
174
|
-
declare enum GuestType {
|
|
175
|
-
/** An invited guest, no ticket necessary. */
|
|
176
|
-
RSVP = "RSVP",
|
|
177
|
-
/** The guest who bought the ticket. */
|
|
178
|
-
BUYER = "BUYER",
|
|
179
|
-
/** The guest for whom the ticket was bought. */
|
|
180
|
-
TICKET_HOLDER = "TICKET_HOLDER"
|
|
181
|
-
}
|
|
182
|
-
interface QueryEventGuestsRequest {
|
|
183
|
-
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
184
|
-
query: QueryV2;
|
|
185
|
-
/**
|
|
186
|
-
* Predefined sets of fields to return.
|
|
187
|
-
* @maxSize 3
|
|
188
|
-
*/
|
|
189
|
-
fields?: RequestedFieldsEnumRequestedFields[];
|
|
190
|
-
}
|
|
191
|
-
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
192
|
-
/** Paging options to limit and skip the number of items. */
|
|
193
|
-
paging?: Paging;
|
|
194
|
-
/** 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`. */
|
|
195
|
-
cursorPaging?: CursorPaging;
|
|
196
|
-
/** 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. */
|
|
197
|
-
filter?: Record<string, any> | null;
|
|
198
|
-
/** 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. */
|
|
199
|
-
sort?: Sorting[];
|
|
200
|
-
/**
|
|
201
|
-
* 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.
|
|
202
|
-
* @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.
|
|
203
|
-
* @replacedBy fields
|
|
204
|
-
* @targetRemovalDate 2024-06-30
|
|
205
|
-
*/
|
|
206
|
-
fieldsets?: string[];
|
|
207
|
-
}
|
|
208
|
-
/** @oneof */
|
|
209
|
-
interface QueryV2PagingMethodOneOf {
|
|
210
|
-
/** Paging options to limit and skip the number of items. */
|
|
211
|
-
paging?: Paging;
|
|
212
|
-
/** 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`. */
|
|
213
|
-
cursorPaging?: CursorPaging;
|
|
214
|
-
}
|
|
215
|
-
interface Sorting {
|
|
216
|
-
/**
|
|
217
|
-
* Name of the field to sort by.
|
|
218
|
-
* @maxLength 512
|
|
219
|
-
*/
|
|
220
|
-
fieldName?: string;
|
|
221
|
-
/** Sort order. */
|
|
222
|
-
order?: SortOrder;
|
|
223
|
-
}
|
|
224
|
-
declare enum SortOrder {
|
|
225
|
-
ASC = "ASC",
|
|
226
|
-
DESC = "DESC"
|
|
227
|
-
}
|
|
228
|
-
interface Paging {
|
|
229
|
-
/**
|
|
230
|
-
* Number of items to load.
|
|
231
|
-
* @max 1000
|
|
232
|
-
*/
|
|
233
|
-
limit?: number | null;
|
|
234
|
-
/** Number of items to skip in the current sort order. */
|
|
235
|
-
offset?: number | null;
|
|
236
|
-
}
|
|
237
|
-
interface CursorPaging {
|
|
238
|
-
/**
|
|
239
|
-
* Maximum number of items to return in the results.
|
|
240
|
-
* @max 1000
|
|
241
|
-
*/
|
|
242
|
-
limit?: number | null;
|
|
243
|
-
/**
|
|
244
|
-
* Pointer to the next or previous page in the list of results.
|
|
245
|
-
*
|
|
246
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
247
|
-
* Not relevant for the first request.
|
|
248
|
-
* @maxLength 16000
|
|
249
|
-
*/
|
|
250
|
-
cursor?: string | null;
|
|
251
|
-
}
|
|
252
|
-
declare enum RequestedFieldsEnumRequestedFields {
|
|
253
|
-
/** Unknown requested field. */
|
|
254
|
-
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
255
|
-
/** Returns `guestDetails` and `tickets`. */
|
|
256
|
-
GUEST_DETAILS = "GUEST_DETAILS",
|
|
257
|
-
/** Returns `totalGuests`. */
|
|
258
|
-
GUEST_TOTAL = "GUEST_TOTAL"
|
|
259
|
-
}
|
|
260
|
-
interface QueryEventGuestsResponse {
|
|
261
|
-
/** List of guests. */
|
|
262
|
-
guests?: EventGuest[];
|
|
263
|
-
/** Metadata for the paginated results. */
|
|
264
|
-
pagingMetadata?: PagingMetadataV2;
|
|
265
|
-
}
|
|
266
|
-
interface PagingMetadataV2 {
|
|
267
|
-
/** Number of items returned in the response. */
|
|
268
|
-
count?: number | null;
|
|
269
|
-
/** Offset that was requested. */
|
|
270
|
-
offset?: number | null;
|
|
271
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
272
|
-
total?: number | null;
|
|
273
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
274
|
-
tooManyToCount?: boolean | null;
|
|
275
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
276
|
-
cursors?: Cursors;
|
|
277
|
-
}
|
|
278
|
-
interface Cursors {
|
|
279
|
-
/**
|
|
280
|
-
* Cursor string pointing to the next page in the list of results.
|
|
281
|
-
* @maxLength 16000
|
|
282
|
-
*/
|
|
283
|
-
next?: string | null;
|
|
284
|
-
/**
|
|
285
|
-
* Cursor pointing to the previous page in the list of results.
|
|
286
|
-
* @maxLength 16000
|
|
287
|
-
*/
|
|
288
|
-
prev?: string | null;
|
|
289
|
-
}
|
|
290
|
-
|
|
291
|
-
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
292
|
-
getUrl: (context: any) => string;
|
|
293
|
-
httpMethod: K;
|
|
294
|
-
path: string;
|
|
295
|
-
pathParams: M;
|
|
296
|
-
__requestType: T;
|
|
297
|
-
__originalRequestType: S;
|
|
298
|
-
__responseType: Q;
|
|
299
|
-
__originalResponseType: R;
|
|
300
|
-
};
|
|
301
|
-
declare function queryGuests(): __PublicMethodMetaInfo<'POST', {}, QueryEventGuestsRequest$1, QueryEventGuestsRequest, QueryEventGuestsResponse$1, QueryEventGuestsResponse>;
|
|
302
|
-
|
|
303
|
-
export { type __PublicMethodMetaInfo, queryGuests };
|
package/build/meta.d.ts
DELETED
|
@@ -1,303 +0,0 @@
|
|
|
1
|
-
import { aq as QueryEventGuestsRequest$1, aw as QueryEventGuestsResponse$1 } from './events-guests-v1-guest-guests.universal-Cj6-k5Jw.js';
|
|
2
|
-
|
|
3
|
-
interface EventGuest {
|
|
4
|
-
/**
|
|
5
|
-
* Guest ID.
|
|
6
|
-
* @format GUID
|
|
7
|
-
*/
|
|
8
|
-
id?: string | null;
|
|
9
|
-
/**
|
|
10
|
-
* Event ID.
|
|
11
|
-
* @format GUID
|
|
12
|
-
*/
|
|
13
|
-
eventId?: string | null;
|
|
14
|
-
/**
|
|
15
|
-
* RSVP ID. <br/> <br/> **Note:** Only applicable when `guestType` is `RSVP`.
|
|
16
|
-
* @format GUID
|
|
17
|
-
*/
|
|
18
|
-
rsvpId?: string | null;
|
|
19
|
-
/**
|
|
20
|
-
* Order number. <br/> <br/> **Note:** Only applicable when `guestType` is `BUYER` or `TICKET_HOLDER`.
|
|
21
|
-
* @maxLength 36
|
|
22
|
-
*/
|
|
23
|
-
orderNumber?: string | null;
|
|
24
|
-
/**
|
|
25
|
-
* Ticket number. <br/> <br/> **Note:** Only applicable when `guestType` is `TICKET_HOLDER`.
|
|
26
|
-
* @maxLength 36
|
|
27
|
-
*/
|
|
28
|
-
ticketNumber?: string | null;
|
|
29
|
-
/**
|
|
30
|
-
* List of names, numbers, and definition IDs for each ticket.
|
|
31
|
-
* @maxSize 50
|
|
32
|
-
*/
|
|
33
|
-
tickets?: TicketDetails[];
|
|
34
|
-
/**
|
|
35
|
-
* Guest's contact ID. See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details.
|
|
36
|
-
* @format GUID
|
|
37
|
-
*/
|
|
38
|
-
contactId?: string | null;
|
|
39
|
-
/** Guest details. <br/> <br/> Returned only when the `guestDetails` fieldset is sent in the request. */
|
|
40
|
-
guestDetails?: GuestDetails;
|
|
41
|
-
/** 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. */
|
|
42
|
-
attendanceStatus?: AttendanceStatus;
|
|
43
|
-
/**
|
|
44
|
-
* 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.
|
|
45
|
-
* @format LANGUAGE
|
|
46
|
-
*/
|
|
47
|
-
secondaryLanguageCode?: string | null;
|
|
48
|
-
/** Date and time the guest was created in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
49
|
-
createdDate?: Date | null;
|
|
50
|
-
/** Date and time the guest was updated in `yyyy-mm-ddThh:mm:sssZ` format. */
|
|
51
|
-
updatedDate?: Date | null;
|
|
52
|
-
/** Date and time of guest's latest attendance status update. */
|
|
53
|
-
attendanceStatusUpdatedDate?: Date | null;
|
|
54
|
-
/**
|
|
55
|
-
* Site member ID.
|
|
56
|
-
* @format GUID
|
|
57
|
-
*/
|
|
58
|
-
memberId?: string | null;
|
|
59
|
-
/** Guest type. */
|
|
60
|
-
guestType?: GuestType;
|
|
61
|
-
/**
|
|
62
|
-
* 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.
|
|
63
|
-
* @format LANGUAGE_TAG
|
|
64
|
-
*/
|
|
65
|
-
locale?: string | null;
|
|
66
|
-
/**
|
|
67
|
-
* Number of total guests in an event (registered guests + additional ones).
|
|
68
|
-
* @readonly
|
|
69
|
-
*/
|
|
70
|
-
totalGuests?: number | null;
|
|
71
|
-
/**
|
|
72
|
-
* Revision number, which increments by 1 each time the guest is updated.
|
|
73
|
-
* @readonly
|
|
74
|
-
*/
|
|
75
|
-
revision?: string | null;
|
|
76
|
-
}
|
|
77
|
-
interface TicketDetails {
|
|
78
|
-
/**
|
|
79
|
-
* Ticket number.
|
|
80
|
-
* @maxLength 36
|
|
81
|
-
*/
|
|
82
|
-
number?: string;
|
|
83
|
-
/**
|
|
84
|
-
* Ticket definition ID.
|
|
85
|
-
* @format GUID
|
|
86
|
-
*/
|
|
87
|
-
definitionId?: string | null;
|
|
88
|
-
/**
|
|
89
|
-
* Ticket name.
|
|
90
|
-
* @minLength 1
|
|
91
|
-
* @maxLength 30
|
|
92
|
-
*/
|
|
93
|
-
name?: string | null;
|
|
94
|
-
}
|
|
95
|
-
interface OnlineConferencingLogin {
|
|
96
|
-
/**
|
|
97
|
-
* Link URL to the online conference.
|
|
98
|
-
* @format WEB_URL
|
|
99
|
-
* @readonly
|
|
100
|
-
*/
|
|
101
|
-
link?: string;
|
|
102
|
-
/**
|
|
103
|
-
* Password for the online conference.
|
|
104
|
-
* @readonly
|
|
105
|
-
*/
|
|
106
|
-
password?: string | null;
|
|
107
|
-
}
|
|
108
|
-
interface GuestDetails {
|
|
109
|
-
/**
|
|
110
|
-
* Email.
|
|
111
|
-
* @format EMAIL
|
|
112
|
-
*/
|
|
113
|
-
email?: string | null;
|
|
114
|
-
/**
|
|
115
|
-
* First name.
|
|
116
|
-
* @maxLength 255
|
|
117
|
-
*/
|
|
118
|
-
firstName?: string | null;
|
|
119
|
-
/**
|
|
120
|
-
* Last name.
|
|
121
|
-
* @maxLength 255
|
|
122
|
-
*/
|
|
123
|
-
lastName?: string | null;
|
|
124
|
-
/** Form response. */
|
|
125
|
-
formResponse?: FormResponse;
|
|
126
|
-
/** Whether the guest has checked into the event. */
|
|
127
|
-
checkedIn?: boolean;
|
|
128
|
-
/** The login details for the guest to access the online conference event. */
|
|
129
|
-
onlineConferencingLogin?: OnlineConferencingLogin;
|
|
130
|
-
/**
|
|
131
|
-
* Phone extracted from form response. If multiples phone inputs are present, first one is returned.
|
|
132
|
-
* @maxLength 200
|
|
133
|
-
*/
|
|
134
|
-
phone?: string | null;
|
|
135
|
-
/**
|
|
136
|
-
* Address extracted from form response. If multiples address inputs are present, first one is returned.
|
|
137
|
-
* @maxLength 200
|
|
138
|
-
*/
|
|
139
|
-
address?: string | null;
|
|
140
|
-
}
|
|
141
|
-
interface FormResponse {
|
|
142
|
-
/**
|
|
143
|
-
* Input values entered when filling the form.
|
|
144
|
-
* @maxSize 200
|
|
145
|
-
*/
|
|
146
|
-
inputValues?: InputValue[];
|
|
147
|
-
}
|
|
148
|
-
interface InputValue {
|
|
149
|
-
/**
|
|
150
|
-
* Input field name.
|
|
151
|
-
* @maxLength 100
|
|
152
|
-
*/
|
|
153
|
-
inputName?: string;
|
|
154
|
-
/**
|
|
155
|
-
* Text entered into the input field.
|
|
156
|
-
* @maxLength 5000
|
|
157
|
-
*/
|
|
158
|
-
value?: string;
|
|
159
|
-
/**
|
|
160
|
-
* Multiple selection values. For example, the array is filled if several checkboxes are ticked.
|
|
161
|
-
* @maxSize 100
|
|
162
|
-
* @maxLength 5000
|
|
163
|
-
*/
|
|
164
|
-
values?: string[];
|
|
165
|
-
}
|
|
166
|
-
declare enum AttendanceStatus {
|
|
167
|
-
/** Not attending. */
|
|
168
|
-
NOT_ATTENDING = "NOT_ATTENDING",
|
|
169
|
-
/** Attending. */
|
|
170
|
-
ATTENDING = "ATTENDING",
|
|
171
|
-
/** In a waiting list. */
|
|
172
|
-
IN_WAITLIST = "IN_WAITLIST"
|
|
173
|
-
}
|
|
174
|
-
declare enum GuestType {
|
|
175
|
-
/** An invited guest, no ticket necessary. */
|
|
176
|
-
RSVP = "RSVP",
|
|
177
|
-
/** The guest who bought the ticket. */
|
|
178
|
-
BUYER = "BUYER",
|
|
179
|
-
/** The guest for whom the ticket was bought. */
|
|
180
|
-
TICKET_HOLDER = "TICKET_HOLDER"
|
|
181
|
-
}
|
|
182
|
-
interface QueryEventGuestsRequest {
|
|
183
|
-
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
184
|
-
query: QueryV2;
|
|
185
|
-
/**
|
|
186
|
-
* Predefined sets of fields to return.
|
|
187
|
-
* @maxSize 3
|
|
188
|
-
*/
|
|
189
|
-
fields?: RequestedFieldsEnumRequestedFields[];
|
|
190
|
-
}
|
|
191
|
-
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
192
|
-
/** Paging options to limit and skip the number of items. */
|
|
193
|
-
paging?: Paging;
|
|
194
|
-
/** 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`. */
|
|
195
|
-
cursorPaging?: CursorPaging;
|
|
196
|
-
/** 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. */
|
|
197
|
-
filter?: Record<string, any> | null;
|
|
198
|
-
/** 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. */
|
|
199
|
-
sort?: Sorting[];
|
|
200
|
-
/**
|
|
201
|
-
* 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.
|
|
202
|
-
* @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.
|
|
203
|
-
* @replacedBy fields
|
|
204
|
-
* @targetRemovalDate 2024-06-30
|
|
205
|
-
*/
|
|
206
|
-
fieldsets?: string[];
|
|
207
|
-
}
|
|
208
|
-
/** @oneof */
|
|
209
|
-
interface QueryV2PagingMethodOneOf {
|
|
210
|
-
/** Paging options to limit and skip the number of items. */
|
|
211
|
-
paging?: Paging;
|
|
212
|
-
/** 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`. */
|
|
213
|
-
cursorPaging?: CursorPaging;
|
|
214
|
-
}
|
|
215
|
-
interface Sorting {
|
|
216
|
-
/**
|
|
217
|
-
* Name of the field to sort by.
|
|
218
|
-
* @maxLength 512
|
|
219
|
-
*/
|
|
220
|
-
fieldName?: string;
|
|
221
|
-
/** Sort order. */
|
|
222
|
-
order?: SortOrder;
|
|
223
|
-
}
|
|
224
|
-
declare enum SortOrder {
|
|
225
|
-
ASC = "ASC",
|
|
226
|
-
DESC = "DESC"
|
|
227
|
-
}
|
|
228
|
-
interface Paging {
|
|
229
|
-
/**
|
|
230
|
-
* Number of items to load.
|
|
231
|
-
* @max 1000
|
|
232
|
-
*/
|
|
233
|
-
limit?: number | null;
|
|
234
|
-
/** Number of items to skip in the current sort order. */
|
|
235
|
-
offset?: number | null;
|
|
236
|
-
}
|
|
237
|
-
interface CursorPaging {
|
|
238
|
-
/**
|
|
239
|
-
* Maximum number of items to return in the results.
|
|
240
|
-
* @max 1000
|
|
241
|
-
*/
|
|
242
|
-
limit?: number | null;
|
|
243
|
-
/**
|
|
244
|
-
* Pointer to the next or previous page in the list of results.
|
|
245
|
-
*
|
|
246
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
247
|
-
* Not relevant for the first request.
|
|
248
|
-
* @maxLength 16000
|
|
249
|
-
*/
|
|
250
|
-
cursor?: string | null;
|
|
251
|
-
}
|
|
252
|
-
declare enum RequestedFieldsEnumRequestedFields {
|
|
253
|
-
/** Unknown requested field. */
|
|
254
|
-
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
255
|
-
/** Returns `guestDetails` and `tickets`. */
|
|
256
|
-
GUEST_DETAILS = "GUEST_DETAILS",
|
|
257
|
-
/** Returns `totalGuests`. */
|
|
258
|
-
GUEST_TOTAL = "GUEST_TOTAL"
|
|
259
|
-
}
|
|
260
|
-
interface QueryEventGuestsResponse {
|
|
261
|
-
/** List of guests. */
|
|
262
|
-
guests?: EventGuest[];
|
|
263
|
-
/** Metadata for the paginated results. */
|
|
264
|
-
pagingMetadata?: PagingMetadataV2;
|
|
265
|
-
}
|
|
266
|
-
interface PagingMetadataV2 {
|
|
267
|
-
/** Number of items returned in the response. */
|
|
268
|
-
count?: number | null;
|
|
269
|
-
/** Offset that was requested. */
|
|
270
|
-
offset?: number | null;
|
|
271
|
-
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
272
|
-
total?: number | null;
|
|
273
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
274
|
-
tooManyToCount?: boolean | null;
|
|
275
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
276
|
-
cursors?: Cursors;
|
|
277
|
-
}
|
|
278
|
-
interface Cursors {
|
|
279
|
-
/**
|
|
280
|
-
* Cursor string pointing to the next page in the list of results.
|
|
281
|
-
* @maxLength 16000
|
|
282
|
-
*/
|
|
283
|
-
next?: string | null;
|
|
284
|
-
/**
|
|
285
|
-
* Cursor pointing to the previous page in the list of results.
|
|
286
|
-
* @maxLength 16000
|
|
287
|
-
*/
|
|
288
|
-
prev?: string | null;
|
|
289
|
-
}
|
|
290
|
-
|
|
291
|
-
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
292
|
-
getUrl: (context: any) => string;
|
|
293
|
-
httpMethod: K;
|
|
294
|
-
path: string;
|
|
295
|
-
pathParams: M;
|
|
296
|
-
__requestType: T;
|
|
297
|
-
__originalRequestType: S;
|
|
298
|
-
__responseType: Q;
|
|
299
|
-
__originalResponseType: R;
|
|
300
|
-
};
|
|
301
|
-
declare function queryGuests(): __PublicMethodMetaInfo<'POST', {}, QueryEventGuestsRequest$1, QueryEventGuestsRequest, QueryEventGuestsResponse$1, QueryEventGuestsResponse>;
|
|
302
|
-
|
|
303
|
-
export { type __PublicMethodMetaInfo, queryGuests };
|