@wix/auto_sdk_seatings_seating-reservation 1.0.11 → 1.0.13

package/build/internal/cjs/index.typings.d.ts

@@ -557,481 +557,560 @@ interface GetSeatingReservationSummaryResponse {
     /** @maxSize 50000 */
     places?: PlaceReservationDetails[];
 }
+/** 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. */
 interface SeatingPlan {
     /**
-     * Auto generated unique plan id
+     * Seating plan ID.
      * @format GUID
      * @readonly
      */
     _id?: string | null;
     /**
-     * A client defined external id for cross referencing.
-     * Can reference external entities.
-     * Format: "{fqdn}:{entity guid}"
+     * Client-defined external ID for cross-referencing with external systems. Format: `{fqdn}:{entity_guid}`. For example, `wix.events.v1.event:abc-123-def`.
      * @minLength 1
      * @maxLength 100
      */
     externalId?: string | null;
     /**
-     * Human friendly plan title
+     * Human-friendly seating plan title. For example, `Madison Square Garden - Main Floor`.
      * @minLength 1
      * @maxLength 120
      */
     title?: string | null;
     /**
-     * Sections of the plan. Seating plan is divided in high level sections.
+     * 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.
      * @maxSize 100
      */
     sections?: Section[];
     /**
-     * Categories for plan element grouping.
+     * 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.
      * @maxSize 100
      */
     categories?: Category[];
     /**
-     * Seating plan created timestamp.
+     * Date and time the seating plan was created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * Seating plan updated timestamp.
+     * Date and time the seating plan was updated.
      * @readonly
      */
     _updatedDate?: Date | null;
     /**
-     * Total capacity
+     * Total number of seats across all sections and elements in the seating plan. Automatically calculated by summing element capacities.
      * @readonly
      */
     totalCapacity?: number | null;
     /**
-     * Total categories
+     * Total number of categories defined in the seating plan. Automatically calculated.
      * @readonly
      */
     totalCategories?: number | null;
     /**
-     * Places not assigned to categories
+     * Places that are not assigned to any category. These places require manual category assignment for pricing and organization.
      * @maxSize 50000
      * @readonly
      */
     uncategorizedPlaces?: Place[];
     /**
-     * A version of the seating plan
+     * Version number of the seating plan, incremented by 1 each time the plan is updated. Used for version management and tracking changes.
      * @readonly
      */
     version?: string | null;
-    /** Data extensions */
+    /** Additional custom fields for extending the seating plan with app-specific data. Learn more about @extended fields. */
     extendedFields?: ExtendedFields;
-    /** Seating Plan UI settings */
+    /** Visual settings for the seating plan, such as background color and opacity. Used by seating chart interfaces for rendering. */
     uiProperties?: SeatingPlanUiProperties;
     /**
-     * Element groups
+     * Hierarchical groupings of elements for UI organization and bulk operations. Groups can contain multiple elements or nested sub-groups for easier management.
      * @maxSize 1000
      */
     elementGroups?: ElementGroup[];
 }
+/** 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. */
 interface Section {
-    /** Unique section id */
+    /** Section ID. Must be unique within the seating plan. Section with `id = 0` is required as the default section. */
     _id?: number;
     /**
-     * Human readable section title
+     * Human-readable section title. For example, `Orchestra` or `Balcony`.
      * @minLength 1
      * @maxLength 20
      */
     title?: string | null;
     /**
-     * Client configuration object
+     * Client configuration object for storing additional section metadata. Read-only field maintained for backward compatibility.
      * @readonly
      */
     config?: Record<string, any> | null;
     /**
-     * Elements of the section.
+     * Seating elements within this section, such as rows, tables, or general admission areas. Each element generates individual places based on its type and capacity.
      * @maxSize 1000
      */
     elements?: Element[];
     /**
-     * Total capacity
+     * Total capacity of all elements within this section. Automatically calculated by summing element capacities.
      * @readonly
      */
     totalCapacity?: number | null;
     /**
-     * Is default section
+     * Whether this is the default section. Always `true` for section with `id = 0`.
      * @readonly
      */
     default?: boolean;
 }
+/** 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. */
 interface Element {
     /**
-     * Unique element id
+     * Element ID. Must be unique within the seating plan.
      * @min 1
      */
     _id?: number;
     /**
-     * User friendly title/label of the element.
+     * User-friendly title or label for the element. For example, `Row A` or `VIP Table 1`.
      * @minLength 1
      * @maxLength 50
      */
     title?: string | null;
-    /** Element type */
+    /** Type of seating element, which determines capacity limits and place generation behavior. See ElementTypeEnum for available types. */
     type?: TypeWithLiterals;
     /**
-     * Capacity. None for Shape type Element.
+     * Number of seats or spots in this element. Not applicable for SHAPE type elements. Maximum 50,000 per element.
      * @min 1
      * @max 50000
      */
     capacity?: number | null;
-    /** Assigned to a category */
+    /** ID of the category this element is assigned to for pricing and organization. References a category defined in the seating plan. */
     categoryId?: number | null;
-    /** A place numbering meta data */
+    /** Configuration for generating place labels and numbering within this element. Defines how seats are labeled (e.g., 1, 2, 3 or A, B, C). */
     sequencing?: Sequencing;
     /**
-     * Place override (by seq_id)
+     * Custom place configurations that override the default generated places for specific positions. Used for accessibility seating, obstructed views, or custom labeling.
      * @maxSize 2000
      */
     overrides?: Place[];
     /**
-     * Final place sequence with overrides
+     * Final sequence of places generated for this element, including any overrides applied. Read-only field populated by the system.
      * @maxSize 200
      * @readonly
      */
     places?: Place[];
-    /** Element reservation options */
+    /** Constraints on how this element can be reserved or booked. For example, requiring the entire element to be reserved as a unit. */
     reservationOptions?: ReservationOptions;
-    /** Element UI settings */
+    /** Visual positioning and styling properties for rendering this element in a seating chart. Includes coordinates, dimensions, and styling options. */
     uiProperties?: ElementUiProperties;
-    /** Element group id */
+    /** ID of the element group this element belongs to for hierarchical organization. References an ElementGroup defined in the seating plan. */
     elementGroupId?: number | null;
-    /** Multi row element relevant for MULTI_ROW element type */
+    /** Additional properties for MULTI_ROW type elements, defining individual rows and their configurations. Only applicable when type is MULTI_ROW. */
     multiRowProperties?: MultiRowProperties;
 }
 declare enum Type {
+    /** General admission area with a single place containing the full capacity. */
     AREA = "AREA",
+    /** Single row of individual seats with sequential labeling. */
     ROW = "ROW",
+    /** Multiple rows treated as one element, each with individual capacity and sequencing. */
     MULTI_ROW = "MULTI_ROW",
+    /** Rectangular table with individual seats around the perimeter. */
     TABLE = "TABLE",
+    /** Circular table with individual seats around the perimeter. */
     ROUND_TABLE = "ROUND_TABLE",
+    /** Visual element with no seating capacity, used for decorative or informational purposes. */
     SHAPE = "SHAPE"
 }
 /** @enumType */
 type TypeWithLiterals = Type | 'AREA' | 'ROW' | 'MULTI_ROW' | 'TABLE' | 'ROUND_TABLE' | 'SHAPE';
+/** Configuration for generating sequential labels for places within an element. */
 interface Sequencing {
     /**
-     * First seq element
+     * Starting value for the sequence. For example, `1` for numeric sequences or `A` for alphabetical sequences.
      * @minLength 1
      * @maxLength 4
      */
     startAt?: string;
     /**
-     * Finite generated seq of labels
+     * Complete sequence of labels to be used for places. Must match the element's capacity. When provided, overrides automatic label generation.
      * @maxSize 2500
      */
     labels?: string[];
-    /** If true - direction right to left. Otherwise left to right. */
+    /** Whether to apply labels in reverse order (right-to-left instead of left-to-right). Useful for venue-specific numbering conventions. */
     reverseOrder?: boolean | null;
 }
