@wix/auto_sdk_seatings_seating-plan 1.0.20 → 1.0.22

package/build/cjs/index.d.ts

@@ -5,9 +5,9 @@ export { ActionEvent, BaseEventMetadata, CapacityExceededViolation, Category, Co
 declare function createSeatingPlan$1(httpClient: HttpClient): CreateSeatingPlanSignature;
 interface CreateSeatingPlanSignature {
     /**
-     * Crates a seating plan
-     * @param - A plan to be created
-     * @returns The created plan
+     * Creates a new seating plan with sections, elements, and categories. The system automatically generates places based on element configurations and calculates capacity totals.
+     * @param - Seating plan to create. Must include at least one section with `id = 0` as the default section.
+     * @returns Created seating plan with generated ID, timestamps, and calculated totals.
      */
     (plan: NonNullablePaths<SeatingPlan, `sections.${number}.elements.${number}.title` | `title`, 6>): Promise<NonNullablePaths<SeatingPlan, `sections` | `sections.${number}._id` | `sections.${number}.default` | `categories` | `categories.${number}._id` | `categories.${number}.title` | `uncategorizedPlaces` | `elementGroups` | `elementGroups.${number}._id`, 4> & {
         __applicationErrorsType?: CreateSeatingPlanApplicationErrors;
@@ -16,8 +16,8 @@ interface CreateSeatingPlanSignature {
 declare function updateSeatingPlan$1(httpClient: HttpClient): UpdateSeatingPlanSignature;
 interface UpdateSeatingPlanSignature {
     /**
-     * Updates the seating plan
-     * @returns The updated plan
+     * Updates an existing seating plan. Changes trigger recalculation of places, capacities, and version increment. Use field masks to update specific portions of the plan.
+     * @returns Updated seating plan with incremented version and recalculated totals.
      */
     (options?: NonNullablePaths<UpdateSeatingPlanOptions, `plan._id` | `plan.sections.${number}.elements.${number}.title`, 7>): Promise<NonNullablePaths<SeatingPlan, `sections` | `sections.${number}._id` | `sections.${number}.default` | `categories` | `categories.${number}._id` | `categories.${number}.title` | `uncategorizedPlaces` | `elementGroups` | `elementGroups.${number}._id`, 4> & {
         __applicationErrorsType?: UpdateSeatingPlanApplicationErrors;
@@ -26,54 +26,56 @@ interface UpdateSeatingPlanSignature {
 declare function copySeatingPlan$1(httpClient: HttpClient): CopySeatingPlanSignature;
 interface CopySeatingPlanSignature {
     /**
-     * Copies the seating plan
-     * @param - The id of the plan to be copied
+     * Creates a copy of an existing seating plan with a new title and external ID. Useful for reusing venue layouts across multiple events.
+     * @param - ID of the seating plan to be copied.
      */
     (_id: string, options: NonNullablePaths<CopySeatingPlanOptions, `externalId` | `title`, 2>): Promise<NonNullablePaths<CopySeatingPlanResponse, `plan.sections` | `plan.sections.${number}._id` | `plan.sections.${number}.default` | `plan.categories` | `plan.categories.${number}._id` | `plan.categories.${number}.title` | `plan.uncategorizedPlaces` | `plan.elementGroups` | `plan.elementGroups.${number}._id`, 5>>;
 }
 declare function querySeatingPlan$1(httpClient: HttpClient): QuerySeatingPlanSignature;
 interface QuerySeatingPlanSignature {
     /**
-     * Lists seating plans by provided query request
+     * Retrieves multiple seating plans based on filter criteria. Supports fieldset projections to control response size and improve performance.
      */
     (options?: QuerySeatingPlanOptions): PlansQueryBuilder;
 }
 declare function getSeatingPlan$1(httpClient: HttpClient): GetSeatingPlanSignature;
 interface GetSeatingPlanSignature {
     /**
-     * Returns the seating plan. Fails of not fond.
-     * @param - The id of the plan
-     * @returns The plan
+     * Retrieves a specific seating plan by ID. Supports fieldset projections and place filtering via SeatingPlanMask for targeted queries.
+     * @param - Seating plan ID to retrieve.
+     * @returns Retrieved seating plan with requested fieldsets and filtered places.
      */
     (_id: string, options?: GetSeatingPlanOptions): Promise<NonNullablePaths<SeatingPlan, `sections` | `sections.${number}._id` | `sections.${number}.default` | `categories` | `categories.${number}._id` | `categories.${number}.title` | `uncategorizedPlaces` | `elementGroups` | `elementGroups.${number}._id`, 4>>;
 }
 declare function findSeatingPlan$1(httpClient: HttpClient): FindSeatingPlanSignature;
 interface FindSeatingPlanSignature {
     /**
-     * Returns the first seating plan found by filter request.
-     * @param - The filter of the plan
+     * Finds the first seating plan matching the specified filter criteria. Useful for locating plans by external ID or other properties.
+     * @param - Filter criteria for finding the seating plan. Use standard WQL filter format.
      */
     (filter: Record<string, any>, options?: FindSeatingPlanOptions): Promise<NonNullablePaths<FindSeatingPlanResponse, `plan.sections` | `plan.sections.${number}._id` | `plan.sections.${number}.default` | `plan.categories` | `plan.categories.${number}._id` | `plan.categories.${number}.title` | `plan.uncategorizedPlaces` | `plan.elementGroups` | `plan.elementGroups.${number}._id`, 5>>;
 }
 declare function deleteSeatingPlan$1(httpClient: HttpClient): DeleteSeatingPlanSignature;
 interface DeleteSeatingPlanSignature {
     /**
-     * Deletes the seating plan.
-     * @param - The id of the plan
+     * Deletes a seating plan and all its associated data including sections, elements, places, and version history.
+     * @param - ID of the seating plan to delete.
      */
     (_id: string): Promise<NonNullablePaths<DeleteSeatingPlanResponse, `plan.sections` | `plan.sections.${number}._id` | `plan.sections.${number}.default` | `plan.categories` | `plan.categories.${number}._id` | `plan.categories.${number}.title` | `plan.uncategorizedPlaces` | `plan.elementGroups` | `plan.elementGroups.${number}._id`, 5>>;
 }
 declare function updateSeatingPlanThumbnail$1(httpClient: HttpClient): UpdateSeatingPlanThumbnailSignature;
 interface UpdateSeatingPlanThumbnailSignature {
     /**
-     * Updates seating plan thumbnail.
+     * Thumbnails provide visual previews of seating layouts for selection and management interfaces.
+     * @param - Thumbnail to update with new image data.
      */
     (thumbnail: NonNullablePaths<SeatingPlanThumbnail, `_id` | `img`, 2>): Promise<UpdateSeatingPlanThumbnailResponse>;
 }
 declare function getSeatingPlanThumbnail$1(httpClient: HttpClient): GetSeatingPlanThumbnailSignature;
 interface GetSeatingPlanThumbnailSignature {
     /**
-     * Get seating plan thumbnail.
+     * Returns the current thumbnail or empty response if no thumbnail has been set.
+     * @param - Seating plan ID to retrieve thumbnail for.
      */
     (_id: string): Promise<GetSeatingPlanThumbnailResponse>;
 }

package/build/cjs/index.js

@@ -250,6 +250,9 @@ function createSeatingPlan(payload) {
       method: "POST",
       methodFqn: "com.wixpress.seating.SeatingPlanManagement.CreateSeatingPlan",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressSeatingSeatingPlanManagementUrl({
         protoPath: "/v1/plans",
         data: serializedData,
@@ -346,6 +349,9 @@ function updateSeatingPlan(payload) {
       method: "PUT",
       methodFqn: "com.wixpress.seating.SeatingPlanManagement.UpdateSeatingPlan",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressSeatingSeatingPlanManagementUrl({
         protoPath: "/v1/plans",
         data: serializedData,
@@ -403,6 +409,9 @@ function copySeatingPlan(payload) {
       method: "POST",
       methodFqn: "com.wixpress.seating.SeatingPlanManagement.CopySeatingPlan",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressSeatingSeatingPlanManagementUrl({
         protoPath: "/v1/plans/copy",
         data: payload,
@@ -460,6 +469,9 @@ function querySeatingPlan(payload) {
       method: "POST",
       methodFqn: "com.wixpress.seating.SeatingPlanManagement.QuerySeatingPlan",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressSeatingSeatingPlanManagementUrl({
         protoPath: "/v1/plans/query",
         data: payload,
@@ -520,6 +532,9 @@ function getSeatingPlan(payload) {
       method: "GET",
       methodFqn: "com.wixpress.seating.SeatingPlanManagement.GetSeatingPlan",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressSeatingSeatingPlanManagementUrl({
         protoPath: "/v1/plans/{id}",
         data: payload,
@@ -577,6 +592,9 @@ function findSeatingPlan(payload) {
       method: "POST",
       methodFqn: "com.wixpress.seating.SeatingPlanManagement.FindSeatingPlan",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressSeatingSeatingPlanManagementUrl({
         protoPath: "/v1/plans/find",
         data: payload,
@@ -634,6 +652,9 @@ function deleteSeatingPlan(payload) {
       method: "DELETE",
       methodFqn: "com.wixpress.seating.SeatingPlanManagement.DeleteSeatingPlan",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressSeatingSeatingPlanManagementUrl({
         protoPath: "/v1/plans/{id}",
         data: payload,
@@ -691,6 +712,9 @@ function updateSeatingPlanThumbnail(payload) {
       method: "POST",
       methodFqn: "com.wixpress.seating.SeatingPlanThumbnailService.UpdateSeatingPlanThumbnail",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressSeatingSeatingPlanThumbnailServiceUrl({
         protoPath: "/v1/plan-thumbnails",
         data: payload,
@@ -709,6 +733,9 @@ function getSeatingPlanThumbnail(payload) {
       method: "GET",
       methodFqn: "com.wixpress.seating.SeatingPlanThumbnailService.GetSeatingPlanThumbnail",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveComWixpressSeatingSeatingPlanThumbnailServiceUrl({
         protoPath: "/v1/plan-thumbnails",
         data: payload,