@wix/auto_sdk_seatings_seating-plan 1.0.20 → 1.0.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/build/cjs/index.d.ts +19 -17
  2. package/build/cjs/index.js +27 -0
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +266 -166
  5. package/build/cjs/index.typings.js +27 -0
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +456 -119
  8. package/build/cjs/meta.js +128 -0
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +19 -17
  11. package/build/es/index.mjs +27 -0
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +266 -166
  14. package/build/es/index.typings.mjs +27 -0
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +456 -119
  17. package/build/es/meta.mjs +119 -0
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +19 -17
  20. package/build/internal/cjs/index.js +27 -0
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +266 -166
  23. package/build/internal/cjs/index.typings.js +27 -0
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +456 -119
  26. package/build/internal/cjs/meta.js +128 -0
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +19 -17
  29. package/build/internal/es/index.mjs +27 -0
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +266 -166
  32. package/build/internal/es/index.typings.mjs +27 -0
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +456 -119
  35. package/build/internal/es/meta.mjs +119 -0
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +3 -3
@@ -1,481 +1,560 @@
1
1
  import { CreateSeatingPlanRequest as CreateSeatingPlanRequest$1, CreateSeatingPlanResponse as CreateSeatingPlanResponse$1, UpdateSeatingPlanRequest as UpdateSeatingPlanRequest$1, UpdateSeatingPlanResponse as UpdateSeatingPlanResponse$1, CopySeatingPlanRequest as CopySeatingPlanRequest$1, CopySeatingPlanResponse as CopySeatingPlanResponse$1, QuerySeatingPlanRequest as QuerySeatingPlanRequest$1, QuerySeatingPlanResponse as QuerySeatingPlanResponse$1, GetSeatingPlanRequest as GetSeatingPlanRequest$1, GetSeatingPlanResponse as GetSeatingPlanResponse$1, FindSeatingPlanRequest as FindSeatingPlanRequest$1, FindSeatingPlanResponse as FindSeatingPlanResponse$1, DeleteSeatingPlanRequest as DeleteSeatingPlanRequest$1, DeleteSeatingPlanResponse as DeleteSeatingPlanResponse$1, UpdateSeatingPlanThumbnailRequest as UpdateSeatingPlanThumbnailRequest$1, UpdateSeatingPlanThumbnailResponse as UpdateSeatingPlanThumbnailResponse$1, GetSeatingPlanThumbnailRequest as GetSeatingPlanThumbnailRequest$1, GetSeatingPlanThumbnailResponse as GetSeatingPlanThumbnailResponse$1 } from './index.typings.mjs';
2
2
  import '@wix/sdk-types';
3
3
 
4
+ /** A seating plan represents the layout and organization of seats within a venue. It defines the physical arrangement of seating areas, pricing categories, and individual places where attendees can be seated or positioned during an event. */
4
5
  interface SeatingPlan {
5
6
  /**
6
- * Auto generated unique plan id
7
+ * Seating plan ID.
7
8
  * @format GUID
8
9
  * @readonly
9
10
  */
10
11
  id?: string | null;
11
12
  /**
12
- * A client defined external id for cross referencing.
13
- * Can reference external entities.
14
- * Format: "{fqdn}:{entity guid}"
13
+ * Client-defined external ID for cross-referencing with external systems. Format: `{fqdn}:{entity_guid}`. For example, `wix.events.v1.event:abc-123-def`.
15
14
  * @minLength 1
16
15
  * @maxLength 100
17
16
  */
18
17
  externalId?: string | null;
19
18
  /**
20
- * Human friendly plan title
19
+ * Human-friendly seating plan title. For example, `Madison Square Garden - Main Floor`.
21
20
  * @minLength 1
22
21
  * @maxLength 120
23
22
  */
24
23
  title?: string | null;
25
24
  /**
26
- * Sections of the plan. Seating plan is divided in high level sections.
25
+ * High-level divisions of the venue, such as "Orchestra", "Balcony", or "VIP Section". A default section with `id = 0` is required and serves as the primary seating area.
27
26
  * @maxSize 100
28
27
  */
29
28
  sections?: Section[];
30
29
  /**
31
- * Categories for plan element grouping.
30
+ * Pricing tiers or groupings for organizing places, such as "VIP", "General Admission", or "Student Discount". Elements and places can be assigned to categories for pricing and availability management.
32
31
  * @maxSize 100
33
32
  */
34
33
  categories?: Category[];
35
34
  /**
36
- * Seating plan created timestamp.
35
+ * Date and time the seating plan was created.
37
36
  * @readonly
38
37
  */
39
38
  createdDate?: Date | null;
40
39
  /**
41
- * Seating plan updated timestamp.
40
+ * Date and time the seating plan was updated.
42
41
  * @readonly
43
42
  */
44
43
  updatedDate?: Date | null;
45
44
  /**
46
- * Total capacity
45
+ * Total number of seats across all sections and elements in the seating plan. Automatically calculated by summing element capacities.
47
46
  * @readonly
48
47
  */
49
48
  totalCapacity?: number | null;
50
49
  /**
51
- * Total categories
50
+ * Total number of categories defined in the seating plan. Automatically calculated.
52
51
  * @readonly
53
52
  */
54
53
  totalCategories?: number | null;
55
54
  /**
56
- * Places not assigned to categories
55
+ * Places that are not assigned to any category. These places require manual category assignment for pricing and organization.
57
56
  * @maxSize 50000
58
57
  * @readonly
59
58
  */
60
59
  uncategorizedPlaces?: Place[];
61
60
  /**
62
- * A version of the seating plan
61
+ * Version number of the seating plan, incremented by 1 each time the plan is updated. Used for version management and tracking changes.
63
62
  * @readonly
64
63
  */
65
64
  version?: string | null;
66
- /** Data extensions */
65
+ /** Additional custom fields for extending the seating plan with app-specific data. Learn more about @extended fields. */
67
66
  extendedFields?: ExtendedFields;
68
- /** Seating Plan UI settings */
67
+ /** Visual settings for the seating plan, such as background color and opacity. Used by seating chart interfaces for rendering. */
69
68
  uiProperties?: SeatingPlanUiProperties;
70
69
  /**
71
- * Element groups
70
+ * Hierarchical groupings of elements for UI organization and bulk operations. Groups can contain multiple elements or nested sub-groups for easier management.
72
71
  * @maxSize 1000
73
72
  */
74
73
  elementGroups?: ElementGroup[];
75
74
  }