+/** An individual seat or spot within an element where an attendee can be positioned. */
 interface Place {
-    /** Local id of the place in the sequence */
+    /** Zero-based position of this place within the element's sequence. Used to identify the place's position for overrides. */
     index?: number;
     /**
-     * Generated composite unique id in the seating plan.
+     * Unique place ID in the format `{section_id}-{element_id}-{label}`. For example, `0-1-A5` for section 0, element 1, seat A5.
      * @readonly
      */
     _id?: string | null;
     /**
-     * Unique label of the place
+     * Human-readable label for this place, such as `A1`, `12`, or `VIP1`. Generated based on sequencing configuration or custom overrides.
      * @minLength 1
      * @maxLength 4
      */
     label?: string;
     /**
-     * Max capacity per place
+     * Maximum number of people that can occupy this place. Typically 1 for individual seats, higher for AREA type places.
      * @readonly
      */
     capacity?: number | null;
     /**
-     * Type of the parent element
+     * Type of the parent element that contains this place. Inherited from the element's type.
      * @readonly
      */
     elementType?: TypeWithLiterals;
     /**
-     * Assigned category id
+     * ID of the category this place is assigned to. Inherited from element or row category assignment.
      * @readonly
      */
     categoryId?: number | null;
-    /** Place type */
+    /** Special characteristics or accessibility features of this place (standard, wheelchair, accessible, companion, obstructed, discount). */
     type?: PlaceTypeEnumTypeWithLiterals;
 }
 declare enum PlaceTypeEnumType {
+    /** Unknown place type. */
     UNKNOWN_PROPERTY = "UNKNOWN_PROPERTY",
+    /** Standard seating with no special accommodations. */
     STANDARD = "STANDARD",
+    /** Wheelchair accessible seating space. */
     WHEELCHAIR = "WHEELCHAIR",
+    /** Accessible seating for mobility-impaired guests. */
     ACCESSIBLE = "ACCESSIBLE",
+    /** Companion seat adjacent to accessible seating. */
     COMPANION = "COMPANION",
+    /** Seat with limited or obstructed view. */
     OBSTRUCTED = "OBSTRUCTED",
+    /** Discounted pricing seat. */
     DISCOUNT = "DISCOUNT"
 }
 /** @enumType */
 type PlaceTypeEnumTypeWithLiterals = PlaceTypeEnumType | 'UNKNOWN_PROPERTY' | 'STANDARD' | 'WHEELCHAIR' | 'ACCESSIBLE' | 'COMPANION' | 'OBSTRUCTED' | 'DISCOUNT';
+/** Configuration options that control how an element can be reserved or booked. */
 interface ReservationOptions {
-    /** Indicates whether the entire element must be reserved */
+    /** 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. */
     reserveWholeElement?: boolean;
 }
