@wix/table-reservations 1.0.77 → 1.0.79
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/context.d.ts +3 -3
- package/build/cjs/context.js +3 -3
- package/build/cjs/context.js.map +1 -1
- package/build/cjs/index.d.ts +3 -3
- package/build/cjs/index.js +3 -3
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +3 -3
- package/build/cjs/meta.js +3 -3
- package/build/cjs/meta.js.map +1 -1
- package/build/es/context.d.ts +3 -3
- package/build/es/context.js +3 -3
- package/build/es/context.js.map +1 -1
- package/build/es/index.d.ts +3 -3
- package/build/es/index.js +3 -3
- package/build/es/index.js.map +1 -1
- package/build/es/meta.d.ts +3 -3
- package/build/es/meta.js +3 -3
- package/build/es/meta.js.map +1 -1
- package/package.json +13 -9
- package/build/cjs/index.typings.d.ts +0 -3
- package/build/cjs/index.typings.js +0 -30
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/src/table-reservations-v1-reservation-location.context.d.ts +0 -6
- package/build/cjs/src/table-reservations-v1-reservation-location.context.js +0 -73
- package/build/cjs/src/table-reservations-v1-reservation-location.context.js.map +0 -1
- package/build/cjs/src/table-reservations-v1-reservation-location.http.d.ts +0 -40
- package/build/cjs/src/table-reservations-v1-reservation-location.http.js +0 -266
- package/build/cjs/src/table-reservations-v1-reservation-location.http.js.map +0 -1
- package/build/cjs/src/table-reservations-v1-reservation-location.meta.d.ts +0 -20
- package/build/cjs/src/table-reservations-v1-reservation-location.meta.js +0 -106
- package/build/cjs/src/table-reservations-v1-reservation-location.meta.js.map +0 -1
- package/build/cjs/src/table-reservations-v1-reservation-location.public.d.ts +0 -178
- package/build/cjs/src/table-reservations-v1-reservation-location.public.js +0 -48
- package/build/cjs/src/table-reservations-v1-reservation-location.public.js.map +0 -1
- package/build/cjs/src/table-reservations-v1-reservation-location.types.d.ts +0 -2260
- package/build/cjs/src/table-reservations-v1-reservation-location.types.js +0 -187
- package/build/cjs/src/table-reservations-v1-reservation-location.types.js.map +0 -1
- package/build/cjs/src/table-reservations-v1-reservation-location.universal.d.ts +0 -2333
- package/build/cjs/src/table-reservations-v1-reservation-location.universal.js +0 -613
- package/build/cjs/src/table-reservations-v1-reservation-location.universal.js.map +0 -1
- package/build/cjs/src/table-reservations-v1-reservation.context.d.ts +0 -11
- package/build/cjs/src/table-reservations-v1-reservation.context.js +0 -158
- package/build/cjs/src/table-reservations-v1-reservation.context.js.map +0 -1
- package/build/cjs/src/table-reservations-v1-reservation.http.d.ts +0 -89
- package/build/cjs/src/table-reservations-v1-reservation.http.js +0 -508
- package/build/cjs/src/table-reservations-v1-reservation.http.js.map +0 -1
- package/build/cjs/src/table-reservations-v1-reservation.meta.d.ts +0 -29
- package/build/cjs/src/table-reservations-v1-reservation.meta.js +0 -199
- package/build/cjs/src/table-reservations-v1-reservation.meta.js.map +0 -1
- package/build/cjs/src/table-reservations-v1-reservation.public.d.ts +0 -26
- package/build/cjs/src/table-reservations-v1-reservation.public.js +0 -78
- package/build/cjs/src/table-reservations-v1-reservation.public.js.map +0 -1
- package/build/cjs/src/table-reservations-v1-reservation.types.d.ts +0 -976
- package/build/cjs/src/table-reservations-v1-reservation.types.js +0 -119
- package/build/cjs/src/table-reservations-v1-reservation.types.js.map +0 -1
- package/build/cjs/src/table-reservations-v1-reservation.universal.d.ts +0 -1382
- package/build/cjs/src/table-reservations-v1-reservation.universal.js +0 -872
- package/build/cjs/src/table-reservations-v1-reservation.universal.js.map +0 -1
- package/build/cjs/src/table-reservations-v1-time-slot.context.d.ts +0 -3
- package/build/cjs/src/table-reservations-v1-time-slot.context.js +0 -22
- package/build/cjs/src/table-reservations-v1-time-slot.context.js.map +0 -1
- package/build/cjs/src/table-reservations-v1-time-slot.http.d.ts +0 -13
- package/build/cjs/src/table-reservations-v1-time-slot.http.js +0 -126
- package/build/cjs/src/table-reservations-v1-time-slot.http.js.map +0 -1
- package/build/cjs/src/table-reservations-v1-time-slot.meta.d.ts +0 -13
- package/build/cjs/src/table-reservations-v1-time-slot.meta.js +0 -47
- package/build/cjs/src/table-reservations-v1-time-slot.meta.js.map +0 -1
- package/build/cjs/src/table-reservations-v1-time-slot.public.d.ts +0 -8
- package/build/cjs/src/table-reservations-v1-time-slot.public.js +0 -17
- package/build/cjs/src/table-reservations-v1-time-slot.public.js.map +0 -1
- package/build/cjs/src/table-reservations-v1-time-slot.types.d.ts +0 -137
- package/build/cjs/src/table-reservations-v1-time-slot.types.js +0 -32
- package/build/cjs/src/table-reservations-v1-time-slot.types.js.map +0 -1
- package/build/cjs/src/table-reservations-v1-time-slot.universal.d.ts +0 -178
- package/build/cjs/src/table-reservations-v1-time-slot.universal.js +0 -166
- package/build/cjs/src/table-reservations-v1-time-slot.universal.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -3
- package/build/es/index.typings.js +0 -4
- package/build/es/index.typings.js.map +0 -1
- package/build/es/src/table-reservations-v1-reservation-location.context.d.ts +0 -6
- package/build/es/src/table-reservations-v1-reservation-location.context.js +0 -66
- package/build/es/src/table-reservations-v1-reservation-location.context.js.map +0 -1
- package/build/es/src/table-reservations-v1-reservation-location.http.d.ts +0 -40
- package/build/es/src/table-reservations-v1-reservation-location.http.js +0 -259
- package/build/es/src/table-reservations-v1-reservation-location.http.js.map +0 -1
- package/build/es/src/table-reservations-v1-reservation-location.meta.d.ts +0 -20
- package/build/es/src/table-reservations-v1-reservation-location.meta.js +0 -76
- package/build/es/src/table-reservations-v1-reservation-location.meta.js.map +0 -1
- package/build/es/src/table-reservations-v1-reservation-location.public.d.ts +0 -178
- package/build/es/src/table-reservations-v1-reservation-location.public.js +0 -25
- package/build/es/src/table-reservations-v1-reservation-location.public.js.map +0 -1
- package/build/es/src/table-reservations-v1-reservation-location.types.d.ts +0 -2260
- package/build/es/src/table-reservations-v1-reservation-location.types.js +0 -184
- package/build/es/src/table-reservations-v1-reservation-location.types.js.map +0 -1
- package/build/es/src/table-reservations-v1-reservation-location.universal.d.ts +0 -2333
- package/build/es/src/table-reservations-v1-reservation-location.universal.js +0 -583
- package/build/es/src/table-reservations-v1-reservation-location.universal.js.map +0 -1
- package/build/es/src/table-reservations-v1-reservation.context.d.ts +0 -11
- package/build/es/src/table-reservations-v1-reservation.context.js +0 -146
- package/build/es/src/table-reservations-v1-reservation.context.js.map +0 -1
- package/build/es/src/table-reservations-v1-reservation.http.d.ts +0 -89
- package/build/es/src/table-reservations-v1-reservation.http.js +0 -496
- package/build/es/src/table-reservations-v1-reservation.http.js.map +0 -1
- package/build/es/src/table-reservations-v1-reservation.meta.d.ts +0 -29
- package/build/es/src/table-reservations-v1-reservation.meta.js +0 -164
- package/build/es/src/table-reservations-v1-reservation.meta.js.map +0 -1
- package/build/es/src/table-reservations-v1-reservation.public.d.ts +0 -26
- package/build/es/src/table-reservations-v1-reservation.public.js +0 -50
- package/build/es/src/table-reservations-v1-reservation.public.js.map +0 -1
- package/build/es/src/table-reservations-v1-reservation.types.d.ts +0 -976
- package/build/es/src/table-reservations-v1-reservation.types.js +0 -116
- package/build/es/src/table-reservations-v1-reservation.types.js.map +0 -1
- package/build/es/src/table-reservations-v1-reservation.universal.d.ts +0 -1382
- package/build/es/src/table-reservations-v1-reservation.universal.js +0 -837
- package/build/es/src/table-reservations-v1-reservation.universal.js.map +0 -1
- package/build/es/src/table-reservations-v1-time-slot.context.d.ts +0 -3
- package/build/es/src/table-reservations-v1-time-slot.context.js +0 -18
- package/build/es/src/table-reservations-v1-time-slot.context.js.map +0 -1
- package/build/es/src/table-reservations-v1-time-slot.http.d.ts +0 -13
- package/build/es/src/table-reservations-v1-time-slot.http.js +0 -122
- package/build/es/src/table-reservations-v1-time-slot.http.js.map +0 -1
- package/build/es/src/table-reservations-v1-time-slot.meta.d.ts +0 -13
- package/build/es/src/table-reservations-v1-time-slot.meta.js +0 -20
- package/build/es/src/table-reservations-v1-time-slot.meta.js.map +0 -1
- package/build/es/src/table-reservations-v1-time-slot.public.d.ts +0 -8
- package/build/es/src/table-reservations-v1-time-slot.public.js +0 -9
- package/build/es/src/table-reservations-v1-time-slot.public.js.map +0 -1
- package/build/es/src/table-reservations-v1-time-slot.types.d.ts +0 -137
- package/build/es/src/table-reservations-v1-time-slot.types.js +0 -29
- package/build/es/src/table-reservations-v1-time-slot.types.js.map +0 -1
- package/build/es/src/table-reservations-v1-time-slot.universal.d.ts +0 -178
- package/build/es/src/table-reservations-v1-time-slot.universal.js +0 -139
- package/build/es/src/table-reservations-v1-time-slot.universal.js.map +0 -1
|
@@ -1,2260 +0,0 @@
|
|
|
1
|
-
export interface ReservationLocation {
|
|
2
|
-
/**
|
|
3
|
-
* Reservation location ID.
|
|
4
|
-
* @readonly
|
|
5
|
-
*/
|
|
6
|
-
id?: string | null;
|
|
7
|
-
/** 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 pass the latest revision. */
|
|
8
|
-
revision?: string | null;
|
|
9
|
-
/**
|
|
10
|
-
* The date and time this reservation location was created.
|
|
11
|
-
* @readonly
|
|
12
|
-
*/
|
|
13
|
-
createdDate?: Date;
|
|
14
|
-
/**
|
|
15
|
-
* The date and time this reservation location was last updated.
|
|
16
|
-
* @readonly
|
|
17
|
-
*/
|
|
18
|
-
updatedDate?: Date;
|
|
19
|
-
/**
|
|
20
|
-
* Physical location details.
|
|
21
|
-
*
|
|
22
|
-
* Locations can be created and configured using the [Locations API](https://dev.wix.com/docs/rest/api-reference/business-info/locations/introduction)
|
|
23
|
-
* 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.
|
|
24
|
-
* @readonly
|
|
25
|
-
*/
|
|
26
|
-
location?: Location;
|
|
27
|
-
/** Reservation location configuration. */
|
|
28
|
-
configuration?: Configuration;
|
|
29
|
-
/**
|
|
30
|
-
* Whether this reservation location's `location` is the default location of the business.
|
|
31
|
-
* @readonly
|
|
32
|
-
*/
|
|
33
|
-
default?: boolean | null;
|
|
34
|
-
/**
|
|
35
|
-
* Whether this reservation location's `location` is archived.
|
|
36
|
-
* @readonly
|
|
37
|
-
*/
|
|
38
|
-
archived?: boolean | null;
|
|
39
|
-
}
|
|
40
|
-
export interface StreetAddress {
|
|
41
|
-
/** Street number. */
|
|
42
|
-
number?: string;
|
|
43
|
-
/** Street name. */
|
|
44
|
-
name?: string;
|
|
45
|
-
/** Apartment number. */
|
|
46
|
-
apt?: string;
|
|
47
|
-
}
|
|
48
|
-
/** Address geolocation information. */
|
|
49
|
-
export interface AddressLocation {
|
|
50
|
-
/** Latitude of the location. Must be between -90 and 90. */
|
|
51
|
-
latitude?: number | null;
|
|
52
|
-
/** Longitude of the location. Must be between -180 and 180. */
|
|
53
|
-
longitude?: number | null;
|
|
54
|
-
}
|
|
55
|
-
export interface Address {
|
|
56
|
-
/** 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
|
|
57
|
-
country?: string | null;
|
|
58
|
-
/** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */
|
|
59
|
-
subdivision?: string | null;
|
|
60
|
-
/** City name. */
|
|
61
|
-
city?: string | null;
|
|
62
|
-
/** Postal or zip code. */
|
|
63
|
-
postalCode?: string | null;
|
|
64
|
-
/** Street address of the location. Includes street name, number, and apartment number in separate fields. */
|
|
65
|
-
streetAddress?: StreetAddress;
|
|
66
|
-
/** Full address of the location. */
|
|
67
|
-
formattedAddress?: string | null;
|
|
68
|
-
/** Extra information that helps guests find the location. */
|
|
69
|
-
hint?: string | null;
|
|
70
|
-
/** Geographic coordinates of the location. */
|
|
71
|
-
geocode?: AddressLocation;
|
|
72
|
-
}
|
|
73
|
-
/**
|
|
74
|
-
* Time periods that this location is open for business. Includes a collection of TimePeriod instances.
|
|
75
|
-
* Aligned with https://developers.google.com/my-business/reference/rest/v4/accounts.locations#businesshours
|
|
76
|
-
* With a few minor adjustments
|
|
77
|
-
*/
|
|
78
|
-
export interface BusinessSchedule {
|
|
79
|
-
periods?: TimePeriod[];
|
|
80
|
-
/**
|
|
81
|
-
* Time periods during which this location is open. Each period represents a range of hours during the week during which the location is
|
|
82
|
-
* open.
|
|
83
|
-
*
|
|
84
|
-
* Max: 100 time periods
|
|
85
|
-
*/
|
|
86
|
-
specialHourPeriod?: SpecialHourPeriod[];
|
|
87
|
-
}
|
|
88
|
-
/**
|
|
89
|
-
* A span of time that the business is open,
|
|
90
|
-
* starting on the specified open day/time and closing on the specified close day/time.
|
|
91
|
-
* Closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
|
|
92
|
-
*/
|
|
93
|
-
export interface TimePeriod {
|
|
94
|
-
/** Day of the week this period starts on. */
|
|
95
|
-
openDay?: DayOfWeek;
|
|
96
|
-
/**
|
|
97
|
-
* 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
|
|
98
|
-
* midnight at the end of the specified day field.
|
|
99
|
-
*/
|
|
100
|
-
openTime?: string;
|
|
101
|
-
/** Day of the week this period ends on. */
|
|
102
|
-
closeDay?: DayOfWeek;
|
|
103
|
-
/**
|
|
104
|
-
* 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
|
|
105
|
-
* midnight at the end of the specified day field.
|
|
106
|
-
*
|
|
107
|
-
* This is the last time a reservation can be made at the restaurant, not the time the restaurant closes its doors.
|
|
108
|
-
*/
|
|
109
|
-
closeTime?: string;
|
|
110
|
-
}
|
|
111
|
-
/** Enumerates the days of the week. */
|
|
112
|
-
export declare enum DayOfWeek {
|
|
113
|
-
MONDAY = "MONDAY",
|
|
114
|
-
TUESDAY = "TUESDAY",
|
|
115
|
-
WEDNESDAY = "WEDNESDAY",
|
|
116
|
-
THURSDAY = "THURSDAY",
|
|
117
|
-
FRIDAY = "FRIDAY",
|
|
118
|
-
SATURDAY = "SATURDAY",
|
|
119
|
-
SUNDAY = "SUNDAY"
|
|
120
|
-
}
|
|
121
|
-
/** Set of time periods when a location's operational hours differ from its normal business hours. */
|
|
122
|
-
export interface SpecialHourPeriod {
|
|
123
|
-
/** Start date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. */
|
|
124
|
-
startDate?: string;
|
|
125
|
-
/** End date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#combined_date_and_time_representations) format. */
|
|
126
|
-
endDate?: string;
|
|
127
|
-
/** Whether or not the location is closed during this period. */
|
|
128
|
-
isClosed?: boolean;
|
|
129
|
-
/** Additional details about the period. */
|
|
130
|
-
comment?: string;
|
|
131
|
-
}
|
|
132
|
-
export interface TableDefinition {
|
|
133
|
-
/**
|
|
134
|
-
* Table ID.
|
|
135
|
-
* @readonly
|
|
136
|
-
*/
|
|
137
|
-
id?: string | null;
|
|
138
|
-
/** Table name. */
|
|
139
|
-
name?: string;
|
|
140
|
-
/** Minimum number of seats. */
|
|
141
|
-
seatsMin?: number;
|
|
142
|
-
/** Maximum number of seats. */
|
|
143
|
-
seatsMax?: number;
|
|
144
|
-
/** Whether the table is active (available to be reserved). */
|
|
145
|
-
isActive?: boolean | null;
|
|
146
|
-
}
|
|
147
|
-
export interface TableCombination {
|
|
148
|
-
/**
|
|
149
|
-
* Table combination ID.
|
|
150
|
-
* @readonly
|
|
151
|
-
*/
|
|
152
|
-
id?: string | null;
|
|
153
|
-
/** IDs of tables in the combination. */
|
|
154
|
-
tableIds?: string[] | null;
|
|
155
|
-
/** Minimum number of seats that can be reserved in this table combination. */
|
|
156
|
-
seatsMin?: number;
|
|
157
|
-
/** Maximum number of seats that can be reserved in this table combination. */
|
|
158
|
-
seatsMax?: number;
|
|
159
|
-
/** Whether the table combination is active (available to be reserved). */
|
|
160
|
-
isActive?: boolean | null;
|
|
161
|
-
}
|
|
162
|
-
export declare enum Unit {
|
|
163
|
-
UNKNOWN = "UNKNOWN",
|
|
164
|
-
MINUTES = "MINUTES",
|
|
165
|
-
HOURS = "HOURS",
|
|
166
|
-
DAYS = "DAYS"
|
|
167
|
-
}
|
|
168
|
-
/**
|
|
169
|
-
* Seat pacing.
|
|
170
|
-
* The maximum number of seats that can be filled by new reservations within a 15-minute period.
|
|
171
|
-
* 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.
|
|
172
|
-
*/
|
|
173
|
-
export interface SeatPacing {
|
|
174
|
-
/** Maximum number of seats that can be reserved every 15 minutes. */
|
|
175
|
-
number?: number;
|
|
176
|
-
/** Whether this option is enabled. */
|
|
177
|
-
enabled?: boolean;
|
|
178
|
-
}
|
|
179
|
-
/**
|
|
180
|
-
* Party pacing.
|
|
181
|
-
* The maximum number of party reservations that can start within a 15-minute period.
|
|
182
|
-
* 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`.
|
|
183
|
-
*/
|
|
184
|
-
export interface PartyPacing {
|
|
185
|
-
/** Maximum number of new party reservations that can be made every 15 minutes. */
|
|
186
|
-
number?: number;
|
|
187
|
-
/** Whether this option is enabled. */
|
|
188
|
-
enabled?: boolean;
|
|
189
|
-
}
|
|
190
|
-
/** The party size limits for a single reservation. */
|
|
191
|
-
export interface PartiesSize {
|
|
192
|
-
/** Minimum number of seats a party can reserve. */
|
|
193
|
-
min?: number;
|
|
194
|
-
/** Maximum number of seats a party can reserve. */
|
|
195
|
-
max?: number;
|
|
196
|
-
}
|
|
197
|
-
/** The party size limits for a single reservation. */
|
|
198
|
-
export interface PartySize {
|
|
199
|
-
/** Minimum number of seats a party can reserve. */
|
|
200
|
-
min?: number;
|
|
201
|
-
/** Maximum number of seats a party can reserve. */
|
|
202
|
-
max?: number;
|
|
203
|
-
}
|
|
204
|
-
/**
|
|
205
|
-
* Reservation notice period.
|
|
206
|
-
*
|
|
207
|
-
* The period of time between making a reservation and that reservation's start time. Reservations cannot be made after the start of this period.
|
|
208
|
-
*/
|
|
209
|
-
export interface NoticePeriod {
|
|
210
|
-
/** The quantity of the chosen time unit. */
|
|
211
|
-
number?: number;
|
|
212
|
-
/** Time unit. */
|
|
213
|
-
unit?: Unit;
|
|
214
|
-
}
|
|
215
|
-
/** Turnover time rule. A turnover time is defined per party size range. */
|
|
216
|
-
export interface TurnoverTimeRule {
|
|
217
|
-
/** Minimum number of seats to qualify for this rule. */
|
|
218
|
-
seatsMin?: number;
|
|
219
|
-
/** Maximum number of seats to qualify for this rule. */
|
|
220
|
-
seatsMax?: number;
|
|
221
|
-
/** Turnover time in minutes for qualifying parties. */
|
|
222
|
-
minutes?: number;
|
|
223
|
-
}
|
|
224
|
-
/** Turnover rule. A turnover time is defined per party size range. */
|
|
225
|
-
export interface TurnoverRule {
|
|
226
|
-
/** Minimum number of seats to qualify for this rule. */
|
|
227
|
-
minSeats?: number;
|
|
228
|
-
/** Maximum number of seats to qualify for this rule. */
|
|
229
|
-
maxSeats?: number;
|
|
230
|
-
/** Turnover time in minutes for qualifying parties. */
|
|
231
|
-
minutes?: number;
|
|
232
|
-
}
|
|
233
|
-
/** Manual approval settings. */
|
|
234
|
-
export interface ManualApproval extends ManualApprovalValueOneOf {
|
|
235
|
-
/** The minimum party size that requires manual approval. */
|
|
236
|
-
partySizeThreshold?: number;
|
|
237
|
-
/** Custom approvals provider id. */
|
|
238
|
-
customApprovalsProviderId?: string;
|
|
239
|
-
/** Whether manual approval is required for online reservations. */
|
|
240
|
-
enabled?: boolean;
|
|
241
|
-
}
|
|
242
|
-
/** @oneof */
|
|
243
|
-
export interface ManualApprovalValueOneOf {
|
|
244
|
-
/** The minimum party size that requires manual approval. */
|
|
245
|
-
partySizeThreshold?: number;
|
|
246
|
-
/** Custom approvals provider id. */
|
|
247
|
-
customApprovalsProviderId?: string;
|
|
248
|
-
}
|
|
249
|
-
/** Type of the field. */
|
|
250
|
-
export declare enum FieldType {
|
|
251
|
-
UNKNOWN = "UNKNOWN",
|
|
252
|
-
TABLE = "TABLE",
|
|
253
|
-
START_DATE = "START_DATE",
|
|
254
|
-
END_DATE = "END_DATE",
|
|
255
|
-
CREATED_DATE = "CREATED_DATE",
|
|
256
|
-
UPDATED_DATE = "UPDATED_DATE",
|
|
257
|
-
PARTY_SIZE = "PARTY_SIZE",
|
|
258
|
-
FIRST_NAME = "FIRST_NAME",
|
|
259
|
-
LAST_NAME = "LAST_NAME",
|
|
260
|
-
EMAIL = "EMAIL",
|
|
261
|
-
PHONE = "PHONE",
|
|
262
|
-
ADDITIONAL_INFO = "ADDITIONAL_INFO",
|
|
263
|
-
TEAM_MESSAGE = "TEAM_MESSAGE",
|
|
264
|
-
CUSTOM_FIELD = "CUSTOM_FIELD",
|
|
265
|
-
STATUS = "STATUS"
|
|
266
|
-
}
|
|
267
|
-
export interface PageUrlV2 {
|
|
268
|
-
/** The relative path for the page within the site. For example, `/product-page/a-product`. */
|
|
269
|
-
relativePath?: string;
|
|
270
|
-
/** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
|
|
271
|
-
url?: string | null;
|
|
272
|
-
}
|
|
273
|
-
/** Terms and conditions. */
|
|
274
|
-
export interface TermsAndConditions extends TermsAndConditionsValueOneOf {
|
|
275
|
-
/** Terms and conditions URL. */
|
|
276
|
-
url?: PageUrlV2;
|
|
277
|
-
/** Terms and conditions text. */
|
|
278
|
-
text?: string | null;
|
|
279
|
-
/**
|
|
280
|
-
* Whether the terms and conditions are shown to the customer.
|
|
281
|
-
*
|
|
282
|
-
* Default: `false`
|
|
283
|
-
*/
|
|
284
|
-
enabled?: boolean;
|
|
285
|
-
}
|
|
286
|
-
/** @oneof */
|
|
287
|
-
export interface TermsAndConditionsValueOneOf {
|
|
288
|
-
/** Terms and conditions URL. */
|
|
289
|
-
url?: PageUrlV2;
|
|
290
|
-
/** Terms and conditions text. */
|
|
291
|
-
text?: string | null;
|
|
292
|
-
}
|
|
293
|
-
/** Privacy policy. */
|
|
294
|
-
export interface PrivacyPolicy extends PrivacyPolicyValueOneOf {
|
|
295
|
-
/** Privacy policy URL. */
|
|
296
|
-
url?: PageUrlV2;
|
|
297
|
-
/** Privacy policy text. */
|
|
298
|
-
text?: string | null;
|
|
299
|
-
/**
|
|
300
|
-
* Whether the privacy policy is shown to the customer.
|
|
301
|
-
*
|
|
302
|
-
* Default: `false`
|
|
303
|
-
*/
|
|
304
|
-
enabled?: boolean;
|
|
305
|
-
}
|
|
306
|
-
/** @oneof */
|
|
307
|
-
export interface PrivacyPolicyValueOneOf {
|
|
308
|
-
/** Privacy policy URL. */
|
|
309
|
-
url?: PageUrlV2;
|
|
310
|
-
/** Privacy policy text. */
|
|
311
|
-
text?: string | null;
|
|
312
|
-
}
|
|
313
|
-
/** Custom field definition. Definitions of the fields that are added to the reservation form. */
|
|
314
|
-
export interface CustomFieldDefinition {
|
|
315
|
-
/**
|
|
316
|
-
* Custom field ID.
|
|
317
|
-
* @readonly
|
|
318
|
-
*/
|
|
319
|
-
id?: string | null;
|
|
320
|
-
/** Custom field name. */
|
|
321
|
-
name?: string;
|
|
322
|
-
/**
|
|
323
|
-
* Whether the custom field is required.
|
|
324
|
-
*
|
|
325
|
-
* Default: `false`
|
|
326
|
-
*/
|
|
327
|
-
required?: boolean;
|
|
328
|
-
}
|
|
329
|
-
/** Email marketing checkbox. */
|
|
330
|
-
export interface EmailMarketingCheckbox {
|
|
331
|
-
/**
|
|
332
|
-
* Whether the checkbox is shown to the customer.
|
|
333
|
-
*
|
|
334
|
-
* Default: `false`
|
|
335
|
-
*/
|
|
336
|
-
enabled?: boolean;
|
|
337
|
-
/**
|
|
338
|
-
* Whether the checkbox is checked by default.
|
|
339
|
-
*
|
|
340
|
-
* Default: `false`
|
|
341
|
-
*/
|
|
342
|
-
checkedByDefault?: boolean;
|
|
343
|
-
}
|
|
344
|
-
export interface OnlineReservations {
|
|
345
|
-
/**
|
|
346
|
-
* Seat pacing settings.
|
|
347
|
-
*
|
|
348
|
-
* The maximum number of seats that can be filled by new reservations within a 15-minute period.
|
|
349
|
-
* 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.
|
|
350
|
-
*/
|
|
351
|
-
seatPacing?: SeatPacing;
|
|
352
|
-
/**
|
|
353
|
-
* Party pacing settings.
|
|
354
|
-
*
|
|
355
|
-
* The maximum number of party reservations that can start within a 15-minute period.
|
|
356
|
-
* 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`.
|
|
357
|
-
*/
|
|
358
|
-
partyPacing?: PartyPacing;
|
|
359
|
-
/** Party size limits for a reservation. */
|
|
360
|
-
partySize?: PartySize;
|
|
361
|
-
/**
|
|
362
|
-
* Minimum reservation notice.
|
|
363
|
-
*
|
|
364
|
-
* The minimum amount of time that must be allowed between making a reservation and that reservation's start time.
|
|
365
|
-
*/
|
|
366
|
-
minimumReservationNotice?: NoticePeriod;
|
|
367
|
-
/**
|
|
368
|
-
* Default turnover time in minutes.
|
|
369
|
-
*
|
|
370
|
-
* Turnover time is how much time a party is allotted for their entire reservation - from being seated to leaving the restaurant.
|
|
371
|
-
*/
|
|
372
|
-
defaultTurnoverTime?: number | null;
|
|
373
|
-
/**
|
|
374
|
-
* Custom turnover time rules.
|
|
375
|
-
*
|
|
376
|
-
* This allows you to set different turnover times for different party sizes.
|
|
377
|
-
*/
|
|
378
|
-
turnoverTimeRules?: TurnoverTimeRule[];
|
|
379
|
-
/**
|
|
380
|
-
* The location's business schedule.
|
|
381
|
-
*
|
|
382
|
-
* 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.
|
|
383
|
-
* Limited to 100 time periods.
|
|
384
|
-
*/
|
|
385
|
-
businessSchedule?: BusinessSchedule;
|
|
386
|
-
/** Whether a phone number is shown. */
|
|
387
|
-
showPhoneNumber?: boolean | null;
|
|
388
|
-
/** Whether online reservations are enabled. */
|
|
389
|
-
onlineReservationsEnabled?: boolean | null;
|
|
390
|
-
/** Manual approval settings. */
|
|
391
|
-
manualApproval?: ManualApproval;
|
|
392
|
-
}
|
|
393
|
-
/** Reservation form settings. */
|
|
394
|
-
export interface ReservationForm {
|
|
395
|
-
/** A message shown to the customer in the registration form. */
|
|
396
|
-
submitMessage?: string | null;
|
|
397
|
-
/** Whether to show policies (the terms and conditions, and the privacy policy) to the customer. */
|
|
398
|
-
policiesEnabled?: boolean | null;
|
|
399
|
-
/** Settings for displaying the terms and conditions. */
|
|
400
|
-
termsAndConditions?: TermsAndConditions;
|
|
401
|
-
/** Settings for displaying the privacy policy. */
|
|
402
|
-
privacyPolicy?: PrivacyPolicy;
|
|
403
|
-
/** Custom fields you wish to add to the registration form for the customer to fill in. */
|
|
404
|
-
customFieldDefinitions?: CustomFieldDefinition[];
|
|
405
|
-
/**
|
|
406
|
-
* Whether a last_name is required in the reservation form.
|
|
407
|
-
*
|
|
408
|
-
* Default: `false`
|
|
409
|
-
*/
|
|
410
|
-
lastNameRequired?: boolean | null;
|
|
411
|
-
/**
|
|
412
|
-
* Whether an email is required in the reservation form.
|
|
413
|
-
*
|
|
414
|
-
* Default: `false`
|
|
415
|
-
*/
|
|
416
|
-
emailRequired?: boolean | null;
|
|
417
|
-
/** Email marketing checkbox settings. */
|
|
418
|
-
emailMarketingCheckbox?: EmailMarketingCheckbox;
|
|
419
|
-
}
|
|
420
|
-
/** My reservations field definition. */
|
|
421
|
-
export interface MyReservationsField {
|
|
422
|
-
/** Field type. */
|
|
423
|
-
fieldType?: FieldType;
|
|
424
|
-
/**
|
|
425
|
-
* Custom field ID.
|
|
426
|
-
*
|
|
427
|
-
* 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`.
|
|
428
|
-
* @readonly
|
|
429
|
-
*/
|
|
430
|
-
customFieldId?: string | null;
|
|
431
|
-
/** Whether the field is shown. */
|
|
432
|
-
shown?: boolean;
|
|
433
|
-
}
|
|
434
|
-
export interface TableManagement {
|
|
435
|
-
/** Table definitions. */
|
|
436
|
-
tableDefinitions?: TableDefinition[];
|
|
437
|
-
/** Deleted table definitions. */
|
|
438
|
-
deletedTableDefinitions?: TableDefinition[];
|
|
439
|
-
/** Table combinations. */
|
|
440
|
-
tableCombinations?: TableCombination[];
|
|
441
|
-
}
|
|
442
|
-
/** Reservation payment. */
|
|
443
|
-
export interface ReservationPayment {
|
|
444
|
-
/** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99) */
|
|
445
|
-
value?: string;
|
|
446
|
-
/** Minimum party size for payment policy application. */
|
|
447
|
-
minPartySize?: number;
|
|
448
|
-
}
|
|
449
|
-
export interface Location {
|
|
450
|
-
/**
|
|
451
|
-
* Location ID.
|
|
452
|
-
* @readonly
|
|
453
|
-
*/
|
|
454
|
-
id?: string | null;
|
|
455
|
-
}
|
|
456
|
-
export interface Configuration {
|
|
457
|
-
/** Settings for this location that are used to determine restaurant availability for reservations made online. */
|
|
458
|
-
onlineReservations?: OnlineReservations;
|
|
459
|
-
/** Reservation form settings. */
|
|
460
|
-
reservationForm?: ReservationForm;
|
|
461
|
-
/**
|
|
462
|
-
* "My reservations" field details.
|
|
463
|
-
*
|
|
464
|
-
* These are the fields that appear in the "My reservations" section of the Table Reservations page on the restaurant's Wix site dashboard.
|
|
465
|
-
*/
|
|
466
|
-
myReservationsFields?: MyReservationsField[];
|
|
467
|
-
/** Table management settings. */
|
|
468
|
-
tableManagement?: TableManagement;
|
|
469
|
-
}
|
|
470
|
-
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
471
|
-
/** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
|
|
472
|
-
metaSiteId?: string;
|
|
473
|
-
/** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
|
|
474
|
-
siteId?: string;
|
|
475
|
-
/** Invalidate by App */
|
|
476
|
-
app?: App;
|
|
477
|
-
/** Invalidate by page id */
|
|
478
|
-
page?: Page;
|
|
479
|
-
/** Invalidate by URI path */
|
|
480
|
-
uri?: URI;
|
|
481
|
-
/** tell us why you're invalidating the cache. You don't need to add your app name */
|
|
482
|
-
reason?: string | null;
|
|
483
|
-
/** Is local DS */
|
|
484
|
-
localDc?: boolean;
|
|
485
|
-
}
|
|
486
|
-
/** @oneof */
|
|
487
|
-
export interface InvalidateCacheGetByOneOf {
|
|
488
|
-
/** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
|
|
489
|
-
metaSiteId?: string;
|
|
490
|
-
/** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
|
|
491
|
-
siteId?: string;
|
|
492
|
-
/** Invalidate by App */
|
|
493
|
-
app?: App;
|
|
494
|
-
/** Invalidate by page id */
|
|
495
|
-
page?: Page;
|
|
496
|
-
/** Invalidate by URI path */
|
|
497
|
-
uri?: URI;
|
|
498
|
-
}
|
|
499
|
-
export interface App {
|
|
500
|
-
/** The AppDefId */
|
|
501
|
-
appDefId?: string;
|
|
502
|
-
/** The instance Id */
|
|
503
|
-
instanceId?: string;
|
|
504
|
-
}
|
|
505
|
-
export interface Page {
|
|
506
|
-
/** the msid the page is on */
|
|
507
|
-
metaSiteId?: string;
|
|
508
|
-
/** Invalidate by Page ID */
|
|
509
|
-
pageId?: string;
|
|
510
|
-
}
|
|
511
|
-
export interface URI {
|
|
512
|
-
/** the msid the URI is on */
|
|
513
|
-
metaSiteId?: string;
|
|
514
|
-
/** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
|
|
515
|
-
uriPath?: string;
|
|
516
|
-
}
|
|
517
|
-
export interface GetReservationLocationRequest {
|
|
518
|
-
/** ID of the ReservationLocation to retrieve. */
|
|
519
|
-
reservationLocationId: string;
|
|
520
|
-
/**
|
|
521
|
-
* Array of named, predefined sets of projected fields to be returned.
|
|
522
|
-
*
|
|
523
|
-
* - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
|
|
524
|
-
* `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
|
|
525
|
-
* `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
|
|
526
|
-
* `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
|
|
527
|
-
* - `FULL`: Returns all fields.
|
|
528
|
-
*
|
|
529
|
-
* Default: `PUBLIC`.
|
|
530
|
-
*/
|
|
531
|
-
fieldsets?: Set[];
|
|
532
|
-
}
|
|
533
|
-
export declare enum Set {
|
|
534
|
-
PUBLIC = "PUBLIC",
|
|
535
|
-
FULL = "FULL"
|
|
536
|
-
}
|
|
537
|
-
export interface GetReservationLocationResponse {
|
|
538
|
-
/** The retrieved reservation location. */
|
|
539
|
-
reservationLocation?: ReservationLocation;
|
|
540
|
-
}
|
|
541
|
-
export interface UpdateReservationLocationRequest {
|
|
542
|
-
/** ReservationLocation to be updated, may be partial. */
|
|
543
|
-
reservationLocation: ReservationLocation;
|
|
544
|
-
}
|
|
545
|
-
export interface UpdateReservationLocationResponse {
|
|
546
|
-
/** The updated reservation location. */
|
|
547
|
-
reservationLocation?: ReservationLocation;
|
|
548
|
-
}
|
|
549
|
-
export interface TablesDeleted {
|
|
550
|
-
/** ID of the affected reservation location. */
|
|
551
|
-
reservationLocationId?: string;
|
|
552
|
-
/** IDs of deleted tables. */
|
|
553
|
-
tableIds?: string[];
|
|
554
|
-
}
|
|
555
|
-
export interface QueryReservationLocationsRequest {
|
|
556
|
-
/** Query options. */
|
|
557
|
-
query: QueryV2;
|
|
558
|
-
/**
|
|
559
|
-
* Array of named, predefined sets of projected fields to be returned.
|
|
560
|
-
*
|
|
561
|
-
* - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
|
|
562
|
-
* `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
|
|
563
|
-
* `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
|
|
564
|
-
* `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
|
|
565
|
-
* - `FULL`: Returns all fields.
|
|
566
|
-
*
|
|
567
|
-
* Default: `PUBLIC`.
|
|
568
|
-
*/
|
|
569
|
-
fieldsets?: Set[];
|
|
570
|
-
}
|
|
571
|
-
export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
572
|
-
/** Paging options to limit and skip the number of items. */
|
|
573
|
-
paging?: Paging;
|
|
574
|
-
/** 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`. */
|
|
575
|
-
cursorPaging?: CursorPaging;
|
|
576
|
-
/**
|
|
577
|
-
* Filter object in the following format:
|
|
578
|
-
* `"filter" : {
|
|
579
|
-
* "fieldName1": "value1",
|
|
580
|
-
* "fieldName2":{"$operator":"value2"}
|
|
581
|
-
* }`
|
|
582
|
-
*
|
|
583
|
-
* 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.
|
|
584
|
-
* To learn how to query reservations, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
|
|
585
|
-
*/
|
|
586
|
-
filter?: Record<string, any> | null;
|
|
587
|
-
/**
|
|
588
|
-
* Sort object in the following format:
|
|
589
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
590
|
-
*/
|
|
591
|
-
sort?: Sorting[];
|
|
592
|
-
}
|
|
593
|
-
/** @oneof */
|
|
594
|
-
export interface QueryV2PagingMethodOneOf {
|
|
595
|
-
/** Paging options to limit and skip the number of items. */
|
|
596
|
-
paging?: Paging;
|
|
597
|
-
/** 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`. */
|
|
598
|
-
cursorPaging?: CursorPaging;
|
|
599
|
-
}
|
|
600
|
-
export interface Sorting {
|
|
601
|
-
/** Name of the field to sort by. */
|
|
602
|
-
fieldName?: string;
|
|
603
|
-
/**
|
|
604
|
-
* Sort order.
|
|
605
|
-
*
|
|
606
|
-
* Use `ASC` for ascending order or `DESC` for descending order. Defaults to `ASC`.
|
|
607
|
-
*/
|
|
608
|
-
order?: SortOrder;
|
|
609
|
-
}
|
|
610
|
-
export declare enum SortOrder {
|
|
611
|
-
ASC = "ASC",
|
|
612
|
-
DESC = "DESC"
|
|
613
|
-
}
|
|
614
|
-
export interface Paging {
|
|
615
|
-
/** Number of items to load. */
|
|
616
|
-
limit?: number | null;
|
|
617
|
-
/** Number of items to skip in the current sort order. */
|
|
618
|
-
offset?: number | null;
|
|
619
|
-
}
|
|
620
|
-
export interface CursorPaging {
|
|
621
|
-
/** Number of items to load. */
|
|
622
|
-
limit?: number | null;
|
|
623
|
-
/**
|
|
624
|
-
* Pointer to the next or previous page in the list of results.
|
|
625
|
-
*
|
|
626
|
-
* You can get the relevant cursor token
|
|
627
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
628
|
-
* Not relevant for the first request.
|
|
629
|
-
*/
|
|
630
|
-
cursor?: string | null;
|
|
631
|
-
}
|
|
632
|
-
export interface QueryReservationLocationsResponse {
|
|
633
|
-
/** List of reservation locations */
|
|
634
|
-
reservationLocations?: ReservationLocation[];
|
|
635
|
-
/** Metadata for the paginated results. */
|
|
636
|
-
pagingMetadata?: PagingMetadataV2;
|
|
637
|
-
}
|
|
638
|
-
export interface PagingMetadataV2 {
|
|
639
|
-
/** Offset that was requested. */
|
|
640
|
-
offset?: number | null;
|
|
641
|
-
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
642
|
-
cursors?: Cursors;
|
|
643
|
-
}
|
|
644
|
-
export interface Cursors {
|
|
645
|
-
/** Cursor pointing to next page in the list of results. */
|
|
646
|
-
next?: string | null;
|
|
647
|
-
/** Cursor pointing to previous page in the list of results. */
|
|
648
|
-
prev?: string | null;
|
|
649
|
-
}
|
|
650
|
-
export interface ListReservationLocationsRequest {
|
|
651
|
-
/** 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`. */
|
|
652
|
-
paging?: CursorPaging;
|
|
653
|
-
/** Sorting for the locations list. */
|
|
654
|
-
sort?: Sorting;
|
|
655
|
-
/**
|
|
656
|
-
* Array of named, predefined sets of projected fields to be returned.
|
|
657
|
-
*
|
|
658
|
-
* - `PUBLIC`: Returns `id`, `archived`, `location`, `default`, `configuration.onlineReservations.partiesSize`, `configuration.onlineReservations.minimumReservationNotice`, `configuration.onlineReservations.businessSchedule`,
|
|
659
|
-
* `configuration.onlineReservations.showPhoneNumber`, `configuration.onlineReservations.onlineReservationsEnabled`, `configuration.onlineReservations.manualApproval`, `configuration.reservationForm.submitMessage`,
|
|
660
|
-
* `configuration.reservationForm.policiesEnabled`, `configuration.reservationForm.termsAndConditions`, `configuration.reservationForm.privacyPolicy`,
|
|
661
|
-
* `configuration.reservationForm.customFieldDefinitions`, `configuration.reservationForm.lastNameRequired`, `configuration.reservationForm.emailRequired`, `configuration.reservationForm.emailMarketingCheckbox`.
|
|
662
|
-
* - `FULL`: Returns all fields.
|
|
663
|
-
*
|
|
664
|
-
* Default: `PUBLIC`.
|
|
665
|
-
*/
|
|
666
|
-
fieldsets?: Set[];
|
|
667
|
-
}
|
|
668
|
-
export interface ListReservationLocationsResponse {
|
|
669
|
-
/** Locations list. */
|
|
670
|
-
reservationLocations?: ReservationLocation[];
|
|
671
|
-
/** Metadata for the paginated results. */
|
|
672
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
673
|
-
}
|
|
674
|
-
export interface CursorPagingMetadata {
|
|
675
|
-
/** Number of items returned in the response. */
|
|
676
|
-
count?: number | null;
|
|
677
|
-
/** Offset that was requested. */
|
|
678
|
-
cursors?: Cursors;
|
|
679
|
-
/**
|
|
680
|
-
* Indicates if there are more results after the current page.
|
|
681
|
-
* If `true`, another page of results can be retrieved.
|
|
682
|
-
* If `false`, this is the last page.
|
|
683
|
-
*/
|
|
684
|
-
hasNext?: boolean | null;
|
|
685
|
-
}
|
|
686
|
-
export interface DeleteOrphanReservationLocationRequest {
|
|
687
|
-
/** Id of the ReservationLocation. */
|
|
688
|
-
reservationLocationId?: string;
|
|
689
|
-
}
|
|
690
|
-
export interface DeleteOrphanReservationLocationResponse {
|
|
691
|
-
}
|
|
692
|
-
export interface MigrateOldRestaurantSettingsRequest {
|
|
693
|
-
/** Mode. */
|
|
694
|
-
mode?: Mode;
|
|
695
|
-
/** Override not default. */
|
|
696
|
-
overrideNotDefault?: boolean;
|
|
697
|
-
}
|
|
698
|
-
export declare enum Mode {
|
|
699
|
-
/** DRY RUN. */
|
|
700
|
-
UNDEFINED = "UNDEFINED",
|
|
701
|
-
DRY_RUN = "DRY_RUN",
|
|
702
|
-
MIGRATE = "MIGRATE",
|
|
703
|
-
FORCE_MIGRATE = "FORCE_MIGRATE"
|
|
704
|
-
}
|
|
705
|
-
export interface MigrateOldRestaurantSettingsResponse {
|
|
706
|
-
/** Migration results. */
|
|
707
|
-
migrationResults?: MigrationResult[];
|
|
708
|
-
}
|
|
709
|
-
export interface ParsedSettings {
|
|
710
|
-
futureDelayMins?: number | null;
|
|
711
|
-
partySizeMin?: number | null;
|
|
712
|
-
partySizeMax?: number | null;
|
|
713
|
-
weeklySchedule?: OldScheduleInterval[];
|
|
714
|
-
customFields?: OldCustomField[];
|
|
715
|
-
privacyPolicy?: OldPolicy;
|
|
716
|
-
termsAndConditions?: OldTerms;
|
|
717
|
-
scheduleExceptions?: OldScheduleException[];
|
|
718
|
-
available?: boolean | null;
|
|
719
|
-
locale?: string | null;
|
|
720
|
-
}
|
|
721
|
-
export interface OldScheduleInterval {
|
|
722
|
-
durationMins?: number;
|
|
723
|
-
minuteOfWeek?: number;
|
|
724
|
-
}
|
|
725
|
-
export interface OldCustomField {
|
|
726
|
-
label?: string;
|
|
727
|
-
required?: boolean;
|
|
728
|
-
}
|
|
729
|
-
export interface OldPolicy {
|
|
730
|
-
value?: string;
|
|
731
|
-
isPlainText?: boolean;
|
|
732
|
-
}
|
|
733
|
-
export interface OldTerms {
|
|
734
|
-
value?: string;
|
|
735
|
-
isPlainText?: boolean;
|
|
736
|
-
}
|
|
737
|
-
export interface OldScheduleException {
|
|
738
|
-
available?: boolean;
|
|
739
|
-
comment?: string | null;
|
|
740
|
-
start?: OldInstant;
|
|
741
|
-
end?: OldInstant;
|
|
742
|
-
}
|
|
743
|
-
export interface OldInstant {
|
|
744
|
-
year?: number;
|
|
745
|
-
month?: number;
|
|
746
|
-
day?: number;
|
|
747
|
-
hour?: number;
|
|
748
|
-
minute?: number;
|
|
749
|
-
}
|
|
750
|
-
export interface MigrationParsingError {
|
|
751
|
-
/** Field. */
|
|
752
|
-
path?: string;
|
|
753
|
-
/** Message. */
|
|
754
|
-
message?: string;
|
|
755
|
-
/** Target. */
|
|
756
|
-
target?: Record<string, any> | null;
|
|
757
|
-
}
|
|
758
|
-
export interface MigrationResult {
|
|
759
|
-
/** The migrated ReservationLocation. */
|
|
760
|
-
reservationLocation?: ReservationLocation;
|
|
761
|
-
/** Old settings. */
|
|
762
|
-
oldSettings?: Record<string, any> | null;
|
|
763
|
-
/** Parsed settings. */
|
|
764
|
-
parsedSettings?: ParsedSettings;
|
|
765
|
-
/** Migration parsing errors. */
|
|
766
|
-
migrationParsingErrors?: MigrationParsingError[];
|
|
767
|
-
}
|
|
768
|
-
export interface CheckReservationLocationsCreatedRequest {
|
|
769
|
-
}
|
|
770
|
-
export interface CheckReservationLocationsCreatedResponse {
|
|
771
|
-
/** Reservation locations created. */
|
|
772
|
-
created?: boolean;
|
|
773
|
-
}
|
|
774
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
775
|
-
createdEvent?: EntityCreatedEvent;
|
|
776
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
777
|
-
deletedEvent?: EntityDeletedEvent;
|
|
778
|
-
actionEvent?: ActionEvent;
|
|
779
|
-
/**
|
|
780
|
-
* Unique event ID.
|
|
781
|
-
* Allows clients to ignore duplicate webhooks.
|
|
782
|
-
*/
|
|
783
|
-
id?: string;
|
|
784
|
-
/**
|
|
785
|
-
* Assumes actions are also always typed to an entity_type
|
|
786
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
787
|
-
*/
|
|
788
|
-
entityFqdn?: string;
|
|
789
|
-
/**
|
|
790
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
791
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
792
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
793
|
-
*/
|
|
794
|
-
slug?: string;
|
|
795
|
-
/** ID of the entity associated with the event. */
|
|
796
|
-
entityId?: string;
|
|
797
|
-
/** Event timestamp. */
|
|
798
|
-
eventTime?: Date;
|
|
799
|
-
/**
|
|
800
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
801
|
-
* (for example, GDPR).
|
|
802
|
-
*/
|
|
803
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
804
|
-
/** If present, indicates the action that triggered the event. */
|
|
805
|
-
originatedFrom?: string | null;
|
|
806
|
-
/**
|
|
807
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
808
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
809
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
810
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
811
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
812
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
813
|
-
*/
|
|
814
|
-
entityEventSequence?: string | null;
|
|
815
|
-
}
|
|
816
|
-
/** @oneof */
|
|
817
|
-
export interface DomainEventBodyOneOf {
|
|
818
|
-
createdEvent?: EntityCreatedEvent;
|
|
819
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
820
|
-
deletedEvent?: EntityDeletedEvent;
|
|
821
|
-
actionEvent?: ActionEvent;
|
|
822
|
-
}
|
|
823
|
-
export interface EntityCreatedEvent {
|
|
824
|
-
entityAsJson?: string;
|
|
825
|
-
}
|
|
826
|
-
export interface EntityUpdatedEvent {
|
|
827
|
-
/**
|
|
828
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
829
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
830
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
831
|
-
*/
|
|
832
|
-
currentEntityAsJson?: string;
|
|
833
|
-
}
|
|
834
|
-
export interface EntityDeletedEvent {
|
|
835
|
-
/** Entity that was deleted */
|
|
836
|
-
deletedEntityAsJson?: string | null;
|
|
837
|
-
}
|
|
838
|
-
export interface ActionEvent {
|
|
839
|
-
bodyAsJson?: string;
|
|
840
|
-
}
|
|
841
|
-
export interface Empty {
|
|
842
|
-
}
|
|
843
|
-
export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
844
|
-
/** Emitted on a meta site creation. */
|
|
845
|
-
siteCreated?: SiteCreated;
|
|
846
|
-
/** Emitted on a meta site transfer completion. */
|
|
847
|
-
siteTransferred?: SiteTransferred;
|
|
848
|
-
/** Emitted on a meta site deletion. */
|
|
849
|
-
siteDeleted?: SiteDeleted;
|
|
850
|
-
/** Emitted on a meta site restoration. */
|
|
851
|
-
siteUndeleted?: SiteUndeleted;
|
|
852
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
853
|
-
sitePublished?: SitePublished;
|
|
854
|
-
/** Emitted on a meta site unpublish. */
|
|
855
|
-
siteUnpublished?: SiteUnpublished;
|
|
856
|
-
/** Emitted when meta site is marked as template. */
|
|
857
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
858
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
859
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
860
|
-
/** Emitted when an application is provisioned (installed). */
|
|
861
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
862
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
863
|
-
serviceRemoved?: ServiceRemoved;
|
|
864
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
865
|
-
siteRenamedPayload?: SiteRenamed;
|
|
866
|
-
/** Emitted when meta site was permanently deleted. */
|
|
867
|
-
hardDeleted?: SiteHardDeleted;
|
|
868
|
-
/** Emitted on a namespace change. */
|
|
869
|
-
namespaceChanged?: NamespaceChanged;
|
|
870
|
-
/** Emitted when Studio is attached. */
|
|
871
|
-
studioAssigned?: StudioAssigned;
|
|
872
|
-
/** Emitted when Studio is detached. */
|
|
873
|
-
studioUnassigned?: StudioUnassigned;
|
|
874
|
-
/** A meta site id. */
|
|
875
|
-
metaSiteId?: string;
|
|
876
|
-
/** A meta site version. Monotonically increasing. */
|
|
877
|
-
version?: string;
|
|
878
|
-
/** A timestamp of the event. */
|
|
879
|
-
timestamp?: string;
|
|
880
|
-
/** A list of "assets" (applications). The same as MetaSiteContext. */
|
|
881
|
-
assets?: Asset[];
|
|
882
|
-
}
|
|
883
|
-
/** @oneof */
|
|
884
|
-
export interface MetaSiteSpecialEventPayloadOneOf {
|
|
885
|
-
/** Emitted on a meta site creation. */
|
|
886
|
-
siteCreated?: SiteCreated;
|
|
887
|
-
/** Emitted on a meta site transfer completion. */
|
|
888
|
-
siteTransferred?: SiteTransferred;
|
|
889
|
-
/** Emitted on a meta site deletion. */
|
|
890
|
-
siteDeleted?: SiteDeleted;
|
|
891
|
-
/** Emitted on a meta site restoration. */
|
|
892
|
-
siteUndeleted?: SiteUndeleted;
|
|
893
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
894
|
-
sitePublished?: SitePublished;
|
|
895
|
-
/** Emitted on a meta site unpublish. */
|
|
896
|
-
siteUnpublished?: SiteUnpublished;
|
|
897
|
-
/** Emitted when meta site is marked as template. */
|
|
898
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
899
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
900
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
901
|
-
/** Emitted when an application is provisioned (installed). */
|
|
902
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
903
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
904
|
-
serviceRemoved?: ServiceRemoved;
|
|
905
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
906
|
-
siteRenamedPayload?: SiteRenamed;
|
|
907
|
-
/** Emitted when meta site was permanently deleted. */
|
|
908
|
-
hardDeleted?: SiteHardDeleted;
|
|
909
|
-
/** Emitted on a namespace change. */
|
|
910
|
-
namespaceChanged?: NamespaceChanged;
|
|
911
|
-
/** Emitted when Studio is attached. */
|
|
912
|
-
studioAssigned?: StudioAssigned;
|
|
913
|
-
/** Emitted when Studio is detached. */
|
|
914
|
-
studioUnassigned?: StudioUnassigned;
|
|
915
|
-
}
|
|
916
|
-
export interface Asset {
|
|
917
|
-
/** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */
|
|
918
|
-
appDefId?: string;
|
|
919
|
-
/** An instance id. For legacy reasons may be UUID or a string. */
|
|
920
|
-
instanceId?: string;
|
|
921
|
-
/** An application state. */
|
|
922
|
-
state?: State;
|
|
923
|
-
}
|
|
924
|
-
export declare enum State {
|
|
925
|
-
UNKNOWN = "UNKNOWN",
|
|
926
|
-
ENABLED = "ENABLED",
|
|
927
|
-
DISABLED = "DISABLED",
|
|
928
|
-
PENDING = "PENDING",
|
|
929
|
-
DEMO = "DEMO"
|
|
930
|
-
}
|
|
931
|
-
export interface SiteCreated {
|
|
932
|
-
/** A template identifier (empty if not created from a template). */
|
|
933
|
-
originTemplateId?: string;
|
|
934
|
-
/** An account id of the owner. */
|
|
935
|
-
ownerId?: string;
|
|
936
|
-
/** A context in which meta site was created. */
|
|
937
|
-
context?: SiteCreatedContext;
|
|
938
|
-
/**
|
|
939
|
-
* A meta site id from which this site was created.
|
|
940
|
-
*
|
|
941
|
-
* In case of a creation from a template it's a template id.
|
|
942
|
-
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
943
|
-
*/
|
|
944
|
-
originMetaSiteId?: string | null;
|
|
945
|
-
/** A meta site name (URL slug). */
|
|
946
|
-
siteName?: string;
|
|
947
|
-
/** A namespace. */
|
|
948
|
-
namespace?: Namespace;
|
|
949
|
-
}
|
|
950
|
-
export declare enum SiteCreatedContext {
|
|
951
|
-
/** A valid option, we don't expose all reasons why site might be created. */
|
|
952
|
-
OTHER = "OTHER",
|
|
953
|
-
/** A meta site was created from template. */
|
|
954
|
-
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
955
|
-
/** A meta site was created by copying of the transfferred meta site. */
|
|
956
|
-
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
957
|
-
/** A copy of existing meta site. */
|
|
958
|
-
DUPLICATE = "DUPLICATE",
|
|
959
|
-
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
960
|
-
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
961
|
-
/** deprecated A meta site was created for Flash editor. */
|
|
962
|
-
FLASH = "FLASH"
|
|
963
|
-
}
|
|
964
|
-
export declare enum Namespace {
|
|
965
|
-
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
966
|
-
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
967
|
-
WIX = "WIX",
|
|
968
|
-
/** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
969
|
-
SHOUT_OUT = "SHOUT_OUT",
|
|
970
|
-
/** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
971
|
-
ALBUMS = "ALBUMS",
|
|
972
|
-
/** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
973
|
-
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
974
|
-
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
975
|
-
HOTELS = "HOTELS",
|
|
976
|
-
/** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
977
|
-
CLUBS = "CLUBS",
|
|
978
|
-
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
979
|
-
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
980
|
-
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
981
|
-
DEV_SITE = "DEV_SITE",
|
|
982
|
-
/** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
983
|
-
LOGOS = "LOGOS",
|
|
984
|
-
/** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
985
|
-
VIDEO_MAKER = "VIDEO_MAKER",
|
|
986
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
987
|
-
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
988
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
989
|
-
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
990
|
-
/**
|
|
991
|
-
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
992
|
-
*
|
|
993
|
-
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
994
|
-
*/
|
|
995
|
-
HTML_DRAFT = "HTML_DRAFT",
|
|
996
|
-
/**
|
|
997
|
-
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
998
|
-
* Will be accessible from Site List and will not have a website app.
|
|
999
|
-
* Once the user attaches a site, the site will become a regular wixsite.
|
|
1000
|
-
*/
|
|
1001
|
-
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
1002
|
-
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
1003
|
-
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
1004
|
-
/** It is to be used in the Business First efforts. */
|
|
1005
|
-
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
1006
|
-
/** Bookings business flow with no site. */
|
|
1007
|
-
ANYWHERE = "ANYWHERE",
|
|
1008
|
-
/** Namespace for Headless Backoffice with no editor */
|
|
1009
|
-
HEADLESS = "HEADLESS",
|
|
1010
|
-
/**
|
|
1011
|
-
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
1012
|
-
* The site will be used for account level CSM feature for enterprise
|
|
1013
|
-
*/
|
|
1014
|
-
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
1015
|
-
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
1016
|
-
RISE = "RISE",
|
|
1017
|
-
/**
|
|
1018
|
-
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
1019
|
-
* There's a blank site behind the scene but it's blank).
|
|
1020
|
-
* The Mobile company will be the owner of this namespace.
|
|
1021
|
-
*/
|
|
1022
|
-
BRANDED_FIRST = "BRANDED_FIRST"
|
|
1023
|
-
}
|
|
1024
|
-
/** Site transferred to another user. */
|
|
1025
|
-
export interface SiteTransferred {
|
|
1026
|
-
/** A previous owner id (user that transfers meta site). */
|
|
1027
|
-
oldOwnerId?: string;
|
|
1028
|
-
/** A new owner id (user that accepts meta site). */
|
|
1029
|
-
newOwnerId?: string;
|
|
1030
|
-
}
|
|
1031
|
-
/** Soft deletion of the meta site. Could be restored. */
|
|
1032
|
-
export interface SiteDeleted {
|
|
1033
|
-
/** A deletion context. */
|
|
1034
|
-
deleteContext?: DeleteContext;
|
|
1035
|
-
}
|
|
1036
|
-
export interface DeleteContext {
|
|
1037
|
-
/** When the meta site was deleted. */
|
|
1038
|
-
dateDeleted?: Date;
|
|
1039
|
-
/** A status. */
|
|
1040
|
-
deleteStatus?: DeleteStatus;
|
|
1041
|
-
/** A reason (flow). */
|
|
1042
|
-
deleteOrigin?: string;
|
|
1043
|
-
/** A service that deleted it. */
|
|
1044
|
-
initiatorId?: string | null;
|
|
1045
|
-
}
|
|
1046
|
-
export declare enum DeleteStatus {
|
|
1047
|
-
UNKNOWN = "UNKNOWN",
|
|
1048
|
-
TRASH = "TRASH",
|
|
1049
|
-
DELETED = "DELETED",
|
|
1050
|
-
PENDING_PURGE = "PENDING_PURGE"
|
|
1051
|
-
}
|
|
1052
|
-
/** Restoration of the meta site. */
|
|
1053
|
-
export interface SiteUndeleted {
|
|
1054
|
-
}
|
|
1055
|
-
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
1056
|
-
export interface SitePublished {
|
|
1057
|
-
}
|
|
1058
|
-
export interface SiteUnpublished {
|
|
1059
|
-
/** A list of URLs previously associated with the meta site. */
|
|
1060
|
-
urls?: string[];
|
|
1061
|
-
}
|
|
1062
|
-
export interface SiteMarkedAsTemplate {
|
|
1063
|
-
}
|
|
1064
|
-
export interface SiteMarkedAsWixSite {
|
|
1065
|
-
}
|
|
1066
|
-
export interface ServiceProvisioned {
|
|
1067
|
-
/** Either UUID or EmbeddedServiceType. */
|
|
1068
|
-
appDefId?: string;
|
|
1069
|
-
/** Not only UUID. Something here could be something weird. */
|
|
1070
|
-
instanceId?: string;
|
|
1071
|
-
/** An instance id from which this instance is originated. */
|
|
1072
|
-
originInstanceId?: string;
|
|
1073
|
-
/** A version. */
|
|
1074
|
-
version?: string | null;
|
|
1075
|
-
}
|
|
1076
|
-
export interface ServiceRemoved {
|
|
1077
|
-
/** Either UUID or EmbeddedServiceType. */
|
|
1078
|
-
appDefId?: string;
|
|
1079
|
-
/** Not only UUID. Something here could be something weird. */
|
|
1080
|
-
instanceId?: string;
|
|
1081
|
-
/** A version. */
|
|
1082
|
-
version?: string | null;
|
|
1083
|
-
}
|
|
1084
|
-
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
1085
|
-
export interface SiteRenamed {
|
|
1086
|
-
/** A new meta site name (URL slug). */
|
|
1087
|
-
newSiteName?: string;
|
|
1088
|
-
/** A previous meta site name (URL slug). */
|
|
1089
|
-
oldSiteName?: string;
|
|
1090
|
-
}
|
|
1091
|
-
/**
|
|
1092
|
-
* Hard deletion of the meta site.
|
|
1093
|
-
*
|
|
1094
|
-
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
1095
|
-
*/
|
|
1096
|
-
export interface SiteHardDeleted {
|
|
1097
|
-
/** A deletion context. */
|
|
1098
|
-
deleteContext?: DeleteContext;
|
|
1099
|
-
}
|
|
1100
|
-
export interface NamespaceChanged {
|
|
1101
|
-
/** A previous namespace. */
|
|
1102
|
-
oldNamespace?: Namespace;
|
|
1103
|
-
/** A new namespace. */
|
|
1104
|
-
newNamespace?: Namespace;
|
|
1105
|
-
}
|
|
1106
|
-
/** Assigned Studio editor */
|
|
1107
|
-
export interface StudioAssigned {
|
|
1108
|
-
}
|
|
1109
|
-
/** Unassigned Studio editor */
|
|
1110
|
-
export interface StudioUnassigned {
|
|
1111
|
-
}
|
|
1112
|
-
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
1113
|
-
export interface SitePropertiesNotification {
|
|
1114
|
-
/** The site ID for which this update notification applies. */
|
|
1115
|
-
metasiteId?: string;
|
|
1116
|
-
/** The actual update event. */
|
|
1117
|
-
event?: SitePropertiesEvent;
|
|
1118
|
-
/** A convenience set of mappings from the MetaSite ID to its constituent services. */
|
|
1119
|
-
translations?: Translation[];
|
|
1120
|
-
/** Context of the notification */
|
|
1121
|
-
changeContext?: ChangeContext;
|
|
1122
|
-
}
|
|
1123
|
-
/** The actual update event for a particular notification. */
|
|
1124
|
-
export interface SitePropertiesEvent {
|
|
1125
|
-
/** Version of the site's properties represented by this update. */
|
|
1126
|
-
version?: number;
|
|
1127
|
-
/** Updated properties. */
|
|
1128
|
-
properties?: Properties;
|
|
1129
|
-
}
|
|
1130
|
-
export interface Properties {
|
|
1131
|
-
/** Site categories. */
|
|
1132
|
-
categories?: Categories;
|
|
1133
|
-
/** Site locale. */
|
|
1134
|
-
locale?: Locale;
|
|
1135
|
-
/**
|
|
1136
|
-
* Site language.
|
|
1137
|
-
*
|
|
1138
|
-
* Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
|
|
1139
|
-
*/
|
|
1140
|
-
language?: string | null;
|
|
1141
|
-
/**
|
|
1142
|
-
* Site currency format used to bill customers.
|
|
1143
|
-
*
|
|
1144
|
-
* Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
1145
|
-
*/
|
|
1146
|
-
paymentCurrency?: string | null;
|
|
1147
|
-
/** Timezone in `America/New_York` format. */
|
|
1148
|
-
timeZone?: string | null;
|
|
1149
|
-
/** Email address. */
|
|
1150
|
-
email?: string | null;
|
|
1151
|
-
/** Phone number. */
|
|
1152
|
-
phone?: string | null;
|
|
1153
|
-
/** Fax number. */
|
|
1154
|
-
fax?: string | null;
|
|
1155
|
-
/** Address. */
|
|
1156
|
-
address?: V4Address;
|
|
1157
|
-
/** Site display name. */
|
|
1158
|
-
siteDisplayName?: string | null;
|
|
1159
|
-
/** Business name. */
|
|
1160
|
-
businessName?: string | null;
|
|
1161
|
-
/** Path to the site's logo in Wix Media (without Wix Media base URL). */
|
|
1162
|
-
logo?: string | null;
|
|
1163
|
-
/** Site description. */
|
|
1164
|
-
description?: string | null;
|
|
1165
|
-
/**
|
|
1166
|
-
* Business schedule. Regular and exceptional time periods when the business is open or the service is available.
|
|
1167
|
-
*
|
|
1168
|
-
* __Note:__ Not supported by Wix Bookings.
|
|
1169
|
-
*/
|
|
1170
|
-
businessSchedule?: V4BusinessSchedule;
|
|
1171
|
-
/** Supported languages of a site and the primary language. */
|
|
1172
|
-
multilingual?: Multilingual;
|
|
1173
|
-
/** Cookie policy the site owner defined for their site (before the users interacts with/limits it). */
|
|
1174
|
-
consentPolicy?: ConsentPolicy;
|
|
1175
|
-
/**
|
|
1176
|
-
* Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
|
|
1177
|
-
*
|
|
1178
|
-
* Site business type.
|
|
1179
|
-
*/
|
|
1180
|
-
businessConfig?: string | null;
|
|
1181
|
-
/** External site url that uses Wix as its headless business solution */
|
|
1182
|
-
externalSiteUrl?: string | null;
|
|
1183
|
-
/** Track clicks analytics */
|
|
1184
|
-
trackClicksAnalytics?: boolean;
|
|
1185
|
-
}
|
|
1186
|
-
export interface Categories {
|
|
1187
|
-
/** Primary site category. */
|
|
1188
|
-
primary?: string;
|
|
1189
|
-
/** Secondary site category. */
|
|
1190
|
-
secondary?: string[];
|
|
1191
|
-
/** Business Term Id */
|
|
1192
|
-
businessTermId?: string | null;
|
|
1193
|
-
}
|
|
1194
|
-
export interface Locale {
|
|
1195
|
-
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1196
|
-
languageCode?: string;
|
|
1197
|
-
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
1198
|
-
country?: string;
|
|
1199
|
-
}
|
|
1200
|
-
export interface V4Address {
|
|
1201
|
-
/** Street name. */
|
|
1202
|
-
street?: string;
|
|
1203
|
-
/** City name. */
|
|
1204
|
-
city?: string;
|
|
1205
|
-
/** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
|
|
1206
|
-
country?: string;
|
|
1207
|
-
/** State. */
|
|
1208
|
-
state?: string;
|
|
1209
|
-
/** Zip or postal code. */
|
|
1210
|
-
zip?: string;
|
|
1211
|
-
/** Extra information to be displayed in the address. */
|
|
1212
|
-
hint?: AddressHint;
|
|
1213
|
-
/** Whether this address represents a physical location. */
|
|
1214
|
-
isPhysical?: boolean;
|
|
1215
|
-
/** Google-formatted version of this address. */
|
|
1216
|
-
googleFormattedAddress?: string;
|
|
1217
|
-
/** Street number. */
|
|
1218
|
-
streetNumber?: string;
|
|
1219
|
-
/** Apartment number. */
|
|
1220
|
-
apartmentNumber?: string;
|
|
1221
|
-
/** Geographic coordinates of location. */
|
|
1222
|
-
coordinates?: GeoCoordinates;
|
|
1223
|
-
}
|
|
1224
|
-
/**
|
|
1225
|
-
* Extra information on displayed addresses.
|
|
1226
|
-
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
1227
|
-
* Free text. In addition the user can state where he wants that additional description - before, after, or instead
|
|
1228
|
-
* the address string.
|
|
1229
|
-
*/
|
|
1230
|
-
export interface AddressHint {
|
|
1231
|
-
/** Extra text displayed next to, or instead of, the actual address. */
|
|
1232
|
-
text?: string;
|
|
1233
|
-
/** Where the extra text should be displayed. */
|
|
1234
|
-
placement?: PlacementType;
|
|
1235
|
-
}
|
|
1236
|
-
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
1237
|
-
export declare enum PlacementType {
|
|
1238
|
-
BEFORE = "BEFORE",
|
|
1239
|
-
AFTER = "AFTER",
|
|
1240
|
-
REPLACE = "REPLACE"
|
|
1241
|
-
}
|
|
1242
|
-
/** Geocoordinates for a particular address. */
|
|
1243
|
-
export interface GeoCoordinates {
|
|
1244
|
-
/** Latitude of the location. Must be between -90 and 90. */
|
|
1245
|
-
latitude?: number;
|
|
1246
|
-
/** Longitude of the location. Must be between -180 and 180. */
|
|
1247
|
-
longitude?: number;
|
|
1248
|
-
}
|
|
1249
|
-
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
1250
|
-
export interface V4BusinessSchedule {
|
|
1251
|
-
/** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */
|
|
1252
|
-
periods?: V4TimePeriod[];
|
|
1253
|
-
/** Exceptions to the business's regular hours. The business can be open or closed during the exception. */
|
|
1254
|
-
specialHourPeriod?: V4SpecialHourPeriod[];
|
|
1255
|
-
}
|
|
1256
|
-
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
1257
|
-
export interface V4TimePeriod {
|
|
1258
|
-
/** Day of the week the period starts on. */
|
|
1259
|
-
openDay?: V4DayOfWeek;
|
|
1260
|
-
/**
|
|
1261
|
-
* Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
1262
|
-
* midnight at the end of the specified day.
|
|
1263
|
-
*/
|
|
1264
|
-
openTime?: string;
|
|
1265
|
-
/** Day of the week the period ends on. */
|
|
1266
|
-
closeDay?: V4DayOfWeek;
|
|
1267
|
-
/**
|
|
1268
|
-
* Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
1269
|
-
* midnight at the end of the specified day.
|
|
1270
|
-
*
|
|
1271
|
-
* __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
|
|
1272
|
-
*/
|
|
1273
|
-
closeTime?: string;
|
|
1274
|
-
}
|
|
1275
|
-
/** Enumerates the days of the week. */
|
|
1276
|
-
export declare enum V4DayOfWeek {
|
|
1277
|
-
MONDAY = "MONDAY",
|
|
1278
|
-
TUESDAY = "TUESDAY",
|
|
1279
|
-
WEDNESDAY = "WEDNESDAY",
|
|
1280
|
-
THURSDAY = "THURSDAY",
|
|
1281
|
-
FRIDAY = "FRIDAY",
|
|
1282
|
-
SATURDAY = "SATURDAY",
|
|
1283
|
-
SUNDAY = "SUNDAY"
|
|
1284
|
-
}
|
|
1285
|
-
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
1286
|
-
export interface V4SpecialHourPeriod {
|
|
1287
|
-
/** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
1288
|
-
startDate?: string;
|
|
1289
|
-
/** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
1290
|
-
endDate?: string;
|
|
1291
|
-
/**
|
|
1292
|
-
* Whether the business is closed (or the service is not available) during the exception.
|
|
1293
|
-
*
|
|
1294
|
-
* Default: `true`.
|
|
1295
|
-
*/
|
|
1296
|
-
isClosed?: boolean;
|
|
1297
|
-
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
1298
|
-
comment?: string;
|
|
1299
|
-
}
|
|
1300
|
-
export interface Multilingual {
|
|
1301
|
-
/** Supported languages list. */
|
|
1302
|
-
supportedLanguages?: SupportedLanguage[];
|
|
1303
|
-
/** Whether to redirect to user language. */
|
|
1304
|
-
autoRedirect?: boolean;
|
|
1305
|
-
}
|
|
1306
|
-
export interface SupportedLanguage {
|
|
1307
|
-
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1308
|
-
languageCode?: string;
|
|
1309
|
-
/** Locale. */
|
|
1310
|
-
locale?: Locale;
|
|
1311
|
-
/** Whether the supported language is the primary language for the site. */
|
|
1312
|
-
isPrimary?: boolean;
|
|
1313
|
-
/** Language icon. */
|
|
1314
|
-
countryCode?: string;
|
|
1315
|
-
/** How the language will be resolved. For internal use. */
|
|
1316
|
-
resolutionMethod?: ResolutionMethod;
|
|
1317
|
-
}
|
|
1318
|
-
export declare enum ResolutionMethod {
|
|
1319
|
-
QUERY_PARAM = "QUERY_PARAM",
|
|
1320
|
-
SUBDOMAIN = "SUBDOMAIN",
|
|
1321
|
-
SUBDIRECTORY = "SUBDIRECTORY"
|
|
1322
|
-
}
|
|
1323
|
-
export interface ConsentPolicy {
|
|
1324
|
-
/** Whether the site uses cookies that are essential to site operation. */
|
|
1325
|
-
essential?: boolean | null;
|
|
1326
|
-
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
1327
|
-
functional?: boolean | null;
|
|
1328
|
-
/** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
|
|
1329
|
-
analytics?: boolean | null;
|
|
1330
|
-
/** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
|
|
1331
|
-
advertising?: boolean | null;
|
|
1332
|
-
/** CCPA compliance flag. */
|
|
1333
|
-
dataToThirdParty?: boolean | null;
|
|
1334
|
-
}
|
|
1335
|
-
/** A single mapping from the MetaSite ID to a particular service. */
|
|
1336
|
-
export interface Translation {
|
|
1337
|
-
/** The service type. */
|
|
1338
|
-
serviceType?: string;
|
|
1339
|
-
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
1340
|
-
appDefId?: string;
|
|
1341
|
-
/** The instance ID of the service. */
|
|
1342
|
-
instanceId?: string;
|
|
1343
|
-
}
|
|
1344
|
-
export interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
1345
|
-
/** Properties were updated. */
|
|
1346
|
-
propertiesChange?: PropertiesChange;
|
|
1347
|
-
/** Default properties were created on site creation. */
|
|
1348
|
-
siteCreated?: V4SiteCreated;
|
|
1349
|
-
/** Properties were cloned on site cloning. */
|
|
1350
|
-
siteCloned?: SiteCloned;
|
|
1351
|
-
}
|
|
1352
|
-
/** @oneof */
|
|
1353
|
-
export interface ChangeContextPayloadOneOf {
|
|
1354
|
-
/** Properties were updated. */
|
|
1355
|
-
propertiesChange?: PropertiesChange;
|
|
1356
|
-
/** Default properties were created on site creation. */
|
|
1357
|
-
siteCreated?: V4SiteCreated;
|
|
1358
|
-
/** Properties were cloned on site cloning. */
|
|
1359
|
-
siteCloned?: SiteCloned;
|
|
1360
|
-
}
|
|
1361
|
-
export interface PropertiesChange {
|
|
1362
|
-
}
|
|
1363
|
-
export interface V4SiteCreated {
|
|
1364
|
-
/** Origin template site id. */
|
|
1365
|
-
originTemplateId?: string | null;
|
|
1366
|
-
}
|
|
1367
|
-
export interface SiteCloned {
|
|
1368
|
-
/** Origin site id. */
|
|
1369
|
-
originMetaSiteId?: string;
|
|
1370
|
-
}
|
|
1371
|
-
export interface FeatureEvent extends FeatureEventEventOneOf {
|
|
1372
|
-
/**
|
|
1373
|
-
* Information about an event that makes a feature eligible to the user.
|
|
1374
|
-
* Triggered for example, for new features or when a feature is reassigned
|
|
1375
|
-
* to an account or a site.
|
|
1376
|
-
*/
|
|
1377
|
-
enabled?: FeatureEnabled;
|
|
1378
|
-
/**
|
|
1379
|
-
* Information about an event that disables a feature for the user.
|
|
1380
|
-
* Triggered for example, when a feature is unassigned from a site,
|
|
1381
|
-
* reassigned to a different site, or the user switched to a different contract.
|
|
1382
|
-
*/
|
|
1383
|
-
disabled?: FeatureDisabled;
|
|
1384
|
-
/**
|
|
1385
|
-
* Information about an event that updates a feature. An `updated` event
|
|
1386
|
-
* is triggered for example by the
|
|
1387
|
-
* [Report Quota Usage](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/report-quota-usage)
|
|
1388
|
-
* and [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter)
|
|
1389
|
-
* endpoints.
|
|
1390
|
-
*/
|
|
1391
|
-
updated?: FeatureUpdated;
|
|
1392
|
-
/**
|
|
1393
|
-
* Information about an event that cancels a feature for the user.
|
|
1394
|
-
* Triggered for example, when a feature is canceled, transferred to
|
|
1395
|
-
* another account, or the user switched to a different contract.
|
|
1396
|
-
*/
|
|
1397
|
-
cancelled?: FeatureCancelled;
|
|
1398
|
-
/**
|
|
1399
|
-
* Timestamp of the event in
|
|
1400
|
-
* [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
1401
|
-
*/
|
|
1402
|
-
timestamp?: Date;
|
|
1403
|
-
}
|
|
1404
|
-
/** @oneof */
|
|
1405
|
-
export interface FeatureEventEventOneOf {
|
|
1406
|
-
/**
|
|
1407
|
-
* Information about an event that makes a feature eligible to the user.
|
|
1408
|
-
* Triggered for example, for new features or when a feature is reassigned
|
|
1409
|
-
* to an account or a site.
|
|
1410
|
-
*/
|
|
1411
|
-
enabled?: FeatureEnabled;
|
|
1412
|
-
/**
|
|
1413
|
-
* Information about an event that disables a feature for the user.
|
|
1414
|
-
* Triggered for example, when a feature is unassigned from a site,
|
|
1415
|
-
* reassigned to a different site, or the user switched to a different contract.
|
|
1416
|
-
*/
|
|
1417
|
-
disabled?: FeatureDisabled;
|
|
1418
|
-
/**
|
|
1419
|
-
* Information about an event that updates a feature. An `updated` event
|
|
1420
|
-
* is triggered for example by the
|
|
1421
|
-
* [Report Quota Usage](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/report-quota-usage)
|
|
1422
|
-
* and [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter)
|
|
1423
|
-
* endpoints.
|
|
1424
|
-
*/
|
|
1425
|
-
updated?: FeatureUpdated;
|
|
1426
|
-
/**
|
|
1427
|
-
* Information about an event that cancels a feature for the user.
|
|
1428
|
-
* Triggered for example, when a feature is canceled, transferred to
|
|
1429
|
-
* another account, or the user switched to a different contract.
|
|
1430
|
-
*/
|
|
1431
|
-
cancelled?: FeatureCancelled;
|
|
1432
|
-
}
|
|
1433
|
-
/** Feature created or enabled after disabled state */
|
|
1434
|
-
export interface FeatureEnabled extends FeatureEnabledReasonOneOf {
|
|
1435
|
-
/** Information about a transfer from another account. */
|
|
1436
|
-
transferredFromAnotherAccount?: TransferredFromAnotherAccountReason;
|
|
1437
|
-
/** Information about a transfer from another site. */
|
|
1438
|
-
reassignedFromSite?: ReassignedFromSiteReason;
|
|
1439
|
-
/** Information about a feature that hadn't been assigned to site. */
|
|
1440
|
-
assignedFromFloating?: AssignedFromFloatingReason;
|
|
1441
|
-
/** Information about the new feature. */
|
|
1442
|
-
newFeature?: NewFeatureReason;
|
|
1443
|
-
/** Information about the contract switch. */
|
|
1444
|
-
contractSwitched?: ContractSwitchedReason;
|
|
1445
|
-
/** Information about the manually created features. */
|
|
1446
|
-
manualFeatureCreation?: ManualFeatureCreationReason;
|
|
1447
|
-
/** Information about a feature that was migrated from legacy. */
|
|
1448
|
-
migratedFromLegacy?: MigratedFromLegacyReason;
|
|
1449
|
-
/** Enabled feature. */
|
|
1450
|
-
feature?: Feature;
|
|
1451
|
-
/**
|
|
1452
|
-
* Information about a transfer from another account.
|
|
1453
|
-
* __Deprecated__. Use `reason.transferred_from_another_account` instead.
|
|
1454
|
-
*/
|
|
1455
|
-
transferredFromAccount?: string | null;
|
|
1456
|
-
/**
|
|
1457
|
-
* Information about a transfer from another site.
|
|
1458
|
-
* __Deprecated__. Use `reason.reassigned_from_site` instead.
|
|
1459
|
-
*/
|
|
1460
|
-
reassignedFromMetasite?: string | null;
|
|
1461
|
-
}
|
|
1462
|
-
/** @oneof */
|
|
1463
|
-
export interface FeatureEnabledReasonOneOf {
|
|
1464
|
-
/** Information about a transfer from another account. */
|
|
1465
|
-
transferredFromAnotherAccount?: TransferredFromAnotherAccountReason;
|
|
1466
|
-
/** Information about a transfer from another site. */
|
|
1467
|
-
reassignedFromSite?: ReassignedFromSiteReason;
|
|
1468
|
-
/** Information about a feature that hadn't been assigned to site. */
|
|
1469
|
-
assignedFromFloating?: AssignedFromFloatingReason;
|
|
1470
|
-
/** Information about the new feature. */
|
|
1471
|
-
newFeature?: NewFeatureReason;
|
|
1472
|
-
/** Information about the contract switch. */
|
|
1473
|
-
contractSwitched?: ContractSwitchedReason;
|
|
1474
|
-
/** Information about the manually created features. */
|
|
1475
|
-
manualFeatureCreation?: ManualFeatureCreationReason;
|
|
1476
|
-
/** Information about a feature that was migrated from legacy. */
|
|
1477
|
-
migratedFromLegacy?: MigratedFromLegacyReason;
|
|
1478
|
-
}
|
|
1479
|
-
export interface Feature extends FeatureQuantityInfoOneOf {
|
|
1480
|
-
/** Deprecated. Use `enabled` instead. */
|
|
1481
|
-
booleanFeature?: BooleanFeature;
|
|
1482
|
-
/** Deprecated. Use `quotaInfo` instead. */
|
|
1483
|
-
quotaFeature?: QuotaFeature;
|
|
1484
|
-
/**
|
|
1485
|
-
* ID of the feature. __Note:__ Isn't unique. For example, all features that
|
|
1486
|
-
* are available to free Wix accounts or site in some capacity have
|
|
1487
|
-
* `{"id": "DEFAULT"}`. Use `uniqueName` as unique identifier for a feature.
|
|
1488
|
-
* @readonly
|
|
1489
|
-
*/
|
|
1490
|
-
id?: string;
|
|
1491
|
-
/**
|
|
1492
|
-
* Unique name of the feature. Only lower case letters, numbers, and dashes
|
|
1493
|
-
* `-` are supported. Used in the endpoints of the
|
|
1494
|
-
* [Features Manager API](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/introduction)
|
|
1495
|
-
* to specify the feature. Not visible to customers. We recommend to start
|
|
1496
|
-
* the unique name with a prefix describing your organization or Wix company.
|
|
1497
|
-
* For example, `bookings` or `crm`.
|
|
1498
|
-
*
|
|
1499
|
-
* Min: 2 characters
|
|
1500
|
-
* Max: 50 characters
|
|
1501
|
-
*/
|
|
1502
|
-
uniqueName?: string;
|
|
1503
|
-
/**
|
|
1504
|
-
* Information about whether the feature belongs to a Wix account or site.
|
|
1505
|
-
* Account features have `context.userId`. Site features have `context.metaSiteId` in case
|
|
1506
|
-
* they're assigned to a specific site. Site features that aren't assigned to
|
|
1507
|
-
* a specific site have neither ID.
|
|
1508
|
-
*/
|
|
1509
|
-
context?: FeatureContext;
|
|
1510
|
-
/**
|
|
1511
|
-
* Deprecated.
|
|
1512
|
-
* @readonly
|
|
1513
|
-
*/
|
|
1514
|
-
createdAt?: Date;
|
|
1515
|
-
/**
|
|
1516
|
-
* Deprecated.
|
|
1517
|
-
* @readonly
|
|
1518
|
-
*/
|
|
1519
|
-
updatedAt?: Date;
|
|
1520
|
-
/**
|
|
1521
|
-
* Information about how often customers can use the feature during a specific
|
|
1522
|
-
* period. Available only for quota features.
|
|
1523
|
-
*/
|
|
1524
|
-
quotaInfo?: QuotaInfo;
|
|
1525
|
-
/**
|
|
1526
|
-
* Whether the customer is currently allowed to use the feature.
|
|
1527
|
-
* `true` means that the customer can use the feature. This means a boolean
|
|
1528
|
-
* feature is active or a quota feature has remaining usage.
|
|
1529
|
-
* `false` means that the customer can't use the feature.
|
|
1530
|
-
* This means a boolean feature isn't active or a quota feature doesn't
|
|
1531
|
-
* have remaining usage.
|
|
1532
|
-
*/
|
|
1533
|
-
enabled?: boolean;
|
|
1534
|
-
/**
|
|
1535
|
-
* ID of the [subscription](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/subscription-object)
|
|
1536
|
-
* to which the feature instance belongs.
|
|
1537
|
-
*/
|
|
1538
|
-
subscriptionId?: string | null;
|
|
1539
|
-
/**
|
|
1540
|
-
* Metadata of the feature. Wix Premium uses the metadata object to indicate
|
|
1541
|
-
* that customers who purchase a product with the feature also get
|
|
1542
|
-
* access to an additional product. For these bundled products `metadata`
|
|
1543
|
-
* looks like this: `{"tpa": "{"appDefId": "sample-app-def-id-1234567890", "vendorProductId": "sample-productId"}}"`.
|
|
1544
|
-
* But you can use the `metadata` property for other purposes, too.
|
|
1545
|
-
*/
|
|
1546
|
-
metadata?: Record<string, string>;
|
|
1547
|
-
}
|
|
1548
|
-
/** @oneof */
|
|
1549
|
-
export interface FeatureQuantityInfoOneOf {
|
|
1550
|
-
/** Deprecated. Use `enabled` instead. */
|
|
1551
|
-
booleanFeature?: BooleanFeature;
|
|
1552
|
-
/** Deprecated. Use `quotaInfo` instead. */
|
|
1553
|
-
quotaFeature?: QuotaFeature;
|
|
1554
|
-
}
|
|
1555
|
-
/**
|
|
1556
|
-
* Context this feature is currently connected to.
|
|
1557
|
-
* Note: Do not confuse with feature scope which is configured in the product catalog
|
|
1558
|
-
* and defines in which context the product can be used
|
|
1559
|
-
*/
|
|
1560
|
-
export interface FeatureContext {
|
|
1561
|
-
/**
|
|
1562
|
-
* ID of the Wix account that the feature instance belongs to.
|
|
1563
|
-
* Available for both site and account level feature instances.
|
|
1564
|
-
*/
|
|
1565
|
-
userId?: string;
|
|
1566
|
-
/**
|
|
1567
|
-
* ID of the meta site that the feature instance is assigned to.
|
|
1568
|
-
* Only available for site level feature instances that are assigned to a Wix
|
|
1569
|
-
* site. Not available for account level and unassigned site level feature
|
|
1570
|
-
* instances.
|
|
1571
|
-
*/
|
|
1572
|
-
metaSiteId?: string | null;
|
|
1573
|
-
}
|
|
1574
|
-
/**
|
|
1575
|
-
* A feature that can be either "enabled" or "disabled". The default/freemium setting is always OFF, and the premium setting is always ON (meaning, unlimited usage without tracking).
|
|
1576
|
-
* A boolean feature is similar to a quantitive feature with a default limit of 0 and UNLIMITED premium limit (although a bit simplified).
|
|
1577
|
-
*/
|
|
1578
|
-
export interface BooleanFeature {
|
|
1579
|
-
}
|
|
1580
|
-
/** A feature with a periodic usage limitation. The default limit is defined in the Feature Spec, the Premium limits are defined in the respective ProductFeature. */
|
|
1581
|
-
export interface QuotaFeature {
|
|
1582
|
-
/** Default (or Freemium) quota limitation. if left undefined the free feature has unlimited amount. */
|
|
1583
|
-
limit?: string | null;
|
|
1584
|
-
/** Periodic time-frame to reset the usage counter. You may use NO_PERIOD if counter shouldn't be reset. */
|
|
1585
|
-
period?: FeaturePeriod;
|
|
1586
|
-
/** Usage measurement units (seconds? MBs? unitless?). Usage reported will be counted in multiples of this basic unit. */
|
|
1587
|
-
units?: string | null;
|
|
1588
|
-
}
|
|
1589
|
-
/** Determines the reset cycle of the feature usage. */
|
|
1590
|
-
export declare enum FeaturePeriod {
|
|
1591
|
-
NO_PERIOD = "NO_PERIOD",
|
|
1592
|
-
MILLISECOND = "MILLISECOND",
|
|
1593
|
-
SECOND = "SECOND",
|
|
1594
|
-
MINUTE = "MINUTE",
|
|
1595
|
-
HOUR = "HOUR",
|
|
1596
|
-
DAY = "DAY",
|
|
1597
|
-
WEEK = "WEEK",
|
|
1598
|
-
MONTH = "MONTH",
|
|
1599
|
-
YEAR = "YEAR"
|
|
1600
|
-
}
|
|
1601
|
-
export interface QuotaInfo {
|
|
1602
|
-
/**
|
|
1603
|
-
* How often the customer is allowed to use the feature during the specified
|
|
1604
|
-
* period. `null` means that the customer has unlimited access to the feature.
|
|
1605
|
-
*/
|
|
1606
|
-
limit?: string | null;
|
|
1607
|
-
/**
|
|
1608
|
-
* Time frame for the usage limitation. `NO_PERIOD` means that `remainingUsage`
|
|
1609
|
-
* isn't automatically reset to the feature's `limit` after a specific period.
|
|
1610
|
-
* You may still manually call
|
|
1611
|
-
* [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter).
|
|
1612
|
-
*/
|
|
1613
|
-
period?: FeaturePeriod;
|
|
1614
|
-
/**
|
|
1615
|
-
* How often the customer has used the feature during the current
|
|
1616
|
-
* period.
|
|
1617
|
-
*/
|
|
1618
|
-
currentUsage?: string;
|
|
1619
|
-
/**
|
|
1620
|
-
* How often the customer can still use the feature during the current
|
|
1621
|
-
* period. `null` means that the customer has unlimited access to the feature.
|
|
1622
|
-
*/
|
|
1623
|
-
remainingUsage?: string | null;
|
|
1624
|
-
}
|
|
1625
|
-
/** Subscription transferred from another account, features on the current account were enabled. */
|
|
1626
|
-
export interface TransferredFromAnotherAccountReason {
|
|
1627
|
-
/** Information about a transfer from another account. */
|
|
1628
|
-
transferredFromAccount?: string;
|
|
1629
|
-
}
|
|
1630
|
-
/** Subscription moved from one site to another in the same account, features enabled on the target site */
|
|
1631
|
-
export interface ReassignedFromSiteReason {
|
|
1632
|
-
/** Information about a transfer from another site. */
|
|
1633
|
-
reassignedFromMetasite?: string;
|
|
1634
|
-
}
|
|
1635
|
-
/** Subscription was floating and assigned to site, features enabled on the target site */
|
|
1636
|
-
export interface AssignedFromFloatingReason {
|
|
1637
|
-
}
|
|
1638
|
-
/** New subscription created and features created as enabled */
|
|
1639
|
-
export interface NewFeatureReason {
|
|
1640
|
-
}
|
|
1641
|
-
/** Subscription was upgraded or downgraded, as a result new features enabled, missing features disabled , quantities are updated */
|
|
1642
|
-
export interface ContractSwitchedReason {
|
|
1643
|
-
}
|
|
1644
|
-
/** a call to CreateFeature in features-writer, creates feature that is not attached to subscription */
|
|
1645
|
-
export interface ManualFeatureCreationReason {
|
|
1646
|
-
}
|
|
1647
|
-
/** Subscription created due to migration from old premium model */
|
|
1648
|
-
export interface MigratedFromLegacyReason {
|
|
1649
|
-
}
|
|
1650
|
-
/** Feature disabled and can be enabled in the future */
|
|
1651
|
-
export interface FeatureDisabled extends FeatureDisabledReasonOneOf {
|
|
1652
|
-
/** Information about a feature that's no longer assigned to a site. */
|
|
1653
|
-
unassingedToFloating?: UnAssingedToFloatingReason;
|
|
1654
|
-
/**
|
|
1655
|
-
* Information about a feature that's been replaced by a feature from a
|
|
1656
|
-
* different subscription.
|
|
1657
|
-
*/
|
|
1658
|
-
replacedByAnotherSubscription?: ReplacedByAnotherSubscriptionReason;
|
|
1659
|
-
/**
|
|
1660
|
-
* Information about a feature that's been reassigned to a different
|
|
1661
|
-
* site.
|
|
1662
|
-
*/
|
|
1663
|
-
reassignedToAnotherSite?: ReassignedToAnotherSiteReason;
|
|
1664
|
-
/**
|
|
1665
|
-
* Disabled feature. Includes information about the feature's new state,
|
|
1666
|
-
* possibly its new context.
|
|
1667
|
-
*/
|
|
1668
|
-
feature?: Feature;
|
|
1669
|
-
/** ID of the meta site for which the feature has been disabled. */
|
|
1670
|
-
metaSiteId?: string | null;
|
|
1671
|
-
}
|
|
1672
|
-
/** @oneof */
|
|
1673
|
-
export interface FeatureDisabledReasonOneOf {
|
|
1674
|
-
/** Information about a feature that's no longer assigned to a site. */
|
|
1675
|
-
unassingedToFloating?: UnAssingedToFloatingReason;
|
|
1676
|
-
/**
|
|
1677
|
-
* Information about a feature that's been replaced by a feature from a
|
|
1678
|
-
* different subscription.
|
|
1679
|
-
*/
|
|
1680
|
-
replacedByAnotherSubscription?: ReplacedByAnotherSubscriptionReason;
|
|
1681
|
-
/**
|
|
1682
|
-
* Information about a feature that's been reassigned to a different
|
|
1683
|
-
* site.
|
|
1684
|
-
*/
|
|
1685
|
-
reassignedToAnotherSite?: ReassignedToAnotherSiteReason;
|
|
1686
|
-
}
|
|
1687
|
-
/** Subscription was unassigned from the site and moved into floating state */
|
|
1688
|
-
export interface UnAssingedToFloatingReason {
|
|
1689
|
-
}
|
|
1690
|
-
/** Another subscription was assigned to the site, causing existing features on this site to be disabled */
|
|
1691
|
-
export interface ReplacedByAnotherSubscriptionReason {
|
|
1692
|
-
}
|
|
1693
|
-
/** Subscription was assigned to another site, causing features on the origin site to be disabled. */
|
|
1694
|
-
export interface ReassignedToAnotherSiteReason {
|
|
1695
|
-
/** Information about a transfer to the site. */
|
|
1696
|
-
reassignedToMetasite?: string;
|
|
1697
|
-
}
|
|
1698
|
-
/** Feature updated, for example Quota was increased due to upgrade */
|
|
1699
|
-
export interface FeatureUpdated extends FeatureUpdatedPreviousQuantityInfoOneOf, FeatureUpdatedReasonOneOf {
|
|
1700
|
-
/** Information about a feature that doesn't have a usage quota. */
|
|
1701
|
-
booleanFeature?: BooleanFeature;
|
|
1702
|
-
/** Information about a feature that has a usage quota. */
|
|
1703
|
-
quotaFeature?: QuotaFeature;
|
|
1704
|
-
/** Information about the contract switch. */
|
|
1705
|
-
contractSwitched?: ContractSwitchedReason;
|
|
1706
|
-
/**
|
|
1707
|
-
* Updated feature. Includes information about the feature's new state and
|
|
1708
|
-
* possibly its new context.
|
|
1709
|
-
*/
|
|
1710
|
-
feature?: Feature;
|
|
1711
|
-
}
|
|
1712
|
-
/** @oneof */
|
|
1713
|
-
export interface FeatureUpdatedPreviousQuantityInfoOneOf {
|
|
1714
|
-
/** Information about a feature that doesn't have a usage quota. */
|
|
1715
|
-
booleanFeature?: BooleanFeature;
|
|
1716
|
-
/** Information about a feature that has a usage quota. */
|
|
1717
|
-
quotaFeature?: QuotaFeature;
|
|
1718
|
-
}
|
|
1719
|
-
/** @oneof */
|
|
1720
|
-
export interface FeatureUpdatedReasonOneOf {
|
|
1721
|
-
/** Information about the contract switch. */
|
|
1722
|
-
contractSwitched?: ContractSwitchedReason;
|
|
1723
|
-
}
|
|
1724
|
-
/** Feature was permanently cancelled */
|
|
1725
|
-
export interface FeatureCancelled extends FeatureCancelledReasonOneOf {
|
|
1726
|
-
/** Information about a transfer to the account. */
|
|
1727
|
-
transferredToAnotherAccount?: TransferredToAnotherAccountReason;
|
|
1728
|
-
/** Information about the contract switch. */
|
|
1729
|
-
contractSwitched?: ContractSwitchedReason;
|
|
1730
|
-
/** Information about the feature cancellation. */
|
|
1731
|
-
cancelRequest?: CancelRequestedReason;
|
|
1732
|
-
/** Canceled feature. */
|
|
1733
|
-
feature?: Feature;
|
|
1734
|
-
/**
|
|
1735
|
-
* Information about a transfer to the account.
|
|
1736
|
-
* __Deprecated__. Use `reason.transferred_to_account` instead.
|
|
1737
|
-
*/
|
|
1738
|
-
transferredToAccount?: string | null;
|
|
1739
|
-
}
|
|
1740
|
-
/** @oneof */
|
|
1741
|
-
export interface FeatureCancelledReasonOneOf {
|
|
1742
|
-
/** Information about a transfer to the account. */
|
|
1743
|
-
transferredToAnotherAccount?: TransferredToAnotherAccountReason;
|
|
1744
|
-
/** Information about the contract switch. */
|
|
1745
|
-
contractSwitched?: ContractSwitchedReason;
|
|
1746
|
-
/** Information about the feature cancellation. */
|
|
1747
|
-
cancelRequest?: CancelRequestedReason;
|
|
1748
|
-
}
|
|
1749
|
-
/** Subscription was transferred to another account, features in the origin account were cancelled */
|
|
1750
|
-
export interface TransferredToAnotherAccountReason {
|
|
1751
|
-
/** Information about a transfer to the account. */
|
|
1752
|
-
transferredToAccount?: string;
|
|
1753
|
-
}
|
|
1754
|
-
/** Cancellation was requested from the subscription manager api, might be a result of billing event, or direct call */
|
|
1755
|
-
export interface CancelRequestedReason {
|
|
1756
|
-
}
|
|
1757
|
-
export interface GetReservationLocationResponseNonNullableFields {
|
|
1758
|
-
reservationLocation?: {
|
|
1759
|
-
location?: {
|
|
1760
|
-
address?: {
|
|
1761
|
-
streetAddress?: {
|
|
1762
|
-
number: string;
|
|
1763
|
-
name: string;
|
|
1764
|
-
apt: string;
|
|
1765
|
-
};
|
|
1766
|
-
};
|
|
1767
|
-
businessSchedule?: {
|
|
1768
|
-
periods: {
|
|
1769
|
-
openDay: DayOfWeek;
|
|
1770
|
-
openTime: string;
|
|
1771
|
-
closeDay: DayOfWeek;
|
|
1772
|
-
closeTime: string;
|
|
1773
|
-
}[];
|
|
1774
|
-
specialHourPeriod: {
|
|
1775
|
-
startDate: string;
|
|
1776
|
-
endDate: string;
|
|
1777
|
-
isClosed: boolean;
|
|
1778
|
-
comment: string;
|
|
1779
|
-
}[];
|
|
1780
|
-
};
|
|
1781
|
-
};
|
|
1782
|
-
configuration?: {
|
|
1783
|
-
onlineReservations?: {
|
|
1784
|
-
seatPacing?: {
|
|
1785
|
-
number: number;
|
|
1786
|
-
enabled: boolean;
|
|
1787
|
-
};
|
|
1788
|
-
partyPacing?: {
|
|
1789
|
-
number: number;
|
|
1790
|
-
enabled: boolean;
|
|
1791
|
-
};
|
|
1792
|
-
partiesSize?: {
|
|
1793
|
-
min: number;
|
|
1794
|
-
max: number;
|
|
1795
|
-
};
|
|
1796
|
-
partySize?: {
|
|
1797
|
-
min: number;
|
|
1798
|
-
max: number;
|
|
1799
|
-
};
|
|
1800
|
-
minimumReservationNotice?: {
|
|
1801
|
-
number: number;
|
|
1802
|
-
unit: Unit;
|
|
1803
|
-
};
|
|
1804
|
-
turnoverTimeRules: {
|
|
1805
|
-
seatsMin: number;
|
|
1806
|
-
seatsMax: number;
|
|
1807
|
-
minutes: number;
|
|
1808
|
-
}[];
|
|
1809
|
-
turnoverRules: {
|
|
1810
|
-
minSeats: number;
|
|
1811
|
-
maxSeats: number;
|
|
1812
|
-
minutes: number;
|
|
1813
|
-
}[];
|
|
1814
|
-
businessSchedule?: {
|
|
1815
|
-
periods: {
|
|
1816
|
-
openDay: DayOfWeek;
|
|
1817
|
-
openTime: string;
|
|
1818
|
-
closeDay: DayOfWeek;
|
|
1819
|
-
closeTime: string;
|
|
1820
|
-
}[];
|
|
1821
|
-
specialHourPeriod: {
|
|
1822
|
-
startDate: string;
|
|
1823
|
-
endDate: string;
|
|
1824
|
-
isClosed: boolean;
|
|
1825
|
-
comment: string;
|
|
1826
|
-
}[];
|
|
1827
|
-
};
|
|
1828
|
-
manualApproval?: {
|
|
1829
|
-
partySizeThreshold: number;
|
|
1830
|
-
customApprovalsProviderId: string;
|
|
1831
|
-
enabled: boolean;
|
|
1832
|
-
};
|
|
1833
|
-
};
|
|
1834
|
-
reservationForm?: {
|
|
1835
|
-
termsAndConditions?: {
|
|
1836
|
-
url?: {
|
|
1837
|
-
relativePath: string;
|
|
1838
|
-
};
|
|
1839
|
-
enabled: boolean;
|
|
1840
|
-
};
|
|
1841
|
-
privacyPolicy?: {
|
|
1842
|
-
url?: {
|
|
1843
|
-
relativePath: string;
|
|
1844
|
-
};
|
|
1845
|
-
enabled: boolean;
|
|
1846
|
-
};
|
|
1847
|
-
customFieldDefinitions: {
|
|
1848
|
-
name: string;
|
|
1849
|
-
required: boolean;
|
|
1850
|
-
}[];
|
|
1851
|
-
emailMarketingCheckbox?: {
|
|
1852
|
-
enabled: boolean;
|
|
1853
|
-
checkedByDefault: boolean;
|
|
1854
|
-
};
|
|
1855
|
-
};
|
|
1856
|
-
myReservationsFields: {
|
|
1857
|
-
fieldType: FieldType;
|
|
1858
|
-
shown: boolean;
|
|
1859
|
-
}[];
|
|
1860
|
-
tableManagement?: {
|
|
1861
|
-
tableDefinitions: {
|
|
1862
|
-
name: string;
|
|
1863
|
-
seatsMin: number;
|
|
1864
|
-
seatsMax: number;
|
|
1865
|
-
}[];
|
|
1866
|
-
deletedTableDefinitions: {
|
|
1867
|
-
name: string;
|
|
1868
|
-
seatsMin: number;
|
|
1869
|
-
seatsMax: number;
|
|
1870
|
-
}[];
|
|
1871
|
-
tableCombinations: {
|
|
1872
|
-
seatsMin: number;
|
|
1873
|
-
seatsMax: number;
|
|
1874
|
-
}[];
|
|
1875
|
-
};
|
|
1876
|
-
reservationPayment?: {
|
|
1877
|
-
value: string;
|
|
1878
|
-
minPartySize: number;
|
|
1879
|
-
};
|
|
1880
|
-
};
|
|
1881
|
-
};
|
|
1882
|
-
}
|
|
1883
|
-
export interface UpdateReservationLocationResponseNonNullableFields {
|
|
1884
|
-
reservationLocation?: {
|
|
1885
|
-
location?: {
|
|
1886
|
-
address?: {
|
|
1887
|
-
streetAddress?: {
|
|
1888
|
-
number: string;
|
|
1889
|
-
name: string;
|
|
1890
|
-
apt: string;
|
|
1891
|
-
};
|
|
1892
|
-
};
|
|
1893
|
-
businessSchedule?: {
|
|
1894
|
-
periods: {
|
|
1895
|
-
openDay: DayOfWeek;
|
|
1896
|
-
openTime: string;
|
|
1897
|
-
closeDay: DayOfWeek;
|
|
1898
|
-
closeTime: string;
|
|
1899
|
-
}[];
|
|
1900
|
-
specialHourPeriod: {
|
|
1901
|
-
startDate: string;
|
|
1902
|
-
endDate: string;
|
|
1903
|
-
isClosed: boolean;
|
|
1904
|
-
comment: string;
|
|
1905
|
-
}[];
|
|
1906
|
-
};
|
|
1907
|
-
};
|
|
1908
|
-
configuration?: {
|
|
1909
|
-
onlineReservations?: {
|
|
1910
|
-
seatPacing?: {
|
|
1911
|
-
number: number;
|
|
1912
|
-
enabled: boolean;
|
|
1913
|
-
};
|
|
1914
|
-
partyPacing?: {
|
|
1915
|
-
number: number;
|
|
1916
|
-
enabled: boolean;
|
|
1917
|
-
};
|
|
1918
|
-
partiesSize?: {
|
|
1919
|
-
min: number;
|
|
1920
|
-
max: number;
|
|
1921
|
-
};
|
|
1922
|
-
partySize?: {
|
|
1923
|
-
min: number;
|
|
1924
|
-
max: number;
|
|
1925
|
-
};
|
|
1926
|
-
minimumReservationNotice?: {
|
|
1927
|
-
number: number;
|
|
1928
|
-
unit: Unit;
|
|
1929
|
-
};
|
|
1930
|
-
turnoverTimeRules: {
|
|
1931
|
-
seatsMin: number;
|
|
1932
|
-
seatsMax: number;
|
|
1933
|
-
minutes: number;
|
|
1934
|
-
}[];
|
|
1935
|
-
turnoverRules: {
|
|
1936
|
-
minSeats: number;
|
|
1937
|
-
maxSeats: number;
|
|
1938
|
-
minutes: number;
|
|
1939
|
-
}[];
|
|
1940
|
-
businessSchedule?: {
|
|
1941
|
-
periods: {
|
|
1942
|
-
openDay: DayOfWeek;
|
|
1943
|
-
openTime: string;
|
|
1944
|
-
closeDay: DayOfWeek;
|
|
1945
|
-
closeTime: string;
|
|
1946
|
-
}[];
|
|
1947
|
-
specialHourPeriod: {
|
|
1948
|
-
startDate: string;
|
|
1949
|
-
endDate: string;
|
|
1950
|
-
isClosed: boolean;
|
|
1951
|
-
comment: string;
|
|
1952
|
-
}[];
|
|
1953
|
-
};
|
|
1954
|
-
manualApproval?: {
|
|
1955
|
-
partySizeThreshold: number;
|
|
1956
|
-
customApprovalsProviderId: string;
|
|
1957
|
-
enabled: boolean;
|
|
1958
|
-
};
|
|
1959
|
-
};
|
|
1960
|
-
reservationForm?: {
|
|
1961
|
-
termsAndConditions?: {
|
|
1962
|
-
url?: {
|
|
1963
|
-
relativePath: string;
|
|
1964
|
-
};
|
|
1965
|
-
enabled: boolean;
|
|
1966
|
-
};
|
|
1967
|
-
privacyPolicy?: {
|
|
1968
|
-
url?: {
|
|
1969
|
-
relativePath: string;
|
|
1970
|
-
};
|
|
1971
|
-
enabled: boolean;
|
|
1972
|
-
};
|
|
1973
|
-
customFieldDefinitions: {
|
|
1974
|
-
name: string;
|
|
1975
|
-
required: boolean;
|
|
1976
|
-
}[];
|
|
1977
|
-
emailMarketingCheckbox?: {
|
|
1978
|
-
enabled: boolean;
|
|
1979
|
-
checkedByDefault: boolean;
|
|
1980
|
-
};
|
|
1981
|
-
};
|
|
1982
|
-
myReservationsFields: {
|
|
1983
|
-
fieldType: FieldType;
|
|
1984
|
-
shown: boolean;
|
|
1985
|
-
}[];
|
|
1986
|
-
tableManagement?: {
|
|
1987
|
-
tableDefinitions: {
|
|
1988
|
-
name: string;
|
|
1989
|
-
seatsMin: number;
|
|
1990
|
-
seatsMax: number;
|
|
1991
|
-
}[];
|
|
1992
|
-
deletedTableDefinitions: {
|
|
1993
|
-
name: string;
|
|
1994
|
-
seatsMin: number;
|
|
1995
|
-
seatsMax: number;
|
|
1996
|
-
}[];
|
|
1997
|
-
tableCombinations: {
|
|
1998
|
-
seatsMin: number;
|
|
1999
|
-
seatsMax: number;
|
|
2000
|
-
}[];
|
|
2001
|
-
};
|
|
2002
|
-
reservationPayment?: {
|
|
2003
|
-
value: string;
|
|
2004
|
-
minPartySize: number;
|
|
2005
|
-
};
|
|
2006
|
-
};
|
|
2007
|
-
};
|
|
2008
|
-
}
|
|
2009
|
-
export interface QueryReservationLocationsResponseNonNullableFields {
|
|
2010
|
-
reservationLocations: {
|
|
2011
|
-
location?: {
|
|
2012
|
-
address?: {
|
|
2013
|
-
streetAddress?: {
|
|
2014
|
-
number: string;
|
|
2015
|
-
name: string;
|
|
2016
|
-
apt: string;
|
|
2017
|
-
};
|
|
2018
|
-
};
|
|
2019
|
-
businessSchedule?: {
|
|
2020
|
-
periods: {
|
|
2021
|
-
openDay: DayOfWeek;
|
|
2022
|
-
openTime: string;
|
|
2023
|
-
closeDay: DayOfWeek;
|
|
2024
|
-
closeTime: string;
|
|
2025
|
-
}[];
|
|
2026
|
-
specialHourPeriod: {
|
|
2027
|
-
startDate: string;
|
|
2028
|
-
endDate: string;
|
|
2029
|
-
isClosed: boolean;
|
|
2030
|
-
comment: string;
|
|
2031
|
-
}[];
|
|
2032
|
-
};
|
|
2033
|
-
};
|
|
2034
|
-
configuration?: {
|
|
2035
|
-
onlineReservations?: {
|
|
2036
|
-
seatPacing?: {
|
|
2037
|
-
number: number;
|
|
2038
|
-
enabled: boolean;
|
|
2039
|
-
};
|
|
2040
|
-
partyPacing?: {
|
|
2041
|
-
number: number;
|
|
2042
|
-
enabled: boolean;
|
|
2043
|
-
};
|
|
2044
|
-
partiesSize?: {
|
|
2045
|
-
min: number;
|
|
2046
|
-
max: number;
|
|
2047
|
-
};
|
|
2048
|
-
partySize?: {
|
|
2049
|
-
min: number;
|
|
2050
|
-
max: number;
|
|
2051
|
-
};
|
|
2052
|
-
minimumReservationNotice?: {
|
|
2053
|
-
number: number;
|
|
2054
|
-
unit: Unit;
|
|
2055
|
-
};
|
|
2056
|
-
turnoverTimeRules: {
|
|
2057
|
-
seatsMin: number;
|
|
2058
|
-
seatsMax: number;
|
|
2059
|
-
minutes: number;
|
|
2060
|
-
}[];
|
|
2061
|
-
turnoverRules: {
|
|
2062
|
-
minSeats: number;
|
|
2063
|
-
maxSeats: number;
|
|
2064
|
-
minutes: number;
|
|
2065
|
-
}[];
|
|
2066
|
-
businessSchedule?: {
|
|
2067
|
-
periods: {
|
|
2068
|
-
openDay: DayOfWeek;
|
|
2069
|
-
openTime: string;
|
|
2070
|
-
closeDay: DayOfWeek;
|
|
2071
|
-
closeTime: string;
|
|
2072
|
-
}[];
|
|
2073
|
-
specialHourPeriod: {
|
|
2074
|
-
startDate: string;
|
|
2075
|
-
endDate: string;
|
|
2076
|
-
isClosed: boolean;
|
|
2077
|
-
comment: string;
|
|
2078
|
-
}[];
|
|
2079
|
-
};
|
|
2080
|
-
manualApproval?: {
|
|
2081
|
-
partySizeThreshold: number;
|
|
2082
|
-
customApprovalsProviderId: string;
|
|
2083
|
-
enabled: boolean;
|
|
2084
|
-
};
|
|
2085
|
-
};
|
|
2086
|
-
reservationForm?: {
|
|
2087
|
-
termsAndConditions?: {
|
|
2088
|
-
url?: {
|
|
2089
|
-
relativePath: string;
|
|
2090
|
-
};
|
|
2091
|
-
enabled: boolean;
|
|
2092
|
-
};
|
|
2093
|
-
privacyPolicy?: {
|
|
2094
|
-
url?: {
|
|
2095
|
-
relativePath: string;
|
|
2096
|
-
};
|
|
2097
|
-
enabled: boolean;
|
|
2098
|
-
};
|
|
2099
|
-
customFieldDefinitions: {
|
|
2100
|
-
name: string;
|
|
2101
|
-
required: boolean;
|
|
2102
|
-
}[];
|
|
2103
|
-
emailMarketingCheckbox?: {
|
|
2104
|
-
enabled: boolean;
|
|
2105
|
-
checkedByDefault: boolean;
|
|
2106
|
-
};
|
|
2107
|
-
};
|
|
2108
|
-
myReservationsFields: {
|
|
2109
|
-
fieldType: FieldType;
|
|
2110
|
-
shown: boolean;
|
|
2111
|
-
}[];
|
|
2112
|
-
tableManagement?: {
|
|
2113
|
-
tableDefinitions: {
|
|
2114
|
-
name: string;
|
|
2115
|
-
seatsMin: number;
|
|
2116
|
-
seatsMax: number;
|
|
2117
|
-
}[];
|
|
2118
|
-
deletedTableDefinitions: {
|
|
2119
|
-
name: string;
|
|
2120
|
-
seatsMin: number;
|
|
2121
|
-
seatsMax: number;
|
|
2122
|
-
}[];
|
|
2123
|
-
tableCombinations: {
|
|
2124
|
-
seatsMin: number;
|
|
2125
|
-
seatsMax: number;
|
|
2126
|
-
}[];
|
|
2127
|
-
};
|
|
2128
|
-
reservationPayment?: {
|
|
2129
|
-
value: string;
|
|
2130
|
-
minPartySize: number;
|
|
2131
|
-
};
|
|
2132
|
-
};
|
|
2133
|
-
}[];
|
|
2134
|
-
}
|
|
2135
|
-
export interface ListReservationLocationsResponseNonNullableFields {
|
|
2136
|
-
reservationLocations: {
|
|
2137
|
-
location?: {
|
|
2138
|
-
address?: {
|
|
2139
|
-
streetAddress?: {
|
|
2140
|
-
number: string;
|
|
2141
|
-
name: string;
|
|
2142
|
-
apt: string;
|
|
2143
|
-
};
|
|
2144
|
-
};
|
|
2145
|
-
businessSchedule?: {
|
|
2146
|
-
periods: {
|
|
2147
|
-
openDay: DayOfWeek;
|
|
2148
|
-
openTime: string;
|
|
2149
|
-
closeDay: DayOfWeek;
|
|
2150
|
-
closeTime: string;
|
|
2151
|
-
}[];
|
|
2152
|
-
specialHourPeriod: {
|
|
2153
|
-
startDate: string;
|
|
2154
|
-
endDate: string;
|
|
2155
|
-
isClosed: boolean;
|
|
2156
|
-
comment: string;
|
|
2157
|
-
}[];
|
|
2158
|
-
};
|
|
2159
|
-
};
|
|
2160
|
-
configuration?: {
|
|
2161
|
-
onlineReservations?: {
|
|
2162
|
-
seatPacing?: {
|
|
2163
|
-
number: number;
|
|
2164
|
-
enabled: boolean;
|
|
2165
|
-
};
|
|
2166
|
-
partyPacing?: {
|
|
2167
|
-
number: number;
|
|
2168
|
-
enabled: boolean;
|
|
2169
|
-
};
|
|
2170
|
-
partiesSize?: {
|
|
2171
|
-
min: number;
|
|
2172
|
-
max: number;
|
|
2173
|
-
};
|
|
2174
|
-
partySize?: {
|
|
2175
|
-
min: number;
|
|
2176
|
-
max: number;
|
|
2177
|
-
};
|
|
2178
|
-
minimumReservationNotice?: {
|
|
2179
|
-
number: number;
|
|
2180
|
-
unit: Unit;
|
|
2181
|
-
};
|
|
2182
|
-
turnoverTimeRules: {
|
|
2183
|
-
seatsMin: number;
|
|
2184
|
-
seatsMax: number;
|
|
2185
|
-
minutes: number;
|
|
2186
|
-
}[];
|
|
2187
|
-
turnoverRules: {
|
|
2188
|
-
minSeats: number;
|
|
2189
|
-
maxSeats: number;
|
|
2190
|
-
minutes: number;
|
|
2191
|
-
}[];
|
|
2192
|
-
businessSchedule?: {
|
|
2193
|
-
periods: {
|
|
2194
|
-
openDay: DayOfWeek;
|
|
2195
|
-
openTime: string;
|
|
2196
|
-
closeDay: DayOfWeek;
|
|
2197
|
-
closeTime: string;
|
|
2198
|
-
}[];
|
|
2199
|
-
specialHourPeriod: {
|
|
2200
|
-
startDate: string;
|
|
2201
|
-
endDate: string;
|
|
2202
|
-
isClosed: boolean;
|
|
2203
|
-
comment: string;
|
|
2204
|
-
}[];
|
|
2205
|
-
};
|
|
2206
|
-
manualApproval?: {
|
|
2207
|
-
partySizeThreshold: number;
|
|
2208
|
-
customApprovalsProviderId: string;
|
|
2209
|
-
enabled: boolean;
|
|
2210
|
-
};
|
|
2211
|
-
};
|
|
2212
|
-
reservationForm?: {
|
|
2213
|
-
termsAndConditions?: {
|
|
2214
|
-
url?: {
|
|
2215
|
-
relativePath: string;
|
|
2216
|
-
};
|
|
2217
|
-
enabled: boolean;
|
|
2218
|
-
};
|
|
2219
|
-
privacyPolicy?: {
|
|
2220
|
-
url?: {
|
|
2221
|
-
relativePath: string;
|
|
2222
|
-
};
|
|
2223
|
-
enabled: boolean;
|
|
2224
|
-
};
|
|
2225
|
-
customFieldDefinitions: {
|
|
2226
|
-
name: string;
|
|
2227
|
-
required: boolean;
|
|
2228
|
-
}[];
|
|
2229
|
-
emailMarketingCheckbox?: {
|
|
2230
|
-
enabled: boolean;
|
|
2231
|
-
checkedByDefault: boolean;
|
|
2232
|
-
};
|
|
2233
|
-
};
|
|
2234
|
-
myReservationsFields: {
|
|
2235
|
-
fieldType: FieldType;
|
|
2236
|
-
shown: boolean;
|
|
2237
|
-
}[];
|
|
2238
|
-
tableManagement?: {
|
|
2239
|
-
tableDefinitions: {
|
|
2240
|
-
name: string;
|
|
2241
|
-
seatsMin: number;
|
|
2242
|
-
seatsMax: number;
|
|
2243
|
-
}[];
|
|
2244
|
-
deletedTableDefinitions: {
|
|
2245
|
-
name: string;
|
|
2246
|
-
seatsMin: number;
|
|
2247
|
-
seatsMax: number;
|
|
2248
|
-
}[];
|
|
2249
|
-
tableCombinations: {
|
|
2250
|
-
seatsMin: number;
|
|
2251
|
-
seatsMax: number;
|
|
2252
|
-
}[];
|
|
2253
|
-
};
|
|
2254
|
-
reservationPayment?: {
|
|
2255
|
-
value: string;
|
|
2256
|
-
minPartySize: number;
|
|
2257
|
-
};
|
|
2258
|
-
};
|
|
2259
|
-
}[];
|
|
2260
|
-
}
|