75
+ /** A section represents a high-level division within a seating plan, such as "Orchestra", "Balcony", or "VIP Area". Sections contain elements that define the actual seating arrangements. */
76
76
  interface Section {
77
- /** Unique section id */
77
+ /** Section ID. Must be unique within the seating plan. Section with `id = 0` is required as the default section. */
78
78
  id?: number;
79
79
  /**
80
- * Human readable section title
80
+ * Human-readable section title. For example, `Orchestra` or `Balcony`.
81
81
  * @minLength 1
82
82
  * @maxLength 20
83
83
  */
84
84
  title?: string | null;
85
85
  /**
86
- * Client configuration object
86
+ * Client configuration object for storing additional section metadata. Read-only field maintained for backward compatibility.
87
87
  * @readonly
88
88
  */
89
89
  config?: Record<string, any> | null;
90
90
  /**
91
- * Elements of the section.
91
+ * Seating elements within this section, such as rows, tables, or general admission areas. Each element generates individual places based on its type and capacity.
92
92
  * @maxSize 1000
93
93
  */
94
94
  elements?: Element[];
95
95
  /**
96
- * Total capacity
96
+ * Total capacity of all elements within this section. Automatically calculated by summing element capacities.
97
97
  * @readonly
98
98
  */
99
99
  totalCapacity?: number | null;
100
100
  /**
101
- * Is default section
101
+ * Whether this is the default section. Always `true` for section with `id = 0`.
102
102
  * @readonly
103
103
  */
104
104
  default?: boolean;
105
105
  }
106
+ /** An element represents a specific seating configuration within a section, such as a row of seats, a table, or a general admission area. Elements generate individual places based on their type and capacity. */
106
107
  interface Element {
107
108
  /**
108
- * Unique element id
109
+ * Element ID. Must be unique within the seating plan.
109
110
  * @min 1
110
111
  */
111
112
  id?: number;
112
113
  /**
113
- * User friendly title/label of the element.
114
+ * User-friendly title or label for the element. For example, `Row A` or `VIP Table 1`.
114
115
  * @minLength 1
115
116
  * @maxLength 50
116
117
  */
117
118
  title?: string | null;
118
- /** Element type */
119
+ /** Type of seating element, which determines capacity limits and place generation behavior. See ElementTypeEnum for available types. */
119
120
  type?: TypeWithLiterals;
120
121
  /**
121
- * Capacity. None for Shape type Element.
122
+ * Number of seats or spots in this element. Not applicable for SHAPE type elements. Maximum 50,000 per element.
122
123
  * @min 1
123
124
  * @max 50000
124
125
  */
125
126
  capacity?: number | null;
126
- /** Assigned to a category */
127
+ /** ID of the category this element is assigned to for pricing and organization. References a category defined in the seating plan. */
127
128
  categoryId?: number | null;
128
- /** A place numbering meta data */
129
+ /** Configuration for generating place labels and numbering within this element. Defines how seats are labeled (e.g., 1, 2, 3 or A, B, C). */
129
130
  sequencing?: Sequencing;
130
131
  /**
131
- * Place override (by seq_id)
132
+ * Custom place configurations that override the default generated places for specific positions. Used for accessibility seating, obstructed views, or custom labeling.
132
133
  * @maxSize 2000
133
134
  */
134
135
  overrides?: Place[];
135
136
  /**
136
- * Final place sequence with overrides
137
+ * Final sequence of places generated for this element, including any overrides applied. Read-only field populated by the system.
137
138
  * @maxSize 200
138
139
  * @readonly
139
140
  */
140
141
  places?: Place[];
141
- /** Element reservation options */
142
+ /** Constraints on how this element can be reserved or booked. For example, requiring the entire element to be reserved as a unit. */
142
143
  reservationOptions?: ReservationOptions;
143
- /** Element UI settings */
144
+ /** Visual positioning and styling properties for rendering this element in a seating chart. Includes coordinates, dimensions, and styling options. */
144
145
  uiProperties?: ElementUiProperties;
145
- /** Element group id */
146
+ /** ID of the element group this element belongs to for hierarchical organization. References an ElementGroup defined in the seating plan. */
146
147
  elementGroupId?: number | null;
147
- /** Multi row element relevant for MULTI_ROW element type */
148
+ /** Additional properties for MULTI_ROW type elements, defining individual rows and their configurations. Only applicable when type is MULTI_ROW. */
148
149
  multiRowProperties?: MultiRowProperties;
149
150
  }
150
151
  declare enum Type {
152
+ /** General admission area with a single place containing the full capacity. */
151
153
  AREA = "AREA",
154
+ /** Single row of individual seats with sequential labeling. */
152
155
  ROW = "ROW",
156
+ /** Multiple rows treated as one element, each with individual capacity and sequencing. */
153
157
  MULTI_ROW = "MULTI_ROW",
158
+ /** Rectangular table with individual seats around the perimeter. */
154
159
  TABLE = "TABLE",
160
+ /** Circular table with individual seats around the perimeter. */
155
161
  ROUND_TABLE = "ROUND_TABLE",
162
+ /** Visual element with no seating capacity, used for decorative or informational purposes. */
156
163
  SHAPE = "SHAPE"
157
164
  }
158
165
  /** @enumType */
159
166
  type TypeWithLiterals = Type | 'AREA' | 'ROW' | 'MULTI_ROW' | 'TABLE' | 'ROUND_TABLE' | 'SHAPE';
167
+ /** Configuration for generating sequential labels for places within an element. */
160
168
  interface Sequencing {
161
169
  /**
162
- * First seq element
170
+ * Starting value for the sequence. For example, `1` for numeric sequences or `A` for alphabetical sequences.
163
171
  * @minLength 1
164
172
  * @maxLength 4
165
173
  */
166
174
  startAt?: string;
167
175
  /**
168
- * Finite generated seq of labels
176
+ * Complete sequence of labels to be used for places. Must match the element's capacity. When provided, overrides automatic label generation.
169
177
  * @maxSize 2500
170
178
  */
171
179
  labels?: string[];
172
- /** If true - direction right to left. Otherwise left to right. */
180
+ /** Whether to apply labels in reverse order (right-to-left instead of left-to-right). Useful for venue-specific numbering conventions. */
173
181
  reverseOrder?: boolean | null;
174
182
  }
183
+ /** An individual seat or spot within an element where an attendee can be positioned. */
175
184
  interface Place {
176
- /** Local id of the place in the sequence */
185
+ /** Zero-based position of this place within the element's sequence. Used to identify the place's position for overrides. */
177
186
  index?: number;
178
187
  /**
179
- * Generated composite unique id in the seating plan.
188
+ * Unique place ID in the format `{section_id}-{element_id}-{label}`. For example, `0-1-A5` for section 0, element 1, seat A5.
180
189
  * @readonly
181
190
  */
182
191
  id?: string | null;
183
192
  /**
184
- * Unique label of the place
193
+ * Human-readable label for this place, such as `A1`, `12`, or `VIP1`. Generated based on sequencing configuration or custom overrides.
185
194
  * @minLength 1
186
195
  * @maxLength 4
187
196
  */
188
197
  label?: string;
189
198
  /**
190
- * Max capacity per place
199
+ * Maximum number of people that can occupy this place. Typically 1 for individual seats, higher for AREA type places.
191
200
  * @readonly
192
201
  */
193
202
  capacity?: number | null;
194
203
  /**
195
- * Type of the parent element
204
+ * Type of the parent element that contains this place. Inherited from the element's type.
196
205
  * @readonly
197
206
  */
198
207
  elementType?: TypeWithLiterals;
199
208
  /**
200
- * Assigned category id
209
+ * ID of the category this place is assigned to. Inherited from element or row category assignment.
201
210
  * @readonly
202
211
  */
203
212
  categoryId?: number | null;
204
- /** Place type */
213
+ /** Special characteristics or accessibility features of this place (standard, wheelchair, accessible, companion, obstructed, discount). */
205
214
  type?: PlaceTypeEnumTypeWithLiterals;
206
215
  }
207
216
  declare enum PlaceTypeEnumType {
217
+ /** Unknown place type. */
208
218
  UNKNOWN_PROPERTY = "UNKNOWN_PROPERTY",
219
+ /** Standard seating with no special accommodations. */
209
220
  STANDARD = "STANDARD",
221
+ /** Wheelchair accessible seating space. */
210
222
  WHEELCHAIR = "WHEELCHAIR",
223
+ /** Accessible seating for mobility-impaired guests. */
211
224
  ACCESSIBLE = "ACCESSIBLE",
225
+ /** Companion seat adjacent to accessible seating. */
212
226
  COMPANION = "COMPANION",
227
+ /** Seat with limited or obstructed view. */
213
228
  OBSTRUCTED = "OBSTRUCTED",
229
+ /** Discounted pricing seat. */
214
230
  DISCOUNT = "DISCOUNT"
215
231
  }
216
232
  /** @enumType */
217
233
  type PlaceTypeEnumTypeWithLiterals = PlaceTypeEnumType | 'UNKNOWN_PROPERTY' | 'STANDARD' | 'WHEELCHAIR' | 'ACCESSIBLE' | 'COMPANION' | 'OBSTRUCTED' | 'DISCOUNT';
234
+ /** Configuration options that control how an element can be reserved or booked. */
218
235
  interface ReservationOptions {
219
- /** Indicates whether the entire element must be reserved */
236
+ /** Whether the entire element must be reserved as a single unit. When `true`, individual seats cannot be booked separately. Cannot be used with AREA type elements. */
220
237
  reserveWholeElement?: boolean;
221
238
  }
239
+ /** Visual positioning and styling properties for rendering elements in a seating chart interface. */
222
240
  interface ElementUiProperties {
223
241
  /**
242
+ * Horizontal position coordinate of the element in the seating chart coordinate system.
224
243
  * @min -1000000
225
244
  * @max 1000000
226
245
  */
227
246
  x?: number | null;
228
247
  /**
248
+ * Vertical position coordinate of the element in the seating chart coordinate system.
229
249
  * @min -1000000
230
250
  * @max 1000000
231
251
  */
232
252
  y?: number | null;
233
253
  /**
254
+ * Layering order for overlapping elements. Higher values appear on top of lower values.
234
255
  * @min -1000000
235
256
  * @max 1000000
236
257
  */
237
258
  zIndex?: number | null;
238
- /** @max 1000000 */
259
+ /**
260
+ * Width of the element in the coordinate system units.
261
+ * @max 1000000
262
+ */
239
263
  width?: number | null;
240
- /** @max 1000000 */
264
+ /**
265
+ * Height of the element in the coordinate system units.
266
+ * @max 1000000
267
+ */
241
268
  height?: number | null;
242
269
  /**
270
+ * Rotation angle of the element in degrees. Positive values rotate clockwise.
243
271
  * @min -180
244
272
  * @max 180
245
273
  */
246
274
  rotationAngle?: number | null;
275
+ /** Shape type for SHAPE elements that don't represent seating. Only applicable when element type is SHAPE. */
247
276
  shapeType?: ShapeTypeEnumTypeWithLiterals;
248
277
  /**
278
+ * Font size for text elements in points.
249
279
  * @min 10
250
280
  * @max 176
251
281
  */
252
282
  fontSize?: number | null;
253
- /** @max 1000000 */
283
+ /**
284
+ * Corner radius for rounded rectangular shapes in coordinate system units.
285
+ * @max 1000000
286
+ */
254
287
  cornerRadius?: number | null;
255
288
  /**
289
+ * Horizontal spacing between individual seats within the element.
256
290
  * @min 1
257
291
  * @max 60
258
292
  */
259
293
  seatSpacing?: number | null;
294
+ /** Whether to hide labels on seats within this element. When `true`, seat labels are not displayed in the UI. */
260
295
  hideLabel?: boolean | null;
296
+ /** Position of labels relative to seats (left, right, both sides, or none). */
261
297
  labelPosition?: PositionWithLiterals;
298
+ /** Array defining the arrangement of seats within the element. Each number represents the count of seats in that position. */
262
299
  seatLayout?: number[];
263
- /** @max 50 */
300
+ /**
301
+ * Number of empty spaces at the top of the seating arrangement for visual spacing.
302
+ * @max 50
303
+ */
264
304
  emptyTopSeatSpaces?: number | null;
265
305
  /**
266
- * needs research
306
+ * Text content for TEXT type shape elements. Only applicable when shape_type is TEXT.
267
307
  * @minLength 1
268
308
  * @maxLength 10000
269
309
  */
270
310
  text?: string | null;
271
311
  /**
272
- * #F0F0F0
312
+ * Primary color in hexadecimal format. For example, `#FF0000` for red.
273
313
  * @format COLOR_HEX
274
314
  */
275
315
  color?: string | null;
276
316
  /**
277
- * #F0F0F0
317
+ * Fill color for shapes in hexadecimal format. For example, `#00FF00` for green.
278
318
  * @format COLOR_HEX
279
319
  */
280
320
  fillColor?: string | null;
281
321
  /**
282
- * #F0F0F0
322
+ * Border color in hexadecimal format. For example, `#0000FF` for blue.
283
323
  * @format COLOR_HEX
284
324
  */
285
325
  strokeColor?: string | null;
286
326
  /**
287
- * px
327
+ * Border width in pixels for shape outlines.
288
328
  * @min 1
289
329
  * @max 6
290
330
  */
291
331
  strokeWidth?: number | null;
292
- /** @max 100 */
332
+ /**
333
+ * Opacity level as a percentage from 0 (transparent) to 100 (opaque).
334
+ * @max 100
335
+ */
293
336
  opacity?: number | null;
337
+ /** Icon type for ICON shape elements. Only applicable when shape_type is ICON. */
294
338
  icon?: IconWithLiterals;
339
+ /** Image object for IMAGE shape elements. Only applicable when shape_type is IMAGE. */
295
340
  image?: Image;
341
+ /** Numbering scheme for seats within this element (numeric, alphabetical, or odd/even). */
296
342
  seatNumbering?: NumberingWithLiterals;
297
343
  }
298
344
  declare enum ShapeTypeEnumType {
345
+ /** Unknown shape type. */
299
346
  UNKNOWN_TYPE = "UNKNOWN_TYPE",
347
+ /** Text label or annotation. */
300
348
  TEXT = "TEXT",
349
+ /** Rectangular shape. */
301
350
  RECTANGLE = "RECTANGLE",
351
+ /** Circular or oval shape. */
302
352
  ELLIPSE = "ELLIPSE",
353
+ /** Straight line. */
303
354
  LINE = "LINE",
355
+ /** Predefined icon symbol. */
304
356
  ICON = "ICON",
357
+ /** Custom image. */
305
358
  IMAGE = "IMAGE"
306
359
  }
307
360
  /** @enumType */
308
361
  type ShapeTypeEnumTypeWithLiterals = ShapeTypeEnumType | 'UNKNOWN_TYPE' | 'TEXT' | 'RECTANGLE' | 'ELLIPSE' | 'LINE' | 'ICON' | 'IMAGE';