+/** Visual positioning and styling properties for rendering elements in a seating chart interface. */
 interface ElementUiProperties {
     /**
+     * Horizontal position coordinate of the element in the seating chart coordinate system.
      * @min -1000000
      * @max 1000000
      */
     x?: number | null;
     /**
+     * Vertical position coordinate of the element in the seating chart coordinate system.
      * @min -1000000
      * @max 1000000
      */
     y?: number | null;
     /**
+     * Layering order for overlapping elements. Higher values appear on top of lower values.
      * @min -1000000
      * @max 1000000
      */
     zIndex?: number | null;
-    /** @max 1000000 */
+    /**
+     * Width of the element in the coordinate system units.
+     * @max 1000000
+     */
     width?: number | null;
-    /** @max 1000000 */
+    /**
+     * Height of the element in the coordinate system units.
+     * @max 1000000
+     */
     height?: number | null;
     /**
+     * Rotation angle of the element in degrees. Positive values rotate clockwise.
      * @min -180
      * @max 180
      */
     rotationAngle?: number | null;
+    /** Shape type for SHAPE elements that don't represent seating. Only applicable when element type is SHAPE. */
     shapeType?: ShapeTypeEnumTypeWithLiterals;
     /**
+     * Font size for text elements in points.
      * @min 10
      * @max 176
      */
     fontSize?: number | null;
-    /** @max 1000000 */
+    /**
+     * Corner radius for rounded rectangular shapes in coordinate system units.
+     * @max 1000000
+     */
     cornerRadius?: number | null;
     /**
+     * Horizontal spacing between individual seats within the element.
      * @min 1
      * @max 60
      */
     seatSpacing?: number | null;
+    /** Whether to hide labels on seats within this element. When `true`, seat labels are not displayed in the UI. */
     hideLabel?: boolean | null;
+    /** Position of labels relative to seats (left, right, both sides, or none). */
     labelPosition?: PositionWithLiterals;
+    /** Array defining the arrangement of seats within the element. Each number represents the count of seats in that position. */
     seatLayout?: number[];
-    /** @max 50 */
+    /**
+     * Number of empty spaces at the top of the seating arrangement for visual spacing.
+     * @max 50
+     */
     emptyTopSeatSpaces?: number | null;
     /**
-     * needs research
+     * Text content for TEXT type shape elements. Only applicable when shape_type is TEXT.
      * @minLength 1
      * @maxLength 10000
      */
     text?: string | null;
     /**
-     * #F0F0F0
+     * Primary color in hexadecimal format. For example, `#FF0000` for red.
      * @format COLOR_HEX
      */
     color?: string | null;
     /**
-     * #F0F0F0
+     * Fill color for shapes in hexadecimal format. For example, `#00FF00` for green.
      * @format COLOR_HEX
      */
     fillColor?: string | null;
     /**
-     * #F0F0F0
+     * Border color in hexadecimal format. For example, `#0000FF` for blue.
      * @format COLOR_HEX
      */
     strokeColor?: string | null;
     /**
-     * px
+     * Border width in pixels for shape outlines.
      * @min 1
      * @max 6
      */
     strokeWidth?: number | null;
-    /** @max 100 */
+    /**
+     * Opacity level as a percentage from 0 (transparent) to 100 (opaque).
+     * @max 100
+     */
     opacity?: number | null;
+    /** Icon type for ICON shape elements. Only applicable when shape_type is ICON. */
     icon?: IconWithLiterals;
+    /** Image object for IMAGE shape elements. Only applicable when shape_type is IMAGE. */
     image?: Image;
+    /** Numbering scheme for seats within this element (numeric, alphabetical, or odd/even). */
     seatNumbering?: NumberingWithLiterals;
 }
 declare enum ShapeTypeEnumType {
+    /** Unknown shape type. */
     UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    /** Text label or annotation. */
     TEXT = "TEXT",
+    /** Rectangular shape. */
     RECTANGLE = "RECTANGLE",
+    /** Circular or oval shape. */
     ELLIPSE = "ELLIPSE",
+    /** Straight line. */
     LINE = "LINE",
+    /** Predefined icon symbol. */
     ICON = "ICON",
+    /** Custom image. */
     IMAGE = "IMAGE"
 }
 /** @enumType */
 type ShapeTypeEnumTypeWithLiterals = ShapeTypeEnumType | 'UNKNOWN_TYPE' | 'TEXT' | 'RECTANGLE' | 'ELLIPSE' | 'LINE' | 'ICON' | 'IMAGE';
 declare enum Position {
+    /** Label positioning options for seats and elements. */
     UNKNOWN_POSITION = "UNKNOWN_POSITION",
+    /** Labels appear to the left of seats. */
     LEFT = "LEFT",
+    /** Labels appear to the right of seats. */
     RIGHT = "RIGHT",
+    /** Labels appear on both sides of seats. */
     BOTH = "BOTH",
+    /** No labels are displayed. */
     NONE = "NONE"
 }
 /** @enumType */
 type PositionWithLiterals = Position | 'UNKNOWN_POSITION' | 'LEFT' | 'RIGHT' | 'BOTH' | 'NONE';
 declare enum Icon {
+    /** Available icon types for venue wayfinding and information. */
     UNKNOWN_ICON = "UNKNOWN_ICON",
+    /** Entrance icon. */
     ENTER = "ENTER",
+    /** Exit icon. */
     EXIT = "EXIT",
+    /** Beverage service icon. */
     DRINKS = "DRINKS",
+    /** Restroom icon. */
     WC = "WC",
+    /** Men's restroom icon. */
     WC_MEN = "WC_MEN",
+    /** Women's restroom icon. */
     WC_WOMEN = "WC_WOMEN",
+    /** Food service icon. */
     FOOD = "FOOD",
+    /** Stairway icon. */
     STAIRS = "STAIRS",
+    /** Elevator icon. */
     ELEVATOR = "ELEVATOR",
+    /** Smoking area icon. */
     SMOKING = "SMOKING",
+    /** Coat check icon. */
     CHECKROOM = "CHECKROOM",
+    /** Stage or performance area icon. */
     STAGE = "STAGE"
 }
 /** @enumType */
 type IconWithLiterals = Icon | 'UNKNOWN_ICON' | 'ENTER' | 'EXIT' | 'DRINKS' | 'WC' | 'WC_MEN' | 'WC_WOMEN' | 'FOOD' | 'STAIRS' | 'ELEVATOR' | 'SMOKING' | 'CHECKROOM' | 'STAGE';
