@wix/auto_sdk_seatings_seating-reservation 1.0.5 → 1.0.7

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

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface SeatingReservation {
     /**
      * The id of the reservation
@@ -298,20 +300,20 @@ interface QuerySeatingReservationRequest {
     query: QueryV2;
 }
 interface QueryV2 extends QueryV2PagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
+    /** Paging options to limit and offset the number of items. */
     paging?: Paging;
     /** 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?: CursorPaging;
     /**
      * Filter object.
      *
-     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
      */
     filter?: Record<string, any> | null;
     /**
      * Sort object.
      *
-     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
      */
     sort?: Sorting[];
     /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
@@ -321,7 +323,7 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
 }
 /** @oneof */
 interface QueryV2PagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
+    /** Paging options to limit and offset the number of items. */
     paging?: Paging;
     /** 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?: CursorPaging;
@@ -1173,6 +1175,15 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type CreateSeatingReservationApplicationErrors = {
+    code?: 'PLACE_NOT_FOUND';
+    description?: string;
+    data?: Places;
+} | {
+    code?: 'PLACE_RESERVED';
+    description?: string;
+    data?: UnavailablePlaces;
+};
 interface BaseEventMetadata {
     /**
      * App instance ID.
@@ -1221,14 +1232,66 @@ interface SeatingReservationCreatedEnvelope {
     entity: SeatingReservation;
     metadata: EventMetadata;
 }
+/** @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId SEATING_PLANS.READ_RESERVATIONS
+ * @webhook
+ * @eventType wix.seating.v1.seating_reservation_created
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onSeatingReservationCreated(handler: (event: SeatingReservationCreatedEnvelope) => void | Promise<void>): void;
 interface SeatingReservationDeletedEnvelope {
     entity: SeatingReservation;
     metadata: EventMetadata;
 }
+/** @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId SEATING_PLANS.READ_RESERVATIONS
+ * @webhook
+ * @eventType wix.seating.v1.seating_reservation_deleted
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+declare function onSeatingReservationDeleted(handler: (event: SeatingReservationDeletedEnvelope) => void | Promise<void>): void;
+type SeatingReservationNonNullablePaths = `reservedPlaces` | `reservedPlaces.${number}._id`;
+/**
+ * Creates a seating reservation
+ * @public
+ * @documentationMaturity preview
+ * @permissionId SEATING_PLANS.MANAGE_RESERVATIONS
+ * @applicableIdentity APP
+ * @returns Created reservation
+ * @fqn com.wixpress.seating.SeatingReservationService.CreateSeatingReservation
+ */
+declare function createSeatingReservation(options?: CreateSeatingReservationOptions): Promise<NonNullablePaths<SeatingReservation, SeatingReservationNonNullablePaths> & {
+    __applicationErrorsType?: CreateSeatingReservationApplicationErrors;
+}>;
 interface CreateSeatingReservationOptions {
     /** A reservation to create */
     reservation?: SeatingReservation;
 }
+/**
+ * Returns seating reservation
+ * @param _id - The id of the reservation to return
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId SEATING_PLANS.READ_RESERVATIONS
+ * @applicableIdentity APP
+ * @returns Created reservation
+ * @fqn com.wixpress.seating.SeatingReservationService.GetReservation
+ */
+declare function getReservation(_id: string): Promise<NonNullablePaths<SeatingReservation, SeatingReservationNonNullablePaths>>;
+/**
+ * Lists seating reservations by query request
+ * @public
+ * @documentationMaturity preview
+ * @permissionId SEATING_PLANS.READ_RESERVATIONS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.seating.SeatingReservationService.QuerySeatingReservation
+ */
+declare function querySeatingReservation(): ReservationsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -1254,6 +1317,27 @@ interface ReservationsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<ReservationsQueryResult>;
 }
+/**
+ * Deletes the seating reservation
+ * @param _id - The id of the reservation to delete
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId SEATING_PLANS.MANAGE_RESERVATIONS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.seating.SeatingReservationService.DeleteSeatingReservation
+ */
+declare function deleteSeatingReservation(_id: string): Promise<NonNullablePaths<DeleteSeatingReservationResponse, {
+    [P in SeatingReservationNonNullablePaths]: `reservation.${P}`;
+}[SeatingReservationNonNullablePaths]>>;
+/** @public
+ * @documentationMaturity preview
+ * @permissionId SEATING_PLANS.READ_SEATING_PLANS
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.seating.SeatingReservationService.GetSeatingCategorySummary
+ */
+declare function getSeatingCategorySummary(options?: GetSeatingCategorySummaryOptions): Promise<NonNullablePaths<GetSeatingCategorySummaryResponse, `categories`>>;
 interface GetSeatingCategorySummaryOptions {
     /**
      * Seating plan external id
@@ -1262,5 +1346,15 @@ interface GetSeatingCategorySummaryOptions {
      */
     externalId?: string;
 }
+/** @param externalId - Seating plan external id
+ * @public
+ * @documentationMaturity preview
+ * @requiredField externalId
+ * @permissionId SEATING_PLANS.READ_SEATING_PLANS
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.seating.SeatingReservationService.GetSeatingReservationSummary
+ */
+declare function getSeatingReservationSummary(externalId: string): Promise<NonNullablePaths<GetSeatingReservationSummaryResponse, `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` | `places` | `places.${number}.placeId` | `places.${number}.occupied`>>;
 
