@wix/table-reservations 1.0.174 → 1.0.175
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/context.js.map +1 -0
- package/context.ts +3 -0
- package/index.js.map +1 -0
- package/index.ts +5 -0
- package/meta.js.map +1 -0
- package/meta.ts +3 -0
- package/package.json +25 -20
- package/build/cjs/context.js.map +0 -1
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/meta.js.map +0 -1
- package/context/package.json +0 -7
- package/meta/package.json +0 -7
- package/type-bundles/context.bundle.d.ts +0 -5442
- package/type-bundles/index.bundle.d.ts +0 -5442
- package/type-bundles/meta.bundle.d.ts +0 -3783
- /package/{build/cjs/context.d.ts → context.d.ts} +0 -0
- /package/{build/cjs/context.js → context.js} +0 -0
- /package/{build/cjs/index.d.ts → index.d.ts} +0 -0
- /package/{build/cjs/index.js → index.js} +0 -0
- /package/{build/cjs/meta.d.ts → meta.d.ts} +0 -0
- /package/{build/cjs/meta.js → meta.js} +0 -0
|
@@ -1,3783 +0,0 @@
|
|
|
1
|
-
/** The reservation domain object. */
|
|
2
|
-
interface Reservation$1 {
|
|
3
|
-
/**
|
|
4
|
-
* Reservation ID.
|
|
5
|
-
* @readonly
|
|
6
|
-
*/
|
|
7
|
-
id?: string | null;
|
|
8
|
-
/**
|
|
9
|
-
* Status of the reservation.
|
|
10
|
-
*
|
|
11
|
-
* See the Reservation Lifecycle article([REST](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/the-reservation-lifecycle) | [SDK](https://dev.wix.com/docs/sdk/backend-modules/table-reservations/reservations/the-reservation-lifecycle)) for an explanation of the role of statuses in the reservation lifecycle.
|
|
12
|
-
*/
|
|
13
|
-
status?: Status$3;
|
|
14
|
-
/**
|
|
15
|
-
* Reservation source.
|
|
16
|
-
*
|
|
17
|
-
* This indicates how the reservation was made.
|
|
18
|
-
*/
|
|
19
|
-
source?: Source$1;
|
|
20
|
-
/** Reservation details. */
|
|
21
|
-
details?: Details$1;
|
|
22
|
-
/**
|
|
23
|
-
* Information about the person the reservation is being made for.
|
|
24
|
-
*
|
|
25
|
-
* A reservation created with any `source` other than `WALK_IN` requires the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
|
|
26
|
-
* Attempting to create a reservation without these fields results in an error.
|
|
27
|
-
*/
|
|
28
|
-
reservee?: Reservee$1;
|
|
29
|
-
/**
|
|
30
|
-
* Information about the person making the reservation.
|
|
31
|
-
*
|
|
32
|
-
* This field is required if the reservation's `status` is anything other than `WALK_IN`.
|
|
33
|
-
* @readonly
|
|
34
|
-
*/
|
|
35
|
-
reservedBy?: ReservedBy$1;
|
|
36
|
-
/**
|
|
37
|
-
* Team message.
|
|
38
|
-
*
|
|
39
|
-
* A message for the restaurant staff containing any additional information regarding the reservation, such as special requirements for the guests.
|
|
40
|
-
*/
|
|
41
|
-
teamMessage?: string | null;
|
|
42
|
-
/**
|
|
43
|
-
* Date and time the reservation was created.
|
|
44
|
-
* @readonly
|
|
45
|
-
*/
|
|
46
|
-
createdDate?: Date | null;
|
|
47
|
-
/**
|
|
48
|
-
* Date and time the reservation was changed.
|
|
49
|
-
* @readonly
|
|
50
|
-
*/
|
|
51
|
-
updatedDate?: Date | null;
|
|
52
|
-
/**
|
|
53
|
-
* Revision number, which increments by 1 each time the reservation is updated.
|
|
54
|
-
* To prevent conflicting changes, the current revision must be specified when updating the reservation.
|
|
55
|
-
*
|
|
56
|
-
* Ignored when creating a reservation.
|
|
57
|
-
* @readonly
|
|
58
|
-
*/
|
|
59
|
-
revision?: string | null;
|
|
60
|
-
/** The reason the reservation was declined. */
|
|
61
|
-
declineReason?: string | null;
|
|
62
|
-
/**
|
|
63
|
-
* Payment status.
|
|
64
|
-
* @readonly
|
|
65
|
-
*/
|
|
66
|
-
paymentStatus?: PaymentStatus$1;
|
|
67
|
-
/**
|
|
68
|
-
* Custom field data for the reservation object.
|
|
69
|
-
*
|
|
70
|
-
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
71
|
-
*/
|
|
72
|
-
extendedFields?: ExtendedFields$3;
|
|
73
|
-
}
|
|
74
|
-
/** Tables used for the reservation. If you don't specify a `tables` object, the server attempts to assign tables automatically. */
|
|
75
|
-
interface Tables$1 {
|
|
76
|
-
/** IDs of tables used for this reservation. If you don't specify an `ids` array, or you specify an empty array, no tables are assigned. */
|
|
77
|
-
ids?: string[];
|
|
78
|
-
}
|
|
79
|
-
declare enum Status$3 {
|
|
80
|
-
/** Undefined reservation status. */
|
|
81
|
-
UNKNOWN = "UNKNOWN",
|
|
82
|
-
/** A customer has begun the reservation flow, a temporary reservation is created and will expire in 10 minutes unless the customer moves forward with the reservation flow. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request. */
|
|
83
|
-
HELD = "HELD",
|
|
84
|
-
/** The reservation is confirmed. */
|
|
85
|
-
RESERVED = "RESERVED",
|
|
86
|
-
/** The reservation is canceled. */
|
|
87
|
-
CANCELED = "CANCELED",
|
|
88
|
-
/** The reservation completed successfully. */
|
|
89
|
-
FINISHED = "FINISHED",
|
|
90
|
-
/** The customer didn't show up for their reservation. */
|
|
91
|
-
NO_SHOW = "NO_SHOW",
|
|
92
|
-
/** The customer is currently occupying the table. */
|
|
93
|
-
SEATED = "SEATED",
|
|
94
|
-
/** A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request. */
|
|
95
|
-
REQUESTED = "REQUESTED",
|
|
96
|
-
/** The restaurant’s owner or staff declined the customer’s request to make the reservation. */
|
|
97
|
-
DECLINED = "DECLINED",
|
|
98
|
-
/** A customer has begun the checkout flow, the temporary reservation is moved to this status and will expire in 10 minutes from the created time, during which time the reservee should pay. This status is set automatically when the reserve reservation endpoint is called for a reservation in `HELD` status and payment is needed. After payment is completed status will be changed automatically to `RESERVED`. */
|
|
99
|
-
PAYMENT_PENDING = "PAYMENT_PENDING"
|
|
100
|
-
}
|
|
101
|
-
declare enum Source$1 {
|
|
102
|
-
/** Undefined reservation source. */
|
|
103
|
-
UNKNOWN = "UNKNOWN",
|
|
104
|
-
/** The reservation was made by a restaurant employee, for example when a customer calls to make a reservation. */
|
|
105
|
-
OFFLINE = "OFFLINE",
|
|
106
|
-
/** The reservation was made through a website or app. */
|
|
107
|
-
ONLINE = "ONLINE",
|
|
108
|
-
/** The reservation was made by a restaurant employee when the customer arrived at the restaurant without a prior reservation. */
|
|
109
|
-
WALK_IN = "WALK_IN"
|
|
110
|
-
}
|
|
111
|
-
/** Reservation details. */
|
|
112
|
-
interface Details$1 {
|
|
113
|
-
/** ID of the reservation location at which this reservation will be made. */
|
|
114
|
-
reservationLocationId?: string | null;
|
|
115
|
-
/**
|
|
116
|
-
* IDs of tables used for this reservation.
|
|
117
|
-
* @deprecated
|
|
118
|
-
* @replacedBy tables
|
|
119
|
-
* @targetRemovalDate 2024-12-31
|
|
120
|
-
*/
|
|
121
|
-
tableIds?: string[] | null;
|
|
122
|
-
/** Tables used for this reservation. */
|
|
123
|
-
tables?: Tables$1;
|
|
124
|
-
/** Start date and time of the reservation. */
|
|
125
|
-
startDate?: Date | null;
|
|
126
|
-
/** End date and time of the reservation. */
|
|
127
|
-
endDate?: Date | null;
|
|
128
|
-
/** Party size. */
|
|
129
|
-
partySize?: number | null;
|
|
130
|
-
}
|
|
131
|
-
/** The person the reservation is being made for. */
|
|
132
|
-
interface Reservee$1 {
|
|
133
|
-
/**
|
|
134
|
-
* First name.
|
|
135
|
-
*
|
|
136
|
-
* This field is required if the reservation's `status` is anything other than `WALK_IN`.
|
|
137
|
-
*/
|
|
138
|
-
firstName?: string | null;
|
|
139
|
-
/** Last name. */
|
|
140
|
-
lastName?: string | null;
|
|
141
|
-
/** Email address. */
|
|
142
|
-
email?: string | null;
|
|
143
|
-
/**
|
|
144
|
-
* Phone number.
|
|
145
|
-
*
|
|
146
|
-
* This property should begin with a +, followed by the country code, and then the rest of the phone number. For example, `"+972555555555"`.
|
|
147
|
-
*
|
|
148
|
-
* This field is required if the reservation's `status` is anything other than `WALK_IN`.
|
|
149
|
-
*/
|
|
150
|
-
phone?: string | null;
|
|
151
|
-
/** Whether the reservee has given marketing consent. */
|
|
152
|
-
marketingConsent?: boolean | null;
|
|
153
|
-
/**
|
|
154
|
-
* Custom fields for the reservee in key-value pairs.
|
|
155
|
-
*
|
|
156
|
-
* The key is the custom field's ID, and the value is the custom field's value. For example, a custom field for allergies might have the key-value pair `f4283b2d-6340-4cf9-bae7-8769e6b62127 : "Nuts, Seafood"`.
|
|
157
|
-
*
|
|
158
|
-
* Empty fields are not returned.
|
|
159
|
-
*/
|
|
160
|
-
customFields?: Record<string, any> | null;
|
|
161
|
-
/**
|
|
162
|
-
* Contact ID. If a contact with this ID does not exist on the site, one will be created.
|
|
163
|
-
* @readonly
|
|
164
|
-
*/
|
|
165
|
-
contactId?: string | null;
|
|
166
|
-
}
|
|
167
|
-
/** A person making reservation. */
|
|
168
|
-
interface ReservedBy$1 {
|
|
169
|
-
/**
|
|
170
|
-
* Contact ID for the person who made the reservation. If a contact with this ID does not exist on the site, one will be created.
|
|
171
|
-
* @readonly
|
|
172
|
-
*/
|
|
173
|
-
contactId?: string | null;
|
|
174
|
-
}
|
|
175
|
-
declare enum PaymentStatus$1 {
|
|
176
|
-
/** Undefined payment status. */
|
|
177
|
-
UNKNOWN = "UNKNOWN",
|
|
178
|
-
/** A reservation is free of charge. */
|
|
179
|
-
FREE = "FREE",
|
|
180
|
-
/** Payment is not received yet. */
|
|
181
|
-
NOT_PAID = "NOT_PAID",
|
|
182
|
-
/** The corresponding reservation order was fully paid. */
|
|
183
|
-
PAID = "PAID",
|
|
184
|
-
/** The corresponding reservation order was refunded, but the refund amount is less than the order total price. */
|
|
185
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
186
|
-
/** The corresponding reservation order was fully refunded. The refund amount equals the total price. */
|
|
187
|
-
FULLY_REFUNDED = "FULLY_REFUNDED",
|
|
188
|
-
/** The corresponding reservation order was partially paid. */
|
|
189
|
-
PARTIALLY_PAID = "PARTIALLY_PAID"
|
|
190
|
-
}
|
|
191
|
-
interface ExtendedFields$3 {
|
|
192
|
-
/**
|
|
193
|
-
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
194
|
-
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
195
|
-
*
|
|
196
|
-
* You can only access fields for which you have the appropriate permissions.
|
|
197
|
-
*
|
|
198
|
-
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
199
|
-
*/
|
|
200
|
-
namespaces?: Record<string, Record<string, any>>;
|
|
201
|
-
}
|
|
202
|
-
interface CreateReservationRequest$1 {
|
|
203
|
-
/** Reservation details. */
|
|
204
|
-
reservation: Reservation$1;
|
|
205
|
-
/**
|
|
206
|
-
* Ignore table combination conflicts of the types specified in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
|
|
207
|
-
*
|
|
208
|
-
* Possible values:
|
|
209
|
-
* * `"RESERVED"`: One or more of the chosen tables are already reserved.
|
|
210
|
-
* * `"TOO_BIG"`: The party is too big for the selected table.
|
|
211
|
-
* * `"TOO_SMALL"`: The party is too small for the selected table.
|
|
212
|
-
* * `"OFFLINE_ONLY"`: The restaurant does not allow online reservations.
|
|
213
|
-
*/
|
|
214
|
-
ignoreTableCombinationConflicts?: TableCombinationConflictType$3[];
|
|
215
|
-
/**
|
|
216
|
-
* Ignored reservation location conflicts of the types specified in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
|
|
217
|
-
*
|
|
218
|
-
* Possible values:
|
|
219
|
-
* * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
|
|
220
|
-
* * `"SEAT_PACING"`: The required number of seats are unavailable according to seat pacing settings.
|
|
221
|
-
*/
|
|
222
|
-
ignoreReservationLocationConflicts?: Type$3[];
|
|
223
|
-
}
|
|
224
|
-
declare enum TableCombinationConflictType$3 {
|
|
225
|
-
/** Undefined conflict type. */
|
|
226
|
-
UNKNOWN = "UNKNOWN",
|
|
227
|
-
/** One or more of the chosen tables are already reserved. */
|
|
228
|
-
RESERVED = "RESERVED",
|
|
229
|
-
/** The party is too big for the selected table. */
|
|
230
|
-
TOO_BIG = "TOO_BIG",
|
|
231
|
-
/** The party is too small for the selected table. */
|
|
232
|
-
TOO_SMALL = "TOO_SMALL",
|
|
233
|
-
/** The restaurant does not allow online reservations. */
|
|
234
|
-
OFFLINE_ONLY = "OFFLINE_ONLY"
|
|
235
|
-
}
|
|
236
|
-
declare enum Type$3 {
|
|
237
|
-
/** Undefined reservation location conflict type. */
|
|
238
|
-
UNKNOWN = "UNKNOWN",
|
|
239
|
-
/** The restaurant cannot accommodate a party of the given size according to party pacing settings. */
|
|
240
|
-
PARTY_PACING = "PARTY_PACING",
|
|
241
|
-
/** The required number of seats are unavailable according to seat pacing settings. */
|
|
242
|
-
SEAT_PACING = "SEAT_PACING"
|
|
243
|
-
}
|
|
244
|
-
interface CreateReservationResponse$1 {
|
|
245
|
-
/** Reservation. */
|
|
246
|
-
reservation?: Reservation$1;
|
|
247
|
-
}
|
|
248
|
-
interface GetReservationRequest$1 {
|
|
249
|
-
/** Reservation ID. */
|
|
250
|
-
reservationId: string;
|
|
251
|
-
/**
|
|
252
|
-
* Array of named, predefined sets of projected fields to be returned.
|
|
253
|
-
* Default: If `fields` is omitted from the request, `PUBLIC`.
|
|
254
|
-
*/
|
|
255
|
-
fieldsets?: Set$3[];
|
|
256
|
-
}
|
|
257
|
-
declare enum Set$3 {
|
|
258
|
-
/**
|
|
259
|
-
* Returns `id`, `status`, `details.reservationLocationId`, `details.startDate`, `details.endDate`, `details.partySize`, `createdDate`, `revision`, `declineReason`,
|
|
260
|
-
* `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
|
|
261
|
-
*/
|
|
262
|
-
PUBLIC = "PUBLIC",
|
|
263
|
-
/** Returns all fields. */
|
|
264
|
-
FULL = "FULL"
|
|
265
|
-
}
|
|
266
|
-
interface GetReservationResponse$1 {
|
|
267
|
-
/** Reservation. */
|
|
268
|
-
reservation?: Reservation$1;
|
|
269
|
-
}
|
|
270
|
-
interface UpdateReservationRequest$1 {
|
|
271
|
-
/** Reservation information to update. */
|
|
272
|
-
reservation: Reservation$1;
|
|
273
|
-
/** Ignore table combination conflicts of the types included in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it. */
|
|
274
|
-
ignoreTableCombinationConflicts?: TableCombinationConflictType$3[];
|
|
275
|
-
ignoreReservationLocationConflicts?: Type$3[];
|
|
276
|
-
}
|
|
277
|
-
interface UpdateReservationResponse$1 {
|
|
278
|
-
/** Reservation. */
|
|
279
|
-
reservation?: Reservation$1;
|
|
280
|
-
}
|
|
281
|
-
interface UpdateExtendedFieldsRequest$3 {
|
|
282
|
-
/** ID of the entity to update. */
|
|
283
|
-
id: string;
|
|
284
|
-
/** Identifier for the app whose extended fields are being updated. */
|
|
285
|
-
namespace: string;
|
|
286
|
-
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
287
|
-
namespaceData: Record<string, any> | null;
|
|
288
|
-
}
|
|
289
|
-
interface UpdateExtendedFieldsResponse$3 {
|
|
290
|
-
/** Updated reservation. */
|
|
291
|
-
reservation?: Reservation$1;
|
|
292
|
-
}
|
|
293
|
-
interface CreateHeldReservationRequest$1 {
|
|
294
|
-
/** Held reservation information to update. */
|
|
295
|
-
reservationDetails: HeldReservationDetails$1;
|
|
296
|
-
}
|
|
297
|
-
/** Reservation details when create reservation in status HELD. */
|
|
298
|
-
interface HeldReservationDetails$1 {
|
|
299
|
-
/** ID of the reservation location where the reservation is made. */
|
|
300
|
-
reservationLocationId?: string | null;
|
|
301
|
-
/** Start date and time of the reservation. */
|
|
302
|
-
startDate?: Date | null;
|
|
303
|
-
/** Party size. */
|
|
304
|
-
partySize?: number | null;
|
|
305
|
-
}
|
|
306
|
-
interface CreateHeldReservationResponse$1 {
|
|
307
|
-
/** Reservation. */
|
|
308
|
-
reservation?: Reservation$1;
|
|
309
|
-
}
|
|
310
|
-
interface ReserveReservationRequest$1 {
|
|
311
|
-
/** Reservation ID. */
|
|
312
|
-
reservationId: string;
|
|
313
|
-
/** Reservee details. */
|
|
314
|
-
reservee: Reservee$1;
|
|
315
|
-
/**
|
|
316
|
-
* Revision number.
|
|
317
|
-
*
|
|
318
|
-
* Specify the existing `revision` to prevent conflicting updates to reservations.
|
|
319
|
-
*/
|
|
320
|
-
revision: string | null;
|
|
321
|
-
}
|
|
322
|
-
interface ReserveReservationResponse$1 {
|
|
323
|
-
/** Reservation. */
|
|
324
|
-
reservation?: Reservation$1;
|
|
325
|
-
}
|
|
326
|
-
interface CancelReservationRequest$1 {
|
|
327
|
-
/** Reservation ID. */
|
|
328
|
-
reservationId: string;
|
|
329
|
-
/**
|
|
330
|
-
* Revision number.
|
|
331
|
-
*
|
|
332
|
-
* Specify the existing `revision` to prevent conflicting updates to reservations.
|
|
333
|
-
*/
|
|
334
|
-
revision: string | null;
|
|
335
|
-
/**
|
|
336
|
-
* The phone number that was provided when the reservation was created.
|
|
337
|
-
*
|
|
338
|
-
* This is required for reservations with any `source` other than `WALK_IN`.
|
|
339
|
-
*
|
|
340
|
-
* This requirement provides additional security by ensuring that the canceling party knows both the reservation's `reservationId` and the reservee's `phone`.
|
|
341
|
-
*/
|
|
342
|
-
phone?: string | null;
|
|
343
|
-
}
|
|
344
|
-
interface CancelReservationResponse$1 {
|
|
345
|
-
/** Reservation. */
|
|
346
|
-
reservation?: Reservation$1;
|
|
347
|
-
}
|
|
348
|
-
interface DeleteReservationRequest$1 {
|
|
349
|
-
/** Reservation ID. */
|
|
350
|
-
reservationId: string;
|
|
351
|
-
}
|
|
352
|
-
interface DeleteReservationResponse$1 {
|
|
353
|
-
}
|
|
354
|
-
interface ListReservationsRequest$1 {
|
|
355
|
-
/** 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`. */
|
|
356
|
-
paging?: CursorPaging$3;
|
|
357
|
-
/** Defines how reservations in the response are sorted. */
|
|
358
|
-
sort?: Sorting$3;
|
|
359
|
-
/** Only reservations starting after this date are returned. */
|
|
360
|
-
startDateFrom?: Date | null;
|
|
361
|
-
/** Only reservations starting before this date are returned. */
|
|
362
|
-
startDateTo?: Date | null;
|
|
363
|
-
/** Only reservations with this status are returned. */
|
|
364
|
-
status?: Status$3;
|
|
365
|
-
}
|
|
366
|
-
interface CursorPaging$3 {
|
|
367
|
-
/** Number of items to load. */
|
|
368
|
-
limit?: number | null;
|
|
369
|
-
/**
|
|
370
|
-
* Pointer to the next or previous page in the list of results.
|
|
371
|
-
*
|
|
372
|
-
* You can get the relevant cursor token
|
|
373
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
374
|
-
* Not relevant for the first request.
|
|
375
|
-
*/
|
|
376
|
-
cursor?: string | null;
|
|
377
|
-
}
|
|
378
|
-
interface Sorting$3 {
|
|
379
|
-
/** Name of the field to sort by. */
|
|
380
|
-
fieldName?: string;
|
|
381
|
-
/**
|
|
382
|
-
* Sort order.
|
|
383
|
-
* Default: `ASC`.
|
|
384
|
-
*/
|
|
385
|
-
order?: SortOrder$3;
|
|
386
|
-
}
|
|
387
|
-
declare enum SortOrder$3 {
|
|
388
|
-
/** Sort by ascending order. */
|
|
389
|
-
ASC = "ASC",
|
|
390
|
-
/** Sort by descending order. */
|
|
391
|
-
DESC = "DESC"
|
|
392
|
-
}
|
|
393
|
-
interface ListReservationsResponse$1 {
|
|
394
|
-
/** List of reservations. */
|
|
395
|
-
reservations?: Reservation$1[];
|
|
396
|
-
/** Metadata for the paginated results. */
|
|
397
|
-
pagingMetadata?: CursorPagingMetadata$3;
|
|
398
|
-
}
|
|
399
|
-
interface CursorPagingMetadata$3 {
|
|
400
|
-
/** Number of items returned in the response. */
|
|
401
|
-
count?: number | null;
|
|
402
|
-
/** Offset that was requested. */
|
|
403
|
-
cursors?: Cursors$3;
|
|
404
|
-
/**
|
|
405
|
-
* Indicates if there are more results after the current page.
|
|
406
|
-
* If `true`, another page of results can be retrieved.
|
|
407
|
-
* If `false`, this is the last page.
|
|
408
|
-
*/
|
|
409
|
-
hasNext?: boolean | null;
|
|
410
|
-
}
|
|
411
|
-
interface Cursors$3 {
|
|
412
|
-
/** Cursor pointing to next page in the list of results. */
|
|
413
|
-
next?: string | null;
|
|
414
|
-
/** Cursor pointing to previous page in the list of results. */
|
|
415
|
-
prev?: string | null;
|
|
416
|
-
}
|
|
417
|
-
interface QueryReservationsRequest$1 {
|
|
418
|
-
/** Query to select reservations. */
|
|
419
|
-
query: CursorQuery$1;
|
|
420
|
-
}
|
|
421
|
-
interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 {
|
|
422
|
-
/** 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`. */
|
|
423
|
-
cursorPaging?: CursorPaging$3;
|
|
424
|
-
/**
|
|
425
|
-
* Filter object in the following format:
|
|
426
|
-
* `"filter" : {
|
|
427
|
-
* "fieldName1": "value1",
|
|
428
|
-
* "fieldName2":{"$operator":"value2"}
|
|
429
|
-
* }`
|
|
430
|
-
*
|
|
431
|
-
* For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/sorting-filtering-and-search) article.
|
|
432
|
-
* To learn how to query reservations, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
|
|
433
|
-
*/
|
|
434
|
-
filter?: Record<string, any> | null;
|
|
435
|
-
/**
|
|
436
|
-
* Sort object in the following format:
|
|
437
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
438
|
-
*/
|
|
439
|
-
sort?: Sorting$3[];
|
|
440
|
-
}
|
|
441
|
-
/** @oneof */
|
|
442
|
-
interface CursorQueryPagingMethodOneOf$1 {
|
|
443
|
-
/** 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`. */
|
|
444
|
-
cursorPaging?: CursorPaging$3;
|
|
445
|
-
}
|
|
446
|
-
interface QueryReservationsResponse$1 {
|
|
447
|
-
/** List of reservations. */
|
|
448
|
-
reservations?: Reservation$1[];
|
|
449
|
-
/** Metadata for the paginated results. */
|
|
450
|
-
pagingMetadata?: CursorPagingMetadata$3;
|
|
451
|
-
}
|
|
452
|
-
interface SearchReservationsRequest$1 {
|
|
453
|
-
/** Search query. */
|
|
454
|
-
search: CursorSearch$1;
|
|
455
|
-
}
|
|
456
|
-
interface CursorSearch$1 extends CursorSearchPagingMethodOneOf$1 {
|
|
457
|
-
/** Cursor pointing to a page of results. Can't be used together with 'paging'. 'cursorPaging.cursor' can't be used together with 'filter' or 'sort'. */
|
|
458
|
-
cursorPaging?: CursorPaging$3;
|
|
459
|
-
/**
|
|
460
|
-
* Filter object in the following format:
|
|
461
|
-
* `"filter" : {
|
|
462
|
-
* "fieldName1": "value1",
|
|
463
|
-
* "fieldName2":{"$operator":"value2"}
|
|
464
|
-
* }`
|
|
465
|
-
* For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/sorting-filtering-and-search) article.
|
|
466
|
-
*/
|
|
467
|
-
filter?: Record<string, any> | null;
|
|
468
|
-
/**
|
|
469
|
-
* Sort object in the following format:
|
|
470
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
471
|
-
*/
|
|
472
|
-
sort?: Sorting$3[];
|
|
473
|
-
/**
|
|
474
|
-
* A search method for grouping data into various categories (facets) and providing summaries for each category.
|
|
475
|
-
* For example, use aggregations to allow site visitors to narrow down their search results by selecting specific reservation statuses, party sizes, etc.
|
|
476
|
-
*/
|
|
477
|
-
aggregations?: Aggregation$1[];
|
|
478
|
-
/** Free text to match in searchable fields. */
|
|
479
|
-
search?: SearchDetails$1;
|
|
480
|
-
/** Time zone to adjust date-time-based filters and aggregations. ISO 8601 or IANA time zone database format. */
|
|
481
|
-
timeZone?: string | null;
|
|
482
|
-
}
|
|
483
|
-
/** @oneof */
|
|
484
|
-
interface CursorSearchPagingMethodOneOf$1 {
|
|
485
|
-
/** Cursor pointing to a page of results. Can't be used together with 'paging'. 'cursorPaging.cursor' can't be used together with 'filter' or 'sort'. */
|
|
486
|
-
cursorPaging?: CursorPaging$3;
|
|
487
|
-
}
|
|
488
|
-
interface Aggregation$1 extends AggregationKindOneOf$1 {
|
|
489
|
-
/** A value aggregation calculates metrics such as "count" for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of reservations (count) of each status that have been made on the site. */
|
|
490
|
-
value?: ValueAggregation$1;
|
|
491
|
-
/** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
|
|
492
|
-
range?: RangeAggregation$1;
|
|
493
|
-
/** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the average part size of reservations made on a site. */
|
|
494
|
-
scalar?: ScalarAggregation$1;
|
|
495
|
-
/** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
|
|
496
|
-
dateHistogram?: DateHistogramAggregation$1;
|
|
497
|
-
/**
|
|
498
|
-
* A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy.
|
|
499
|
-
* For example, to get the number of reservations by party size for each week, first perform a date histogram aggregation on `details.startDate` with the interval `WEEK`, and a second value aggregation on `details.partySize`.
|
|
500
|
-
*/
|
|
501
|
-
nested?: NestedAggregation$1;
|
|
502
|
-
name?: string | null;
|
|
503
|
-
type?: AggregationType$1;
|
|
504
|
-
fieldPath?: string;
|
|
505
|
-
}
|
|
506
|
-
/** @oneof */
|
|
507
|
-
interface AggregationKindOneOf$1 {
|
|
508
|
-
/** A value aggregation calculates metrics such as "count" for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of reservations (count) of each status that have been made on the site. */
|
|
509
|
-
value?: ValueAggregation$1;
|
|
510
|
-
/** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
|
|
511
|
-
range?: RangeAggregation$1;
|
|
512
|
-
/** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the average part size of reservations made on a site. */
|
|
513
|
-
scalar?: ScalarAggregation$1;
|
|
514
|
-
/** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
|
|
515
|
-
dateHistogram?: DateHistogramAggregation$1;
|
|
516
|
-
/**
|
|
517
|
-
* A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy.
|
|
518
|
-
* For example, to get the number of reservations by party size for each week, first perform a date histogram aggregation on `details.startDate` with the interval `WEEK`, and a second value aggregation on `details.partySize`.
|
|
519
|
-
*/
|
|
520
|
-
nested?: NestedAggregation$1;
|
|
521
|
-
}
|
|
522
|
-
interface RangeBucket$1 {
|
|
523
|
-
/** Inclusive lower bound of the range. Required if `to` is not provided. */
|
|
524
|
-
from?: number | null;
|
|
525
|
-
/** Exclusive upper bound of the range. Required if `from` is not provided. */
|
|
526
|
-
to?: number | null;
|
|
527
|
-
}
|
|
528
|
-
declare enum SortType$1 {
|
|
529
|
-
/** Sort by number of matches. */
|
|
530
|
-
COUNT = "COUNT",
|
|
531
|
-
/** Sort by value of the field alphabetically. */
|
|
532
|
-
VALUE = "VALUE"
|
|
533
|
-
}
|
|
534
|
-
declare enum SortDirection$1 {
|
|
535
|
-
/** Sort in descending order. */
|
|
536
|
-
DESC = "DESC",
|
|
537
|
-
/** Sort in ascending order. */
|
|
538
|
-
ASC = "ASC"
|
|
539
|
-
}
|
|
540
|
-
declare enum MissingValues$1 {
|
|
541
|
-
/** Exclude missing values from the aggregation results */
|
|
542
|
-
EXCLUDE = "EXCLUDE",
|
|
543
|
-
/** Include missing values in the aggregation results */
|
|
544
|
-
INCLUDE = "INCLUDE"
|
|
545
|
-
}
|
|
546
|
-
interface IncludeMissingValuesOptions$1 {
|
|
547
|
-
/** Specify a custom name for the bucket containing the missing values. Defaults are "N/A" for strings, "0" for integers, and "false" for booleans. */
|
|
548
|
-
addToBucket?: string;
|
|
549
|
-
}
|
|
550
|
-
declare enum ScalarType$1 {
|
|
551
|
-
/** Undefined scalar type. */
|
|
552
|
-
UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
|
|
553
|
-
/** Count of distinct values. */
|
|
554
|
-
COUNT_DISTINCT = "COUNT_DISTINCT",
|
|
555
|
-
/** Minimum value. */
|
|
556
|
-
MIN = "MIN",
|
|
557
|
-
/** Maximum value. */
|
|
558
|
-
MAX = "MAX"
|
|
559
|
-
}
|
|
560
|
-
declare enum NestedAggregationType$1 {
|
|
561
|
-
/** Undefined aggregation type. */
|
|
562
|
-
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
563
|
-
/** An aggregation where result buckets are dynamically built - one per unique value. */
|
|
564
|
-
VALUE = "VALUE",
|
|
565
|
-
/** An aggregation where you can define a set of ranges - each representing a bucket. */
|
|
566
|
-
RANGE = "RANGE",
|
|
567
|
-
/** A single-value metric aggregation - such as min, max, sum, and avg. */
|
|
568
|
-
SCALAR = "SCALAR",
|
|
569
|
-
/** An aggregation where result buckets are dynamically built - one per time interval such as hour, day, or week. */
|
|
570
|
-
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
571
|
-
}
|
|
572
|
-
interface ValueAggregation$1 extends ValueAggregationOptionsOneOf$1 {
|
|
573
|
-
/** Options for including missing values in results. */
|
|
574
|
-
includeOptions?: IncludeMissingValuesOptions$1;
|
|
575
|
-
/** Whether to sort by the number of matches or the value of the field. */
|
|
576
|
-
sortType?: SortType$1;
|
|
577
|
-
/** Whether to sort in ascending or descending order. */
|
|
578
|
-
sortDirection?: SortDirection$1;
|
|
579
|
-
/**
|
|
580
|
-
* Number of aggregation results to return.
|
|
581
|
-
* Min: `1`
|
|
582
|
-
* Max: `250`
|
|
583
|
-
* Default: `10`
|
|
584
|
-
*/
|
|
585
|
-
limit?: number | null;
|
|
586
|
-
/**
|
|
587
|
-
* Whether missing values should be included or excluded from the aggregation results.
|
|
588
|
-
* Default: `EXCLUDE`.
|
|
589
|
-
*/
|
|
590
|
-
missingValues?: MissingValues$1;
|
|
591
|
-
}
|
|
592
|
-
/** @oneof */
|
|
593
|
-
interface ValueAggregationOptionsOneOf$1 {
|
|
594
|
-
/** Options for including missing values in results. */
|
|
595
|
-
includeOptions?: IncludeMissingValuesOptions$1;
|
|
596
|
-
}
|
|
597
|
-
interface RangeAggregation$1 {
|
|
598
|
-
/** List of range buckets. During aggregation each entity will be placed in the first bucket its value falls into based on the provided range bounds. */
|
|
599
|
-
buckets?: RangeBucket$1[];
|
|
600
|
-
}
|
|
601
|
-
interface ScalarAggregation$1 {
|
|
602
|
-
/** Operation type for the scalar aggregation. */
|
|
603
|
-
type?: ScalarType$1;
|
|
604
|
-
}
|
|
605
|
-
interface DateHistogramAggregation$1 {
|
|
606
|
-
/** Interval for date histogram aggregation. */
|
|
607
|
-
interval?: Interval$1;
|
|
608
|
-
}
|
|
609
|
-
declare enum Interval$1 {
|
|
610
|
-
UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
|
|
611
|
-
YEAR = "YEAR",
|
|
612
|
-
MONTH = "MONTH",
|
|
613
|
-
WEEK = "WEEK",
|
|
614
|
-
DAY = "DAY",
|
|
615
|
-
HOUR = "HOUR",
|
|
616
|
-
MINUTE = "MINUTE",
|
|
617
|
-
SECOND = "SECOND"
|
|
618
|
-
}
|
|
619
|
-
interface NestedAggregationItem$1 extends NestedAggregationItemKindOneOf$1 {
|
|
620
|
-
/** A value aggregation calculates metrics such as "count" for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of reservations (count) of each status that have been made on the site. */
|
|
621
|
-
value?: ValueAggregation$1;
|
|
622
|
-
/** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
|
|
623
|
-
range?: RangeAggregation$1;
|
|
624
|
-
/** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the average part size of reservations made on a site. */
|
|
625
|
-
scalar?: ScalarAggregation$1;
|
|
626
|
-
/** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
|
|
627
|
-
dateHistogram?: DateHistogramAggregation$1;
|
|
628
|
-
/** Aggregation name displayed in the return. */
|
|
629
|
-
name?: string | null;
|
|
630
|
-
/** Type of aggregation to perform. */
|
|
631
|
-
type?: NestedAggregationType$1;
|
|
632
|
-
/** Field to aggregate by. */
|
|
633
|
-
fieldPath?: string;
|
|
634
|
-
}
|
|
635
|
-
/** @oneof */
|
|
636
|
-
interface NestedAggregationItemKindOneOf$1 {
|
|
637
|
-
/** A value aggregation calculates metrics such as "count" for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of reservations (count) of each status that have been made on the site. */
|
|
638
|
-
value?: ValueAggregation$1;
|
|
639
|
-
/** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
|
|
640
|
-
range?: RangeAggregation$1;
|
|
641
|
-
/** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the average part size of reservations made on a site. */
|
|
642
|
-
scalar?: ScalarAggregation$1;
|
|
643
|
-
/** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
|
|
644
|
-
dateHistogram?: DateHistogramAggregation$1;
|
|
645
|
-
}
|
|
646
|
-
declare enum AggregationType$1 {
|
|
647
|
-
/** Undefined aggregation type. */
|
|
648
|
-
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
649
|
-
/** An aggregation where result buckets are dynamically built - one per unique value. */
|
|
650
|
-
VALUE = "VALUE",
|
|
651
|
-
/** An aggregation where you can define a set of ranges - each representing a bucket. */
|
|
652
|
-
RANGE = "RANGE",
|
|
653
|
-
/** A single-value metric aggregation - such as min, max, sum, or avg. */
|
|
654
|
-
SCALAR = "SCALAR",
|
|
655
|
-
/** An aggregation where result buckets are dynamically built - one per time interval such as hour, day, or week. */
|
|
656
|
-
DATE_HISTOGRAM = "DATE_HISTOGRAM",
|
|
657
|
-
/** Multi-level aggregation, where each next aggregation is nested within the previous one. */
|
|
658
|
-
NESTED = "NESTED"
|
|
659
|
-
}
|
|
660
|
-
interface NestedAggregation$1 {
|
|
661
|
-
/** Flattened list of aggregations, where each aggregation is nested within the previous one. */
|
|
662
|
-
nestedAggregations?: NestedAggregationItem$1[];
|
|
663
|
-
}
|
|
664
|
-
interface SearchDetails$1 {
|
|
665
|
-
/** Boolean search mode. Defines how separate search terms in the `expression` are combined. */
|
|
666
|
-
mode?: Mode$1;
|
|
667
|
-
/** Search term or expression. */
|
|
668
|
-
expression?: string | null;
|
|
669
|
-
/**
|
|
670
|
-
* Fields to search in.
|
|
671
|
-
*
|
|
672
|
-
* Searchable fields are `reservee.firstName`, `reservee.lastName`, `reservee.phone`, and `reservee.email`.
|
|
673
|
-
*
|
|
674
|
-
* If the array is empty, all fields are searched.
|
|
675
|
-
*/
|
|
676
|
-
fields?: string[];
|
|
677
|
-
/**
|
|
678
|
-
* Whether to allow the search function to automatically correct typos or minor mistakes in the search expression.
|
|
679
|
-
* The search function uses an algorithm to find results that are close to what the site visitor typed.
|
|
680
|
-
*/
|
|
681
|
-
fuzzy?: boolean;
|
|
682
|
-
}
|
|
683
|
-
declare enum Mode$1 {
|
|
684
|
-
/** Returns instances where any terms in the expression occur. */
|
|
685
|
-
OR = "OR",
|
|
686
|
-
/** Returns instances where all the terms in the expression occur. */
|
|
687
|
-
AND = "AND"
|
|
688
|
-
}
|
|
689
|
-
interface SearchReservationsResponse$1 {
|
|
690
|
-
/** List of Reservations. */
|
|
691
|
-
reservations?: Reservation$1[];
|
|
692
|
-
/** Cursor paging metadata. */
|
|
693
|
-
pagingMetadata?: CursorPagingMetadata$3;
|
|
694
|
-
/** Aggregation data. */
|
|
695
|
-
aggregationData?: AggregationData$1;
|
|
696
|
-
}
|
|
697
|
-
interface AggregationData$1 {
|
|
698
|
-
/** List of the aggregated data results. */
|
|
699
|
-
results?: AggregationResults$1[];
|
|
700
|
-
}
|
|
701
|
-
interface ValueAggregationResult$1 {
|
|
702
|
-
/** Value of the field */
|
|
703
|
-
value?: string;
|
|
704
|
-
/** Count of entities with this value */
|
|
705
|
-
count?: number;
|
|
706
|
-
}
|
|
707
|
-
interface RangeAggregationResult$1 {
|
|
708
|
-
/** Inclusive lower bound of the range. */
|
|
709
|
-
from?: number | null;
|
|
710
|
-
/** Exclusive upper bound of the range. */
|
|
711
|
-
to?: number | null;
|
|
712
|
-
/** Count of entities in the range. */
|
|
713
|
-
count?: number;
|
|
714
|
-
}
|
|
715
|
-
interface NestedAggregationResults$1 extends NestedAggregationResultsResultOneOf$1 {
|
|
716
|
-
/** List of the value aggregation results. */
|
|
717
|
-
values?: ValueResults$1;
|
|
718
|
-
/** List of the range aggregation results. */
|
|
719
|
-
ranges?: RangeResults$1;
|
|
720
|
-
/** List of the scalar aggregation results. */
|
|
721
|
-
scalar?: AggregationResultsScalarResult$1;
|
|
722
|
-
/** Aggregation name defined in the request. */
|
|
723
|
-
name?: string;
|
|
724
|
-
/** Type of aggregation performed. */
|
|
725
|
-
type?: AggregationType$1;
|
|
726
|
-
/** Field the data was aggregated by. */
|
|
727
|
-
fieldPath?: string;
|
|
728
|
-
}
|
|
729
|
-
/** @oneof */
|
|
730
|
-
interface NestedAggregationResultsResultOneOf$1 {
|
|
731
|
-
/** List of the value aggregation results. */
|
|
732
|
-
values?: ValueResults$1;
|
|
733
|
-
/** List of the range aggregation results. */
|
|
734
|
-
ranges?: RangeResults$1;
|
|
735
|
-
/** List of the scalar aggregation results. */
|
|
736
|
-
scalar?: AggregationResultsScalarResult$1;
|
|
737
|
-
}
|
|
738
|
-
interface ValueResults$1 {
|
|
739
|
-
/** List of value aggregations. */
|
|
740
|
-
results?: ValueAggregationResult$1[];
|
|
741
|
-
}
|
|
742
|
-
interface RangeResults$1 {
|
|
743
|
-
/** List of ranges returned in same order as requested. */
|
|
744
|
-
results?: RangeAggregationResult$1[];
|
|
745
|
-
}
|
|
746
|
-
interface AggregationResultsScalarResult$1 {
|
|
747
|
-
/** Type of scalar aggregation. */
|
|
748
|
-
type?: ScalarType$1;
|
|
749
|
-
/** Value of the scalar aggregation. */
|
|
750
|
-
value?: number;
|
|
751
|
-
}
|
|
752
|
-
interface NestedValueAggregationResult$1 {
|
|
753
|
-
value?: string;
|
|
754
|
-
nestedResults?: NestedAggregationResults$1;
|
|
755
|
-
}
|
|
756
|
-
interface ValueResult$1 {
|
|
757
|
-
/** Value of the field. */
|
|
758
|
-
value?: string;
|
|
759
|
-
/** Count of entities with this value. */
|
|
760
|
-
count?: number | null;
|
|
761
|
-
}
|
|
762
|
-
interface RangeResult$1 {
|
|
763
|
-
/** Inclusive lower bound of the range. */
|
|
764
|
-
from?: number | null;
|
|
765
|
-
/** Exclusive upper bound of the range. */
|
|
766
|
-
to?: number | null;
|
|
767
|
-
/** Count of entities in the range. */
|
|
768
|
-
count?: number | null;
|
|
769
|
-
}
|
|
770
|
-
interface ScalarResult$1 {
|
|
771
|
-
/** Scalar aggregation results. */
|
|
772
|
-
value?: number;
|
|
773
|
-
}
|
|
774
|
-
interface NestedResultValue$1 extends NestedResultValueResultOneOf$1 {
|
|
775
|
-
/** Value aggregation results. */
|
|
776
|
-
value?: ValueResult$1;
|
|
777
|
-
/** Range aggregation results. */
|
|
778
|
-
range?: RangeResult$1;
|
|
779
|
-
/** Scalar aggregation results. */
|
|
780
|
-
scalar?: ScalarResult$1;
|
|
781
|
-
/** Date histogram aggregation results. */
|
|
782
|
-
dateHistogram?: ValueResult$1;
|
|
783
|
-
}
|
|
784
|
-
/** @oneof */
|
|
785
|
-
interface NestedResultValueResultOneOf$1 {
|
|
786
|
-
/** Value aggregation results. */
|
|
787
|
-
value?: ValueResult$1;
|
|
788
|
-
/** Range aggregation results. */
|
|
789
|
-
range?: RangeResult$1;
|
|
790
|
-
/** Scalar aggregation results. */
|
|
791
|
-
scalar?: ScalarResult$1;
|
|
792
|
-
/** Date histogram aggregation results. */
|
|
793
|
-
dateHistogram?: ValueResult$1;
|
|
794
|
-
}
|
|
795
|
-
interface Results$1 {
|
|
796
|
-
/** List of nested aggregation results. */
|
|
797
|
-
results?: Record<string, NestedResultValue$1>;
|
|
798
|
-
}
|
|
799
|
-
interface DateHistogramResult$1 {
|
|
800
|
-
/** Date in ISO 8601 format. */
|
|
801
|
-
value?: string;
|
|
802
|
-
/** Count of entities in the interval. */
|
|
803
|
-
count?: number;
|
|
804
|
-
}
|
|
805
|
-
/** deprecated */
|
|
806
|
-
interface GroupByValueResults$1 {
|
|
807
|
-
results?: NestedValueAggregationResult$1[];
|
|
808
|
-
}
|
|
809
|
-
interface DateHistogramResults$1 {
|
|
810
|
-
/** List of date histogram aggregations. */
|
|
811
|
-
results?: DateHistogramResult$1[];
|
|
812
|
-
}
|
|
813
|
-
/**
|
|
814
|
-
* Results of `NESTED` aggregation type in a flattened form.
|
|
815
|
-
* Aggregations in the resulting array are keyed by the requested aggregation `name`.
|
|
816
|
-
*/
|
|
817
|
-
interface NestedResults$1 {
|
|
818
|
-
/** List of nested aggregation results. */
|
|
819
|
-
results?: Results$1[];
|
|
820
|
-
}
|
|
821
|
-
interface AggregationResults$1 extends AggregationResultsResultOneOf$1 {
|
|
822
|
-
/** Value aggregation results. */
|
|
823
|
-
values?: ValueResults$1;
|
|
824
|
-
/** Range aggregation results. */
|
|
825
|
-
ranges?: RangeResults$1;
|
|
826
|
-
/** Scalar aggregation results. */
|
|
827
|
-
scalar?: AggregationResultsScalarResult$1;
|
|
828
|
-
/** deprecated */
|
|
829
|
-
groupedByValue?: GroupByValueResults$1;
|
|
830
|
-
/** Date histogram aggregation results. */
|
|
831
|
-
dateHistogram?: DateHistogramResults$1;
|
|
832
|
-
/** Nested aggregation results. */
|
|
833
|
-
nested?: NestedResults$1;
|
|
834
|
-
/** Aggregation name defined in the request. */
|
|
835
|
-
name?: string;
|
|
836
|
-
/** Type of aggregation that was performed. */
|
|
837
|
-
type?: AggregationType$1;
|
|
838
|
-
/** Field the data was aggregated by. */
|
|
839
|
-
fieldPath?: string;
|
|
840
|
-
}
|
|
841
|
-
/** @oneof */
|
|
842
|
-
interface AggregationResultsResultOneOf$1 {
|
|
843
|
-
/** Value aggregation results. */
|
|
844
|
-
values?: ValueResults$1;
|
|
845
|
-
/** Range aggregation results. */
|
|
846
|
-
ranges?: RangeResults$1;
|
|
847
|
-
/** Scalar aggregation results. */
|
|
848
|
-
scalar?: AggregationResultsScalarResult$1;
|
|
849
|
-
/** deprecated */
|
|
850
|
-
groupedByValue?: GroupByValueResults$1;
|
|
851
|
-
/** Date histogram aggregation results. */
|
|
852
|
-
dateHistogram?: DateHistogramResults$1;
|
|
853
|
-
/** Nested aggregation results. */
|
|
854
|
-
nested?: NestedResults$1;
|
|
855
|
-
}
|
|
856
|
-
interface TablesNonNullableFields$1 {
|
|
857
|
-
ids: string[];
|
|
858
|
-
}
|
|
859
|
-
interface DetailsNonNullableFields$1 {
|
|
860
|
-
tables?: TablesNonNullableFields$1;
|
|
861
|
-
}
|
|
862
|
-
interface TableWithReservationConflictsNonNullableFields$1 {
|
|
863
|
-
tableId: string;
|
|
864
|
-
reservationIds: string[];
|
|
865
|
-
}
|
|
866
|
-
interface ReservationNonNullableFields$1 {
|
|
867
|
-
status: Status$3;
|
|
868
|
-
source: Source$1;
|
|
869
|
-
details?: DetailsNonNullableFields$1;
|
|
870
|
-
tablesWithReservationConflicts: TableWithReservationConflictsNonNullableFields$1[];
|
|
871
|
-
paymentStatus: PaymentStatus$1;
|
|
872
|
-
}
|
|
873
|
-
interface CreateReservationResponseNonNullableFields$1 {
|
|
874
|
-
reservation?: ReservationNonNullableFields$1;
|
|
875
|
-
}
|
|
876
|
-
interface GetReservationResponseNonNullableFields$1 {
|
|
877
|
-
reservation?: ReservationNonNullableFields$1;
|
|
878
|
-
}
|
|
879
|
-
interface UpdateReservationResponseNonNullableFields$1 {
|
|
880
|
-
reservation?: ReservationNonNullableFields$1;
|
|
881
|
-
}
|
|
882
|
-
interface UpdateExtendedFieldsResponseNonNullableFields$3 {
|
|
883
|
-
reservation?: ReservationNonNullableFields$1;
|
|
884
|
-
}
|
|
885
|
-
interface CreateHeldReservationResponseNonNullableFields$1 {
|
|
886
|
-
reservation?: ReservationNonNullableFields$1;
|
|
887
|
-
}
|
|
888
|
-
interface ReserveReservationResponseNonNullableFields$1 {
|
|
889
|
-
reservation?: ReservationNonNullableFields$1;
|
|
890
|
-
}
|
|
891
|
-
interface CancelReservationResponseNonNullableFields$1 {
|
|
892
|
-
reservation?: ReservationNonNullableFields$1;
|
|
893
|
-
}
|
|
894
|
-
interface ListReservationsResponseNonNullableFields$1 {
|
|
895
|
-
reservations: ReservationNonNullableFields$1[];
|
|
896
|
-
}
|
|
897
|
-
interface QueryReservationsResponseNonNullableFields$1 {
|
|
898
|
-
reservations: ReservationNonNullableFields$1[];
|
|
899
|
-
}
|
|
900
|
-
interface ValueAggregationResultNonNullableFields$1 {
|
|
901
|
-
value: string;
|
|
902
|
-
count: number;
|
|
903
|
-
}
|
|
904
|
-
interface ValueResultsNonNullableFields$1 {
|
|
905
|
-
results: ValueAggregationResultNonNullableFields$1[];
|
|
906
|
-
}
|
|
907
|
-
interface RangeAggregationResultNonNullableFields$1 {
|
|
908
|
-
count: number;
|
|
909
|
-
}
|
|
910
|
-
interface RangeResultsNonNullableFields$1 {
|
|
911
|
-
results: RangeAggregationResultNonNullableFields$1[];
|
|
912
|
-
}
|
|
913
|
-
interface AggregationResultsScalarResultNonNullableFields$1 {
|
|
914
|
-
type: ScalarType$1;
|
|
915
|
-
value: number;
|
|
916
|
-
}
|
|
917
|
-
interface NestedAggregationResultsNonNullableFields$1 {
|
|
918
|
-
values?: ValueResultsNonNullableFields$1;
|
|
919
|
-
ranges?: RangeResultsNonNullableFields$1;
|
|
920
|
-
scalar?: AggregationResultsScalarResultNonNullableFields$1;
|
|
921
|
-
name: string;
|
|
922
|
-
type: AggregationType$1;
|
|
923
|
-
fieldPath: string;
|
|
924
|
-
}
|
|
925
|
-
interface NestedValueAggregationResultNonNullableFields$1 {
|
|
926
|
-
value: string;
|
|
927
|
-
nestedResults?: NestedAggregationResultsNonNullableFields$1;
|
|
928
|
-
}
|
|
929
|
-
interface GroupByValueResultsNonNullableFields$1 {
|
|
930
|
-
results: NestedValueAggregationResultNonNullableFields$1[];
|
|
931
|
-
}
|
|
932
|
-
interface DateHistogramResultNonNullableFields$1 {
|
|
933
|
-
value: string;
|
|
934
|
-
count: number;
|
|
935
|
-
}
|
|
936
|
-
interface DateHistogramResultsNonNullableFields$1 {
|
|
937
|
-
results: DateHistogramResultNonNullableFields$1[];
|
|
938
|
-
}
|
|
939
|
-
interface AggregationResultsNonNullableFields$1 {
|
|
940
|
-
values?: ValueResultsNonNullableFields$1;
|
|
941
|
-
ranges?: RangeResultsNonNullableFields$1;
|
|
942
|
-
scalar?: AggregationResultsScalarResultNonNullableFields$1;
|
|
943
|
-
groupedByValue?: GroupByValueResultsNonNullableFields$1;
|
|
944
|
-
dateHistogram?: DateHistogramResultsNonNullableFields$1;
|
|
945
|
-
name: string;
|
|
946
|
-
type: AggregationType$1;
|
|
947
|
-
fieldPath: string;
|
|
948
|
-
}
|
|
949
|
-
interface AggregationDataNonNullableFields$1 {
|
|
950
|
-
results: AggregationResultsNonNullableFields$1[];
|
|
951
|
-
}
|
|
952
|
-
interface SearchReservationsResponseNonNullableFields$1 {
|
|
953
|
-
reservations: ReservationNonNullableFields$1[];
|
|
954
|
-
aggregationData?: AggregationDataNonNullableFields$1;
|
|
955
|
-
}
|
|
956
|
-
|
|
957
|
-
/** The reservation domain object. */
|
|
958
|
-
interface Reservation {
|
|
959
|
-
/**
|
|
960
|
-
* Reservation ID.
|
|
961
|
-
* @readonly
|
|
962
|
-
*/
|
|
963
|
-
_id?: string | null;
|
|
964
|
-
/**
|
|
965
|
-
* Status of the reservation.
|
|
966
|
-
*
|
|
967
|
-
* Supported values:
|
|
968
|
-
*
|
|
969
|
-
* * `HELD`: The reservation is temporary and will expire in 10 minutes if its status isn’t changed. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request.
|
|
970
|
-
* * `REQUESTED`: A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request.
|
|
971
|
-
* * `DECLINED`: The restaurant’s owner or staff declined the customer’s request to make the reservation.
|
|
972
|
-
* * `RESERVED`: The reservation is confirmed.
|
|
973
|
-
* * `SEATED`: The customer is currently occupying the table.
|
|
974
|
-
* * `CANCELED`: The reservation is canceled.
|
|
975
|
-
* * `NO_SHOW`: The customer didn't show up for their reservation.
|
|
976
|
-
* * `FINISHED`: The reservation completed successfully.
|
|
977
|
-
*
|
|
978
|
-
*
|
|
979
|
-
* See the article for this API titled "The Reservation Lifecycle" in the menu on the left for more details on each of the statuses, and an explanation of the reservation lifecycle.
|
|
980
|
-
*/
|
|
981
|
-
status?: Status$2;
|
|
982
|
-
/**
|
|
983
|
-
* Reservation source.
|
|
984
|
-
*
|
|
985
|
-
* This indicates how the reservation was made.
|
|
986
|
-
*/
|
|
987
|
-
source?: Source;
|
|
988
|
-
/** Reservation details. */
|
|
989
|
-
details?: Details;
|
|
990
|
-
/**
|
|
991
|
-
* Information about the person the reservation is being made for.
|
|
992
|
-
*
|
|
993
|
-
* A reservation created with any `source` other than `WALK_IN` requires the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
|
|
994
|
-
* Attempting to create a reservation without these fields results in an error.
|
|
995
|
-
*/
|
|
996
|
-
reservee?: Reservee;
|
|
997
|
-
/**
|
|
998
|
-
* Information about the person making the reservation.
|
|
999
|
-
*
|
|
1000
|
-
* This field is required if the reservation's `status` is anything other than `WALK_IN`.
|
|
1001
|
-
* @readonly
|
|
1002
|
-
*/
|
|
1003
|
-
reservedBy?: ReservedBy;
|
|
1004
|
-
/**
|
|
1005
|
-
* Team message.
|
|
1006
|
-
*
|
|
1007
|
-
* A message for the restaurant staff containing any additional information regarding the reservation, such as special requirements for the guests.
|
|
1008
|
-
*/
|
|
1009
|
-
teamMessage?: string | null;
|
|
1010
|
-
/**
|
|
1011
|
-
* Date and time the reservation was created.
|
|
1012
|
-
* @readonly
|
|
1013
|
-
*/
|
|
1014
|
-
_createdDate?: Date | null;
|
|
1015
|
-
/**
|
|
1016
|
-
* Date and time the reservation was changed.
|
|
1017
|
-
* @readonly
|
|
1018
|
-
*/
|
|
1019
|
-
_updatedDate?: Date | null;
|
|
1020
|
-
/**
|
|
1021
|
-
* Revision number, which increments by 1 each time the reservation is updated.
|
|
1022
|
-
* To prevent conflicting changes, the current revision must be specified when updating the reservation.
|
|
1023
|
-
*
|
|
1024
|
-
* Ignored when creating a reservation.
|
|
1025
|
-
* @readonly
|
|
1026
|
-
*/
|
|
1027
|
-
revision?: string | null;
|
|
1028
|
-
/** The reason the reservation was declined. */
|
|
1029
|
-
declineReason?: string | null;
|
|
1030
|
-
/**
|
|
1031
|
-
* Payment status.
|
|
1032
|
-
* @readonly
|
|
1033
|
-
*/
|
|
1034
|
-
paymentStatus?: PaymentStatus;
|
|
1035
|
-
/**
|
|
1036
|
-
* Custom field data for the reservation object.
|
|
1037
|
-
*
|
|
1038
|
-
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
1039
|
-
*/
|
|
1040
|
-
extendedFields?: ExtendedFields$2;
|
|
1041
|
-
}
|
|
1042
|
-
/** Tables used for the reservation. If you don't specify a `tables` object, the server attempts to assign tables automatically. */
|
|
1043
|
-
interface Tables {
|
|
1044
|
-
/** IDs of tables used for this reservation. If you don't specify an `ids` array, or you specify an empty array, no tables are assigned. */
|
|
1045
|
-
ids?: string[];
|
|
1046
|
-
}
|
|
1047
|
-
declare enum Status$2 {
|
|
1048
|
-
/** Undefined reservation status. */
|
|
1049
|
-
UNKNOWN = "UNKNOWN",
|
|
1050
|
-
/** A customer has begun the reservation flow, a temporary reservation is created and will expire in 10 minutes unless the customer moves forward with the reservation flow. This phase temporarily reserves the required number of seats and tables for a given party size at a chosen time while a customer enters details and/or confirms their reservation request. */
|
|
1051
|
-
HELD = "HELD",
|
|
1052
|
-
/** The reservation is confirmed. */
|
|
1053
|
-
RESERVED = "RESERVED",
|
|
1054
|
-
/** The reservation is canceled. */
|
|
1055
|
-
CANCELED = "CANCELED",
|
|
1056
|
-
/** The reservation completed successfully. */
|
|
1057
|
-
FINISHED = "FINISHED",
|
|
1058
|
-
/** The customer didn't show up for their reservation. */
|
|
1059
|
-
NO_SHOW = "NO_SHOW",
|
|
1060
|
-
/** The customer is currently occupying the table. */
|
|
1061
|
-
SEATED = "SEATED",
|
|
1062
|
-
/** A customer finished requesting this reservation, meaning they have added all necessary details and confirmed the request. Restaurant staff can now either approve or decline the reservation request. */
|
|
1063
|
-
REQUESTED = "REQUESTED",
|
|
1064
|
-
/** The restaurant’s owner or staff declined the customer’s request to make the reservation. */
|
|
1065
|
-
DECLINED = "DECLINED",
|
|
1066
|
-
/** A customer has begun the checkout flow, the temporary reservation is moved to this status and will expire in 10 minutes from the created time, during which time the reservee should pay. This status is set automatically when the reserve reservation endpoint is called for a reservation in `HELD` status and payment is needed. After payment is completed status will be changed automatically to `RESERVED`. */
|
|
1067
|
-
PAYMENT_PENDING = "PAYMENT_PENDING"
|
|
1068
|
-
}
|
|
1069
|
-
declare enum Source {
|
|
1070
|
-
/** Undefined reservation source. */
|
|
1071
|
-
UNKNOWN = "UNKNOWN",
|
|
1072
|
-
/** The reservation was made by a restaurant employee, for example when a customer calls to make a reservation. */
|
|
1073
|
-
OFFLINE = "OFFLINE",
|
|
1074
|
-
/** The reservation was made through a website or app. */
|
|
1075
|
-
ONLINE = "ONLINE",
|
|
1076
|
-
/** The reservation was made by a restaurant employee when the customer arrived at the restaurant without a prior reservation. */
|
|
1077
|
-
WALK_IN = "WALK_IN"
|
|
1078
|
-
}
|
|
1079
|
-
/** Reservation details. */
|
|
1080
|
-
interface Details {
|
|
1081
|
-
/** ID of the reservation location at which this reservation will be made. */
|
|
1082
|
-
reservationLocationId?: string | null;
|
|
1083
|
-
/**
|
|
1084
|
-
* IDs of tables used for this reservation.
|
|
1085
|
-
* @deprecated
|
|
1086
|
-
* @replacedBy tables
|
|
1087
|
-
* @targetRemovalDate 2024-12-31
|
|
1088
|
-
*/
|
|
1089
|
-
tableIds?: string[] | null;
|
|
1090
|
-
/** Tables used for this reservation. */
|
|
1091
|
-
tables?: Tables;
|
|
1092
|
-
/** Start date and time of the reservation. */
|
|
1093
|
-
startDate?: Date | null;
|
|
1094
|
-
/** End date and time of the reservation. */
|
|
1095
|
-
endDate?: Date | null;
|
|
1096
|
-
/** Party size. */
|
|
1097
|
-
partySize?: number | null;
|
|
1098
|
-
}
|
|
1099
|
-
/** The person the reservation is being made for. */
|
|
1100
|
-
interface Reservee {
|
|
1101
|
-
/**
|
|
1102
|
-
* First name.
|
|
1103
|
-
*
|
|
1104
|
-
* This field is required if the reservation's `status` is anything other than `WALK_IN`.
|
|
1105
|
-
*/
|
|
1106
|
-
firstName?: string | null;
|
|
1107
|
-
/** Last name. */
|
|
1108
|
-
lastName?: string | null;
|
|
1109
|
-
/** Email address. */
|
|
1110
|
-
email?: string | null;
|
|
1111
|
-
/**
|
|
1112
|
-
* Phone number.
|
|
1113
|
-
*
|
|
1114
|
-
* This property should begin with a +, followed by the country code, and then the rest of the phone number. For example, `"+972555555555"`.
|
|
1115
|
-
*
|
|
1116
|
-
* This field is required if the reservation's `status` is anything other than `WALK_IN`.
|
|
1117
|
-
*/
|
|
1118
|
-
phone?: string | null;
|
|
1119
|
-
/** Whether the reservee has given marketing consent. */
|
|
1120
|
-
marketingConsent?: boolean | null;
|
|
1121
|
-
/**
|
|
1122
|
-
* Custom fields for the reservee in key-value pairs.
|
|
1123
|
-
*
|
|
1124
|
-
* The key is the custom field's ID, and the value is the custom field's value. For example, a custom field for allergies might have the key-value pair `f4283b2d-6340-4cf9-bae7-8769e6b62127 : "Nuts, Seafood"`.
|
|
1125
|
-
*
|
|
1126
|
-
* Empty fields are not returned.
|
|
1127
|
-
*/
|
|
1128
|
-
customFields?: Record<string, any> | null;
|
|
1129
|
-
/**
|
|
1130
|
-
* Contact ID. If a contact with this ID does not exist on the site, one will be created.
|
|
1131
|
-
* @readonly
|
|
1132
|
-
*/
|
|
1133
|
-
contactId?: string | null;
|
|
1134
|
-
}
|
|
1135
|
-
/** A person making reservation. */
|
|
1136
|
-
interface ReservedBy {
|
|
1137
|
-
/**
|
|
1138
|
-
* Contact ID for the person who made the reservation. If a contact with this ID does not exist on the site, one will be created.
|
|
1139
|
-
* @readonly
|
|
1140
|
-
*/
|
|
1141
|
-
contactId?: string | null;
|
|
1142
|
-
}
|
|
1143
|
-
declare enum PaymentStatus {
|
|
1144
|
-
/** Undefined payment status. */
|
|
1145
|
-
UNKNOWN = "UNKNOWN",
|
|
1146
|
-
/** A reservation is free of charge. */
|
|
1147
|
-
FREE = "FREE",
|
|
1148
|
-
/** Payment is not received yet. */
|
|
1149
|
-
NOT_PAID = "NOT_PAID",
|
|
1150
|
-
/** The corresponding reservation order was fully paid. */
|
|
1151
|
-
PAID = "PAID",
|
|
1152
|
-
/** The corresponding reservation order was refunded, but the refund amount is less than the order total price. */
|
|
1153
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
1154
|
-
/** The corresponding reservation order was fully refunded. The refund amount equals the total price. */
|
|
1155
|
-
FULLY_REFUNDED = "FULLY_REFUNDED",
|
|
1156
|
-
/** The corresponding reservation order was partially paid. */
|
|
1157
|
-
PARTIALLY_PAID = "PARTIALLY_PAID"
|
|
1158
|
-
}
|
|
1159
|
-
interface ExtendedFields$2 {
|
|
1160
|
-
/**
|
|
1161
|
-
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
1162
|
-
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
1163
|
-
*
|
|
1164
|
-
* You can only access fields for which you have the appropriate permissions.
|
|
1165
|
-
*
|
|
1166
|
-
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
1167
|
-
*/
|
|
1168
|
-
namespaces?: Record<string, Record<string, any>>;
|
|
1169
|
-
}
|
|
1170
|
-
interface CreateReservationRequest {
|
|
1171
|
-
/** Reservation details. */
|
|
1172
|
-
reservation: Reservation;
|
|
1173
|
-
/**
|
|
1174
|
-
* Ignore table combination conflicts of the types specified in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
|
|
1175
|
-
*
|
|
1176
|
-
* Possible values:
|
|
1177
|
-
* * `"RESERVED"`: One or more of the chosen tables are already reserved.
|
|
1178
|
-
* * `"TOO_BIG"`: The party is too big for the selected table.
|
|
1179
|
-
* * `"TOO_SMALL"`: The party is too small for the selected table.
|
|
1180
|
-
* * `"OFFLINE_ONLY"`: The restaurant does not allow online reservations.
|
|
1181
|
-
*/
|
|
1182
|
-
ignoreTableCombinationConflicts?: TableCombinationConflictType$2[];
|
|
1183
|
-
/**
|
|
1184
|
-
* Ignored reservation location conflicts of the types specified in the array. This ensures that the reservation is created even if the given conflicts would normally prevent it.
|
|
1185
|
-
*
|
|
1186
|
-
* Possible values:
|
|
1187
|
-
* * `"PARTY_PACING"`: The restaurant cannot accommodate a party of the given size according to party pacing settings.
|
|
1188
|
-
* * `"SEAT_PACING"`: The required number of seats are unavailable according to seat pacing settings.
|
|
1189
|
-
*/
|
|
1190
|
-
ignoreReservationLocationConflicts?: Type$2[];
|
|
1191
|
-
}
|
|
1192
|
-
declare enum TableCombinationConflictType$2 {
|
|
1193
|
-
/** Undefined conflict type. */
|
|
1194
|
-
UNKNOWN = "UNKNOWN",
|
|
1195
|
-
/** One or more of the chosen tables are already reserved. */
|
|
1196
|
-
RESERVED = "RESERVED",
|
|
1197
|
-
/** The party is too big for the selected table. */
|
|
1198
|
-
TOO_BIG = "TOO_BIG",
|
|
1199
|
-
/** The party is too small for the selected table. */
|
|
1200
|
-
TOO_SMALL = "TOO_SMALL",
|
|
1201
|
-
/** The restaurant does not allow online reservations. */
|
|
1202
|
-
OFFLINE_ONLY = "OFFLINE_ONLY"
|
|
1203
|
-
}
|
|
1204
|
-
declare enum Type$2 {
|
|
1205
|
-
/** Undefined reservation location conflict type. */
|
|
1206
|
-
UNKNOWN = "UNKNOWN",
|
|
1207
|
-
/** The restaurant cannot accommodate a party of the given size according to party pacing settings. */
|
|
1208
|
-
PARTY_PACING = "PARTY_PACING",
|
|
1209
|
-
/** The required number of seats are unavailable according to seat pacing settings. */
|
|
1210
|
-
SEAT_PACING = "SEAT_PACING"
|
|
1211
|
-
}
|
|
1212
|
-
interface CreateReservationResponse {
|
|
1213
|
-
/** Reservation. */
|
|
1214
|
-
reservation?: Reservation;
|
|
1215
|
-
}
|
|
1216
|
-
interface GetReservationRequest {
|
|
1217
|
-
/** Reservation ID. */
|
|
1218
|
-
reservationId: string;
|
|
1219
|
-
/**
|
|
1220
|
-
* Array of named, predefined sets of projected fields to be returned.
|
|
1221
|
-
*
|
|
1222
|
-
* Supported values: `PUBLIC`, `FULL`.
|
|
1223
|
-
*
|
|
1224
|
-
* Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.
|
|
1225
|
-
*/
|
|
1226
|
-
fieldsets?: Set$2[];
|
|
1227
|
-
}
|
|
1228
|
-
declare enum Set$2 {
|
|
1229
|
-
/**
|
|
1230
|
-
* Returns `id`, `status`, `details.reservationLocationId`, `details.startDate`, `details.endDate`, `details.partySize`, `createdDate`, `revision`, `declineReason`,
|
|
1231
|
-
* `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
|
|
1232
|
-
*/
|
|
1233
|
-
PUBLIC = "PUBLIC",
|
|
1234
|
-
/** Returns all fields. */
|
|
1235
|
-
FULL = "FULL"
|
|
1236
|
-
}
|
|
1237
|
-
interface GetReservationResponse {
|
|
1238
|
-
/** Reservation. */
|
|
1239
|
-
reservation?: Reservation;
|
|
1240
|
-
}
|
|
1241
|
-
interface UpdateReservationRequest {
|
|
1242
|
-
/** Reservation information to update. */
|
|
1243
|
-
reservation: Reservation;
|
|
1244
|
-
/** Ignore table combination conflicts of the types included in the array. This ensures that the reservation is updated even if the given conflicts would normally prevent it. */
|
|
1245
|
-
ignoreTableCombinationConflicts?: TableCombinationConflictType$2[];
|
|
1246
|
-
ignoreReservationLocationConflicts?: Type$2[];
|
|
1247
|
-
}
|
|
1248
|
-
interface UpdateReservationResponse {
|
|
1249
|
-
/** Reservation. */
|
|
1250
|
-
reservation?: Reservation;
|
|
1251
|
-
}
|
|
1252
|
-
interface UpdateExtendedFieldsRequest$2 {
|
|
1253
|
-
/** ID of the entity to update. */
|
|
1254
|
-
_id: string;
|
|
1255
|
-
/** Identifier for the app whose extended fields are being updated. */
|
|
1256
|
-
namespace: string;
|
|
1257
|
-
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
1258
|
-
namespaceData: Record<string, any> | null;
|
|
1259
|
-
}
|
|
1260
|
-
interface UpdateExtendedFieldsResponse$2 {
|
|
1261
|
-
/** Updated reservation. */
|
|
1262
|
-
reservation?: Reservation;
|
|
1263
|
-
}
|
|
1264
|
-
interface CreateHeldReservationRequest {
|
|
1265
|
-
/** Held reservation information to update. */
|
|
1266
|
-
reservationDetails: HeldReservationDetails;
|
|
1267
|
-
}
|
|
1268
|
-
/** Reservation details when create reservation in status HELD. */
|
|
1269
|
-
interface HeldReservationDetails {
|
|
1270
|
-
/** ID of the reservation location where the reservation is made. */
|
|
1271
|
-
reservationLocationId?: string | null;
|
|
1272
|
-
/** Start date and time of the reservation. */
|
|
1273
|
-
startDate?: Date | null;
|
|
1274
|
-
/** Party size. */
|
|
1275
|
-
partySize?: number | null;
|
|
1276
|
-
}
|
|
1277
|
-
interface CreateHeldReservationResponse {
|
|
1278
|
-
/** Reservation. */
|
|
1279
|
-
reservation?: Reservation;
|
|
1280
|
-
}
|
|
1281
|
-
interface ReserveReservationRequest {
|
|
1282
|
-
/** Reservation ID. */
|
|
1283
|
-
reservationId: string;
|
|
1284
|
-
/** Reservee details. */
|
|
1285
|
-
reservee: Reservee;
|
|
1286
|
-
/**
|
|
1287
|
-
* Revision number.
|
|
1288
|
-
*
|
|
1289
|
-
* Specify the existing `revision` to prevent conflicting updates to reservations.
|
|
1290
|
-
*/
|
|
1291
|
-
revision: string | null;
|
|
1292
|
-
}
|
|
1293
|
-
interface ReserveReservationResponse {
|
|
1294
|
-
/** Reservation. */
|
|
1295
|
-
reservation?: Reservation;
|
|
1296
|
-
}
|
|
1297
|
-
interface CancelReservationRequest {
|
|
1298
|
-
/** Reservation ID. */
|
|
1299
|
-
reservationId: string;
|
|
1300
|
-
/**
|
|
1301
|
-
* Revision number.
|
|
1302
|
-
*
|
|
1303
|
-
* Specify the existing `revision` to prevent conflicting updates to reservations.
|
|
1304
|
-
*/
|
|
1305
|
-
revision: string | null;
|
|
1306
|
-
/**
|
|
1307
|
-
* The phone number that was provided when the reservation was created.
|
|
1308
|
-
*
|
|
1309
|
-
* This is required for reservations with any `source` other than `WALK_IN`.
|
|
1310
|
-
*
|
|
1311
|
-
* This requirement provides additional security by ensuring that the canceling party knows both the reservation's `reservationId` and the reservee's `phone`.
|
|
1312
|
-
*/
|
|
1313
|
-
phone?: string | null;
|
|
1314
|
-
}
|
|
1315
|
-
interface CancelReservationResponse {
|
|
1316
|
-
/** Reservation. */
|
|
1317
|
-
reservation?: Reservation;
|
|
1318
|
-
}
|
|
1319
|
-
interface DeleteReservationRequest {
|
|
1320
|
-
/** Reservation ID. */
|
|
1321
|
-
reservationId: string;
|
|
1322
|
-
}
|
|
1323
|
-
interface DeleteReservationResponse {
|
|
1324
|
-
}
|
|
1325
|
-
interface ListReservationsRequest {
|
|
1326
|
-
/** 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`. */
|
|
1327
|
-
paging?: CursorPaging$2;
|
|
1328
|
-
/** Defines how reservations in the response are sorted. */
|
|
1329
|
-
sort?: Sorting$2;
|
|
1330
|
-
/** Only reservations starting after this date are returned. */
|
|
1331
|
-
startDateFrom?: Date | null;
|
|
1332
|
-
/** Only reservations starting before this date are returned. */
|
|
1333
|
-
startDateTo?: Date | null;
|
|
1334
|
-
/** Only reservations with this status are returned. */
|
|
1335
|
-
status?: Status$2;
|
|
1336
|
-
}
|
|
1337
|
-
interface CursorPaging$2 {
|
|
1338
|
-
/** Number of items to load. */
|
|
1339
|
-
limit?: number | null;
|
|
1340
|
-
/**
|
|
1341
|
-
* Pointer to the next or previous page in the list of results.
|
|
1342
|
-
*
|
|
1343
|
-
* You can get the relevant cursor token
|
|
1344
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
1345
|
-
* Not relevant for the first request.
|
|
1346
|
-
*/
|
|
1347
|
-
cursor?: string | null;
|
|
1348
|
-
}
|
|
1349
|
-
interface Sorting$2 {
|
|
1350
|
-
/** Name of the field to sort by. */
|
|
1351
|
-
fieldName?: string;
|
|
1352
|
-
/**
|
|
1353
|
-
* Sort order.
|
|
1354
|
-
* Default: `ASC`.
|
|
1355
|
-
*/
|
|
1356
|
-
order?: SortOrder$2;
|
|
1357
|
-
}
|
|
1358
|
-
declare enum SortOrder$2 {
|
|
1359
|
-
/** Sort by ascending order. */
|
|
1360
|
-
ASC = "ASC",
|
|
1361
|
-
/** Sort by descending order. */
|
|
1362
|
-
DESC = "DESC"
|
|
1363
|
-
}
|
|
1364
|
-
interface ListReservationsResponse {
|
|
1365
|
-
/** List of reservations. */
|
|
1366
|
-
reservations?: Reservation[];
|
|
1367
|
-
/** Metadata for the paginated results. */
|
|
1368
|
-
pagingMetadata?: CursorPagingMetadata$2;
|
|
1369
|
-
}
|
|
1370
|
-
interface CursorPagingMetadata$2 {
|
|
1371
|
-
/** Number of items returned in the response. */
|
|
1372
|
-
count?: number | null;
|
|
1373
|
-
/** Offset that was requested. */
|
|
1374
|
-
cursors?: Cursors$2;
|
|
1375
|
-
/**
|
|
1376
|
-
* Indicates if there are more results after the current page.
|
|
1377
|
-
* If `true`, another page of results can be retrieved.
|
|
1378
|
-
* If `false`, this is the last page.
|
|
1379
|
-
*/
|
|
1380
|
-
hasNext?: boolean | null;
|
|
1381
|
-
}
|
|
1382
|
-
interface Cursors$2 {
|
|
1383
|
-
/** Cursor pointing to next page in the list of results. */
|
|
1384
|
-
next?: string | null;
|
|
1385
|
-
/** Cursor pointing to previous page in the list of results. */
|
|
1386
|
-
prev?: string | null;
|
|
1387
|
-
}
|
|
1388
|
-
interface QueryReservationsRequest {
|
|
1389
|
-
/** Query to select reservations. */
|
|
1390
|
-
query: CursorQuery;
|
|
1391
|
-
}
|
|
1392
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1393
|
-
/** 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`. */
|
|
1394
|
-
cursorPaging?: CursorPaging$2;
|
|
1395
|
-
/**
|
|
1396
|
-
* Filter object in the following format:
|
|
1397
|
-
* `"filter" : {
|
|
1398
|
-
* "fieldName1": "value1",
|
|
1399
|
-
* "fieldName2":{"$operator":"value2"}
|
|
1400
|
-
* }`
|
|
1401
|
-
*
|
|
1402
|
-
* For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/sorting-filtering-and-search) article.
|
|
1403
|
-
* To learn how to query reservations, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
|
|
1404
|
-
*/
|
|
1405
|
-
filter?: Record<string, any> | null;
|
|
1406
|
-
/**
|
|
1407
|
-
* Sort object in the following format:
|
|
1408
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
1409
|
-
*/
|
|
1410
|
-
sort?: Sorting$2[];
|
|
1411
|
-
}
|
|
1412
|
-
/** @oneof */
|
|
1413
|
-
interface CursorQueryPagingMethodOneOf {
|
|
1414
|
-
/** 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`. */
|
|
1415
|
-
cursorPaging?: CursorPaging$2;
|
|
1416
|
-
}
|
|
1417
|
-
interface QueryReservationsResponse {
|
|
1418
|
-
/** List of reservations. */
|
|
1419
|
-
reservations?: Reservation[];
|
|
1420
|
-
/** Metadata for the paginated results. */
|
|
1421
|
-
pagingMetadata?: CursorPagingMetadata$2;
|
|
1422
|
-
}
|
|
1423
|
-
interface SearchReservationsRequest {
|
|
1424
|
-
/** Search query. */
|
|
1425
|
-
search: CursorSearch;
|
|
1426
|
-
}
|
|
1427
|
-
interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
1428
|
-
/** Cursor pointing to a page of results. Can't be used together with 'paging'. 'cursorPaging.cursor' can't be used together with 'filter' or 'sort'. */
|
|
1429
|
-
cursorPaging?: CursorPaging$2;
|
|
1430
|
-
/**
|
|
1431
|
-
* Filter object in the following format:
|
|
1432
|
-
* `"filter" : {
|
|
1433
|
-
* "fieldName1": "value1",
|
|
1434
|
-
* "fieldName2":{"$operator":"value2"}
|
|
1435
|
-
* }`
|
|
1436
|
-
* For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/sorting-filtering-and-search) article.
|
|
1437
|
-
*/
|
|
1438
|
-
filter?: Record<string, any> | null;
|
|
1439
|
-
/**
|
|
1440
|
-
* Sort object in the following format:
|
|
1441
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
1442
|
-
*/
|
|
1443
|
-
sort?: Sorting$2[];
|
|
1444
|
-
/**
|
|
1445
|
-
* A search method for grouping data into various categories (facets) and providing summaries for each category.
|
|
1446
|
-
* For example, use aggregations to allow site visitors to narrow down their search results by selecting specific reservation statuses, party sizes, etc.
|
|
1447
|
-
*/
|
|
1448
|
-
aggregations?: Aggregation[];
|
|
1449
|
-
/** Free text to match in searchable fields. */
|
|
1450
|
-
search?: SearchDetails;
|
|
1451
|
-
/** Time zone to adjust date-time-based filters and aggregations. ISO 8601 or IANA time zone database format. */
|
|
1452
|
-
timeZone?: string | null;
|
|
1453
|
-
}
|
|
1454
|
-
/** @oneof */
|
|
1455
|
-
interface CursorSearchPagingMethodOneOf {
|
|
1456
|
-
/** Cursor pointing to a page of results. Can't be used together with 'paging'. 'cursorPaging.cursor' can't be used together with 'filter' or 'sort'. */
|
|
1457
|
-
cursorPaging?: CursorPaging$2;
|
|
1458
|
-
}
|
|
1459
|
-
interface Aggregation extends AggregationKindOneOf {
|
|
1460
|
-
/** A value aggregation calculates metrics such as "count" for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of reservations (count) of each status that have been made on the site. */
|
|
1461
|
-
value?: ValueAggregation;
|
|
1462
|
-
/** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
|
|
1463
|
-
range?: RangeAggregation;
|
|
1464
|
-
/** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the average part size of reservations made on a site. */
|
|
1465
|
-
scalar?: ScalarAggregation;
|
|
1466
|
-
/** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
|
|
1467
|
-
dateHistogram?: DateHistogramAggregation;
|
|
1468
|
-
/**
|
|
1469
|
-
* A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy.
|
|
1470
|
-
* For example, to get the number of reservations by party size for each week, first perform a date histogram aggregation on `details.startDate` with the interval `WEEK`, and a second value aggregation on `details.partySize`.
|
|
1471
|
-
*/
|
|
1472
|
-
nested?: NestedAggregation;
|
|
1473
|
-
name?: string | null;
|
|
1474
|
-
type?: AggregationType;
|
|
1475
|
-
fieldPath?: string;
|
|
1476
|
-
}
|
|
1477
|
-
/** @oneof */
|
|
1478
|
-
interface AggregationKindOneOf {
|
|
1479
|
-
/** A value aggregation calculates metrics such as "count" for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of reservations (count) of each status that have been made on the site. */
|
|
1480
|
-
value?: ValueAggregation;
|
|
1481
|
-
/** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
|
|
1482
|
-
range?: RangeAggregation;
|
|
1483
|
-
/** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the average part size of reservations made on a site. */
|
|
1484
|
-
scalar?: ScalarAggregation;
|
|
1485
|
-
/** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
|
|
1486
|
-
dateHistogram?: DateHistogramAggregation;
|
|
1487
|
-
/**
|
|
1488
|
-
* A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy.
|
|
1489
|
-
* For example, to get the number of reservations by party size for each week, first perform a date histogram aggregation on `details.startDate` with the interval `WEEK`, and a second value aggregation on `details.partySize`.
|
|
1490
|
-
*/
|
|
1491
|
-
nested?: NestedAggregation;
|
|
1492
|
-
}
|
|
1493
|
-
interface RangeBucket {
|
|
1494
|
-
/** Inclusive lower bound of the range. Required if `to` is not provided. */
|
|
1495
|
-
from?: number | null;
|
|
1496
|
-
/** Exclusive upper bound of the range. Required if `from` is not provided. */
|
|
1497
|
-
to?: number | null;
|
|
1498
|
-
}
|
|
1499
|
-
declare enum SortType {
|
|
1500
|
-
/** Sort by number of matches. */
|
|
1501
|
-
COUNT = "COUNT",
|
|
1502
|
-
/** Sort by value of the field alphabetically. */
|
|
1503
|
-
VALUE = "VALUE"
|
|
1504
|
-
}
|
|
1505
|
-
declare enum SortDirection {
|
|
1506
|
-
/** Sort in descending order. */
|
|
1507
|
-
DESC = "DESC",
|
|
1508
|
-
/** Sort in ascending order. */
|
|
1509
|
-
ASC = "ASC"
|
|
1510
|
-
}
|
|
1511
|
-
declare enum MissingValues {
|
|
1512
|
-
/** Exclude missing values from the aggregation results */
|
|
1513
|
-
EXCLUDE = "EXCLUDE",
|
|
1514
|
-
/** Include missing values in the aggregation results */
|
|
1515
|
-
INCLUDE = "INCLUDE"
|
|
1516
|
-
}
|
|
1517
|
-
interface IncludeMissingValuesOptions {
|
|
1518
|
-
/** Specify a custom name for the bucket containing the missing values. Defaults are "N/A" for strings, "0" for integers, and "false" for booleans. */
|
|
1519
|
-
addToBucket?: string;
|
|
1520
|
-
}
|
|
1521
|
-
declare enum ScalarType {
|
|
1522
|
-
/** Undefined scalar type. */
|
|
1523
|
-
UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
|
|
1524
|
-
/** Count of distinct values. */
|
|
1525
|
-
COUNT_DISTINCT = "COUNT_DISTINCT",
|
|
1526
|
-
/** Minimum value. */
|
|
1527
|
-
MIN = "MIN",
|
|
1528
|
-
/** Maximum value. */
|
|
1529
|
-
MAX = "MAX"
|
|
1530
|
-
}
|
|
1531
|
-
declare enum NestedAggregationType {
|
|
1532
|
-
/** Undefined aggregation type. */
|
|
1533
|
-
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
1534
|
-
/** An aggregation where result buckets are dynamically built - one per unique value. */
|
|
1535
|
-
VALUE = "VALUE",
|
|
1536
|
-
/** An aggregation where you can define a set of ranges - each representing a bucket. */
|
|
1537
|
-
RANGE = "RANGE",
|
|
1538
|
-
/** A single-value metric aggregation - such as min, max, sum, and avg. */
|
|
1539
|
-
SCALAR = "SCALAR",
|
|
1540
|
-
/** An aggregation where result buckets are dynamically built - one per time interval such as hour, day, or week. */
|
|
1541
|
-
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
1542
|
-
}
|
|
1543
|
-
interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
1544
|
-
/** Options for including missing values in results. */
|
|
1545
|
-
includeOptions?: IncludeMissingValuesOptions;
|
|
1546
|
-
/** Whether to sort by the number of matches or the value of the field. */
|
|
1547
|
-
sortType?: SortType;
|
|
1548
|
-
/** Whether to sort in ascending or descending order. */
|
|
1549
|
-
sortDirection?: SortDirection;
|
|
1550
|
-
/**
|
|
1551
|
-
* Number of aggregation results to return.
|
|
1552
|
-
* Min: `1`
|
|
1553
|
-
* Max: `250`
|
|
1554
|
-
* Default: `10`
|
|
1555
|
-
*/
|
|
1556
|
-
limit?: number | null;
|
|
1557
|
-
/**
|
|
1558
|
-
* Whether missing values should be included or excluded from the aggregation results.
|
|
1559
|
-
* Default: `EXCLUDE`.
|
|
1560
|
-
*/
|
|
1561
|
-
missingValues?: MissingValues;
|
|
1562
|
-
}
|
|
1563
|
-
/** @oneof */
|
|
1564
|
-
interface ValueAggregationOptionsOneOf {
|
|
1565
|
-
/** Options for including missing values in results. */
|
|
1566
|
-
includeOptions?: IncludeMissingValuesOptions;
|
|
1567
|
-
}
|
|
1568
|
-
interface RangeAggregation {
|
|
1569
|
-
/** List of range buckets. During aggregation each entity will be placed in the first bucket its value falls into based on the provided range bounds. */
|
|
1570
|
-
buckets?: RangeBucket[];
|
|
1571
|
-
}
|
|
1572
|
-
interface ScalarAggregation {
|
|
1573
|
-
/** Operation type for the scalar aggregation. */
|
|
1574
|
-
type?: ScalarType;
|
|
1575
|
-
}
|
|
1576
|
-
interface DateHistogramAggregation {
|
|
1577
|
-
/** Interval for date histogram aggregation. */
|
|
1578
|
-
interval?: Interval;
|
|
1579
|
-
}
|
|
1580
|
-
declare enum Interval {
|
|
1581
|
-
UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
|
|
1582
|
-
YEAR = "YEAR",
|
|
1583
|
-
MONTH = "MONTH",
|
|
1584
|
-
WEEK = "WEEK",
|
|
1585
|
-
DAY = "DAY",
|
|
1586
|
-
HOUR = "HOUR",
|
|
1587
|
-
MINUTE = "MINUTE",
|
|
1588
|
-
SECOND = "SECOND"
|
|
1589
|
-
}
|
|
1590
|
-
interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
1591
|
-
/** A value aggregation calculates metrics such as "count" for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of reservations (count) of each status that have been made on the site. */
|
|
1592
|
-
value?: ValueAggregation;
|
|
1593
|
-
/** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
|
|
1594
|
-
range?: RangeAggregation;
|
|
1595
|
-
/** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the average part size of reservations made on a site. */
|
|
1596
|
-
scalar?: ScalarAggregation;
|
|
1597
|
-
/** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
|
|
1598
|
-
dateHistogram?: DateHistogramAggregation;
|
|
1599
|
-
/** Aggregation name displayed in the return. */
|
|
1600
|
-
name?: string | null;
|
|
1601
|
-
/** Type of aggregation to perform. */
|
|
1602
|
-
type?: NestedAggregationType;
|
|
1603
|
-
/** Field to aggregate by. */
|
|
1604
|
-
fieldPath?: string;
|
|
1605
|
-
}
|
|
1606
|
-
/** @oneof */
|
|
1607
|
-
interface NestedAggregationItemKindOneOf {
|
|
1608
|
-
/** A value aggregation calculates metrics such as "count" for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of reservations (count) of each status that have been made on the site. */
|
|
1609
|
-
value?: ValueAggregation;
|
|
1610
|
-
/** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
|
|
1611
|
-
range?: RangeAggregation;
|
|
1612
|
-
/** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the average part size of reservations made on a site. */
|
|
1613
|
-
scalar?: ScalarAggregation;
|
|
1614
|
-
/** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
|
|
1615
|
-
dateHistogram?: DateHistogramAggregation;
|
|
1616
|
-
}
|
|
1617
|
-
declare enum AggregationType {
|
|
1618
|
-
/** Undefined aggregation type. */
|
|
1619
|
-
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
1620
|
-
/** An aggregation where result buckets are dynamically built - one per unique value. */
|
|
1621
|
-
VALUE = "VALUE",
|
|
1622
|
-
/** An aggregation where you can define a set of ranges - each representing a bucket. */
|
|
1623
|
-
RANGE = "RANGE",
|
|
1624
|
-
/** A single-value metric aggregation - such as min, max, sum, or avg. */
|
|
1625
|
-
SCALAR = "SCALAR",
|
|
1626
|
-
/** An aggregation where result buckets are dynamically built - one per time interval such as hour, day, or week. */
|
|
1627
|
-
DATE_HISTOGRAM = "DATE_HISTOGRAM",
|
|
1628
|
-
/** Multi-level aggregation, where each next aggregation is nested within the previous one. */
|
|
1629
|
-
NESTED = "NESTED"
|
|
1630
|
-
}
|
|
1631
|
-
interface NestedAggregation {
|
|
1632
|
-
/** Flattened list of aggregations, where each aggregation is nested within the previous one. */
|
|
1633
|
-
nestedAggregations?: NestedAggregationItem[];
|
|
1634
|
-
}
|
|
1635
|
-
interface SearchDetails {
|
|
1636
|
-
/** Boolean search mode. Defines how separate search terms in the `expression` are combined. */
|
|
1637
|
-
mode?: Mode;
|
|
1638
|
-
/** Search term or expression. */
|
|
1639
|
-
expression?: string | null;
|
|
1640
|
-
/**
|
|
1641
|
-
* Fields to search in.
|
|
1642
|
-
*
|
|
1643
|
-
* Searchable fields are `reservee.firstName`, `reservee.lastName`, `reservee.phone`, and `reservee.email`.
|
|
1644
|
-
*
|
|
1645
|
-
* If the array is empty, all fields are searched.
|
|
1646
|
-
*/
|
|
1647
|
-
fields?: string[];
|
|
1648
|
-
/**
|
|
1649
|
-
* Whether to allow the search function to automatically correct typos or minor mistakes in the search expression.
|
|
1650
|
-
* The search function uses an algorithm to find results that are close to what the site visitor typed.
|
|
1651
|
-
*/
|
|
1652
|
-
fuzzy?: boolean;
|
|
1653
|
-
}
|
|
1654
|
-
declare enum Mode {
|
|
1655
|
-
/** Returns instances where any terms in the expression occur. */
|
|
1656
|
-
OR = "OR",
|
|
1657
|
-
/** Returns instances where all the terms in the expression occur. */
|
|
1658
|
-
AND = "AND"
|
|
1659
|
-
}
|
|
1660
|
-
interface SearchReservationsResponse {
|
|
1661
|
-
/** List of Reservations. */
|
|
1662
|
-
reservations?: Reservation[];
|
|
1663
|
-
/** Cursor paging metadata. */
|
|
1664
|
-
pagingMetadata?: CursorPagingMetadata$2;
|
|
1665
|
-
/** Aggregation data. */
|
|
1666
|
-
aggregationData?: AggregationData;
|
|
1667
|
-
}
|
|
1668
|
-
interface AggregationData {
|
|
1669
|
-
/** List of the aggregated data results. */
|
|
1670
|
-
results?: AggregationResults[];
|
|
1671
|
-
}
|
|
1672
|
-
interface ValueAggregationResult {
|
|
1673
|
-
/** Value of the field */
|
|
1674
|
-
value?: string;
|
|
1675
|
-
/** Count of entities with this value */
|
|
1676
|
-
count?: number;
|
|
1677
|
-
}
|
|
1678
|
-
interface RangeAggregationResult {
|
|
1679
|
-
/** Inclusive lower bound of the range. */
|
|
1680
|
-
from?: number | null;
|
|
1681
|
-
/** Exclusive upper bound of the range. */
|
|
1682
|
-
to?: number | null;
|
|
1683
|
-
/** Count of entities in the range. */
|
|
1684
|
-
count?: number;
|
|
1685
|
-
}
|
|
1686
|
-
interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
|
|
1687
|
-
/** List of the value aggregation results. */
|
|
1688
|
-
values?: ValueResults;
|
|
1689
|
-
/** List of the range aggregation results. */
|
|
1690
|
-
ranges?: RangeResults;
|
|
1691
|
-
/** List of the scalar aggregation results. */
|
|
1692
|
-
scalar?: AggregationResultsScalarResult;
|
|
1693
|
-
/** Aggregation name defined in the request. */
|
|
1694
|
-
name?: string;
|
|
1695
|
-
/** Type of aggregation performed. */
|
|
1696
|
-
type?: AggregationType;
|
|
1697
|
-
/** Field the data was aggregated by. */
|
|
1698
|
-
fieldPath?: string;
|
|
1699
|
-
}
|
|
1700
|
-
/** @oneof */
|
|
1701
|
-
interface NestedAggregationResultsResultOneOf {
|
|
1702
|
-
/** List of the value aggregation results. */
|
|
1703
|
-
values?: ValueResults;
|
|
1704
|
-
/** List of the range aggregation results. */
|
|
1705
|
-
ranges?: RangeResults;
|
|
1706
|
-
/** List of the scalar aggregation results. */
|
|
1707
|
-
scalar?: AggregationResultsScalarResult;
|
|
1708
|
-
}
|
|
1709
|
-
interface ValueResults {
|
|
1710
|
-
/** List of value aggregations. */
|
|
1711
|
-
results?: ValueAggregationResult[];
|
|
1712
|
-
}
|
|
1713
|
-
interface RangeResults {
|
|
1714
|
-
/** List of ranges returned in same order as requested. */
|
|
1715
|
-
results?: RangeAggregationResult[];
|
|
1716
|
-
}
|
|
1717
|
-
interface AggregationResultsScalarResult {
|
|
1718
|
-
/** Type of scalar aggregation. */
|
|
1719
|
-
type?: ScalarType;
|
|
1720
|
-
/** Value of the scalar aggregation. */
|
|
1721
|
-
value?: number;
|
|
1722
|
-
}
|
|
1723
|
-
interface NestedValueAggregationResult {
|
|
1724
|
-
value?: string;
|
|
1725
|
-
nestedResults?: NestedAggregationResults;
|
|
1726
|
-
}
|
|
1727
|
-
interface ValueResult {
|
|
1728
|
-
/** Value of the field. */
|
|
1729
|
-
value?: string;
|
|
1730
|
-
/** Count of entities with this value. */
|
|
1731
|
-
count?: number | null;
|
|
1732
|
-
}
|
|
1733
|
-
interface RangeResult {
|
|
1734
|
-
/** Inclusive lower bound of the range. */
|
|
1735
|
-
from?: number | null;
|
|
1736
|
-
/** Exclusive upper bound of the range. */
|
|
1737
|
-
to?: number | null;
|
|
1738
|
-
/** Count of entities in the range. */
|
|
1739
|
-
count?: number | null;
|
|
1740
|
-
}
|
|
1741
|
-
interface ScalarResult {
|
|
1742
|
-
/** Scalar aggregation results. */
|
|
1743
|
-
value?: number;
|
|
1744
|
-
}
|
|
1745
|
-
interface NestedResultValue extends NestedResultValueResultOneOf {
|
|
1746
|
-
/** Value aggregation results. */
|
|
1747
|
-
value?: ValueResult;
|
|
1748
|
-
/** Range aggregation results. */
|
|
1749
|
-
range?: RangeResult;
|
|
1750
|
-
/** Scalar aggregation results. */
|
|
1751
|
-
scalar?: ScalarResult;
|
|
1752
|
-
/** Date histogram aggregation results. */
|
|
1753
|
-
dateHistogram?: ValueResult;
|
|
1754
|
-
}
|
|
1755
|
-
/** @oneof */
|
|
1756
|
-
interface NestedResultValueResultOneOf {
|
|
1757
|
-
/** Value aggregation results. */
|
|
1758
|
-
value?: ValueResult;
|
|
1759
|
-
/** Range aggregation results. */
|
|
1760
|
-
range?: RangeResult;
|
|
1761
|
-
/** Scalar aggregation results. */
|
|
1762
|
-
scalar?: ScalarResult;
|
|
1763
|
-
/** Date histogram aggregation results. */
|
|
1764
|
-
dateHistogram?: ValueResult;
|
|
1765
|
-
}
|
|
1766
|
-
interface Results {
|
|
1767
|
-
/** List of nested aggregation results. */
|
|
1768
|
-
results?: Record<string, NestedResultValue>;
|
|
1769
|
-
}
|
|
1770
|
-
interface DateHistogramResult {
|
|
1771
|
-
/** Date in ISO 8601 format. */
|
|
1772
|
-
value?: string;
|
|
1773
|
-
/** Count of entities in the interval. */
|
|
1774
|
-
count?: number;
|
|
1775
|
-
}
|
|
1776
|
-
/** deprecated */
|
|
1777
|
-
interface GroupByValueResults {
|
|
1778
|
-
results?: NestedValueAggregationResult[];
|
|
1779
|
-
}
|
|
1780
|
-
interface DateHistogramResults {
|
|
1781
|
-
/** List of date histogram aggregations. */
|
|
1782
|
-
results?: DateHistogramResult[];
|
|
1783
|
-
}
|
|
1784
|
-
/**
|
|
1785
|
-
* Results of `NESTED` aggregation type in a flattened form.
|
|
1786
|
-
* Aggregations in the resulting array are keyed by the requested aggregation `name`.
|
|
1787
|
-
*/
|
|
1788
|
-
interface NestedResults {
|
|
1789
|
-
/** List of nested aggregation results. */
|
|
1790
|
-
results?: Results[];
|
|
1791
|
-
}
|
|
1792
|
-
interface AggregationResults extends AggregationResultsResultOneOf {
|
|
1793
|
-
/** Value aggregation results. */
|
|
1794
|
-
values?: ValueResults;
|
|
1795
|
-
/** Range aggregation results. */
|
|
1796
|
-
ranges?: RangeResults;
|
|
1797
|
-
/** Scalar aggregation results. */
|
|
1798
|
-
scalar?: AggregationResultsScalarResult;
|
|
1799
|
-
/** deprecated */
|
|
1800
|
-
groupedByValue?: GroupByValueResults;
|
|
1801
|
-
/** Date histogram aggregation results. */
|
|
1802
|
-
dateHistogram?: DateHistogramResults;
|
|
1803
|
-
/** Nested aggregation results. */
|
|
1804
|
-
nested?: NestedResults;
|
|
1805
|
-
/** Aggregation name defined in the request. */
|
|
1806
|
-
name?: string;
|
|
1807
|
-
/** Type of aggregation that was performed. */
|
|
1808
|
-
type?: AggregationType;
|
|
1809
|
-
/** Field the data was aggregated by. */
|
|
1810
|
-
fieldPath?: string;
|
|
1811
|
-
}
|
|
1812
|
-
/** @oneof */
|
|
1813
|
-
interface AggregationResultsResultOneOf {
|
|
1814
|
-
/** Value aggregation results. */
|
|
1815
|
-
values?: ValueResults;
|
|
1816
|
-
/** Range aggregation results. */
|
|
1817
|
-
ranges?: RangeResults;
|
|
1818
|
-
/** Scalar aggregation results. */
|
|
1819
|
-
scalar?: AggregationResultsScalarResult;
|
|
1820
|
-
/** deprecated */
|
|
1821
|
-
groupedByValue?: GroupByValueResults;
|
|
1822
|
-
/** Date histogram aggregation results. */
|
|
1823
|
-
dateHistogram?: DateHistogramResults;
|
|
1824
|
-
/** Nested aggregation results. */
|
|
1825
|
-
nested?: NestedResults;
|
|
1826
|
-
}
|
|
1827
|
-
interface TablesNonNullableFields {
|
|
1828
|
-
ids: string[];
|
|
1829
|
-
}
|
|
1830
|
-
interface DetailsNonNullableFields {
|
|
1831
|
-
tables?: TablesNonNullableFields;
|
|
1832
|
-
}
|
|
1833
|
-
interface TableWithReservationConflictsNonNullableFields {
|
|
1834
|
-
tableId: string;
|
|
1835
|
-
reservationIds: string[];
|
|
1836
|
-
}
|
|
1837
|
-
interface ReservationNonNullableFields {
|
|
1838
|
-
status: Status$2;
|
|
1839
|
-
source: Source;
|
|
1840
|
-
details?: DetailsNonNullableFields;
|
|
1841
|
-
tablesWithReservationConflicts: TableWithReservationConflictsNonNullableFields[];
|
|
1842
|
-
paymentStatus: PaymentStatus;
|
|
1843
|
-
}
|
|
1844
|
-
interface CreateReservationResponseNonNullableFields {
|
|
1845
|
-
reservation?: ReservationNonNullableFields;
|
|
1846
|
-
}
|
|
1847
|
-
interface GetReservationResponseNonNullableFields {
|
|
1848
|
-
reservation?: ReservationNonNullableFields;
|
|
1849
|
-
}
|
|
1850
|
-
interface UpdateReservationResponseNonNullableFields {
|
|
1851
|
-
reservation?: ReservationNonNullableFields;
|
|
1852
|
-
}
|
|
1853
|
-
interface UpdateExtendedFieldsResponseNonNullableFields$2 {
|
|
1854
|
-
reservation?: ReservationNonNullableFields;
|
|
1855
|
-
}
|
|
1856
|
-
interface CreateHeldReservationResponseNonNullableFields {
|
|
1857
|
-
reservation?: ReservationNonNullableFields;
|
|
1858
|
-
}
|
|
1859
|
-
interface ReserveReservationResponseNonNullableFields {
|
|
1860
|
-
reservation?: ReservationNonNullableFields;
|
|
1861
|
-
}
|
|
1862
|
-
interface CancelReservationResponseNonNullableFields {
|
|
1863
|
-
reservation?: ReservationNonNullableFields;
|
|
1864
|
-
}
|
|
1865
|
-
interface ListReservationsResponseNonNullableFields {
|
|
1866
|
-
reservations: ReservationNonNullableFields[];
|
|
1867
|
-
}
|
|
1868
|
-
interface QueryReservationsResponseNonNullableFields {
|
|
1869
|
-
reservations: ReservationNonNullableFields[];
|
|
1870
|
-
}
|
|
1871
|
-
interface ValueAggregationResultNonNullableFields {
|
|
1872
|
-
value: string;
|
|
1873
|
-
count: number;
|
|
1874
|
-
}
|
|
1875
|
-
interface ValueResultsNonNullableFields {
|
|
1876
|
-
results: ValueAggregationResultNonNullableFields[];
|
|
1877
|
-
}
|
|
1878
|
-
interface RangeAggregationResultNonNullableFields {
|
|
1879
|
-
count: number;
|
|
1880
|
-
}
|
|
1881
|
-
interface RangeResultsNonNullableFields {
|
|
1882
|
-
results: RangeAggregationResultNonNullableFields[];
|
|
1883
|
-
}
|
|
1884
|
-
interface AggregationResultsScalarResultNonNullableFields {
|
|
1885
|
-
type: ScalarType;
|
|
1886
|
-
value: number;
|
|
1887
|
-
}
|
|
1888
|
-
interface NestedAggregationResultsNonNullableFields {
|
|
1889
|
-
values?: ValueResultsNonNullableFields;
|
|
1890
|
-
ranges?: RangeResultsNonNullableFields;
|
|
1891
|
-
scalar?: AggregationResultsScalarResultNonNullableFields;
|
|
1892
|
-
name: string;
|
|
1893
|
-
type: AggregationType;
|
|
1894
|
-
fieldPath: string;
|
|
1895
|
-
}
|
|
1896
|
-
interface NestedValueAggregationResultNonNullableFields {
|
|
1897
|
-
value: string;
|
|
1898
|
-
nestedResults?: NestedAggregationResultsNonNullableFields;
|
|
1899
|
-
}
|
|
1900
|
-
interface GroupByValueResultsNonNullableFields {
|
|
1901
|
-
results: NestedValueAggregationResultNonNullableFields[];
|
|
1902
|
-
}
|
|
1903
|
-
interface DateHistogramResultNonNullableFields {
|
|
1904
|
-
value: string;
|
|
1905
|
-
count: number;
|
|
1906
|
-
}
|
|
1907
|
-
interface DateHistogramResultsNonNullableFields {
|
|
1908
|
-
results: DateHistogramResultNonNullableFields[];
|
|
1909
|
-
}
|
|
1910
|
-
interface AggregationResultsNonNullableFields {
|
|
1911
|
-
values?: ValueResultsNonNullableFields;
|
|
1912
|
-
ranges?: RangeResultsNonNullableFields;
|
|
1913
|
-
scalar?: AggregationResultsScalarResultNonNullableFields;
|
|
1914
|
-
groupedByValue?: GroupByValueResultsNonNullableFields;
|
|
1915
|
-
dateHistogram?: DateHistogramResultsNonNullableFields;
|
|
1916
|
-
name: string;
|
|
1917
|
-
type: AggregationType;
|
|
1918
|
-
fieldPath: string;
|
|
1919
|
-
}
|
|
1920
|
-
interface AggregationDataNonNullableFields {
|
|
1921
|
-
results: AggregationResultsNonNullableFields[];
|
|
1922
|
-
}
|
|
1923
|
-
interface SearchReservationsResponseNonNullableFields {
|
|
1924
|
-
reservations: ReservationNonNullableFields[];
|
|
1925
|
-
aggregationData?: AggregationDataNonNullableFields;
|
|
1926
|
-
}
|
|
1927
|
-
|
|
1928
|
-
type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
1929
|
-
getUrl: (context: any) => string;
|
|
1930
|
-
httpMethod: K;
|
|
1931
|
-
path: string;
|
|
1932
|
-
pathParams: M;
|
|
1933
|
-
__requestType: T;
|
|
1934
|
-
__originalRequestType: S;
|
|
1935
|
-
__responseType: Q;
|
|
1936
|
-
__originalResponseType: R;
|
|
1937
|
-
};
|
|
1938
|
-
declare function createReservation(): __PublicMethodMetaInfo$2<'POST', {}, CreateReservationRequest, CreateReservationRequest$1, CreateReservationResponse & CreateReservationResponseNonNullableFields, CreateReservationResponse$1 & CreateReservationResponseNonNullableFields$1>;
|
|
1939
|
-
declare function getReservation(): __PublicMethodMetaInfo$2<'GET', {
|
|
1940
|
-
reservationId: string;
|
|
1941
|
-
}, GetReservationRequest, GetReservationRequest$1, GetReservationResponse & GetReservationResponseNonNullableFields, GetReservationResponse$1 & GetReservationResponseNonNullableFields$1>;
|
|
1942
|
-
declare function updateReservation(): __PublicMethodMetaInfo$2<'PATCH', {
|
|
1943
|
-
reservationId: string;
|
|
1944
|
-
}, UpdateReservationRequest, UpdateReservationRequest$1, UpdateReservationResponse & UpdateReservationResponseNonNullableFields, UpdateReservationResponse$1 & UpdateReservationResponseNonNullableFields$1>;
|
|
1945
|
-
declare function updateExtendedFields$1(): __PublicMethodMetaInfo$2<'POST', {
|
|
1946
|
-
id: string;
|
|
1947
|
-
}, UpdateExtendedFieldsRequest$2, UpdateExtendedFieldsRequest$3, UpdateExtendedFieldsResponse$2 & UpdateExtendedFieldsResponseNonNullableFields$2, UpdateExtendedFieldsResponse$3 & UpdateExtendedFieldsResponseNonNullableFields$3>;
|
|
1948
|
-
declare function createHeldReservation(): __PublicMethodMetaInfo$2<'POST', {}, CreateHeldReservationRequest, CreateHeldReservationRequest$1, CreateHeldReservationResponse & CreateHeldReservationResponseNonNullableFields, CreateHeldReservationResponse$1 & CreateHeldReservationResponseNonNullableFields$1>;
|
|
1949
|
-
declare function reserveReservation(): __PublicMethodMetaInfo$2<'POST', {
|
|
1950
|
-
reservationId: string;
|
|
1951
|
-
}, ReserveReservationRequest, ReserveReservationRequest$1, ReserveReservationResponse & ReserveReservationResponseNonNullableFields, ReserveReservationResponse$1 & ReserveReservationResponseNonNullableFields$1>;
|
|
1952
|
-
declare function cancelReservation(): __PublicMethodMetaInfo$2<'POST', {
|
|
1953
|
-
reservationId: string;
|
|
1954
|
-
}, CancelReservationRequest, CancelReservationRequest$1, CancelReservationResponse & CancelReservationResponseNonNullableFields, CancelReservationResponse$1 & CancelReservationResponseNonNullableFields$1>;
|
|
1955
|
-
declare function deleteReservation(): __PublicMethodMetaInfo$2<'DELETE', {
|
|
1956
|
-
reservationId: string;
|
|
1957
|
-
}, DeleteReservationRequest, DeleteReservationRequest$1, DeleteReservationResponse, DeleteReservationResponse$1>;
|
|
1958
|
-
declare function listReservations(): __PublicMethodMetaInfo$2<'GET', {}, ListReservationsRequest, ListReservationsRequest$1, ListReservationsResponse & ListReservationsResponseNonNullableFields, ListReservationsResponse$1 & ListReservationsResponseNonNullableFields$1>;
|
|
1959
|
-
declare function queryReservations(): __PublicMethodMetaInfo$2<'POST', {}, QueryReservationsRequest, QueryReservationsRequest$1, QueryReservationsResponse & QueryReservationsResponseNonNullableFields, QueryReservationsResponse$1 & QueryReservationsResponseNonNullableFields$1>;
|
|
1960
|
-
declare function searchReservations(): __PublicMethodMetaInfo$2<'POST', {}, SearchReservationsRequest, SearchReservationsRequest$1, SearchReservationsResponse & SearchReservationsResponseNonNullableFields, SearchReservationsResponse$1 & SearchReservationsResponseNonNullableFields$1>;
|
|
1961
|
-
|
|
1962
|
-
declare const meta$2_cancelReservation: typeof cancelReservation;
|
|
1963
|
-
declare const meta$2_createHeldReservation: typeof createHeldReservation;
|
|
1964
|
-
declare const meta$2_createReservation: typeof createReservation;
|
|
1965
|
-
declare const meta$2_deleteReservation: typeof deleteReservation;
|
|
1966
|
-
declare const meta$2_getReservation: typeof getReservation;
|
|
1967
|
-
declare const meta$2_listReservations: typeof listReservations;
|
|
1968
|
-
declare const meta$2_queryReservations: typeof queryReservations;
|
|
1969
|
-
declare const meta$2_reserveReservation: typeof reserveReservation;
|
|
1970
|
-
declare const meta$2_searchReservations: typeof searchReservations;
|
|
1971
|
-
declare const meta$2_updateReservation: typeof updateReservation;
|
|
1972
|
-
declare namespace meta$2 {
|
|
1973
|
-
export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_cancelReservation as cancelReservation, meta$2_createHeldReservation as createHeldReservation, meta$2_createReservation as createReservation, meta$2_deleteReservation as deleteReservation, meta$2_getReservation as getReservation, meta$2_listReservations as listReservations, meta$2_queryReservations as queryReservations, meta$2_reserveReservation as reserveReservation, meta$2_searchReservations as searchReservations, updateExtendedFields$1 as updateExtendedFields, meta$2_updateReservation as updateReservation };
|
|
1974
|
-
}
|
|
1975
|
-
|
|
1976
|
-
interface ReservationLocation$1 {
|
|
1977
|
-
/**
|
|
1978
|
-
* Reservation location ID.
|
|
1979
|
-
* @readonly
|
|
1980
|
-
*/
|
|
1981
|
-
id?: string | null;
|
|
1982
|
-
/** Represents the current state of a reservation location. Each time the reservation location is modified, its `revision` changes. For an update operation to succeed, you must specify the latest revision. */
|
|
1983
|
-
revision?: string | null;
|
|
1984
|
-
/**
|
|
1985
|
-
* The date and time this reservation location was created.
|
|
1986
|
-
* @readonly
|
|
1987
|
-
*/
|
|
1988
|
-
createdDate?: Date | null;
|
|
1989
|
-
/**
|
|
1990
|
-
* The date and time this reservation location was last updated.
|
|
1991
|
-
* @readonly
|
|
1992
|
-
*/
|
|
1993
|
-
updatedDate?: Date | null;
|
|
1994
|
-
/**
|
|
1995
|
-
* Physical location details.
|
|
1996
|
-
*
|
|
1997
|
-
* Locations can be created and configured using the Locations API.
|
|
1998
|
-
* or on the [Business Info](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fsettings/business-info) page in the Dashboard.
|
|
1999
|
-
* @readonly
|
|
2000
|
-
*/
|
|
2001
|
-
location?: Location$1;
|
|
2002
|
-
/** Reservation location configuration. */
|
|
2003
|
-
configuration?: Configuration$1;
|
|
2004
|
-
/**
|
|
2005
|
-
* Whether this reservation location's `location` is the default location of the business.
|
|
2006
|
-
* @readonly
|
|
2007
|
-
*/
|
|
2008
|
-
default?: boolean | null;
|
|
2009
|
-
/**
|
|
2010
|
-
* Whether this reservation location's `location` is archived.
|
|
2011
|
-
* @readonly
|
|
2012
|
-
*/
|
|
2013
|
-
archived?: boolean | null;
|
|
2014
|
-
/**
|
|
2015
|
-
* Custom field data for the reservation location object.
|
|
2016
|
-
*
|
|
2017
|
-
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
2018
|
-
*/
|
|
2019
|
-
extendedFields?: ExtendedFields$1;
|
|
2020
|
-
}
|
|
2021
|
-
/**
|
|
2022
|
-
* Time periods that this location is open for business. Includes a collection of TimePeriod instances.
|
|
2023
|
-
* Aligned with https://developers.google.com/my-business/reference/rest/v4/accounts.locations#businesshours
|
|
2024
|
-
* With a few minor adjustments
|
|
2025
|
-
*/
|
|
2026
|
-
interface CommonBusinessSchedule$1 {
|
|
2027
|
-
periods?: CommonTimePeriod$1[];
|
|
2028
|
-
/**
|
|
2029
|
-
* Time periods during which this location is open. Each period represents a range of hours during the week during which the location is
|
|
2030
|
-
* open.
|
|
2031
|
-
*
|
|
2032
|
-
* Max: 100 time periods
|
|
2033
|
-
*/
|
|
2034
|
-
specialHourPeriod?: CommonSpecialHourPeriod$1[];
|
|
2035
|
-
}
|
|
2036
|
-
/**
|
|
2037
|
-
* A span of time that the business is open,
|
|
2038
|
-
* starting on the specified open day/time and closing on the specified close day/time.
|
|
2039
|
-
* Closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
|
|
2040
|
-
*/
|
|
2041
|
-
interface CommonTimePeriod$1 {
|
|
2042
|
-
/** Day of the week this period starts on. */
|
|
2043
|
-
openDay?: CommonDayOfWeek$1;
|
|
2044
|
-
/**
|
|
2045
|
-
* Time this period starts in 24hr [ISO 8601](http://www.w3.org/TR/NOTE-datetime) extended format (hh:mm). Valid values are `00:00-24:00`, where `24:00` represents
|
|
2046
|
-
* midnight at the end of the specified day field.
|
|
2047
|
-
*/
|
|
2048
|
-
openTime?: string;
|
|
2049
|
-
/** Day of the week this period ends on. */
|
|
2050
|
-
closeDay?: CommonDayOfWeek$1;
|
|
2051
|
-
/**
|
|
2052
|
-
* Time this period ends in 24hr [ISO 8601](http://www.w3.org/TR/NOTE-datetime) extended format (hh:mm). Valid values are `00:00-24:00`, where `24:00` represents
|
|
2053
|
-
* midnight at the end of the specified day field.
|
|
2054
|
-
*
|
|
2055
|
-
* This is the last time a reservation can be made at the restaurant, not the time the restaurant closes its doors.
|
|
2056
|
-
*/
|
|
2057
|
-
closeTime?: string;
|
|
2058
|
-
}
|
|
2059
|
-
/** Enumerates the days of the week. */
|
|
2060
|
-
declare enum CommonDayOfWeek$1 {
|
|
2061
|
-
MONDAY = "MONDAY",
|
|
2062
|
-
TUESDAY = "TUESDAY",
|
|
2063
|
-
WEDNESDAY = "WEDNESDAY",
|
|
2064
|
-
THURSDAY = "THURSDAY",
|
|
2065
|
-
FRIDAY = "FRIDAY",
|
|
2066
|
-
SATURDAY = "SATURDAY",
|
|
2067
|
-
SUNDAY = "SUNDAY"
|
|
2068
|
-
}
|
|
2069
|
-
/** Set of time periods when a location's operational hours differ from its normal business hours. */
|
|
2070
|
-
interface CommonSpecialHourPeriod$1 {
|
|
2071
|
-
/** Start date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. */
|
|
2072
|
-
startDate?: string;
|
|
2073
|
-
/** End date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. */
|
|
2074
|
-
endDate?: string;
|
|
2075
|
-
/** Whether or not the location is closed during this period. */
|
|
2076
|
-
isClosed?: boolean;
|
|
2077
|
-
/** Additional details about the period. */
|
|
2078
|
-
comment?: string;
|
|
2079
|
-
}
|
|
2080
|
-
declare enum Value$1 {
|
|
2081
|
-
UNKNOWN = "UNKNOWN",
|
|
2082
|
-
ON = "ON",
|
|
2083
|
-
IN_HOUSE_ONLY = "IN_HOUSE_ONLY",
|
|
2084
|
-
OFF = "OFF"
|
|
2085
|
-
}
|
|
2086
|
-
interface TableDefinition$1 {
|
|
2087
|
-
/**
|
|
2088
|
-
* Table ID.
|
|
2089
|
-
* @readonly
|
|
2090
|
-
*/
|
|
2091
|
-
id?: string | null;
|
|
2092
|
-
/** Table name. */
|
|
2093
|
-
name?: string;
|
|
2094
|
-
/** Minimum number of seats. */
|
|
2095
|
-
seatsMin?: number;
|
|
2096
|
-
/** Maximum number of seats. */
|
|
2097
|
-
seatsMax?: number;
|
|
2098
|
-
/** Whether the table is active (available to be reserved). */
|
|
2099
|
-
isActive?: boolean | null;
|
|
2100
|
-
}
|
|
2101
|
-
interface TableCombination$1 {
|
|
2102
|
-
/**
|
|
2103
|
-
* Table combination ID.
|
|
2104
|
-
* @readonly
|
|
2105
|
-
*/
|
|
2106
|
-
id?: string | null;
|
|
2107
|
-
/** IDs of tables in the combination. */
|
|
2108
|
-
tableIds?: string[] | null;
|
|
2109
|
-
/** Minimum number of seats that can be reserved in this table combination. */
|
|
2110
|
-
seatsMin?: number;
|
|
2111
|
-
/** Maximum number of seats that can be reserved in this table combination. */
|
|
2112
|
-
seatsMax?: number;
|
|
2113
|
-
/** Whether the table combination is active (available to be reserved). */
|
|
2114
|
-
isActive?: boolean | null;
|
|
2115
|
-
}
|
|
2116
|
-
declare enum Unit$1 {
|
|
2117
|
-
UNKNOWN = "UNKNOWN",
|
|
2118
|
-
MINUTES = "MINUTES",
|
|
2119
|
-
HOURS = "HOURS",
|
|
2120
|
-
DAYS = "DAYS"
|
|
2121
|
-
}
|
|
2122
|
-
declare enum ApprovalMode$1 {
|
|
2123
|
-
UNKNOWN = "UNKNOWN",
|
|
2124
|
-
AUTOMATIC = "AUTOMATIC",
|
|
2125
|
-
MANUAL = "MANUAL",
|
|
2126
|
-
MANUAL_FOR_LARGE_PARTIES = "MANUAL_FOR_LARGE_PARTIES"
|
|
2127
|
-
}
|
|
2128
|
-
/**
|
|
2129
|
-
* Seat pacing.
|
|
2130
|
-
* The maximum number of seats that can be filled by new reservations within a 15-minute period.
|
|
2131
|
-
* For example, setting a seat pacing of 15 would mean that between `10:00.000`-`10:14.999` there will be no more than 15 new seats available for reservation.
|
|
2132
|
-
*/
|
|
2133
|
-
interface SeatPacing$1 {
|
|
2134
|
-
/** Maximum number of seats that can be reserved every 15 minutes. */
|
|
2135
|
-
number?: number;
|
|
2136
|
-
/** Whether this option is enabled. */
|
|
2137
|
-
enabled?: boolean;
|
|
2138
|
-
}
|
|
2139
|
-
/**
|
|
2140
|
-
* Party pacing.
|
|
2141
|
-
* The maximum number of party reservations that can start within a 15-minute period.
|
|
2142
|
-
* For example, a party pacing of 5 would mean that no more than 5 parties could make a reservation for the period between `10:00.000`-`10:14.999`.
|
|
2143
|
-
*/
|
|
2144
|
-
interface PartyPacing$1 {
|
|
2145
|
-
/** Maximum number of new party reservations that can be made every 15 minutes. */
|
|
2146
|
-
number?: number;
|
|
2147
|
-
/** Whether this option is enabled. */
|
|
2148
|
-
enabled?: boolean;
|
|
2149
|
-
}
|
|
2150
|
-
/** The party size limits for a single reservation. */
|
|
2151
|
-
interface PartySize$1 {
|
|
2152
|
-
/** Minimum number of seats a party can reserve. */
|
|
2153
|
-
min?: number;
|
|
2154
|
-
/** Maximum number of seats a party can reserve. */
|
|
2155
|
-
max?: number;
|
|
2156
|
-
}
|
|
2157
|
-
/**
|
|
2158
|
-
* Reservation notice period.
|
|
2159
|
-
*
|
|
2160
|
-
* The period of time between making a reservation and that reservation's start time. Reservations cannot be made after the start of this period.
|
|
2161
|
-
*/
|
|
2162
|
-
interface NoticePeriod$1 {
|
|
2163
|
-
/** The quantity of the chosen time unit. */
|
|
2164
|
-
number?: number;
|
|
2165
|
-
/** Time unit. */
|
|
2166
|
-
unit?: Unit$1;
|
|
2167
|
-
}
|
|
2168
|
-
/** Turnover time rule. A turnover time is defined per party size range. */
|
|
2169
|
-
interface TurnoverTimeRule$1 {
|
|
2170
|
-
/** Minimum number of seats to qualify for this rule. */
|
|
2171
|
-
seatsMin?: number;
|
|
2172
|
-
/** Maximum number of seats to qualify for this rule. */
|
|
2173
|
-
seatsMax?: number;
|
|
2174
|
-
/** Turnover time in minutes for qualifying parties. */
|
|
2175
|
-
minutes?: number;
|
|
2176
|
-
}
|
|
2177
|
-
/** Manual approval settings. */
|
|
2178
|
-
interface ManualApproval$1 extends ManualApprovalValueOneOf$1 {
|
|
2179
|
-
/** The minimum party size that requires manual approval. */
|
|
2180
|
-
partySizeThreshold?: number;
|
|
2181
|
-
/** Whether manual approval is required for online reservations. */
|
|
2182
|
-
enabled?: boolean;
|
|
2183
|
-
}
|
|
2184
|
-
/** @oneof */
|
|
2185
|
-
interface ManualApprovalValueOneOf$1 {
|
|
2186
|
-
/** The minimum party size that requires manual approval. */
|
|
2187
|
-
partySizeThreshold?: number;
|
|
2188
|
-
}
|
|
2189
|
-
/** Type of the field. */
|
|
2190
|
-
declare enum FieldType$1 {
|
|
2191
|
-
UNKNOWN = "UNKNOWN",
|
|
2192
|
-
TABLE = "TABLE",
|
|
2193
|
-
START_DATE = "START_DATE",
|
|
2194
|
-
END_DATE = "END_DATE",
|
|
2195
|
-
CREATED_DATE = "CREATED_DATE",
|
|
2196
|
-
UPDATED_DATE = "UPDATED_DATE",
|
|
2197
|
-
PARTY_SIZE = "PARTY_SIZE",
|
|
2198
|
-
FIRST_NAME = "FIRST_NAME",
|
|
2199
|
-
LAST_NAME = "LAST_NAME",
|
|
2200
|
-
EMAIL = "EMAIL",
|
|
2201
|
-
PHONE = "PHONE",
|
|
2202
|
-
ADDITIONAL_INFO = "ADDITIONAL_INFO",
|
|
2203
|
-
TEAM_MESSAGE = "TEAM_MESSAGE",
|
|
2204
|
-
CUSTOM_FIELD = "CUSTOM_FIELD",
|
|
2205
|
-
STATUS = "STATUS"
|
|
2206
|
-
}
|
|
2207
|
-
interface PageUrlV2 {
|
|
2208
|
-
/** The relative path for the page within the site. */
|
|
2209
|
-
relativePath?: string;
|
|
2210
|
-
/** The page's full URL. */
|
|
2211
|
-
url?: string | null;
|
|
2212
|
-
}
|
|
2213
|
-
/** Terms and conditions. */
|
|
2214
|
-
interface TermsAndConditions$1 extends TermsAndConditionsValueOneOf$1 {
|
|
2215
|
-
/** Terms and conditions URL. */
|
|
2216
|
-
url?: PageUrlV2;
|
|
2217
|
-
/** Terms and conditions text. */
|
|
2218
|
-
text?: string | null;
|
|
2219
|
-
/**
|
|
2220
|
-
* Whether the terms and conditions are shown to the customer.
|
|
2221
|
-
*
|
|
2222
|
-
* Default: `false`
|
|
2223
|
-
*/
|
|
2224
|
-
enabled?: boolean;
|
|
2225
|
-
}
|
|
2226
|
-
/** @oneof */
|
|
2227
|
-
interface TermsAndConditionsValueOneOf$1 {
|
|
2228
|
-
/** Terms and conditions URL. */
|
|
2229
|
-
url?: PageUrlV2;
|
|
2230
|
-
/** Terms and conditions text. */
|
|
2231
|
-
text?: string | null;
|
|
2232
|
-
}
|
|
2233
|
-
/** Privacy policy. */
|
|
2234
|
-
interface PrivacyPolicy$1 extends PrivacyPolicyValueOneOf$1 {
|
|
2235
|
-
/** Privacy policy URL. */
|
|
2236
|
-
url?: PageUrlV2;
|
|
2237
|
-
/** Privacy policy text. */
|
|
2238
|
-
text?: string | null;
|
|
2239
|
-
/**
|
|
2240
|
-
* Whether the privacy policy is shown to the customer.
|
|
2241
|
-
*
|
|
2242
|
-
* Default: `false`
|
|
2243
|
-
*/
|
|
2244
|
-
enabled?: boolean;
|
|
2245
|
-
}
|
|
2246
|
-
/** @oneof */
|
|
2247
|
-
interface PrivacyPolicyValueOneOf$1 {
|
|
2248
|
-
/** Privacy policy URL. */
|
|
2249
|
-
url?: PageUrlV2;
|
|
2250
|
-
/** Privacy policy text. */
|
|
2251
|
-
text?: string | null;
|
|
2252
|
-
}
|
|
2253
|
-
/** Custom field definition. Definitions of the fields that are added to the reservation form. */
|
|
2254
|
-
interface CustomFieldDefinition$1 {
|
|
2255
|
-
/**
|
|
2256
|
-
* Custom field ID.
|
|
2257
|
-
* @readonly
|
|
2258
|
-
*/
|
|
2259
|
-
id?: string | null;
|
|
2260
|
-
/** Custom field name. */
|
|
2261
|
-
name?: string;
|
|
2262
|
-
/**
|
|
2263
|
-
* Whether the custom field is required.
|
|
2264
|
-
*
|
|
2265
|
-
* Default: `false`
|
|
2266
|
-
*/
|
|
2267
|
-
required?: boolean;
|
|
2268
|
-
}
|
|
2269
|
-
/** Email marketing checkbox. */
|
|
2270
|
-
interface EmailMarketingCheckbox$1 {
|
|
2271
|
-
/**
|
|
2272
|
-
* Whether the checkbox is shown to the customer.
|
|
2273
|
-
*
|
|
2274
|
-
* Default: `false`
|
|
2275
|
-
*/
|
|
2276
|
-
enabled?: boolean;
|
|
2277
|
-
/**
|
|
2278
|
-
* Whether the checkbox is checked by default.
|
|
2279
|
-
*
|
|
2280
|
-
* Default: `false`
|
|
2281
|
-
*/
|
|
2282
|
-
checkedByDefault?: boolean;
|
|
2283
|
-
}
|
|
2284
|
-
interface OnlineReservations$1 {
|
|
2285
|
-
/**
|
|
2286
|
-
* Seat pacing settings.
|
|
2287
|
-
*
|
|
2288
|
-
* The maximum number of seats that can be filled by new reservations within a 15-minute period.
|
|
2289
|
-
* For example, setting a seat pacing of 15 would mean that between `10:00.000`-`10:14.999` there will be no more than 15 new seats available for reservation.
|
|
2290
|
-
*/
|
|
2291
|
-
seatPacing?: SeatPacing$1;
|
|
2292
|
-
/**
|
|
2293
|
-
* Party pacing settings.
|
|
2294
|
-
*
|
|
2295
|
-
* The maximum number of party reservations that can start within a 15-minute period.
|
|
2296
|
-
* For example, a party pacing of 5 would mean that no more than 5 parties could make a reservation for the period between `10:00.000`-`10:14.999`.
|
|
2297
|
-
*/
|
|
2298
|
-
partyPacing?: PartyPacing$1;
|
|
2299
|
-
/** Party size limits for a reservation. */
|
|
2300
|
-
partySize?: PartySize$1;
|
|
2301
|
-
/**
|
|
2302
|
-
* Minimum reservation notice.
|
|
2303
|
-
*
|
|
2304
|
-
* The minimum amount of time that must be allowed between making a reservation and that reservation's start time.
|
|
2305
|
-
*/
|
|
2306
|
-
minimumReservationNotice?: NoticePeriod$1;
|
|
2307
|
-
/**
|
|
2308
|
-
* Default turnover time in minutes.
|
|
2309
|
-
*
|
|
2310
|
-
* Turnover time is how much time a party is allotted for their entire reservation - from being seated to leaving the restaurant.
|
|
2311
|
-
*/
|
|
2312
|
-
defaultTurnoverTime?: number | null;
|
|
2313
|
-
/**
|
|
2314
|
-
* Custom turnover time rules.
|
|
2315
|
-
*
|
|
2316
|
-
* This allows you to set different turnover times for different party sizes.
|
|
2317
|
-
*/
|
|
2318
|
-
turnoverTimeRules?: TurnoverTimeRule$1[];
|
|
2319
|
-
/**
|
|
2320
|
-
* The location's business schedule.
|
|
2321
|
-
*
|
|
2322
|
-
* By default, the business schedule of a reservation location uses the values of its location's business schedule. However, after the first time a reservation location's business schedule has been modified, it stores and uses its own values and no longer mirrors its location's business schedule.
|
|
2323
|
-
* Limited to 100 time periods.
|
|
2324
|
-
*/
|
|
2325
|
-
businessSchedule?: CommonBusinessSchedule$1;
|
|
2326
|
-
/** Whether a phone number is shown. */
|
|
2327
|
-
showPhoneNumber?: boolean | null;
|
|
2328
|
-
/** Whether online reservations are enabled. */
|
|
2329
|
-
onlineReservationsEnabled?: boolean | null;
|
|
2330
|
-
/** Manual approval settings. */
|
|
2331
|
-
manualApproval?: ManualApproval$1;
|
|
2332
|
-
/**
|
|
2333
|
-
* Interval between a reservation location's time slots in minutes.
|
|
2334
|
-
*
|
|
2335
|
-
* This controls the interval between time slots on a Wix site's Reservations page, and the interval between time slots returned by the Time Slots API's Get Time Slots method.
|
|
2336
|
-
*
|
|
2337
|
-
* Default: `15`
|
|
2338
|
-
*/
|
|
2339
|
-
timeSlotInterval?: number | null;
|
|
2340
|
-
}
|
|
2341
|
-
/** Reservation form settings. */
|
|
2342
|
-
interface ReservationForm$1 {
|
|
2343
|
-
/** A message shown to the customer in the registration form. */
|
|
2344
|
-
submitMessage?: string | null;
|
|
2345
|
-
/** Whether to show policies (the terms and conditions, and the privacy policy) to the customer. */
|
|
2346
|
-
policiesEnabled?: boolean | null;
|
|
2347
|
-
/** Settings for displaying the terms and conditions. */
|
|
2348
|
-
termsAndConditions?: TermsAndConditions$1;
|
|
2349
|
-
/** Settings for displaying the privacy policy. */
|
|
2350
|
-
privacyPolicy?: PrivacyPolicy$1;
|
|
2351
|
-
/** Custom fields you wish to add to the registration form for the customer to fill in. */
|
|
2352
|
-
customFieldDefinitions?: CustomFieldDefinition$1[];
|
|
2353
|
-
/**
|
|
2354
|
-
* Whether a last_name is required in the reservation form.
|
|
2355
|
-
*
|
|
2356
|
-
* Default: `false`
|
|
2357
|
-
*/
|
|
2358
|
-
lastNameRequired?: boolean | null;
|
|
2359
|
-
/**
|
|
2360
|
-
* Whether an email is required in the reservation form.
|
|
2361
|
-
*
|
|
2362
|
-
* Default: `false`
|
|
2363
|
-
*/
|
|
2364
|
-
emailRequired?: boolean | null;
|
|
2365
|
-
/** Email marketing checkbox settings. */
|
|
2366
|
-
emailMarketingCheckbox?: EmailMarketingCheckbox$1;
|
|
2367
|
-
}
|
|
2368
|
-
/** My reservations field definition. */
|
|
2369
|
-
interface MyReservationsField$1 {
|
|
2370
|
-
/** Field type. */
|
|
2371
|
-
fieldType?: FieldType$1;
|
|
2372
|
-
/**
|
|
2373
|
-
* Custom field ID.
|
|
2374
|
-
*
|
|
2375
|
-
* This should only be provided if the `fieldType` is `CUSTOM_FIELD`, in which case it is required and must match the ID of a custom field in the `customFieldDefinitions` array of the `reservationForm`.
|
|
2376
|
-
* @readonly
|
|
2377
|
-
*/
|
|
2378
|
-
customFieldId?: string | null;
|
|
2379
|
-
/** Whether the field is shown. */
|
|
2380
|
-
shown?: boolean;
|
|
2381
|
-
}
|
|
2382
|
-
interface TableManagement$1 {
|
|
2383
|
-
/** Table definitions. */
|
|
2384
|
-
tableDefinitions?: TableDefinition$1[];
|
|
2385
|
-
/** Deleted table definitions. */
|
|
2386
|
-
deletedTableDefinitions?: TableDefinition$1[];
|
|
2387
|
-
/** Table combinations. */
|
|
2388
|
-
tableCombinations?: TableCombination$1[];
|
|
2389
|
-
}
|
|
2390
|
-
interface Location$1 {
|
|
2391
|
-
/**
|
|
2392
|
-
* Location ID.
|
|
2393
|
-
* @readonly
|
|
2394
|
-
*/
|
|
2395
|
-
id?: string | null;
|
|
2396
|
-
}
|
|
2397
|
-
interface Configuration$1 {
|
|
2398
|
-
/** Settings for this location that are used to determine restaurant availability for reservations made online. */
|
|
2399
|
-
onlineReservations?: OnlineReservations$1;
|
|
2400
|
-
/** Reservation form settings. */
|
|
2401
|
-
reservationForm?: ReservationForm$1;
|
|
2402
|
-
/**
|
|
2403
|
-
* "My reservations" field details.
|
|
2404
|
-
*
|
|
2405
|
-
* These are the fields that appear in the "My reservations" section of the Table Reservations page on the restaurant's Wix site dashboard.
|
|
2406
|
-
*/
|
|
2407
|
-
myReservationsFields?: MyReservationsField$1[];
|
|
2408
|
-
/** Table management settings. */
|
|
2409
|
-
tableManagement?: TableManagement$1;
|
|
2410
|
-
}
|
|
2411
|
-
interface ExtendedFields$1 {
|
|
2412
|
-
/**
|
|
2413
|
-
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
2414
|
-
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
2415
|
-
*
|
|
2416
|
-
* You can only access fields for which you have the appropriate permissions.
|
|
2417
|
-
*
|
|
2418
|
-
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
2419
|
-
*/
|
|
2420
|
-
namespaces?: Record<string, Record<string, any>>;
|
|
2421
|
-
}
|
|
2422
|
-
interface GetReservationLocationRequest$1 {
|
|
2423
|
-
/** ID of the ReservationLocation to retrieve. */
|
|
2424
|
-
reservationLocationId: string;
|
|
2425
|
-
/**
|
|
2426
|
-
* Array of named, predefined sets of projected fields to be returned.
|
|
2427
|
-
*
|
|
2428
|
-
* Default: `PUBLIC`.
|
|
2429
|
-
*/
|
|
2430
|
-
fieldsets?: Set$1[];
|
|
2431
|
-
}
|
|
2432
|
-
declare enum Set$1 {
|
|
2433
|
-
/**
|
|
2434
|
-
* Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
|
|
2435
|
-
* `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
|
|
2436
|
-
* `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
|
|
2437
|
-
* `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
|
|
2438
|
-
*/
|
|
2439
|
-
PUBLIC = "PUBLIC",
|
|
2440
|
-
/** - `FULL`: Returns all fields. */
|
|
2441
|
-
FULL = "FULL"
|
|
2442
|
-
}
|
|
2443
|
-
interface GetReservationLocationResponse$1 {
|
|
2444
|
-
/** The retrieved reservation location. */
|
|
2445
|
-
reservationLocation?: ReservationLocation$1;
|
|
2446
|
-
}
|
|
2447
|
-
interface UpdateReservationLocationRequest$1 {
|
|
2448
|
-
/** ReservationLocation to be updated, may be partial. */
|
|
2449
|
-
reservationLocation: ReservationLocation$1;
|
|
2450
|
-
}
|
|
2451
|
-
interface UpdateReservationLocationResponse$1 {
|
|
2452
|
-
/** The updated reservation location. */
|
|
2453
|
-
reservationLocation?: ReservationLocation$1;
|
|
2454
|
-
}
|
|
2455
|
-
interface UpdateExtendedFieldsRequest$1 {
|
|
2456
|
-
/** ID of the entity to update. */
|
|
2457
|
-
id: string;
|
|
2458
|
-
/** Identifier for the app whose extended fields are being updated. */
|
|
2459
|
-
namespace: string;
|
|
2460
|
-
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
2461
|
-
namespaceData: Record<string, any> | null;
|
|
2462
|
-
}
|
|
2463
|
-
interface UpdateExtendedFieldsResponse$1 {
|
|
2464
|
-
/** Updated reservation location. */
|
|
2465
|
-
reservationLocation?: ReservationLocation$1;
|
|
2466
|
-
}
|
|
2467
|
-
interface QueryReservationLocationsRequest$1 {
|
|
2468
|
-
/** Query options. */
|
|
2469
|
-
query: QueryV2$1;
|
|
2470
|
-
/**
|
|
2471
|
-
* Array of named, predefined sets of projected fields to be returned.
|
|
2472
|
-
*
|
|
2473
|
-
* Default: `PUBLIC`.
|
|
2474
|
-
*/
|
|
2475
|
-
fieldsets?: Set$1[];
|
|
2476
|
-
}
|
|
2477
|
-
interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
|
|
2478
|
-
/** Paging options to limit and skip the number of items. */
|
|
2479
|
-
paging?: Paging$1;
|
|
2480
|
-
/** 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`. */
|
|
2481
|
-
cursorPaging?: CursorPaging$1;
|
|
2482
|
-
/**
|
|
2483
|
-
* Filter object in the following format:
|
|
2484
|
-
* `"filter" : {
|
|
2485
|
-
* "fieldName1": "value1",
|
|
2486
|
-
* "fieldName2":{"$operator":"value2"}
|
|
2487
|
-
* }`
|
|
2488
|
-
*
|
|
2489
|
-
* For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/sorting-and-filtering) article.
|
|
2490
|
-
* To learn how to query reservations, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
|
|
2491
|
-
*/
|
|
2492
|
-
filter?: Record<string, any> | null;
|
|
2493
|
-
/**
|
|
2494
|
-
* Sort object in the following format:
|
|
2495
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
2496
|
-
*/
|
|
2497
|
-
sort?: Sorting$1[];
|
|
2498
|
-
}
|
|
2499
|
-
/** @oneof */
|
|
2500
|
-
interface QueryV2PagingMethodOneOf$1 {
|
|
2501
|
-
/** Paging options to limit and skip the number of items. */
|
|
2502
|
-
paging?: Paging$1;
|
|
2503
|
-
/** 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`. */
|
|
2504
|
-
cursorPaging?: CursorPaging$1;
|
|
2505
|
-
}
|
|
2506
|
-
interface Sorting$1 {
|
|
2507
|
-
/** Name of the field to sort by. */
|
|
2508
|
-
fieldName?: string;
|
|
2509
|
-
/**
|
|
2510
|
-
* Sort order.
|
|
2511
|
-
*
|
|
2512
|
-
* Defaults to `ASC`.
|
|
2513
|
-
*/
|
|
2514
|
-
order?: SortOrder$1;
|
|
2515
|
-
}
|
|
2516
|
-
declare enum SortOrder$1 {
|
|
2517
|
-
/** Soer by ascending order. */
|
|
2518
|
-
ASC = "ASC",
|
|
2519
|
-
/** Sort by descending order. */
|
|
2520
|
-
DESC = "DESC"
|
|
2521
|
-
}
|
|
2522
|
-
interface Paging$1 {
|
|
2523
|
-
/** Number of items to load. */
|
|
2524
|
-
limit?: number | null;
|
|
2525
|
-
/** Number of items to skip in the current sort order. */
|
|
2526
|
-
offset?: number | null;
|
|
2527
|
-
}
|
|
2528
|
-
interface CursorPaging$1 {
|
|
2529
|
-
/** Number of items to load. */
|
|
2530
|
-
limit?: number | null;
|
|
2531
|
-
/**
|
|
2532
|
-
* Pointer to the next or previous page in the list of results.
|
|
2533
|
-
*
|
|
2534
|
-
* You can get the relevant cursor token
|
|
2535
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
2536
|
-
* Not relevant for the first request.
|
|
2537
|
-
*/
|
|
2538
|
-
cursor?: string | null;
|
|
2539
|
-
}
|
|
2540
|
-
interface QueryReservationLocationsResponse$1 {
|
|
2541
|
-
/** List of reservation locations. */
|
|
2542
|
-
reservationLocations?: ReservationLocation$1[];
|
|
2543
|
-
/** Metadata for the paginated results. */
|
|
2544
|
-
pagingMetadata?: PagingMetadataV2$1;
|
|
2545
|
-
}
|
|
2546
|
-
interface PagingMetadataV2$1 {
|
|
2547
|
-
/** Offset that was requested. */
|
|
2548
|
-
offset?: number | null;
|
|
2549
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
2550
|
-
cursors?: Cursors$1;
|
|
2551
|
-
}
|
|
2552
|
-
interface Cursors$1 {
|
|
2553
|
-
/** Cursor pointing to next page in the list of results. */
|
|
2554
|
-
next?: string | null;
|
|
2555
|
-
/** Cursor pointing to previous page in the list of results. */
|
|
2556
|
-
prev?: string | null;
|
|
2557
|
-
}
|
|
2558
|
-
interface ListReservationLocationsRequest$1 {
|
|
2559
|
-
/** 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`. */
|
|
2560
|
-
paging?: CursorPaging$1;
|
|
2561
|
-
/** Sorting for the locations list. */
|
|
2562
|
-
sort?: Sorting$1;
|
|
2563
|
-
/**
|
|
2564
|
-
* Array of named, predefined sets of projected fields to be returned.
|
|
2565
|
-
*
|
|
2566
|
-
* Default: `PUBLIC`.
|
|
2567
|
-
*/
|
|
2568
|
-
fieldsets?: Set$1[];
|
|
2569
|
-
}
|
|
2570
|
-
interface ListReservationLocationsResponse$1 {
|
|
2571
|
-
/** Locations list. */
|
|
2572
|
-
reservationLocations?: ReservationLocation$1[];
|
|
2573
|
-
/** Metadata for the paginated results. */
|
|
2574
|
-
pagingMetadata?: CursorPagingMetadata$1;
|
|
2575
|
-
}
|
|
2576
|
-
interface CursorPagingMetadata$1 {
|
|
2577
|
-
/** Number of items returned in the response. */
|
|
2578
|
-
count?: number | null;
|
|
2579
|
-
/** Offset that was requested. */
|
|
2580
|
-
cursors?: Cursors$1;
|
|
2581
|
-
/**
|
|
2582
|
-
* Indicates if there are more results after the current page.
|
|
2583
|
-
* If `true`, another page of results can be retrieved.
|
|
2584
|
-
* If `false`, this is the last page.
|
|
2585
|
-
*/
|
|
2586
|
-
hasNext?: boolean | null;
|
|
2587
|
-
}
|
|
2588
|
-
interface StreetAddressNonNullableFields$1 {
|
|
2589
|
-
number: string;
|
|
2590
|
-
name: string;
|
|
2591
|
-
apt: string;
|
|
2592
|
-
}
|
|
2593
|
-
interface LocationAddressNonNullableFields$1 {
|
|
2594
|
-
streetAddress?: StreetAddressNonNullableFields$1;
|
|
2595
|
-
}
|
|
2596
|
-
interface CommonTimePeriodNonNullableFields$1 {
|
|
2597
|
-
openDay: CommonDayOfWeek$1;
|
|
2598
|
-
openTime: string;
|
|
2599
|
-
closeDay: CommonDayOfWeek$1;
|
|
2600
|
-
closeTime: string;
|
|
2601
|
-
}
|
|
2602
|
-
interface CommonSpecialHourPeriodNonNullableFields$1 {
|
|
2603
|
-
startDate: string;
|
|
2604
|
-
endDate: string;
|
|
2605
|
-
isClosed: boolean;
|
|
2606
|
-
comment: string;
|
|
2607
|
-
}
|
|
2608
|
-
interface CommonBusinessScheduleNonNullableFields$1 {
|
|
2609
|
-
periods: CommonTimePeriodNonNullableFields$1[];
|
|
2610
|
-
specialHourPeriod: CommonSpecialHourPeriodNonNullableFields$1[];
|
|
2611
|
-
}
|
|
2612
|
-
interface LocationNonNullableFields$1 {
|
|
2613
|
-
address?: LocationAddressNonNullableFields$1;
|
|
2614
|
-
businessSchedule?: CommonBusinessScheduleNonNullableFields$1;
|
|
2615
|
-
}
|
|
2616
|
-
interface ApprovalNonNullableFields$1 {
|
|
2617
|
-
mode: ApprovalMode$1;
|
|
2618
|
-
}
|
|
2619
|
-
interface SeatPacingNonNullableFields$1 {
|
|
2620
|
-
number: number;
|
|
2621
|
-
enabled: boolean;
|
|
2622
|
-
}
|
|
2623
|
-
interface PartyPacingNonNullableFields$1 {
|
|
2624
|
-
number: number;
|
|
2625
|
-
enabled: boolean;
|
|
2626
|
-
}
|
|
2627
|
-
interface PartiesSizeNonNullableFields$1 {
|
|
2628
|
-
min: number;
|
|
2629
|
-
max: number;
|
|
2630
|
-
}
|
|
2631
|
-
interface PartySizeNonNullableFields$1 {
|
|
2632
|
-
min: number;
|
|
2633
|
-
max: number;
|
|
2634
|
-
}
|
|
2635
|
-
interface NoticePeriodNonNullableFields$1 {
|
|
2636
|
-
number: number;
|
|
2637
|
-
unit: Unit$1;
|
|
2638
|
-
}
|
|
2639
|
-
interface TurnoverTimeRuleNonNullableFields$1 {
|
|
2640
|
-
seatsMin: number;
|
|
2641
|
-
seatsMax: number;
|
|
2642
|
-
minutes: number;
|
|
2643
|
-
}
|
|
2644
|
-
interface TurnoverRuleNonNullableFields$1 {
|
|
2645
|
-
minSeats: number;
|
|
2646
|
-
maxSeats: number;
|
|
2647
|
-
minutes: number;
|
|
2648
|
-
}
|
|
2649
|
-
interface ManualApprovalNonNullableFields$1 {
|
|
2650
|
-
partySizeThreshold: number;
|
|
2651
|
-
enabled: boolean;
|
|
2652
|
-
}
|
|
2653
|
-
interface OnlineReservationsNonNullableFields$1 {
|
|
2654
|
-
approval?: ApprovalNonNullableFields$1;
|
|
2655
|
-
seatPacing?: SeatPacingNonNullableFields$1;
|
|
2656
|
-
partyPacing?: PartyPacingNonNullableFields$1;
|
|
2657
|
-
partiesSize?: PartiesSizeNonNullableFields$1;
|
|
2658
|
-
partySize?: PartySizeNonNullableFields$1;
|
|
2659
|
-
minimumReservationNotice?: NoticePeriodNonNullableFields$1;
|
|
2660
|
-
turnoverTimeRules: TurnoverTimeRuleNonNullableFields$1[];
|
|
2661
|
-
turnoverRules: TurnoverRuleNonNullableFields$1[];
|
|
2662
|
-
businessSchedule?: CommonBusinessScheduleNonNullableFields$1;
|
|
2663
|
-
manualApproval?: ManualApprovalNonNullableFields$1;
|
|
2664
|
-
}
|
|
2665
|
-
interface PageUrlV2NonNullableFields {
|
|
2666
|
-
relativePath: string;
|
|
2667
|
-
}
|
|
2668
|
-
interface TermsAndConditionsNonNullableFields$1 {
|
|
2669
|
-
url?: PageUrlV2NonNullableFields;
|
|
2670
|
-
enabled: boolean;
|
|
2671
|
-
}
|
|
2672
|
-
interface PrivacyPolicyNonNullableFields$1 {
|
|
2673
|
-
url?: PageUrlV2NonNullableFields;
|
|
2674
|
-
enabled: boolean;
|
|
2675
|
-
}
|
|
2676
|
-
interface CustomFieldDefinitionNonNullableFields$1 {
|
|
2677
|
-
name: string;
|
|
2678
|
-
required: boolean;
|
|
2679
|
-
}
|
|
2680
|
-
interface EmailMarketingCheckboxNonNullableFields$1 {
|
|
2681
|
-
enabled: boolean;
|
|
2682
|
-
checkedByDefault: boolean;
|
|
2683
|
-
}
|
|
2684
|
-
interface ReservationFormNonNullableFields$1 {
|
|
2685
|
-
termsAndConditions?: TermsAndConditionsNonNullableFields$1;
|
|
2686
|
-
privacyPolicy?: PrivacyPolicyNonNullableFields$1;
|
|
2687
|
-
customFieldDefinitions: CustomFieldDefinitionNonNullableFields$1[];
|
|
2688
|
-
emailMarketingCheckbox?: EmailMarketingCheckboxNonNullableFields$1;
|
|
2689
|
-
}
|
|
2690
|
-
interface MyReservationsFieldNonNullableFields$1 {
|
|
2691
|
-
fieldType: FieldType$1;
|
|
2692
|
-
shown: boolean;
|
|
2693
|
-
}
|
|
2694
|
-
interface TableDefinitionNonNullableFields$1 {
|
|
2695
|
-
name: string;
|
|
2696
|
-
seatsMin: number;
|
|
2697
|
-
seatsMax: number;
|
|
2698
|
-
}
|
|
2699
|
-
interface TableCombinationNonNullableFields$1 {
|
|
2700
|
-
seatsMin: number;
|
|
2701
|
-
seatsMax: number;
|
|
2702
|
-
}
|
|
2703
|
-
interface TableManagementNonNullableFields$1 {
|
|
2704
|
-
mode: Value$1;
|
|
2705
|
-
tableDefinitions: TableDefinitionNonNullableFields$1[];
|
|
2706
|
-
deletedTableDefinitions: TableDefinitionNonNullableFields$1[];
|
|
2707
|
-
tableCombinations: TableCombinationNonNullableFields$1[];
|
|
2708
|
-
}
|
|
2709
|
-
interface ReservationPaymentNonNullableFields$1 {
|
|
2710
|
-
value: string;
|
|
2711
|
-
minPartySize: number;
|
|
2712
|
-
}
|
|
2713
|
-
interface ConfigurationNonNullableFields$1 {
|
|
2714
|
-
onlineReservations?: OnlineReservationsNonNullableFields$1;
|
|
2715
|
-
reservationForm?: ReservationFormNonNullableFields$1;
|
|
2716
|
-
myReservationsFields: MyReservationsFieldNonNullableFields$1[];
|
|
2717
|
-
tableManagement?: TableManagementNonNullableFields$1;
|
|
2718
|
-
reservationPayment?: ReservationPaymentNonNullableFields$1;
|
|
2719
|
-
}
|
|
2720
|
-
interface ReservationLocationNonNullableFields$1 {
|
|
2721
|
-
location?: LocationNonNullableFields$1;
|
|
2722
|
-
configuration?: ConfigurationNonNullableFields$1;
|
|
2723
|
-
}
|
|
2724
|
-
interface GetReservationLocationResponseNonNullableFields$1 {
|
|
2725
|
-
reservationLocation?: ReservationLocationNonNullableFields$1;
|
|
2726
|
-
}
|
|
2727
|
-
interface UpdateReservationLocationResponseNonNullableFields$1 {
|
|
2728
|
-
reservationLocation?: ReservationLocationNonNullableFields$1;
|
|
2729
|
-
}
|
|
2730
|
-
interface UpdateExtendedFieldsResponseNonNullableFields$1 {
|
|
2731
|
-
reservationLocation?: ReservationLocationNonNullableFields$1;
|
|
2732
|
-
}
|
|
2733
|
-
interface QueryReservationLocationsResponseNonNullableFields$1 {
|
|
2734
|
-
reservationLocations: ReservationLocationNonNullableFields$1[];
|
|
2735
|
-
}
|
|
2736
|
-
interface ListReservationLocationsResponseNonNullableFields$1 {
|
|
2737
|
-
reservationLocations: ReservationLocationNonNullableFields$1[];
|
|
2738
|
-
}
|
|
2739
|
-
|
|
2740
|
-
interface ReservationLocation {
|
|
2741
|
-
/**
|
|
2742
|
-
* Reservation location ID.
|
|
2743
|
-
* @readonly
|
|
2744
|
-
*/
|
|
2745
|
-
_id?: string | null;
|
|
2746
|
-
/** Represents the current state of a reservation location. Each time the reservation location is modified, its `revision` changes. For an update operation to succeed, you must specify the latest revision. */
|
|
2747
|
-
revision?: string | null;
|
|
2748
|
-
/**
|
|
2749
|
-
* The date and time this reservation location was created.
|
|
2750
|
-
* @readonly
|
|
2751
|
-
*/
|
|
2752
|
-
_createdDate?: Date | null;
|
|
2753
|
-
/**
|
|
2754
|
-
* The date and time this reservation location was last updated.
|
|
2755
|
-
* @readonly
|
|
2756
|
-
*/
|
|
2757
|
-
_updatedDate?: Date | null;
|
|
2758
|
-
/**
|
|
2759
|
-
* Physical location details.
|
|
2760
|
-
*
|
|
2761
|
-
* Locations can be created and configured using the Locations API.
|
|
2762
|
-
* or on the [Business Info](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fsettings/business-info) page in the Dashboard.
|
|
2763
|
-
* @readonly
|
|
2764
|
-
*/
|
|
2765
|
-
location?: Location;
|
|
2766
|
-
/** Reservation location configuration. */
|
|
2767
|
-
configuration?: Configuration;
|
|
2768
|
-
/**
|
|
2769
|
-
* Whether this reservation location's `location` is the default location of the business.
|
|
2770
|
-
* @readonly
|
|
2771
|
-
*/
|
|
2772
|
-
default?: boolean | null;
|
|
2773
|
-
/**
|
|
2774
|
-
* Whether this reservation location's `location` is archived.
|
|
2775
|
-
* @readonly
|
|
2776
|
-
*/
|
|
2777
|
-
archived?: boolean | null;
|
|
2778
|
-
/**
|
|
2779
|
-
* Custom field data for the reservation location object.
|
|
2780
|
-
*
|
|
2781
|
-
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
2782
|
-
*/
|
|
2783
|
-
extendedFields?: ExtendedFields;
|
|
2784
|
-
}
|
|
2785
|
-
/**
|
|
2786
|
-
* Time periods that this location is open for business. Includes a collection of TimePeriod instances.
|
|
2787
|
-
* Aligned with https://developers.google.com/my-business/reference/rest/v4/accounts.locations#businesshours
|
|
2788
|
-
* With a few minor adjustments
|
|
2789
|
-
*/
|
|
2790
|
-
interface CommonBusinessSchedule {
|
|
2791
|
-
periods?: CommonTimePeriod[];
|
|
2792
|
-
/**
|
|
2793
|
-
* Time periods during which this location is open. Each period represents a range of hours during the week during which the location is
|
|
2794
|
-
* open.
|
|
2795
|
-
*
|
|
2796
|
-
* Max: 100 time periods
|
|
2797
|
-
*/
|
|
2798
|
-
specialHourPeriod?: CommonSpecialHourPeriod[];
|
|
2799
|
-
}
|
|
2800
|
-
/**
|
|
2801
|
-
* A span of time that the business is open,
|
|
2802
|
-
* starting on the specified open day/time and closing on the specified close day/time.
|
|
2803
|
-
* Closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
|
|
2804
|
-
*/
|
|
2805
|
-
interface CommonTimePeriod {
|
|
2806
|
-
/** Day of the week this period starts on. */
|
|
2807
|
-
openDay?: CommonDayOfWeek;
|
|
2808
|
-
/**
|
|
2809
|
-
* Time this period starts in 24hr [ISO 8601](http://www.w3.org/TR/NOTE-datetime) extended format (hh:mm). Valid values are `00:00-24:00`, where `24:00` represents
|
|
2810
|
-
* midnight at the end of the specified day field.
|
|
2811
|
-
*/
|
|
2812
|
-
openTime?: string;
|
|
2813
|
-
/** Day of the week this period ends on. */
|
|
2814
|
-
closeDay?: CommonDayOfWeek;
|
|
2815
|
-
/**
|
|
2816
|
-
* Time this period ends in 24hr [ISO 8601](http://www.w3.org/TR/NOTE-datetime) extended format (hh:mm). Valid values are `00:00-24:00`, where `24:00` represents
|
|
2817
|
-
* midnight at the end of the specified day field.
|
|
2818
|
-
*
|
|
2819
|
-
* This is the last time a reservation can be made at the restaurant, not the time the restaurant closes its doors.
|
|
2820
|
-
*/
|
|
2821
|
-
closeTime?: string;
|
|
2822
|
-
}
|
|
2823
|
-
/** Enumerates the days of the week. */
|
|
2824
|
-
declare enum CommonDayOfWeek {
|
|
2825
|
-
MONDAY = "MONDAY",
|
|
2826
|
-
TUESDAY = "TUESDAY",
|
|
2827
|
-
WEDNESDAY = "WEDNESDAY",
|
|
2828
|
-
THURSDAY = "THURSDAY",
|
|
2829
|
-
FRIDAY = "FRIDAY",
|
|
2830
|
-
SATURDAY = "SATURDAY",
|
|
2831
|
-
SUNDAY = "SUNDAY"
|
|
2832
|
-
}
|
|
2833
|
-
/** Set of time periods when a location's operational hours differ from its normal business hours. */
|
|
2834
|
-
interface CommonSpecialHourPeriod {
|
|
2835
|
-
/** Start date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. */
|
|
2836
|
-
startDate?: string;
|
|
2837
|
-
/** End date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. */
|
|
2838
|
-
endDate?: string;
|
|
2839
|
-
/** Whether or not the location is closed during this period. */
|
|
2840
|
-
isClosed?: boolean;
|
|
2841
|
-
/** Additional details about the period. */
|
|
2842
|
-
comment?: string;
|
|
2843
|
-
}
|
|
2844
|
-
declare enum Value {
|
|
2845
|
-
UNKNOWN = "UNKNOWN",
|
|
2846
|
-
ON = "ON",
|
|
2847
|
-
IN_HOUSE_ONLY = "IN_HOUSE_ONLY",
|
|
2848
|
-
OFF = "OFF"
|
|
2849
|
-
}
|
|
2850
|
-
interface TableDefinition {
|
|
2851
|
-
/**
|
|
2852
|
-
* Table ID.
|
|
2853
|
-
* @readonly
|
|
2854
|
-
*/
|
|
2855
|
-
_id?: string | null;
|
|
2856
|
-
/** Table name. */
|
|
2857
|
-
name?: string;
|
|
2858
|
-
/** Minimum number of seats. */
|
|
2859
|
-
seatsMin?: number;
|
|
2860
|
-
/** Maximum number of seats. */
|
|
2861
|
-
seatsMax?: number;
|
|
2862
|
-
/** Whether the table is active (available to be reserved). */
|
|
2863
|
-
isActive?: boolean | null;
|
|
2864
|
-
}
|
|
2865
|
-
interface TableCombination {
|
|
2866
|
-
/**
|
|
2867
|
-
* Table combination ID.
|
|
2868
|
-
* @readonly
|
|
2869
|
-
*/
|
|
2870
|
-
_id?: string | null;
|
|
2871
|
-
/** IDs of tables in the combination. */
|
|
2872
|
-
tableIds?: string[] | null;
|
|
2873
|
-
/** Minimum number of seats that can be reserved in this table combination. */
|
|
2874
|
-
seatsMin?: number;
|
|
2875
|
-
/** Maximum number of seats that can be reserved in this table combination. */
|
|
2876
|
-
seatsMax?: number;
|
|
2877
|
-
/** Whether the table combination is active (available to be reserved). */
|
|
2878
|
-
isActive?: boolean | null;
|
|
2879
|
-
}
|
|
2880
|
-
declare enum Unit {
|
|
2881
|
-
UNKNOWN = "UNKNOWN",
|
|
2882
|
-
MINUTES = "MINUTES",
|
|
2883
|
-
HOURS = "HOURS",
|
|
2884
|
-
DAYS = "DAYS"
|
|
2885
|
-
}
|
|
2886
|
-
declare enum ApprovalMode {
|
|
2887
|
-
UNKNOWN = "UNKNOWN",
|
|
2888
|
-
AUTOMATIC = "AUTOMATIC",
|
|
2889
|
-
MANUAL = "MANUAL",
|
|
2890
|
-
MANUAL_FOR_LARGE_PARTIES = "MANUAL_FOR_LARGE_PARTIES"
|
|
2891
|
-
}
|
|
2892
|
-
/**
|
|
2893
|
-
* Seat pacing.
|
|
2894
|
-
* The maximum number of seats that can be filled by new reservations within a 15-minute period.
|
|
2895
|
-
* For example, setting a seat pacing of 15 would mean that between `10:00.000`-`10:14.999` there will be no more than 15 new seats available for reservation.
|
|
2896
|
-
*/
|
|
2897
|
-
interface SeatPacing {
|
|
2898
|
-
/** Maximum number of seats that can be reserved every 15 minutes. */
|
|
2899
|
-
number?: number;
|
|
2900
|
-
/** Whether this option is enabled. */
|
|
2901
|
-
enabled?: boolean;
|
|
2902
|
-
}
|
|
2903
|
-
/**
|
|
2904
|
-
* Party pacing.
|
|
2905
|
-
* The maximum number of party reservations that can start within a 15-minute period.
|
|
2906
|
-
* For example, a party pacing of 5 would mean that no more than 5 parties could make a reservation for the period between `10:00.000`-`10:14.999`.
|
|
2907
|
-
*/
|
|
2908
|
-
interface PartyPacing {
|
|
2909
|
-
/** Maximum number of new party reservations that can be made every 15 minutes. */
|
|
2910
|
-
number?: number;
|
|
2911
|
-
/** Whether this option is enabled. */
|
|
2912
|
-
enabled?: boolean;
|
|
2913
|
-
}
|
|
2914
|
-
/** The party size limits for a single reservation. */
|
|
2915
|
-
interface PartySize {
|
|
2916
|
-
/** Minimum number of seats a party can reserve. */
|
|
2917
|
-
min?: number;
|
|
2918
|
-
/** Maximum number of seats a party can reserve. */
|
|
2919
|
-
max?: number;
|
|
2920
|
-
}
|
|
2921
|
-
/**
|
|
2922
|
-
* Reservation notice period.
|
|
2923
|
-
*
|
|
2924
|
-
* The period of time between making a reservation and that reservation's start time. Reservations cannot be made after the start of this period.
|
|
2925
|
-
*/
|
|
2926
|
-
interface NoticePeriod {
|
|
2927
|
-
/** The quantity of the chosen time unit. */
|
|
2928
|
-
number?: number;
|
|
2929
|
-
/**
|
|
2930
|
-
* Time unit.
|
|
2931
|
-
*
|
|
2932
|
-
* Supported values:
|
|
2933
|
-
* 'UNKNOWN', 'MINUTES, 'HOURS', 'DAYS'.
|
|
2934
|
-
*/
|
|
2935
|
-
unit?: Unit;
|
|
2936
|
-
}
|
|
2937
|
-
/** Turnover time rule. A turnover time is defined per party size range. */
|
|
2938
|
-
interface TurnoverTimeRule {
|
|
2939
|
-
/** Minimum number of seats to qualify for this rule. */
|
|
2940
|
-
seatsMin?: number;
|
|
2941
|
-
/** Maximum number of seats to qualify for this rule. */
|
|
2942
|
-
seatsMax?: number;
|
|
2943
|
-
/** Turnover time in minutes for qualifying parties. */
|
|
2944
|
-
minutes?: number;
|
|
2945
|
-
}
|
|
2946
|
-
/** Manual approval settings. */
|
|
2947
|
-
interface ManualApproval extends ManualApprovalValueOneOf {
|
|
2948
|
-
/** The minimum party size that requires manual approval. */
|
|
2949
|
-
partySizeThreshold?: number;
|
|
2950
|
-
/** Whether manual approval is required for online reservations. */
|
|
2951
|
-
enabled?: boolean;
|
|
2952
|
-
}
|
|
2953
|
-
/** @oneof */
|
|
2954
|
-
interface ManualApprovalValueOneOf {
|
|
2955
|
-
/** The minimum party size that requires manual approval. */
|
|
2956
|
-
partySizeThreshold?: number;
|
|
2957
|
-
}
|
|
2958
|
-
/** Type of the field. */
|
|
2959
|
-
declare enum FieldType {
|
|
2960
|
-
UNKNOWN = "UNKNOWN",
|
|
2961
|
-
TABLE = "TABLE",
|
|
2962
|
-
START_DATE = "START_DATE",
|
|
2963
|
-
END_DATE = "END_DATE",
|
|
2964
|
-
CREATED_DATE = "CREATED_DATE",
|
|
2965
|
-
UPDATED_DATE = "UPDATED_DATE",
|
|
2966
|
-
PARTY_SIZE = "PARTY_SIZE",
|
|
2967
|
-
FIRST_NAME = "FIRST_NAME",
|
|
2968
|
-
LAST_NAME = "LAST_NAME",
|
|
2969
|
-
EMAIL = "EMAIL",
|
|
2970
|
-
PHONE = "PHONE",
|
|
2971
|
-
ADDITIONAL_INFO = "ADDITIONAL_INFO",
|
|
2972
|
-
TEAM_MESSAGE = "TEAM_MESSAGE",
|
|
2973
|
-
CUSTOM_FIELD = "CUSTOM_FIELD",
|
|
2974
|
-
STATUS = "STATUS"
|
|
2975
|
-
}
|
|
2976
|
-
/** Terms and conditions. */
|
|
2977
|
-
interface TermsAndConditions extends TermsAndConditionsValueOneOf {
|
|
2978
|
-
/** Terms and conditions URL. */
|
|
2979
|
-
url?: string;
|
|
2980
|
-
/** Terms and conditions text. */
|
|
2981
|
-
text?: string | null;
|
|
2982
|
-
/**
|
|
2983
|
-
* Whether the terms and conditions are shown to the customer.
|
|
2984
|
-
*
|
|
2985
|
-
* Default: `false`
|
|
2986
|
-
*/
|
|
2987
|
-
enabled?: boolean;
|
|
2988
|
-
}
|
|
2989
|
-
/** @oneof */
|
|
2990
|
-
interface TermsAndConditionsValueOneOf {
|
|
2991
|
-
/** Terms and conditions URL. */
|
|
2992
|
-
url?: string;
|
|
2993
|
-
/** Terms and conditions text. */
|
|
2994
|
-
text?: string | null;
|
|
2995
|
-
}
|
|
2996
|
-
/** Privacy policy. */
|
|
2997
|
-
interface PrivacyPolicy extends PrivacyPolicyValueOneOf {
|
|
2998
|
-
/** Privacy policy URL. */
|
|
2999
|
-
url?: string;
|
|
3000
|
-
/** Privacy policy text. */
|
|
3001
|
-
text?: string | null;
|
|
3002
|
-
/**
|
|
3003
|
-
* Whether the privacy policy is shown to the customer.
|
|
3004
|
-
*
|
|
3005
|
-
* Default: `false`
|
|
3006
|
-
*/
|
|
3007
|
-
enabled?: boolean;
|
|
3008
|
-
}
|
|
3009
|
-
/** @oneof */
|
|
3010
|
-
interface PrivacyPolicyValueOneOf {
|
|
3011
|
-
/** Privacy policy URL. */
|
|
3012
|
-
url?: string;
|
|
3013
|
-
/** Privacy policy text. */
|
|
3014
|
-
text?: string | null;
|
|
3015
|
-
}
|
|
3016
|
-
/** Custom field definition. Definitions of the fields that are added to the reservation form. */
|
|
3017
|
-
interface CustomFieldDefinition {
|
|
3018
|
-
/**
|
|
3019
|
-
* Custom field ID.
|
|
3020
|
-
* @readonly
|
|
3021
|
-
*/
|
|
3022
|
-
_id?: string | null;
|
|
3023
|
-
/** Custom field name. */
|
|
3024
|
-
name?: string;
|
|
3025
|
-
/**
|
|
3026
|
-
* Whether the custom field is required.
|
|
3027
|
-
*
|
|
3028
|
-
* Default: `false`
|
|
3029
|
-
*/
|
|
3030
|
-
required?: boolean;
|
|
3031
|
-
}
|
|
3032
|
-
/** Email marketing checkbox. */
|
|
3033
|
-
interface EmailMarketingCheckbox {
|
|
3034
|
-
/**
|
|
3035
|
-
* Whether the checkbox is shown to the customer.
|
|
3036
|
-
*
|
|
3037
|
-
* Default: `false`
|
|
3038
|
-
*/
|
|
3039
|
-
enabled?: boolean;
|
|
3040
|
-
/**
|
|
3041
|
-
* Whether the checkbox is checked by default.
|
|
3042
|
-
*
|
|
3043
|
-
* Default: `false`
|
|
3044
|
-
*/
|
|
3045
|
-
checkedByDefault?: boolean;
|
|
3046
|
-
}
|
|
3047
|
-
interface OnlineReservations {
|
|
3048
|
-
/**
|
|
3049
|
-
* Seat pacing settings.
|
|
3050
|
-
*
|
|
3051
|
-
* The maximum number of seats that can be filled by new reservations within a 15-minute period.
|
|
3052
|
-
* For example, setting a seat pacing of 15 would mean that between `10:00.000`-`10:14.999` there will be no more than 15 new seats available for reservation.
|
|
3053
|
-
*/
|
|
3054
|
-
seatPacing?: SeatPacing;
|
|
3055
|
-
/**
|
|
3056
|
-
* Party pacing settings.
|
|
3057
|
-
*
|
|
3058
|
-
* The maximum number of party reservations that can start within a 15-minute period.
|
|
3059
|
-
* For example, a party pacing of 5 would mean that no more than 5 parties could make a reservation for the period between `10:00.000`-`10:14.999`.
|
|
3060
|
-
*/
|
|
3061
|
-
partyPacing?: PartyPacing;
|
|
3062
|
-
/** Party size limits for a reservation. */
|
|
3063
|
-
partySize?: PartySize;
|
|
3064
|
-
/**
|
|
3065
|
-
* Minimum reservation notice.
|
|
3066
|
-
*
|
|
3067
|
-
* The minimum amount of time that must be allowed between making a reservation and that reservation's start time.
|
|
3068
|
-
*/
|
|
3069
|
-
minimumReservationNotice?: NoticePeriod;
|
|
3070
|
-
/**
|
|
3071
|
-
* Default turnover time in minutes.
|
|
3072
|
-
*
|
|
3073
|
-
* Turnover time is how much time a party is allotted for their entire reservation - from being seated to leaving the restaurant.
|
|
3074
|
-
*/
|
|
3075
|
-
defaultTurnoverTime?: number | null;
|
|
3076
|
-
/**
|
|
3077
|
-
* Custom turnover time rules.
|
|
3078
|
-
*
|
|
3079
|
-
* This allows you to set different turnover times for different party sizes.
|
|
3080
|
-
*/
|
|
3081
|
-
turnoverTimeRules?: TurnoverTimeRule[];
|
|
3082
|
-
/**
|
|
3083
|
-
* The location's business schedule.
|
|
3084
|
-
*
|
|
3085
|
-
* By default, the business schedule of a reservation location uses the values of its location's business schedule. However, after the first time a reservation location's business schedule has been modified, it stores and uses its own values and no longer mirrors its location's business schedule.
|
|
3086
|
-
* Limited to 100 time periods.
|
|
3087
|
-
*/
|
|
3088
|
-
businessSchedule?: CommonBusinessSchedule;
|
|
3089
|
-
/** Whether a phone number is shown. */
|
|
3090
|
-
showPhoneNumber?: boolean | null;
|
|
3091
|
-
/** Whether online reservations are enabled. */
|
|
3092
|
-
onlineReservationsEnabled?: boolean | null;
|
|
3093
|
-
/** Manual approval settings. */
|
|
3094
|
-
manualApproval?: ManualApproval;
|
|
3095
|
-
/**
|
|
3096
|
-
* Interval between a reservation location's time slots in minutes.
|
|
3097
|
-
*
|
|
3098
|
-
* This controls the interval between time slots on a Wix site's Reservations page, and the interval between time slots returned by [getTimeSlots()](/time-slots/get-time-slots).
|
|
3099
|
-
*
|
|
3100
|
-
* Default: `15`
|
|
3101
|
-
*/
|
|
3102
|
-
timeSlotInterval?: number | null;
|
|
3103
|
-
}
|
|
3104
|
-
/** Reservation form settings. */
|
|
3105
|
-
interface ReservationForm {
|
|
3106
|
-
/** A message shown to the customer in the registration form. */
|
|
3107
|
-
submitMessage?: string | null;
|
|
3108
|
-
/** Whether to show policies (the terms and conditions, and the privacy policy) to the customer. */
|
|
3109
|
-
policiesEnabled?: boolean | null;
|
|
3110
|
-
/** Settings for displaying the terms and conditions. */
|
|
3111
|
-
termsAndConditions?: TermsAndConditions;
|
|
3112
|
-
/** Settings for displaying the privacy policy. */
|
|
3113
|
-
privacyPolicy?: PrivacyPolicy;
|
|
3114
|
-
/** Custom fields you wish to add to the registration form for the customer to fill in. */
|
|
3115
|
-
customFieldDefinitions?: CustomFieldDefinition[];
|
|
3116
|
-
/**
|
|
3117
|
-
* Whether a last_name is required in the reservation form.
|
|
3118
|
-
*
|
|
3119
|
-
* Default: `false`
|
|
3120
|
-
*/
|
|
3121
|
-
lastNameRequired?: boolean | null;
|
|
3122
|
-
/**
|
|
3123
|
-
* Whether an email is required in the reservation form.
|
|
3124
|
-
*
|
|
3125
|
-
* Default: `false`
|
|
3126
|
-
*/
|
|
3127
|
-
emailRequired?: boolean | null;
|
|
3128
|
-
/** Email marketing checkbox settings. */
|
|
3129
|
-
emailMarketingCheckbox?: EmailMarketingCheckbox;
|
|
3130
|
-
}
|
|
3131
|
-
/** My reservations field definition. */
|
|
3132
|
-
interface MyReservationsField {
|
|
3133
|
-
/** Field type. */
|
|
3134
|
-
fieldType?: FieldType;
|
|
3135
|
-
/**
|
|
3136
|
-
* Custom field ID.
|
|
3137
|
-
*
|
|
3138
|
-
* This should only be provided if the `fieldType` is `CUSTOM_FIELD`, in which case it is required and must match the ID of a custom field in the `customFieldDefinitions` array of the `reservationForm`.
|
|
3139
|
-
* @readonly
|
|
3140
|
-
*/
|
|
3141
|
-
customFieldId?: string | null;
|
|
3142
|
-
/** Whether the field is shown. */
|
|
3143
|
-
shown?: boolean;
|
|
3144
|
-
}
|
|
3145
|
-
interface TableManagement {
|
|
3146
|
-
/** Table definitions. */
|
|
3147
|
-
tableDefinitions?: TableDefinition[];
|
|
3148
|
-
/** Deleted table definitions. */
|
|
3149
|
-
deletedTableDefinitions?: TableDefinition[];
|
|
3150
|
-
/** Table combinations. */
|
|
3151
|
-
tableCombinations?: TableCombination[];
|
|
3152
|
-
}
|
|
3153
|
-
interface Location {
|
|
3154
|
-
/**
|
|
3155
|
-
* Location ID.
|
|
3156
|
-
* @readonly
|
|
3157
|
-
*/
|
|
3158
|
-
_id?: string | null;
|
|
3159
|
-
}
|
|
3160
|
-
interface Configuration {
|
|
3161
|
-
/** Settings for this location that are used to determine restaurant availability for reservations made online. */
|
|
3162
|
-
onlineReservations?: OnlineReservations;
|
|
3163
|
-
/** Reservation form settings. */
|
|
3164
|
-
reservationForm?: ReservationForm;
|
|
3165
|
-
/**
|
|
3166
|
-
* "My reservations" field details.
|
|
3167
|
-
*
|
|
3168
|
-
* These are the fields that appear in the "My reservations" section of the Table Reservations page on the restaurant's Wix site dashboard.
|
|
3169
|
-
*/
|
|
3170
|
-
myReservationsFields?: MyReservationsField[];
|
|
3171
|
-
/** Table management settings. */
|
|
3172
|
-
tableManagement?: TableManagement;
|
|
3173
|
-
}
|
|
3174
|
-
interface ExtendedFields {
|
|
3175
|
-
/**
|
|
3176
|
-
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
3177
|
-
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
3178
|
-
*
|
|
3179
|
-
* You can only access fields for which you have the appropriate permissions.
|
|
3180
|
-
*
|
|
3181
|
-
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
3182
|
-
*/
|
|
3183
|
-
namespaces?: Record<string, Record<string, any>>;
|
|
3184
|
-
}
|
|
3185
|
-
interface GetReservationLocationRequest {
|
|
3186
|
-
/** ID of the ReservationLocation to retrieve. */
|
|
3187
|
-
reservationLocationId: string;
|
|
3188
|
-
/**
|
|
3189
|
-
* Array of named, predefined sets of projected fields to be returned.
|
|
3190
|
-
*
|
|
3191
|
-
* Default: `PUBLIC`.
|
|
3192
|
-
*/
|
|
3193
|
-
fieldsets?: Set[];
|
|
3194
|
-
}
|
|
3195
|
-
declare enum Set {
|
|
3196
|
-
/**
|
|
3197
|
-
* Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
|
|
3198
|
-
* `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
|
|
3199
|
-
* `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
|
|
3200
|
-
* `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
|
|
3201
|
-
*/
|
|
3202
|
-
PUBLIC = "PUBLIC",
|
|
3203
|
-
/** - `FULL`: Returns all fields. */
|
|
3204
|
-
FULL = "FULL"
|
|
3205
|
-
}
|
|
3206
|
-
interface GetReservationLocationResponse {
|
|
3207
|
-
/** The retrieved reservation location. */
|
|
3208
|
-
reservationLocation?: ReservationLocation;
|
|
3209
|
-
}
|
|
3210
|
-
interface UpdateReservationLocationRequest {
|
|
3211
|
-
/** ReservationLocation to be updated, may be partial. */
|
|
3212
|
-
reservationLocation: ReservationLocation;
|
|
3213
|
-
}
|
|
3214
|
-
interface UpdateReservationLocationResponse {
|
|
3215
|
-
/** The updated reservation location. */
|
|
3216
|
-
reservationLocation?: ReservationLocation;
|
|
3217
|
-
}
|
|
3218
|
-
interface UpdateExtendedFieldsRequest {
|
|
3219
|
-
/** ID of the entity to update. */
|
|
3220
|
-
_id: string;
|
|
3221
|
-
/** Identifier for the app whose extended fields are being updated. */
|
|
3222
|
-
namespace: string;
|
|
3223
|
-
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
3224
|
-
namespaceData: Record<string, any> | null;
|
|
3225
|
-
}
|
|
3226
|
-
interface UpdateExtendedFieldsResponse {
|
|
3227
|
-
/** Updated reservation location. */
|
|
3228
|
-
reservationLocation?: ReservationLocation;
|
|
3229
|
-
}
|
|
3230
|
-
interface QueryReservationLocationsRequest {
|
|
3231
|
-
/** Query options. */
|
|
3232
|
-
query: QueryV2;
|
|
3233
|
-
/**
|
|
3234
|
-
* Array of named, predefined sets of projected fields to be returned.
|
|
3235
|
-
*
|
|
3236
|
-
* Default: `PUBLIC`.
|
|
3237
|
-
*/
|
|
3238
|
-
fieldsets?: Set[];
|
|
3239
|
-
}
|
|
3240
|
-
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
3241
|
-
/** Paging options to limit and skip the number of items. */
|
|
3242
|
-
paging?: Paging;
|
|
3243
|
-
/** 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`. */
|
|
3244
|
-
cursorPaging?: CursorPaging;
|
|
3245
|
-
/**
|
|
3246
|
-
* Filter object in the following format:
|
|
3247
|
-
* `"filter" : {
|
|
3248
|
-
* "fieldName1": "value1",
|
|
3249
|
-
* "fieldName2":{"$operator":"value2"}
|
|
3250
|
-
* }`
|
|
3251
|
-
*
|
|
3252
|
-
* For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/sorting-and-filtering) article.
|
|
3253
|
-
* To learn how to query reservations, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
|
|
3254
|
-
*/
|
|
3255
|
-
filter?: Record<string, any> | null;
|
|
3256
|
-
/**
|
|
3257
|
-
* Sort object in the following format:
|
|
3258
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
3259
|
-
*/
|
|
3260
|
-
sort?: Sorting[];
|
|
3261
|
-
}
|
|
3262
|
-
/** @oneof */
|
|
3263
|
-
interface QueryV2PagingMethodOneOf {
|
|
3264
|
-
/** Paging options to limit and skip the number of items. */
|
|
3265
|
-
paging?: Paging;
|
|
3266
|
-
/** 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`. */
|
|
3267
|
-
cursorPaging?: CursorPaging;
|
|
3268
|
-
}
|
|
3269
|
-
interface Sorting {
|
|
3270
|
-
/** Name of the field to sort by. */
|
|
3271
|
-
fieldName?: string;
|
|
3272
|
-
/**
|
|
3273
|
-
* Sort order.
|
|
3274
|
-
*
|
|
3275
|
-
* Defaults to `ASC`.
|
|
3276
|
-
*/
|
|
3277
|
-
order?: SortOrder;
|
|
3278
|
-
}
|
|
3279
|
-
declare enum SortOrder {
|
|
3280
|
-
/** Soer by ascending order. */
|
|
3281
|
-
ASC = "ASC",
|
|
3282
|
-
/** Sort by descending order. */
|
|
3283
|
-
DESC = "DESC"
|
|
3284
|
-
}
|
|
3285
|
-
interface Paging {
|
|
3286
|
-
/** Number of items to load. */
|
|
3287
|
-
limit?: number | null;
|
|
3288
|
-
/** Number of items to skip in the current sort order. */
|
|
3289
|
-
offset?: number | null;
|
|
3290
|
-
}
|
|
3291
|
-
interface CursorPaging {
|
|
3292
|
-
/** Number of items to load. */
|
|
3293
|
-
limit?: number | null;
|
|
3294
|
-
/**
|
|
3295
|
-
* Pointer to the next or previous page in the list of results.
|
|
3296
|
-
*
|
|
3297
|
-
* You can get the relevant cursor token
|
|
3298
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
3299
|
-
* Not relevant for the first request.
|
|
3300
|
-
*/
|
|
3301
|
-
cursor?: string | null;
|
|
3302
|
-
}
|
|
3303
|
-
interface QueryReservationLocationsResponse {
|
|
3304
|
-
/** List of reservation locations. */
|
|
3305
|
-
reservationLocations?: ReservationLocation[];
|
|
3306
|
-
/** Metadata for the paginated results. */
|
|
3307
|
-
pagingMetadata?: PagingMetadataV2;
|
|
3308
|
-
}
|
|
3309
|
-
interface PagingMetadataV2 {
|
|
3310
|
-
/** Offset that was requested. */
|
|
3311
|
-
offset?: number | null;
|
|
3312
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
3313
|
-
cursors?: Cursors;
|
|
3314
|
-
}
|
|
3315
|
-
interface Cursors {
|
|
3316
|
-
/** Cursor pointing to next page in the list of results. */
|
|
3317
|
-
next?: string | null;
|
|
3318
|
-
/** Cursor pointing to previous page in the list of results. */
|
|
3319
|
-
prev?: string | null;
|
|
3320
|
-
}
|
|
3321
|
-
interface ListReservationLocationsRequest {
|
|
3322
|
-
/** 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`. */
|
|
3323
|
-
paging?: CursorPaging;
|
|
3324
|
-
/** Sorting for the locations list. */
|
|
3325
|
-
sort?: Sorting;
|
|
3326
|
-
/**
|
|
3327
|
-
* Array of named, predefined sets of projected fields to be returned.
|
|
3328
|
-
*
|
|
3329
|
-
* Default: `PUBLIC`.
|
|
3330
|
-
*/
|
|
3331
|
-
fieldsets?: Set[];
|
|
3332
|
-
}
|
|
3333
|
-
interface ListReservationLocationsResponse {
|
|
3334
|
-
/** Locations list. */
|
|
3335
|
-
reservationLocations?: ReservationLocation[];
|
|
3336
|
-
/** Metadata for the paginated results. */
|
|
3337
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
3338
|
-
}
|
|
3339
|
-
interface CursorPagingMetadata {
|
|
3340
|
-
/** Number of items returned in the response. */
|
|
3341
|
-
count?: number | null;
|
|
3342
|
-
/** Offset that was requested. */
|
|
3343
|
-
cursors?: Cursors;
|
|
3344
|
-
/**
|
|
3345
|
-
* Indicates if there are more results after the current page.
|
|
3346
|
-
* If `true`, another page of results can be retrieved.
|
|
3347
|
-
* If `false`, this is the last page.
|
|
3348
|
-
*/
|
|
3349
|
-
hasNext?: boolean | null;
|
|
3350
|
-
}
|
|
3351
|
-
interface StreetAddressNonNullableFields {
|
|
3352
|
-
number: string;
|
|
3353
|
-
name: string;
|
|
3354
|
-
apt: string;
|
|
3355
|
-
}
|
|
3356
|
-
interface LocationAddressNonNullableFields {
|
|
3357
|
-
streetAddress?: StreetAddressNonNullableFields;
|
|
3358
|
-
}
|
|
3359
|
-
interface CommonTimePeriodNonNullableFields {
|
|
3360
|
-
openDay: CommonDayOfWeek;
|
|
3361
|
-
openTime: string;
|
|
3362
|
-
closeDay: CommonDayOfWeek;
|
|
3363
|
-
closeTime: string;
|
|
3364
|
-
}
|
|
3365
|
-
interface CommonSpecialHourPeriodNonNullableFields {
|
|
3366
|
-
startDate: string;
|
|
3367
|
-
endDate: string;
|
|
3368
|
-
isClosed: boolean;
|
|
3369
|
-
comment: string;
|
|
3370
|
-
}
|
|
3371
|
-
interface CommonBusinessScheduleNonNullableFields {
|
|
3372
|
-
periods: CommonTimePeriodNonNullableFields[];
|
|
3373
|
-
specialHourPeriod: CommonSpecialHourPeriodNonNullableFields[];
|
|
3374
|
-
}
|
|
3375
|
-
interface LocationNonNullableFields {
|
|
3376
|
-
address?: LocationAddressNonNullableFields;
|
|
3377
|
-
businessSchedule?: CommonBusinessScheduleNonNullableFields;
|
|
3378
|
-
}
|
|
3379
|
-
interface ApprovalNonNullableFields {
|
|
3380
|
-
mode: ApprovalMode;
|
|
3381
|
-
}
|
|
3382
|
-
interface SeatPacingNonNullableFields {
|
|
3383
|
-
number: number;
|
|
3384
|
-
enabled: boolean;
|
|
3385
|
-
}
|
|
3386
|
-
interface PartyPacingNonNullableFields {
|
|
3387
|
-
number: number;
|
|
3388
|
-
enabled: boolean;
|
|
3389
|
-
}
|
|
3390
|
-
interface PartiesSizeNonNullableFields {
|
|
3391
|
-
min: number;
|
|
3392
|
-
max: number;
|
|
3393
|
-
}
|
|
3394
|
-
interface PartySizeNonNullableFields {
|
|
3395
|
-
min: number;
|
|
3396
|
-
max: number;
|
|
3397
|
-
}
|
|
3398
|
-
interface NoticePeriodNonNullableFields {
|
|
3399
|
-
number: number;
|
|
3400
|
-
unit: Unit;
|
|
3401
|
-
}
|
|
3402
|
-
interface TurnoverTimeRuleNonNullableFields {
|
|
3403
|
-
seatsMin: number;
|
|
3404
|
-
seatsMax: number;
|
|
3405
|
-
minutes: number;
|
|
3406
|
-
}
|
|
3407
|
-
interface TurnoverRuleNonNullableFields {
|
|
3408
|
-
minSeats: number;
|
|
3409
|
-
maxSeats: number;
|
|
3410
|
-
minutes: number;
|
|
3411
|
-
}
|
|
3412
|
-
interface ManualApprovalNonNullableFields {
|
|
3413
|
-
partySizeThreshold: number;
|
|
3414
|
-
enabled: boolean;
|
|
3415
|
-
}
|
|
3416
|
-
interface OnlineReservationsNonNullableFields {
|
|
3417
|
-
approval?: ApprovalNonNullableFields;
|
|
3418
|
-
seatPacing?: SeatPacingNonNullableFields;
|
|
3419
|
-
partyPacing?: PartyPacingNonNullableFields;
|
|
3420
|
-
partiesSize?: PartiesSizeNonNullableFields;
|
|
3421
|
-
partySize?: PartySizeNonNullableFields;
|
|
3422
|
-
minimumReservationNotice?: NoticePeriodNonNullableFields;
|
|
3423
|
-
turnoverTimeRules: TurnoverTimeRuleNonNullableFields[];
|
|
3424
|
-
turnoverRules: TurnoverRuleNonNullableFields[];
|
|
3425
|
-
businessSchedule?: CommonBusinessScheduleNonNullableFields;
|
|
3426
|
-
manualApproval?: ManualApprovalNonNullableFields;
|
|
3427
|
-
}
|
|
3428
|
-
interface TermsAndConditionsNonNullableFields {
|
|
3429
|
-
url: string;
|
|
3430
|
-
enabled: boolean;
|
|
3431
|
-
}
|
|
3432
|
-
interface PrivacyPolicyNonNullableFields {
|
|
3433
|
-
url: string;
|
|
3434
|
-
enabled: boolean;
|
|
3435
|
-
}
|
|
3436
|
-
interface CustomFieldDefinitionNonNullableFields {
|
|
3437
|
-
name: string;
|
|
3438
|
-
required: boolean;
|
|
3439
|
-
}
|
|
3440
|
-
interface EmailMarketingCheckboxNonNullableFields {
|
|
3441
|
-
enabled: boolean;
|
|
3442
|
-
checkedByDefault: boolean;
|
|
3443
|
-
}
|
|
3444
|
-
interface ReservationFormNonNullableFields {
|
|
3445
|
-
termsAndConditions?: TermsAndConditionsNonNullableFields;
|
|
3446
|
-
privacyPolicy?: PrivacyPolicyNonNullableFields;
|
|
3447
|
-
customFieldDefinitions: CustomFieldDefinitionNonNullableFields[];
|
|
3448
|
-
emailMarketingCheckbox?: EmailMarketingCheckboxNonNullableFields;
|
|
3449
|
-
}
|
|
3450
|
-
interface MyReservationsFieldNonNullableFields {
|
|
3451
|
-
fieldType: FieldType;
|
|
3452
|
-
shown: boolean;
|
|
3453
|
-
}
|
|
3454
|
-
interface TableDefinitionNonNullableFields {
|
|
3455
|
-
name: string;
|
|
3456
|
-
seatsMin: number;
|
|
3457
|
-
seatsMax: number;
|
|
3458
|
-
}
|
|
3459
|
-
interface TableCombinationNonNullableFields {
|
|
3460
|
-
seatsMin: number;
|
|
3461
|
-
seatsMax: number;
|
|
3462
|
-
}
|
|
3463
|
-
interface TableManagementNonNullableFields {
|
|
3464
|
-
mode: Value;
|
|
3465
|
-
tableDefinitions: TableDefinitionNonNullableFields[];
|
|
3466
|
-
deletedTableDefinitions: TableDefinitionNonNullableFields[];
|
|
3467
|
-
tableCombinations: TableCombinationNonNullableFields[];
|
|
3468
|
-
}
|
|
3469
|
-
interface ReservationPaymentNonNullableFields {
|
|
3470
|
-
value: string;
|
|
3471
|
-
minPartySize: number;
|
|
3472
|
-
}
|
|
3473
|
-
interface ConfigurationNonNullableFields {
|
|
3474
|
-
onlineReservations?: OnlineReservationsNonNullableFields;
|
|
3475
|
-
reservationForm?: ReservationFormNonNullableFields;
|
|
3476
|
-
myReservationsFields: MyReservationsFieldNonNullableFields[];
|
|
3477
|
-
tableManagement?: TableManagementNonNullableFields;
|
|
3478
|
-
reservationPayment?: ReservationPaymentNonNullableFields;
|
|
3479
|
-
}
|
|
3480
|
-
interface ReservationLocationNonNullableFields {
|
|
3481
|
-
location?: LocationNonNullableFields;
|
|
3482
|
-
configuration?: ConfigurationNonNullableFields;
|
|
3483
|
-
}
|
|
3484
|
-
interface GetReservationLocationResponseNonNullableFields {
|
|
3485
|
-
reservationLocation?: ReservationLocationNonNullableFields;
|
|
3486
|
-
}
|
|
3487
|
-
interface UpdateReservationLocationResponseNonNullableFields {
|
|
3488
|
-
reservationLocation?: ReservationLocationNonNullableFields;
|
|
3489
|
-
}
|
|
3490
|
-
interface UpdateExtendedFieldsResponseNonNullableFields {
|
|
3491
|
-
reservationLocation?: ReservationLocationNonNullableFields;
|
|
3492
|
-
}
|
|
3493
|
-
interface QueryReservationLocationsResponseNonNullableFields {
|
|
3494
|
-
reservationLocations: ReservationLocationNonNullableFields[];
|
|
3495
|
-
}
|
|
3496
|
-
interface ListReservationLocationsResponseNonNullableFields {
|
|
3497
|
-
reservationLocations: ReservationLocationNonNullableFields[];
|
|
3498
|
-
}
|
|
3499
|
-
|
|
3500
|
-
type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
3501
|
-
getUrl: (context: any) => string;
|
|
3502
|
-
httpMethod: K;
|
|
3503
|
-
path: string;
|
|
3504
|
-
pathParams: M;
|
|
3505
|
-
__requestType: T;
|
|
3506
|
-
__originalRequestType: S;
|
|
3507
|
-
__responseType: Q;
|
|
3508
|
-
__originalResponseType: R;
|
|
3509
|
-
};
|
|
3510
|
-
declare function getReservationLocation(): __PublicMethodMetaInfo$1<'GET', {
|
|
3511
|
-
reservationLocationId: string;
|
|
3512
|
-
}, GetReservationLocationRequest, GetReservationLocationRequest$1, GetReservationLocationResponse & GetReservationLocationResponseNonNullableFields, GetReservationLocationResponse$1 & GetReservationLocationResponseNonNullableFields$1>;
|
|
3513
|
-
declare function updateReservationLocation(): __PublicMethodMetaInfo$1<'PATCH', {
|
|
3514
|
-
reservationLocationId: string;
|
|
3515
|
-
}, UpdateReservationLocationRequest, UpdateReservationLocationRequest$1, UpdateReservationLocationResponse & UpdateReservationLocationResponseNonNullableFields, UpdateReservationLocationResponse$1 & UpdateReservationLocationResponseNonNullableFields$1>;
|
|
3516
|
-
declare function updateExtendedFields(): __PublicMethodMetaInfo$1<'POST', {
|
|
3517
|
-
id: string;
|
|
3518
|
-
}, UpdateExtendedFieldsRequest, UpdateExtendedFieldsRequest$1, UpdateExtendedFieldsResponse & UpdateExtendedFieldsResponseNonNullableFields, UpdateExtendedFieldsResponse$1 & UpdateExtendedFieldsResponseNonNullableFields$1>;
|
|
3519
|
-
declare function queryReservationLocations(): __PublicMethodMetaInfo$1<'POST', {}, QueryReservationLocationsRequest, QueryReservationLocationsRequest$1, QueryReservationLocationsResponse & QueryReservationLocationsResponseNonNullableFields, QueryReservationLocationsResponse$1 & QueryReservationLocationsResponseNonNullableFields$1>;
|
|
3520
|
-
declare function listReservationLocations(): __PublicMethodMetaInfo$1<'GET', {}, ListReservationLocationsRequest, ListReservationLocationsRequest$1, ListReservationLocationsResponse & ListReservationLocationsResponseNonNullableFields, ListReservationLocationsResponse$1 & ListReservationLocationsResponseNonNullableFields$1>;
|
|
3521
|
-
|
|
3522
|
-
declare const meta$1_getReservationLocation: typeof getReservationLocation;
|
|
3523
|
-
declare const meta$1_listReservationLocations: typeof listReservationLocations;
|
|
3524
|
-
declare const meta$1_queryReservationLocations: typeof queryReservationLocations;
|
|
3525
|
-
declare const meta$1_updateExtendedFields: typeof updateExtendedFields;
|
|
3526
|
-
declare const meta$1_updateReservationLocation: typeof updateReservationLocation;
|
|
3527
|
-
declare namespace meta$1 {
|
|
3528
|
-
export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_getReservationLocation as getReservationLocation, meta$1_listReservationLocations as listReservationLocations, meta$1_queryReservationLocations as queryReservationLocations, meta$1_updateExtendedFields as updateExtendedFields, meta$1_updateReservationLocation as updateReservationLocation };
|
|
3529
|
-
}
|
|
3530
|
-
|
|
3531
|
-
interface TimeSlot$1 {
|
|
3532
|
-
/** Start date and time of this time slot. */
|
|
3533
|
-
startDate?: Date | null;
|
|
3534
|
-
/** Duration in minutes of this time slot. */
|
|
3535
|
-
duration?: number;
|
|
3536
|
-
/** Availability status of this time slot. */
|
|
3537
|
-
status?: Status$1;
|
|
3538
|
-
/** Whether manual approval is required to make a reservation in this time slot. */
|
|
3539
|
-
manualApproval?: boolean | null;
|
|
3540
|
-
}
|
|
3541
|
-
declare enum Status$1 {
|
|
3542
|
-
/** The restaurant can accommodate a party of the given size in this time slot. */
|
|
3543
|
-
AVAILABLE = "AVAILABLE",
|
|
3544
|
-
/** The restaurant can't accommodate a party of the given size in this time slot. */
|
|
3545
|
-
UNAVAILABLE = "UNAVAILABLE",
|
|
3546
|
-
/** The restaurant is not open during this time slot. */
|
|
3547
|
-
NON_WORKING_HOURS = "NON_WORKING_HOURS"
|
|
3548
|
-
}
|
|
3549
|
-
interface GetTimeSlotsRequest$1 {
|
|
3550
|
-
/** ID of the reservation location for which to retrieve time slots. */
|
|
3551
|
-
reservationLocationId: string;
|
|
3552
|
-
/** Date and time for which to retrieve a time slot in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#coordinated_Universal_Time_(UTC)) format. */
|
|
3553
|
-
date: Date | null;
|
|
3554
|
-
/**
|
|
3555
|
-
* Duration in minutes of the time slot.
|
|
3556
|
-
*
|
|
3557
|
-
* Min: `5`
|
|
3558
|
-
*/
|
|
3559
|
-
duration?: number | null;
|
|
3560
|
-
/**
|
|
3561
|
-
* Size of the party that needs to be seated during this time slot.
|
|
3562
|
-
*
|
|
3563
|
-
* Min: `1`
|
|
3564
|
-
*/
|
|
3565
|
-
partySize: number | null;
|
|
3566
|
-
/** The number of time slots to retrieve before the specified `date`. */
|
|
3567
|
-
slotsBefore?: number | null;
|
|
3568
|
-
/** The number of time slots to retrieve after the specified `date`. */
|
|
3569
|
-
slotsAfter?: number | null;
|
|
3570
|
-
}
|
|
3571
|
-
interface GetTimeSlotsResponse$1 {
|
|
3572
|
-
/** A list of time slots and their availability according to the specified party size. */
|
|
3573
|
-
timeSlots?: TimeSlot$1[];
|
|
3574
|
-
}
|
|
3575
|
-
declare enum TableCombinationConflictType$1 {
|
|
3576
|
-
/** Undefined conflict type. */
|
|
3577
|
-
UNKNOWN = "UNKNOWN",
|
|
3578
|
-
/** One or more of the chosen tables are already reserved. */
|
|
3579
|
-
RESERVED = "RESERVED",
|
|
3580
|
-
/** The party is too big for the selected table. */
|
|
3581
|
-
TOO_BIG = "TOO_BIG",
|
|
3582
|
-
/** The party is too small for the selected table. */
|
|
3583
|
-
TOO_SMALL = "TOO_SMALL",
|
|
3584
|
-
/** The restaurant does not allow online reservations. */
|
|
3585
|
-
OFFLINE_ONLY = "OFFLINE_ONLY"
|
|
3586
|
-
}
|
|
3587
|
-
declare enum Type$1 {
|
|
3588
|
-
/** Undefined reservation location conflict type. */
|
|
3589
|
-
UNKNOWN = "UNKNOWN",
|
|
3590
|
-
/** The restaurant cannot accommodate a party of the given size according to party pacing settings. */
|
|
3591
|
-
PARTY_PACING = "PARTY_PACING",
|
|
3592
|
-
/** The required number of seats are unavailable according to seat pacing settings. */
|
|
3593
|
-
SEAT_PACING = "SEAT_PACING"
|
|
3594
|
-
}
|
|
3595
|
-
interface CheckTimeSlotRequest$1 {
|
|
3596
|
-
/** ID of the reservation location for which to check the time slot. */
|
|
3597
|
-
reservationLocationId: string;
|
|
3598
|
-
/** Date and time of the time slot to check. */
|
|
3599
|
-
date: Date | null;
|
|
3600
|
-
/**
|
|
3601
|
-
* Duration of the time slot in minutes .
|
|
3602
|
-
*
|
|
3603
|
-
* Min: `5`
|
|
3604
|
-
*/
|
|
3605
|
-
duration: number | null;
|
|
3606
|
-
/** Party size to check the restaurant's availability for. */
|
|
3607
|
-
partySize: number | null;
|
|
3608
|
-
/**
|
|
3609
|
-
* ID of a reservation to ignore during the check.
|
|
3610
|
-
*
|
|
3611
|
-
* Use this when rescheduling a reservation to exclude it in its current state from the availability calculations.
|
|
3612
|
-
*/
|
|
3613
|
-
excludeReservationId?: string | null;
|
|
3614
|
-
}
|
|
3615
|
-
interface CheckTimeSlotResponse$1 {
|
|
3616
|
-
/** Table combinations and their availability information. */
|
|
3617
|
-
tableCombinationAvailabilities?: TableCombinationAvailability$1[];
|
|
3618
|
-
/** Reservation location conflicts that would occur by making a reservation for the specified party size in the specified time slot. */
|
|
3619
|
-
reservationLocationConflicts?: Type$1[];
|
|
3620
|
-
}
|
|
3621
|
-
interface TableCombinationAvailability$1 {
|
|
3622
|
-
/** IDs of the tables in the table combination. */
|
|
3623
|
-
tableIds?: string[];
|
|
3624
|
-
/** Conflicts that would be generated by attempting to accommodate the proposed reservation using the table combination. */
|
|
3625
|
-
tableCombinationConflicts?: TableCombinationConflictType$1[];
|
|
3626
|
-
}
|
|
3627
|
-
interface TimeSlotTableCombinationNonNullableFields$1 {
|
|
3628
|
-
tableIds: string[];
|
|
3629
|
-
}
|
|
3630
|
-
interface TimeSlotNonNullableFields$1 {
|
|
3631
|
-
duration: number;
|
|
3632
|
-
status: Status$1;
|
|
3633
|
-
tableCombinations: TimeSlotTableCombinationNonNullableFields$1[];
|
|
3634
|
-
}
|
|
3635
|
-
interface GetTimeSlotsResponseNonNullableFields$1 {
|
|
3636
|
-
timeSlots: TimeSlotNonNullableFields$1[];
|
|
3637
|
-
}
|
|
3638
|
-
interface TableCombinationAvailabilityNonNullableFields$1 {
|
|
3639
|
-
tableIds: string[];
|
|
3640
|
-
tableCombinationConflicts: TableCombinationConflictType$1[];
|
|
3641
|
-
}
|
|
3642
|
-
interface CheckTimeSlotResponseNonNullableFields$1 {
|
|
3643
|
-
tableCombinationAvailabilities: TableCombinationAvailabilityNonNullableFields$1[];
|
|
3644
|
-
reservationLocationConflicts: Type$1[];
|
|
3645
|
-
}
|
|
3646
|
-
|
|
3647
|
-
interface TimeSlot {
|
|
3648
|
-
/** Start date and time of this time slot. */
|
|
3649
|
-
startDate?: Date | null;
|
|
3650
|
-
/** Duration in minutes of this time slot. */
|
|
3651
|
-
duration?: number;
|
|
3652
|
-
/** Availability status of this time slot. */
|
|
3653
|
-
status?: Status;
|
|
3654
|
-
/** Whether manual approval is required to make a reservation in this time slot. */
|
|
3655
|
-
manualApproval?: boolean | null;
|
|
3656
|
-
}
|
|
3657
|
-
declare enum Status {
|
|
3658
|
-
/** The restaurant can accommodate a party of the given size in this time slot. */
|
|
3659
|
-
AVAILABLE = "AVAILABLE",
|
|
3660
|
-
/** The restaurant can't accommodate a party of the given size in this time slot. */
|
|
3661
|
-
UNAVAILABLE = "UNAVAILABLE",
|
|
3662
|
-
/** The restaurant is not open during this time slot. */
|
|
3663
|
-
NON_WORKING_HOURS = "NON_WORKING_HOURS"
|
|
3664
|
-
}
|
|
3665
|
-
interface GetTimeSlotsRequest {
|
|
3666
|
-
/** ID of the reservation location for which to retrieve time slots. */
|
|
3667
|
-
reservationLocationId: string;
|
|
3668
|
-
/** Date and time for which to retrieve a time slot in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#coordinated_Universal_Time_(UTC)) format. */
|
|
3669
|
-
date: Date | null;
|
|
3670
|
-
/**
|
|
3671
|
-
* Duration in minutes of the time slot.
|
|
3672
|
-
*
|
|
3673
|
-
* Min: `5`
|
|
3674
|
-
*/
|
|
3675
|
-
duration?: number | null;
|
|
3676
|
-
/**
|
|
3677
|
-
* Size of the party that needs to be seated during this time slot.
|
|
3678
|
-
*
|
|
3679
|
-
* Min: `1`
|
|
3680
|
-
*/
|
|
3681
|
-
partySize: number | null;
|
|
3682
|
-
/** The number of time slots to retrieve before the specified `date`. */
|
|
3683
|
-
slotsBefore?: number | null;
|
|
3684
|
-
/** The number of time slots to retrieve after the specified `date`. */
|
|
3685
|
-
slotsAfter?: number | null;
|
|
3686
|
-
}
|
|
3687
|
-
interface GetTimeSlotsResponse {
|
|
3688
|
-
/** A list of time slots and their availability according to the specified party size. */
|
|
3689
|
-
timeSlots?: TimeSlot[];
|
|
3690
|
-
}
|
|
3691
|
-
declare enum TableCombinationConflictType {
|
|
3692
|
-
/** Undefined conflict type. */
|
|
3693
|
-
UNKNOWN = "UNKNOWN",
|
|
3694
|
-
/** One or more of the chosen tables are already reserved. */
|
|
3695
|
-
RESERVED = "RESERVED",
|
|
3696
|
-
/** The party is too big for the selected table. */
|
|
3697
|
-
TOO_BIG = "TOO_BIG",
|
|
3698
|
-
/** The party is too small for the selected table. */
|
|
3699
|
-
TOO_SMALL = "TOO_SMALL",
|
|
3700
|
-
/** The restaurant does not allow online reservations. */
|
|
3701
|
-
OFFLINE_ONLY = "OFFLINE_ONLY"
|
|
3702
|
-
}
|
|
3703
|
-
declare enum Type {
|
|
3704
|
-
/** Undefined reservation location conflict type. */
|
|
3705
|
-
UNKNOWN = "UNKNOWN",
|
|
3706
|
-
/** The restaurant cannot accommodate a party of the given size according to party pacing settings. */
|
|
3707
|
-
PARTY_PACING = "PARTY_PACING",
|
|
3708
|
-
/** The required number of seats are unavailable according to seat pacing settings. */
|
|
3709
|
-
SEAT_PACING = "SEAT_PACING"
|
|
3710
|
-
}
|
|
3711
|
-
interface CheckTimeSlotRequest {
|
|
3712
|
-
/** ID of the reservation location for which to check the time slot. */
|
|
3713
|
-
reservationLocationId: string;
|
|
3714
|
-
/** Date and time of the time slot to check. */
|
|
3715
|
-
date: Date | null;
|
|
3716
|
-
/**
|
|
3717
|
-
* Duration of the time slot in minutes .
|
|
3718
|
-
*
|
|
3719
|
-
* Min: `5`
|
|
3720
|
-
*/
|
|
3721
|
-
duration: number | null;
|
|
3722
|
-
/** Party size to check the restaurant's availability for. */
|
|
3723
|
-
partySize: number | null;
|
|
3724
|
-
/**
|
|
3725
|
-
* ID of a reservation to ignore during the check.
|
|
3726
|
-
*
|
|
3727
|
-
* Use this when rescheduling a reservation to exclude it in its current state from the availability calculations.
|
|
3728
|
-
*/
|
|
3729
|
-
excludeReservationId?: string | null;
|
|
3730
|
-
}
|
|
3731
|
-
interface CheckTimeSlotResponse {
|
|
3732
|
-
/** Table combinations and their availability information. */
|
|
3733
|
-
tableCombinationAvailabilities?: TableCombinationAvailability[];
|
|
3734
|
-
/** Reservation location conflicts that would occur by making a reservation for the specified party size in the specified time slot. */
|
|
3735
|
-
reservationLocationConflicts?: Type[];
|
|
3736
|
-
}
|
|
3737
|
-
interface TableCombinationAvailability {
|
|
3738
|
-
/** IDs of the tables in the table combination. */
|
|
3739
|
-
tableIds?: string[];
|
|
3740
|
-
/** Conflicts that would be generated by attempting to accommodate the proposed reservation using the table combination. */
|
|
3741
|
-
tableCombinationConflicts?: TableCombinationConflictType[];
|
|
3742
|
-
}
|
|
3743
|
-
interface TimeSlotTableCombinationNonNullableFields {
|
|
3744
|
-
tableIds: string[];
|
|
3745
|
-
}
|
|
3746
|
-
interface TimeSlotNonNullableFields {
|
|
3747
|
-
duration: number;
|
|
3748
|
-
status: Status;
|
|
3749
|
-
tableCombinations: TimeSlotTableCombinationNonNullableFields[];
|
|
3750
|
-
}
|
|
3751
|
-
interface GetTimeSlotsResponseNonNullableFields {
|
|
3752
|
-
timeSlots: TimeSlotNonNullableFields[];
|
|
3753
|
-
}
|
|
3754
|
-
interface TableCombinationAvailabilityNonNullableFields {
|
|
3755
|
-
tableIds: string[];
|
|
3756
|
-
tableCombinationConflicts: TableCombinationConflictType[];
|
|
3757
|
-
}
|
|
3758
|
-
interface CheckTimeSlotResponseNonNullableFields {
|
|
3759
|
-
tableCombinationAvailabilities: TableCombinationAvailabilityNonNullableFields[];
|
|
3760
|
-
reservationLocationConflicts: Type[];
|
|
3761
|
-
}
|
|
3762
|
-
|
|
3763
|
-
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
3764
|
-
getUrl: (context: any) => string;
|
|
3765
|
-
httpMethod: K;
|
|
3766
|
-
path: string;
|
|
3767
|
-
pathParams: M;
|
|
3768
|
-
__requestType: T;
|
|
3769
|
-
__originalRequestType: S;
|
|
3770
|
-
__responseType: Q;
|
|
3771
|
-
__originalResponseType: R;
|
|
3772
|
-
};
|
|
3773
|
-
declare function getTimeSlots(): __PublicMethodMetaInfo<'POST', {}, GetTimeSlotsRequest, GetTimeSlotsRequest$1, GetTimeSlotsResponse & GetTimeSlotsResponseNonNullableFields, GetTimeSlotsResponse$1 & GetTimeSlotsResponseNonNullableFields$1>;
|
|
3774
|
-
declare function checkTimeSlot(): __PublicMethodMetaInfo<'POST', {}, CheckTimeSlotRequest, CheckTimeSlotRequest$1, CheckTimeSlotResponse & CheckTimeSlotResponseNonNullableFields, CheckTimeSlotResponse$1 & CheckTimeSlotResponseNonNullableFields$1>;
|
|
3775
|
-
|
|
3776
|
-
type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
|
|
3777
|
-
declare const meta_checkTimeSlot: typeof checkTimeSlot;
|
|
3778
|
-
declare const meta_getTimeSlots: typeof getTimeSlots;
|
|
3779
|
-
declare namespace meta {
|
|
3780
|
-
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_checkTimeSlot as checkTimeSlot, meta_getTimeSlots as getTimeSlots };
|
|
3781
|
-
}
|
|
3782
|
-
|
|
3783
|
-
export { meta$1 as reservationLocations, meta$2 as reservations, meta as timeSlots };
|