+/** Image reference for use in seating plan visual elements. */
 interface Image {
-    /** WixMedia image ID. */
+    /** Image ID from Wix Media Manager. */
     _id?: string;
     /**
-     * Original image height.
+     * Original image height in pixels.
      * @readonly
      */
     height?: number;
     /**
-     * Original image width.
+     * Original image width in pixels.
      * @readonly
      */
     width?: number;
     /**
-     * WixMedia image URI.
+     * Deprecated. Use the `id` field instead for referencing images.
      * @deprecated
      */
     uri?: string | null;
 }
 declare enum Numbering {
+    /** Seat numbering patterns for sequential label generation. */
     UNKNOWN_NUMBERING = "UNKNOWN_NUMBERING",
+    /** Sequential numbers (1, 2, 3, ...). */
     NUMERIC = "NUMERIC",
+    /** Alternating odd and even numbers. */
     ODD_EVEN = "ODD_EVEN",
+    /** Sequential letters (A, B, C, ...). */
     ALPHABETICAL = "ALPHABETICAL"
 }
 /** @enumType */
 type NumberingWithLiterals = Numbering | 'UNKNOWN_NUMBERING' | 'NUMERIC' | 'ODD_EVEN' | 'ALPHABETICAL';
+/** Configuration for multi-row elements that contain multiple individual rows, each with their own capacity and sequencing. */
 interface MultiRowProperties {
     /**
-     * Individual rows of the multi row element
+     * Individual rows within the multi-row element. Each row has its own capacity, sequencing, and category assignment.
      * @maxSize 1000
      */
     rows?: RowElement[];
-    /** Meta data for vertical labeling */
+    /** Configuration for labeling rows vertically (e.g., Row A, Row B, Row C). Defines how row labels are generated. */
     verticalSequencing?: VerticalSequencing;
     /**
-     * Row spacing
+     * Vertical spacing between rows in the multi-row element. Measured in coordinate system units.
      * @min 1
      * @max 60
      */
     rowSpacing?: number | null;
     /**
-     * Amount of seats in the row
+     * Number of seats per row in the multi-row element.
      * @max 50
      */
     seatAmount?: number | null;
 }
+/** An individual row within a multi-row element, with its own capacity, sequencing, and category assignment. */
 interface RowElement {
     /**
-     * Unique row id
+     * Row ID. Must be unique across all multi-row elements in the seating plan.
      * @min 1
      */
     _id?: number;
     /**
-     * User friendly title/label of the row
+     * User-friendly title or label for this row. For example, `Row A` or `Front Row`.
      * @minLength 1
      * @maxLength 50
      */
     title?: string | null;
     /**
-     * Row capacity
+     * Number of seats in this row. Maximum 50,000 per row.
      * @min 1
      * @max 50000
      */
     capacity?: number | null;
-    /** Assigned to a category */
+    /** Category assignment for this row, which can override the parent element's category. References a category defined in the seating plan. */
     categoryId?: number | null;
-    /** A place numbering meta data for a single row */
+    /** Configuration for generating seat labels within this row. Defines numbering scheme and starting position. */
     sequencing?: Sequencing;
-    /** Row UI settings */
+    /** Visual properties specific to this row within the multi-row element. Includes positioning relative to parent element. */
     uiProperties?: RowElementUiProperties;
 }
+/** Visual properties specific to individual rows within multi-row elements. */
 interface RowElementUiProperties {
     /**
-     * Relative x position to the parent element
+     * Horizontal position relative to the parent multi-row element's coordinate system.
      * @min -1000000
      * @max 1000000
      */
     relativeX?: number | null;
     /**
-     * Width of the row
+     * Width of this row in coordinate system units.
      * @max 1000000
      */
     width?: number | null;
     /**
-     * Amount of seats in the row
+     * Number of seats in this row. Overrides the capacity field when specified.
      * @max 50
      */
     seatAmount?: number | null;
     /**
-     * Seat spacing
+     * Spacing between seats in this row.
      * @min 1
      * @max 60
      */
     seatSpacing?: number | null;
-    /** Label position */
+    /** Position of labels relative to seats in this row (left, right, both sides, or none). // Position of labels relative to seats in this row. */
     labelPosition?: PositionWithLiterals;
-    /** Seat numbering */
+    /** Numbering scheme for seats in this row (numeric, alphabetical, or odd/even). */
     seatNumbering?: NumberingWithLiterals;
 }
