@wix/auto_sdk_seatings_seating-plan 1.0.0 → 1.0.2
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/src/seating-v1-seating-plan-seating-plan.context.d.ts +1 -1
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.types.d.ts +325 -78
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.types.js.map +1 -1
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.universal.d.ts +379 -85
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.universal.js +27 -0
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.universal.js.map +1 -1
- package/build/es/src/seating-v1-seating-plan-seating-plan.context.d.ts +1 -1
- package/build/es/src/seating-v1-seating-plan-seating-plan.types.d.ts +325 -78
- package/build/es/src/seating-v1-seating-plan-seating-plan.types.js.map +1 -1
- package/build/es/src/seating-v1-seating-plan-seating-plan.universal.d.ts +379 -85
- package/build/es/src/seating-v1-seating-plan-seating-plan.universal.js +27 -0
- package/build/es/src/seating-v1-seating-plan-seating-plan.universal.js.map +1 -1
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.context.d.ts +1 -1
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.types.d.ts +325 -78
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.types.js.map +1 -1
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.universal.d.ts +379 -85
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.universal.js +27 -0
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.universal.js.map +1 -1
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.context.d.ts +1 -1
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.types.d.ts +325 -78
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.types.js.map +1 -1
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.universal.d.ts +379 -85
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.universal.js +27 -0
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export interface SeatingPlan {
|
|
2
2
|
/**
|
|
3
3
|
* Auto generated unique plan id
|
|
4
|
+
* @format GUID
|
|
4
5
|
* @readonly
|
|
5
6
|
*/
|
|
6
7
|
_id?: string | null;
|
|
@@ -8,13 +9,25 @@ export interface SeatingPlan {
|
|
|
8
9
|
* A client defined external id for cross referencing.
|
|
9
10
|
* Can reference external entities.
|
|
10
11
|
* Format: "{fqdn}:{entity guid}"
|
|
12
|
+
* @minLength 1
|
|
13
|
+
* @maxLength 100
|
|
11
14
|
*/
|
|
12
15
|
externalId?: string | null;
|
|
13
|
-
/**
|
|
16
|
+
/**
|
|
17
|
+
* Human friendly plan title
|
|
18
|
+
* @minLength 1
|
|
19
|
+
* @maxLength 120
|
|
20
|
+
*/
|
|
14
21
|
title?: string | null;
|
|
15
|
-
/**
|
|
22
|
+
/**
|
|
23
|
+
* Sections of the plan. Seating plan is divided in high level sections.
|
|
24
|
+
* @maxSize 100
|
|
25
|
+
*/
|
|
16
26
|
sections?: Section[];
|
|
17
|
-
/**
|
|
27
|
+
/**
|
|
28
|
+
* Categories for plan element grouping.
|
|
29
|
+
* @maxSize 100
|
|
30
|
+
*/
|
|
18
31
|
categories?: Category[];
|
|
19
32
|
/**
|
|
20
33
|
* Seating plan created timestamp.
|
|
@@ -38,6 +51,7 @@ export interface SeatingPlan {
|
|
|
38
51
|
totalCategories?: number | null;
|
|
39
52
|
/**
|
|
40
53
|
* Places not assigned to categories
|
|
54
|
+
* @maxSize 50000
|
|
41
55
|
* @readonly
|
|
42
56
|
*/
|
|
43
57
|
uncategorizedPlaces?: Place[];
|
|
@@ -50,20 +64,30 @@ export interface SeatingPlan {
|
|
|
50
64
|
extendedFields?: ExtendedFields;
|
|
51
65
|
/** Seating Plan UI settings */
|
|
52
66
|
uiProperties?: SeatingPlanUiProperties;
|
|
53
|
-
/**
|
|
67
|
+
/**
|
|
68
|
+
* Element groups
|
|
69
|
+
* @maxSize 1000
|
|
70
|
+
*/
|
|
54
71
|
elementGroups?: ElementGroup[];
|
|
55
72
|
}
|
|
56
73
|
export interface Section {
|
|
57
74
|
/** Unique section id */
|
|
58
75
|
_id?: number;
|
|
59
|
-
/**
|
|
76
|
+
/**
|
|
77
|
+
* Human readable section title
|
|
78
|
+
* @minLength 1
|
|
79
|
+
* @maxLength 20
|
|
80
|
+
*/
|
|
60
81
|
title?: string | null;
|
|
61
82
|
/**
|
|
62
83
|
* Client configuration object
|
|
63
84
|
* @readonly
|
|
64
85
|
*/
|
|
65
86
|
config?: Record<string, any> | null;
|
|
66
|
-
/**
|
|
87
|
+
/**
|
|
88
|
+
* Elements of the section.
|
|
89
|
+
* @maxSize 1000
|
|
90
|
+
*/
|
|
67
91
|
elements?: Element[];
|
|
68
92
|
/**
|
|
69
93
|
* Total capacity
|
|
@@ -77,22 +101,37 @@ export interface Section {
|
|
|
77
101
|
default?: boolean;
|
|
78
102
|
}
|
|
79
103
|
export interface Element {
|
|
80
|
-
/**
|
|
104
|
+
/**
|
|
105
|
+
* Unique element id
|
|
106
|
+
* @min 1
|
|
107
|
+
*/
|
|
81
108
|
_id?: number;
|
|
82
|
-
/**
|
|
109
|
+
/**
|
|
110
|
+
* User friendly title/label of the element.
|
|
111
|
+
* @minLength 1
|
|
112
|
+
* @maxLength 50
|
|
113
|
+
*/
|
|
83
114
|
title?: string | null;
|
|
84
115
|
/** Element type */
|
|
85
116
|
type?: Type;
|
|
86
|
-
/**
|
|
117
|
+
/**
|
|
118
|
+
* Capacity. None for Shape type Element.
|
|
119
|
+
* @min 1
|
|
120
|
+
* @max 50000
|
|
121
|
+
*/
|
|
87
122
|
capacity?: number | null;
|
|
88
123
|
/** Assigned to a category */
|
|
89
124
|
categoryId?: number | null;
|
|
90
125
|
/** A place numbering meta data */
|
|
91
126
|
sequencing?: Sequencing;
|
|
92
|
-
/**
|
|
127
|
+
/**
|
|
128
|
+
* Place override (by seq_id)
|
|
129
|
+
* @maxSize 2000
|
|
130
|
+
*/
|
|
93
131
|
overrides?: Place[];
|
|
94
132
|
/**
|
|
95
133
|
* Final place sequence with overrides
|
|
134
|
+
* @maxSize 200
|
|
96
135
|
* @readonly
|
|
97
136
|
*/
|
|
98
137
|
places?: Place[];
|
|
@@ -114,9 +153,16 @@ export declare enum Type {
|
|
|
114
153
|
SHAPE = "SHAPE"
|
|
115
154
|
}
|
|
116
155
|
export interface Sequencing {
|
|
117
|
-
/**
|
|
156
|
+
/**
|
|
157
|
+
* First seq element
|
|
158
|
+
* @minLength 1
|
|
159
|
+
* @maxLength 4
|
|
160
|
+
*/
|
|
118
161
|
startAt?: string;
|
|
119
|
-
/**
|
|
162
|
+
/**
|
|
163
|
+
* Finite generated seq of labels
|
|
164
|
+
* @maxSize 2500
|
|
165
|
+
*/
|
|
120
166
|
labels?: string[];
|
|
121
167
|
/** If true - direction right to left. Otherwise left to right. */
|
|
122
168
|
reverseOrder?: boolean | null;
|
|
@@ -129,7 +175,11 @@ export interface Place {
|
|
|
129
175
|
* @readonly
|
|
130
176
|
*/
|
|
131
177
|
_id?: string | null;
|
|
132
|
-
/**
|
|
178
|
+
/**
|
|
179
|
+
* Unique label of the place
|
|
180
|
+
* @minLength 1
|
|
181
|
+
* @maxLength 4
|
|
182
|
+
*/
|
|
133
183
|
label?: string;
|
|
134
184
|
/**
|
|
135
185
|
* Max capacity per place
|
|
@@ -163,30 +213,76 @@ export interface ReservationOptions {
|
|
|
163
213
|
reserveWholeElement?: boolean;
|
|
164
214
|
}
|
|
165
215
|
export interface ElementUiProperties {
|
|
216
|
+
/**
|
|
217
|
+
* @min -1000000
|
|
218
|
+
* @max 1000000
|
|
219
|
+
*/
|
|
166
220
|
x?: number | null;
|
|
221
|
+
/**
|
|
222
|
+
* @min -1000000
|
|
223
|
+
* @max 1000000
|
|
224
|
+
*/
|
|
167
225
|
y?: number | null;
|
|
226
|
+
/**
|
|
227
|
+
* @min -1000000
|
|
228
|
+
* @max 1000000
|
|
229
|
+
*/
|
|
168
230
|
zIndex?: number | null;
|
|
231
|
+
/** @max 1000000 */
|
|
169
232
|
width?: number | null;
|
|
233
|
+
/** @max 1000000 */
|
|
170
234
|
height?: number | null;
|
|
235
|
+
/**
|
|
236
|
+
* @min -180
|
|
237
|
+
* @max 180
|
|
238
|
+
*/
|
|
171
239
|
rotationAngle?: number | null;
|
|
172
240
|
shapeType?: ShapeTypeEnumType;
|
|
241
|
+
/**
|
|
242
|
+
* @min 10
|
|
243
|
+
* @max 176
|
|
244
|
+
*/
|
|
173
245
|
fontSize?: number | null;
|
|
246
|
+
/** @max 1000000 */
|
|
174
247
|
cornerRadius?: number | null;
|
|
248
|
+
/**
|
|
249
|
+
* @min 1
|
|
250
|
+
* @max 60
|
|
251
|
+
*/
|
|
175
252
|
seatSpacing?: number | null;
|
|
176
253
|
hideLabel?: boolean | null;
|
|
177
254
|
labelPosition?: Position;
|
|
178
255
|
seatLayout?: number[];
|
|
256
|
+
/** @max 50 */
|
|
179
257
|
emptyTopSeatSpaces?: number | null;
|
|
180
|
-
/**
|
|
258
|
+
/**
|
|
259
|
+
* needs research
|
|
260
|
+
* @minLength 1
|
|
261
|
+
* @maxLength 10000
|
|
262
|
+
*/
|
|
181
263
|
text?: string | null;
|
|
182
|
-
/**
|
|
264
|
+
/**
|
|
265
|
+
* #F0F0F0
|
|
266
|
+
* @format COLOR_HEX
|
|
267
|
+
*/
|
|
183
268
|
color?: string | null;
|
|
184
|
-
/**
|
|
269
|
+
/**
|
|
270
|
+
* #F0F0F0
|
|
271
|
+
* @format COLOR_HEX
|
|
272
|
+
*/
|
|
185
273
|
fillColor?: string | null;
|
|
186
|
-
/**
|
|
274
|
+
/**
|
|
275
|
+
* #F0F0F0
|
|
276
|
+
* @format COLOR_HEX
|
|
277
|
+
*/
|
|
187
278
|
strokeColor?: string | null;
|
|
188
|
-
/**
|
|
279
|
+
/**
|
|
280
|
+
* px
|
|
281
|
+
* @min 1
|
|
282
|
+
* @max 6
|
|
283
|
+
*/
|
|
189
284
|
strokeWidth?: number | null;
|
|
285
|
+
/** @max 100 */
|
|
190
286
|
opacity?: number | null;
|
|
191
287
|
icon?: Icon;
|
|
192
288
|
image?: Image;
|
|
@@ -249,21 +345,42 @@ export declare enum Numbering {
|
|
|
249
345
|
ALPHABETICAL = "ALPHABETICAL"
|
|
250
346
|
}
|
|
251
347
|
export interface MultiRowProperties {
|
|
252
|
-
/**
|
|
348
|
+
/**
|
|
349
|
+
* Individual rows of the multi row element
|
|
350
|
+
* @maxSize 1000
|
|
351
|
+
*/
|
|
253
352
|
rows?: RowElement[];
|
|
254
353
|
/** Meta data for vertical labeling */
|
|
255
354
|
verticalSequencing?: VerticalSequencing;
|
|
256
|
-
/**
|
|
355
|
+
/**
|
|
356
|
+
* Row spacing
|
|
357
|
+
* @min 1
|
|
358
|
+
* @max 60
|
|
359
|
+
*/
|
|
257
360
|
rowSpacing?: number | null;
|
|
258
|
-
/**
|
|
361
|
+
/**
|
|
362
|
+
* Amount of seats in the row
|
|
363
|
+
* @max 50
|
|
364
|
+
*/
|
|
259
365
|
seatAmount?: number | null;
|
|
260
366
|
}
|
|
261
367
|
export interface RowElement {
|
|
262
|
-
/**
|
|
368
|
+
/**
|
|
369
|
+
* Unique row id
|
|
370
|
+
* @min 1
|
|
371
|
+
*/
|
|
263
372
|
_id?: number;
|
|
264
|
-
/**
|
|
373
|
+
/**
|
|
374
|
+
* User friendly title/label of the row
|
|
375
|
+
* @minLength 1
|
|
376
|
+
* @maxLength 50
|
|
377
|
+
*/
|
|
265
378
|
title?: string | null;
|
|
266
|
-
/**
|
|
379
|
+
/**
|
|
380
|
+
* Row capacity
|
|
381
|
+
* @min 1
|
|
382
|
+
* @max 50000
|
|
383
|
+
*/
|
|
267
384
|
capacity?: number | null;
|
|
268
385
|
/** Assigned to a category */
|
|
269
386
|
categoryId?: number | null;
|
|
@@ -273,13 +390,27 @@ export interface RowElement {
|
|
|
273
390
|
uiProperties?: RowElementUiProperties;
|
|
274
391
|
}
|
|
275
392
|
export interface RowElementUiProperties {
|
|
276
|
-
/**
|
|
393
|
+
/**
|
|
394
|
+
* Relative x position to the parent element
|
|
395
|
+
* @min -1000000
|
|
396
|
+
* @max 1000000
|
|
397
|
+
*/
|
|
277
398
|
relativeX?: number | null;
|
|
278
|
-
/**
|
|
399
|
+
/**
|
|
400
|
+
* Width of the row
|
|
401
|
+
* @max 1000000
|
|
402
|
+
*/
|
|
279
403
|
width?: number | null;
|
|
280
|
-
/**
|
|
404
|
+
/**
|
|
405
|
+
* Amount of seats in the row
|
|
406
|
+
* @max 50
|
|
407
|
+
*/
|
|
281
408
|
seatAmount?: number | null;
|
|
282
|
-
/**
|
|
409
|
+
/**
|
|
410
|
+
* Seat spacing
|
|
411
|
+
* @min 1
|
|
412
|
+
* @max 60
|
|
413
|
+
*/
|
|
283
414
|
seatSpacing?: number | null;
|
|
284
415
|
/** Label position */
|
|
285
416
|
labelPosition?: Position;
|
|
@@ -287,7 +418,11 @@ export interface RowElementUiProperties {
|
|
|
287
418
|
seatNumbering?: Numbering;
|
|
288
419
|
}
|
|
289
420
|
export interface VerticalSequencing {
|
|
290
|
-
/**
|
|
421
|
+
/**
|
|
422
|
+
* First seq element
|
|
423
|
+
* @minLength 1
|
|
424
|
+
* @maxLength 4
|
|
425
|
+
*/
|
|
291
426
|
startAt?: string;
|
|
292
427
|
/** Row numbering */
|
|
293
428
|
rowNumbering?: Numbering;
|
|
@@ -295,15 +430,24 @@ export interface VerticalSequencing {
|
|
|
295
430
|
reverseOrder?: boolean | null;
|
|
296
431
|
}
|
|
297
432
|
export interface Category {
|
|
298
|
-
/**
|
|
433
|
+
/**
|
|
434
|
+
* Local category id within the seating plan
|
|
435
|
+
* @min 1
|
|
436
|
+
*/
|
|
299
437
|
_id?: number;
|
|
300
438
|
/**
|
|
301
439
|
* A client defined external id for cross referencing.
|
|
302
440
|
* Can reference external entities.
|
|
303
441
|
* Format: "{entity_fqdn}:{entity_id}"
|
|
442
|
+
* @minLength 1
|
|
443
|
+
* @maxLength 100
|
|
304
444
|
*/
|
|
305
445
|
externalId?: string | null;
|
|
306
|
-
/**
|
|
446
|
+
/**
|
|
447
|
+
* Category label
|
|
448
|
+
* @minLength 1
|
|
449
|
+
* @maxLength 120
|
|
450
|
+
*/
|
|
307
451
|
title?: string;
|
|
308
452
|
/**
|
|
309
453
|
* Client configuration object
|
|
@@ -317,6 +461,7 @@ export interface Category {
|
|
|
317
461
|
totalCapacity?: number | null;
|
|
318
462
|
/**
|
|
319
463
|
* Possible places
|
|
464
|
+
* @maxSize 50000
|
|
320
465
|
* @readonly
|
|
321
466
|
*/
|
|
322
467
|
places?: Place[];
|
|
@@ -333,12 +478,19 @@ export interface ExtendedFields {
|
|
|
333
478
|
namespaces?: Record<string, Record<string, any>>;
|
|
334
479
|
}
|
|
335
480
|
export interface SeatingPlanUiProperties {
|
|
336
|
-
/**
|
|
481
|
+
/**
|
|
482
|
+
* #F0F0F0
|
|
483
|
+
* @format COLOR_HEX
|
|
484
|
+
*/
|
|
337
485
|
backgroundColor?: string | null;
|
|
486
|
+
/** @max 100 */
|
|
338
487
|
backgroundOpacity?: number | null;
|
|
339
488
|
}
|
|
340
489
|
export interface ElementGroup {
|
|
341
|
-
/**
|
|
490
|
+
/**
|
|
491
|
+
* Unique element group id
|
|
492
|
+
* @min 1
|
|
493
|
+
*/
|
|
342
494
|
_id?: number;
|
|
343
495
|
/** Parent group id */
|
|
344
496
|
parentElementGroupId?: number | null;
|
|
@@ -346,15 +498,33 @@ export interface ElementGroup {
|
|
|
346
498
|
uiProperties?: ElementGroupUiProperties;
|
|
347
499
|
}
|
|
348
500
|
export interface ElementGroupUiProperties {
|
|
349
|
-
/**
|
|
501
|
+
/**
|
|
502
|
+
* x position of the group
|
|
503
|
+
* @min -1000000
|
|
504
|
+
* @max 1000000
|
|
505
|
+
*/
|
|
350
506
|
x?: number | null;
|
|
351
|
-
/**
|
|
507
|
+
/**
|
|
508
|
+
* y position of the group
|
|
509
|
+
* @min -1000000
|
|
510
|
+
* @max 1000000
|
|
511
|
+
*/
|
|
352
512
|
y?: number | null;
|
|
353
|
-
/**
|
|
513
|
+
/**
|
|
514
|
+
* width of the group
|
|
515
|
+
* @max 1000000
|
|
516
|
+
*/
|
|
354
517
|
width?: number | null;
|
|
355
|
-
/**
|
|
518
|
+
/**
|
|
519
|
+
* height of the group
|
|
520
|
+
* @max 1000000
|
|
521
|
+
*/
|
|
356
522
|
height?: number | null;
|
|
357
|
-
/**
|
|
523
|
+
/**
|
|
524
|
+
* rotation angle of the group
|
|
525
|
+
* @min -180
|
|
526
|
+
* @max 180
|
|
527
|
+
*/
|
|
358
528
|
rotationAngle?: number | null;
|
|
359
529
|
}
|
|
360
530
|
export interface CreateSeatingPlanRequest {
|
|
@@ -384,11 +554,22 @@ export interface UpdateSeatingPlanResponse {
|
|
|
384
554
|
plan?: SeatingPlan;
|
|
385
555
|
}
|
|
386
556
|
export interface CopySeatingPlanRequest {
|
|
387
|
-
/**
|
|
557
|
+
/**
|
|
558
|
+
* The id of the plan to be copied
|
|
559
|
+
* @format GUID
|
|
560
|
+
*/
|
|
388
561
|
_id: string | null;
|
|
389
|
-
/**
|
|
562
|
+
/**
|
|
563
|
+
* New plan title
|
|
564
|
+
* @minLength 1
|
|
565
|
+
* @maxLength 120
|
|
566
|
+
*/
|
|
390
567
|
title: string | null;
|
|
391
|
-
/**
|
|
568
|
+
/**
|
|
569
|
+
* Format: "{fqdn}:{entity guid}"
|
|
570
|
+
* @minLength 1
|
|
571
|
+
* @maxLength 100
|
|
572
|
+
*/
|
|
392
573
|
externalId: string | null;
|
|
393
574
|
}
|
|
394
575
|
export interface CopySeatingPlanResponse {
|
|
@@ -434,7 +615,10 @@ export interface QueryV2PagingMethodOneOf {
|
|
|
434
615
|
cursorPaging?: CursorPaging;
|
|
435
616
|
}
|
|
436
617
|
export interface Sorting {
|
|
437
|
-
/**
|
|
618
|
+
/**
|
|
619
|
+
* Name of the field to sort by.
|
|
620
|
+
* @maxLength 512
|
|
621
|
+
*/
|
|
438
622
|
fieldName?: string;
|
|
439
623
|
/** Sort order. */
|
|
440
624
|
order?: SortOrder;
|
|
@@ -450,13 +634,17 @@ export interface Paging {
|
|
|
450
634
|
offset?: number | null;
|
|
451
635
|
}
|
|
452
636
|
export interface CursorPaging {
|
|
453
|
-
/**
|
|
637
|
+
/**
|
|
638
|
+
* Maximum number of items to return in the results.
|
|
639
|
+
* @max 100
|
|
640
|
+
*/
|
|
454
641
|
limit?: number | null;
|
|
455
642
|
/**
|
|
456
643
|
* Pointer to the next or previous page in the list of results.
|
|
457
644
|
*
|
|
458
645
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
459
646
|
* Not relevant for the first request.
|
|
647
|
+
* @maxLength 16000
|
|
460
648
|
*/
|
|
461
649
|
cursor?: string | null;
|
|
462
650
|
}
|
|
@@ -472,7 +660,10 @@ export interface QuerySeatingPlanResponse {
|
|
|
472
660
|
plans?: SeatingPlan[];
|
|
473
661
|
}
|
|
474
662
|
export interface GetSeatingPlanRequest {
|
|
475
|
-
/**
|
|
663
|
+
/**
|
|
664
|
+
* The id of the plan
|
|
665
|
+
* @format GUID
|
|
666
|
+
*/
|
|
476
667
|
_id: string | null;
|
|
477
668
|
/**
|
|
478
669
|
* A fieldset for the response
|
|
@@ -488,7 +679,11 @@ export interface GetSeatingPlanRequest {
|
|
|
488
679
|
seatingPlanMask?: SeatingPlanMask;
|
|
489
680
|
}
|
|
490
681
|
export interface SeatingPlanMask {
|
|
491
|
-
/**
|
|
682
|
+
/**
|
|
683
|
+
* Filter seating plan by place ids
|
|
684
|
+
* @minLength 5
|
|
685
|
+
* @maxLength 11
|
|
686
|
+
*/
|
|
492
687
|
placeId?: string[];
|
|
493
688
|
}
|
|
494
689
|
export interface GetSeatingPlanResponse {
|
|
@@ -516,7 +711,10 @@ export interface FindSeatingPlanResponse {
|
|
|
516
711
|
plan?: SeatingPlan;
|
|
517
712
|
}
|
|
518
713
|
export interface DeleteSeatingPlanRequest {
|
|
519
|
-
/**
|
|
714
|
+
/**
|
|
715
|
+
* The id of the plan
|
|
716
|
+
* @format GUID
|
|
717
|
+
*/
|
|
520
718
|
_id: string | null;
|
|
521
719
|
}
|
|
522
720
|
export interface DeleteSeatingPlanResponse {
|
|
@@ -594,9 +792,15 @@ export interface ActionEvent {
|
|
|
594
792
|
body?: string;
|
|
595
793
|
}
|
|
596
794
|
export interface MessageEnvelope {
|
|
597
|
-
/**
|
|
795
|
+
/**
|
|
796
|
+
* App instance ID.
|
|
797
|
+
* @format GUID
|
|
798
|
+
*/
|
|
598
799
|
instanceId?: string | null;
|
|
599
|
-
/**
|
|
800
|
+
/**
|
|
801
|
+
* Event type.
|
|
802
|
+
* @maxLength 150
|
|
803
|
+
*/
|
|
600
804
|
eventType?: string;
|
|
601
805
|
/** The identification type and identity data. */
|
|
602
806
|
identity?: IdentificationData;
|
|
@@ -604,26 +808,50 @@ export interface MessageEnvelope {
|
|
|
604
808
|
data?: string;
|
|
605
809
|
}
|
|
606
810
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
607
|
-
/**
|
|
811
|
+
/**
|
|
812
|
+
* ID of a site visitor that has not logged in to the site.
|
|
813
|
+
* @format GUID
|
|
814
|
+
*/
|
|
608
815
|
anonymousVisitorId?: string;
|
|
609
|
-
/**
|
|
816
|
+
/**
|
|
817
|
+
* ID of a site visitor that has logged in to the site.
|
|
818
|
+
* @format GUID
|
|
819
|
+
*/
|
|
610
820
|
memberId?: string;
|
|
611
|
-
/**
|
|
821
|
+
/**
|
|
822
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
823
|
+
* @format GUID
|
|
824
|
+
*/
|
|
612
825
|
wixUserId?: string;
|
|
613
|
-
/**
|
|
826
|
+
/**
|
|
827
|
+
* ID of an app.
|
|
828
|
+
* @format GUID
|
|
829
|
+
*/
|
|
614
830
|
appId?: string;
|
|
615
831
|
/** @readonly */
|
|
616
832
|
identityType?: WebhookIdentityType;
|
|
617
833
|
}
|
|
618
834
|
/** @oneof */
|
|
619
835
|
export interface IdentificationDataIdOneOf {
|
|
620
|
-
/**
|
|
836
|
+
/**
|
|
837
|
+
* ID of a site visitor that has not logged in to the site.
|
|
838
|
+
* @format GUID
|
|
839
|
+
*/
|
|
621
840
|
anonymousVisitorId?: string;
|
|
622
|
-
/**
|
|
841
|
+
/**
|
|
842
|
+
* ID of a site visitor that has logged in to the site.
|
|
843
|
+
* @format GUID
|
|
844
|
+
*/
|
|
623
845
|
memberId?: string;
|
|
624
|
-
/**
|
|
846
|
+
/**
|
|
847
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
848
|
+
* @format GUID
|
|
849
|
+
*/
|
|
625
850
|
wixUserId?: string;
|
|
626
|
-
/**
|
|
851
|
+
/**
|
|
852
|
+
* ID of an app.
|
|
853
|
+
* @format GUID
|
|
854
|
+
*/
|
|
627
855
|
appId?: string;
|
|
628
856
|
}
|
|
629
857
|
export declare enum WebhookIdentityType {
|
|
@@ -633,24 +861,6 @@ export declare enum WebhookIdentityType {
|
|
|
633
861
|
WIX_USER = "WIX_USER",
|
|
634
862
|
APP = "APP"
|
|
635
863
|
}
|
|
636
|
-
export interface UpdateSeatingPlanThumbnailRequest {
|
|
637
|
-
thumbnail: SeatingPlanThumbnail;
|
|
638
|
-
}
|
|
639
|
-
export interface SeatingPlanThumbnail {
|
|
640
|
-
/** @readonly */
|
|
641
|
-
_id?: string | null;
|
|
642
|
-
img?: string | null;
|
|
643
|
-
}
|
|
644
|
-
export interface UpdateSeatingPlanThumbnailResponse {
|
|
645
|
-
thumbnail?: SeatingPlanThumbnail;
|
|
646
|
-
}
|
|
647
|
-
export interface GetSeatingPlanThumbnailRequest {
|
|
648
|
-
/** @readonly */
|
|
649
|
-
_id: string | null;
|
|
650
|
-
}
|
|
651
|
-
export interface GetSeatingPlanThumbnailResponse {
|
|
652
|
-
thumbnail?: SeatingPlanThumbnail;
|
|
653
|
-
}
|
|
654
864
|
export interface SaveSeatingPlanVersionRequest {
|
|
655
865
|
/** A plan version to be saved */
|
|
656
866
|
plan?: SeatingPlan;
|
|
@@ -661,6 +871,7 @@ export interface SaveSeatingPlanVersionRequest {
|
|
|
661
871
|
* but intermediate versions will be removed. Example:
|
|
662
872
|
* Existing versions [1, 2, 3, 4, 5].
|
|
663
873
|
* Save request with parent_version 2 will yield versions [1, 2, 6].
|
|
874
|
+
* @min 1
|
|
664
875
|
*/
|
|
665
876
|
parentVersion?: string | null;
|
|
666
877
|
}
|
|
@@ -694,13 +905,22 @@ export interface PagingMetadataV2 {
|
|
|
694
905
|
cursors?: Cursors;
|
|
695
906
|
}
|
|
696
907
|
export interface Cursors {
|
|
697
|
-
/**
|
|
908
|
+
/**
|
|
909
|
+
* Cursor string pointing to the next page in the list of results.
|
|
910
|
+
* @maxLength 16000
|
|
911
|
+
*/
|
|
698
912
|
next?: string | null;
|
|
699
|
-
/**
|
|
913
|
+
/**
|
|
914
|
+
* Cursor pointing to the previous page in the list of results.
|
|
915
|
+
* @maxLength 16000
|
|
916
|
+
*/
|
|
700
917
|
prev?: string | null;
|
|
701
918
|
}
|
|
702
919
|
export interface DiscardSeatingPlanVersionsRequest {
|
|
703
|
-
/**
|
|
920
|
+
/**
|
|
921
|
+
* Seating Plan ID
|
|
922
|
+
* @format GUID
|
|
923
|
+
*/
|
|
704
924
|
seatingPlanId?: string | null;
|
|
705
925
|
/** Version from which all higher versions will be discarded. */
|
|
706
926
|
version?: string | null;
|
|
@@ -708,7 +928,10 @@ export interface DiscardSeatingPlanVersionsRequest {
|
|
|
708
928
|
export interface DiscardSeatingPlanVersionsResponse {
|
|
709
929
|
}
|
|
710
930
|
export interface RestoreSeatingPlanRequest {
|
|
711
|
-
/**
|
|
931
|
+
/**
|
|
932
|
+
* Seating Plan ID
|
|
933
|
+
* @format GUID
|
|
934
|
+
*/
|
|
712
935
|
seatingPlanId?: string | null;
|
|
713
936
|
/** Version to witch the seating plan should be restored. */
|
|
714
937
|
version?: string | null;
|
|
@@ -717,6 +940,30 @@ export interface RestoreSeatingPlanResponse {
|
|
|
717
940
|
/** Seating Plan */
|
|
718
941
|
plan?: SeatingPlan;
|
|
719
942
|
}
|
|
943
|
+
export interface UpdateSeatingPlanThumbnailRequest {
|
|
944
|
+
thumbnail: SeatingPlanThumbnail;
|
|
945
|
+
}
|
|
946
|
+
export interface SeatingPlanThumbnail {
|
|
947
|
+
/**
|
|
948
|
+
* @format GUID
|
|
949
|
+
* @readonly
|
|
950
|
+
*/
|
|
951
|
+
_id?: string | null;
|
|
952
|
+
img?: string | null;
|
|
953
|
+
}
|
|
954
|
+
export interface UpdateSeatingPlanThumbnailResponse {
|
|
955
|
+
thumbnail?: SeatingPlanThumbnail;
|
|
956
|
+
}
|
|
957
|
+
export interface GetSeatingPlanThumbnailRequest {
|
|
958
|
+
/**
|
|
959
|
+
* @format GUID
|
|
960
|
+
* @readonly
|
|
961
|
+
*/
|
|
962
|
+
_id: string | null;
|
|
963
|
+
}
|
|
964
|
+
export interface GetSeatingPlanThumbnailResponse {
|
|
965
|
+
thumbnail?: SeatingPlanThumbnail;
|
|
966
|
+
}
|
|
720
967
|
interface SequencingNonNullableFields {
|
|
721
968
|
startAt: string;
|
|
722
969
|
labels: string[];
|
|
@@ -811,9 +1058,15 @@ export interface DeleteSeatingPlanResponseNonNullableFields {
|
|
|
811
1058
|
plan?: SeatingPlanNonNullableFields;
|
|
812
1059
|
}
|
|
813
1060
|
export interface BaseEventMetadata {
|
|
814
|
-
/**
|
|
1061
|
+
/**
|
|
1062
|
+
* App instance ID.
|
|
1063
|
+
* @format GUID
|
|
1064
|
+
*/
|
|
815
1065
|
instanceId?: string | null;
|
|
816
|
-
/**
|
|
1066
|
+
/**
|
|
1067
|
+
* Event type.
|
|
1068
|
+
* @maxLength 150
|
|
1069
|
+
*/
|
|
817
1070
|
eventType?: string;
|
|
818
1071
|
/** The identification type and identity data. */
|
|
819
1072
|
identity?: IdentificationData;
|
|
@@ -860,7 +1113,9 @@ export interface SeatingPlanCreatedEnvelope {
|
|
|
860
1113
|
entity: SeatingPlan;
|
|
861
1114
|
metadata: EventMetadata;
|
|
862
1115
|
}
|
|
863
|
-
/** @
|
|
1116
|
+
/** @permissionScope Manage Events
|
|
1117
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1118
|
+
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
864
1119
|
* @webhook
|
|
865
1120
|
* @eventType wix.seating.v1.seating_plan_created
|
|
866
1121
|
* @slug created
|
|
@@ -871,7 +1126,9 @@ export interface SeatingPlanDeletedEnvelope {
|
|
|
871
1126
|
entity: SeatingPlan;
|
|
872
1127
|
metadata: EventMetadata;
|
|
873
1128
|
}
|
|
874
|
-
/** @
|
|
1129
|
+
/** @permissionScope Manage Events
|
|
1130
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1131
|
+
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
875
1132
|
* @webhook
|
|
876
1133
|
* @eventType wix.seating.v1.seating_plan_deleted
|
|
877
1134
|
* @slug deleted
|
|
@@ -882,7 +1139,9 @@ export interface SeatingPlanUpdatedEnvelope {
|
|
|
882
1139
|
entity: SeatingPlan;
|
|
883
1140
|
metadata: EventMetadata;
|
|
884
1141
|
}
|
|
885
|
-
/** @
|
|
1142
|
+
/** @permissionScope Manage Events
|
|
1143
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1144
|
+
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
886
1145
|
* @webhook
|
|
887
1146
|
* @eventType wix.seating.v1.seating_plan_updated
|
|
888
1147
|
* @slug updated
|
|
@@ -898,6 +1157,9 @@ export declare function onSeatingPlanUpdated(handler: (event: SeatingPlanUpdated
|
|
|
898
1157
|
* @requiredField plan.sections.elements.title
|
|
899
1158
|
* @requiredField plan.title
|
|
900
1159
|
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1160
|
+
* @permissionScope Manage Events
|
|
1161
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1162
|
+
* @applicableIdentity APP
|
|
901
1163
|
* @returns The created plan
|
|
902
1164
|
* @fqn com.wixpress.seating.SeatingPlanManagement.CreateSeatingPlan
|
|
903
1165
|
*/
|
|
@@ -909,6 +1171,9 @@ export declare function createSeatingPlan(plan: SeatingPlan): Promise<SeatingPla
|
|
|
909
1171
|
* @requiredField options.plan._id
|
|
910
1172
|
* @requiredField options.plan.sections.elements.title
|
|
911
1173
|
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1174
|
+
* @permissionScope Manage Events
|
|
1175
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1176
|
+
* @applicableIdentity APP
|
|
912
1177
|
* @returns The updated plan
|
|
913
1178
|
* @fqn com.wixpress.seating.SeatingPlanManagement.UpdateSeatingPlan
|
|
914
1179
|
*/
|
|
@@ -929,20 +1194,34 @@ export interface UpdateSeatingPlanOptions {
|
|
|
929
1194
|
* @requiredField options.externalId
|
|
930
1195
|
* @requiredField options.title
|
|
931
1196
|
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1197
|
+
* @permissionScope Manage Events
|
|
1198
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1199
|
+
* @applicableIdentity APP
|
|
932
1200
|
* @fqn com.wixpress.seating.SeatingPlanManagement.CopySeatingPlan
|
|
933
1201
|
*/
|
|
934
1202
|
export declare function copySeatingPlan(_id: string | null, options: CopySeatingPlanOptions): Promise<CopySeatingPlanResponse & CopySeatingPlanResponseNonNullableFields>;
|
|
935
1203
|
export interface CopySeatingPlanOptions {
|
|
936
|
-
/**
|
|
1204
|
+
/**
|
|
1205
|
+
* New plan title
|
|
1206
|
+
* @minLength 1
|
|
1207
|
+
* @maxLength 120
|
|
1208
|
+
*/
|
|
937
1209
|
title: string | null;
|
|
938
|
-
/**
|
|
1210
|
+
/**
|
|
1211
|
+
* Format: "{fqdn}:{entity guid}"
|
|
1212
|
+
* @minLength 1
|
|
1213
|
+
* @maxLength 100
|
|
1214
|
+
*/
|
|
939
1215
|
externalId: string | null;
|
|
940
1216
|
}
|
|
941
1217
|
/**
|
|
942
1218
|
* Lists seating plans by provided query request
|
|
943
1219
|
* @public
|
|
944
1220
|
* @documentationMaturity preview
|
|
1221
|
+
* @permissionScope Manage Events
|
|
1222
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
945
1223
|
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
1224
|
+
* @applicableIdentity APP
|
|
946
1225
|
* @applicableIdentity VISITOR
|
|
947
1226
|
* @fqn com.wixpress.seating.SeatingPlanManagement.QuerySeatingPlan
|
|
948
1227
|
*/
|
|
@@ -983,6 +1262,9 @@ export interface PlansQueryBuilder {
|
|
|
983
1262
|
* @documentationMaturity preview
|
|
984
1263
|
* @requiredField _id
|
|
985
1264
|
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
1265
|
+
* @permissionScope Manage Events
|
|
1266
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1267
|
+
* @applicableIdentity APP
|
|
986
1268
|
* @applicableIdentity VISITOR
|
|
987
1269
|
* @returns The plan
|
|
988
1270
|
* @fqn com.wixpress.seating.SeatingPlanManagement.GetSeatingPlan
|
|
@@ -1009,6 +1291,9 @@ export interface GetSeatingPlanOptions {
|
|
|
1009
1291
|
* @documentationMaturity preview
|
|
1010
1292
|
* @requiredField filter
|
|
1011
1293
|
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
1294
|
+
* @permissionScope Manage Events
|
|
1295
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1296
|
+
* @applicableIdentity APP
|
|
1012
1297
|
* @applicableIdentity VISITOR
|
|
1013
1298
|
* @fqn com.wixpress.seating.SeatingPlanManagement.FindSeatingPlan
|
|
1014
1299
|
*/
|
|
@@ -1034,6 +1319,9 @@ export interface FindSeatingPlanOptions {
|
|
|
1034
1319
|
* @documentationMaturity preview
|
|
1035
1320
|
* @requiredField _id
|
|
1036
1321
|
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1322
|
+
* @permissionScope Manage Events
|
|
1323
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1324
|
+
* @applicableIdentity APP
|
|
1037
1325
|
* @fqn com.wixpress.seating.SeatingPlanManagement.DeleteSeatingPlan
|
|
1038
1326
|
*/
|
|
1039
1327
|
export declare function deleteSeatingPlan(_id: string | null): Promise<DeleteSeatingPlanResponse & DeleteSeatingPlanResponseNonNullableFields>;
|
|
@@ -1045,6 +1333,9 @@ export declare function deleteSeatingPlan(_id: string | null): Promise<DeleteSea
|
|
|
1045
1333
|
* @requiredField thumbnail._id
|
|
1046
1334
|
* @requiredField thumbnail.img
|
|
1047
1335
|
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1336
|
+
* @permissionScope Manage Events
|
|
1337
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1338
|
+
* @applicableIdentity APP
|
|
1048
1339
|
* @fqn com.wixpress.seating.SeatingPlanThumbnailService.UpdateSeatingPlanThumbnail
|
|
1049
1340
|
*/
|
|
1050
1341
|
export declare function updateSeatingPlanThumbnail(thumbnail: SeatingPlanThumbnail): Promise<UpdateSeatingPlanThumbnailResponse>;
|
|
@@ -1054,6 +1345,9 @@ export declare function updateSeatingPlanThumbnail(thumbnail: SeatingPlanThumbna
|
|
|
1054
1345
|
* @documentationMaturity preview
|
|
1055
1346
|
* @requiredField _id
|
|
1056
1347
|
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1348
|
+
* @permissionScope Manage Events
|
|
1349
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1350
|
+
* @applicableIdentity APP
|
|
1057
1351
|
* @fqn com.wixpress.seating.SeatingPlanThumbnailService.GetSeatingPlanThumbnail
|
|
1058
1352
|
*/
|
|
1059
1353
|
export declare function getSeatingPlanThumbnail(_id: string | null): Promise<GetSeatingPlanThumbnailResponse>;
|