@wix/auto_sdk_seatings_seating-plan 1.0.39 → 1.0.41

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

@@ -1,4 +1,4 @@
-import { NonNullablePaths } from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
 
 /** 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 {
@@ -1140,8 +1140,6 @@ interface SeatingPlanCreatedEnvelope {
 }
 /** @permissionScope Manage Events
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionId SEATING_PLANS.READ_SEATING_PLANS
  * @webhook
  * @eventType wix.seating.v1.seating_plan_created
@@ -1155,8 +1153,6 @@ interface SeatingPlanDeletedEnvelope {
 }
 /** @permissionScope Manage Events
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionId SEATING_PLANS.READ_SEATING_PLANS
  * @webhook
  * @eventType wix.seating.v1.seating_plan_deleted
@@ -1170,8 +1166,6 @@ interface SeatingPlanUpdatedEnvelope {
 }
 /** @permissionScope Manage Events
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionId SEATING_PLANS.READ_SEATING_PLANS
  * @webhook
  * @eventType wix.seating.v1.seating_plan_updated
@@ -1287,7 +1281,54 @@ interface PlansQueryBuilder {
  * @requiredField query
  * @returns Response containing matching seating plans.
  */
-declare function typedQuerySeatingPlan(query: QueryV2, options?: QuerySeatingPlanOptions): Promise<NonNullablePaths<QuerySeatingPlanResponse, `plans`, 2>>;
+declare function typedQuerySeatingPlan(query: SeatingPlanQuery, options?: QuerySeatingPlanOptions): Promise<NonNullablePaths<QuerySeatingPlanResponse, `plans`, 2>>;
+interface SeatingPlanQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [];
+}
+type CommonQueryWithEntityContext = Query<SeatingPlan, SeatingPlanQuerySpec>;
+type SeatingPlanQuery = {
+    /**
+    Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.
+    */
+    cursorPaging?: {
+        /**
+      Maximum number of items to return in the results.
+      @max: 100
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | 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?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+  
+    Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object.
+  
+    Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
 /**
  * Retrieves a specific seating plan by ID. Supports fieldset projections and place filtering via SeatingPlanMask for targeted queries.
  * @param _id - Seating plan ID to retrieve.
@@ -1375,4 +1416,4 @@ declare function updateSeatingPlanThumbnail(thumbnail: NonNullablePaths<SeatingP
  */
 declare function getSeatingPlanThumbnail(_id: string): Promise<GetSeatingPlanThumbnailResponse>;
 
-export { type ActionEvent, type BaseEventMetadata, type CapacityExceededViolation, type Category, type CopySeatingPlanOptions, type CopySeatingPlanRequest, type CopySeatingPlanResponse, type CreateSeatingPlanApplicationErrors, type CreateSeatingPlanRequest, type CreateSeatingPlanResponse, type CursorPaging, type Cursors, type DeleteSeatingPlanRequest, type DeleteSeatingPlanResponse, type DiscardSeatingPlanVersionsRequest, type DiscardSeatingPlanVersionsResponse, type DomainEvent, type DomainEventBodyOneOf, type Element, type ElementGroup, type ElementGroupUiProperties, type ElementUiProperties, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, Fieldset, type FieldsetWithLiterals, type FindSeatingPlanOptions, type FindSeatingPlanRequest, type FindSeatingPlanResponse, type GetSeatingPlanOptions, type GetSeatingPlanRequest, type GetSeatingPlanResponse, type GetSeatingPlanThumbnailRequest, type GetSeatingPlanThumbnailResponse, Icon, type IconWithLiterals, type IdentificationData, type IdentificationDataIdOneOf, type Image, type MessageEnvelope, type MultiRowProperties, Numbering, type NumberingWithLiterals, type Paging, type PagingMetadataV2, type Place, PlaceTypeEnumType, type PlaceTypeEnumTypeWithLiterals, type PlansQueryBuilder, type PlansQueryResult, Position, type PositionWithLiterals, type QuerySeatingPlanOptions, type QuerySeatingPlanRequest, type QuerySeatingPlanResponse, type QuerySeatingPlanVersionsRequest, type QuerySeatingPlanVersionsResponse, type QueryV2, type QueryV2PagingMethodOneOf, type ReservationOptions, type RestoreInfo, type RestoreSeatingPlanRequest, type RestoreSeatingPlanResponse, type RowElement, type RowElementUiProperties, type SaveSeatingPlanVersionRequest, type SaveSeatingPlanVersionResponse, type SeatingPlan, type SeatingPlanCreatedEnvelope, type SeatingPlanDeletedEnvelope, type SeatingPlanMask, type SeatingPlanThumbnail, type SeatingPlanUiProperties, type SeatingPlanUpdatedEnvelope, type Section, type Sequencing, ShapeTypeEnumType, type ShapeTypeEnumTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Type, type TypeWithLiterals, type UpdateSeatingPlanApplicationErrors, type UpdateSeatingPlanOptions, type UpdateSeatingPlanRequest, type UpdateSeatingPlanResponse, type UpdateSeatingPlanThumbnailRequest, type UpdateSeatingPlanThumbnailResponse, type VerticalSequencing, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, copySeatingPlan, createSeatingPlan, deleteSeatingPlan, findSeatingPlan, getSeatingPlan, getSeatingPlanThumbnail, onSeatingPlanCreated, onSeatingPlanDeleted, onSeatingPlanUpdated, querySeatingPlan, typedQuerySeatingPlan, updateSeatingPlan, updateSeatingPlanThumbnail };
+export { type ActionEvent, type BaseEventMetadata, type CapacityExceededViolation, type Category, type CommonQueryWithEntityContext, type CopySeatingPlanOptions, type CopySeatingPlanRequest, type CopySeatingPlanResponse, type CreateSeatingPlanApplicationErrors, type CreateSeatingPlanRequest, type CreateSeatingPlanResponse, type CursorPaging, type Cursors, type DeleteSeatingPlanRequest, type DeleteSeatingPlanResponse, type DiscardSeatingPlanVersionsRequest, type DiscardSeatingPlanVersionsResponse, type DomainEvent, type DomainEventBodyOneOf, type Element, type ElementGroup, type ElementGroupUiProperties, type ElementUiProperties, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, Fieldset, type FieldsetWithLiterals, type FindSeatingPlanOptions, type FindSeatingPlanRequest, type FindSeatingPlanResponse, type GetSeatingPlanOptions, type GetSeatingPlanRequest, type GetSeatingPlanResponse, type GetSeatingPlanThumbnailRequest, type GetSeatingPlanThumbnailResponse, Icon, type IconWithLiterals, type IdentificationData, type IdentificationDataIdOneOf, type Image, type MessageEnvelope, type MultiRowProperties, Numbering, type NumberingWithLiterals, type Paging, type PagingMetadataV2, type Place, PlaceTypeEnumType, type PlaceTypeEnumTypeWithLiterals, type PlansQueryBuilder, type PlansQueryResult, Position, type PositionWithLiterals, type QuerySeatingPlanOptions, type QuerySeatingPlanRequest, type QuerySeatingPlanResponse, type QuerySeatingPlanVersionsRequest, type QuerySeatingPlanVersionsResponse, type QueryV2, type QueryV2PagingMethodOneOf, type ReservationOptions, type RestoreInfo, type RestoreSeatingPlanRequest, type RestoreSeatingPlanResponse, type RowElement, type RowElementUiProperties, type SaveSeatingPlanVersionRequest, type SaveSeatingPlanVersionResponse, type SeatingPlan, type SeatingPlanCreatedEnvelope, type SeatingPlanDeletedEnvelope, type SeatingPlanMask, type SeatingPlanQuery, type SeatingPlanQuerySpec, type SeatingPlanThumbnail, type SeatingPlanUiProperties, type SeatingPlanUpdatedEnvelope, type Section, type Sequencing, ShapeTypeEnumType, type ShapeTypeEnumTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Type, type TypeWithLiterals, type UpdateSeatingPlanApplicationErrors, type UpdateSeatingPlanOptions, type UpdateSeatingPlanRequest, type UpdateSeatingPlanResponse, type UpdateSeatingPlanThumbnailRequest, type UpdateSeatingPlanThumbnailResponse, type VerticalSequencing, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, copySeatingPlan, createSeatingPlan, deleteSeatingPlan, findSeatingPlan, getSeatingPlan, getSeatingPlanThumbnail, onSeatingPlanCreated, onSeatingPlanDeleted, onSeatingPlanUpdated, querySeatingPlan, typedQuerySeatingPlan, updateSeatingPlan, updateSeatingPlanThumbnail };