+/** Configuration for labeling rows vertically in multi-row elements. */
 interface VerticalSequencing {
     /**
-     * First seq element
+     * Starting value for row labeling. For example, `A` for alphabetical sequences or `1` for numeric sequences.
      * @minLength 1
      * @maxLength 4
      */
     startAt?: string;
-    /** Row numbering */
+    /** Numbering scheme for row labels (numeric, alphabetical, or odd/even). */
     rowNumbering?: NumberingWithLiterals;
-    /** If true - direction bottom to top. Otherwise top to bottom. */
+    /** Whether to label rows in reverse order (bottom-to-top instead of top-to-bottom). */
     reverseOrder?: boolean | null;
 }
+/** A grouping mechanism for organizing places by pricing tier, access level, or other business criteria. */
 interface Category {
     /**
-     * Local category id within the seating plan
+     * Category ID. Must be unique within the seating plan.
      * @min 1
      */
     _id?: number;
     /**
-     * A client defined external id for cross referencing.
-     * Can reference external entities.
-     * Format: "{entity_fqdn}:{entity_id}"
+     * Client-defined external ID for cross-referencing with pricing or ticketing systems. Format: `{entity_fqdn}:{entity_id}`.
      * @minLength 1
      * @maxLength 100
      */
     externalId?: string | null;
     /**
-     * Category label
+     * Human-readable category name, such as `VIP`, `General Admission`, or `Student Discount`.
      * @minLength 1
      * @maxLength 120
      */
     title?: string;
     /**
-     * Client configuration object
+     * Client configuration object for storing additional category metadata. Read-only field maintained for backward compatibility.
      * @readonly
      */
     config?: Record<string, any> | null;
     /**
-     * Total capacity
+     * Total capacity of all places assigned to this category. Automatically calculated by summing place capacities.
      * @readonly
      */
     totalCapacity?: number | null;
     /**
-     * Possible places
+     * All places that are assigned to this category. Populated when using the CATEGORIES fieldset.
      * @maxSize 50000
      * @readonly
      */
@@ -1048,51 +1127,57 @@ interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
+/** Visual styling properties for the overall seating plan background and appearance. */
 interface SeatingPlanUiProperties {
     /**
-     * #F0F0F0
+     * Background color in hexadecimal format. For example, `#F0F0F0` for light gray.
      * @format COLOR_HEX
      */
     backgroundColor?: string | null;
-    /** @max 100 */
+    /**
+     * Background opacity as a percentage from 0 (transparent) to 100 (opaque).
+     * @max 100
+     */
     backgroundOpacity?: number | null;
 }
+/** A hierarchical grouping of elements for UI organization and bulk operations. */
 interface ElementGroup {
     /**
-     * Unique element group id
+     * Element group ID. Must be unique within the seating plan.
      * @min 1
      */
     _id?: number;
-    /** Parent group id */
+    /** ID of the parent group for creating nested group hierarchies. References another ElementGroup in the same seating plan. */
     parentElementGroupId?: number | null;
-    /** Element group UI settings */
+    /** Visual properties for rendering this group in the UI. Includes positioning and dimensions for the group container. */
     uiProperties?: ElementGroupUiProperties;
 }
+/** Visual positioning and styling properties for element groups. */
 interface ElementGroupUiProperties {
     /**
-     * x position of the group
+     * Horizontal position coordinate of the group container.
      * @min -1000000
      * @max 1000000
      */
     x?: number | null;
     /**
-     * y position of the group
+     * Vertical position coordinate of the group container.
      * @min -1000000
      * @max 1000000
      */
     y?: number | null;
     /**
-     * width of the group
+     * Width of the group bounding box in coordinate system units.
      * @max 1000000
      */
     width?: number | null;
     /**
-     * height of the group
+     * Height of the group bounding box in coordinate system units.
      * @max 1000000
      */
     height?: number | null;
     /**
-     * rotation angle of the group
+     * Rotation angle of the group in degrees. Applied to all elements within the group.
      * @min -180
      * @max 180
      */