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