@wix/auto_sdk_seatings_seating-plan 1.0.3 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.context.d.ts +1 -1
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.meta.d.ts +7 -7
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.meta.js.map +1 -1
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.public.d.ts +9 -9
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.public.js.map +1 -1
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.types.d.ts +42 -126
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.types.js.map +1 -1
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.universal.d.ts +93 -152
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.universal.js +22 -2
- package/build/cjs/src/seating-v1-seating-plan-seating-plan.universal.js.map +1 -1
- package/build/es/src/seating-v1-seating-plan-seating-plan.context.d.ts +1 -1
- package/build/es/src/seating-v1-seating-plan-seating-plan.meta.d.ts +7 -7
- package/build/es/src/seating-v1-seating-plan-seating-plan.meta.js.map +1 -1
- package/build/es/src/seating-v1-seating-plan-seating-plan.public.d.ts +9 -9
- package/build/es/src/seating-v1-seating-plan-seating-plan.public.js.map +1 -1
- package/build/es/src/seating-v1-seating-plan-seating-plan.types.d.ts +42 -126
- package/build/es/src/seating-v1-seating-plan-seating-plan.types.js.map +1 -1
- package/build/es/src/seating-v1-seating-plan-seating-plan.universal.d.ts +93 -152
- package/build/es/src/seating-v1-seating-plan-seating-plan.universal.js +22 -2
- package/build/es/src/seating-v1-seating-plan-seating-plan.universal.js.map +1 -1
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.context.d.ts +1 -1
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.meta.d.ts +7 -7
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.meta.js.map +1 -1
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.public.d.ts +9 -9
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.public.js.map +1 -1
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.types.d.ts +42 -126
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.types.js.map +1 -1
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.universal.d.ts +93 -152
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.universal.js +22 -2
- package/build/internal/cjs/src/seating-v1-seating-plan-seating-plan.universal.js.map +1 -1
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.context.d.ts +1 -1
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.meta.d.ts +7 -7
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.meta.js.map +1 -1
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.public.d.ts +9 -9
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.public.js.map +1 -1
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.types.d.ts +42 -126
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.types.js.map +1 -1
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.universal.d.ts +93 -152
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.universal.js +22 -2
- package/build/internal/es/src/seating-v1-seating-plan-seating-plan.universal.js.map +1 -1
- package/package.json +4 -4
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
1
2
|
export interface SeatingPlan {
|
|
2
3
|
/**
|
|
3
4
|
* Auto generated unique plan id
|
|
@@ -113,7 +114,7 @@ export interface Element {
|
|
|
113
114
|
*/
|
|
114
115
|
title?: string | null;
|
|
115
116
|
/** Element type */
|
|
116
|
-
type?:
|
|
117
|
+
type?: TypeWithLiterals;
|
|
117
118
|
/**
|
|
118
119
|
* Capacity. None for Shape type Element.
|
|
119
120
|
* @min 1
|
|
@@ -152,6 +153,8 @@ export declare enum Type {
|
|
|
152
153
|
ROUND_TABLE = "ROUND_TABLE",
|
|
153
154
|
SHAPE = "SHAPE"
|
|
154
155
|
}
|
|
156
|
+
/** @enumType */
|
|
157
|
+
export type TypeWithLiterals = Type | 'AREA' | 'ROW' | 'MULTI_ROW' | 'TABLE' | 'ROUND_TABLE' | 'SHAPE';
|
|
155
158
|
export interface Sequencing {
|
|
156
159
|
/**
|
|
157
160
|
* First seq element
|
|
@@ -190,14 +193,14 @@ export interface Place {
|
|
|
190
193
|
* Type of the parent element
|
|
191
194
|
* @readonly
|
|
192
195
|
*/
|
|
193
|
-
elementType?:
|
|
196
|
+
elementType?: TypeWithLiterals;
|
|
194
197
|
/**
|
|
195
198
|
* Assigned category id
|
|
196
199
|
* @readonly
|
|
197
200
|
*/
|
|
198
201
|
categoryId?: number | null;
|
|
199
202
|
/** Place type */
|
|
200
|
-
type?:
|
|
203
|
+
type?: PlaceTypeEnumTypeWithLiterals;
|
|
201
204
|
}
|
|
202
205
|
export declare enum PlaceTypeEnumType {
|
|
203
206
|
UNKNOWN_PROPERTY = "UNKNOWN_PROPERTY",
|
|
@@ -208,6 +211,8 @@ export declare enum PlaceTypeEnumType {
|
|
|
208
211
|
OBSTRUCTED = "OBSTRUCTED",
|
|
209
212
|
DISCOUNT = "DISCOUNT"
|
|
210
213
|
}
|
|
214
|
+
/** @enumType */
|
|
215
|
+
export type PlaceTypeEnumTypeWithLiterals = PlaceTypeEnumType | 'UNKNOWN_PROPERTY' | 'STANDARD' | 'WHEELCHAIR' | 'ACCESSIBLE' | 'COMPANION' | 'OBSTRUCTED' | 'DISCOUNT';
|
|
211
216
|
export interface ReservationOptions {
|
|
212
217
|
/** Indicates whether the entire element must be reserved */
|
|
213
218
|
reserveWholeElement?: boolean;
|
|
@@ -237,7 +242,7 @@ export interface ElementUiProperties {
|
|
|
237
242
|
* @max 180
|
|
238
243
|
*/
|
|
239
244
|
rotationAngle?: number | null;
|
|
240
|
-
shapeType?:
|
|
245
|
+
shapeType?: ShapeTypeEnumTypeWithLiterals;
|
|
241
246
|
/**
|
|
242
247
|
* @min 10
|
|
243
248
|
* @max 176
|
|
@@ -251,7 +256,7 @@ export interface ElementUiProperties {
|
|
|
251
256
|
*/
|
|
252
257
|
seatSpacing?: number | null;
|
|
253
258
|
hideLabel?: boolean | null;
|
|
254
|
-
labelPosition?:
|
|
259
|
+
labelPosition?: PositionWithLiterals;
|
|
255
260
|
seatLayout?: number[];
|
|
256
261
|
/** @max 50 */
|
|
257
262
|
emptyTopSeatSpaces?: number | null;
|
|
@@ -284,9 +289,9 @@ export interface ElementUiProperties {
|
|
|
284
289
|
strokeWidth?: number | null;
|
|
285
290
|
/** @max 100 */
|
|
286
291
|
opacity?: number | null;
|
|
287
|
-
icon?:
|
|
292
|
+
icon?: IconWithLiterals;
|
|
288
293
|
image?: Image;
|
|
289
|
-
seatNumbering?:
|
|
294
|
+
seatNumbering?: NumberingWithLiterals;
|
|
290
295
|
}
|
|
291
296
|
export declare enum ShapeTypeEnumType {
|
|
292
297
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
@@ -297,6 +302,8 @@ export declare enum ShapeTypeEnumType {
|
|
|
297
302
|
ICON = "ICON",
|
|
298
303
|
IMAGE = "IMAGE"
|
|
299
304
|
}
|
|
305
|
+
/** @enumType */
|
|
306
|
+
export type ShapeTypeEnumTypeWithLiterals = ShapeTypeEnumType | 'UNKNOWN_TYPE' | 'TEXT' | 'RECTANGLE' | 'ELLIPSE' | 'LINE' | 'ICON' | 'IMAGE';
|
|
300
307
|
export declare enum Position {
|
|
301
308
|
UNKNOWN_POSITION = "UNKNOWN_POSITION",
|
|
302
309
|
LEFT = "LEFT",
|
|
@@ -304,6 +311,8 @@ export declare enum Position {
|
|
|
304
311
|
BOTH = "BOTH",
|
|
305
312
|
NONE = "NONE"
|
|
306
313
|
}
|
|
314
|
+
/** @enumType */
|
|
315
|
+
export type PositionWithLiterals = Position | 'UNKNOWN_POSITION' | 'LEFT' | 'RIGHT' | 'BOTH' | 'NONE';
|
|
307
316
|
export declare enum Icon {
|
|
308
317
|
UNKNOWN_ICON = "UNKNOWN_ICON",
|
|
309
318
|
ENTER = "ENTER",
|
|
@@ -319,6 +328,8 @@ export declare enum Icon {
|
|
|
319
328
|
CHECKROOM = "CHECKROOM",
|
|
320
329
|
STAGE = "STAGE"
|
|
321
330
|
}
|
|
331
|
+
/** @enumType */
|
|
332
|
+
export type IconWithLiterals = Icon | 'UNKNOWN_ICON' | 'ENTER' | 'EXIT' | 'DRINKS' | 'WC' | 'WC_MEN' | 'WC_WOMEN' | 'FOOD' | 'STAIRS' | 'ELEVATOR' | 'SMOKING' | 'CHECKROOM' | 'STAGE';
|
|
322
333
|
export interface Image {
|
|
323
334
|
/** WixMedia image ID. */
|
|
324
335
|
_id?: string;
|
|
@@ -344,6 +355,8 @@ export declare enum Numbering {
|
|
|
344
355
|
ODD_EVEN = "ODD_EVEN",
|
|
345
356
|
ALPHABETICAL = "ALPHABETICAL"
|
|
346
357
|
}
|
|
358
|
+
/** @enumType */
|
|
359
|
+
export type NumberingWithLiterals = Numbering | 'UNKNOWN_NUMBERING' | 'NUMERIC' | 'ODD_EVEN' | 'ALPHABETICAL';
|
|
347
360
|
export interface MultiRowProperties {
|
|
348
361
|
/**
|
|
349
362
|
* Individual rows of the multi row element
|
|
@@ -413,9 +426,9 @@ export interface RowElementUiProperties {
|
|
|
413
426
|
*/
|
|
414
427
|
seatSpacing?: number | null;
|
|
415
428
|
/** Label position */
|
|
416
|
-
labelPosition?:
|
|
429
|
+
labelPosition?: PositionWithLiterals;
|
|
417
430
|
/** Seat numbering */
|
|
418
|
-
seatNumbering?:
|
|
431
|
+
seatNumbering?: NumberingWithLiterals;
|
|
419
432
|
}
|
|
420
433
|
export interface VerticalSequencing {
|
|
421
434
|
/**
|
|
@@ -425,7 +438,7 @@ export interface VerticalSequencing {
|
|
|
425
438
|
*/
|
|
426
439
|
startAt?: string;
|
|
427
440
|
/** Row numbering */
|
|
428
|
-
rowNumbering?:
|
|
441
|
+
rowNumbering?: NumberingWithLiterals;
|
|
429
442
|
/** If true - direction bottom to top. Otherwise top to bottom. */
|
|
430
443
|
reverseOrder?: boolean | null;
|
|
431
444
|
}
|
|
@@ -583,7 +596,7 @@ export interface QuerySeatingPlanRequest {
|
|
|
583
596
|
*/
|
|
584
597
|
query: QueryV2;
|
|
585
598
|
/** A fieldset for the response */
|
|
586
|
-
fieldset?:
|
|
599
|
+
fieldset?: FieldsetWithLiterals[];
|
|
587
600
|
}
|
|
588
601
|
export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
589
602
|
/** Paging options to limit and skip the number of items. */
|
|
@@ -621,12 +634,14 @@ export interface Sorting {
|
|
|
621
634
|
*/
|
|
622
635
|
fieldName?: string;
|
|
623
636
|
/** Sort order. */
|
|
624
|
-
order?:
|
|
637
|
+
order?: SortOrderWithLiterals;
|
|
625
638
|
}
|
|
626
639
|
export declare enum SortOrder {
|
|
627
640
|
ASC = "ASC",
|
|
628
641
|
DESC = "DESC"
|
|
629
642
|
}
|
|
643
|
+
/** @enumType */
|
|
644
|
+
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
630
645
|
export interface Paging {
|
|
631
646
|
/** Number of items to load. */
|
|
632
647
|
limit?: number | null;
|
|
@@ -655,6 +670,8 @@ export declare enum Fieldset {
|
|
|
655
670
|
CONFIG = "CONFIG",
|
|
656
671
|
ELEMENT_GROUPS = "ELEMENT_GROUPS"
|
|
657
672
|
}
|
|
673
|
+
/** @enumType */
|
|
674
|
+
export type FieldsetWithLiterals = Fieldset | 'ELEMENTS' | 'CATEGORIES' | 'PLACES' | 'CONFIG' | 'ELEMENT_GROUPS';
|
|
658
675
|
export interface QuerySeatingPlanResponse {
|
|
659
676
|
/** Plan results */
|
|
660
677
|
plans?: SeatingPlan[];
|
|
@@ -669,7 +686,7 @@ export interface GetSeatingPlanRequest {
|
|
|
669
686
|
* A fieldset for the response
|
|
670
687
|
* @deprecated
|
|
671
688
|
*/
|
|
672
|
-
fieldset?:
|
|
689
|
+
fieldset?: FieldsetWithLiterals[];
|
|
673
690
|
/**
|
|
674
691
|
* Projection on the result object - list of named projections.
|
|
675
692
|
* Possible values: "elements", "categories", "places", "config".
|
|
@@ -697,7 +714,7 @@ export interface FindSeatingPlanRequest {
|
|
|
697
714
|
* A fieldset for the response
|
|
698
715
|
* @deprecated
|
|
699
716
|
*/
|
|
700
|
-
fieldset?:
|
|
717
|
+
fieldset?: FieldsetWithLiterals[];
|
|
701
718
|
/**
|
|
702
719
|
* Projection on the result object - list of named projections.
|
|
703
720
|
* Possible values: "elements", "categories", "places", "config".
|
|
@@ -726,25 +743,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
726
743
|
updatedEvent?: EntityUpdatedEvent;
|
|
727
744
|
deletedEvent?: EntityDeletedEvent;
|
|
728
745
|
actionEvent?: ActionEvent;
|
|
729
|
-
/**
|
|
730
|
-
* Unique event ID.
|
|
731
|
-
* Allows clients to ignore duplicate webhooks.
|
|
732
|
-
*/
|
|
746
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
733
747
|
_id?: string;
|
|
734
748
|
/**
|
|
735
|
-
*
|
|
736
|
-
*
|
|
749
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
750
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
737
751
|
*/
|
|
738
752
|
entityFqdn?: string;
|
|
739
753
|
/**
|
|
740
|
-
*
|
|
741
|
-
*
|
|
742
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
754
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
755
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
743
756
|
*/
|
|
744
757
|
slug?: string;
|
|
745
758
|
/** ID of the entity associated with the event. */
|
|
746
759
|
entityId?: string;
|
|
747
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
760
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
748
761
|
eventTime?: Date | null;
|
|
749
762
|
/**
|
|
750
763
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -754,12 +767,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
754
767
|
/** If present, indicates the action that triggered the event. */
|
|
755
768
|
originatedFrom?: string | null;
|
|
756
769
|
/**
|
|
757
|
-
* A sequence number
|
|
758
|
-
*
|
|
759
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
760
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
761
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
762
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
770
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
771
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
763
772
|
*/
|
|
764
773
|
entityEventSequence?: string | null;
|
|
765
774
|
}
|
|
@@ -785,7 +794,7 @@ export interface EntityUpdatedEvent {
|
|
|
785
794
|
currentEntity?: string;
|
|
786
795
|
}
|
|
787
796
|
export interface EntityDeletedEvent {
|
|
788
|
-
/** Entity that was deleted */
|
|
797
|
+
/** Entity that was deleted. */
|
|
789
798
|
deletedEntity?: string | null;
|
|
790
799
|
}
|
|
791
800
|
export interface ActionEvent {
|
|
@@ -829,7 +838,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
829
838
|
*/
|
|
830
839
|
appId?: string;
|
|
831
840
|
/** @readonly */
|
|
832
|
-
identityType?:
|
|
841
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
833
842
|
}
|
|
834
843
|
/** @oneof */
|
|
835
844
|
export interface IdentificationDataIdOneOf {
|
|
@@ -861,6 +870,8 @@ export declare enum WebhookIdentityType {
|
|
|
861
870
|
WIX_USER = "WIX_USER",
|
|
862
871
|
APP = "APP"
|
|
863
872
|
}
|
|
873
|
+
/** @enumType */
|
|
874
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
864
875
|
export interface SaveSeatingPlanVersionRequest {
|
|
865
876
|
/** A plan version to be saved */
|
|
866
877
|
plan?: SeatingPlan;
|
|
@@ -964,99 +975,6 @@ export interface GetSeatingPlanThumbnailRequest {
|
|
|
964
975
|
export interface GetSeatingPlanThumbnailResponse {
|
|
965
976
|
thumbnail?: SeatingPlanThumbnail;
|
|
966
977
|
}
|
|
967
|
-
interface SequencingNonNullableFields {
|
|
968
|
-
startAt: string;
|
|
969
|
-
labels: string[];
|
|
970
|
-
}
|
|
971
|
-
interface PlaceNonNullableFields {
|
|
972
|
-
index: number;
|
|
973
|
-
label: string;
|
|
974
|
-
elementType: Type;
|
|
975
|
-
type: PlaceTypeEnumType;
|
|
976
|
-
}
|
|
977
|
-
interface ReservationOptionsNonNullableFields {
|
|
978
|
-
reserveWholeElement: boolean;
|
|
979
|
-
}
|
|
980
|
-
interface ImageNonNullableFields {
|
|
981
|
-
_id: string;
|
|
982
|
-
height: number;
|
|
983
|
-
width: number;
|
|
984
|
-
}
|
|
985
|
-
interface ElementUiPropertiesNonNullableFields {
|
|
986
|
-
shapeType: ShapeTypeEnumType;
|
|
987
|
-
labelPosition: Position;
|
|
988
|
-
seatLayout: number[];
|
|
989
|
-
icon: Icon;
|
|
990
|
-
image?: ImageNonNullableFields;
|
|
991
|
-
seatNumbering: Numbering;
|
|
992
|
-
}
|
|
993
|
-
interface RowElementUiPropertiesNonNullableFields {
|
|
994
|
-
labelPosition: Position;
|
|
995
|
-
seatNumbering: Numbering;
|
|
996
|
-
}
|
|
997
|
-
interface RowElementNonNullableFields {
|
|
998
|
-
_id: number;
|
|
999
|
-
sequencing?: SequencingNonNullableFields;
|
|
1000
|
-
uiProperties?: RowElementUiPropertiesNonNullableFields;
|
|
1001
|
-
}
|
|
1002
|
-
interface VerticalSequencingNonNullableFields {
|
|
1003
|
-
startAt: string;
|
|
1004
|
-
rowNumbering: Numbering;
|
|
1005
|
-
}
|
|
1006
|
-
interface MultiRowPropertiesNonNullableFields {
|
|
1007
|
-
rows: RowElementNonNullableFields[];
|
|
1008
|
-
verticalSequencing?: VerticalSequencingNonNullableFields;
|
|
1009
|
-
}
|
|
1010
|
-
interface ElementNonNullableFields {
|
|
1011
|
-
_id: number;
|
|
1012
|
-
type: Type;
|
|
1013
|
-
sequencing?: SequencingNonNullableFields;
|
|
1014
|
-
overrides: PlaceNonNullableFields[];
|
|
1015
|
-
places: PlaceNonNullableFields[];
|
|
1016
|
-
reservationOptions?: ReservationOptionsNonNullableFields;
|
|
1017
|
-
uiProperties?: ElementUiPropertiesNonNullableFields;
|
|
1018
|
-
multiRowProperties?: MultiRowPropertiesNonNullableFields;
|
|
1019
|
-
}
|
|
1020
|
-
interface SectionNonNullableFields {
|
|
1021
|
-
_id: number;
|
|
1022
|
-
elements: ElementNonNullableFields[];
|
|
1023
|
-
default: boolean;
|
|
1024
|
-
}
|
|
1025
|
-
interface CategoryNonNullableFields {
|
|
1026
|
-
_id: number;
|
|
1027
|
-
title: string;
|
|
1028
|
-
places: PlaceNonNullableFields[];
|
|
1029
|
-
}
|
|
1030
|
-
interface ElementGroupNonNullableFields {
|
|
1031
|
-
_id: number;
|
|
1032
|
-
}
|
|
1033
|
-
export interface SeatingPlanNonNullableFields {
|
|
1034
|
-
sections: SectionNonNullableFields[];
|
|
1035
|
-
categories: CategoryNonNullableFields[];
|
|
1036
|
-
uncategorizedPlaces: PlaceNonNullableFields[];
|
|
1037
|
-
elementGroups: ElementGroupNonNullableFields[];
|
|
1038
|
-
}
|
|
1039
|
-
export interface CreateSeatingPlanResponseNonNullableFields {
|
|
1040
|
-
plan?: SeatingPlanNonNullableFields;
|
|
1041
|
-
}
|
|
1042
|
-
export interface UpdateSeatingPlanResponseNonNullableFields {
|
|
1043
|
-
plan?: SeatingPlanNonNullableFields;
|
|
1044
|
-
}
|
|
1045
|
-
export interface CopySeatingPlanResponseNonNullableFields {
|
|
1046
|
-
plan?: SeatingPlanNonNullableFields;
|
|
1047
|
-
}
|
|
1048
|
-
export interface QuerySeatingPlanResponseNonNullableFields {
|
|
1049
|
-
plans: SeatingPlanNonNullableFields[];
|
|
1050
|
-
}
|
|
1051
|
-
export interface GetSeatingPlanResponseNonNullableFields {
|
|
1052
|
-
plan?: SeatingPlanNonNullableFields;
|
|
1053
|
-
}
|
|
1054
|
-
export interface FindSeatingPlanResponseNonNullableFields {
|
|
1055
|
-
plan?: SeatingPlanNonNullableFields;
|
|
1056
|
-
}
|
|
1057
|
-
export interface DeleteSeatingPlanResponseNonNullableFields {
|
|
1058
|
-
plan?: SeatingPlanNonNullableFields;
|
|
1059
|
-
}
|
|
1060
978
|
export interface BaseEventMetadata {
|
|
1061
979
|
/**
|
|
1062
980
|
* App instance ID.
|
|
@@ -1072,25 +990,21 @@ export interface BaseEventMetadata {
|
|
|
1072
990
|
identity?: IdentificationData;
|
|
1073
991
|
}
|
|
1074
992
|
export interface EventMetadata extends BaseEventMetadata {
|
|
1075
|
-
/**
|
|
1076
|
-
* Unique event ID.
|
|
1077
|
-
* Allows clients to ignore duplicate webhooks.
|
|
1078
|
-
*/
|
|
993
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1079
994
|
_id?: string;
|
|
1080
995
|
/**
|
|
1081
|
-
*
|
|
1082
|
-
*
|
|
996
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
997
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1083
998
|
*/
|
|
1084
999
|
entityFqdn?: string;
|
|
1085
1000
|
/**
|
|
1086
|
-
*
|
|
1087
|
-
*
|
|
1088
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
1001
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1002
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1089
1003
|
*/
|
|
1090
1004
|
slug?: string;
|
|
1091
1005
|
/** ID of the entity associated with the event. */
|
|
1092
1006
|
entityId?: string;
|
|
1093
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
1007
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1094
1008
|
eventTime?: Date | null;
|
|
1095
1009
|
/**
|
|
1096
1010
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -1100,12 +1014,8 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
1100
1014
|
/** If present, indicates the action that triggered the event. */
|
|
1101
1015
|
originatedFrom?: string | null;
|
|
1102
1016
|
/**
|
|
1103
|
-
* A sequence number
|
|
1104
|
-
*
|
|
1105
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1106
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1107
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1108
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1017
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
1018
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
1109
1019
|
*/
|
|
1110
1020
|
entityEventSequence?: string | null;
|
|
1111
1021
|
}
|
|
@@ -1115,6 +1025,8 @@ export interface SeatingPlanCreatedEnvelope {
|
|
|
1115
1025
|
}
|
|
1116
1026
|
/** @permissionScope Manage Events
|
|
1117
1027
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1028
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1029
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1118
1030
|
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
1119
1031
|
* @webhook
|
|
1120
1032
|
* @eventType wix.seating.v1.seating_plan_created
|
|
@@ -1128,6 +1040,8 @@ export interface SeatingPlanDeletedEnvelope {
|
|
|
1128
1040
|
}
|
|
1129
1041
|
/** @permissionScope Manage Events
|
|
1130
1042
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1043
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1044
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1131
1045
|
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
1132
1046
|
* @webhook
|
|
1133
1047
|
* @eventType wix.seating.v1.seating_plan_deleted
|
|
@@ -1141,6 +1055,8 @@ export interface SeatingPlanUpdatedEnvelope {
|
|
|
1141
1055
|
}
|
|
1142
1056
|
/** @permissionScope Manage Events
|
|
1143
1057
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1058
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1059
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1144
1060
|
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
1145
1061
|
* @webhook
|
|
1146
1062
|
* @eventType wix.seating.v1.seating_plan_updated
|
|
@@ -1148,6 +1064,7 @@ export interface SeatingPlanUpdatedEnvelope {
|
|
|
1148
1064
|
* @documentationMaturity preview
|
|
1149
1065
|
*/
|
|
1150
1066
|
export declare function onSeatingPlanUpdated(handler: (event: SeatingPlanUpdatedEnvelope) => void | Promise<void>): void;
|
|
1067
|
+
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`;
|
|
1151
1068
|
/**
|
|
1152
1069
|
* Crates a seating plan
|
|
1153
1070
|
* @param plan - A plan to be created
|
|
@@ -1159,11 +1076,13 @@ export declare function onSeatingPlanUpdated(handler: (event: SeatingPlanUpdated
|
|
|
1159
1076
|
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1160
1077
|
* @permissionScope Manage Events
|
|
1161
1078
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1079
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1080
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1162
1081
|
* @applicableIdentity APP
|
|
1163
1082
|
* @returns The created plan
|
|
1164
1083
|
* @fqn com.wixpress.seating.SeatingPlanManagement.CreateSeatingPlan
|
|
1165
1084
|
*/
|
|
1166
|
-
export declare function createSeatingPlan(plan: SeatingPlan): Promise<SeatingPlan
|
|
1085
|
+
export declare function createSeatingPlan(plan: NonNullablePaths<SeatingPlan, `sections.${number}.elements.${number}.title` | `title`>): Promise<NonNullablePaths<SeatingPlan, SeatingPlanNonNullablePaths>>;
|
|
1167
1086
|
/**
|
|
1168
1087
|
* Updates the seating plan
|
|
1169
1088
|
* @public
|
|
@@ -1173,11 +1092,13 @@ export declare function createSeatingPlan(plan: SeatingPlan): Promise<SeatingPla
|
|
|
1173
1092
|
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1174
1093
|
* @permissionScope Manage Events
|
|
1175
1094
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1095
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1096
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1176
1097
|
* @applicableIdentity APP
|
|
1177
1098
|
* @returns The updated plan
|
|
1178
1099
|
* @fqn com.wixpress.seating.SeatingPlanManagement.UpdateSeatingPlan
|
|
1179
1100
|
*/
|
|
1180
|
-
export declare function updateSeatingPlan(options?: UpdateSeatingPlanOptions): Promise<SeatingPlan
|
|
1101
|
+
export declare function updateSeatingPlan(options?: NonNullablePaths<UpdateSeatingPlanOptions, `plan._id` | `plan.sections.${number}.elements.${number}.title`>): Promise<NonNullablePaths<SeatingPlan, SeatingPlanNonNullablePaths>>;
|
|
1181
1102
|
export interface UpdateSeatingPlanOptions {
|
|
1182
1103
|
/** The plan updates */
|
|
1183
1104
|
plan?: SeatingPlan;
|
|
@@ -1196,10 +1117,14 @@ export interface UpdateSeatingPlanOptions {
|
|
|
1196
1117
|
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1197
1118
|
* @permissionScope Manage Events
|
|
1198
1119
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1120
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1121
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1199
1122
|
* @applicableIdentity APP
|
|
1200
1123
|
* @fqn com.wixpress.seating.SeatingPlanManagement.CopySeatingPlan
|
|
1201
1124
|
*/
|
|
1202
|
-
export declare function copySeatingPlan(_id: string
|
|
1125
|
+
export declare function copySeatingPlan(_id: string, options: NonNullablePaths<CopySeatingPlanOptions, `externalId` | `title`>): Promise<NonNullablePaths<CopySeatingPlanResponse, {
|
|
1126
|
+
[P in SeatingPlanNonNullablePaths]: `plan.${P}`;
|
|
1127
|
+
}[SeatingPlanNonNullablePaths]>>;
|
|
1203
1128
|
export interface CopySeatingPlanOptions {
|
|
1204
1129
|
/**
|
|
1205
1130
|
* New plan title
|
|
@@ -1220,6 +1145,8 @@ export interface CopySeatingPlanOptions {
|
|
|
1220
1145
|
* @documentationMaturity preview
|
|
1221
1146
|
* @permissionScope Manage Events
|
|
1222
1147
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1148
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1149
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1223
1150
|
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
1224
1151
|
* @applicableIdentity APP
|
|
1225
1152
|
* @applicableIdentity VISITOR
|
|
@@ -1228,7 +1155,7 @@ export interface CopySeatingPlanOptions {
|
|
|
1228
1155
|
export declare function querySeatingPlan(options?: QuerySeatingPlanOptions): PlansQueryBuilder;
|
|
1229
1156
|
export interface QuerySeatingPlanOptions {
|
|
1230
1157
|
/** A fieldset for the response */
|
|
1231
|
-
fieldset?:
|
|
1158
|
+
fieldset?: FieldsetWithLiterals[] | undefined;
|
|
1232
1159
|
}
|
|
1233
1160
|
interface QueryCursorResult {
|
|
1234
1161
|
cursors: Cursors;
|
|
@@ -1264,18 +1191,20 @@ export interface PlansQueryBuilder {
|
|
|
1264
1191
|
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
1265
1192
|
* @permissionScope Manage Events
|
|
1266
1193
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1194
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1195
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1267
1196
|
* @applicableIdentity APP
|
|
1268
1197
|
* @applicableIdentity VISITOR
|
|
1269
1198
|
* @returns The plan
|
|
1270
1199
|
* @fqn com.wixpress.seating.SeatingPlanManagement.GetSeatingPlan
|
|
1271
1200
|
*/
|
|
1272
|
-
export declare function getSeatingPlan(_id: string
|
|
1201
|
+
export declare function getSeatingPlan(_id: string, options?: GetSeatingPlanOptions): Promise<NonNullablePaths<SeatingPlan, SeatingPlanNonNullablePaths>>;
|
|
1273
1202
|
export interface GetSeatingPlanOptions {
|
|
1274
1203
|
/**
|
|
1275
1204
|
* A fieldset for the response
|
|
1276
1205
|
* @deprecated
|
|
1277
1206
|
*/
|
|
1278
|
-
fieldset?:
|
|
1207
|
+
fieldset?: FieldsetWithLiterals[];
|
|
1279
1208
|
/**
|
|
1280
1209
|
* Projection on the result object - list of named projections.
|
|
1281
1210
|
* Possible values: "elements", "categories", "places", "config".
|
|
@@ -1293,17 +1222,21 @@ export interface GetSeatingPlanOptions {
|
|
|
1293
1222
|
* @permissionId SEATING_PLANS.READ_SEATING_PLANS
|
|
1294
1223
|
* @permissionScope Manage Events
|
|
1295
1224
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1225
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1226
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1296
1227
|
* @applicableIdentity APP
|
|
1297
1228
|
* @applicableIdentity VISITOR
|
|
1298
1229
|
* @fqn com.wixpress.seating.SeatingPlanManagement.FindSeatingPlan
|
|
1299
1230
|
*/
|
|
1300
|
-
export declare function findSeatingPlan(filter: Record<string, any
|
|
1231
|
+
export declare function findSeatingPlan(filter: Record<string, any>, options?: FindSeatingPlanOptions): Promise<NonNullablePaths<FindSeatingPlanResponse, {
|
|
1232
|
+
[P in SeatingPlanNonNullablePaths]: `plan.${P}`;
|
|
1233
|
+
}[SeatingPlanNonNullablePaths]>>;
|
|
1301
1234
|
export interface FindSeatingPlanOptions {
|
|
1302
1235
|
/**
|
|
1303
1236
|
* A fieldset for the response
|
|
1304
1237
|
* @deprecated
|
|
1305
1238
|
*/
|
|
1306
|
-
fieldset?:
|
|
1239
|
+
fieldset?: FieldsetWithLiterals[];
|
|
1307
1240
|
/**
|
|
1308
1241
|
* Projection on the result object - list of named projections.
|
|
1309
1242
|
* Possible values: "elements", "categories", "places", "config".
|
|
@@ -1321,10 +1254,14 @@ export interface FindSeatingPlanOptions {
|
|
|
1321
1254
|
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1322
1255
|
* @permissionScope Manage Events
|
|
1323
1256
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1257
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1258
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1324
1259
|
* @applicableIdentity APP
|
|
1325
1260
|
* @fqn com.wixpress.seating.SeatingPlanManagement.DeleteSeatingPlan
|
|
1326
1261
|
*/
|
|
1327
|
-
export declare function deleteSeatingPlan(_id: string
|
|
1262
|
+
export declare function deleteSeatingPlan(_id: string): Promise<NonNullablePaths<DeleteSeatingPlanResponse, {
|
|
1263
|
+
[P in SeatingPlanNonNullablePaths]: `plan.${P}`;
|
|
1264
|
+
}[SeatingPlanNonNullablePaths]>>;
|
|
1328
1265
|
/**
|
|
1329
1266
|
* Updates seating plan thumbnail.
|
|
1330
1267
|
* @public
|
|
@@ -1335,10 +1272,12 @@ export declare function deleteSeatingPlan(_id: string | null): Promise<DeleteSea
|
|
|
1335
1272
|
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1336
1273
|
* @permissionScope Manage Events
|
|
1337
1274
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1275
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1276
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1338
1277
|
* @applicableIdentity APP
|
|
1339
1278
|
* @fqn com.wixpress.seating.SeatingPlanThumbnailService.UpdateSeatingPlanThumbnail
|
|
1340
1279
|
*/
|
|
1341
|
-
export declare function updateSeatingPlanThumbnail(thumbnail: SeatingPlanThumbnail): Promise<UpdateSeatingPlanThumbnailResponse>;
|
|
1280
|
+
export declare function updateSeatingPlanThumbnail(thumbnail: NonNullablePaths<SeatingPlanThumbnail, `_id` | `img`>): Promise<UpdateSeatingPlanThumbnailResponse>;
|
|
1342
1281
|
/**
|
|
1343
1282
|
* Get seating plan thumbnail.
|
|
1344
1283
|
* @public
|
|
@@ -1347,8 +1286,10 @@ export declare function updateSeatingPlanThumbnail(thumbnail: SeatingPlanThumbna
|
|
|
1347
1286
|
* @permissionId SEATING_PLANS.MANAGE_SEATING_PLANS
|
|
1348
1287
|
* @permissionScope Manage Events
|
|
1349
1288
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1289
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1290
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1350
1291
|
* @applicableIdentity APP
|
|
1351
1292
|
* @fqn com.wixpress.seating.SeatingPlanThumbnailService.GetSeatingPlanThumbnail
|
|
1352
1293
|
*/
|
|
1353
|
-
export declare function getSeatingPlanThumbnail(_id: string
|
|
1294
|
+
export declare function getSeatingPlanThumbnail(_id: string): Promise<GetSeatingPlanThumbnailResponse>;
|
|
1354
1295
|
export {};
|