@wix/auto_sdk_seatings_seating-plan 1.0.5 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +96 -1
- package/build/cjs/index.js +1310 -15
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +783 -1
- package/build/cjs/meta.js +860 -15
- package/build/cjs/meta.js.map +1 -1
- package/build/{internal/cjs/src/seating-v1-seating-plan-seating-plan.universal.d.ts → cjs/seating-v1-seating-plan-seating-plan.universal-BphMjTRF.d.ts} +95 -279
- package/build/es/index.d.mts +96 -0
- package/build/es/index.mjs +1269 -0
- package/build/es/index.mjs.map +1 -0
- package/build/es/{src/seating-v1-seating-plan-seating-plan.types.d.ts → meta.d.mts} +86 -281
- package/build/es/meta.mjs +828 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/{internal/es/src/seating-v1-seating-plan-seating-plan.universal.d.ts → es/seating-v1-seating-plan-seating-plan.universal-BphMjTRF.d.mts} +95 -279
- package/build/internal/cjs/index.d.ts +96 -1
- package/build/internal/cjs/index.js +1310 -15
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +783 -1
- package/build/internal/cjs/meta.js +860 -15
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/{cjs/src/seating-v1-seating-plan-seating-plan.universal.d.ts → internal/cjs/seating-v1-seating-plan-seating-plan.universal-BphMjTRF.d.ts} +95 -279
- package/build/internal/es/index.d.mts +96 -0
- package/build/internal/es/index.mjs +1269 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/internal/{cjs/src/seating-v1-seating-plan-seating-plan.types.d.ts → es/meta.d.mts} +86 -281
- package/build/internal/es/meta.mjs +828 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/build/{es/src/seating-v1-seating-plan-seating-plan.universal.d.ts → internal/es/seating-v1-seating-plan-seating-plan.universal-BphMjTRF.d.mts} +95 -279
- package/package.json +9 -8
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.context.d.ts +0 -23
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.context.js +0 -35
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.context.js.map +0 -1
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.http.d.ts +0 -19
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.http.js +0 -673
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.http.js.map +0 -1
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.meta.d.ts +0 -25
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.meta.js +0 -199
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.meta.js.map +0 -1
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.public.d.ts +0 -80
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.public.js +0 -204
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.public.js.map +0 -1
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.types.d.ts +0 -978
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.types.js +0 -85
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.types.js.map +0 -1
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.universal.js +0 -505
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/seating-v1-seating-plan-seating-plan.context.d.ts +0 -23
- package/build/es/src/seating-v1-seating-plan-seating-plan.context.js +0 -23
- package/build/es/src/seating-v1-seating-plan-seating-plan.context.js.map +0 -1
- package/build/es/src/seating-v1-seating-plan-seating-plan.http.d.ts +0 -19
- package/build/es/src/seating-v1-seating-plan-seating-plan.http.js +0 -661
- package/build/es/src/seating-v1-seating-plan-seating-plan.http.js.map +0 -1
- package/build/es/src/seating-v1-seating-plan-seating-plan.meta.d.ts +0 -25
- package/build/es/src/seating-v1-seating-plan-seating-plan.meta.js +0 -164
- package/build/es/src/seating-v1-seating-plan-seating-plan.meta.js.map +0 -1
- package/build/es/src/seating-v1-seating-plan-seating-plan.public.d.ts +0 -80
- package/build/es/src/seating-v1-seating-plan-seating-plan.public.js +0 -183
- package/build/es/src/seating-v1-seating-plan-seating-plan.public.js.map +0 -1
- package/build/es/src/seating-v1-seating-plan-seating-plan.types.js +0 -82
- package/build/es/src/seating-v1-seating-plan-seating-plan.types.js.map +0 -1
- package/build/es/src/seating-v1-seating-plan-seating-plan.universal.js +0 -470
- package/build/es/src/seating-v1-seating-plan-seating-plan.universal.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.context.d.ts +0 -23
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.context.js +0 -35
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.context.js.map +0 -1
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.http.d.ts +0 -19
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.http.js +0 -673
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.http.js.map +0 -1
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.meta.d.ts +0 -25
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.meta.js +0 -199
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.meta.js.map +0 -1
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.public.d.ts +0 -80
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.public.js +0 -204
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.public.js.map +0 -1
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.types.js +0 -85
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.types.js.map +0 -1
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.universal.js +0 -505
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.context.d.ts +0 -23
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.context.js +0 -23
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.context.js.map +0 -1
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.http.d.ts +0 -19
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.http.js +0 -661
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.http.js.map +0 -1
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.meta.d.ts +0 -25
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.meta.js +0 -164
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.meta.js.map +0 -1
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.public.d.ts +0 -80
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.public.js +0 -183
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.public.js.map +0 -1
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.types.d.ts +0 -978
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.types.js +0 -82
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.types.js.map +0 -1
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.universal.js +0 -470
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.universal.js.map +0 -1
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export interface SeatingPlan {
|
|
1
|
+
interface SeatingPlan {
|
|
3
2
|
/**
|
|
4
3
|
* Auto generated unique plan id
|
|
5
4
|
* @format GUID
|
|
@@ -71,7 +70,7 @@ export interface SeatingPlan {
|
|
|
71
70
|
*/
|
|
72
71
|
elementGroups?: ElementGroup[];
|
|
73
72
|
}
|
|
74
|
-
|
|
73
|
+
interface Section {
|
|
75
74
|
/** Unique section id */
|
|
76
75
|
_id?: number;
|
|
77
76
|
/**
|
|
@@ -101,7 +100,7 @@ export interface Section {
|
|
|
101
100
|
*/
|
|
102
101
|
default?: boolean;
|
|
103
102
|
}
|
|
104
|
-
|
|
103
|
+
interface Element {
|
|
105
104
|
/**
|
|
106
105
|
* Unique element id
|
|
107
106
|
* @min 1
|
|
@@ -145,7 +144,7 @@ export interface Element {
|
|
|
145
144
|
/** Multi row element relevant for MULTI_ROW element type */
|
|
146
145
|
multiRowProperties?: MultiRowProperties;
|
|
147
146
|
}
|
|
148
|
-
|
|
147
|
+
declare enum Type {
|
|
149
148
|
AREA = "AREA",
|
|
150
149
|
ROW = "ROW",
|
|
151
150
|
MULTI_ROW = "MULTI_ROW",
|
|
@@ -154,8 +153,8 @@ export declare enum Type {
|
|
|
154
153
|
SHAPE = "SHAPE"
|
|
155
154
|
}
|
|
156
155
|
/** @enumType */
|
|
157
|
-
|
|
158
|
-
|
|
156
|
+
type TypeWithLiterals = Type | 'AREA' | 'ROW' | 'MULTI_ROW' | 'TABLE' | 'ROUND_TABLE' | 'SHAPE';
|
|
157
|
+
interface Sequencing {
|
|
159
158
|
/**
|
|
160
159
|
* First seq element
|
|
161
160
|
* @minLength 1
|
|
@@ -170,7 +169,7 @@ export interface Sequencing {
|
|
|
170
169
|
/** If true - direction right to left. Otherwise left to right. */
|
|
171
170
|
reverseOrder?: boolean | null;
|
|
172
171
|
}
|
|
173
|
-
|
|
172
|
+
interface Place {
|
|
174
173
|
/** Local id of the place in the sequence */
|
|
175
174
|
index?: number;
|
|
176
175
|
/**
|
|
@@ -202,7 +201,7 @@ export interface Place {
|
|
|
202
201
|
/** Place type */
|
|
203
202
|
type?: PlaceTypeEnumTypeWithLiterals;
|
|
204
203
|
}
|
|
205
|
-
|
|
204
|
+
declare enum PlaceTypeEnumType {
|
|
206
205
|
UNKNOWN_PROPERTY = "UNKNOWN_PROPERTY",
|
|
207
206
|
STANDARD = "STANDARD",
|
|
208
207
|
WHEELCHAIR = "WHEELCHAIR",
|
|
@@ -212,12 +211,12 @@ export declare enum PlaceTypeEnumType {
|
|
|
212
211
|
DISCOUNT = "DISCOUNT"
|
|
213
212
|
}
|
|
214
213
|
/** @enumType */
|
|
215
|
-
|
|
216
|
-
|
|
214
|
+
type PlaceTypeEnumTypeWithLiterals = PlaceTypeEnumType | 'UNKNOWN_PROPERTY' | 'STANDARD' | 'WHEELCHAIR' | 'ACCESSIBLE' | 'COMPANION' | 'OBSTRUCTED' | 'DISCOUNT';
|
|
215
|
+
interface ReservationOptions {
|
|
217
216
|
/** Indicates whether the entire element must be reserved */
|
|
218
217
|
reserveWholeElement?: boolean;
|
|
219
218
|
}
|
|
220
|
-
|
|
219
|
+
interface ElementUiProperties {
|
|
221
220
|
/**
|
|
222
221
|
* @min -1000000
|
|
223
222
|
* @max 1000000
|
|
@@ -293,7 +292,7 @@ export interface ElementUiProperties {
|
|
|
293
292
|
image?: Image;
|
|
294
293
|
seatNumbering?: NumberingWithLiterals;
|
|
295
294
|
}
|
|
296
|
-
|
|
295
|
+
declare enum ShapeTypeEnumType {
|
|
297
296
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
298
297
|
TEXT = "TEXT",
|
|
299
298
|
RECTANGLE = "RECTANGLE",
|
|
@@ -303,8 +302,8 @@ export declare enum ShapeTypeEnumType {
|
|
|
303
302
|
IMAGE = "IMAGE"
|
|
304
303
|
}
|
|
305
304
|
/** @enumType */
|
|
306
|
-
|
|
307
|
-
|
|
305
|
+
type ShapeTypeEnumTypeWithLiterals = ShapeTypeEnumType | 'UNKNOWN_TYPE' | 'TEXT' | 'RECTANGLE' | 'ELLIPSE' | 'LINE' | 'ICON' | 'IMAGE';
|
|
306
|
+
declare enum Position {
|
|
308
307
|
UNKNOWN_POSITION = "UNKNOWN_POSITION",
|
|
309
308
|
LEFT = "LEFT",
|
|
310
309
|
RIGHT = "RIGHT",
|
|
@@ -312,8 +311,8 @@ export declare enum Position {
|
|
|
312
311
|
NONE = "NONE"
|
|
313
312
|
}
|
|
314
313
|
/** @enumType */
|
|
315
|
-
|
|
316
|
-
|
|
314
|
+
type PositionWithLiterals = Position | 'UNKNOWN_POSITION' | 'LEFT' | 'RIGHT' | 'BOTH' | 'NONE';
|
|
315
|
+
declare enum Icon {
|
|
317
316
|
UNKNOWN_ICON = "UNKNOWN_ICON",
|
|
318
317
|
ENTER = "ENTER",
|
|
319
318
|
EXIT = "EXIT",
|
|
@@ -329,8 +328,8 @@ export declare enum Icon {
|
|
|
329
328
|
STAGE = "STAGE"
|
|
330
329
|
}
|
|
331
330
|
/** @enumType */
|
|
332
|
-
|
|
333
|
-
|
|
331
|
+
type IconWithLiterals = Icon | 'UNKNOWN_ICON' | 'ENTER' | 'EXIT' | 'DRINKS' | 'WC' | 'WC_MEN' | 'WC_WOMEN' | 'FOOD' | 'STAIRS' | 'ELEVATOR' | 'SMOKING' | 'CHECKROOM' | 'STAGE';
|
|
332
|
+
interface Image {
|
|
334
333
|
/** WixMedia image ID. */
|
|
335
334
|
_id?: string;
|
|
336
335
|
/**
|
|
@@ -349,15 +348,15 @@ export interface Image {
|
|
|
349
348
|
*/
|
|
350
349
|
uri?: string | null;
|
|
351
350
|
}
|
|
352
|
-
|
|
351
|
+
declare enum Numbering {
|
|
353
352
|
UNKNOWN_NUMBERING = "UNKNOWN_NUMBERING",
|
|
354
353
|
NUMERIC = "NUMERIC",
|
|
355
354
|
ODD_EVEN = "ODD_EVEN",
|
|
356
355
|
ALPHABETICAL = "ALPHABETICAL"
|
|
357
356
|
}
|
|
358
357
|
/** @enumType */
|
|
359
|
-
|
|
360
|
-
|
|
358
|
+
type NumberingWithLiterals = Numbering | 'UNKNOWN_NUMBERING' | 'NUMERIC' | 'ODD_EVEN' | 'ALPHABETICAL';
|
|
359
|
+
interface MultiRowProperties {
|
|
361
360
|
/**
|
|
362
361
|
* Individual rows of the multi row element
|
|
363
362
|
* @maxSize 1000
|
|
@@ -377,7 +376,7 @@ export interface MultiRowProperties {
|
|
|
377
376
|
*/
|
|
378
377
|
seatAmount?: number | null;
|
|
379
378
|
}
|
|
380
|
-
|
|
379
|
+
interface RowElement {
|
|
381
380
|
/**
|
|
382
381
|
* Unique row id
|
|
383
382
|
* @min 1
|
|
@@ -402,7 +401,7 @@ export interface RowElement {
|
|
|
402
401
|
/** Row UI settings */
|
|
403
402
|
uiProperties?: RowElementUiProperties;
|
|
404
403
|
}
|
|
405
|
-
|
|
404
|
+
interface RowElementUiProperties {
|
|
406
405
|
/**
|
|
407
406
|
* Relative x position to the parent element
|
|
408
407
|
* @min -1000000
|
|
@@ -430,7 +429,7 @@ export interface RowElementUiProperties {
|
|
|
430
429
|
/** Seat numbering */
|
|
431
430
|
seatNumbering?: NumberingWithLiterals;
|
|
432
431
|
}
|
|
433
|
-
|
|
432
|
+
interface VerticalSequencing {
|
|
434
433
|
/**
|
|
435
434
|
* First seq element
|
|
436
435
|
* @minLength 1
|
|
@@ -442,7 +441,7 @@ export interface VerticalSequencing {
|
|
|
442
441
|
/** If true - direction bottom to top. Otherwise top to bottom. */
|
|
443
442
|
reverseOrder?: boolean | null;
|
|
444
443
|
}
|
|
445
|
-
|
|
444
|
+
interface Category {
|
|
446
445
|
/**
|
|
447
446
|
* Local category id within the seating plan
|
|
448
447
|
* @min 1
|
|
@@ -479,7 +478,7 @@ export interface Category {
|
|
|
479
478
|
*/
|
|
480
479
|
places?: Place[];
|
|
481
480
|
}
|
|
482
|
-
|
|
481
|
+
interface ExtendedFields {
|
|
483
482
|
/**
|
|
484
483
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
485
484
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -490,7 +489,7 @@ export interface ExtendedFields {
|
|
|
490
489
|
*/
|
|
491
490
|
namespaces?: Record<string, Record<string, any>>;
|
|
492
491
|
}
|
|
493
|
-
|
|
492
|
+
interface SeatingPlanUiProperties {
|
|
494
493
|
/**
|
|
495
494
|
* #F0F0F0
|
|
496
495
|
* @format COLOR_HEX
|
|
@@ -499,7 +498,7 @@ export interface SeatingPlanUiProperties {
|
|
|
499
498
|
/** @max 100 */
|
|
500
499
|
backgroundOpacity?: number | null;
|
|
501
500
|
}
|
|
502
|
-
|
|
501
|
+
interface ElementGroup {
|
|
503
502
|
/**
|
|
504
503
|
* Unique element group id
|
|
505
504
|
* @min 1
|
|
@@ -510,7 +509,7 @@ export interface ElementGroup {
|
|
|
510
509
|
/** Element group UI settings */
|
|
511
510
|
uiProperties?: ElementGroupUiProperties;
|
|
512
511
|
}
|
|
513
|
-
|
|
512
|
+
interface ElementGroupUiProperties {
|
|
514
513
|
/**
|
|
515
514
|
* x position of the group
|
|
516
515
|
* @min -1000000
|
|
@@ -540,15 +539,15 @@ export interface ElementGroupUiProperties {
|
|
|
540
539
|
*/
|
|
541
540
|
rotationAngle?: number | null;
|
|
542
541
|
}
|
|
543
|
-
|
|
542
|
+
interface CreateSeatingPlanRequest {
|
|
544
543
|
/** A plan to be created */
|
|
545
544
|
plan: SeatingPlan;
|
|
546
545
|
}
|
|
547
|
-
|
|
546
|
+
interface CreateSeatingPlanResponse {
|
|
548
547
|
/** The created plan */
|
|
549
548
|
plan?: SeatingPlan;
|
|
550
549
|
}
|
|
551
|
-
|
|
550
|
+
interface CapacityExceededViolation {
|
|
552
551
|
/** Max allowed capacity */
|
|
553
552
|
maxCapacity?: number;
|
|
554
553
|
/** Invalid capacity */
|
|
@@ -556,17 +555,17 @@ export interface CapacityExceededViolation {
|
|
|
556
555
|
/** The element id */
|
|
557
556
|
elementId?: number | null;
|
|
558
557
|
}
|
|
559
|
-
|
|
558
|
+
interface UpdateSeatingPlanRequest {
|
|
560
559
|
/** The plan updates */
|
|
561
560
|
plan?: SeatingPlan;
|
|
562
561
|
/** A set of field paths, specifying which parts of seating plan to update */
|
|
563
562
|
fields?: string[];
|
|
564
563
|
}
|
|
565
|
-
|
|
564
|
+
interface UpdateSeatingPlanResponse {
|
|
566
565
|
/** The updated plan */
|
|
567
566
|
plan?: SeatingPlan;
|
|
568
567
|
}
|
|
569
|
-
|
|
568
|
+
interface CopySeatingPlanRequest {
|
|
570
569
|
/**
|
|
571
570
|
* The id of the plan to be copied
|
|
572
571
|
* @format GUID
|
|
@@ -585,11 +584,11 @@ export interface CopySeatingPlanRequest {
|
|
|
585
584
|
*/
|
|
586
585
|
externalId: string | null;
|
|
587
586
|
}
|
|
588
|
-
|
|
587
|
+
interface CopySeatingPlanResponse {
|
|
589
588
|
/** The copied plan */
|
|
590
589
|
plan?: SeatingPlan;
|
|
591
590
|
}
|
|
592
|
-
|
|
591
|
+
interface QuerySeatingPlanRequest {
|
|
593
592
|
/**
|
|
594
593
|
* Generic query object
|
|
595
594
|
* Possible fieldsets: "elements", "categories", "places", "config".
|
|
@@ -598,7 +597,7 @@ export interface QuerySeatingPlanRequest {
|
|
|
598
597
|
/** A fieldset for the response */
|
|
599
598
|
fieldset?: FieldsetWithLiterals[];
|
|
600
599
|
}
|
|
601
|
-
|
|
600
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
602
601
|
/** Paging options to limit and skip the number of items. */
|
|
603
602
|
paging?: Paging;
|
|
604
603
|
/** 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`. */
|
|
@@ -621,13 +620,13 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
621
620
|
fieldsets?: string[];
|
|
622
621
|
}
|
|
623
622
|
/** @oneof */
|
|
624
|
-
|
|
623
|
+
interface QueryV2PagingMethodOneOf {
|
|
625
624
|
/** Paging options to limit and skip the number of items. */
|
|
626
625
|
paging?: Paging;
|
|
627
626
|
/** 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`. */
|
|
628
627
|
cursorPaging?: CursorPaging;
|
|
629
628
|
}
|
|
630
|
-
|
|
629
|
+
interface Sorting {
|
|
631
630
|
/**
|
|
632
631
|
* Name of the field to sort by.
|
|
633
632
|
* @maxLength 512
|
|
@@ -636,19 +635,19 @@ export interface Sorting {
|
|
|
636
635
|
/** Sort order. */
|
|
637
636
|
order?: SortOrderWithLiterals;
|
|
638
637
|
}
|
|
639
|
-
|
|
638
|
+
declare enum SortOrder {
|
|
640
639
|
ASC = "ASC",
|
|
641
640
|
DESC = "DESC"
|
|
642
641
|
}
|
|
643
642
|
/** @enumType */
|
|
644
|
-
|
|
645
|
-
|
|
643
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
644
|
+
interface Paging {
|
|
646
645
|
/** Number of items to load. */
|
|
647
646
|
limit?: number | null;
|
|
648
647
|
/** Number of items to skip in the current sort order. */
|
|
649
648
|
offset?: number | null;
|
|
650
649
|
}
|
|
651
|
-
|
|
650
|
+
interface CursorPaging {
|
|
652
651
|
/**
|
|
653
652
|
* Maximum number of items to return in the results.
|
|
654
653
|
* @max 100
|
|
@@ -663,7 +662,7 @@ export interface CursorPaging {
|
|
|
663
662
|
*/
|
|
664
663
|
cursor?: string | null;
|
|
665
664
|
}
|
|
666
|
-
|
|
665
|
+
declare enum Fieldset {
|
|
667
666
|
ELEMENTS = "ELEMENTS",
|
|
668
667
|
CATEGORIES = "CATEGORIES",
|
|
669
668
|
PLACES = "PLACES",
|
|
@@ -671,12 +670,12 @@ export declare enum Fieldset {
|
|
|
671
670
|
ELEMENT_GROUPS = "ELEMENT_GROUPS"
|
|
672
671
|
}
|
|
673
672
|
/** @enumType */
|
|
674
|
-
|
|
675
|
-
|
|
673
|
+
type FieldsetWithLiterals = Fieldset | 'ELEMENTS' | 'CATEGORIES' | 'PLACES' | 'CONFIG' | 'ELEMENT_GROUPS';
|
|
674
|
+
interface QuerySeatingPlanResponse {
|
|
676
675
|
/** Plan results */
|
|
677
676
|
plans?: SeatingPlan[];
|
|
678
677
|
}
|
|
679
|
-
|
|
678
|
+
interface GetSeatingPlanRequest {
|
|
680
679
|
/**
|
|
681
680
|
* The id of the plan
|
|
682
681
|
* @format GUID
|
|
@@ -695,7 +694,7 @@ export interface GetSeatingPlanRequest {
|
|
|
695
694
|
/** Seating Plan Mask */
|
|
696
695
|
seatingPlanMask?: SeatingPlanMask;
|
|
697
696
|
}
|
|
698
|
-
|
|
697
|
+
interface SeatingPlanMask {
|
|
699
698
|
/**
|
|
700
699
|
* Filter seating plan by place ids
|
|
701
700
|
* @minLength 5
|
|
@@ -703,11 +702,11 @@ export interface SeatingPlanMask {
|
|
|
703
702
|
*/
|
|
704
703
|
placeId?: string[];
|
|
705
704
|
}
|
|
706
|
-
|
|
705
|
+
interface GetSeatingPlanResponse {
|
|
707
706
|
/** The plan */
|
|
708
707
|
plan?: SeatingPlan;
|
|
709
708
|
}
|
|
710
|
-
|
|
709
|
+
interface FindSeatingPlanRequest {
|
|
711
710
|
/** The filter of the plan */
|
|
712
711
|
filter: Record<string, any> | null;
|
|
713
712
|
/**
|
|
@@ -723,22 +722,22 @@ export interface FindSeatingPlanRequest {
|
|
|
723
722
|
/** Seating Plan Mask */
|
|
724
723
|
seatingPlanMask?: SeatingPlanMask;
|
|
725
724
|
}
|
|
726
|
-
|
|
725
|
+
interface FindSeatingPlanResponse {
|
|
727
726
|
/** The plan */
|
|
728
727
|
plan?: SeatingPlan;
|
|
729
728
|
}
|
|
730
|
-
|
|
729
|
+
interface DeleteSeatingPlanRequest {
|
|
731
730
|
/**
|
|
732
731
|
* The id of the plan
|
|
733
732
|
* @format GUID
|
|
734
733
|
*/
|
|
735
734
|
_id: string | null;
|
|
736
735
|
}
|
|
737
|
-
|
|
736
|
+
interface DeleteSeatingPlanResponse {
|
|
738
737
|
/** Deleted plan */
|
|
739
738
|
plan?: SeatingPlan;
|
|
740
739
|
}
|
|
741
|
-
|
|
740
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
742
741
|
createdEvent?: EntityCreatedEvent;
|
|
743
742
|
updatedEvent?: EntityUpdatedEvent;
|
|
744
743
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -773,19 +772,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
773
772
|
entityEventSequence?: string | null;
|
|
774
773
|
}
|
|
775
774
|
/** @oneof */
|
|
776
|
-
|
|
775
|
+
interface DomainEventBodyOneOf {
|
|
777
776
|
createdEvent?: EntityCreatedEvent;
|
|
778
777
|
updatedEvent?: EntityUpdatedEvent;
|
|
779
778
|
deletedEvent?: EntityDeletedEvent;
|
|
780
779
|
actionEvent?: ActionEvent;
|
|
781
780
|
}
|
|
782
|
-
|
|
781
|
+
interface EntityCreatedEvent {
|
|
783
782
|
entity?: string;
|
|
784
783
|
}
|
|
785
|
-
|
|
784
|
+
interface RestoreInfo {
|
|
786
785
|
deletedDate?: Date | null;
|
|
787
786
|
}
|
|
788
|
-
|
|
787
|
+
interface EntityUpdatedEvent {
|
|
789
788
|
/**
|
|
790
789
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
791
790
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -793,14 +792,14 @@ export interface EntityUpdatedEvent {
|
|
|
793
792
|
*/
|
|
794
793
|
currentEntity?: string;
|
|
795
794
|
}
|
|
796
|
-
|
|
795
|
+
interface EntityDeletedEvent {
|
|
797
796
|
/** Entity that was deleted. */
|
|
798
797
|
deletedEntity?: string | null;
|
|
799
798
|
}
|
|
800
|
-
|
|
799
|
+
interface ActionEvent {
|
|
801
800
|
body?: string;
|
|
802
801
|
}
|
|
803
|
-
|
|
802
|
+
interface MessageEnvelope {
|
|
804
803
|
/**
|
|
805
804
|
* App instance ID.
|
|
806
805
|
* @format GUID
|
|
@@ -816,7 +815,7 @@ export interface MessageEnvelope {
|
|
|
816
815
|
/** Stringify payload. */
|
|
817
816
|
data?: string;
|
|
818
817
|
}
|
|
819
|
-
|
|
818
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
820
819
|
/**
|
|
821
820
|
* ID of a site visitor that has not logged in to the site.
|
|
822
821
|
* @format GUID
|
|
@@ -841,7 +840,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
841
840
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
842
841
|
}
|
|
843
842
|
/** @oneof */
|
|
844
|
-
|
|
843
|
+
interface IdentificationDataIdOneOf {
|
|
845
844
|
/**
|
|
846
845
|
* ID of a site visitor that has not logged in to the site.
|
|
847
846
|
* @format GUID
|
|
@@ -863,7 +862,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
863
862
|
*/
|
|
864
863
|
appId?: string;
|
|
865
864
|
}
|
|
866
|
-
|
|
865
|
+
declare enum WebhookIdentityType {
|
|
867
866
|
UNKNOWN = "UNKNOWN",
|
|
868
867
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
869
868
|
MEMBER = "MEMBER",
|
|
@@ -871,8 +870,8 @@ export declare enum WebhookIdentityType {
|
|
|
871
870
|
APP = "APP"
|
|
872
871
|
}
|
|
873
872
|
/** @enumType */
|
|
874
|
-
|
|
875
|
-
|
|
873
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
874
|
+
interface SaveSeatingPlanVersionRequest {
|
|
876
875
|
/** A plan version to be saved */
|
|
877
876
|
plan?: SeatingPlan;
|
|
878
877
|
/**
|
|
@@ -886,24 +885,24 @@ export interface SaveSeatingPlanVersionRequest {
|
|
|
886
885
|
*/
|
|
887
886
|
parentVersion?: string | null;
|
|
888
887
|
}
|
|
889
|
-
|
|
888
|
+
interface SaveSeatingPlanVersionResponse {
|
|
890
889
|
/** Updated plan version */
|
|
891
890
|
plan?: SeatingPlan;
|
|
892
891
|
}
|
|
893
|
-
|
|
892
|
+
interface QuerySeatingPlanVersionsRequest {
|
|
894
893
|
/**
|
|
895
894
|
* Generic query object
|
|
896
895
|
* Possible fieldsets: "elements", "categories", "places", "config".
|
|
897
896
|
*/
|
|
898
897
|
query?: QueryV2;
|
|
899
898
|
}
|
|
900
|
-
|
|
899
|
+
interface QuerySeatingPlanVersionsResponse {
|
|
901
900
|
/** Plan results */
|
|
902
901
|
plans?: SeatingPlan[];
|
|
903
902
|
/** Paging meta data */
|
|
904
903
|
metadata?: PagingMetadataV2;
|
|
905
904
|
}
|
|
906
|
-
|
|
905
|
+
interface PagingMetadataV2 {
|
|
907
906
|
/** Number of items returned in the response. */
|
|
908
907
|
count?: number | null;
|
|
909
908
|
/** Offset that was requested. */
|
|
@@ -915,7 +914,7 @@ export interface PagingMetadataV2 {
|
|
|
915
914
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
916
915
|
cursors?: Cursors;
|
|
917
916
|
}
|
|
918
|
-
|
|
917
|
+
interface Cursors {
|
|
919
918
|
/**
|
|
920
919
|
* Cursor string pointing to the next page in the list of results.
|
|
921
920
|
* @maxLength 16000
|
|
@@ -927,7 +926,7 @@ export interface Cursors {
|
|
|
927
926
|
*/
|
|
928
927
|
prev?: string | null;
|
|
929
928
|
}
|
|
930
|
-
|
|
929
|
+
interface DiscardSeatingPlanVersionsRequest {
|
|
931
930
|
/**
|
|
932
931
|
* Seating Plan ID
|
|
933
932
|
* @format GUID
|
|
@@ -936,9 +935,9 @@ export interface DiscardSeatingPlanVersionsRequest {
|
|
|
936
935
|
/** Version from which all higher versions will be discarded. */
|
|
937
936
|
version?: string | null;
|
|
938
937
|
}
|
|
939
|
-
|
|
938
|
+
interface DiscardSeatingPlanVersionsResponse {
|
|
940
939
|
}
|
|
941
|
-
|
|
940
|
+
interface RestoreSeatingPlanRequest {
|
|
942
941
|
/**
|
|
943
942
|
* Seating Plan ID
|
|
944
943
|
* @format GUID
|
|
@@ -947,14 +946,14 @@ export interface RestoreSeatingPlanRequest {
|
|
|
947
946
|
/** Version to witch the seating plan should be restored. */
|
|
948
947
|
version?: string | null;
|
|
949
948
|
}
|
|
950
|
-
|
|
949
|
+
interface RestoreSeatingPlanResponse {
|
|
951
950
|
/** Seating Plan */
|
|
952
951
|
plan?: SeatingPlan;
|
|
953
952
|
}
|
|
954
|
-
|
|
953
|
+
interface UpdateSeatingPlanThumbnailRequest {
|
|
955
954
|
thumbnail: SeatingPlanThumbnail;
|
|
956
955
|
}
|
|
957
|
-
|
|
956
|
+
interface SeatingPlanThumbnail {
|
|
958
957
|
/**
|
|
959
958
|
* @format GUID
|
|
960
959
|
* @readonly
|
|
@@ -962,20 +961,20 @@ export interface SeatingPlanThumbnail {
|
|
|
962
961
|
_id?: string | null;
|
|
963
962
|
img?: string | null;
|
|
964
963
|
}
|
|
965
|
-
|
|
964
|
+
interface UpdateSeatingPlanThumbnailResponse {
|
|
966
965
|
thumbnail?: SeatingPlanThumbnail;
|
|
967
966
|
}
|
|
968
|
-
|
|
967
|
+
interface GetSeatingPlanThumbnailRequest {
|
|
969
968
|
/**
|
|
970
969
|
* @format GUID
|
|
971
970
|
* @readonly
|
|
972
971
|
*/
|
|
973
972
|
_id: string | null;
|
|
974
973
|
}
|
|
975
|
-
|
|
974
|
+
interface GetSeatingPlanThumbnailResponse {
|
|
976
975
|
thumbnail?: SeatingPlanThumbnail;
|
|
977
976
|
}
|
|
978
|
-
|
|
977
|
+
interface BaseEventMetadata {
|
|
979
978
|
/**
|
|
980
979
|
* App instance ID.
|
|
981
980
|
* @format GUID
|
|
@@ -989,7 +988,7 @@ export interface BaseEventMetadata {
|
|
|
989
988
|
/** The identification type and identity data. */
|
|
990
989
|
identity?: IdentificationData;
|
|
991
990
|
}
|
|
992
|
-
|
|
991
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
993
992
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
994
993
|
_id?: string;
|
|
995
994
|
/**
|
|
@@ -1019,113 +1018,25 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
1019
1018
|
*/
|
|
1020
1019
|
entityEventSequence?: string | null;
|
|
1021
1020
|
}
|
|
1022
|
-
|
|
1021
|
+
interface SeatingPlanCreatedEnvelope {
|
|
1023
1022
|
entity: SeatingPlan;
|
|
1024
1023
|
metadata: EventMetadata;
|
|
1025
1024
|
}
|
|
1026
|
-
|
|
1027
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1028
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1029
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1030
|
-
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
1031
|
-
* @webhook
|
|
1032
|
-
* @eventType wix.seating.v1.seating_plan_created
|
|
1033
|
-
* @slug created
|
|
1034
|
-
* @documentationMaturity preview
|
|
1035
|
-
*/
|
|
1036
|
-
export declare function onSeatingPlanCreated(handler: (event: SeatingPlanCreatedEnvelope) => void | Promise<void>): void;
|
|
1037
|
-
export interface SeatingPlanDeletedEnvelope {
|
|
1025
|
+
interface SeatingPlanDeletedEnvelope {
|
|
1038
1026
|
entity: SeatingPlan;
|
|
1039
1027
|
metadata: EventMetadata;
|
|
1040
1028
|
}
|
|
1041
|
-
|
|
1042
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1043
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1044
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1045
|
-
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
1046
|
-
* @webhook
|
|
1047
|
-
* @eventType wix.seating.v1.seating_plan_deleted
|
|
1048
|
-
* @slug deleted
|
|
1049
|
-
* @documentationMaturity preview
|
|
1050
|
-
*/
|
|
1051
|
-
export declare function onSeatingPlanDeleted(handler: (event: SeatingPlanDeletedEnvelope) => void | Promise<void>): void;
|
|
1052
|
-
export interface SeatingPlanUpdatedEnvelope {
|
|
1029
|
+
interface SeatingPlanUpdatedEnvelope {
|
|
1053
1030
|
entity: SeatingPlan;
|
|
1054
1031
|
metadata: EventMetadata;
|
|
1055
1032
|
}
|
|
1056
|
-
|
|
1057
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1058
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1059
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1060
|
-
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
1061
|
-
* @webhook
|
|
1062
|
-
* @eventType wix.seating.v1.seating_plan_updated
|
|
1063
|
-
* @slug updated
|
|
1064
|
-
* @documentationMaturity preview
|
|
1065
|
-
*/
|
|
1066
|
-
export declare function onSeatingPlanUpdated(handler: (event: SeatingPlanUpdatedEnvelope) => void | Promise<void>): void;
|
|
1067
|
-
type SeatingPlanNonNullablePaths = `sections` | `sections.${number}._id` | `sections.${number}.default` | `categories` | `categories.${number}._id` | `categories.${number}.title` | `uncategorizedPlaces` | `uncategorizedPlaces.${number}.index` | `uncategorizedPlaces.${number}.label` | `uncategorizedPlaces.${number}.elementType` | `uncategorizedPlaces.${number}.type` | `elementGroups` | `elementGroups.${number}._id`;
|
|
1068
|
-
/**
|
|
1069
|
-
* Crates a seating plan
|
|
1070
|
-
* @param plan - A plan to be created
|
|
1071
|
-
* @public
|
|
1072
|
-
* @documentationMaturity preview
|
|
1073
|
-
* @requiredField plan
|
|
1074
|
-
* @requiredField plan.sections.elements.title
|
|
1075
|
-
* @requiredField plan.title
|
|
1076
|
-
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1077
|
-
* @permissionScope Manage Events
|
|
1078
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1079
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1080
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1081
|
-
* @applicableIdentity APP
|
|
1082
|
-
* @returns The created plan
|
|
1083
|
-
* @fqn com.wixpress.seating.SeatingPlanManagement.CreateSeatingPlan
|
|
1084
|
-
*/
|
|
1085
|
-
export declare function createSeatingPlan(plan: NonNullablePaths<SeatingPlan, `sections.${number}.elements.${number}.title` | `title`>): Promise<NonNullablePaths<SeatingPlan, SeatingPlanNonNullablePaths>>;
|
|
1086
|
-
/**
|
|
1087
|
-
* Updates the seating plan
|
|
1088
|
-
* @public
|
|
1089
|
-
* @documentationMaturity preview
|
|
1090
|
-
* @requiredField options.plan._id
|
|
1091
|
-
* @requiredField options.plan.sections.elements.title
|
|
1092
|
-
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1093
|
-
* @permissionScope Manage Events
|
|
1094
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1095
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1096
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1097
|
-
* @applicableIdentity APP
|
|
1098
|
-
* @returns The updated plan
|
|
1099
|
-
* @fqn com.wixpress.seating.SeatingPlanManagement.UpdateSeatingPlan
|
|
1100
|
-
*/
|
|
1101
|
-
export declare function updateSeatingPlan(options?: NonNullablePaths<UpdateSeatingPlanOptions, `plan._id` | `plan.sections.${number}.elements.${number}.title`>): Promise<NonNullablePaths<SeatingPlan, SeatingPlanNonNullablePaths>>;
|
|
1102
|
-
export interface UpdateSeatingPlanOptions {
|
|
1033
|
+
interface UpdateSeatingPlanOptions {
|
|
1103
1034
|
/** The plan updates */
|
|
1104
1035
|
plan?: SeatingPlan;
|
|
1105
1036
|
/** A set of field paths, specifying which parts of seating plan to update */
|
|
1106
1037
|
fields?: string[];
|
|
1107
1038
|
}
|
|
1108
|
-
|
|
1109
|
-
* Copies the seating plan
|
|
1110
|
-
* @param _id - The id of the plan to be copied
|
|
1111
|
-
* @public
|
|
1112
|
-
* @documentationMaturity preview
|
|
1113
|
-
* @requiredField _id
|
|
1114
|
-
* @requiredField options
|
|
1115
|
-
* @requiredField options.externalId
|
|
1116
|
-
* @requiredField options.title
|
|
1117
|
-
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1118
|
-
* @permissionScope Manage Events
|
|
1119
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1120
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1121
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1122
|
-
* @applicableIdentity APP
|
|
1123
|
-
* @fqn com.wixpress.seating.SeatingPlanManagement.CopySeatingPlan
|
|
1124
|
-
*/
|
|
1125
|
-
export declare function copySeatingPlan(_id: string, options: NonNullablePaths<CopySeatingPlanOptions, `externalId` | `title`>): Promise<NonNullablePaths<CopySeatingPlanResponse, {
|
|
1126
|
-
[P in SeatingPlanNonNullablePaths]: `plan.${P}`;
|
|
1127
|
-
}[SeatingPlanNonNullablePaths]>>;
|
|
1128
|
-
export interface CopySeatingPlanOptions {
|
|
1039
|
+
interface CopySeatingPlanOptions {
|
|
1129
1040
|
/**
|
|
1130
1041
|
* New plan title
|
|
1131
1042
|
* @minLength 1
|
|
@@ -1139,21 +1050,7 @@ export interface CopySeatingPlanOptions {
|
|
|
1139
1050
|
*/
|
|
1140
1051
|
externalId: string | null;
|
|
1141
1052
|
}
|
|
1142
|
-
|
|
1143
|
-
* Lists seating plans by provided query request
|
|
1144
|
-
* @public
|
|
1145
|
-
* @documentationMaturity preview
|
|
1146
|
-
* @permissionScope Manage Events
|
|
1147
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1148
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1149
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1150
|
-
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
1151
|
-
* @applicableIdentity APP
|
|
1152
|
-
* @applicableIdentity VISITOR
|
|
1153
|
-
* @fqn com.wixpress.seating.SeatingPlanManagement.QuerySeatingPlan
|
|
1154
|
-
*/
|
|
1155
|
-
export declare function querySeatingPlan(options?: QuerySeatingPlanOptions): PlansQueryBuilder;
|
|
1156
|
-
export interface QuerySeatingPlanOptions {
|
|
1053
|
+
interface QuerySeatingPlanOptions {
|
|
1157
1054
|
/** A fieldset for the response */
|
|
1158
1055
|
fieldset?: FieldsetWithLiterals[] | undefined;
|
|
1159
1056
|
}
|
|
@@ -1164,13 +1061,13 @@ interface QueryCursorResult {
|
|
|
1164
1061
|
length: number;
|
|
1165
1062
|
pageSize: number;
|
|
1166
1063
|
}
|
|
1167
|
-
|
|
1064
|
+
interface PlansQueryResult extends QueryCursorResult {
|
|
1168
1065
|
items: SeatingPlan[];
|
|
1169
1066
|
query: PlansQueryBuilder;
|
|
1170
1067
|
next: () => Promise<PlansQueryResult>;
|
|
1171
1068
|
prev: () => Promise<PlansQueryResult>;
|
|
1172
1069
|
}
|
|
1173
|
-
|
|
1070
|
+
interface PlansQueryBuilder {
|
|
1174
1071
|
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
1175
1072
|
* @documentationMaturity preview
|
|
1176
1073
|
*/
|
|
@@ -1182,24 +1079,7 @@ export interface PlansQueryBuilder {
|
|
|
1182
1079
|
/** @documentationMaturity preview */
|
|
1183
1080
|
find: () => Promise<PlansQueryResult>;
|
|
1184
1081
|
}
|
|
1185
|
-
|
|
1186
|
-
* Returns the seating plan. Fails of not fond.
|
|
1187
|
-
* @param _id - The id of the plan
|
|
1188
|
-
* @public
|
|
1189
|
-
* @documentationMaturity preview
|
|
1190
|
-
* @requiredField _id
|
|
1191
|
-
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
1192
|
-
* @permissionScope Manage Events
|
|
1193
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1194
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1195
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1196
|
-
* @applicableIdentity APP
|
|
1197
|
-
* @applicableIdentity VISITOR
|
|
1198
|
-
* @returns The plan
|
|
1199
|
-
* @fqn com.wixpress.seating.SeatingPlanManagement.GetSeatingPlan
|
|
1200
|
-
*/
|
|
1201
|
-
export declare function getSeatingPlan(_id: string, options?: GetSeatingPlanOptions): Promise<NonNullablePaths<SeatingPlan, SeatingPlanNonNullablePaths>>;
|
|
1202
|
-
export interface GetSeatingPlanOptions {
|
|
1082
|
+
interface GetSeatingPlanOptions {
|
|
1203
1083
|
/**
|
|
1204
1084
|
* A fieldset for the response
|
|
1205
1085
|
* @deprecated
|
|
@@ -1213,25 +1093,7 @@ export interface GetSeatingPlanOptions {
|
|
|
1213
1093
|
/** Seating Plan Mask */
|
|
1214
1094
|
seatingPlanMask?: SeatingPlanMask;
|
|
1215
1095
|
}
|
|
1216
|
-
|
|
1217
|
-
* Returns the first seating plan found by filter request.
|
|
1218
|
-
* @param filter - The filter of the plan
|
|
1219
|
-
* @public
|
|
1220
|
-
* @documentationMaturity preview
|
|
1221
|
-
* @requiredField filter
|
|
1222
|
-
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
1223
|
-
* @permissionScope Manage Events
|
|
1224
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1225
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1226
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1227
|
-
* @applicableIdentity APP
|
|
1228
|
-
* @applicableIdentity VISITOR
|
|
1229
|
-
* @fqn com.wixpress.seating.SeatingPlanManagement.FindSeatingPlan
|
|
1230
|
-
*/
|
|
1231
|
-
export declare function findSeatingPlan(filter: Record<string, any>, options?: FindSeatingPlanOptions): Promise<NonNullablePaths<FindSeatingPlanResponse, {
|
|
1232
|
-
[P in SeatingPlanNonNullablePaths]: `plan.${P}`;
|
|
1233
|
-
}[SeatingPlanNonNullablePaths]>>;
|
|
1234
|
-
export interface FindSeatingPlanOptions {
|
|
1096
|
+
interface FindSeatingPlanOptions {
|
|
1235
1097
|
/**
|
|
1236
1098
|
* A fieldset for the response
|
|
1237
1099
|
* @deprecated
|
|
@@ -1245,51 +1107,5 @@ export interface FindSeatingPlanOptions {
|
|
|
1245
1107
|
/** Seating Plan Mask */
|
|
1246
1108
|
seatingPlanMask?: SeatingPlanMask;
|
|
1247
1109
|
}
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
* @param _id - The id of the plan
|
|
1251
|
-
* @public
|
|
1252
|
-
* @documentationMaturity preview
|
|
1253
|
-
* @requiredField _id
|
|
1254
|
-
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1255
|
-
* @permissionScope Manage Events
|
|
1256
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1257
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1258
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1259
|
-
* @applicableIdentity APP
|
|
1260
|
-
* @fqn com.wixpress.seating.SeatingPlanManagement.DeleteSeatingPlan
|
|
1261
|
-
*/
|
|
1262
|
-
export declare function deleteSeatingPlan(_id: string): Promise<NonNullablePaths<DeleteSeatingPlanResponse, {
|
|
1263
|
-
[P in SeatingPlanNonNullablePaths]: `plan.${P}`;
|
|
1264
|
-
}[SeatingPlanNonNullablePaths]>>;
|
|
1265
|
-
/**
|
|
1266
|
-
* Updates seating plan thumbnail.
|
|
1267
|
-
* @public
|
|
1268
|
-
* @documentationMaturity preview
|
|
1269
|
-
* @requiredField thumbnail
|
|
1270
|
-
* @requiredField thumbnail._id
|
|
1271
|
-
* @requiredField thumbnail.img
|
|
1272
|
-
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1273
|
-
* @permissionScope Manage Events
|
|
1274
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1275
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1276
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1277
|
-
* @applicableIdentity APP
|
|
1278
|
-
* @fqn com.wixpress.seating.SeatingPlanThumbnailService.UpdateSeatingPlanThumbnail
|
|
1279
|
-
*/
|
|
1280
|
-
export declare function updateSeatingPlanThumbnail(thumbnail: NonNullablePaths<SeatingPlanThumbnail, `_id` | `img`>): Promise<UpdateSeatingPlanThumbnailResponse>;
|
|
1281
|
-
/**
|
|
1282
|
-
* Get seating plan thumbnail.
|
|
1283
|
-
* @public
|
|
1284
|
-
* @documentationMaturity preview
|
|
1285
|
-
* @requiredField _id
|
|
1286
|
-
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1287
|
-
* @permissionScope Manage Events
|
|
1288
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1289
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1290
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1291
|
-
* @applicableIdentity APP
|
|
1292
|
-
* @fqn com.wixpress.seating.SeatingPlanThumbnailService.GetSeatingPlanThumbnail
|
|
1293
|
-
*/
|
|
1294
|
-
export declare function getSeatingPlanThumbnail(_id: string): Promise<GetSeatingPlanThumbnailResponse>;
|
|
1295
|
-
export {};
|
|
1110
|
+
|
|
1111
|
+
export { type QuerySeatingPlanResponse as $, type CreateSeatingPlanResponse as A, type CapacityExceededViolation as B, type CopySeatingPlanOptions as C, type DeleteSeatingPlanResponse as D, type Element as E, type FindSeatingPlanOptions as F, type GetSeatingPlanOptions as G, type UpdateSeatingPlanRequest as H, Icon as I, type UpdateSeatingPlanResponse as J, type CopySeatingPlanRequest as K, type QuerySeatingPlanRequest as L, type MultiRowProperties as M, Numbering as N, type QueryV2 as O, type PlansQueryBuilder as P, type QuerySeatingPlanOptions as Q, type ReservationOptions as R, type SeatingPlan as S, Type as T, type UpdateSeatingPlanOptions as U, type VerticalSequencing as V, WebhookIdentityType as W, type QueryV2PagingMethodOneOf as X, type Sorting as Y, type Paging as Z, type CursorPaging as _, type CopySeatingPlanResponse as a, type GetSeatingPlanRequest as a0, type SeatingPlanMask as a1, type GetSeatingPlanResponse as a2, type FindSeatingPlanRequest as a3, type DeleteSeatingPlanRequest as a4, type DomainEvent as a5, type DomainEventBodyOneOf as a6, type EntityCreatedEvent as a7, type RestoreInfo as a8, type EntityUpdatedEvent as a9, type EntityDeletedEvent as aa, type ActionEvent as ab, type MessageEnvelope as ac, type IdentificationData as ad, type IdentificationDataIdOneOf as ae, type SaveSeatingPlanVersionRequest as af, type SaveSeatingPlanVersionResponse as ag, type QuerySeatingPlanVersionsRequest as ah, type QuerySeatingPlanVersionsResponse as ai, type PagingMetadataV2 as aj, type Cursors as ak, type DiscardSeatingPlanVersionsRequest as al, type DiscardSeatingPlanVersionsResponse as am, type RestoreSeatingPlanRequest as an, type RestoreSeatingPlanResponse as ao, type UpdateSeatingPlanThumbnailRequest as ap, type GetSeatingPlanThumbnailRequest as aq, type BaseEventMetadata as ar, type EventMetadata as as, type PlansQueryResult as at, type FindSeatingPlanResponse as b, type SeatingPlanThumbnail as c, type UpdateSeatingPlanThumbnailResponse as d, type GetSeatingPlanThumbnailResponse as e, type SeatingPlanCreatedEnvelope as f, type SeatingPlanDeletedEnvelope as g, type SeatingPlanUpdatedEnvelope as h, PlaceTypeEnumType as i, ShapeTypeEnumType as j, Position as k, SortOrder as l, Fieldset as m, type Section as n, type Sequencing as o, type Place as p, type ElementUiProperties as q, type Image as r, type RowElement as s, type RowElementUiProperties as t, type Category as u, type ExtendedFields as v, type SeatingPlanUiProperties as w, type ElementGroup as x, type ElementGroupUiProperties as y, type CreateSeatingPlanRequest as z };
|