309
362
  declare enum Position {
363
+ /** Label positioning options for seats and elements. */
310
364
  UNKNOWN_POSITION = "UNKNOWN_POSITION",
365
+ /** Labels appear to the left of seats. */
311
366
  LEFT = "LEFT",
367
+ /** Labels appear to the right of seats. */
312
368
  RIGHT = "RIGHT",
369
+ /** Labels appear on both sides of seats. */
313
370
  BOTH = "BOTH",
371
+ /** No labels are displayed. */
314
372
  NONE = "NONE"
315
373
  }
316
374
  /** @enumType */
317
375
  type PositionWithLiterals = Position | 'UNKNOWN_POSITION' | 'LEFT' | 'RIGHT' | 'BOTH' | 'NONE';
318
376
  declare enum Icon {
377
+ /** Available icon types for venue wayfinding and information. */
319
378
  UNKNOWN_ICON = "UNKNOWN_ICON",
379
+ /** Entrance icon. */
320
380
  ENTER = "ENTER",
381
+ /** Exit icon. */
321
382
  EXIT = "EXIT",
383
+ /** Beverage service icon. */
322
384
  DRINKS = "DRINKS",
385
+ /** Restroom icon. */
323
386
  WC = "WC",
387
+ /** Men's restroom icon. */
324
388
  WC_MEN = "WC_MEN",
389
+ /** Women's restroom icon. */
325
390
  WC_WOMEN = "WC_WOMEN",
391
+ /** Food service icon. */
326
392
  FOOD = "FOOD",
393
+ /** Stairway icon. */
327
394
  STAIRS = "STAIRS",
395
+ /** Elevator icon. */
328
396
  ELEVATOR = "ELEVATOR",
397
+ /** Smoking area icon. */
329
398
  SMOKING = "SMOKING",
399
+ /** Coat check icon. */
330
400
  CHECKROOM = "CHECKROOM",
401
+ /** Stage or performance area icon. */
331
402
  STAGE = "STAGE"
332
403
  }
333
404
  /** @enumType */
334
405
  type IconWithLiterals = Icon | 'UNKNOWN_ICON' | 'ENTER' | 'EXIT' | 'DRINKS' | 'WC' | 'WC_MEN' | 'WC_WOMEN' | 'FOOD' | 'STAIRS' | 'ELEVATOR' | 'SMOKING' | 'CHECKROOM' | 'STAGE';
406
+ /** Image reference for use in seating plan visual elements. */
335
407
  interface Image {
336
- /** WixMedia image ID. */
408
+ /** Image ID from Wix Media Manager. */
337
409
  id?: string;
338
410
  /**
339
- * Original image height.
411
+ * Original image height in pixels.
340
412
  * @readonly
341
413
  */
342
414
  height?: number;
343
415
  /**
344
- * Original image width.
416
+ * Original image width in pixels.
345
417
  * @readonly
346
418
  */
347
419
  width?: number;
348
420
  /**
349
- * WixMedia image URI.
421
+ * Deprecated. Use the `id` field instead for referencing images.
350
422
  * @deprecated
351
423
  */
352
424
  uri?: string | null;
353
425
  }
354
426
  declare enum Numbering {
427
+ /** Seat numbering patterns for sequential label generation. */
355
428
  UNKNOWN_NUMBERING = "UNKNOWN_NUMBERING",
429
+ /** Sequential numbers (1, 2, 3, ...). */
356
430
  NUMERIC = "NUMERIC",
431
+ /** Alternating odd and even numbers. */
357
432
  ODD_EVEN = "ODD_EVEN",
433
+ /** Sequential letters (A, B, C, ...). */
358
434
  ALPHABETICAL = "ALPHABETICAL"
359
435
  }
360
436
  /** @enumType */
361
437
  type NumberingWithLiterals = Numbering | 'UNKNOWN_NUMBERING' | 'NUMERIC' | 'ODD_EVEN' | 'ALPHABETICAL';
438
+ /** Configuration for multi-row elements that contain multiple individual rows, each with their own capacity and sequencing. */
362
439
  interface MultiRowProperties {
363
440
  /**
364
- * Individual rows of the multi row element
441
+ * Individual rows within the multi-row element. Each row has its own capacity, sequencing, and category assignment.
365
442
  * @maxSize 1000
366
443
  */
367
444
  rows?: RowElement[];
368
- /** Meta data for vertical labeling */
445
+ /** Configuration for labeling rows vertically (e.g., Row A, Row B, Row C). Defines how row labels are generated. */
369
446
  verticalSequencing?: VerticalSequencing;
370
447
  /**
371
- * Row spacing
448
+ * Vertical spacing between rows in the multi-row element. Measured in coordinate system units.
372
449
  * @min 1
373
450
  * @max 60
374
451
  */
375
452
  rowSpacing?: number | null;
376
453
  /**
377
- * Amount of seats in the row
454
+ * Number of seats per row in the multi-row element.
378
455
  * @max 50
379
456
  */
380
457
  seatAmount?: number | null;
381
458
  }
459
+ /** An individual row within a multi-row element, with its own capacity, sequencing, and category assignment. */
382
460
  interface RowElement {
383
461
  /**
384
- * Unique row id
462
+ * Row ID. Must be unique across all multi-row elements in the seating plan.
385
463
  * @min 1
386
464
  */
387
465
  id?: number;
388
466
  /**
389
- * User friendly title/label of the row
467
+ * User-friendly title or label for this row. For example, `Row A` or `Front Row`.
390
468
  * @minLength 1
391
469
  * @maxLength 50
392
470
  */
393
471
  title?: string | null;
394
472
  /**
395
- * Row capacity
473
+ * Number of seats in this row. Maximum 50,000 per row.
396
474
  * @min 1
397
475
  * @max 50000
398
476
  */
399
477
  capacity?: number | null;
400
- /** Assigned to a category */
478
+ /** Category assignment for this row, which can override the parent element's category. References a category defined in the seating plan. */
401
479
  categoryId?: number | null;
402
- /** A place numbering meta data for a single row */
480
+ /** Configuration for generating seat labels within this row. Defines numbering scheme and starting position. */
403
481
  sequencing?: Sequencing;
404
- /** Row UI settings */
482
+ /** Visual properties specific to this row within the multi-row element. Includes positioning relative to parent element. */
405
483
  uiProperties?: RowElementUiProperties;
406
484
  }
485
+ /** Visual properties specific to individual rows within multi-row elements. */
407
486
  interface RowElementUiProperties {
408
487
  /**
409
- * Relative x position to the parent element
488
+ * Horizontal position relative to the parent multi-row element's coordinate system.
410
489
  * @min -1000000
411
490
  * @max 1000000
412
491
  */
413
492
  relativeX?: number | null;
414
493
  /**
415
- * Width of the row
494
+ * Width of this row in coordinate system units.
416
495
  * @max 1000000
417
496
  */
418
497
  width?: number | null;
419
498
  /**
420
- * Amount of seats in the row
499
+ * Number of seats in this row. Overrides the capacity field when specified.
421
500
  * @max 50
422
501
  */
423
502
  seatAmount?: number | null;
424
503
  /**
425
- * Seat spacing
504
+ * Spacing between seats in this row.
426
505
  * @min 1
427
506
  * @max 60
428
507
  */
429
508
  seatSpacing?: number | null;
430
- /** Label position */
509
+ /** Position of labels relative to seats in this row (left, right, both sides, or none). // Position of labels relative to seats in this row. */
431
510
  labelPosition?: PositionWithLiterals;
432
- /** Seat numbering */
511
+ /** Numbering scheme for seats in this row (numeric, alphabetical, or odd/even). */
433
512
  seatNumbering?: NumberingWithLiterals;
434
513
  }
