@wix/auto_sdk_seatings_seating-plan 1.0.10 → 1.0.12

package/build/cjs/{seating-v1-seating-plan-seating-plan.universal-Ctm431no.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface SeatingPlan {
     /**
      * Auto generated unique plan id
@@ -974,6 +976,20 @@ interface GetSeatingPlanThumbnailRequest {
 interface GetSeatingPlanThumbnailResponse {
     thumbnail?: SeatingPlanThumbnail;
 }
+type CreateSeatingPlanApplicationErrors = {
+    code?: 'PLAN_MAX_CAPACITY_EXCEEDED';
+    description?: string;
+    data?: CapacityExceededViolation;
+} | {
+    code?: 'ELEMENT_MAX_CAPACITY_EXCEEDED';
+    description?: string;
+    data?: CapacityExceededViolation;
+};
+type UpdateSeatingPlanApplicationErrors = {
+    code?: 'INVALID_FIELD_MASK';
+    description?: string;
+    data?: Record<string, any>;
+};
 interface BaseEventMetadata {
     /**
      * App instance ID.
@@ -1022,20 +1038,94 @@ interface SeatingPlanCreatedEnvelope {
     entity: SeatingPlan;
     metadata: EventMetadata;
 }
+/** @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId SEATING_PLANS.READ_SEATING_PLANS
+ * @webhook
+ * @eventType wix.seating.v1.seating_plan_created
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onSeatingPlanCreated(handler: (event: SeatingPlanCreatedEnvelope) => void | Promise<void>): void;
 interface SeatingPlanDeletedEnvelope {
     entity: SeatingPlan;
     metadata: EventMetadata;
 }
+/** @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId SEATING_PLANS.READ_SEATING_PLANS
+ * @webhook
+ * @eventType wix.seating.v1.seating_plan_deleted
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+declare function onSeatingPlanDeleted(handler: (event: SeatingPlanDeletedEnvelope) => void | Promise<void>): void;
 interface SeatingPlanUpdatedEnvelope {
     entity: SeatingPlan;
     metadata: EventMetadata;
 }
+/** @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId SEATING_PLANS.READ_SEATING_PLANS
+ * @webhook
+ * @eventType wix.seating.v1.seating_plan_updated
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onSeatingPlanUpdated(handler: (event: SeatingPlanUpdatedEnvelope) => void | Promise<void>): void;
+type SeatingPlanNonNullablePaths = `sections` | `sections.${number}._id` | `sections.${number}.default` | `categories` | `categories.${number}._id` | `categories.${number}.title` | `uncategorizedPlaces` | `uncategorizedPlaces.${number}.index` | `uncategorizedPlaces.${number}.label` | `uncategorizedPlaces.${number}.elementType` | `uncategorizedPlaces.${number}.type` | `elementGroups` | `elementGroups.${number}._id`;
+/**
+ * Crates a seating plan
+ * @param plan - A plan to be created
+ * @public
+ * @documentationMaturity preview
+ * @requiredField plan
+ * @requiredField plan.sections.elements.title
+ * @requiredField plan.title
+ * @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
+ * @applicableIdentity APP
+ * @returns The created plan
+ * @fqn com.wixpress.seating.SeatingPlanManagement.CreateSeatingPlan
+ */
+declare function createSeatingPlan(plan: NonNullablePaths<SeatingPlan, `sections.${number}.elements.${number}.title` | `title`>): Promise<NonNullablePaths<SeatingPlan, SeatingPlanNonNullablePaths> & {
+    __applicationErrorsType?: CreateSeatingPlanApplicationErrors;
+}>;
+/**
+ * Updates the seating plan
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.plan._id
+ * @requiredField options.plan.sections.elements.title
+ * @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
+ * @applicableIdentity APP
+ * @returns The updated plan
+ * @fqn com.wixpress.seating.SeatingPlanManagement.UpdateSeatingPlan
+ */
+declare function updateSeatingPlan(options?: NonNullablePaths<UpdateSeatingPlanOptions, `plan._id` | `plan.sections.${number}.elements.${number}.title`>): Promise<NonNullablePaths<SeatingPlan, SeatingPlanNonNullablePaths> & {
+    __applicationErrorsType?: UpdateSeatingPlanApplicationErrors;
+}>;
 interface UpdateSeatingPlanOptions {
     /** The plan updates */
     plan?: SeatingPlan;
     /** A set of field paths, specifying which parts of seating plan to update */
     fields?: string[];
 }
+/**
+ * Copies the seating plan
+ * @param _id - The id of the plan to be copied
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField options
+ * @requiredField options.externalId
+ * @requiredField options.title
+ * @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.seating.SeatingPlanManagement.CopySeatingPlan
+ */
+declare function copySeatingPlan(_id: string, options: NonNullablePaths<CopySeatingPlanOptions, `externalId` | `title`>): Promise<NonNullablePaths<CopySeatingPlanResponse, {
+    [P in SeatingPlanNonNullablePaths]: `plan.${P}`;
+}[SeatingPlanNonNullablePaths]>>;
 interface CopySeatingPlanOptions {
     /**
      * New plan title
@@ -1050,6 +1140,16 @@ interface CopySeatingPlanOptions {
      */
     externalId: string | null;
 }
+/**
+ * Lists seating plans by provided query request
+ * @public
+ * @documentationMaturity preview
+ * @permissionId SEATING_PLANS.READ_SEATING_PLANS
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.seating.SeatingPlanManagement.QuerySeatingPlan
+ */
+declare function querySeatingPlan(options?: QuerySeatingPlanOptions): PlansQueryBuilder;
 interface QuerySeatingPlanOptions {
     /** A fieldset for the response */
     fieldset?: FieldsetWithLiterals[] | undefined;
@@ -1079,6 +1179,19 @@ interface PlansQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<PlansQueryResult>;
 }
+/**
+ * Returns the seating plan. Fails of not fond.
+ * @param _id - The id of the plan
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId SEATING_PLANS.READ_SEATING_PLANS
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @returns The plan
+ * @fqn com.wixpress.seating.SeatingPlanManagement.GetSeatingPlan
+ */
+declare function getSeatingPlan(_id: string, options?: GetSeatingPlanOptions): Promise<NonNullablePaths<SeatingPlan, SeatingPlanNonNullablePaths>>;
 interface GetSeatingPlanOptions {
     /**
      * A fieldset for the response
@@ -1093,6 +1206,20 @@ interface GetSeatingPlanOptions {
     /** Seating Plan Mask */
     seatingPlanMask?: SeatingPlanMask;
 }
+/**
+ * Returns the first seating plan found by filter request.
+ * @param filter - The filter of the plan
+ * @public
+ * @documentationMaturity preview
+ * @requiredField filter
+ * @permissionId SEATING_PLANS.READ_SEATING_PLANS
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.seating.SeatingPlanManagement.FindSeatingPlan
+ */
+declare function findSeatingPlan(filter: Record<string, any>, options?: FindSeatingPlanOptions): Promise<NonNullablePaths<FindSeatingPlanResponse, {
+    [P in SeatingPlanNonNullablePaths]: `plan.${P}`;
+}[SeatingPlanNonNullablePaths]>>;
 interface FindSeatingPlanOptions {
     /**
      * A fieldset for the response
@@ -1107,5 +1234,40 @@ interface FindSeatingPlanOptions {
     /** Seating Plan Mask */
     seatingPlanMask?: SeatingPlanMask;
 }
+/**
+ * Deletes the seating plan.
+ * @param _id - The id of the plan
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.seating.SeatingPlanManagement.DeleteSeatingPlan
+ */
+declare function deleteSeatingPlan(_id: string): Promise<NonNullablePaths<DeleteSeatingPlanResponse, {
+    [P in SeatingPlanNonNullablePaths]: `plan.${P}`;
+}[SeatingPlanNonNullablePaths]>>;
+/**
+ * Updates seating plan thumbnail.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField thumbnail
+ * @requiredField thumbnail._id
+ * @requiredField thumbnail.img
+ * @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.seating.SeatingPlanThumbnailService.UpdateSeatingPlanThumbnail
+ */
+declare function updateSeatingPlanThumbnail(thumbnail: NonNullablePaths<SeatingPlanThumbnail, `_id` | `img`>): Promise<UpdateSeatingPlanThumbnailResponse>;
+/**
+ * Get seating plan thumbnail.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.seating.SeatingPlanThumbnailService.GetSeatingPlanThumbnail
+ */
+declare function getSeatingPlanThumbnail(_id: string): Promise<GetSeatingPlanThumbnailResponse>;
 
-export { type QuerySeatingPlanResponse as $, type CreateSeatingPlanResponse as A, type CapacityExceededViolation as B, type CopySeatingPlanOptions as C, type DeleteSeatingPlanResponse as D, type Element as E, type FindSeatingPlanOptions as F, type GetSeatingPlanOptions as G, type UpdateSeatingPlanRequest as H, Icon as I, type UpdateSeatingPlanResponse as J, type CopySeatingPlanRequest as K, type QuerySeatingPlanRequest as L, type MultiRowProperties as M, Numbering as N, type QueryV2 as O, type PlansQueryBuilder as P, type QuerySeatingPlanOptions as Q, type ReservationOptions as R, type SeatingPlan as S, Type as T, type UpdateSeatingPlanOptions as U, type VerticalSequencing as V, WebhookIdentityType as W, type QueryV2PagingMethodOneOf as X, type Sorting as Y, type Paging as Z, type CursorPaging as _, type CopySeatingPlanResponse as a, type GetSeatingPlanRequest as a0, type SeatingPlanMask as a1, type GetSeatingPlanResponse as a2, type FindSeatingPlanRequest as a3, type DeleteSeatingPlanRequest as a4, type DomainEvent as a5, type DomainEventBodyOneOf as a6, type EntityCreatedEvent as a7, type RestoreInfo as a8, type EntityUpdatedEvent as a9, type EntityDeletedEvent as aa, type ActionEvent as ab, type MessageEnvelope as ac, type IdentificationData as ad, type IdentificationDataIdOneOf as ae, type SaveSeatingPlanVersionRequest as af, type SaveSeatingPlanVersionResponse as ag, type QuerySeatingPlanVersionsRequest as ah, type QuerySeatingPlanVersionsResponse as ai, type PagingMetadataV2 as aj, type Cursors as ak, type DiscardSeatingPlanVersionsRequest as al, type DiscardSeatingPlanVersionsResponse as am, type RestoreSeatingPlanRequest as an, type RestoreSeatingPlanResponse as ao, type UpdateSeatingPlanThumbnailRequest as ap, type GetSeatingPlanThumbnailRequest as aq, type BaseEventMetadata as ar, type EventMetadata as as, type PlansQueryResult as at, type FindSeatingPlanResponse as b, type SeatingPlanThumbnail as c, type UpdateSeatingPlanThumbnailResponse as d, type GetSeatingPlanThumbnailResponse as e, type SeatingPlanCreatedEnvelope as f, type SeatingPlanDeletedEnvelope as g, type SeatingPlanUpdatedEnvelope as h, PlaceTypeEnumType as i, ShapeTypeEnumType as j, Position as k, SortOrder as l, Fieldset as m, type Section as n, type Sequencing as o, type Place as p, type ElementUiProperties as q, type Image as r, type RowElement as s, type RowElementUiProperties as t, type Category as u, type ExtendedFields as v, type SeatingPlanUiProperties as w, type ElementGroup as x, type ElementGroupUiProperties as y, type CreateSeatingPlanRequest as z };
+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, updateSeatingPlan, updateSeatingPlanThumbnail };