@wix/auto_sdk_seatings_seating-plan 1.0.0
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 +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.context.d.ts +23 -0
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.context.js +35 -0
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.context.js.map +1 -0
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.http.d.ts +19 -0
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.http.js +673 -0
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.http.js.map +1 -0
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.meta.d.ts +25 -0
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.meta.js +199 -0
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.meta.js.map +1 -0
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.public.d.ts +80 -0
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.public.js +204 -0
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.public.js.map +1 -0
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.types.d.ts +815 -0
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.types.js +85 -0
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.types.js.map +1 -0
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.universal.d.ts +1060 -0
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.universal.js +458 -0
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/seating-v1-seating-plan-seating-plan.context.d.ts +23 -0
- package/build/es/src/seating-v1-seating-plan-seating-plan.context.js +23 -0
- package/build/es/src/seating-v1-seating-plan-seating-plan.context.js.map +1 -0
- package/build/es/src/seating-v1-seating-plan-seating-plan.http.d.ts +19 -0
- package/build/es/src/seating-v1-seating-plan-seating-plan.http.js +661 -0
- package/build/es/src/seating-v1-seating-plan-seating-plan.http.js.map +1 -0
- package/build/es/src/seating-v1-seating-plan-seating-plan.meta.d.ts +25 -0
- package/build/es/src/seating-v1-seating-plan-seating-plan.meta.js +164 -0
- package/build/es/src/seating-v1-seating-plan-seating-plan.meta.js.map +1 -0
- package/build/es/src/seating-v1-seating-plan-seating-plan.public.d.ts +80 -0
- package/build/es/src/seating-v1-seating-plan-seating-plan.public.js +183 -0
- package/build/es/src/seating-v1-seating-plan-seating-plan.public.js.map +1 -0
- package/build/es/src/seating-v1-seating-plan-seating-plan.types.d.ts +815 -0
- package/build/es/src/seating-v1-seating-plan-seating-plan.types.js +82 -0
- package/build/es/src/seating-v1-seating-plan-seating-plan.types.js.map +1 -0
- package/build/es/src/seating-v1-seating-plan-seating-plan.universal.d.ts +1060 -0
- package/build/es/src/seating-v1-seating-plan-seating-plan.universal.js +423 -0
- package/build/es/src/seating-v1-seating-plan-seating-plan.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.context.d.ts +23 -0
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.context.js +35 -0
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.context.js.map +1 -0
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.http.d.ts +19 -0
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.http.js +673 -0
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.http.js.map +1 -0
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.meta.d.ts +25 -0
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.meta.js +199 -0
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.meta.js.map +1 -0
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.public.d.ts +80 -0
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.public.js +204 -0
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.public.js.map +1 -0
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.types.d.ts +815 -0
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.types.js +85 -0
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.types.js.map +1 -0
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.universal.d.ts +1060 -0
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.universal.js +458 -0
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.context.d.ts +23 -0
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.context.js +23 -0
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.context.js.map +1 -0
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.http.d.ts +19 -0
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.http.js +661 -0
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.http.js.map +1 -0
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.meta.d.ts +25 -0
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.meta.js +164 -0
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.meta.js.map +1 -0
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.public.d.ts +80 -0
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.public.js +183 -0
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.public.js.map +1 -0
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.types.d.ts +815 -0
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.types.js +82 -0
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.types.js.map +1 -0
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.universal.d.ts +1060 -0
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.universal.js +423 -0
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.universal.js.map +1 -0
- package/meta/package.json +3 -0
- package/package.json +52 -0
|
@@ -0,0 +1,1060 @@
|
|
|
1
|
+
export interface SeatingPlan {
|
|
2
|
+
/**
|
|
3
|
+
* Auto generated unique plan id
|
|
4
|
+
* @readonly
|
|
5
|
+
*/
|
|
6
|
+
_id?: string | null;
|
|
7
|
+
/**
|
|
8
|
+
* A client defined external id for cross referencing.
|
|
9
|
+
* Can reference external entities.
|
|
10
|
+
* Format: "{fqdn}:{entity guid}"
|
|
11
|
+
*/
|
|
12
|
+
externalId?: string | null;
|
|
13
|
+
/** Human friendly plan title */
|
|
14
|
+
title?: string | null;
|
|
15
|
+
/** Sections of the plan. Seating plan is divided in high level sections. */
|
|
16
|
+
sections?: Section[];
|
|
17
|
+
/** Categories for plan element grouping. */
|
|
18
|
+
categories?: Category[];
|
|
19
|
+
/**
|
|
20
|
+
* Seating plan created timestamp.
|
|
21
|
+
* @readonly
|
|
22
|
+
*/
|
|
23
|
+
_createdDate?: Date | null;
|
|
24
|
+
/**
|
|
25
|
+
* Seating plan updated timestamp.
|
|
26
|
+
* @readonly
|
|
27
|
+
*/
|
|
28
|
+
_updatedDate?: Date | null;
|
|
29
|
+
/**
|
|
30
|
+
* Total capacity
|
|
31
|
+
* @readonly
|
|
32
|
+
*/
|
|
33
|
+
totalCapacity?: number | null;
|
|
34
|
+
/**
|
|
35
|
+
* Total categories
|
|
36
|
+
* @readonly
|
|
37
|
+
*/
|
|
38
|
+
totalCategories?: number | null;
|
|
39
|
+
/**
|
|
40
|
+
* Places not assigned to categories
|
|
41
|
+
* @readonly
|
|
42
|
+
*/
|
|
43
|
+
uncategorizedPlaces?: Place[];
|
|
44
|
+
/**
|
|
45
|
+
* A version of the seating plan
|
|
46
|
+
* @readonly
|
|
47
|
+
*/
|
|
48
|
+
version?: string | null;
|
|
49
|
+
/** Data extensions */
|
|
50
|
+
extendedFields?: ExtendedFields;
|
|
51
|
+
/** Seating Plan UI settings */
|
|
52
|
+
uiProperties?: SeatingPlanUiProperties;
|
|
53
|
+
/** Element groups */
|
|
54
|
+
elementGroups?: ElementGroup[];
|
|
55
|
+
}
|
|
56
|
+
export interface Section {
|
|
57
|
+
/** Unique section id */
|
|
58
|
+
_id?: number;
|
|
59
|
+
/** Human readable section title */
|
|
60
|
+
title?: string | null;
|
|
61
|
+
/**
|
|
62
|
+
* Client configuration object
|
|
63
|
+
* @readonly
|
|
64
|
+
*/
|
|
65
|
+
config?: Record<string, any> | null;
|
|
66
|
+
/** Elements of the section. */
|
|
67
|
+
elements?: Element[];
|
|
68
|
+
/**
|
|
69
|
+
* Total capacity
|
|
70
|
+
* @readonly
|
|
71
|
+
*/
|
|
72
|
+
totalCapacity?: number | null;
|
|
73
|
+
/**
|
|
74
|
+
* Is default section
|
|
75
|
+
* @readonly
|
|
76
|
+
*/
|
|
77
|
+
default?: boolean;
|
|
78
|
+
}
|
|
79
|
+
export interface Element {
|
|
80
|
+
/** Unique element id */
|
|
81
|
+
_id?: number;
|
|
82
|
+
/** User friendly title/label of the element. */
|
|
83
|
+
title?: string | null;
|
|
84
|
+
/** Element type */
|
|
85
|
+
type?: Type;
|
|
86
|
+
/** Capacity. None for Shape type Element. */
|
|
87
|
+
capacity?: number | null;
|
|
88
|
+
/** Assigned to a category */
|
|
89
|
+
categoryId?: number | null;
|
|
90
|
+
/** A place numbering meta data */
|
|
91
|
+
sequencing?: Sequencing;
|
|
92
|
+
/** Place override (by seq_id) */
|
|
93
|
+
overrides?: Place[];
|
|
94
|
+
/**
|
|
95
|
+
* Final place sequence with overrides
|
|
96
|
+
* @readonly
|
|
97
|
+
*/
|
|
98
|
+
places?: Place[];
|
|
99
|
+
/** Element reservation options */
|
|
100
|
+
reservationOptions?: ReservationOptions;
|
|
101
|
+
/** Element UI settings */
|
|
102
|
+
uiProperties?: ElementUiProperties;
|
|
103
|
+
/** Element group id */
|
|
104
|
+
elementGroupId?: number | null;
|
|
105
|
+
/** Multi row element relevant for MULTI_ROW element type */
|
|
106
|
+
multiRowProperties?: MultiRowProperties;
|
|
107
|
+
}
|
|
108
|
+
export declare enum Type {
|
|
109
|
+
AREA = "AREA",
|
|
110
|
+
ROW = "ROW",
|
|
111
|
+
MULTI_ROW = "MULTI_ROW",
|
|
112
|
+
TABLE = "TABLE",
|
|
113
|
+
ROUND_TABLE = "ROUND_TABLE",
|
|
114
|
+
SHAPE = "SHAPE"
|
|
115
|
+
}
|
|
116
|
+
export interface Sequencing {
|
|
117
|
+
/** First seq element */
|
|
118
|
+
startAt?: string;
|
|
119
|
+
/** Finite generated seq of labels */
|
|
120
|
+
labels?: string[];
|
|
121
|
+
/** If true - direction right to left. Otherwise left to right. */
|
|
122
|
+
reverseOrder?: boolean | null;
|
|
123
|
+
}
|
|
124
|
+
export interface Place {
|
|
125
|
+
/** Local id of the place in the sequence */
|
|
126
|
+
index?: number;
|
|
127
|
+
/**
|
|
128
|
+
* Generated composite unique id in the seating plan.
|
|
129
|
+
* @readonly
|
|
130
|
+
*/
|
|
131
|
+
_id?: string | null;
|
|
132
|
+
/** Unique label of the place */
|
|
133
|
+
label?: string;
|
|
134
|
+
/**
|
|
135
|
+
* Max capacity per place
|
|
136
|
+
* @readonly
|
|
137
|
+
*/
|
|
138
|
+
capacity?: number | null;
|
|
139
|
+
/**
|
|
140
|
+
* Type of the parent element
|
|
141
|
+
* @readonly
|
|
142
|
+
*/
|
|
143
|
+
elementType?: Type;
|
|
144
|
+
/**
|
|
145
|
+
* Assigned category id
|
|
146
|
+
* @readonly
|
|
147
|
+
*/
|
|
148
|
+
categoryId?: number | null;
|
|
149
|
+
/** Place type */
|
|
150
|
+
type?: PlaceTypeEnumType;
|
|
151
|
+
}
|
|
152
|
+
export declare enum PlaceTypeEnumType {
|
|
153
|
+
UNKNOWN_PROPERTY = "UNKNOWN_PROPERTY",
|
|
154
|
+
STANDARD = "STANDARD",
|
|
155
|
+
WHEELCHAIR = "WHEELCHAIR",
|
|
156
|
+
ACCESSIBLE = "ACCESSIBLE",
|
|
157
|
+
COMPANION = "COMPANION",
|
|
158
|
+
OBSTRUCTED = "OBSTRUCTED",
|
|
159
|
+
DISCOUNT = "DISCOUNT"
|
|
160
|
+
}
|
|
161
|
+
export interface ReservationOptions {
|
|
162
|
+
/** Indicates whether the entire element must be reserved */
|
|
163
|
+
reserveWholeElement?: boolean;
|
|
164
|
+
}
|
|
165
|
+
export interface ElementUiProperties {
|
|
166
|
+
x?: number | null;
|
|
167
|
+
y?: number | null;
|
|
168
|
+
zIndex?: number | null;
|
|
169
|
+
width?: number | null;
|
|
170
|
+
height?: number | null;
|
|
171
|
+
rotationAngle?: number | null;
|
|
172
|
+
shapeType?: ShapeTypeEnumType;
|
|
173
|
+
fontSize?: number | null;
|
|
174
|
+
cornerRadius?: number | null;
|
|
175
|
+
seatSpacing?: number | null;
|
|
176
|
+
hideLabel?: boolean | null;
|
|
177
|
+
labelPosition?: Position;
|
|
178
|
+
seatLayout?: number[];
|
|
179
|
+
emptyTopSeatSpaces?: number | null;
|
|
180
|
+
/** needs research */
|
|
181
|
+
text?: string | null;
|
|
182
|
+
/** #F0F0F0 */
|
|
183
|
+
color?: string | null;
|
|
184
|
+
/** #F0F0F0 */
|
|
185
|
+
fillColor?: string | null;
|
|
186
|
+
/** #F0F0F0 */
|
|
187
|
+
strokeColor?: string | null;
|
|
188
|
+
/** px */
|
|
189
|
+
strokeWidth?: number | null;
|
|
190
|
+
opacity?: number | null;
|
|
191
|
+
icon?: Icon;
|
|
192
|
+
image?: Image;
|
|
193
|
+
seatNumbering?: Numbering;
|
|
194
|
+
}
|
|
195
|
+
export declare enum ShapeTypeEnumType {
|
|
196
|
+
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
197
|
+
TEXT = "TEXT",
|
|
198
|
+
RECTANGLE = "RECTANGLE",
|
|
199
|
+
ELLIPSE = "ELLIPSE",
|
|
200
|
+
LINE = "LINE",
|
|
201
|
+
ICON = "ICON",
|
|
202
|
+
IMAGE = "IMAGE"
|
|
203
|
+
}
|
|
204
|
+
export declare enum Position {
|
|
205
|
+
UNKNOWN_POSITION = "UNKNOWN_POSITION",
|
|
206
|
+
LEFT = "LEFT",
|
|
207
|
+
RIGHT = "RIGHT",
|
|
208
|
+
BOTH = "BOTH",
|
|
209
|
+
NONE = "NONE"
|
|
210
|
+
}
|
|
211
|
+
export declare enum Icon {
|
|
212
|
+
UNKNOWN_ICON = "UNKNOWN_ICON",
|
|
213
|
+
ENTER = "ENTER",
|
|
214
|
+
EXIT = "EXIT",
|
|
215
|
+
DRINKS = "DRINKS",
|
|
216
|
+
WC = "WC",
|
|
217
|
+
WC_MEN = "WC_MEN",
|
|
218
|
+
WC_WOMEN = "WC_WOMEN",
|
|
219
|
+
FOOD = "FOOD",
|
|
220
|
+
STAIRS = "STAIRS",
|
|
221
|
+
ELEVATOR = "ELEVATOR",
|
|
222
|
+
SMOKING = "SMOKING",
|
|
223
|
+
CHECKROOM = "CHECKROOM",
|
|
224
|
+
STAGE = "STAGE"
|
|
225
|
+
}
|
|
226
|
+
export interface Image {
|
|
227
|
+
/** WixMedia image ID. */
|
|
228
|
+
_id?: string;
|
|
229
|
+
/**
|
|
230
|
+
* Original image height.
|
|
231
|
+
* @readonly
|
|
232
|
+
*/
|
|
233
|
+
height?: number;
|
|
234
|
+
/**
|
|
235
|
+
* Original image width.
|
|
236
|
+
* @readonly
|
|
237
|
+
*/
|
|
238
|
+
width?: number;
|
|
239
|
+
/**
|
|
240
|
+
* WixMedia image URI.
|
|
241
|
+
* @deprecated
|
|
242
|
+
*/
|
|
243
|
+
uri?: string | null;
|
|
244
|
+
}
|
|
245
|
+
export declare enum Numbering {
|
|
246
|
+
UNKNOWN_NUMBERING = "UNKNOWN_NUMBERING",
|
|
247
|
+
NUMERIC = "NUMERIC",
|
|
248
|
+
ODD_EVEN = "ODD_EVEN",
|
|
249
|
+
ALPHABETICAL = "ALPHABETICAL"
|
|
250
|
+
}
|
|
251
|
+
export interface MultiRowProperties {
|
|
252
|
+
/** Individual rows of the multi row element */
|
|
253
|
+
rows?: RowElement[];
|
|
254
|
+
/** Meta data for vertical labeling */
|
|
255
|
+
verticalSequencing?: VerticalSequencing;
|
|
256
|
+
/** Row spacing */
|
|
257
|
+
rowSpacing?: number | null;
|
|
258
|
+
/** Amount of seats in the row */
|
|
259
|
+
seatAmount?: number | null;
|
|
260
|
+
}
|
|
261
|
+
export interface RowElement {
|
|
262
|
+
/** Unique row id */
|
|
263
|
+
_id?: number;
|
|
264
|
+
/** User friendly title/label of the row */
|
|
265
|
+
title?: string | null;
|
|
266
|
+
/** Row capacity */
|
|
267
|
+
capacity?: number | null;
|
|
268
|
+
/** Assigned to a category */
|
|
269
|
+
categoryId?: number | null;
|
|
270
|
+
/** A place numbering meta data for a single row */
|
|
271
|
+
sequencing?: Sequencing;
|
|
272
|
+
/** Row UI settings */
|
|
273
|
+
uiProperties?: RowElementUiProperties;
|
|
274
|
+
}
|
|
275
|
+
export interface RowElementUiProperties {
|
|
276
|
+
/** Relative x position to the parent element */
|
|
277
|
+
relativeX?: number | null;
|
|
278
|
+
/** Width of the row */
|
|
279
|
+
width?: number | null;
|
|
280
|
+
/** Amount of seats in the row */
|
|
281
|
+
seatAmount?: number | null;
|
|
282
|
+
/** Seat spacing */
|
|
283
|
+
seatSpacing?: number | null;
|
|
284
|
+
/** Label position */
|
|
285
|
+
labelPosition?: Position;
|
|
286
|
+
/** Seat numbering */
|
|
287
|
+
seatNumbering?: Numbering;
|
|
288
|
+
}
|
|
289
|
+
export interface VerticalSequencing {
|
|
290
|
+
/** First seq element */
|
|
291
|
+
startAt?: string;
|
|
292
|
+
/** Row numbering */
|
|
293
|
+
rowNumbering?: Numbering;
|
|
294
|
+
/** If true - direction bottom to top. Otherwise top to bottom. */
|
|
295
|
+
reverseOrder?: boolean | null;
|
|
296
|
+
}
|
|
297
|
+
export interface Category {
|
|
298
|
+
/** Local category id within the seating plan */
|
|
299
|
+
_id?: number;
|
|
300
|
+
/**
|
|
301
|
+
* A client defined external id for cross referencing.
|
|
302
|
+
* Can reference external entities.
|
|
303
|
+
* Format: "{entity_fqdn}:{entity_id}"
|
|
304
|
+
*/
|
|
305
|
+
externalId?: string | null;
|
|
306
|
+
/** Category label */
|
|
307
|
+
title?: string;
|
|
308
|
+
/**
|
|
309
|
+
* Client configuration object
|
|
310
|
+
* @readonly
|
|
311
|
+
*/
|
|
312
|
+
config?: Record<string, any> | null;
|
|
313
|
+
/**
|
|
314
|
+
* Total capacity
|
|
315
|
+
* @readonly
|
|
316
|
+
*/
|
|
317
|
+
totalCapacity?: number | null;
|
|
318
|
+
/**
|
|
319
|
+
* Possible places
|
|
320
|
+
* @readonly
|
|
321
|
+
*/
|
|
322
|
+
places?: Place[];
|
|
323
|
+
}
|
|
324
|
+
export interface ExtendedFields {
|
|
325
|
+
/**
|
|
326
|
+
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
327
|
+
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
328
|
+
*
|
|
329
|
+
* You can only access fields for which you have the appropriate permissions.
|
|
330
|
+
*
|
|
331
|
+
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
332
|
+
*/
|
|
333
|
+
namespaces?: Record<string, Record<string, any>>;
|
|
334
|
+
}
|
|
335
|
+
export interface SeatingPlanUiProperties {
|
|
336
|
+
/** #F0F0F0 */
|
|
337
|
+
backgroundColor?: string | null;
|
|
338
|
+
backgroundOpacity?: number | null;
|
|
339
|
+
}
|
|
340
|
+
export interface ElementGroup {
|
|
341
|
+
/** Unique element group id */
|
|
342
|
+
_id?: number;
|
|
343
|
+
/** Parent group id */
|
|
344
|
+
parentElementGroupId?: number | null;
|
|
345
|
+
/** Element group UI settings */
|
|
346
|
+
uiProperties?: ElementGroupUiProperties;
|
|
347
|
+
}
|
|
348
|
+
export interface ElementGroupUiProperties {
|
|
349
|
+
/** x position of the group */
|
|
350
|
+
x?: number | null;
|
|
351
|
+
/** y position of the group */
|
|
352
|
+
y?: number | null;
|
|
353
|
+
/** width of the group */
|
|
354
|
+
width?: number | null;
|
|
355
|
+
/** height of the group */
|
|
356
|
+
height?: number | null;
|
|
357
|
+
/** rotation angle of the group */
|
|
358
|
+
rotationAngle?: number | null;
|
|
359
|
+
}
|
|
360
|
+
export interface CreateSeatingPlanRequest {
|
|
361
|
+
/** A plan to be created */
|
|
362
|
+
plan: SeatingPlan;
|
|
363
|
+
}
|
|
364
|
+
export interface CreateSeatingPlanResponse {
|
|
365
|
+
/** The created plan */
|
|
366
|
+
plan?: SeatingPlan;
|
|
367
|
+
}
|
|
368
|
+
export interface CapacityExceededViolation {
|
|
369
|
+
/** Max allowed capacity */
|
|
370
|
+
maxCapacity?: number;
|
|
371
|
+
/** Invalid capacity */
|
|
372
|
+
capacity?: number;
|
|
373
|
+
/** The element id */
|
|
374
|
+
elementId?: number | null;
|
|
375
|
+
}
|
|
376
|
+
export interface UpdateSeatingPlanRequest {
|
|
377
|
+
/** The plan updates */
|
|
378
|
+
plan?: SeatingPlan;
|
|
379
|
+
/** A set of field paths, specifying which parts of seating plan to update */
|
|
380
|
+
fields?: string[];
|
|
381
|
+
}
|
|
382
|
+
export interface UpdateSeatingPlanResponse {
|
|
383
|
+
/** The updated plan */
|
|
384
|
+
plan?: SeatingPlan;
|
|
385
|
+
}
|
|
386
|
+
export interface CopySeatingPlanRequest {
|
|
387
|
+
/** The id of the plan to be copied */
|
|
388
|
+
_id: string | null;
|
|
389
|
+
/** New plan title */
|
|
390
|
+
title: string | null;
|
|
391
|
+
/** Format: "{fqdn}:{entity guid}" */
|
|
392
|
+
externalId: string | null;
|
|
393
|
+
}
|
|
394
|
+
export interface CopySeatingPlanResponse {
|
|
395
|
+
/** The copied plan */
|
|
396
|
+
plan?: SeatingPlan;
|
|
397
|
+
}
|
|
398
|
+
export interface QuerySeatingPlanRequest {
|
|
399
|
+
/**
|
|
400
|
+
* Generic query object
|
|
401
|
+
* Possible fieldsets: "elements", "categories", "places", "config".
|
|
402
|
+
*/
|
|
403
|
+
query: QueryV2;
|
|
404
|
+
/** A fieldset for the response */
|
|
405
|
+
fieldset?: Fieldset[];
|
|
406
|
+
}
|
|
407
|
+
export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
408
|
+
/** Paging options to limit and skip the number of items. */
|
|
409
|
+
paging?: Paging;
|
|
410
|
+
/** 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`. */
|
|
411
|
+
cursorPaging?: CursorPaging;
|
|
412
|
+
/**
|
|
413
|
+
* Filter object.
|
|
414
|
+
*
|
|
415
|
+
* Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
|
|
416
|
+
*/
|
|
417
|
+
filter?: Record<string, any> | null;
|
|
418
|
+
/**
|
|
419
|
+
* Sort object.
|
|
420
|
+
*
|
|
421
|
+
* Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
|
|
422
|
+
*/
|
|
423
|
+
sort?: Sorting[];
|
|
424
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
425
|
+
fields?: string[];
|
|
426
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
427
|
+
fieldsets?: string[];
|
|
428
|
+
}
|
|
429
|
+
/** @oneof */
|
|
430
|
+
export interface QueryV2PagingMethodOneOf {
|
|
431
|
+
/** Paging options to limit and skip the number of items. */
|
|
432
|
+
paging?: Paging;
|
|
433
|
+
/** 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`. */
|
|
434
|
+
cursorPaging?: CursorPaging;
|
|
435
|
+
}
|
|
436
|
+
export interface Sorting {
|
|
437
|
+
/** Name of the field to sort by. */
|
|
438
|
+
fieldName?: string;
|
|
439
|
+
/** Sort order. */
|
|
440
|
+
order?: SortOrder;
|
|
441
|
+
}
|
|
442
|
+
export declare enum SortOrder {
|
|
443
|
+
ASC = "ASC",
|
|
444
|
+
DESC = "DESC"
|
|
445
|
+
}
|
|
446
|
+
export interface Paging {
|
|
447
|
+
/** Number of items to load. */
|
|
448
|
+
limit?: number | null;
|
|
449
|
+
/** Number of items to skip in the current sort order. */
|
|
450
|
+
offset?: number | null;
|
|
451
|
+
}
|
|
452
|
+
export interface CursorPaging {
|
|
453
|
+
/** Maximum number of items to return in the results. */
|
|
454
|
+
limit?: number | null;
|
|
455
|
+
/**
|
|
456
|
+
* Pointer to the next or previous page in the list of results.
|
|
457
|
+
*
|
|
458
|
+
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
459
|
+
* Not relevant for the first request.
|
|
460
|
+
*/
|
|
461
|
+
cursor?: string | null;
|
|
462
|
+
}
|
|
463
|
+
export declare enum Fieldset {
|
|
464
|
+
ELEMENTS = "ELEMENTS",
|
|
465
|
+
CATEGORIES = "CATEGORIES",
|
|
466
|
+
PLACES = "PLACES",
|
|
467
|
+
CONFIG = "CONFIG",
|
|
468
|
+
ELEMENT_GROUPS = "ELEMENT_GROUPS"
|
|
469
|
+
}
|
|
470
|
+
export interface QuerySeatingPlanResponse {
|
|
471
|
+
/** Plan results */
|
|
472
|
+
plans?: SeatingPlan[];
|
|
473
|
+
}
|
|
474
|
+
export interface GetSeatingPlanRequest {
|
|
475
|
+
/** The id of the plan */
|
|
476
|
+
_id: string | null;
|
|
477
|
+
/**
|
|
478
|
+
* A fieldset for the response
|
|
479
|
+
* @deprecated
|
|
480
|
+
*/
|
|
481
|
+
fieldset?: Fieldset[];
|
|
482
|
+
/**
|
|
483
|
+
* Projection on the result object - list of named projections.
|
|
484
|
+
* Possible values: "elements", "categories", "places", "config".
|
|
485
|
+
*/
|
|
486
|
+
fieldsets?: string[];
|
|
487
|
+
/** Seating Plan Mask */
|
|
488
|
+
seatingPlanMask?: SeatingPlanMask;
|
|
489
|
+
}
|
|
490
|
+
export interface SeatingPlanMask {
|
|
491
|
+
/** Filter seating plan by place ids */
|
|
492
|
+
placeId?: string[];
|
|
493
|
+
}
|
|
494
|
+
export interface GetSeatingPlanResponse {
|
|
495
|
+
/** The plan */
|
|
496
|
+
plan?: SeatingPlan;
|
|
497
|
+
}
|
|
498
|
+
export interface FindSeatingPlanRequest {
|
|
499
|
+
/** The filter of the plan */
|
|
500
|
+
filter: Record<string, any> | null;
|
|
501
|
+
/**
|
|
502
|
+
* A fieldset for the response
|
|
503
|
+
* @deprecated
|
|
504
|
+
*/
|
|
505
|
+
fieldset?: Fieldset[];
|
|
506
|
+
/**
|
|
507
|
+
* Projection on the result object - list of named projections.
|
|
508
|
+
* Possible values: "elements", "categories", "places", "config".
|
|
509
|
+
*/
|
|
510
|
+
fieldsets?: string[];
|
|
511
|
+
/** Seating Plan Mask */
|
|
512
|
+
seatingPlanMask?: SeatingPlanMask;
|
|
513
|
+
}
|
|
514
|
+
export interface FindSeatingPlanResponse {
|
|
515
|
+
/** The plan */
|
|
516
|
+
plan?: SeatingPlan;
|
|
517
|
+
}
|
|
518
|
+
export interface DeleteSeatingPlanRequest {
|
|
519
|
+
/** The id of the plan */
|
|
520
|
+
_id: string | null;
|
|
521
|
+
}
|
|
522
|
+
export interface DeleteSeatingPlanResponse {
|
|
523
|
+
/** Deleted plan */
|
|
524
|
+
plan?: SeatingPlan;
|
|
525
|
+
}
|
|
526
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
527
|
+
createdEvent?: EntityCreatedEvent;
|
|
528
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
529
|
+
deletedEvent?: EntityDeletedEvent;
|
|
530
|
+
actionEvent?: ActionEvent;
|
|
531
|
+
/**
|
|
532
|
+
* Unique event ID.
|
|
533
|
+
* Allows clients to ignore duplicate webhooks.
|
|
534
|
+
*/
|
|
535
|
+
_id?: string;
|
|
536
|
+
/**
|
|
537
|
+
* Assumes actions are also always typed to an entity_type
|
|
538
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
539
|
+
*/
|
|
540
|
+
entityFqdn?: string;
|
|
541
|
+
/**
|
|
542
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
543
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
544
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
545
|
+
*/
|
|
546
|
+
slug?: string;
|
|
547
|
+
/** ID of the entity associated with the event. */
|
|
548
|
+
entityId?: string;
|
|
549
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
550
|
+
eventTime?: Date | null;
|
|
551
|
+
/**
|
|
552
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
553
|
+
* (for example, GDPR).
|
|
554
|
+
*/
|
|
555
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
556
|
+
/** If present, indicates the action that triggered the event. */
|
|
557
|
+
originatedFrom?: string | null;
|
|
558
|
+
/**
|
|
559
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
560
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
561
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
562
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
563
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
564
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
565
|
+
*/
|
|
566
|
+
entityEventSequence?: string | null;
|
|
567
|
+
}
|
|
568
|
+
/** @oneof */
|
|
569
|
+
export interface DomainEventBodyOneOf {
|
|
570
|
+
createdEvent?: EntityCreatedEvent;
|
|
571
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
572
|
+
deletedEvent?: EntityDeletedEvent;
|
|
573
|
+
actionEvent?: ActionEvent;
|
|
574
|
+
}
|
|
575
|
+
export interface EntityCreatedEvent {
|
|
576
|
+
entity?: string;
|
|
577
|
+
}
|
|
578
|
+
export interface RestoreInfo {
|
|
579
|
+
deletedDate?: Date | null;
|
|
580
|
+
}
|
|
581
|
+
export interface EntityUpdatedEvent {
|
|
582
|
+
/**
|
|
583
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
584
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
585
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
586
|
+
*/
|
|
587
|
+
currentEntity?: string;
|
|
588
|
+
}
|
|
589
|
+
export interface EntityDeletedEvent {
|
|
590
|
+
/** Entity that was deleted */
|
|
591
|
+
deletedEntity?: string | null;
|
|
592
|
+
}
|
|
593
|
+
export interface ActionEvent {
|
|
594
|
+
body?: string;
|
|
595
|
+
}
|
|
596
|
+
export interface MessageEnvelope {
|
|
597
|
+
/** App instance ID. */
|
|
598
|
+
instanceId?: string | null;
|
|
599
|
+
/** Event type. */
|
|
600
|
+
eventType?: string;
|
|
601
|
+
/** The identification type and identity data. */
|
|
602
|
+
identity?: IdentificationData;
|
|
603
|
+
/** Stringify payload. */
|
|
604
|
+
data?: string;
|
|
605
|
+
}
|
|
606
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
607
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
608
|
+
anonymousVisitorId?: string;
|
|
609
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
610
|
+
memberId?: string;
|
|
611
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
612
|
+
wixUserId?: string;
|
|
613
|
+
/** ID of an app. */
|
|
614
|
+
appId?: string;
|
|
615
|
+
/** @readonly */
|
|
616
|
+
identityType?: WebhookIdentityType;
|
|
617
|
+
}
|
|
618
|
+
/** @oneof */
|
|
619
|
+
export interface IdentificationDataIdOneOf {
|
|
620
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
621
|
+
anonymousVisitorId?: string;
|
|
622
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
623
|
+
memberId?: string;
|
|
624
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
625
|
+
wixUserId?: string;
|
|
626
|
+
/** ID of an app. */
|
|
627
|
+
appId?: string;
|
|
628
|
+
}
|
|
629
|
+
export declare enum WebhookIdentityType {
|
|
630
|
+
UNKNOWN = "UNKNOWN",
|
|
631
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
632
|
+
MEMBER = "MEMBER",
|
|
633
|
+
WIX_USER = "WIX_USER",
|
|
634
|
+
APP = "APP"
|
|
635
|
+
}
|
|
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
|
+
export interface SaveSeatingPlanVersionRequest {
|
|
655
|
+
/** A plan version to be saved */
|
|
656
|
+
plan?: SeatingPlan;
|
|
657
|
+
/**
|
|
658
|
+
* Parent version of the plan.
|
|
659
|
+
* Use this field to override history of plan versions.
|
|
660
|
+
* The next version of the plan will still be latest version +1,
|
|
661
|
+
* but intermediate versions will be removed. Example:
|
|
662
|
+
* Existing versions [1, 2, 3, 4, 5].
|
|
663
|
+
* Save request with parent_version 2 will yield versions [1, 2, 6].
|
|
664
|
+
*/
|
|
665
|
+
parentVersion?: string | null;
|
|
666
|
+
}
|
|
667
|
+
export interface SaveSeatingPlanVersionResponse {
|
|
668
|
+
/** Updated plan version */
|
|
669
|
+
plan?: SeatingPlan;
|
|
670
|
+
}
|
|
671
|
+
export interface QuerySeatingPlanVersionsRequest {
|
|
672
|
+
/**
|
|
673
|
+
* Generic query object
|
|
674
|
+
* Possible fieldsets: "elements", "categories", "places", "config".
|
|
675
|
+
*/
|
|
676
|
+
query?: QueryV2;
|
|
677
|
+
}
|
|
678
|
+
export interface QuerySeatingPlanVersionsResponse {
|
|
679
|
+
/** Plan results */
|
|
680
|
+
plans?: SeatingPlan[];
|
|
681
|
+
/** Paging meta data */
|
|
682
|
+
metadata?: PagingMetadataV2;
|
|
683
|
+
}
|
|
684
|
+
export interface PagingMetadataV2 {
|
|
685
|
+
/** Number of items returned in the response. */
|
|
686
|
+
count?: number | null;
|
|
687
|
+
/** Offset that was requested. */
|
|
688
|
+
offset?: number | null;
|
|
689
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
690
|
+
total?: number | null;
|
|
691
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
692
|
+
tooManyToCount?: boolean | null;
|
|
693
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
694
|
+
cursors?: Cursors;
|
|
695
|
+
}
|
|
696
|
+
export interface Cursors {
|
|
697
|
+
/** Cursor string pointing to the next page in the list of results. */
|
|
698
|
+
next?: string | null;
|
|
699
|
+
/** Cursor pointing to the previous page in the list of results. */
|
|
700
|
+
prev?: string | null;
|
|
701
|
+
}
|
|
702
|
+
export interface DiscardSeatingPlanVersionsRequest {
|
|
703
|
+
/** Seating Plan ID */
|
|
704
|
+
seatingPlanId?: string | null;
|
|
705
|
+
/** Version from which all higher versions will be discarded. */
|
|
706
|
+
version?: string | null;
|
|
707
|
+
}
|
|
708
|
+
export interface DiscardSeatingPlanVersionsResponse {
|
|
709
|
+
}
|
|
710
|
+
export interface RestoreSeatingPlanRequest {
|
|
711
|
+
/** Seating Plan ID */
|
|
712
|
+
seatingPlanId?: string | null;
|
|
713
|
+
/** Version to witch the seating plan should be restored. */
|
|
714
|
+
version?: string | null;
|
|
715
|
+
}
|
|
716
|
+
export interface RestoreSeatingPlanResponse {
|
|
717
|
+
/** Seating Plan */
|
|
718
|
+
plan?: SeatingPlan;
|
|
719
|
+
}
|
|
720
|
+
interface SequencingNonNullableFields {
|
|
721
|
+
startAt: string;
|
|
722
|
+
labels: string[];
|
|
723
|
+
}
|
|
724
|
+
interface PlaceNonNullableFields {
|
|
725
|
+
index: number;
|
|
726
|
+
label: string;
|
|
727
|
+
elementType: Type;
|
|
728
|
+
type: PlaceTypeEnumType;
|
|
729
|
+
}
|
|
730
|
+
interface ReservationOptionsNonNullableFields {
|
|
731
|
+
reserveWholeElement: boolean;
|
|
732
|
+
}
|
|
733
|
+
interface ImageNonNullableFields {
|
|
734
|
+
_id: string;
|
|
735
|
+
height: number;
|
|
736
|
+
width: number;
|
|
737
|
+
}
|
|
738
|
+
interface ElementUiPropertiesNonNullableFields {
|
|
739
|
+
shapeType: ShapeTypeEnumType;
|
|
740
|
+
labelPosition: Position;
|
|
741
|
+
seatLayout: number[];
|
|
742
|
+
icon: Icon;
|
|
743
|
+
image?: ImageNonNullableFields;
|
|
744
|
+
seatNumbering: Numbering;
|
|
745
|
+
}
|
|
746
|
+
interface RowElementUiPropertiesNonNullableFields {
|
|
747
|
+
labelPosition: Position;
|
|
748
|
+
seatNumbering: Numbering;
|
|
749
|
+
}
|
|
750
|
+
interface RowElementNonNullableFields {
|
|
751
|
+
_id: number;
|
|
752
|
+
sequencing?: SequencingNonNullableFields;
|
|
753
|
+
uiProperties?: RowElementUiPropertiesNonNullableFields;
|
|
754
|
+
}
|
|
755
|
+
interface VerticalSequencingNonNullableFields {
|
|
756
|
+
startAt: string;
|
|
757
|
+
rowNumbering: Numbering;
|
|
758
|
+
}
|
|
759
|
+
interface MultiRowPropertiesNonNullableFields {
|
|
760
|
+
rows: RowElementNonNullableFields[];
|
|
761
|
+
verticalSequencing?: VerticalSequencingNonNullableFields;
|
|
762
|
+
}
|
|
763
|
+
interface ElementNonNullableFields {
|
|
764
|
+
_id: number;
|
|
765
|
+
type: Type;
|
|
766
|
+
sequencing?: SequencingNonNullableFields;
|
|
767
|
+
overrides: PlaceNonNullableFields[];
|
|
768
|
+
places: PlaceNonNullableFields[];
|
|
769
|
+
reservationOptions?: ReservationOptionsNonNullableFields;
|
|
770
|
+
uiProperties?: ElementUiPropertiesNonNullableFields;
|
|
771
|
+
multiRowProperties?: MultiRowPropertiesNonNullableFields;
|
|
772
|
+
}
|
|
773
|
+
interface SectionNonNullableFields {
|
|
774
|
+
_id: number;
|
|
775
|
+
elements: ElementNonNullableFields[];
|
|
776
|
+
default: boolean;
|
|
777
|
+
}
|
|
778
|
+
interface CategoryNonNullableFields {
|
|
779
|
+
_id: number;
|
|
780
|
+
title: string;
|
|
781
|
+
places: PlaceNonNullableFields[];
|
|
782
|
+
}
|
|
783
|
+
interface ElementGroupNonNullableFields {
|
|
784
|
+
_id: number;
|
|
785
|
+
}
|
|
786
|
+
export interface SeatingPlanNonNullableFields {
|
|
787
|
+
sections: SectionNonNullableFields[];
|
|
788
|
+
categories: CategoryNonNullableFields[];
|
|
789
|
+
uncategorizedPlaces: PlaceNonNullableFields[];
|
|
790
|
+
elementGroups: ElementGroupNonNullableFields[];
|
|
791
|
+
}
|
|
792
|
+
export interface CreateSeatingPlanResponseNonNullableFields {
|
|
793
|
+
plan?: SeatingPlanNonNullableFields;
|
|
794
|
+
}
|
|
795
|
+
export interface UpdateSeatingPlanResponseNonNullableFields {
|
|
796
|
+
plan?: SeatingPlanNonNullableFields;
|
|
797
|
+
}
|
|
798
|
+
export interface CopySeatingPlanResponseNonNullableFields {
|
|
799
|
+
plan?: SeatingPlanNonNullableFields;
|
|
800
|
+
}
|
|
801
|
+
export interface QuerySeatingPlanResponseNonNullableFields {
|
|
802
|
+
plans: SeatingPlanNonNullableFields[];
|
|
803
|
+
}
|
|
804
|
+
export interface GetSeatingPlanResponseNonNullableFields {
|
|
805
|
+
plan?: SeatingPlanNonNullableFields;
|
|
806
|
+
}
|
|
807
|
+
export interface FindSeatingPlanResponseNonNullableFields {
|
|
808
|
+
plan?: SeatingPlanNonNullableFields;
|
|
809
|
+
}
|
|
810
|
+
export interface DeleteSeatingPlanResponseNonNullableFields {
|
|
811
|
+
plan?: SeatingPlanNonNullableFields;
|
|
812
|
+
}
|
|
813
|
+
export interface BaseEventMetadata {
|
|
814
|
+
/** App instance ID. */
|
|
815
|
+
instanceId?: string | null;
|
|
816
|
+
/** Event type. */
|
|
817
|
+
eventType?: string;
|
|
818
|
+
/** The identification type and identity data. */
|
|
819
|
+
identity?: IdentificationData;
|
|
820
|
+
}
|
|
821
|
+
export interface EventMetadata extends BaseEventMetadata {
|
|
822
|
+
/**
|
|
823
|
+
* Unique event ID.
|
|
824
|
+
* Allows clients to ignore duplicate webhooks.
|
|
825
|
+
*/
|
|
826
|
+
_id?: string;
|
|
827
|
+
/**
|
|
828
|
+
* Assumes actions are also always typed to an entity_type
|
|
829
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
830
|
+
*/
|
|
831
|
+
entityFqdn?: string;
|
|
832
|
+
/**
|
|
833
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
834
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
835
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
836
|
+
*/
|
|
837
|
+
slug?: string;
|
|
838
|
+
/** ID of the entity associated with the event. */
|
|
839
|
+
entityId?: string;
|
|
840
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
841
|
+
eventTime?: Date | null;
|
|
842
|
+
/**
|
|
843
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
844
|
+
* (for example, GDPR).
|
|
845
|
+
*/
|
|
846
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
847
|
+
/** If present, indicates the action that triggered the event. */
|
|
848
|
+
originatedFrom?: string | null;
|
|
849
|
+
/**
|
|
850
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
851
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
852
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
853
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
854
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
855
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
856
|
+
*/
|
|
857
|
+
entityEventSequence?: string | null;
|
|
858
|
+
}
|
|
859
|
+
export interface SeatingPlanCreatedEnvelope {
|
|
860
|
+
entity: SeatingPlan;
|
|
861
|
+
metadata: EventMetadata;
|
|
862
|
+
}
|
|
863
|
+
/** @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
864
|
+
* @webhook
|
|
865
|
+
* @eventType wix.seating.v1.seating_plan_created
|
|
866
|
+
* @slug created
|
|
867
|
+
* @documentationMaturity preview
|
|
868
|
+
*/
|
|
869
|
+
export declare function onSeatingPlanCreated(handler: (event: SeatingPlanCreatedEnvelope) => void | Promise<void>): void;
|
|
870
|
+
export interface SeatingPlanDeletedEnvelope {
|
|
871
|
+
entity: SeatingPlan;
|
|
872
|
+
metadata: EventMetadata;
|
|
873
|
+
}
|
|
874
|
+
/** @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
875
|
+
* @webhook
|
|
876
|
+
* @eventType wix.seating.v1.seating_plan_deleted
|
|
877
|
+
* @slug deleted
|
|
878
|
+
* @documentationMaturity preview
|
|
879
|
+
*/
|
|
880
|
+
export declare function onSeatingPlanDeleted(handler: (event: SeatingPlanDeletedEnvelope) => void | Promise<void>): void;
|
|
881
|
+
export interface SeatingPlanUpdatedEnvelope {
|
|
882
|
+
entity: SeatingPlan;
|
|
883
|
+
metadata: EventMetadata;
|
|
884
|
+
}
|
|
885
|
+
/** @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
886
|
+
* @webhook
|
|
887
|
+
* @eventType wix.seating.v1.seating_plan_updated
|
|
888
|
+
* @slug updated
|
|
889
|
+
* @documentationMaturity preview
|
|
890
|
+
*/
|
|
891
|
+
export declare function onSeatingPlanUpdated(handler: (event: SeatingPlanUpdatedEnvelope) => void | Promise<void>): void;
|
|
892
|
+
/**
|
|
893
|
+
* Crates a seating plan
|
|
894
|
+
* @param plan - A plan to be created
|
|
895
|
+
* @public
|
|
896
|
+
* @documentationMaturity preview
|
|
897
|
+
* @requiredField plan
|
|
898
|
+
* @requiredField plan.sections.elements.title
|
|
899
|
+
* @requiredField plan.title
|
|
900
|
+
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
901
|
+
* @returns The created plan
|
|
902
|
+
* @fqn com.wixpress.seating.SeatingPlanManagement.CreateSeatingPlan
|
|
903
|
+
*/
|
|
904
|
+
export declare function createSeatingPlan(plan: SeatingPlan): Promise<SeatingPlan & SeatingPlanNonNullableFields>;
|
|
905
|
+
/**
|
|
906
|
+
* Updates the seating plan
|
|
907
|
+
* @public
|
|
908
|
+
* @documentationMaturity preview
|
|
909
|
+
* @requiredField options.plan._id
|
|
910
|
+
* @requiredField options.plan.sections.elements.title
|
|
911
|
+
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
912
|
+
* @returns The updated plan
|
|
913
|
+
* @fqn com.wixpress.seating.SeatingPlanManagement.UpdateSeatingPlan
|
|
914
|
+
*/
|
|
915
|
+
export declare function updateSeatingPlan(options?: UpdateSeatingPlanOptions): Promise<SeatingPlan & SeatingPlanNonNullableFields>;
|
|
916
|
+
export interface UpdateSeatingPlanOptions {
|
|
917
|
+
/** The plan updates */
|
|
918
|
+
plan?: SeatingPlan;
|
|
919
|
+
/** A set of field paths, specifying which parts of seating plan to update */
|
|
920
|
+
fields?: string[];
|
|
921
|
+
}
|
|
922
|
+
/**
|
|
923
|
+
* Copies the seating plan
|
|
924
|
+
* @param _id - The id of the plan to be copied
|
|
925
|
+
* @public
|
|
926
|
+
* @documentationMaturity preview
|
|
927
|
+
* @requiredField _id
|
|
928
|
+
* @requiredField options
|
|
929
|
+
* @requiredField options.externalId
|
|
930
|
+
* @requiredField options.title
|
|
931
|
+
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
932
|
+
* @fqn com.wixpress.seating.SeatingPlanManagement.CopySeatingPlan
|
|
933
|
+
*/
|
|
934
|
+
export declare function copySeatingPlan(_id: string | null, options: CopySeatingPlanOptions): Promise<CopySeatingPlanResponse & CopySeatingPlanResponseNonNullableFields>;
|
|
935
|
+
export interface CopySeatingPlanOptions {
|
|
936
|
+
/** New plan title */
|
|
937
|
+
title: string | null;
|
|
938
|
+
/** Format: "{fqdn}:{entity guid}" */
|
|
939
|
+
externalId: string | null;
|
|
940
|
+
}
|
|
941
|
+
/**
|
|
942
|
+
* Lists seating plans by provided query request
|
|
943
|
+
* @public
|
|
944
|
+
* @documentationMaturity preview
|
|
945
|
+
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
946
|
+
* @applicableIdentity VISITOR
|
|
947
|
+
* @fqn com.wixpress.seating.SeatingPlanManagement.QuerySeatingPlan
|
|
948
|
+
*/
|
|
949
|
+
export declare function querySeatingPlan(options?: QuerySeatingPlanOptions): PlansQueryBuilder;
|
|
950
|
+
export interface QuerySeatingPlanOptions {
|
|
951
|
+
/** A fieldset for the response */
|
|
952
|
+
fieldset?: Fieldset[] | undefined;
|
|
953
|
+
}
|
|
954
|
+
interface QueryCursorResult {
|
|
955
|
+
cursors: Cursors;
|
|
956
|
+
hasNext: () => boolean;
|
|
957
|
+
hasPrev: () => boolean;
|
|
958
|
+
length: number;
|
|
959
|
+
pageSize: number;
|
|
960
|
+
}
|
|
961
|
+
export interface PlansQueryResult extends QueryCursorResult {
|
|
962
|
+
items: SeatingPlan[];
|
|
963
|
+
query: PlansQueryBuilder;
|
|
964
|
+
next: () => Promise<PlansQueryResult>;
|
|
965
|
+
prev: () => Promise<PlansQueryResult>;
|
|
966
|
+
}
|
|
967
|
+
export interface PlansQueryBuilder {
|
|
968
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
969
|
+
* @documentationMaturity preview
|
|
970
|
+
*/
|
|
971
|
+
limit: (limit: number) => PlansQueryBuilder;
|
|
972
|
+
/** @param cursor - A pointer to specific record
|
|
973
|
+
* @documentationMaturity preview
|
|
974
|
+
*/
|
|
975
|
+
skipTo: (cursor: string) => PlansQueryBuilder;
|
|
976
|
+
/** @documentationMaturity preview */
|
|
977
|
+
find: () => Promise<PlansQueryResult>;
|
|
978
|
+
}
|
|
979
|
+
/**
|
|
980
|
+
* Returns the seating plan. Fails of not fond.
|
|
981
|
+
* @param _id - The id of the plan
|
|
982
|
+
* @public
|
|
983
|
+
* @documentationMaturity preview
|
|
984
|
+
* @requiredField _id
|
|
985
|
+
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
986
|
+
* @applicableIdentity VISITOR
|
|
987
|
+
* @returns The plan
|
|
988
|
+
* @fqn com.wixpress.seating.SeatingPlanManagement.GetSeatingPlan
|
|
989
|
+
*/
|
|
990
|
+
export declare function getSeatingPlan(_id: string | null, options?: GetSeatingPlanOptions): Promise<SeatingPlan & SeatingPlanNonNullableFields>;
|
|
991
|
+
export interface GetSeatingPlanOptions {
|
|
992
|
+
/**
|
|
993
|
+
* A fieldset for the response
|
|
994
|
+
* @deprecated
|
|
995
|
+
*/
|
|
996
|
+
fieldset?: Fieldset[];
|
|
997
|
+
/**
|
|
998
|
+
* Projection on the result object - list of named projections.
|
|
999
|
+
* Possible values: "elements", "categories", "places", "config".
|
|
1000
|
+
*/
|
|
1001
|
+
fieldsets?: string[];
|
|
1002
|
+
/** Seating Plan Mask */
|
|
1003
|
+
seatingPlanMask?: SeatingPlanMask;
|
|
1004
|
+
}
|
|
1005
|
+
/**
|
|
1006
|
+
* Returns the first seating plan found by filter request.
|
|
1007
|
+
* @param filter - The filter of the plan
|
|
1008
|
+
* @public
|
|
1009
|
+
* @documentationMaturity preview
|
|
1010
|
+
* @requiredField filter
|
|
1011
|
+
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
1012
|
+
* @applicableIdentity VISITOR
|
|
1013
|
+
* @fqn com.wixpress.seating.SeatingPlanManagement.FindSeatingPlan
|
|
1014
|
+
*/
|
|
1015
|
+
export declare function findSeatingPlan(filter: Record<string, any> | null, options?: FindSeatingPlanOptions): Promise<FindSeatingPlanResponse & FindSeatingPlanResponseNonNullableFields>;
|
|
1016
|
+
export interface FindSeatingPlanOptions {
|
|
1017
|
+
/**
|
|
1018
|
+
* A fieldset for the response
|
|
1019
|
+
* @deprecated
|
|
1020
|
+
*/
|
|
1021
|
+
fieldset?: Fieldset[];
|
|
1022
|
+
/**
|
|
1023
|
+
* Projection on the result object - list of named projections.
|
|
1024
|
+
* Possible values: "elements", "categories", "places", "config".
|
|
1025
|
+
*/
|
|
1026
|
+
fieldsets?: string[];
|
|
1027
|
+
/** Seating Plan Mask */
|
|
1028
|
+
seatingPlanMask?: SeatingPlanMask;
|
|
1029
|
+
}
|
|
1030
|
+
/**
|
|
1031
|
+
* Deletes the seating plan.
|
|
1032
|
+
* @param _id - The id of the plan
|
|
1033
|
+
* @public
|
|
1034
|
+
* @documentationMaturity preview
|
|
1035
|
+
* @requiredField _id
|
|
1036
|
+
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1037
|
+
* @fqn com.wixpress.seating.SeatingPlanManagement.DeleteSeatingPlan
|
|
1038
|
+
*/
|
|
1039
|
+
export declare function deleteSeatingPlan(_id: string | null): Promise<DeleteSeatingPlanResponse & DeleteSeatingPlanResponseNonNullableFields>;
|
|
1040
|
+
/**
|
|
1041
|
+
* Updates seating plan thumbnail.
|
|
1042
|
+
* @public
|
|
1043
|
+
* @documentationMaturity preview
|
|
1044
|
+
* @requiredField thumbnail
|
|
1045
|
+
* @requiredField thumbnail._id
|
|
1046
|
+
* @requiredField thumbnail.img
|
|
1047
|
+
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1048
|
+
* @fqn com.wixpress.seating.SeatingPlanThumbnailService.UpdateSeatingPlanThumbnail
|
|
1049
|
+
*/
|
|
1050
|
+
export declare function updateSeatingPlanThumbnail(thumbnail: SeatingPlanThumbnail): Promise<UpdateSeatingPlanThumbnailResponse>;
|
|
1051
|
+
/**
|
|
1052
|
+
* Get seating plan thumbnail.
|
|
1053
|
+
* @public
|
|
1054
|
+
* @documentationMaturity preview
|
|
1055
|
+
* @requiredField _id
|
|
1056
|
+
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1057
|
+
* @fqn com.wixpress.seating.SeatingPlanThumbnailService.GetSeatingPlanThumbnail
|
|
1058
|
+
*/
|
|
1059
|
+
export declare function getSeatingPlanThumbnail(_id: string | null): Promise<GetSeatingPlanThumbnailResponse>;
|
|
1060
|
+
export {};
|