514
+ /** Configuration for labeling rows vertically in multi-row elements. */
435
515
  interface VerticalSequencing {
436
516
  /**
437
- * First seq element
517
+ * Starting value for row labeling. For example, `A` for alphabetical sequences or `1` for numeric sequences.
438
518
  * @minLength 1
439
519
  * @maxLength 4
440
520
  */
441
521
  startAt?: string;
442
- /** Row numbering */
522
+ /** Numbering scheme for row labels (numeric, alphabetical, or odd/even). */
443
523
  rowNumbering?: NumberingWithLiterals;
444
- /** If true - direction bottom to top. Otherwise top to bottom. */
524
+ /** Whether to label rows in reverse order (bottom-to-top instead of top-to-bottom). */
445
525
  reverseOrder?: boolean | null;
446
526
  }
527
+ /** A grouping mechanism for organizing places by pricing tier, access level, or other business criteria. */
447
528
  interface Category {
448
529
  /**
449
- * Local category id within the seating plan
530
+ * Category ID. Must be unique within the seating plan.
450
531
  * @min 1
451
532
  */
452
533
  id?: number;
453
534
  /**
454
- * A client defined external id for cross referencing.
455
- * Can reference external entities.
456
- * Format: "{entity_fqdn}:{entity_id}"
535
+ * Client-defined external ID for cross-referencing with pricing or ticketing systems. Format: `{entity_fqdn}:{entity_id}`.
457
536
  * @minLength 1
458
537
  * @maxLength 100
459
538
  */
460
539
  externalId?: string | null;
461
540
  /**
462
- * Category label
541
+ * Human-readable category name, such as `VIP`, `General Admission`, or `Student Discount`.
463
542
  * @minLength 1
464
543
  * @maxLength 120
465
544
  */
466
545
  title?: string;
467
546
  /**
468
- * Client configuration object
547
+ * Client configuration object for storing additional category metadata. Read-only field maintained for backward compatibility.
469
548
  * @readonly
470
549
  */
471
550
  config?: Record<string, any> | null;
472
551
  /**
473
- * Total capacity
552
+ * Total capacity of all places assigned to this category. Automatically calculated by summing place capacities.
474
553
  * @readonly
475
554
  */
476
555
  totalCapacity?: number | null;
477
556
  /**
478
- * Possible places
557
+ * All places that are assigned to this category. Populated when using the CATEGORIES fieldset.
479
558
  * @maxSize 50000
480
559
  * @readonly
481
560
  */
@@ -492,104 +571,124 @@ interface ExtendedFields {
492
571
  */
493
572
  namespaces?: Record<string, Record<string, any>>;
494
573
  }
574
+ /** Visual styling properties for the overall seating plan background and appearance. */
495
575
  interface SeatingPlanUiProperties {
496
576
  /**
497
- * #F0F0F0
577
+ * Background color in hexadecimal format. For example, `#F0F0F0` for light gray.
498
578
  * @format COLOR_HEX
499
579
  */
500
580
  backgroundColor?: string | null;
501
- /** @max 100 */
581
+ /**
582
+ * Background opacity as a percentage from 0 (transparent) to 100 (opaque).
583
+ * @max 100
584
+ */
502
585
  backgroundOpacity?: number | null;
503
586
  }
587
+ /** A hierarchical grouping of elements for UI organization and bulk operations. */
504
588
  interface ElementGroup {
505
589
  /**
506
- * Unique element group id
590
+ * Element group ID. Must be unique within the seating plan.
507
591
  * @min 1
508
592
  */
509
593
  id?: number;
510
- /** Parent group id */
594
+ /** ID of the parent group for creating nested group hierarchies. References another ElementGroup in the same seating plan. */
511
595
  parentElementGroupId?: number | null;
512
- /** Element group UI settings */
596
+ /** Visual properties for rendering this group in the UI. Includes positioning and dimensions for the group container. */
513
597
  uiProperties?: ElementGroupUiProperties;
514
598
  }
599
+ /** Visual positioning and styling properties for element groups. */
515
600
  interface ElementGroupUiProperties {
516
601
  /**
517
- * x position of the group
602
+ * Horizontal position coordinate of the group container.
518
603
  * @min -1000000
519
604
  * @max 1000000
520
605
  */
521
606
  x?: number | null;
522
607
  /**
523
- * y position of the group
608
+ * Vertical position coordinate of the group container.
524
609
  * @min -1000000
525
610
  * @max 1000000
526
611
  */
527
612
  y?: number | null;
528
613
  /**
529
- * width of the group
614
+ * Width of the group bounding box in coordinate system units.
530
615
  * @max 1000000
531
616
  */
532
617
  width?: number | null;
533
618
  /**
534
- * height of the group
619
+ * Height of the group bounding box in coordinate system units.
535
620
  * @max 1000000
536
621
  */
537
622
  height?: number | null;
538
623
  /**
539
- * rotation angle of the group
624
+ * Rotation angle of the group in degrees. Applied to all elements within the group.
540
625
  * @min -180
541
626
  * @max 180
542
627
  */
543
628
  rotationAngle?: number | null;
544
629
  }
630
+ /** Request to create a new seating plan. */
545
631
  interface CreateSeatingPlanRequest {
546
- /** A plan to be created */
632
+ /** Seating plan to create. Must include at least one section with `id = 0` as the default section. */
547
633
  plan: SeatingPlan;
548
634
  }
635
+ /** Response containing the created seating plan. */
549
636
  interface CreateSeatingPlanResponse {
550
- /** The created plan */
637
+ /** Created seating plan with generated ID, timestamps, and calculated totals. */
551
638
  plan?: SeatingPlan;
552
639
  }
640
+ /** Error details when seating plan or element capacity limits are exceeded. */
641
+ interface CapacityExceededViolation {
642
+ /** Maximum allowed capacity that was exceeded. Represents the system limit for the specific context. */
643
+ maxCapacity?: number;
644
+ /** Invalid capacity value that was provided in the request. */
645
+ capacity?: number;
646
+ /** ID of the element where the capacity violation occurred. Only present for element-level violations. */
647
+ elementId?: number | null;
648
+ }
649
+ /** Request to update an existing seating plan. */
553
650
  interface UpdateSeatingPlanRequest {
554
- /** The plan updates */
651
+ /** Seating plan updates to apply. Must include the plan ID for identification. */
555
652
  plan?: SeatingPlan;
556
- /** A set of field paths, specifying which parts of seating plan to update */
653
+ /** Field mask specifying which parts of the seating plan to update. For example, `sections.elements.ui_properties` to update only visual properties. */
557
654
  fields?: string[];
558
655
  }
656
+ /** Response containing the updated seating plan. */
559
657
  interface UpdateSeatingPlanResponse {
560
- /** The updated plan */
658
+ /** Updated seating plan with incremented version and recalculated totals. */
561
659
  plan?: SeatingPlan;
562
660
  }
563
661
  interface CopySeatingPlanRequest {
564
662
  /**
565
- * The id of the plan to be copied
663
+ * ID of the seating plan to be copied.
566
664
  * @format GUID
567
665
  */
568
666
  id: string | null;
569
667
  /**
570
- * New plan title
668
+ * Title for the new copied seating plan. Must be different from the original.
571
669
  * @minLength 1
572
670
  * @maxLength 120
573
671
  */
574
672
  title: string | null;
575
673
  /**
576
- * Format: "{fqdn}:{entity guid}"
674
+ * External ID for the new copied seating plan. Format: `{fqdn}:{entity_guid}`. Must be unique.
577
675
  * @minLength 1
578
676
  * @maxLength 100
579
677
  */
580
678
  externalId: string | null;
581
679
  }
582
680
  interface CopySeatingPlanResponse {
583
- /** The copied plan */
681
+ /** Copied seating plan with new ID, specified title, and all duplicated content. */
584
682
  plan?: SeatingPlan;
585
683
  }
684
+ /** Request to query multiple seating plans with filtering and projection options. */
586
685
  interface QuerySeatingPlanRequest {
587
686
  /**
588
687
  * Generic query object
589
688
  * Possible fieldsets: "elements", "categories", "places", "config".
590
689
  */
591
690
  query: QueryV2;
592
- /** A fieldset for the response */
691
+ /** Fieldsets to include in the response. Available options: ELEMENTS, CATEGORIES, PLACES, CONFIG, ELEMENT_GROUPS. */
593
692
  fieldset?: FieldsetWithLiterals[];
594
693
  }
595
694
  interface QueryV2 extends QueryV2PagingMethodOneOf {
@@ -657,27 +756,35 @@ interface CursorPaging {
657
756
  */
658
757
  cursor?: string | null;
659
758
  }
759
+ /** Available fieldsets for seating plan projections. */
660
760
  declare enum Fieldset {
761
+ /** Include section elements with their configurations and generated places. */
661
762
  ELEMENTS = "ELEMENTS",
763
+ /** Include categories with their assigned places and capacity totals. */
662
764
  CATEGORIES = "CATEGORIES",
765
+ /** Include all generated places across all elements and sections. */
663
766
  PLACES = "PLACES",
767
+ /** Include legacy configuration objects for backward compatibility. */
664
768
  CONFIG = "CONFIG",
769
+ /** Include element groups for hierarchical organization and UI rendering. */
665
770
  ELEMENT_GROUPS = "ELEMENT_GROUPS"
666
771
  }
667
772
  /** @enumType */
668
773
  type FieldsetWithLiterals = Fieldset | 'ELEMENTS' | 'CATEGORIES' | 'PLACES' | 'CONFIG' | 'ELEMENT_GROUPS';
774
+ /** Response containing matching seating plans. */
669
775
  interface QuerySeatingPlanResponse {
670
- /** Plan results */
776
+ /** Seating plans matching the query criteria with requested fieldsets included. */
671
777
  plans?: SeatingPlan[];
672
778
  }
779
+ /** Request to retrieve a specific seating plan by ID. */
673
780
  interface GetSeatingPlanRequest {
674
781
  /**
675
- * The id of the plan
782
+ * Seating plan ID to retrieve.
676
783
  * @format GUID
677
784
  */
678
785
  id: string | null;
679
786
  /**
680
- * A fieldset for the response
787
+ * Deprecated. Use `fieldsets` parameter instead.
681
788
  * @deprecated
682
789
  */
683
790
  fieldset?: FieldsetWithLiterals[];
@@ -686,26 +793,26 @@ interface GetSeatingPlanRequest {
686
793
  * Possible values: "elements", "categories", "places", "config".
687
794
  */
688
795
  fieldsets?: string[];
689
- /** Seating Plan Mask */
796
+ /** Seating plan mask for filtering specific places by their IDs. Useful for retrieving only relevant places. */
690
797
  seatingPlanMask?: SeatingPlanMask;
691
798
  }
692
799
  interface SeatingPlanMask {
693
800
  /**
694
- * Filter seating plan by place ids
801
+ * Filter seating plan by place IDs. For example, `0-1-A`, `0-2-B`. Use this to retrieve only specific places from large seating plans.
695
802
  * @minLength 5
696
803
  * @maxLength 11
697
804
  */
698
805
  placeId?: string[];
699
806
  }
700
807
  interface GetSeatingPlanResponse {
701
- /** The plan */
808
+ /** Retrieved seating plan with requested fieldsets and filtered places. */
702
809
  plan?: SeatingPlan;
703
810
  }
704
811
  interface FindSeatingPlanRequest {
705
- /** The filter of the plan */
812
+ /** Filter criteria for finding the seating plan. Use standard WQL filter format. */
706
813
  filter: Record<string, any> | null;
707
814
  /**
708
- * A fieldset for the response
815
+ * Deprecated. Use `fieldsets` parameter instead.
709
816
  * @deprecated
710
817
  */
711
818
  fieldset?: FieldsetWithLiterals[];
@@ -714,48 +821,278 @@ interface FindSeatingPlanRequest {
714
821
  * Possible values: "elements", "categories", "places", "config".
715
822
  */
716
823
  fieldsets?: string[];
717
- /** Seating Plan Mask */
824
+ /** Seating plan mask for filtering specific places by their IDs. */
718
825
  seatingPlanMask?: SeatingPlanMask;
719
826
  }
720
827
  interface FindSeatingPlanResponse {
721
- /** The plan */
828
+ /** Found seating plan matching the filter criteria, or empty if no match found. */
722
829
  plan?: SeatingPlan;
723
830
  }
724
831
  interface DeleteSeatingPlanRequest {
725
832
  /**
726
- * The id of the plan
833
+ * ID of the seating plan to delete.
727
834
  * @format GUID
728
835
  */
729
836
  id: string | null;
730
837
  }
731
838
  interface DeleteSeatingPlanResponse {
732
- /** Deleted plan */
839
+ /** Deleted seating plan data for reference before deletion. */
840
+ plan?: SeatingPlan;
841
+ }
842
+ interface DomainEvent extends DomainEventBodyOneOf {
843
+ createdEvent?: EntityCreatedEvent;
844
+ updatedEvent?: EntityUpdatedEvent;
845
+ deletedEvent?: EntityDeletedEvent;
846
+ actionEvent?: ActionEvent;
847
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
848
+ id?: string;
849
+ /**
850
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
851
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
852
+ */
853
+ entityFqdn?: string;
854
+ /**
855
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
856
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
857
+ */
858
+ slug?: string;
859
+ /** ID of the entity associated with the event. */
860
+ entityId?: string;
861
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
862
+ eventTime?: Date | null;
863
+ /**
864
+ * Whether the event was triggered as a result of a privacy regulation application
865
+ * (for example, GDPR).
866
+ */
867
+ triggeredByAnonymizeRequest?: boolean | null;
868
+ /** If present, indicates the action that triggered the event. */
869
+ originatedFrom?: string | null;
870
+ /**
871
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
872
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
873
+ */
874
+ entityEventSequence?: string | null;
875
+ }
876
+ /** @oneof */
877
+ interface DomainEventBodyOneOf {
878
+ createdEvent?: EntityCreatedEvent;
879
+ updatedEvent?: EntityUpdatedEvent;
880
+ deletedEvent?: EntityDeletedEvent;
881
+ actionEvent?: ActionEvent;
882
+ }
883
+ interface EntityCreatedEvent {
884
+ entityAsJson?: string;
885
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
886
+ restoreInfo?: RestoreInfo;
887
+ }
888
+ interface RestoreInfo {
889
+ deletedDate?: Date | null;
890
+ }
891
+ interface EntityUpdatedEvent {
892
+ /**
893
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
894
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
895
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
896
+ */
897
+ currentEntityAsJson?: string;
898
+ }
899
+ interface EntityDeletedEvent {
900
+ /** Entity that was deleted. */
901
+ deletedEntityAsJson?: string | null;
902
+ }
903
+ interface ActionEvent {
904
+ bodyAsJson?: string;
905
+ }
906
+ interface MessageEnvelope {
907
+ /**
908
+ * App instance ID.
909
+ * @format GUID
910
+ */
911
+ instanceId?: string | null;
912
+ /**
913
+ * Event type.
914
+ * @maxLength 150
915
+ */
916
+ eventType?: string;
917
+ /** The identification type and identity data. */
918
+ identity?: IdentificationData;
919
+ /** Stringify payload. */
920
+ data?: string;
921
+ }
922
+ interface IdentificationData extends IdentificationDataIdOneOf {
923
+ /**
924
+ * ID of a site visitor that has not logged in to the site.
925
+ * @format GUID
926
+ */
927
+ anonymousVisitorId?: string;
928
+ /**
929
+ * ID of a site visitor that has logged in to the site.
930
+ * @format GUID
931
+ */
932
+ memberId?: string;
933
+ /**
934
+ * ID of a Wix user (site owner, contributor, etc.).
935
+ * @format GUID
936
+ */
937
+ wixUserId?: string;
938
+ /**
939
+ * ID of an app.
940
+ * @format GUID
941
+ */
942
+ appId?: string;
943
+ /** @readonly */
944
+ identityType?: WebhookIdentityTypeWithLiterals;
945
+ }
946
+ /** @oneof */
947
+ interface IdentificationDataIdOneOf {
948
+ /**
949
+ * ID of a site visitor that has not logged in to the site.
950
+ * @format GUID
951
+ */
952
+ anonymousVisitorId?: string;
953
+ /**
954
+ * ID of a site visitor that has logged in to the site.
955
+ * @format GUID
956
+ */
957
+ memberId?: string;
958
+ /**
959
+ * ID of a Wix user (site owner, contributor, etc.).
960
+ * @format GUID
961
+ */
962
+ wixUserId?: string;
963
+ /**
964
+ * ID of an app.
965
+ * @format GUID
966
+ */
967
+ appId?: string;
968
+ }
969
+ declare enum WebhookIdentityType {
970
+ UNKNOWN = "UNKNOWN",
971
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
972
+ MEMBER = "MEMBER",
973
+ WIX_USER = "WIX_USER",
974
+ APP = "APP"
975
+ }
976
+ /** @enumType */
977
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
978
+ interface SaveSeatingPlanVersionRequest {
979
+ /** Seating plan version to be saved as a draft. Must include plan ID for existing plans. */
980
+ plan?: SeatingPlan;
981
+ /**
982
+ * Parent version of the plan. Use this field to override history of plan versions.
983
+ * @min 1
984
+ */
985
+ parentVersion?: string | null;
986
+ }
987
+ interface SaveSeatingPlanVersionResponse {
988
+ /** Saved seating plan version with incremented version number and updated timestamps. */
989
+ plan?: SeatingPlan;
990
+ }
991
+ interface QuerySeatingPlanVersionsRequest {
992
+ /** Query criteria for filtering seating plan versions. Supports standard WQL filtering, sorting, and paging. */
993
+ query?: QueryV2;
994
+ }
995
+ interface QuerySeatingPlanVersionsResponse {
996
+ /** Seating plan versions matching the query criteria, ordered by version number. */
997
+ plans?: SeatingPlan[];
998
+ /** Paging metadata for the query results including total count and cursor information. */
999
+ metadata?: PagingMetadataV2;
1000
+ }
1001
+ interface PagingMetadataV2 {
1002
+ /** Number of items returned in the response. */
1003
+ count?: number | null;
1004
+ /** Offset that was requested. */
1005
+ offset?: number | null;
1006
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
1007
+ total?: number | null;
1008
+ /** Flag that indicates the server failed to calculate the `total` field. */
1009
+ tooManyToCount?: boolean | null;
1010
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
1011
+ cursors?: Cursors;
1012
+ }
1013
+ interface Cursors {
1014
+ /**
1015
+ * Cursor string pointing to the next page in the list of results.
1016
+ * @maxLength 16000
1017
+ */
1018
+ next?: string | null;
1019
+ /**
1020
+ * Cursor pointing to the previous page in the list of results.
1021
+ * @maxLength 16000
1022
+ */
1023
+ prev?: string | null;
1024
+ }
1025
+ interface DiscardSeatingPlanVersionsRequest {
1026
+ /**
1027
+ * Seating plan ID to discard versions for.
1028
+ * @format GUID
1029
+ */
1030
+ seatingPlanId?: string | null;
1031
+ /** Version from which all higher versions will be discarded. This version and lower versions are preserved. */
1032
+ version?: string | null;
1033
+ }
1034
+ interface DiscardSeatingPlanVersionsResponse {
1035
+ }
1036
+ interface RestoreSeatingPlanRequest {
1037
+ /**
1038
+ * Seating plan ID to restore.
1039
+ * @format GUID
1040
+ */
1041
+ seatingPlanId?: string | null;
1042
+ /** Version to which the seating plan should be restored. This becomes the basis for the new current version. */
1043
+ version?: string | null;
1044
+ }
1045
+ interface RestoreSeatingPlanResponse {
1046
+ /** Restored seating plan with the specified version as the new current version and incremented version number. */
733
1047
  plan?: SeatingPlan;
734
1048
  }
735
1049
  interface UpdateSeatingPlanThumbnailRequest {
1050
+ /** Thumbnail to update with new image data. */
736
1051
  thumbnail: SeatingPlanThumbnail;
737
1052
  }
1053
+ /** Thumbnail image data for a seating plan. */
738
1054
  interface SeatingPlanThumbnail {
739
1055
  /**
1056
+ * Seating plan ID that this thumbnail represents.
740
1057
  * @format GUID
741
1058
  * @readonly
742
1059
  */
743
1060
  id?: string | null;
1061
+ /** Thumbnail image data or reference. Format depends on implementation (base64, URL, or image ID). */
744
1062
  img?: string | null;
745
1063
  }
746
1064
  interface UpdateSeatingPlanThumbnailResponse {
1065
+ /** Updated thumbnail with confirmation of changes. */
747
1066
  thumbnail?: SeatingPlanThumbnail;
748
1067
  }
749
1068
  interface GetSeatingPlanThumbnailRequest {
750
1069
  /**
1070
+ * Seating plan ID to retrieve thumbnail for.
751
1071
  * @format GUID
752
1072
  * @readonly
753
1073
  */
754
1074
  id: string | null;
755
1075
  }
756
1076
  interface GetSeatingPlanThumbnailResponse {
1077
+ /** Retrieved thumbnail data, or empty if no thumbnail exists. */
757
1078
  thumbnail?: SeatingPlanThumbnail;
758
1079
  }
1080
+ /** @docsIgnore */
1081
+ type CreateSeatingPlanApplicationErrors = {
1082
+ code?: 'PLAN_MAX_CAPACITY_EXCEEDED';
1083
+ description?: string;
1084
+ data?: CapacityExceededViolation;
1085
+ } | {
1086
+ code?: 'ELEMENT_MAX_CAPACITY_EXCEEDED';
1087
+ description?: string;
1088
+ data?: CapacityExceededViolation;
1089
+ };
1090
+ /** @docsIgnore */
1091
+ type UpdateSeatingPlanApplicationErrors = {
1092
+ code?: 'INVALID_FIELD_MASK';
1093
+ description?: string;
1094
+ data?: Record<string, any>;
1095
+ };
759
1096
 
760
1097
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
761
1098
  getUrl: (context: any) => string;
@@ -781,4 +1118,4 @@ declare function deleteSeatingPlan(): __PublicMethodMetaInfo<'DELETE', {
781
1118
  declare function updateSeatingPlanThumbnail(): __PublicMethodMetaInfo<'POST', {}, UpdateSeatingPlanThumbnailRequest$1, UpdateSeatingPlanThumbnailRequest, UpdateSeatingPlanThumbnailResponse$1, UpdateSeatingPlanThumbnailResponse>;
782
1119
  declare function getSeatingPlanThumbnail(): __PublicMethodMetaInfo<'GET', {}, GetSeatingPlanThumbnailRequest$1, GetSeatingPlanThumbnailRequest, GetSeatingPlanThumbnailResponse$1, GetSeatingPlanThumbnailResponse>;
783
1120
 
784
- export { type __PublicMethodMetaInfo, copySeatingPlan, createSeatingPlan, deleteSeatingPlan, findSeatingPlan, getSeatingPlan, getSeatingPlanThumbnail, querySeatingPlan, updateSeatingPlan, updateSeatingPlanThumbnail };
1121
+ export { type ActionEvent as ActionEventOriginal, type CapacityExceededViolation as CapacityExceededViolationOriginal, type Category as CategoryOriginal, type CopySeatingPlanRequest as CopySeatingPlanRequestOriginal, type CopySeatingPlanResponse as CopySeatingPlanResponseOriginal, type CreateSeatingPlanApplicationErrors as CreateSeatingPlanApplicationErrorsOriginal, type CreateSeatingPlanRequest as CreateSeatingPlanRequestOriginal, type CreateSeatingPlanResponse as CreateSeatingPlanResponseOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type DeleteSeatingPlanRequest as DeleteSeatingPlanRequestOriginal, type DeleteSeatingPlanResponse as DeleteSeatingPlanResponseOriginal, type DiscardSeatingPlanVersionsRequest as DiscardSeatingPlanVersionsRequestOriginal, type DiscardSeatingPlanVersionsResponse as DiscardSeatingPlanVersionsResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type ElementGroup as ElementGroupOriginal, type ElementGroupUiProperties as ElementGroupUiPropertiesOriginal, type Element as ElementOriginal, type ElementUiProperties as ElementUiPropertiesOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, Fieldset as FieldsetOriginal, type FieldsetWithLiterals as FieldsetWithLiteralsOriginal, type FindSeatingPlanRequest as FindSeatingPlanRequestOriginal, type FindSeatingPlanResponse as FindSeatingPlanResponseOriginal, type GetSeatingPlanRequest as GetSeatingPlanRequestOriginal, type GetSeatingPlanResponse as GetSeatingPlanResponseOriginal, type GetSeatingPlanThumbnailRequest as GetSeatingPlanThumbnailRequestOriginal, type GetSeatingPlanThumbnailResponse as GetSeatingPlanThumbnailResponseOriginal, Icon as IconOriginal, type IconWithLiterals as IconWithLiteralsOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MultiRowProperties as MultiRowPropertiesOriginal, Numbering as NumberingOriginal, type NumberingWithLiterals as NumberingWithLiteralsOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type Place as PlaceOriginal, PlaceTypeEnumType as PlaceTypeEnumTypeOriginal, type PlaceTypeEnumTypeWithLiterals as PlaceTypeEnumTypeWithLiteralsOriginal, Position as PositionOriginal, type PositionWithLiterals as PositionWithLiteralsOriginal, type QuerySeatingPlanRequest as QuerySeatingPlanRequestOriginal, type QuerySeatingPlanResponse as QuerySeatingPlanResponseOriginal, type QuerySeatingPlanVersionsRequest as QuerySeatingPlanVersionsRequestOriginal, type QuerySeatingPlanVersionsResponse as QuerySeatingPlanVersionsResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, type ReservationOptions as ReservationOptionsOriginal, type RestoreInfo as RestoreInfoOriginal, type RestoreSeatingPlanRequest as RestoreSeatingPlanRequestOriginal, type RestoreSeatingPlanResponse as RestoreSeatingPlanResponseOriginal, type RowElement as RowElementOriginal, type RowElementUiProperties as RowElementUiPropertiesOriginal, type SaveSeatingPlanVersionRequest as SaveSeatingPlanVersionRequestOriginal, type SaveSeatingPlanVersionResponse as SaveSeatingPlanVersionResponseOriginal, type SeatingPlanMask as SeatingPlanMaskOriginal, type SeatingPlan as SeatingPlanOriginal, type SeatingPlanThumbnail as SeatingPlanThumbnailOriginal, type SeatingPlanUiProperties as SeatingPlanUiPropertiesOriginal, type Section as SectionOriginal, type Sequencing as SequencingOriginal, ShapeTypeEnumType as ShapeTypeEnumTypeOriginal, type ShapeTypeEnumTypeWithLiterals as ShapeTypeEnumTypeWithLiteralsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type UpdateSeatingPlanApplicationErrors as UpdateSeatingPlanApplicationErrorsOriginal, type UpdateSeatingPlanRequest as UpdateSeatingPlanRequestOriginal, type UpdateSeatingPlanResponse as UpdateSeatingPlanResponseOriginal, type UpdateSeatingPlanThumbnailRequest as UpdateSeatingPlanThumbnailRequestOriginal, type UpdateSeatingPlanThumbnailResponse as UpdateSeatingPlanThumbnailResponseOriginal, type VerticalSequencing as VerticalSequencingOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, copySeatingPlan, createSeatingPlan, deleteSeatingPlan, findSeatingPlan, getSeatingPlan, getSeatingPlanThumbnail, querySeatingPlan, updateSeatingPlan, updateSeatingPlanThumbnail };