-export { type GetSeatingCategorySummaryRequest as $, type App as A, type QuerySeatingReservationResponse as B, type CreateSeatingReservationOptions as C, type DeleteSeatingReservationResponse as D, type PagingMetadataV2 as E, type File as F, type GetSeatingCategorySummaryOptions as G, type Cursors as H, Icon as I, type DeleteSeatingReservationRequest as J, type DeleteSeatingPlaceReservationRequest as K, type Empty as L, type CancelSeatingPlaceReservationsRequest as M, Numbering as N, type PlaceReservationDetails as O, PlaceTypeEnumType as P, type QuerySeatingReservationRequest as Q, type ReservationsQueryBuilder as R, type SeatingReservation as S, Type as T, type URI as U, type CancelSeatingPlaceReservationsResponse as V, WebhookIdentityType as W, type UpdateSeatingReservationRequest as X, type UpdateSeatingReservationResponse as Y, type GetReservedPlacesRequest as Z, type GetReservedPlacesResponse as _, type GetSeatingCategorySummaryResponse as a, type GetSeatingReservationSummaryRequest as a0, type SeatingPlan as a1, type Section as a2, type Element as a3, type Sequencing as a4, type Place as a5, type ReservationOptions as a6, type ElementUiProperties as a7, type Image as a8, type MultiRowProperties as a9, type RowElement as aa, type RowElementUiProperties as ab, type VerticalSequencing as ac, type Category as ad, type ExtendedFields as ae, type SeatingPlanUiProperties as af, type ElementGroup as ag, type ElementGroupUiProperties as ah, type RegenerateSummariesRequest as ai, type RegenerateSummariesResponse as aj, type SeatingReservationsSummary as ak, type DomainEvent as al, type DomainEventBodyOneOf as am, type EntityCreatedEvent as an, type RestoreInfo as ao, type EntityUpdatedEvent as ap, type EntityDeletedEvent as aq, type ActionEvent as ar, type MessageEnvelope as as, type IdentificationData as at, type IdentificationDataIdOneOf as au, type BaseEventMetadata as av, type EventMetadata as aw, type ReservationsQueryResult as ax, type GetSeatingReservationSummaryResponse as b, type SeatingReservationCreatedEnvelope as c, type SeatingReservationDeletedEnvelope as d, SortOrder as e, ShapeTypeEnumType as f, Position as g, type PlaceReservation as h, type SeatingPlanCategoriesSummaryUpdated as i, type CategoryDetails as j, type InvalidateCache as k, type InvalidateCacheGetByOneOf as l, type Page as m, type CustomTag as n, type CreateSeatingReservationRequest as o, type CreateSeatingReservationResponse as p, type Places as q, type UnavailablePlaces as r, type ReservationErrorDetails as s, type GetReservationRequest as t, type GetReservationResponse as u, type QueryV2 as v, type QueryV2PagingMethodOneOf as w, type Sorting as x, type Paging as y, type CursorPaging as z };
+export { type ActionEvent, type App, type BaseEventMetadata, type CancelSeatingPlaceReservationsRequest, type CancelSeatingPlaceReservationsResponse, type Category, type CategoryDetails, type CreateSeatingReservationApplicationErrors, type CreateSeatingReservationOptions, type CreateSeatingReservationRequest, type CreateSeatingReservationResponse, type CursorPaging, type Cursors, type CustomTag, type DeleteSeatingPlaceReservationRequest, type DeleteSeatingReservationRequest, type DeleteSeatingReservationResponse, type DomainEvent, type DomainEventBodyOneOf, type Element, type ElementGroup, type ElementGroupUiProperties, type ElementUiProperties, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type File, type GetReservationRequest, type GetReservationResponse, type GetReservedPlacesRequest, type GetReservedPlacesResponse, type GetSeatingCategorySummaryOptions, type GetSeatingCategorySummaryRequest, type GetSeatingCategorySummaryResponse, type GetSeatingReservationSummaryRequest, type GetSeatingReservationSummaryResponse, Icon, type IconWithLiterals, type IdentificationData, type IdentificationDataIdOneOf, type Image, type InvalidateCache, type InvalidateCacheGetByOneOf, type MessageEnvelope, type MultiRowProperties, Numbering, type NumberingWithLiterals, type Page, type Paging, type PagingMetadataV2, type Place, type PlaceReservation, type PlaceReservationDetails, PlaceTypeEnumType, type PlaceTypeEnumTypeWithLiterals, type Places, Position, type PositionWithLiterals, type QuerySeatingReservationRequest, type QuerySeatingReservationResponse, type QueryV2, type QueryV2PagingMethodOneOf, type RegenerateSummariesRequest, type RegenerateSummariesResponse, type ReservationErrorDetails, type ReservationOptions, type ReservationsQueryBuilder, type ReservationsQueryResult, type RestoreInfo, type RowElement, type RowElementUiProperties, type SeatingPlan, type SeatingPlanCategoriesSummaryUpdated, type SeatingPlanUiProperties, type SeatingReservation, type SeatingReservationCreatedEnvelope, type SeatingReservationDeletedEnvelope, type SeatingReservationsSummary, type Section, type Sequencing, ShapeTypeEnumType, type ShapeTypeEnumTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Type, type TypeWithLiterals, type URI, type UnavailablePlaces, type UpdateSeatingReservationRequest, type UpdateSeatingReservationResponse, type VerticalSequencing, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createSeatingReservation, deleteSeatingReservation, getReservation, getSeatingCategorySummary, getSeatingReservationSummary, onSeatingReservationCreated, onSeatingReservationDeleted, querySeatingReservation };