@wix/auto_sdk_seatings_seating-reservation 1.0.0 → 1.0.2

package/build/cjs/src/seating-v1-seating-reservation-seating-reservation.types.d.ts

@@ -1,25 +1,35 @@
 export interface SeatingReservation {
     /**
      * The id of the reservation
+     * @format GUID
      * @readonly
      */
     id?: string | null;
     /**
      * The seating plan id
+     * @format GUID
      * @readonly
      */
     seatingPlanId?: string | null;
     /**
      * The external seating plan id
+     * @minLength 1
+     * @maxLength 100
      * @readonly
      */
     externalSeatingPlanId?: string | null;
-    /** Reserved places */
+    /**
+     * Reserved places
+     * @minSize 1
+     * @maxSize 100
+     */
     reservedPlaces?: PlaceReservation[];
     /**
      * A client defined external id for cross referencing.
      * Can reference external entities.
      * Format: "{fqdn}:{entity guid}"
+     * @minLength 1
+     * @maxLength 100
      */
     externalId?: string | null;
     /**
@@ -29,11 +39,17 @@ export interface SeatingReservation {
     revision?: string | null;
 }
 export interface PlaceReservation {
-    /** The place id. */
+    /**
+     * The place id.
+     * @minLength 5
+     * @maxLength 11
+     */
     id?: string;
     /**
      * Number of places in the spot. If not provided - defaults to 1.
      * Used to reserve for more that one place in areas.
+     * @min 1
+     * @max 50
      */
     capacity?: number | null;
     /**
@@ -63,11 +79,17 @@ export interface PlaceReservation {
     seatLabel?: string | null;
 }
 export interface SeatingPlanCategoriesSummaryUpdated {
-    /** Seating plan id */
+    /**
+     * Seating plan id
+     * @format GUID
+     */
     seatingPlanId?: string;
     /** External seating plan id */
     externalSeatingPlanId?: string | null;
-    /** Ticket counts by category */
+    /**
+     * Ticket counts by category
+     * @maxSize 100
+     */
     categories?: CategoryDetails[];
     /**
      * Summary revision.
@@ -78,16 +100,21 @@ export interface SeatingPlanCategoriesSummaryUpdated {
 export interface CategoryDetails {
     /**
      * Seating plan id
+     * @format GUID
      * @readonly
      */
     seatingPlanId?: string | null;
     /**
      * External seating plan id
+     * @minLength 1
+     * @maxLength 100
      * @readonly
      */
     externalSeatingPlanId?: string | null;
     /**
      * External category id
+     * @minLength 1
+     * @maxLength 100
      * @readonly
      */
     externalCategoryId?: string | null;
@@ -103,9 +130,15 @@ export interface CategoryDetails {
     reserved?: number | null;
 }
 export interface InvalidateCache extends InvalidateCacheGetByOneOf {
-    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     siteId?: string;
     /** Invalidate by App */
     app?: App;
@@ -115,7 +148,10 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
     uri?: URI;
     /** Invalidate by file (for media files such as PDFs) */
     file?: File;
-    /** tell us why you're invalidating the cache. You don't need to add your app name */
+    /**
+     * tell us why you're invalidating the cache. You don't need to add your app name
+     * @maxLength 256
+     */
     reason?: string | null;
     /** Is local DS */
     localDc?: boolean;
@@ -123,9 +159,15 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
 }
 /** @oneof */
 export interface InvalidateCacheGetByOneOf {
-    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     siteId?: string;
     /** Invalidate by App */
     app?: App;
@@ -137,27 +179,52 @@ export interface InvalidateCacheGetByOneOf {
     file?: File;
 }
 export interface App {
-    /** The AppDefId */
+    /**
+     * The AppDefId
+     * @minLength 1
+     */
     appDefId?: string;
-    /** The instance Id */
+    /**
+     * The instance Id
+     * @format GUID
+     */
     instanceId?: string;
 }
 export interface Page {
-    /** the msid the page is on */
+    /**
+     * the msid the page is on
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by Page ID */
+    /**
+     * Invalidate by Page ID
+     * @minLength 1
+     */
     pageId?: string;
 }
 export interface URI {
-    /** the msid the URI is on */
+    /**
+     * the msid the URI is on
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
+    /**
+     * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
+     * @minLength 1
+     */
     uriPath?: string;
 }
 export interface File {
-    /** the msid the file is related to */
+    /**
+     * the msid the file is related to
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by filename (for media files such as PDFs) */
+    /**
+     * Invalidate by filename (for media files such as PDFs)
+     * @minLength 1
+     * @maxLength 256
+     */
     fileName?: string;
 }
 export interface CreateSeatingReservationRequest {
@@ -169,13 +236,25 @@ export interface CreateSeatingReservationResponse {
     reservation?: SeatingReservation;
 }
 export interface Places {
-    /** Places */
+    /**
+     * Places
+     * @minSize 1
+     * @maxSize 100
+     */
     places?: string[];
 }
 export interface UnavailablePlaces {
-    /** Places that cannot be reserved */
+    /**
+     * Places that cannot be reserved
+     * @minSize 1
+     * @maxSize 100
+     */
     unavailablePlaces?: string[];
-    /** Reservation error details */
+    /**
+     * Reservation error details
+     * @minSize 1
+     * @maxSize 100
+     */
     reservationErrorDetails?: ReservationErrorDetails[];
 }
 export interface ReservationErrorDetails {
@@ -187,7 +266,10 @@ export interface ReservationErrorDetails {
     requested?: number;
 }
 export interface GetReservationRequest {
-    /** The id of the reservation to return */
+    /**
+     * The id of the reservation to return
+     * @format GUID
+     */
     id: string | null;
 }
 export interface GetReservationResponse {
@@ -228,7 +310,10 @@ export interface QueryV2PagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -244,13 +329,17 @@ export interface Paging {
     offset?: number | null;
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
      *
      * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
      * Not relevant for the first request.
+     * @maxLength 16000
      */
     cursor?: string | null;
 }
@@ -273,13 +362,22 @@ export interface PagingMetadataV2 {
     cursors?: Cursors;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface DeleteSeatingReservationRequest {
-    /** The id of the reservation to delete */
+    /**
+     * The id of the reservation to delete
+     * @format GUID
+     */
     id: string | null;
 }
 export interface DeleteSeatingReservationResponse {
@@ -289,15 +387,25 @@ export interface DeleteSeatingReservationResponse {
 export interface DeleteSeatingPlaceReservationRequest {
     /** The id of the place reservation to delete */
     id?: string | null;
-    /** The id of the place reservation's reservation */
+    /**
+     * The id of the place reservation's reservation
+     * @format GUID
+     */
     reservationId?: string | null;
 }
 export interface Empty {
 }
 export interface CancelSeatingPlaceReservationsRequest {
-    /** The id of the place reservations' reservation */
+    /**
+     * The id of the place reservations' reservation
+     * @format GUID
+     */
     reservationId?: string | null;
-    /** The place reservations to cancel */
+    /**
+     * The place reservations to cancel
+     * @minSize 1
+     * @maxSize 100
+     */
     placeReservations?: PlaceReservationDetails[];
 }
 export interface PlaceReservationDetails {
@@ -317,7 +425,10 @@ export interface UpdateSeatingReservationResponse {
     reservation?: SeatingReservation;
 }
 export interface GetReservedPlacesRequest {
-    /** Seating plan id */
+    /**
+     * Seating plan id
+     * @format GUID
+     */
     id?: string | null;
 }
 export interface GetReservedPlacesResponse {
@@ -325,24 +436,37 @@ export interface GetReservedPlacesResponse {
     placeReservations?: PlaceReservation[];
 }
 export interface GetSeatingCategorySummaryRequest {
-    /** Seating plan external id */
+    /**
+     * Seating plan external id
+     * @minLength 1
+     * @maxLength 100
+     */
     externalId?: string;
 }
 export interface GetSeatingCategorySummaryResponse {
-    /** Ticket counts by category */
+    /**
+     * Ticket counts by category
+     * @maxSize 50000
+     */
     categories?: CategoryDetails[];
 }
 export interface GetSeatingReservationSummaryRequest {
-    /** Seating plan external id */
+    /**
+     * Seating plan external id
+     * @minLength 1
+     * @maxLength 100
+     */
     externalId: string;
 }
 export interface GetSeatingReservationSummaryResponse {
     plan?: SeatingPlan;
+    /** @maxSize 50000 */
     places?: PlaceReservationDetails[];
 }
 export interface SeatingPlan {
     /**
      * Auto generated unique plan id
+     * @format GUID
      * @readonly
      */
     id?: string | null;
@@ -350,13 +474,25 @@ export interface SeatingPlan {
      * A client defined external id for cross referencing.
      * Can reference external entities.
      * Format: "{fqdn}:{entity guid}"
+     * @minLength 1
+     * @maxLength 100
      */
     externalId?: string | null;
-    /** Human friendly plan title */
+    /**
+     * Human friendly plan title
+     * @minLength 1
+     * @maxLength 120
+     */
     title?: string | null;
-    /** Sections of the plan. Seating plan is divided in high level sections. */
+    /**
+     * Sections of the plan. Seating plan is divided in high level sections.
+     * @maxSize 100
+     */
     sections?: Section[];
-    /** Categories for plan element grouping. */
+    /**
+     * Categories for plan element grouping.
+     * @maxSize 100
+     */
     categories?: Category[];
     /**
      * Seating plan created timestamp.
@@ -380,6 +516,7 @@ export interface SeatingPlan {
     totalCategories?: number | null;
     /**
      * Places not assigned to categories
+     * @maxSize 50000
      * @readonly
      */
     uncategorizedPlaces?: Place[];
@@ -392,20 +529,30 @@ export interface SeatingPlan {
     extendedFields?: ExtendedFields;
     /** Seating Plan UI settings */
     uiProperties?: SeatingPlanUiProperties;
-    /** Element groups */
+    /**
+     * Element groups
+     * @maxSize 1000
+     */
     elementGroups?: ElementGroup[];
 }
 export interface Section {
     /** Unique section id */
     id?: number;
-    /** Human readable section title */
+    /**
+     * Human readable section title
+     * @minLength 1
+     * @maxLength 20
+     */
     title?: string | null;
     /**
      * Client configuration object
      * @readonly
      */
     config?: Record<string, any> | null;
-    /** Elements of the section. */
+    /**
+     * Elements of the section.
+     * @maxSize 1000
+     */
     elements?: Element[];
     /**
      * Total capacity
@@ -419,22 +566,37 @@ export interface Section {
     default?: boolean;
 }
 export interface Element {
-    /** Unique element id */
+    /**
+     * Unique element id
+     * @min 1
+     */
     id?: number;
-    /** User friendly title/label of the element. */
+    /**
+     * User friendly title/label of the element.
+     * @minLength 1
+     * @maxLength 50
+     */
     title?: string | null;
     /** Element type */
     type?: Type;
-    /** Capacity. None for Shape type Element. */
+    /**
+     * Capacity. None for Shape type Element.
+     * @min 1
+     * @max 50000
+     */
     capacity?: number | null;
     /** Assigned to a category */
     categoryId?: number | null;
     /** A place numbering meta data */
     sequencing?: Sequencing;
-    /** Place override (by seq_id) */
+    /**
+     * Place override (by seq_id)
+     * @maxSize 2000
+     */
     overrides?: Place[];
     /**
      * Final place sequence with overrides
+     * @maxSize 200
      * @readonly
      */
     places?: Place[];
@@ -456,9 +618,16 @@ export declare enum Type {
     SHAPE = "SHAPE"
 }
 export interface Sequencing {
-    /** First seq element */
+    /**
+     * First seq element
+     * @minLength 1
+     * @maxLength 4
+     */
     startAt?: string;
-    /** Finite generated seq of labels */
+    /**
+     * Finite generated seq of labels
+     * @maxSize 2500
+     */
     labels?: string[];
     /** If true - direction right to left. Otherwise left to right. */
     reverseOrder?: boolean | null;
@@ -471,7 +640,11 @@ export interface Place {
      * @readonly
      */
     id?: string | null;
-    /** Unique label of the place */
+    /**
+     * Unique label of the place
+     * @minLength 1
+     * @maxLength 4
+     */
     label?: string;
     /**
      * Max capacity per place
@@ -505,30 +678,76 @@ export interface ReservationOptions {
     reserveWholeElement?: boolean;
 }
 export interface ElementUiProperties {
+    /**
+     * @min -1000000
+     * @max 1000000
+     */
     x?: number | null;
+    /**
+     * @min -1000000
+     * @max 1000000
+     */
     y?: number | null;
+    /**
+     * @min -1000000
+     * @max 1000000
+     */
     zIndex?: number | null;
+    /** @max 1000000 */
     width?: number | null;
+    /** @max 1000000 */
     height?: number | null;
+    /**
+     * @min -180
+     * @max 180
+     */
     rotationAngle?: number | null;
     shapeType?: ShapeTypeEnumType;
+    /**
+     * @min 10
+     * @max 176
+     */
     fontSize?: number | null;
+    /** @max 1000000 */
     cornerRadius?: number | null;
+    /**
+     * @min 1
+     * @max 60
+     */
     seatSpacing?: number | null;
     hideLabel?: boolean | null;
     labelPosition?: Position;
     seatLayout?: number[];
+    /** @max 50 */
     emptyTopSeatSpaces?: number | null;
-    /** needs research */
+    /**
+     * needs research
+     * @minLength 1
+     * @maxLength 10000
+     */
     text?: string | null;
-    /** #F0F0F0 */
+    /**
+     * #F0F0F0
+     * @format COLOR_HEX
+     */
     color?: string | null;
-    /** #F0F0F0 */
+    /**
+     * #F0F0F0
+     * @format COLOR_HEX
+     */
     fillColor?: string | null;
-    /** #F0F0F0 */
+    /**
+     * #F0F0F0
+     * @format COLOR_HEX
+     */
     strokeColor?: string | null;
-    /** px */
+    /**
+     * px
+     * @min 1
+     * @max 6
+     */
     strokeWidth?: number | null;
+    /** @max 100 */
     opacity?: number | null;
     icon?: Icon;
     image?: Image;
@@ -591,21 +810,42 @@ export declare enum Numbering {
     ALPHABETICAL = "ALPHABETICAL"
 }
 export interface MultiRowProperties {
-    /** Individual rows of the multi row element */
+    /**
+     * Individual rows of the multi row element
+     * @maxSize 1000
+     */
     rows?: RowElement[];
     /** Meta data for vertical labeling */
     verticalSequencing?: VerticalSequencing;
-    /** Row spacing */
+    /**
+     * Row spacing
+     * @min 1
+     * @max 60
+     */
     rowSpacing?: number | null;
-    /** Amount of seats in the row */
+    /**
+     * Amount of seats in the row
+     * @max 50
+     */
     seatAmount?: number | null;
 }
 export interface RowElement {
-    /** Unique row id */
+    /**
+     * Unique row id
+     * @min 1
+     */
     id?: number;
-    /** User friendly title/label of the row */
+    /**
+     * User friendly title/label of the row
+     * @minLength 1
+     * @maxLength 50
+     */
     title?: string | null;
-    /** Row capacity */
+    /**
+     * Row capacity
+     * @min 1
+     * @max 50000
+     */
     capacity?: number | null;
     /** Assigned to a category */
     categoryId?: number | null;
@@ -615,13 +855,27 @@ export interface RowElement {
     uiProperties?: RowElementUiProperties;
 }
 export interface RowElementUiProperties {
-    /** Relative x position to the parent element */
+    /**
+     * Relative x position to the parent element
+     * @min -1000000
+     * @max 1000000
+     */
     relativeX?: number | null;
-    /** Width of the row */
+    /**
+     * Width of the row
+     * @max 1000000
+     */
     width?: number | null;
-    /** Amount of seats in the row */
+    /**
+     * Amount of seats in the row
+     * @max 50
+     */
     seatAmount?: number | null;
-    /** Seat spacing */
+    /**
+     * Seat spacing
+     * @min 1
+     * @max 60
+     */
     seatSpacing?: number | null;
     /** Label position */
     labelPosition?: Position;
@@ -629,7 +883,11 @@ export interface RowElementUiProperties {
     seatNumbering?: Numbering;
 }
 export interface VerticalSequencing {
-    /** First seq element */
+    /**
+     * First seq element
+     * @minLength 1
+     * @maxLength 4
+     */
     startAt?: string;
     /** Row numbering */
     rowNumbering?: Numbering;
@@ -637,15 +895,24 @@ export interface VerticalSequencing {
     reverseOrder?: boolean | null;
 }
 export interface Category {
-    /** Local category id within the seating plan */
+    /**
+     * Local category id 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}"
+     * @minLength 1
+     * @maxLength 100
      */
     externalId?: string | null;
-    /** Category label */
+    /**
+     * Category label
+     * @minLength 1
+     * @maxLength 120
+     */
     title?: string;
     /**
      * Client configuration object
@@ -659,6 +926,7 @@ export interface Category {
     totalCapacity?: number | null;
     /**
      * Possible places
+     * @maxSize 50000
      * @readonly
      */
     places?: Place[];
@@ -675,12 +943,19 @@ export interface ExtendedFields {
     namespaces?: Record<string, Record<string, any>>;
 }
 export interface SeatingPlanUiProperties {
-    /** #F0F0F0 */
+    /**
+     * #F0F0F0
+     * @format COLOR_HEX
+     */
     backgroundColor?: string | null;
+    /** @max 100 */
     backgroundOpacity?: number | null;
 }
 export interface ElementGroup {
-    /** Unique element group id */
+    /**
+     * Unique element group id
+     * @min 1
+     */
     id?: number;
     /** Parent group id */
     parentElementGroupId?: number | null;
@@ -688,26 +963,49 @@ export interface ElementGroup {
     uiProperties?: ElementGroupUiProperties;
 }
 export interface ElementGroupUiProperties {
-    /** x position of the group */
+    /**
+     * x position of the group
+     * @min -1000000
+     * @max 1000000
+     */
     x?: number | null;
-    /** y position of the group */
+    /**
+     * y position of the group
+     * @min -1000000
+     * @max 1000000
+     */
     y?: number | null;
-    /** width of the group */
+    /**
+     * width of the group
+     * @max 1000000
+     */
     width?: number | null;
-    /** height of the group */
+    /**
+     * height of the group
+     * @max 1000000
+     */
     height?: number | null;
-    /** rotation angle of the group */
+    /**
+     * rotation angle of the group
+     * @min -180
+     * @max 180
+     */
     rotationAngle?: number | null;
 }
 export interface RegenerateSummariesRequest {
-    /** Seating plan id */
+    /**
+     * Seating plan id
+     * @format GUID
+     */
     planId?: string | null;
 }
 export interface RegenerateSummariesResponse {
     seatingReservationsSummary?: SeatingReservationsSummary;
+    /** @maxSize 50000 */
     categories?: CategoryDetails[];
 }
 export interface SeatingReservationsSummary {
+    /** @maxSize 50000 */
     places?: PlaceReservationDetails[];
 }
 export interface DomainEvent extends DomainEventBodyOneOf {
@@ -783,9 +1081,15 @@ export interface ActionEvent {
     bodyAsJson?: string;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -793,26 +1097,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {