@wix/auto_sdk_table-reservations_experiences 1.0.0

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.
Files changed (39) hide show
  1. package/build/cjs/index.d.ts +85 -0
  2. package/build/cjs/index.js +1781 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +3183 -0
  5. package/build/cjs/index.typings.js +1442 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +2934 -0
  8. package/build/cjs/meta.js +1240 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/es/index.d.mts +85 -0
  11. package/build/es/index.mjs +1699 -0
  12. package/build/es/index.mjs.map +1 -0
  13. package/build/es/index.typings.d.mts +3183 -0
  14. package/build/es/index.typings.mjs +1363 -0
  15. package/build/es/index.typings.mjs.map +1 -0
  16. package/build/es/meta.d.mts +2934 -0
  17. package/build/es/meta.mjs +1158 -0
  18. package/build/es/meta.mjs.map +1 -0
  19. package/build/es/package.json +3 -0
  20. package/build/internal/cjs/index.d.ts +85 -0
  21. package/build/internal/cjs/index.js +1781 -0
  22. package/build/internal/cjs/index.js.map +1 -0
  23. package/build/internal/cjs/index.typings.d.ts +3183 -0
  24. package/build/internal/cjs/index.typings.js +1442 -0
  25. package/build/internal/cjs/index.typings.js.map +1 -0
  26. package/build/internal/cjs/meta.d.ts +2934 -0
  27. package/build/internal/cjs/meta.js +1240 -0
  28. package/build/internal/cjs/meta.js.map +1 -0
  29. package/build/internal/es/index.d.mts +85 -0
  30. package/build/internal/es/index.mjs +1699 -0
  31. package/build/internal/es/index.mjs.map +1 -0
  32. package/build/internal/es/index.typings.d.mts +3183 -0
  33. package/build/internal/es/index.typings.mjs +1363 -0
  34. package/build/internal/es/index.typings.mjs.map +1 -0
  35. package/build/internal/es/meta.d.mts +2934 -0
  36. package/build/internal/es/meta.mjs +1158 -0
  37. package/build/internal/es/meta.mjs.map +1 -0
  38. package/meta/package.json +3 -0
  39. package/package.json +54 -0
@@ -0,0 +1,3183 @@
1
+ import { NonNullablePaths } from '@wix/sdk-types';
2
+
3
+ /** Experience. */
4
+ interface Experience {
5
+ /**
6
+ * Experience ID.
7
+ * @format GUID
8
+ * @readonly
9
+ */
10
+ _id?: string | null;
11
+ /**
12
+ * Id of reservation location experience is assigned to.
13
+ * @format GUID
14
+ * @readonly
15
+ */
16
+ reservationLocationId?: string | null;
17
+ /**
18
+ * Revision number, which increments by 1 each time the Experience is updated.
19
+ * To prevent conflicting changes,
20
+ * the current revision must be passed when updating the Experience.
21
+ *
22
+ * Ignored when creating an Experience.
23
+ * @readonly
24
+ */
25
+ revision?: string | null;
26
+ /**
27
+ * Date and time the Experience was created.
28
+ * @readonly
29
+ */
30
+ _createdDate?: Date | null;
31
+ /**
32
+ * Date and time the Experience was last updated.
33
+ * @readonly
34
+ */
35
+ _updatedDate?: Date | null;
36
+ /** Configuration. */
37
+ configuration?: Configuration;
38
+ /**
39
+ * Currency code. Must be valid ISO 4217 currency code (e.g., USD).
40
+ * @format CURRENCY
41
+ * @readonly
42
+ */
43
+ currency?: string | null;
44
+ /** Data Extensions. */
45
+ extendedFields?: ExtendedFields;
46
+ /** Tags. */
47
+ tags?: Tags;
48
+ }
49
+ interface Table {
50
+ /**
51
+ * Table id.
52
+ * @format GUID
53
+ */
54
+ _id?: string | null;
55
+ }
56
+ interface TableCombination {
57
+ /**
58
+ * Table combinations id.
59
+ * @format GUID
60
+ */
61
+ _id?: string | null;
62
+ }
63
+ declare enum TableAvailabilityType {
64
+ UNKNOWN_TABLE_AVAILABILITY_TYPE = "UNKNOWN_TABLE_AVAILABILITY_TYPE",
65
+ ANY_ONLINE_TABLE = "ANY_ONLINE_TABLE",
66
+ SPECIFIC_TABLES = "SPECIFIC_TABLES"
67
+ }
68
+ /** @enumType */
69
+ type TableAvailabilityTypeWithLiterals = TableAvailabilityType | 'UNKNOWN_TABLE_AVAILABILITY_TYPE' | 'ANY_ONLINE_TABLE' | 'SPECIFIC_TABLES';
70
+ declare enum TableAssignmentType {
71
+ UNKNOWN_ASSIGMENT_TYPE = "UNKNOWN_ASSIGMENT_TYPE",
72
+ AUTOMATIC = "AUTOMATIC",
73
+ MANUAL = "MANUAL"
74
+ }
75
+ /** @enumType */
76
+ type TableAssignmentTypeWithLiterals = TableAssignmentType | 'UNKNOWN_ASSIGMENT_TYPE' | 'AUTOMATIC' | 'MANUAL';
77
+ interface SpecificTablesOptions {
78
+ /** When tables are mandatory for experience they can't be used for standard reservations during experience time. */
79
+ mandatoryForExperience?: boolean | null;
80
+ /**
81
+ * Tables.
82
+ * @maxSize 1000
83
+ */
84
+ tables?: Table[];
85
+ /**
86
+ * Table combinations.
87
+ * @maxSize 1000
88
+ */
89
+ tableCombinations?: TableCombination[];
90
+ }
91
+ declare enum TableManagementMode {
92
+ UNKNOWN_MODE = "UNKNOWN_MODE",
93
+ ON = "ON",
94
+ OFF = "OFF"
95
+ }
96
+ /** @enumType */
97
+ type TableManagementModeWithLiterals = TableManagementMode | 'UNKNOWN_MODE' | 'ON' | 'OFF';
98
+ interface OnOptions extends OnOptionsOptionsOneOf {
99
+ /** Specific tables options. */
100
+ specificTablesOptions?: SpecificTablesOptions;
101
+ /** Table availability type. */
102
+ tableAvailabilityType?: TableAvailabilityTypeWithLiterals;
103
+ /** Table assignment type. */
104
+ tableAssignmentType?: TableAssignmentTypeWithLiterals;
105
+ }
106
+ /** @oneof */
107
+ interface OnOptionsOptionsOneOf {
108
+ /** Specific tables options. */
109
+ specificTablesOptions?: SpecificTablesOptions;
110
+ }
111
+ declare enum Unit {
112
+ UNKNOWN_UNIT = "UNKNOWN_UNIT",
113
+ MINUTES = "MINUTES",
114
+ HOURS = "HOURS",
115
+ DAYS = "DAYS"
116
+ }
117
+ /** @enumType */
118
+ type UnitWithLiterals = Unit | 'UNKNOWN_UNIT' | 'MINUTES' | 'HOURS' | 'DAYS';
119
+ declare enum Mode {
120
+ UNKNOWN_MODE = "UNKNOWN_MODE",
121
+ AUTOMATIC = "AUTOMATIC",
122
+ MANUAL = "MANUAL"
123
+ }
124
+ /** @enumType */
125
+ type ModeWithLiterals = Mode | 'UNKNOWN_MODE' | 'AUTOMATIC' | 'MANUAL';
126
+ /** Enumerates the days of the week. */
127
+ declare enum StartDaysAndTimesDayOfWeek {
128
+ MONDAY = "MONDAY",
129
+ TUESDAY = "TUESDAY",
130
+ WEDNESDAY = "WEDNESDAY",
131
+ THURSDAY = "THURSDAY",
132
+ FRIDAY = "FRIDAY",
133
+ SATURDAY = "SATURDAY",
134
+ SUNDAY = "SUNDAY"
135
+ }
136
+ /** @enumType */
137
+ type StartDaysAndTimesDayOfWeekWithLiterals = StartDaysAndTimesDayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
138
+ interface StartDaysAndTimes {
139
+ /** Day of week */
140
+ day?: StartDaysAndTimesDayOfWeekWithLiterals;
141
+ /**
142
+ * Start time. ISO-8601 extended local time format (hh:mm). Examples: "11:00", "23:30"
143
+ * @maxLength 5
144
+ * @minLength 5
145
+ * @format LOCAL_TIME
146
+ */
147
+ time?: string | null;
148
+ }
149
+ declare enum Recurrence {
150
+ UNKNOWN_RECURRENCE = "UNKNOWN_RECURRENCE",
151
+ WEEKLY = "WEEKLY",
152
+ ONE_TIME = "ONE_TIME"
153
+ }
154
+ /** @enumType */
155
+ type RecurrenceWithLiterals = Recurrence | 'UNKNOWN_RECURRENCE' | 'WEEKLY' | 'ONE_TIME';
156
+ interface WeeklyOptions {
157
+ /**
158
+ * Start date.
159
+ * @format LOCAL_DATE
160
+ */
161
+ startDate?: string | null;
162
+ /**
163
+ * End date.
164
+ * @format LOCAL_DATE
165
+ */
166
+ endDate?: string | null;
167
+ /**
168
+ * Array of days and times when experience can start.
169
+ * @maxSize 100
170
+ */
171
+ startDaysAndTimes?: StartDaysAndTimes[];
172
+ }
173
+ interface OneTimeOptions {
174
+ /**
175
+ * Start date.
176
+ * @format LOCAL_DATE
177
+ */
178
+ startDate?: string | null;
179
+ /**
180
+ * Start time. ISO-8601 extended local time format (hh:mm). Examples: "11:00", "23:30"
181
+ * @maxLength 5
182
+ * @minLength 5
183
+ * @format LOCAL_TIME
184
+ */
185
+ startTime?: string | null;
186
+ }
187
+ interface Entry extends EntryRecurrenceOptionsOneOf {
188
+ /** Weekly options. */
189
+ weeklyOptions?: WeeklyOptions;
190
+ /** One time options. */
191
+ oneTimeOptions?: OneTimeOptions;
192
+ /** How often repeats. */
193
+ recurrence?: RecurrenceWithLiterals;
194
+ }
195
+ /** @oneof */
196
+ interface EntryRecurrenceOptionsOneOf {
197
+ /** Weekly options. */
198
+ weeklyOptions?: WeeklyOptions;
199
+ /** One time options. */
200
+ oneTimeOptions?: OneTimeOptions;
201
+ }
202
+ interface PartySize {
203
+ /**
204
+ * Minimum number of seats a party can reserve.
205
+ * @min 1
206
+ * @max 10000
207
+ */
208
+ min?: number | null;
209
+ /**
210
+ * Maximum number of seats a party can reserve.
211
+ * @min 1
212
+ * @max 10000
213
+ */
214
+ max?: number | null;
215
+ }
216
+ interface NoticePeriod {
217
+ /**
218
+ * The quantity of the chosen time unit.
219
+ * @min 1
220
+ * @max 1000
221
+ */
222
+ number?: number | null;
223
+ /** Time unit. */
224
+ unit?: UnitWithLiterals;
225
+ }
226
+ /** Approval settings. */
227
+ interface Approval {
228
+ /** Approval mode. */
229
+ mode?: ModeWithLiterals;
230
+ }
231
+ interface MaxGuests {
232
+ /**
233
+ * Maximum number of seats that can be reserved for experience at same time.
234
+ * @max 10000
235
+ */
236
+ number?: number | null;
237
+ }
238
+ interface OnlineReservationsBusinessSchedule {
239
+ /**
240
+ * Duration of the experience.
241
+ * @min 1
242
+ * @max 1440
243
+ */
244
+ durationInMinutes?: number | null;
245
+ /**
246
+ * Instances of business schedules.
247
+ * @maxSize 10
248
+ */
249
+ entries?: Entry[];
250
+ /** Do not allow standard reservations during time of experience. */
251
+ doNotAllowStandardReservations?: boolean | null;
252
+ }
253
+ /** Privacy policy. */
254
+ interface PrivacyPolicy extends PrivacyPolicyValueOneOf {
255
+ /** Privacy policy URL. */
256
+ url?: string;
257
+ /**
258
+ * Privacy policy text.
259
+ * @maxLength 1000000
260
+ */
261
+ text?: string | null;
262
+ /**
263
+ * Whether the privacy policy is shown to the customer.
264
+ *
265
+ * Default: `false`
266
+ */
267
+ enabled?: boolean | null;
268
+ }
269
+ /** @oneof */
270
+ interface PrivacyPolicyValueOneOf {
271
+ /** Privacy policy URL. */
272
+ url?: string;
273
+ /**
274
+ * Privacy policy text.
275
+ * @maxLength 1000000
276
+ */
277
+ text?: string | null;
278
+ }
279
+ /** Terms and conditions. */
280
+ interface TermsAndConditions extends TermsAndConditionsValueOneOf {
281
+ /** Terms and conditions URL. */
282
+ url?: string;
283
+ /**
284
+ * Terms and conditions text.
285
+ * @maxLength 1000000
286
+ */
287
+ text?: string | null;
288
+ /**
289
+ * Whether the terms and conditions are shown to the customer.
290
+ *
291
+ * Default: `false`
292
+ */
293
+ enabled?: boolean | null;
294
+ }
295
+ /** @oneof */
296
+ interface TermsAndConditionsValueOneOf {
297
+ /** Terms and conditions URL. */
298
+ url?: string;
299
+ /**
300
+ * Terms and conditions text.
301
+ * @maxLength 1000000
302
+ */
303
+ text?: string | null;
304
+ }
305
+ /** Custom field definition. Definitions of the fields that are added to the reservation form. */
306
+ interface CustomFieldDefinition {
307
+ /**
308
+ * Custom field ID.
309
+ * @format GUID
310
+ * @readonly
311
+ */
312
+ _id?: string | null;
313
+ /**
314
+ * Custom field name.
315
+ * @minLength 1
316
+ * @maxLength 1000
317
+ */
318
+ name?: string | null;
319
+ /**
320
+ * Whether the custom field is required.
321
+ *
322
+ * Default: `false`
323
+ */
324
+ required?: boolean | null;
325
+ }
326
+ /** Email marketing checkbox. */
327
+ interface EmailMarketingCheckbox {
328
+ /**
329
+ * Whether the checkbox is shown to the customer.
330
+ *
331
+ * Default: `false`
332
+ */
333
+ enabled?: boolean | null;
334
+ /**
335
+ * Whether the checkbox is checked by default.
336
+ *
337
+ * Default: `false`
338
+ */
339
+ checkedByDefault?: boolean | null;
340
+ }
341
+ interface RichContent {
342
+ /** Node objects representing a rich content document. */
343
+ nodes?: Node[];
344
+ /** Object metadata. */
345
+ metadata?: Metadata;
346
+ /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
347
+ documentStyle?: DocumentStyle;
348
+ }
349
+ interface Node extends NodeDataOneOf {
350
+ /** Data for a button node. */
351
+ buttonData?: ButtonData;
352
+ /** Data for a code block node. */
353
+ codeBlockData?: CodeBlockData;
354
+ /** Data for a divider node. */
355
+ dividerData?: DividerData;
356
+ /** Data for a file node. */
357
+ fileData?: FileData;
358
+ /** Data for a gallery node. */
359
+ galleryData?: GalleryData;
360
+ /** Data for a GIF node. */
361
+ gifData?: GIFData;
362
+ /** Data for a heading node. */
363
+ headingData?: HeadingData;
364
+ /** Data for an embedded HTML node. */
365
+ htmlData?: HTMLData;
366
+ /** Data for an image node. */
367
+ imageData?: ImageData;
368
+ /** Data for a link preview node. */
369
+ linkPreviewData?: LinkPreviewData;
370
+ /** @deprecated */
371
+ mapData?: MapData;
372
+ /** Data for a paragraph node. */
373
+ paragraphData?: ParagraphData;
374
+ /** Data for a poll node. */
375
+ pollData?: PollData;
376
+ /** Data for a text node. Used to apply decorations to text. */
377
+ textData?: TextData;
378
+ /** Data for an app embed node. */
379
+ appEmbedData?: AppEmbedData;
380
+ /** Data for a video node. */
381
+ videoData?: VideoData;
382
+ /** Data for an oEmbed node. */
383
+ embedData?: EmbedData;
384
+ /** Data for a collapsible list node. */
385
+ collapsibleListData?: CollapsibleListData;
386
+ /** Data for a table node. */
387
+ tableData?: TableData;
388
+ /** Data for a table cell node. */
389
+ tableCellData?: TableCellData;
390
+ /** Data for a custom external node. */
391
+ externalData?: Record<string, any> | null;
392
+ /** Data for an audio node. */
393
+ audioData?: AudioData;
394
+ /** Data for an ordered list node. */
395
+ orderedListData?: OrderedListData;
396
+ /** Data for a bulleted list node. */
397
+ bulletedListData?: BulletedListData;
398
+ /** Data for a block quote node. */
399
+ blockquoteData?: BlockquoteData;
400
+ /** Data for a caption node. */
401
+ captionData?: CaptionData;
402
+ /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
403
+ layoutCellData?: LayoutCellData;
404
+ /** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
405
+ type?: NodeTypeWithLiterals;
406
+ /** Node ID. */
407
+ id?: string;
408
+ /** A list of child nodes. */
409
+ nodes?: Node[];
410
+ /** Padding and background color styling for the node. */
411
+ style?: NodeStyle;
412
+ }
413
+ /** @oneof */
414
+ interface NodeDataOneOf {
415
+ /** Data for a button node. */
416
+ buttonData?: ButtonData;
417
+ /** Data for a code block node. */
418
+ codeBlockData?: CodeBlockData;
419
+ /** Data for a divider node. */
420
+ dividerData?: DividerData;
421
+ /** Data for a file node. */
422
+ fileData?: FileData;
423
+ /** Data for a gallery node. */
424
+ galleryData?: GalleryData;
425
+ /** Data for a GIF node. */
426
+ gifData?: GIFData;
427
+ /** Data for a heading node. */
428
+ headingData?: HeadingData;
429
+ /** Data for an embedded HTML node. */
430
+ htmlData?: HTMLData;
431
+ /** Data for an image node. */
432
+ imageData?: ImageData;
433
+ /** Data for a link preview node. */
434
+ linkPreviewData?: LinkPreviewData;
435
+ /** @deprecated */
436
+ mapData?: MapData;
437
+ /** Data for a paragraph node. */
438
+ paragraphData?: ParagraphData;
439
+ /** Data for a poll node. */
440
+ pollData?: PollData;
441
+ /** Data for a text node. Used to apply decorations to text. */
442
+ textData?: TextData;
443
+ /** Data for an app embed node. */
444
+ appEmbedData?: AppEmbedData;
445
+ /** Data for a video node. */
446
+ videoData?: VideoData;
447
+ /** Data for an oEmbed node. */
448
+ embedData?: EmbedData;
449
+ /** Data for a collapsible list node. */
450
+ collapsibleListData?: CollapsibleListData;
451
+ /** Data for a table node. */
452
+ tableData?: TableData;
453
+ /** Data for a table cell node. */
454
+ tableCellData?: TableCellData;
455
+ /** Data for a custom external node. */
456
+ externalData?: Record<string, any> | null;
457
+ /** Data for an audio node. */
458
+ audioData?: AudioData;
459
+ /** Data for an ordered list node. */
460
+ orderedListData?: OrderedListData;
461
+ /** Data for a bulleted list node. */
462
+ bulletedListData?: BulletedListData;
463
+ /** Data for a block quote node. */
464
+ blockquoteData?: BlockquoteData;
465
+ /** Data for a caption node. */
466
+ captionData?: CaptionData;
467
+ /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
468
+ layoutCellData?: LayoutCellData;
469
+ }
470
+ declare enum NodeType {
471
+ PARAGRAPH = "PARAGRAPH",
472
+ TEXT = "TEXT",
473
+ HEADING = "HEADING",
474
+ BULLETED_LIST = "BULLETED_LIST",
475
+ ORDERED_LIST = "ORDERED_LIST",
476
+ LIST_ITEM = "LIST_ITEM",
477
+ BLOCKQUOTE = "BLOCKQUOTE",
478
+ CODE_BLOCK = "CODE_BLOCK",
479
+ VIDEO = "VIDEO",
480
+ DIVIDER = "DIVIDER",
481
+ FILE = "FILE",
482
+ GALLERY = "GALLERY",
483
+ GIF = "GIF",
484
+ HTML = "HTML",
485
+ IMAGE = "IMAGE",
486
+ LINK_PREVIEW = "LINK_PREVIEW",
487
+ /** @deprecated */
488
+ MAP = "MAP",
489
+ POLL = "POLL",
490
+ APP_EMBED = "APP_EMBED",
491
+ BUTTON = "BUTTON",
492
+ COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
493
+ TABLE = "TABLE",
494
+ EMBED = "EMBED",
495
+ COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
496
+ COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
497
+ COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
498
+ TABLE_CELL = "TABLE_CELL",
499
+ TABLE_ROW = "TABLE_ROW",
500
+ EXTERNAL = "EXTERNAL",
501
+ AUDIO = "AUDIO",
502
+ CAPTION = "CAPTION",
503
+ LAYOUT = "LAYOUT",
504
+ LAYOUT_CELL = "LAYOUT_CELL"
505
+ }
506
+ /** @enumType */
507
+ type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
508
+ interface NodeStyle {
509
+ /** The top padding value in pixels. */
510
+ paddingTop?: string | null;
511
+ /** The bottom padding value in pixels. */
512
+ paddingBottom?: string | null;
513
+ /** The background color as a hexadecimal value. */
514
+ backgroundColor?: string | null;
515
+ }
516
+ interface ButtonData {
517
+ /** Styling for the button's container. */
518
+ containerData?: PluginContainerData;
519
+ /** The button type. */
520
+ type?: ButtonDataTypeWithLiterals;
521
+ /** Styling for the button. */
522
+ styles?: Styles;
523
+ /** The text to display on the button. */
524
+ text?: string | null;
525
+ /** Button link details. */
526
+ link?: Link;
527
+ }
528
+ interface Border {
529
+ /**
530
+ * Deprecated: Use `borderWidth` in `styles` instead.
531
+ * @deprecated
532
+ */
533
+ width?: number | null;
534
+ /**
535
+ * Deprecated: Use `borderRadius` in `styles` instead.
536
+ * @deprecated
537
+ */
538
+ radius?: number | null;
539
+ }
540
+ interface Colors {
541
+ /**
542
+ * Deprecated: Use `textColor` in `styles` instead.
543
+ * @deprecated
544
+ */
545
+ text?: string | null;
546
+ /**
547
+ * Deprecated: Use `borderColor` in `styles` instead.
548
+ * @deprecated
549
+ */
550
+ border?: string | null;
551
+ /**
552
+ * Deprecated: Use `backgroundColor` in `styles` instead.
553
+ * @deprecated
554
+ */
555
+ background?: string | null;
556
+ }
557
+ interface PluginContainerData {
558
+ /** The width of the node when it's displayed. */
559
+ width?: PluginContainerDataWidth;
560
+ /** The node's alignment within its container. */
561
+ alignment?: PluginContainerDataAlignmentWithLiterals;
562
+ /** Spoiler cover settings for the node. */
563
+ spoiler?: Spoiler;
564
+ /** The height of the node when it's displayed. */
565
+ height?: Height;
566
+ /** Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. */
567
+ textWrap?: boolean | null;
568
+ }
569
+ declare enum WidthType {
570
+ /** Width matches the content width */
571
+ CONTENT = "CONTENT",
572
+ /** Small Width */
573
+ SMALL = "SMALL",
574
+ /** Width will match the original asset width */
575
+ ORIGINAL = "ORIGINAL",
576
+ /** coast-to-coast display */
577
+ FULL_WIDTH = "FULL_WIDTH"
578
+ }
579
+ /** @enumType */
580
+ type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
581
+ interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
582
+ /**
583
+ * One of the following predefined width options:
584
+ * `CONTENT`: The width of the container matches the content width.
585
+ * `SMALL`: A small width.
586
+ * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
587
+ * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
588
+ */
589
+ size?: WidthTypeWithLiterals;
590
+ /** A custom width value in pixels. */
591
+ custom?: string | null;
592
+ }
593
+ /** @oneof */
594
+ interface PluginContainerDataWidthDataOneOf {
595
+ /**
596
+ * One of the following predefined width options:
597
+ * `CONTENT`: The width of the container matches the content width.
598
+ * `SMALL`: A small width.
599
+ * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
600
+ * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
601
+ */
602
+ size?: WidthTypeWithLiterals;
603
+ /** A custom width value in pixels. */
604
+ custom?: string | null;
605
+ }
606
+ declare enum PluginContainerDataAlignment {
607
+ /** Center Alignment */
608
+ CENTER = "CENTER",
609
+ /** Left Alignment */
610
+ LEFT = "LEFT",
611
+ /** Right Alignment */
612
+ RIGHT = "RIGHT"
613
+ }
614
+ /** @enumType */
615
+ type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
616
+ interface Spoiler {
617
+ /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
618
+ enabled?: boolean | null;
619
+ /** The description displayed on top of the spoiler cover. */
620
+ description?: string | null;
621
+ /** The text for the button used to remove the spoiler cover. */
622
+ buttonText?: string | null;
623
+ }
624
+ interface Height {
625
+ /** A custom height value in pixels. */
626
+ custom?: string | null;
627
+ }
628
+ declare enum ButtonDataType {
629
+ /** Regular link button */
630
+ LINK = "LINK",
631
+ /** Triggers custom action that is defined in plugin configuration by the consumer */
632
+ ACTION = "ACTION"
633
+ }
634
+ /** @enumType */
635
+ type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
636
+ interface Styles {
637
+ /**
638
+ * Deprecated: Use `borderWidth` and `borderRadius` instead.
639
+ * @deprecated
640
+ */
641
+ border?: Border;
642
+ /**
643
+ * Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
644
+ * @deprecated
645
+ */
646
+ colors?: Colors;
647
+ /** Border width in pixels. */
648
+ borderWidth?: number | null;
649
+ /**
650
+ * Deprecated: Use `borderWidth` for normal/hover states instead.
651
+ * @deprecated
652
+ */
653
+ borderWidthHover?: number | null;
654
+ /** Border radius in pixels. */
655
+ borderRadius?: number | null;
656
+ /**
657
+ * Border color as a hexadecimal value.
658
+ * @format COLOR_HEX
659
+ */
660
+ borderColor?: string | null;
661
+ /**
662
+ * Border color as a hexadecimal value (hover state).
663
+ * @format COLOR_HEX
664
+ */
665
+ borderColorHover?: string | null;
666
+ /**
667
+ * Text color as a hexadecimal value.
668
+ * @format COLOR_HEX
669
+ */
670
+ textColor?: string | null;
671
+ /**
672
+ * Text color as a hexadecimal value (hover state).
673
+ * @format COLOR_HEX
674
+ */
675
+ textColorHover?: string | null;
676
+ /**
677
+ * Background color as a hexadecimal value.
678
+ * @format COLOR_HEX
679
+ */
680
+ backgroundColor?: string | null;
681
+ /**
682
+ * Background color as a hexadecimal value (hover state).
683
+ * @format COLOR_HEX
684
+ */
685
+ backgroundColorHover?: string | null;
686
+ /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
687
+ buttonSize?: string | null;
688
+ }
689
+ interface Link extends LinkDataOneOf {
690
+ /** The absolute URL for the linked document. */
691
+ url?: string;
692
+ /** The target node's ID. Used for linking to another node in this object. */
693
+ anchor?: string;
694
+ /**
695
+ * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
696
+ * `SELF` - Default. Opens the linked document in the same frame as the link.
697
+ * `BLANK` - Opens the linked document in a new browser tab or window.
698
+ * `PARENT` - Opens the linked document in the link's parent frame.
699
+ * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
700
+ */
701
+ target?: TargetWithLiterals;
702
+ /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
703
+ rel?: Rel;
704
+ /** A serialized object used for a custom or external link panel. */
705
+ customData?: string | null;
706
+ }
707
+ /** @oneof */
708
+ interface LinkDataOneOf {
709
+ /** The absolute URL for the linked document. */
710
+ url?: string;
711
+ /** The target node's ID. Used for linking to another node in this object. */
712
+ anchor?: string;
713
+ }
714
+ declare enum Target {
715
+ /** Opens the linked document in the same frame as it was clicked (this is default) */
716
+ SELF = "SELF",
717
+ /** Opens the linked document in a new window or tab */
718
+ BLANK = "BLANK",
719
+ /** Opens the linked document in the parent frame */
720
+ PARENT = "PARENT",
721
+ /** Opens the linked document in the full body of the window */
722
+ TOP = "TOP"
723
+ }
724
+ /** @enumType */
725
+ type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
726
+ interface Rel {
727
+ /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
728
+ nofollow?: boolean | null;
729
+ /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
730
+ sponsored?: boolean | null;
731
+ /** Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`. */
732
+ ugc?: boolean | null;
733
+ /** Indicates that this link protect referral information from being passed to the target website. */
734
+ noreferrer?: boolean | null;
735
+ }
736
+ interface CodeBlockData {
737
+ /** Styling for the code block's text. */
738
+ textStyle?: TextStyle;
739
+ }
740
+ interface TextStyle {
741
+ /** Text alignment. Defaults to `AUTO`. */
742
+ textAlignment?: TextAlignmentWithLiterals;
743
+ /** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
744
+ lineHeight?: string | null;
745
+ }
746
+ declare enum TextAlignment {
747
+ /** browser default, eqivalent to `initial` */
748
+ AUTO = "AUTO",
749
+ /** Left align */
750
+ LEFT = "LEFT",
751
+ /** Right align */
752
+ RIGHT = "RIGHT",
753
+ /** Center align */
754
+ CENTER = "CENTER",
755
+ /** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
756
+ JUSTIFY = "JUSTIFY"
757
+ }
758
+ /** @enumType */
759
+ type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
760
+ interface DividerData {
761
+ /** Styling for the divider's container. */
762
+ containerData?: PluginContainerData;
763
+ /** Divider line style. */
764
+ lineStyle?: LineStyleWithLiterals;
765
+ /** Divider width. */
766
+ width?: WidthWithLiterals;
767
+ /** Divider alignment. */
768
+ alignment?: DividerDataAlignmentWithLiterals;
769
+ }
770
+ declare enum LineStyle {
771
+ /** Single Line */
772
+ SINGLE = "SINGLE",
773
+ /** Double Line */
774
+ DOUBLE = "DOUBLE",
775
+ /** Dashed Line */
776
+ DASHED = "DASHED",
777
+ /** Dotted Line */
778
+ DOTTED = "DOTTED"
779
+ }
780
+ /** @enumType */
781
+ type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
782
+ declare enum Width {
783
+ /** Large line */
784
+ LARGE = "LARGE",
785
+ /** Medium line */
786
+ MEDIUM = "MEDIUM",
787
+ /** Small line */
788
+ SMALL = "SMALL"
789
+ }
790
+ /** @enumType */
791
+ type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
792
+ declare enum DividerDataAlignment {
793
+ /** Center alignment */
794
+ CENTER = "CENTER",
795
+ /** Left alignment */
796
+ LEFT = "LEFT",
797
+ /** Right alignment */
798
+ RIGHT = "RIGHT"
799
+ }
800
+ /** @enumType */
801
+ type DividerDataAlignmentWithLiterals = DividerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
802
+ interface FileData {
803
+ /** Styling for the file's container. */
804
+ containerData?: PluginContainerData;
805
+ /** The source for the file's data. */
806
+ src?: FileSource;
807
+ /** File name. */
808
+ name?: string | null;
809
+ /** File type. */
810
+ type?: string | null;
811
+ /**
812
+ * Use `sizeInKb` instead.
813
+ * @deprecated
814
+ */
815
+ size?: number | null;
816
+ /** Settings for PDF files. */
817
+ pdfSettings?: PDFSettings;
818
+ /** File MIME type. */
819
+ mimeType?: string | null;
820
+ /** File path. */
821
+ path?: string | null;
822
+ /** File size in KB. */
823
+ sizeInKb?: string | null;
824
+ }
825
+ declare enum ViewMode {
826
+ /** No PDF view */
827
+ NONE = "NONE",
828
+ /** Full PDF view */
829
+ FULL = "FULL",
830
+ /** Mini PDF view */
831
+ MINI = "MINI"
832
+ }
833
+ /** @enumType */
834
+ type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
835
+ interface FileSource extends FileSourceDataOneOf {
836
+ /** The absolute URL for the file's source. */
837
+ url?: string | null;
838
+ /**
839
+ * Custom ID. Use `id` instead.
840
+ * @deprecated
841
+ */
842
+ custom?: string | null;
843
+ /** An ID that's resolved to a URL by a resolver function. */
844
+ id?: string | null;
845
+ /** Indicates whether the file's source is private. Defaults to `false`. */
846
+ private?: boolean | null;
847
+ }
848
+ /** @oneof */
849
+ interface FileSourceDataOneOf {
850
+ /** The absolute URL for the file's source. */
851
+ url?: string | null;
852
+ /**
853
+ * Custom ID. Use `id` instead.
854
+ * @deprecated
855
+ */
856
+ custom?: string | null;
857
+ /** An ID that's resolved to a URL by a resolver function. */
858
+ id?: string | null;
859
+ }
860
+ interface PDFSettings {
861
+ /**
862
+ * PDF view mode. One of the following:
863
+ * `NONE` : The PDF isn't displayed.
864
+ * `FULL` : A full page view of the PDF is displayed.
865
+ * `MINI` : A mini view of the PDF is displayed.
866
+ */
867
+ viewMode?: ViewModeWithLiterals;
868
+ /** Sets whether the PDF download button is disabled. Defaults to `false`. */
869
+ disableDownload?: boolean | null;
870
+ /** Sets whether the PDF print button is disabled. Defaults to `false`. */
871
+ disablePrint?: boolean | null;
872
+ }
873
+ interface GalleryData {
874
+ /** Styling for the gallery's container. */
875
+ containerData?: PluginContainerData;
876
+ /** The items in the gallery. */
877
+ items?: Item[];
878
+ /** Options for defining the gallery's appearance. */
879
+ options?: GalleryOptions;
880
+ /** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
881
+ disableExpand?: boolean | null;
882
+ /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
883
+ disableDownload?: boolean | null;
884
+ }
885
+ interface Media {
886
+ /** The source for the media's data. */
887
+ src?: FileSource;
888
+ /** Media width in pixels. */
889
+ width?: number | null;
890
+ /** Media height in pixels. */
891
+ height?: number | null;
892
+ /** Media duration in seconds. Only relevant for audio and video files. */
893
+ duration?: number | null;
894
+ }
895
+ interface Image {
896
+ /** Image file details. */
897
+ media?: Media;
898
+ /** Link details for images that are links. */
899
+ link?: Link;
900
+ }
901
+ interface Video {
902
+ /** Video file details. */
903
+ media?: Media;
904
+ /** Video thumbnail file details. */
905
+ thumbnail?: Media;
906
+ }
907
+ interface Item extends ItemDataOneOf {
908
+ /** An image item. */
909
+ image?: Image;
910
+ /** A video item. */
911
+ video?: Video;
912
+ /** Item title. */
913
+ title?: string | null;
914
+ /** Item's alternative text. */
915
+ altText?: string | null;
916
+ }
917
+ /** @oneof */
918
+ interface ItemDataOneOf {
919
+ /** An image item. */
920
+ image?: Image;
921
+ /** A video item. */
922
+ video?: Video;
923
+ }
924
+ interface GalleryOptions {
925
+ /** Gallery layout. */
926
+ layout?: GalleryOptionsLayout;
927
+ /** Styling for gallery items. */
928
+ item?: ItemStyle;
929
+ /** Styling for gallery thumbnail images. */
930
+ thumbnails?: Thumbnails;
931
+ }
932
+ declare enum LayoutType {
933
+ /** Collage type */
934
+ COLLAGE = "COLLAGE",
935
+ /** Masonry type */
936
+ MASONRY = "MASONRY",
937
+ /** Grid type */
938
+ GRID = "GRID",
939
+ /** Thumbnail type */
940
+ THUMBNAIL = "THUMBNAIL",
941
+ /** Slider type */
942
+ SLIDER = "SLIDER",
943
+ /** Slideshow type */
944
+ SLIDESHOW = "SLIDESHOW",
945
+ /** Panorama type */
946
+ PANORAMA = "PANORAMA",
947
+ /** Column type */
948
+ COLUMN = "COLUMN",
949
+ /** Magic type */
950
+ MAGIC = "MAGIC",
951
+ /** Fullsize images type */
952
+ FULLSIZE = "FULLSIZE"
953
+ }
954
+ /** @enumType */
955
+ type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
956
+ declare enum Orientation {
957
+ /** Rows Orientation */
958
+ ROWS = "ROWS",
959
+ /** Columns Orientation */
960
+ COLUMNS = "COLUMNS"
961
+ }
962
+ /** @enumType */
963
+ type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
964
+ declare enum Crop {
965
+ /** Crop to fill */
966
+ FILL = "FILL",
967
+ /** Crop to fit */
968
+ FIT = "FIT"
969
+ }
970
+ /** @enumType */
971
+ type CropWithLiterals = Crop | 'FILL' | 'FIT';
972
+ declare enum ThumbnailsAlignment {
973
+ /** Top alignment */
974
+ TOP = "TOP",
975
+ /** Right alignment */
976
+ RIGHT = "RIGHT",
977
+ /** Bottom alignment */
978
+ BOTTOM = "BOTTOM",
979
+ /** Left alignment */
980
+ LEFT = "LEFT",
981
+ /** No thumbnail */
982
+ NONE = "NONE"
983
+ }
984
+ /** @enumType */
985
+ type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
986
+ interface GalleryOptionsLayout {
987
+ /** Gallery layout type. */
988
+ type?: LayoutTypeWithLiterals;
989
+ /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
990
+ horizontalScroll?: boolean | null;
991
+ /** Gallery orientation. */
992
+ orientation?: OrientationWithLiterals;
993
+ /** The number of columns to display on full size screens. */
994
+ numberOfColumns?: number | null;
995
+ /** The number of columns to display on mobile screens. */
996
+ mobileNumberOfColumns?: number | null;
997
+ }
998
+ interface ItemStyle {
999
+ /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
1000
+ targetSize?: number | null;
1001
+ /** Item ratio */
1002
+ ratio?: number | null;
1003
+ /** Sets how item images are cropped. */
1004
+ crop?: CropWithLiterals;
1005
+ /** The spacing between items in pixels. */
1006
+ spacing?: number | null;
1007
+ }
1008
+ interface Thumbnails {
1009
+ /** Thumbnail alignment. */
1010
+ placement?: ThumbnailsAlignmentWithLiterals;
1011
+ /** Spacing between thumbnails in pixels. */
1012
+ spacing?: number | null;
1013
+ }
1014
+ interface GIFData {
1015
+ /** Styling for the GIF's container. */
1016
+ containerData?: PluginContainerData;
1017
+ /** The source of the full size GIF. */
1018
+ original?: GIF;
1019
+ /** The source of the downsized GIF. */
1020
+ downsized?: GIF;
1021
+ /** Height in pixels. */
1022
+ height?: number;
1023
+ /** Width in pixels. */
1024
+ width?: number;
1025
+ /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
1026
+ gifType?: GIFTypeWithLiterals;
1027
+ }
1028
+ interface GIF {
1029
+ /**
1030
+ * GIF format URL.
1031
+ * @format WEB_URL
1032
+ */
1033
+ gif?: string | null;
1034
+ /**
1035
+ * MP4 format URL.
1036
+ * @format WEB_URL
1037
+ */
1038
+ mp4?: string | null;
1039
+ /**
1040
+ * Thumbnail URL.
1041
+ * @format WEB_URL
1042
+ */
1043
+ still?: string | null;
1044
+ }
1045
+ declare enum GIFType {
1046
+ NORMAL = "NORMAL",
1047
+ STICKER = "STICKER"
1048
+ }
1049
+ /** @enumType */
1050
+ type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
1051
+ interface HeadingData {
1052
+ /** Heading level from 1-6. */
1053
+ level?: number;
1054
+ /** Styling for the heading text. */
1055
+ textStyle?: TextStyle;
1056
+ /** Indentation level from 1-4. */
1057
+ indentation?: number | null;
1058
+ }
1059
+ interface HTMLData extends HTMLDataDataOneOf {
1060
+ /** The URL for the HTML code for the node. */
1061
+ url?: string;
1062
+ /** The HTML code for the node. */
1063
+ html?: string;
1064
+ /**
1065
+ * Whether this is an AdSense element. Use `source` instead.
1066
+ * @deprecated
1067
+ */
1068
+ isAdsense?: boolean | null;
1069
+ /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
1070
+ containerData?: PluginContainerData;
1071
+ /** The type of HTML code. */
1072
+ source?: SourceWithLiterals;
1073
+ /** If container height is aligned with its content height. Defaults to `true`. */
1074
+ autoHeight?: boolean | null;
1075
+ }
1076
+ /** @oneof */
1077
+ interface HTMLDataDataOneOf {
1078
+ /** The URL for the HTML code for the node. */
1079
+ url?: string;
1080
+ /** The HTML code for the node. */
1081
+ html?: string;
1082
+ /**
1083
+ * Whether this is an AdSense element. Use `source` instead.
1084
+ * @deprecated
1085
+ */
1086
+ isAdsense?: boolean | null;
1087
+ }
1088
+ declare enum Source {
1089
+ HTML = "HTML",
1090
+ ADSENSE = "ADSENSE"
1091
+ }
1092
+ /** @enumType */
1093
+ type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
1094
+ interface ImageData {
1095
+ /** Styling for the image's container. */
1096
+ containerData?: PluginContainerData;
1097
+ /** Image file details. */
1098
+ image?: Media;
1099
+ /** Link details for images that are links. */
1100
+ link?: Link;
1101
+ /** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
1102
+ disableExpand?: boolean | null;
1103
+ /** Image's alternative text. */
1104
+ altText?: string | null;
1105
+ /**
1106
+ * Deprecated: use Caption node instead.
1107
+ * @deprecated
1108
+ */
1109
+ caption?: string | null;
1110
+ /** Sets whether the image's download button is disabled. Defaults to `false`. */
1111
+ disableDownload?: boolean | null;
1112
+ /** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
1113
+ decorative?: boolean | null;
1114
+ /** Styling for the image. */
1115
+ styles?: ImageDataStyles;
1116
+ }
1117
+ interface StylesBorder {
1118
+ /** Border width in pixels. */
1119
+ width?: number | null;
1120
+ /**
1121
+ * Border color as a hexadecimal value.
1122
+ * @format COLOR_HEX
1123
+ */
1124
+ color?: string | null;
1125
+ /** Border radius in pixels. */
1126
+ radius?: number | null;
1127
+ }
1128
+ interface ImageDataStyles {
1129
+ /** Border attributes. */
1130
+ border?: StylesBorder;
1131
+ }
1132
+ interface LinkPreviewData {
1133
+ /** Styling for the link preview's container. */
1134
+ containerData?: PluginContainerData;
1135
+ /** Link details. */
1136
+ link?: Link;
1137
+ /** Preview title. */
1138
+ title?: string | null;
1139
+ /** Preview thumbnail URL. */
1140
+ thumbnailUrl?: string | null;
1141
+ /** Preview description. */
1142
+ description?: string | null;
1143
+ /** The preview content as HTML. */
1144
+ html?: string | null;
1145
+ /** Styling for the link preview. */
1146
+ styles?: LinkPreviewDataStyles;
1147
+ }
1148
+ declare enum StylesPosition {
1149
+ /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
1150
+ START = "START",
1151
+ /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
1152
+ END = "END",
1153
+ /** Thumbnail positioned at the top */
1154
+ TOP = "TOP",
1155
+ /** Thumbnail hidden and not displayed */
1156
+ HIDDEN = "HIDDEN"
1157
+ }
1158
+ /** @enumType */
1159
+ type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HIDDEN';
1160
+ interface LinkPreviewDataStyles {
1161
+ /**
1162
+ * Background color as a hexadecimal value.
1163
+ * @format COLOR_HEX
1164
+ */
1165
+ backgroundColor?: string | null;
1166
+ /**
1167
+ * Title color as a hexadecimal value.
1168
+ * @format COLOR_HEX
1169
+ */
1170
+ titleColor?: string | null;
1171
+ /**
1172
+ * Subtitle color as a hexadecimal value.
1173
+ * @format COLOR_HEX
1174
+ */
1175
+ subtitleColor?: string | null;
1176
+ /**
1177
+ * Link color as a hexadecimal value.
1178
+ * @format COLOR_HEX
1179
+ */
1180
+ linkColor?: string | null;
1181
+ /** Border width in pixels. */
1182
+ borderWidth?: number | null;
1183
+ /** Border radius in pixels. */
1184
+ borderRadius?: number | null;
1185
+ /**
1186
+ * Border color as a hexadecimal value.
1187
+ * @format COLOR_HEX
1188
+ */
1189
+ borderColor?: string | null;
1190
+ /** Position of thumbnail. Defaults to `START`. */
1191
+ thumbnailPosition?: StylesPositionWithLiterals;
1192
+ }
1193
+ interface MapData {
1194
+ /** Styling for the map's container. */
1195
+ containerData?: PluginContainerData;
1196
+ /** Map settings. */
1197
+ mapSettings?: MapSettings;
1198
+ }
1199
+ interface MapSettings {
1200
+ /** The address to display on the map. */
1201
+ address?: string | null;
1202
+ /** Sets whether the map is draggable. */
1203
+ draggable?: boolean | null;
1204
+ /** Sets whether the location marker is visible. */
1205
+ marker?: boolean | null;
1206
+ /** Sets whether street view control is enabled. */
1207
+ streetViewControl?: boolean | null;
1208
+ /** Sets whether zoom control is enabled. */
1209
+ zoomControl?: boolean | null;
1210
+ /** Location latitude. */
1211
+ lat?: number | null;
1212
+ /** Location longitude. */
1213
+ lng?: number | null;
1214
+ /** Location name. */
1215
+ locationName?: string | null;
1216
+ /** Sets whether view mode control is enabled. */
1217
+ viewModeControl?: boolean | null;
1218
+ /** Initial zoom value. */
1219
+ initialZoom?: number | null;
1220
+ /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
1221
+ mapType?: MapTypeWithLiterals;
1222
+ }
1223
+ declare enum MapType {
1224
+ /** Roadmap map type */
1225
+ ROADMAP = "ROADMAP",
1226
+ /** Satellite map type */
1227
+ SATELITE = "SATELITE",
1228
+ /** Hybrid map type */
1229
+ HYBRID = "HYBRID",
1230
+ /** Terrain map type */
1231
+ TERRAIN = "TERRAIN"
1232
+ }
1233
+ /** @enumType */
1234
+ type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
1235
+ interface ParagraphData {
1236
+ /** Styling for the paragraph text. */
1237
+ textStyle?: TextStyle;
1238
+ /** Indentation level from 1-4. */
1239
+ indentation?: number | null;
1240
+ /** Paragraph level */
1241
+ level?: number | null;
1242
+ }
1243
+ interface PollData {
1244
+ /** Styling for the poll's container. */
1245
+ containerData?: PluginContainerData;
1246
+ /** Poll data. */
1247
+ poll?: Poll;
1248
+ /** Layout settings for the poll and voting options. */
1249
+ layout?: PollDataLayout;
1250
+ /** Styling for the poll and voting options. */
1251
+ design?: Design;
1252
+ }
1253
+ declare enum ViewRole {
1254
+ /** Only Poll creator can view the results */
1255
+ CREATOR = "CREATOR",
1256
+ /** Anyone who voted can see the results */
1257
+ VOTERS = "VOTERS",
1258
+ /** Anyone can see the results, even if one didn't vote */
1259
+ EVERYONE = "EVERYONE"
1260
+ }
1261
+ /** @enumType */
1262
+ type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
1263
+ declare enum VoteRole {
1264
+ /** Logged in member */
1265
+ SITE_MEMBERS = "SITE_MEMBERS",
1266
+ /** Anyone */
1267
+ ALL = "ALL"
1268
+ }
1269
+ /** @enumType */
1270
+ type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
1271
+ interface Permissions {
1272
+ /** Sets who can view the poll results. */
1273
+ view?: ViewRoleWithLiterals;
1274
+ /** Sets who can vote. */
1275
+ vote?: VoteRoleWithLiterals;
1276
+ /** Sets whether one voter can vote multiple times. Defaults to `false`. */
1277
+ allowMultipleVotes?: boolean | null;
1278
+ }
1279
+ interface Option {
1280
+ /** Option ID. */
1281
+ id?: string | null;
1282
+ /** Option title. */
1283
+ title?: string | null;
1284
+ /** The image displayed with the option. */
1285
+ image?: Media;
1286
+ }
1287
+ interface Settings {
1288
+ /** Permissions settings for voting. */
1289
+ permissions?: Permissions;
1290
+ /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
1291
+ showVoters?: boolean | null;
1292
+ /** Sets whether the vote count is displayed. Defaults to `true`. */
1293
+ showVotesCount?: boolean | null;
1294
+ }
1295
+ declare enum PollLayoutType {
1296
+ /** List */
1297
+ LIST = "LIST",
1298
+ /** Grid */
1299
+ GRID = "GRID"
1300
+ }
1301
+ /** @enumType */
1302
+ type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
1303
+ declare enum PollLayoutDirection {
1304
+ /** Left-to-right */
1305
+ LTR = "LTR",
1306
+ /** Right-to-left */
1307
+ RTL = "RTL"
1308
+ }
1309
+ /** @enumType */
1310
+ type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
1311
+ interface PollLayout {
1312
+ /** The layout for displaying the voting options. */
1313
+ type?: PollLayoutTypeWithLiterals;
1314
+ /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
1315
+ direction?: PollLayoutDirectionWithLiterals;
1316
+ /** Sets whether to display the main poll image. Defaults to `false`. */
1317
+ enableImage?: boolean | null;
1318
+ }
1319
+ interface OptionLayout {
1320
+ /** Sets whether to display option images. Defaults to `false`. */
1321
+ enableImage?: boolean | null;
1322
+ }
1323
+ declare enum BackgroundType {
1324
+ /** Color background type */
1325
+ COLOR = "COLOR",
1326
+ /** Image background type */
1327
+ IMAGE = "IMAGE",
1328
+ /** Gradiant background type */
1329
+ GRADIENT = "GRADIENT"
1330
+ }
1331
+ /** @enumType */
1332
+ type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
1333
+ interface Gradient {
1334
+ /** The gradient angle in degrees. */
1335
+ angle?: number | null;
1336
+ /**
1337
+ * The start color as a hexademical value.
1338
+ * @format COLOR_HEX
1339
+ */
1340
+ startColor?: string | null;
1341
+ /**
1342
+ * The end color as a hexademical value.
1343
+ * @format COLOR_HEX
1344
+ */
1345
+ lastColor?: string | null;
1346
+ }
1347
+ interface Background extends BackgroundBackgroundOneOf {
1348
+ /**
1349
+ * The background color as a hexademical value.
1350
+ * @format COLOR_HEX
1351
+ */
1352
+ color?: string | null;
1353
+ /** An image to use for the background. */
1354
+ image?: Media;
1355
+ /** Details for a gradient background. */
1356
+ gradient?: Gradient;
1357
+ /** Background type. For each option, include the relevant details. */
1358
+ type?: BackgroundTypeWithLiterals;
1359
+ }
1360
+ /** @oneof */
1361
+ interface BackgroundBackgroundOneOf {
1362
+ /**
1363
+ * The background color as a hexademical value.
1364
+ * @format COLOR_HEX
1365
+ */
1366
+ color?: string | null;
1367
+ /** An image to use for the background. */
1368
+ image?: Media;
1369
+ /** Details for a gradient background. */
1370
+ gradient?: Gradient;
1371
+ }
1372
+ interface PollDesign {
1373
+ /** Background styling. */
1374
+ background?: Background;
1375
+ /** Border radius in pixels. */
1376
+ borderRadius?: number | null;
1377
+ }
1378
+ interface OptionDesign {
1379
+ /** Border radius in pixels. */
1380
+ borderRadius?: number | null;
1381
+ }
1382
+ interface Poll {
1383
+ /** Poll ID. */
1384
+ id?: string | null;
1385
+ /** Poll title. */
1386
+ title?: string | null;
1387
+ /** Poll creator ID. */
1388
+ creatorId?: string | null;
1389
+ /** Main poll image. */
1390
+ image?: Media;
1391
+ /** Voting options. */
1392
+ options?: Option[];
1393
+ /** The poll's permissions and display settings. */
1394
+ settings?: Settings;
1395
+ }
1396
+ interface PollDataLayout {
1397
+ /** Poll layout settings. */
1398
+ poll?: PollLayout;
1399
+ /** Voting otpions layout settings. */
1400
+ options?: OptionLayout;
1401
+ }
1402
+ interface Design {
1403
+ /** Styling for the poll. */
1404
+ poll?: PollDesign;
1405
+ /** Styling for voting options. */
1406
+ options?: OptionDesign;
1407
+ }
1408
+ interface TextData {
1409
+ /** The text to apply decorations to. */
1410
+ text?: string;
1411
+ /** The decorations to apply. */
1412
+ decorations?: Decoration[];
1413
+ }
1414
+ /** Adds appearence changes to text */
1415
+ interface Decoration extends DecorationDataOneOf {
1416
+ /** Data for an anchor link decoration. */
1417
+ anchorData?: AnchorData;
1418
+ /** Data for a color decoration. */
1419
+ colorData?: ColorData;
1420
+ /** Data for an external link decoration. */
1421
+ linkData?: LinkData;
1422
+ /** Data for a mention decoration. */
1423
+ mentionData?: MentionData;
1424
+ /** Data for a font size decoration. */
1425
+ fontSizeData?: FontSizeData;
1426
+ /** Font weight for a bold decoration. */
1427
+ fontWeightValue?: number | null;
1428
+ /** Data for an italic decoration. Defaults to `true`. */
1429
+ italicData?: boolean | null;
1430
+ /** Data for an underline decoration. Defaults to `true`. */
1431
+ underlineData?: boolean | null;
1432
+ /** Data for a spoiler decoration. */
1433
+ spoilerData?: SpoilerData;
1434
+ /** Data for a strikethrough decoration. Defaults to `true`. */
1435
+ strikethroughData?: boolean | null;
1436
+ /** Data for a superscript decoration. Defaults to `true`. */
1437
+ superscriptData?: boolean | null;
1438
+ /** Data for a subscript decoration. Defaults to `true`. */
1439
+ subscriptData?: boolean | null;
1440
+ /** The type of decoration to apply. */
1441
+ type?: DecorationTypeWithLiterals;
1442
+ }
1443
+ /** @oneof */
1444
+ interface DecorationDataOneOf {
1445
+ /** Data for an anchor link decoration. */
1446
+ anchorData?: AnchorData;
1447
+ /** Data for a color decoration. */
1448
+ colorData?: ColorData;
1449
+ /** Data for an external link decoration. */
1450
+ linkData?: LinkData;
1451
+ /** Data for a mention decoration. */
1452
+ mentionData?: MentionData;
1453
+ /** Data for a font size decoration. */
1454
+ fontSizeData?: FontSizeData;
1455
+ /** Font weight for a bold decoration. */
1456
+ fontWeightValue?: number | null;
1457
+ /** Data for an italic decoration. Defaults to `true`. */
1458
+ italicData?: boolean | null;
1459
+ /** Data for an underline decoration. Defaults to `true`. */
1460
+ underlineData?: boolean | null;
1461
+ /** Data for a spoiler decoration. */
1462
+ spoilerData?: SpoilerData;
1463
+ /** Data for a strikethrough decoration. Defaults to `true`. */
1464
+ strikethroughData?: boolean | null;
1465
+ /** Data for a superscript decoration. Defaults to `true`. */
1466
+ superscriptData?: boolean | null;
1467
+ /** Data for a subscript decoration. Defaults to `true`. */
1468
+ subscriptData?: boolean | null;
1469
+ }
1470
+ declare enum DecorationType {
1471
+ BOLD = "BOLD",
1472
+ ITALIC = "ITALIC",
1473
+ UNDERLINE = "UNDERLINE",
1474
+ SPOILER = "SPOILER",
1475
+ ANCHOR = "ANCHOR",
1476
+ MENTION = "MENTION",
1477
+ LINK = "LINK",
1478
+ COLOR = "COLOR",
1479
+ FONT_SIZE = "FONT_SIZE",
1480
+ EXTERNAL = "EXTERNAL",
1481
+ STRIKETHROUGH = "STRIKETHROUGH",
1482
+ SUPERSCRIPT = "SUPERSCRIPT",
1483
+ SUBSCRIPT = "SUBSCRIPT"
1484
+ }
1485
+ /** @enumType */
1486
+ type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH' | 'SUPERSCRIPT' | 'SUBSCRIPT';
1487
+ interface AnchorData {
1488
+ /** The target node's ID. */
1489
+ anchor?: string;
1490
+ }
1491
+ interface ColorData {
1492
+ /** The text's background color as a hexadecimal value. */
1493
+ background?: string | null;
1494
+ /** The text's foreground color as a hexadecimal value. */
1495
+ foreground?: string | null;
1496
+ }
1497
+ interface LinkData {
1498
+ /** Link details. */
1499
+ link?: Link;
1500
+ }
1501
+ interface MentionData {
1502
+ /** The mentioned user's name. */
1503
+ name?: string;
1504
+ /** The version of the user's name that appears after the `@` character in the mention. */
1505
+ slug?: string;
1506
+ /** Mentioned user's ID. */
1507
+ id?: string | null;
1508
+ }
1509
+ interface FontSizeData {
1510
+ /** The units used for the font size. */
1511
+ unit?: FontTypeWithLiterals;
1512
+ /** Font size value. */
1513
+ value?: number | null;
1514
+ }
1515
+ declare enum FontType {
1516
+ PX = "PX",
1517
+ EM = "EM"
1518
+ }
1519
+ /** @enumType */
1520
+ type FontTypeWithLiterals = FontType | 'PX' | 'EM';
1521
+ interface SpoilerData {
1522
+ /** Spoiler ID. */
1523
+ id?: string | null;
1524
+ }
1525
+ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1526
+ /** Data for embedded Wix Bookings content. */
1527
+ bookingData?: BookingData;
1528
+ /** Data for embedded Wix Events content. */
1529
+ eventData?: EventData;
1530
+ /** The type of Wix App content being embedded. */
1531
+ type?: AppTypeWithLiterals;
1532
+ /** The ID of the embedded content. */
1533
+ itemId?: string | null;
1534
+ /** The name of the embedded content. */
1535
+ name?: string | null;
1536
+ /**
1537
+ * Deprecated: Use `image` instead.
1538
+ * @deprecated
1539
+ */
1540
+ imageSrc?: string | null;
1541
+ /** The URL for the embedded content. */
1542
+ url?: string | null;
1543
+ /** An image for the embedded content. */
1544
+ image?: Media;
1545
+ /** Whether to hide the image. */
1546
+ hideImage?: boolean | null;
1547
+ /** Whether to hide the title. */
1548
+ hideTitle?: boolean | null;
1549
+ /** Whether to hide the price. */
1550
+ hidePrice?: boolean | null;
1551
+ /** Whether to hide the description (Event and Booking). */
1552
+ hideDescription?: boolean | null;
1553
+ /** Whether to hide the date and time (Event). */
1554
+ hideDateTime?: boolean | null;
1555
+ /** Whether to hide the location (Event). */
1556
+ hideLocation?: boolean | null;
1557
+ /** Whether to hide the duration (Booking). */
1558
+ hideDuration?: boolean | null;
1559
+ /** Whether to hide the button. */
1560
+ hideButton?: boolean | null;
1561
+ /** Whether to hide the ribbon. */
1562
+ hideRibbon?: boolean | null;
1563
+ /** Button styling options. */
1564
+ buttonStyles?: ButtonStyles;
1565
+ /** Image styling options. */
1566
+ imageStyles?: ImageStyles;
1567
+ /** Ribbon styling options. */
1568
+ ribbonStyles?: RibbonStyles;
1569
+ /** Card styling options. */
1570
+ cardStyles?: CardStyles;
1571
+ /** Styling for the app embed's container. */
1572
+ containerData?: PluginContainerData;
1573
+ /** Pricing data for embedded Wix App content. */
1574
+ pricingData?: PricingData;
1575
+ }
1576
+ /** @oneof */
1577
+ interface AppEmbedDataAppDataOneOf {
1578
+ /** Data for embedded Wix Bookings content. */
1579
+ bookingData?: BookingData;
1580
+ /** Data for embedded Wix Events content. */
1581
+ eventData?: EventData;
1582
+ }
1583
+ declare enum Position {
1584
+ /** Image positioned at the start (left in LTR layouts, right in RTL layouts) */
1585
+ START = "START",
1586
+ /** Image positioned at the end (right in LTR layouts, left in RTL layouts) */
1587
+ END = "END",
1588
+ /** Image positioned at the top */
1589
+ TOP = "TOP"
1590
+ }
1591
+ /** @enumType */
1592
+ type PositionWithLiterals = Position | 'START' | 'END' | 'TOP';
1593
+ declare enum AspectRatio {
1594
+ /** 1:1 aspect ratio */
1595
+ SQUARE = "SQUARE",
1596
+ /** 16:9 aspect ratio */
1597
+ RECTANGLE = "RECTANGLE"
1598
+ }
1599
+ /** @enumType */
1600
+ type AspectRatioWithLiterals = AspectRatio | 'SQUARE' | 'RECTANGLE';
1601
+ declare enum Resizing {
1602
+ /** Fill the container, may crop the image */
1603
+ FILL = "FILL",
1604
+ /** Fit the image within the container */
1605
+ FIT = "FIT"
1606
+ }
1607
+ /** @enumType */
1608
+ type ResizingWithLiterals = Resizing | 'FILL' | 'FIT';
1609
+ declare enum Placement {
1610
+ /** Ribbon placed on the image */
1611
+ IMAGE = "IMAGE",
1612
+ /** Ribbon placed on the product information */
1613
+ PRODUCT_INFO = "PRODUCT_INFO"
1614
+ }
1615
+ /** @enumType */
1616
+ type PlacementWithLiterals = Placement | 'IMAGE' | 'PRODUCT_INFO';
1617
+ declare enum Type {
1618
+ /** Card with visible border and background */
1619
+ CONTAINED = "CONTAINED",
1620
+ /** Card without visible border */
1621
+ FRAMELESS = "FRAMELESS"
1622
+ }
1623
+ /** @enumType */
1624
+ type TypeWithLiterals = Type | 'CONTAINED' | 'FRAMELESS';
1625
+ declare enum Alignment {
1626
+ /** Content aligned to start (left in LTR layouts, right in RTL layouts) */
1627
+ START = "START",
1628
+ /** Content centered */
1629
+ CENTER = "CENTER",
1630
+ /** Content aligned to end (right in LTR layouts, left in RTL layouts) */
1631
+ END = "END"
1632
+ }
1633
+ /** @enumType */
1634
+ type AlignmentWithLiterals = Alignment | 'START' | 'CENTER' | 'END';
1635
+ declare enum Layout {
1636
+ /** Elements stacked vertically */
1637
+ STACKED = "STACKED",
1638
+ /** Elements arranged horizontally */
1639
+ SIDE_BY_SIDE = "SIDE_BY_SIDE"
1640
+ }
1641
+ /** @enumType */
1642
+ type LayoutWithLiterals = Layout | 'STACKED' | 'SIDE_BY_SIDE';
1643
+ declare enum AppType {
1644
+ PRODUCT = "PRODUCT",
1645
+ EVENT = "EVENT",
1646
+ BOOKING = "BOOKING"
1647
+ }
1648
+ /** @enumType */
1649
+ type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
1650
+ interface BookingData {
1651
+ /** Booking duration in minutes. */
1652
+ durations?: string | null;
1653
+ }
1654
+ interface EventData {
1655
+ /** Event schedule. */
1656
+ scheduling?: string | null;
1657
+ /** Event location. */
1658
+ location?: string | null;
1659
+ }
1660
+ interface ButtonStyles {
1661
+ /** Text to display on the button. */
1662
+ buttonText?: string | null;
1663
+ /** Border width in pixels. */
1664
+ borderWidth?: number | null;
1665
+ /** Border radius in pixels. */
1666
+ borderRadius?: number | null;
1667
+ /**
1668
+ * Border color as a hexadecimal value.
1669
+ * @format COLOR_HEX
1670
+ */
1671
+ borderColor?: string | null;
1672
+ /**
1673
+ * Text color as a hexadecimal value.
1674
+ * @format COLOR_HEX
1675
+ */
1676
+ textColor?: string | null;
1677
+ /**
1678
+ * Background color as a hexadecimal value.
1679
+ * @format COLOR_HEX
1680
+ */
1681
+ backgroundColor?: string | null;
1682
+ /**
1683
+ * Border color as a hexadecimal value (hover state).
1684
+ * @format COLOR_HEX
1685
+ */
1686
+ borderColorHover?: string | null;
1687
+ /**
1688
+ * Text color as a hexadecimal value (hover state).
1689
+ * @format COLOR_HEX
1690
+ */
1691
+ textColorHover?: string | null;
1692
+ /**
1693
+ * Background color as a hexadecimal value (hover state).
1694
+ * @format COLOR_HEX
1695
+ */
1696
+ backgroundColorHover?: string | null;
1697
+ /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
1698
+ buttonSize?: string | null;
1699
+ }
1700
+ interface ImageStyles {
1701
+ /** Whether to hide the image. */
1702
+ hideImage?: boolean | null;
1703
+ /** Position of image. Defaults to `START`. */
1704
+ imagePosition?: PositionWithLiterals;
1705
+ /** Aspect ratio for the image. Defaults to `SQUARE`. */
1706
+ aspectRatio?: AspectRatioWithLiterals;
1707
+ /** How the image should be resized. Defaults to `FILL`. */
1708
+ resizing?: ResizingWithLiterals;
1709
+ /**
1710
+ * Image border color as a hexadecimal value.
1711
+ * @format COLOR_HEX
1712
+ */
1713
+ borderColor?: string | null;
1714
+ /** Image border width in pixels. */
1715
+ borderWidth?: number | null;
1716
+ /** Image border radius in pixels. */
1717
+ borderRadius?: number | null;
1718
+ }
1719
+ interface RibbonStyles {
1720
+ /** Text to display on the ribbon. */
1721
+ ribbonText?: string | null;
1722
+ /**
1723
+ * Ribbon background color as a hexadecimal value.
1724
+ * @format COLOR_HEX
1725
+ */
1726
+ backgroundColor?: string | null;
1727
+ /**
1728
+ * Ribbon text color as a hexadecimal value.
1729
+ * @format COLOR_HEX
1730
+ */
1731
+ textColor?: string | null;
1732
+ /**
1733
+ * Ribbon border color as a hexadecimal value.
1734
+ * @format COLOR_HEX
1735
+ */
1736
+ borderColor?: string | null;
1737
+ /** Ribbon border width in pixels. */
1738
+ borderWidth?: number | null;
1739
+ /** Ribbon border radius in pixels. */
1740
+ borderRadius?: number | null;
1741
+ /** Placement of the ribbon. Defaults to `IMAGE`. */
1742
+ ribbonPlacement?: PlacementWithLiterals;
1743
+ }
1744
+ interface CardStyles {
1745
+ /**
1746
+ * Card background color as a hexadecimal value.
1747
+ * @format COLOR_HEX
1748
+ */
1749
+ backgroundColor?: string | null;
1750
+ /**
1751
+ * Card border color as a hexadecimal value.
1752
+ * @format COLOR_HEX
1753
+ */
1754
+ borderColor?: string | null;
1755
+ /** Card border width in pixels. */
1756
+ borderWidth?: number | null;
1757
+ /** Card border radius in pixels. */
1758
+ borderRadius?: number | null;
1759
+ /** Card type. Defaults to `CONTAINED`. */
1760
+ type?: TypeWithLiterals;
1761
+ /** Content alignment. Defaults to `START`. */
1762
+ alignment?: AlignmentWithLiterals;
1763
+ /** Layout for title and price. Defaults to `STACKED`. */
1764
+ titlePriceLayout?: LayoutWithLiterals;
1765
+ /**
1766
+ * Title text color as a hexadecimal value.
1767
+ * @format COLOR_HEX
1768
+ */
1769
+ titleColor?: string | null;
1770
+ /**
1771
+ * Text color as a hexadecimal value.
1772
+ * @format COLOR_HEX
1773
+ */
1774
+ textColor?: string | null;
1775
+ }
1776
+ interface PricingData {
1777
+ /**
1778
+ * Minimum numeric price value as string (e.g., "10.99").
1779
+ * @decimalValue options { maxScale:2 }
1780
+ */
1781
+ valueFrom?: string | null;
1782
+ /**
1783
+ * Maximum numeric price value as string (e.g., "19.99").
1784
+ * @decimalValue options { maxScale:2 }
1785
+ */
1786
+ valueTo?: string | null;
1787
+ /**
1788
+ * Numeric price value as string after discount application (e.g., "15.99").
1789
+ * @decimalValue options { maxScale:2 }
1790
+ */
1791
+ discountedValue?: string | null;
1792
+ /**
1793
+ * Currency of the value in ISO 4217 format (e.g., "USD", "EUR").
1794
+ * @format CURRENCY
1795
+ */
1796
+ currency?: string | null;
1797
+ /**
1798
+ * Pricing plan ID.
1799
+ * @format GUID
1800
+ */
1801
+ pricingPlanId?: string | null;
1802
+ }
1803
+ interface VideoData {
1804
+ /** Styling for the video's container. */
1805
+ containerData?: PluginContainerData;
1806
+ /** Video details. */
1807
+ video?: Media;
1808
+ /** Video thumbnail details. */
1809
+ thumbnail?: Media;
1810
+ /** Sets whether the video's download button is disabled. Defaults to `false`. */
1811
+ disableDownload?: boolean | null;
1812
+ /** Video title. */
1813
+ title?: string | null;
1814
+ /** Video options. */
1815
+ options?: PlaybackOptions;
1816
+ }
1817
+ interface PlaybackOptions {
1818
+ /** Sets whether the media will automatically start playing. */
1819
+ autoPlay?: boolean | null;
1820
+ /** Sets whether media's will be looped. */
1821
+ playInLoop?: boolean | null;
1822
+ /** Sets whether media's controls will be shown. */
1823
+ showControls?: boolean | null;
1824
+ }
1825
+ interface EmbedData {
1826
+ /** Styling for the oEmbed node's container. */
1827
+ containerData?: PluginContainerData;
1828
+ /** An [oEmbed](https://www.oembed.com) object. */
1829
+ oembed?: Oembed;
1830
+ /** Origin asset source. */
1831
+ src?: string | null;
1832
+ }
1833
+ interface Oembed {
1834
+ /** The resource type. */
1835
+ type?: string | null;
1836
+ /** The width of the resource specified in the `url` property in pixels. */
1837
+ width?: number | null;
1838
+ /** The height of the resource specified in the `url` property in pixels. */
1839
+ height?: number | null;
1840
+ /** Resource title. */
1841
+ title?: string | null;
1842
+ /** The source URL for the resource. */
1843
+ url?: string | null;
1844
+ /** HTML for embedding a video player. The HTML should have no padding or margins. */
1845
+ html?: string | null;
1846
+ /** The name of the author or owner of the resource. */
1847
+ authorName?: string | null;
1848
+ /** The URL for the author or owner of the resource. */
1849
+ authorUrl?: string | null;
1850
+ /** The name of the resource provider. */
1851
+ providerName?: string | null;
1852
+ /** The URL for the resource provider. */
1853
+ providerUrl?: string | null;
1854
+ /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
1855
+ thumbnailUrl?: string | null;
1856
+ /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
1857
+ thumbnailWidth?: string | null;
1858
+ /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
1859
+ thumbnailHeight?: string | null;
1860
+ /** The URL for an embedded viedo. */
1861
+ videoUrl?: string | null;
1862
+ /** The oEmbed version number. This value must be `1.0`. */
1863
+ version?: string | null;
1864
+ }
1865
+ interface CollapsibleListData {
1866
+ /** Styling for the collapsible list's container. */
1867
+ containerData?: PluginContainerData;
1868
+ /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
1869
+ expandOnlyOne?: boolean | null;
1870
+ /** Sets which items are expanded when the page loads. */
1871
+ initialExpandedItems?: InitialExpandedItemsWithLiterals;
1872
+ /** The direction of the text in the list. Either left-to-right or right-to-left. */
1873
+ direction?: DirectionWithLiterals;
1874
+ /** If `true`, The collapsible item will appear in search results as an FAQ. */
1875
+ isQapageData?: boolean | null;
1876
+ }
1877
+ declare enum InitialExpandedItems {
1878
+ /** First item will be expended initally */
1879
+ FIRST = "FIRST",
1880
+ /** All items will expended initally */
1881
+ ALL = "ALL",
1882
+ /** All items collapsed initally */
1883
+ NONE = "NONE"
1884
+ }
1885
+ /** @enumType */
1886
+ type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
1887
+ declare enum Direction {
1888
+ /** Left-to-right */
1889
+ LTR = "LTR",
1890
+ /** Right-to-left */
1891
+ RTL = "RTL"
1892
+ }
1893
+ /** @enumType */
1894
+ type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
1895
+ interface TableData {
1896
+ /** Styling for the table's container. */
1897
+ containerData?: PluginContainerData;
1898
+ /** The table's dimensions. */
1899
+ dimensions?: Dimensions;
1900
+ /**
1901
+ * Deprecated: Use `rowHeader` and `columnHeader` instead.
1902
+ * @deprecated
1903
+ */
1904
+ header?: boolean | null;
1905
+ /** Sets whether the table's first row is a header. Defaults to `false`. */
1906
+ rowHeader?: boolean | null;
1907
+ /** Sets whether the table's first column is a header. Defaults to `false`. */
1908
+ columnHeader?: boolean | null;
1909
+ }
1910
+ interface Dimensions {
1911
+ /** An array representing relative width of each column in relation to the other columns. */
1912
+ colsWidthRatio?: number[];
1913
+ /** An array representing the height of each row in pixels. */
1914
+ rowsHeight?: number[];
1915
+ /** An array representing the minimum width of each column in pixels. */
1916
+ colsMinWidth?: number[];
1917
+ }
1918
+ interface TableCellData {
1919
+ /** Styling for the cell's background color and text alignment. */
1920
+ cellStyle?: CellStyle;
1921
+ /** The cell's border colors. */
1922
+ borderColors?: BorderColors;
1923
+ }
1924
+ declare enum VerticalAlignment {
1925
+ /** Top alignment */
1926
+ TOP = "TOP",
1927
+ /** Middle alignment */
1928
+ MIDDLE = "MIDDLE",
1929
+ /** Bottom alignment */
1930
+ BOTTOM = "BOTTOM"
1931
+ }
1932
+ /** @enumType */
1933
+ type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
1934
+ interface CellStyle {
1935
+ /** Vertical alignment for the cell's text. */
1936
+ verticalAlignment?: VerticalAlignmentWithLiterals;
1937
+ /**
1938
+ * Cell background color as a hexadecimal value.
1939
+ * @format COLOR_HEX
1940
+ */
1941
+ backgroundColor?: string | null;
1942
+ }
1943
+ interface BorderColors {
1944
+ /**
1945
+ * Left border color as a hexadecimal value.
1946
+ * @format COLOR_HEX
1947
+ */
1948
+ left?: string | null;
1949
+ /**
1950
+ * Right border color as a hexadecimal value.
1951
+ * @format COLOR_HEX
1952
+ */
1953
+ right?: string | null;
1954
+ /**
1955
+ * Top border color as a hexadecimal value.
1956
+ * @format COLOR_HEX
1957
+ */
1958
+ top?: string | null;
1959
+ /**
1960
+ * Bottom border color as a hexadecimal value.
1961
+ * @format COLOR_HEX
1962
+ */
1963
+ bottom?: string | null;
1964
+ }
1965
+ /**
1966
+ * `NullValue` is a singleton enumeration to represent the null value for the
1967
+ * `Value` type union.
1968
+ *
1969
+ * The JSON representation for `NullValue` is JSON `null`.
1970
+ */
1971
+ declare enum NullValue {
1972
+ /** Null value. */
1973
+ NULL_VALUE = "NULL_VALUE"
1974
+ }
1975
+ /** @enumType */
1976
+ type NullValueWithLiterals = NullValue | 'NULL_VALUE';
1977
+ /**
1978
+ * `ListValue` is a wrapper around a repeated field of values.
1979
+ *
1980
+ * The JSON representation for `ListValue` is JSON array.
1981
+ */
1982
+ interface ListValue {
1983
+ /** Repeated field of dynamically typed values. */
1984
+ values?: any[];
1985
+ }
1986
+ interface AudioData {
1987
+ /** Styling for the audio node's container. */
1988
+ containerData?: PluginContainerData;
1989
+ /** Audio file details. */
1990
+ audio?: Media;
1991
+ /** Sets whether the audio node's download button is disabled. Defaults to `false`. */
1992
+ disableDownload?: boolean | null;
1993
+ /** Cover image. */
1994
+ coverImage?: Media;
1995
+ /** Track name. */
1996
+ name?: string | null;
1997
+ /** Author name. */
1998
+ authorName?: string | null;
1999
+ /** An HTML version of the audio node. */
2000
+ html?: string | null;
2001
+ }
2002
+ interface OrderedListData {
2003
+ /** Indentation level from 0-4. */
2004
+ indentation?: number;
2005
+ /** Offset level from 0-4. */
2006
+ offset?: number | null;
2007
+ /** List start number. */
2008
+ start?: number | null;
2009
+ }
2010
+ interface BulletedListData {
2011
+ /** Indentation level from 0-4. */
2012
+ indentation?: number;
2013
+ /** Offset level from 0-4. */
2014
+ offset?: number | null;
2015
+ }
2016
+ interface BlockquoteData {
2017
+ /** Indentation level from 1-4. */
2018
+ indentation?: number;
2019
+ }
2020
+ interface CaptionData {
2021
+ textStyle?: TextStyle;
2022
+ }
2023
+ interface LayoutCellData {
2024
+ /** Size of the cell in 12 columns grid. */
2025
+ colSpan?: number | null;
2026
+ }
2027
+ interface Metadata {
2028
+ /** Schema version. */
2029
+ version?: number;
2030
+ /**
2031
+ * When the object was created.
2032
+ * @readonly
2033
+ * @deprecated
2034
+ */
2035
+ createdTimestamp?: Date | null;
2036
+ /**
2037
+ * When the object was most recently updated.
2038
+ * @deprecated
2039
+ */
2040
+ updatedTimestamp?: Date | null;
2041
+ /** Object ID. */
2042
+ _id?: string | null;
2043
+ }
2044
+ interface DocumentStyle {
2045
+ /** Styling for H1 nodes. */
2046
+ headerOne?: TextNodeStyle;
2047
+ /** Styling for H2 nodes. */
2048
+ headerTwo?: TextNodeStyle;
2049
+ /** Styling for H3 nodes. */
2050
+ headerThree?: TextNodeStyle;
2051
+ /** Styling for H4 nodes. */
2052
+ headerFour?: TextNodeStyle;
2053
+ /** Styling for H5 nodes. */
2054
+ headerFive?: TextNodeStyle;
2055
+ /** Styling for H6 nodes. */
2056
+ headerSix?: TextNodeStyle;
2057
+ /** Styling for paragraph nodes. */
2058
+ paragraph?: TextNodeStyle;
2059
+ /** Styling for block quote nodes. */
2060
+ blockquote?: TextNodeStyle;
2061
+ /** Styling for code block nodes. */
2062
+ codeBlock?: TextNodeStyle;
2063
+ }
2064
+ interface TextNodeStyle {
2065
+ /** The decorations to apply to the node. */
2066
+ decorations?: Decoration[];
2067
+ /** Padding and background color for the node. */
2068
+ nodeStyle?: NodeStyle;
2069
+ /** Line height for text in the node. */
2070
+ lineHeight?: string | null;
2071
+ }
2072
+ declare enum PaymentPolicyType {
2073
+ UNKNOWN_PAYMENT_POLICY_TYPE = "UNKNOWN_PAYMENT_POLICY_TYPE",
2074
+ PER_GUEST = "PER_GUEST",
2075
+ FREE = "FREE"
2076
+ }
2077
+ /** @enumType */
2078
+ type PaymentPolicyTypeWithLiterals = PaymentPolicyType | 'UNKNOWN_PAYMENT_POLICY_TYPE' | 'PER_GUEST' | 'FREE';
2079
+ /** Payment per guest policy. */
2080
+ interface PerGuestOptions {
2081
+ /**
2082
+ * Monetary amount to charge. Decimal string with a period as a decimal separator (e.g., 3.99)
2083
+ * @decimalValue options { gt:0.000, maxScale:3 }
2084
+ */
2085
+ price?: string | null;
2086
+ }
2087
+ interface DisplayInfo {
2088
+ /**
2089
+ * Experience name.
2090
+ * @minLength 1
2091
+ * @maxLength 100
2092
+ */
2093
+ name?: string | null;
2094
+ /**
2095
+ * Short description.
2096
+ * @maxLength 100
2097
+ */
2098
+ shortDescription?: string | null;
2099
+ /** Cover image. */
2100
+ coverImage?: string;
2101
+ /** About the experience description, rich editor. */
2102
+ richContent?: RichContent;
2103
+ }
2104
+ interface PaymentPolicy extends PaymentPolicyOptionsOneOf {
2105
+ /** Payment per guest policy. */
2106
+ perGuestOptions?: PerGuestOptions;
2107
+ /** Type of payment policy. */
2108
+ paymentPolicyType?: PaymentPolicyTypeWithLiterals;
2109
+ }
2110
+ /** @oneof */
2111
+ interface PaymentPolicyOptionsOneOf {
2112
+ /** Payment per guest policy. */
2113
+ perGuestOptions?: PerGuestOptions;
2114
+ }
2115
+ interface OnlineReservations {
2116
+ /** Party size. */
2117
+ partySize?: PartySize;
2118
+ /** Minimum reservation notice. */
2119
+ minimumReservationNotice?: NoticePeriod;
2120
+ /** Maximum reservation notice. */
2121
+ maximumReservationNotice?: NoticePeriod;
2122
+ /** Approval. */
2123
+ approval?: Approval;
2124
+ /** Maximum number of guests. */
2125
+ maxGuests?: MaxGuests;
2126
+ /** Business schedule. */
2127
+ businessSchedule?: OnlineReservationsBusinessSchedule;
2128
+ }
2129
+ /** Experience form settings. */
2130
+ interface ReservationForm {
2131
+ /**
2132
+ * A message shown to the customer in the registration form.
2133
+ * @maxLength 1000000
2134
+ */
2135
+ submitMessage?: string | null;
2136
+ /** Whether to show policies (the terms and conditions, and the privacy policy) to the customer. */
2137
+ policiesEnabled?: boolean | null;
2138
+ /** Settings for displaying the privacy policy. */
2139
+ privacyPolicy?: PrivacyPolicy;
2140
+ /** Settings for displaying the terms and conditions. */
2141
+ termsAndConditions?: TermsAndConditions;
2142
+ /**
2143
+ * Custom fields you wish to add to the registration form for the customer to fill in.
2144
+ * @maxSize 1000
2145
+ */
2146
+ customFieldDefinitions?: CustomFieldDefinition[];
2147
+ /**
2148
+ * Whether a last_name is required in the reservation form.
2149
+ *
2150
+ * Default: `false`
2151
+ */
2152
+ lastNameRequired?: boolean | null;
2153
+ /**
2154
+ * Whether an email is required in the reservation form.
2155
+ *
2156
+ * Default: `false`
2157
+ */
2158
+ emailRequired?: boolean | null;
2159
+ /** Email marketing checkbox settings. */
2160
+ emailMarketingCheckbox?: EmailMarketingCheckbox;
2161
+ }
2162
+ interface TableManagement extends TableManagementOptionsOneOf {
2163
+ /** On options. */
2164
+ onOptions?: OnOptions;
2165
+ /** Table management mode. */
2166
+ mode?: TableManagementModeWithLiterals;
2167
+ }
2168
+ /** @oneof */
2169
+ interface TableManagementOptionsOneOf {
2170
+ /** On options. */
2171
+ onOptions?: OnOptions;
2172
+ }
2173
+ interface Configuration {
2174
+ /** Display information of experience. */
2175
+ displayInfo?: DisplayInfo;
2176
+ /** Payment policy. */
2177
+ paymentPolicy?: PaymentPolicy;
2178
+ /** Settings for online reservations. */
2179
+ onlineReservations?: OnlineReservations;
2180
+ /** Reservation form. */
2181
+ reservationForm?: ReservationForm;
2182
+ /** Visibility of experience on the live site. Doesn't taken into account when a reservation is created from API. */
2183
+ visible?: boolean | null;
2184
+ /** Table management. */
2185
+ tableManagement?: TableManagement;
2186
+ }
2187
+ interface ExtendedFields {
2188
+ /**
2189
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
2190
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
2191
+ *
2192
+ * You can only access fields for which you have the appropriate permissions.
2193
+ *
2194
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
2195
+ */
2196
+ namespaces?: Record<string, Record<string, any>>;
2197
+ }
2198
+ /**
2199
+ * Common object for tags.
2200
+ * Should be use as in this example:
2201
+ * message Foo {
2202
+ * option (.wix.api.decomposite_of) = "wix.commons.v2.tags.Foo";
2203
+ * string id = 1;
2204
+ * ...
2205
+ * Tags tags = 5
2206
+ * }
2207
+ *
2208
+ * example of taggable entity
2209
+ * {
2210
+ * id: "123"
2211
+ * tags: {
2212
+ * public_tags: {
2213
+ * tag_ids:["11","22"]
2214
+ * },
2215
+ * private_tags: {
2216
+ * tag_ids: ["33", "44"]
2217
+ * }
2218
+ * }
2219
+ * }
2220
+ */
2221
+ interface Tags {
2222
+ /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
2223
+ privateTags?: TagList;
2224
+ /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
2225
+ publicTags?: TagList;
2226
+ }
2227
+ interface TagList {
2228
+ /**
2229
+ * List of tag IDs.
2230
+ * @maxSize 100
2231
+ * @maxLength 5
2232
+ */
2233
+ tagIds?: string[];
2234
+ }
2235
+ interface TagsModified {
2236
+ /** Updated Experience. */
2237
+ experience?: Experience;
2238
+ /** Tags that were assigned to the Experience. */
2239
+ assignedTags?: Tags;
2240
+ /** Tags that were unassigned from the Experience. */
2241
+ unassignedTags?: Tags;
2242
+ }
2243
+ interface CreateExperienceRequest {
2244
+ /** Experience to be created. */
2245
+ experience: Experience;
2246
+ }
2247
+ interface CreateExperienceResponse {
2248
+ /** The created Experience. */
2249
+ experience?: Experience;
2250
+ }
2251
+ interface GetExperienceRequest {
2252
+ /**
2253
+ * ID of the Experience to retrieve.
2254
+ * @format GUID
2255
+ */
2256
+ experienceId: string;
2257
+ }
2258
+ interface GetExperienceResponse {
2259
+ /** The requested Experience. */
2260
+ experience?: Experience;
2261
+ }
2262
+ interface UpdateExperienceRequest {
2263
+ /** Experience to be updated, may be partial. */
2264
+ experience: Experience;
2265
+ }
2266
+ interface UpdateExperienceResponse {
2267
+ /** Updated Experience. */
2268
+ experience?: Experience;
2269
+ }
2270
+ interface QueryExperiencesRequest {
2271
+ /** WQL expression. */
2272
+ query?: CursorQuery;
2273
+ }
2274
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
2275
+ /**
2276
+ * Cursor paging options.
2277
+ *
2278
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
2279
+ */
2280
+ cursorPaging?: CursorPaging;
2281
+ /**
2282
+ * Filter object.
2283
+ *
2284
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
2285
+ */
2286
+ filter?: Record<string, any> | null;
2287
+ /**
2288
+ * Sort object.
2289
+ *
2290
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
2291
+ * @maxSize 5
2292
+ */
2293
+ sort?: Sorting[];
2294
+ }
2295
+ /** @oneof */
2296
+ interface CursorQueryPagingMethodOneOf {
2297
+ /**
2298
+ * Cursor paging options.
2299
+ *
2300
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
2301
+ */
2302
+ cursorPaging?: CursorPaging;
2303
+ }
2304
+ interface Sorting {
2305
+ /**
2306
+ * Name of the field to sort by.
2307
+ * @maxLength 512
2308
+ */
2309
+ fieldName?: string;
2310
+ /** Sort order. */
2311
+ order?: SortOrderWithLiterals;
2312
+ }
2313
+ declare enum SortOrder {
2314
+ ASC = "ASC",
2315
+ DESC = "DESC"
2316
+ }
2317
+ /** @enumType */
2318
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
2319
+ interface CursorPaging {
2320
+ /**
2321
+ * Maximum number of items to return in the results.
2322
+ * @max 100
2323
+ */
2324
+ limit?: number | null;
2325
+ /**
2326
+ * Pointer to the next or previous page in the list of results.
2327
+ *
2328
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
2329
+ * Not relevant for the first request.
2330
+ * @maxLength 16000
2331
+ */
2332
+ cursor?: string | null;
2333
+ }
2334
+ interface QueryExperiencesResponse {
2335
+ /** List of Experiences. */
2336
+ experiences?: Experience[];
2337
+ /** Paging metadata */
2338
+ pagingMetadata?: CursorPagingMetadata;
2339
+ }
2340
+ interface CursorPagingMetadata {
2341
+ /** Number of items returned in current page. */
2342
+ count?: number | null;
2343
+ /** Cursor strings that point to the next page, previous page, or both. */
2344
+ cursors?: Cursors;
2345
+ /**
2346
+ * Whether there are more pages to retrieve following the current page.
2347
+ *
2348
+ * + `true`: Another page of results can be retrieved.
2349
+ * + `false`: This is the last page.
2350
+ */
2351
+ hasNext?: boolean | null;
2352
+ }
2353
+ interface Cursors {
2354
+ /**
2355
+ * Cursor string pointing to the next page in the list of results.
2356
+ * @maxLength 16000
2357
+ */
2358
+ next?: string | null;
2359
+ /**
2360
+ * Cursor pointing to the previous page in the list of results.
2361
+ * @maxLength 16000
2362
+ */
2363
+ prev?: string | null;
2364
+ }
2365
+ interface BulkUpdateExperienceTagsRequest {
2366
+ /**
2367
+ * List of NileProtoTagsEntities that their tags will update.
2368
+ * @minSize 1
2369
+ * @maxSize 100
2370
+ * @format GUID
2371
+ */
2372
+ experienceIds: string[];
2373
+ /** List of Tags to assign */
2374
+ assignTags?: Tags;
2375
+ /** List of Tags to unAssign */
2376
+ unassignTags?: Tags;
2377
+ }
2378
+ interface BulkUpdateExperienceTagsResponse {
2379
+ /**
2380
+ * Results
2381
+ * @minSize 1
2382
+ * @maxSize 100
2383
+ */
2384
+ results?: BulkUpdateExperienceTagsResult[];
2385
+ /** Metadata regarding the bulk update operation */
2386
+ bulkActionMetadata?: BulkActionMetadata;
2387
+ }
2388
+ interface ItemMetadata {
2389
+ /**
2390
+ * Item ID. Provided only whenever possible. For example, `itemId` can't be provided when item creation has failed.
2391
+ * @format GUID
2392
+ */
2393
+ _id?: string | null;
2394
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
2395
+ originalIndex?: number;
2396
+ /** Whether the requested action for this item was successful. When `false`, the `error` field is returned. */
2397
+ success?: boolean;
2398
+ /** Details about the error in case of failure. */
2399
+ error?: ApplicationError;
2400
+ }
2401
+ interface ApplicationError {
2402
+ /** Error code. */
2403
+ code?: string;
2404
+ /** Description of the error. */
2405
+ description?: string;
2406
+ /** Data related to the error. */
2407
+ data?: Record<string, any> | null;
2408
+ }
2409
+ interface BulkUpdateExperienceTagsResult {
2410
+ /** Metadata regarding the specific single update operation */
2411
+ itemMetadata?: ItemMetadata;
2412
+ }
2413
+ interface BulkActionMetadata {
2414
+ /** Number of items that were successfully processed. */
2415
+ totalSuccesses?: number;
2416
+ /** Number of items that couldn't be processed. */
2417
+ totalFailures?: number;
2418
+ /** Number of failures without details because detailed failure threshold was exceeded. */
2419
+ undetailedFailures?: number;
2420
+ }
2421
+ interface BulkUpdateExperienceTagsByFilterRequest {
2422
+ /** Filter */
2423
+ filter: Record<string, any> | null;
2424
+ /** List of Tags to assign */
2425
+ assignTags?: Tags;
2426
+ /** List of Tags to unAssign */
2427
+ unassignTags?: Tags;
2428
+ }
2429
+ interface BulkUpdateExperienceTagsByFilterResponse {
2430
+ /**
2431
+ * Job ID
2432
+ * @format GUID
2433
+ */
2434
+ jobId?: string;
2435
+ }
2436
+ /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
2437
+ interface SitePropertiesNotification {
2438
+ /** The site ID for which this update notification applies. */
2439
+ metasiteId?: string;
2440
+ /** The actual update event. */
2441
+ event?: SitePropertiesEvent;
2442
+ /**
2443
+ * A convenience set of mappings from the MetaSite ID to its constituent services.
2444
+ * @maxSize 500
2445
+ */
2446
+ translations?: Translation[];
2447
+ /** Context of the notification */
2448
+ changeContext?: ChangeContext;
2449
+ }
2450
+ /** The actual update event for a particular notification. */
2451
+ interface SitePropertiesEvent {
2452
+ /** Version of the site's properties represented by this update. */
2453
+ version?: number;
2454
+ /** Set of properties that were updated - corresponds to the fields in "properties". */
2455
+ fields?: string[];
2456
+ /** Updated properties. */
2457
+ properties?: Properties;
2458
+ }
2459
+ interface Properties {
2460
+ /** Site categories. */
2461
+ categories?: Categories;
2462
+ /** Site locale. */
2463
+ locale?: Locale;
2464
+ /**
2465
+ * Site language.
2466
+ *
2467
+ * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
2468
+ */
2469
+ language?: string | null;
2470
+ /**
2471
+ * Site currency format used to bill customers.
2472
+ *
2473
+ * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
2474
+ */
2475
+ paymentCurrency?: string | null;
2476
+ /** Timezone in `America/New_York` format. */
2477
+ timeZone?: string | null;
2478
+ /** Email address. */
2479
+ email?: string | null;
2480
+ /** Phone number. */
2481
+ phone?: string | null;
2482
+ /** Fax number. */
2483
+ fax?: string | null;
2484
+ /** Address. */
2485
+ address?: Address;
2486
+ /** Site display name. */
2487
+ siteDisplayName?: string | null;
2488
+ /** Business name. */
2489
+ businessName?: string | null;
2490
+ /** Path to the site's logo in Wix Media (without Wix Media base URL). */
2491
+ logo?: string | null;
2492
+ /** Site description. */
2493
+ description?: string | null;
2494
+ /**
2495
+ * Business schedule. Regular and exceptional time periods when the business is open or the service is available.
2496
+ *
2497
+ * __Note:__ Not supported by Wix Bookings.
2498
+ */
2499
+ businessSchedule?: BusinessSchedule;
2500
+ /** Supported languages of a site and the primary language. */
2501
+ multilingual?: Multilingual;
2502
+ /** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
2503
+ consentPolicy?: ConsentPolicy;
2504
+ /**
2505
+ * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
2506
+ *
2507
+ * Site business type.
2508
+ */
2509
+ businessConfig?: string | null;
2510
+ /** External site URL that uses Wix as its headless business solution. */
2511
+ externalSiteUrl?: string | null;
2512
+ /** Track clicks analytics. */
2513
+ trackClicksAnalytics?: boolean;
2514
+ }
2515
+ interface Categories {
2516
+ /** Primary site category. */
2517
+ primary?: string;
2518
+ /**
2519
+ * Secondary site category.
2520
+ * @maxSize 50
2521
+ */
2522
+ secondary?: string[];
2523
+ /** Business Term Id */
2524
+ businessTermId?: string | null;
2525
+ }
2526
+ interface Locale {
2527
+ /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
2528
+ languageCode?: string;
2529
+ /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
2530
+ country?: string;
2531
+ }
2532
+ interface Address {
2533
+ /** Street name. */
2534
+ street?: string;
2535
+ /** City name. */
2536
+ city?: string;
2537
+ /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
2538
+ country?: string;
2539
+ /** State. */
2540
+ state?: string;
2541
+ /**
2542
+ * Zip or postal code.
2543
+ * @maxLength 20
2544
+ */
2545
+ zip?: string;
2546
+ /** Extra information to be displayed in the address. */
2547
+ hint?: AddressHint;
2548
+ /** Whether this address represents a physical location. */
2549
+ isPhysical?: boolean;
2550
+ /** Google-formatted version of this address. */
2551
+ googleFormattedAddress?: string;
2552
+ /** Street number. */
2553
+ streetNumber?: string;
2554
+ /** Apartment number. */
2555
+ apartmentNumber?: string;
2556
+ /** Geographic coordinates of location. */
2557
+ coordinates?: GeoCoordinates;
2558
+ }
2559
+ /**
2560
+ * Extra information on displayed addresses.
2561
+ * This is used for display purposes. Used to add additional data about the address, such as "In the passage".
2562
+ * Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
2563
+ */
2564
+ interface AddressHint {
2565
+ /** Extra text displayed next to, or instead of, the actual address. */
2566
+ text?: string;
2567
+ /** Where the extra text should be displayed. */
2568
+ placement?: PlacementTypeWithLiterals;
2569
+ }
2570
+ /** Where the extra text should be displayed: before, after or instead of the actual address. */
2571
+ declare enum PlacementType {
2572
+ BEFORE = "BEFORE",
2573
+ AFTER = "AFTER",
2574
+ REPLACE = "REPLACE"
2575
+ }
2576
+ /** @enumType */
2577
+ type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
2578
+ /** Geocoordinates for a particular address. */
2579
+ interface GeoCoordinates {
2580
+ /** Latitude of the location. Must be between -90 and 90. */
2581
+ latitude?: number;
2582
+ /** Longitude of the location. Must be between -180 and 180. */
2583
+ longitude?: number;
2584
+ }
2585
+ /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
2586
+ interface BusinessSchedule {
2587
+ /**
2588
+ * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
2589
+ * @maxSize 100
2590
+ */
2591
+ periods?: TimePeriod[];
2592
+ /**
2593
+ * Exceptions to the business's regular hours. The business can be open or closed during the exception.
2594
+ * @maxSize 100
2595
+ */
2596
+ specialHourPeriod?: SpecialHourPeriod[];
2597
+ }
2598
+ /** Weekly recurring time periods when the business is regularly open or the service is available. */
2599
+ interface TimePeriod {
2600
+ /** Day of the week the period starts on. */
2601
+ openDay?: DayOfWeekWithLiterals;
2602
+ /**
2603
+ * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
2604
+ * midnight at the end of the specified day.
2605
+ */
2606
+ openTime?: string;
2607
+ /** Day of the week the period ends on. */
2608
+ closeDay?: DayOfWeekWithLiterals;
2609
+ /**
2610
+ * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
2611
+ * midnight at the end of the specified day.
2612
+ *
2613
+ * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
2614
+ */
2615
+ closeTime?: string;
2616
+ }
2617
+ /** Enumerates the days of the week. */
2618
+ declare enum DayOfWeek {
2619
+ MONDAY = "MONDAY",
2620
+ TUESDAY = "TUESDAY",
2621
+ WEDNESDAY = "WEDNESDAY",
2622
+ THURSDAY = "THURSDAY",
2623
+ FRIDAY = "FRIDAY",
2624
+ SATURDAY = "SATURDAY",
2625
+ SUNDAY = "SUNDAY"
2626
+ }
2627
+ /** @enumType */
2628
+ type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
2629
+ /** Exception to the business's regular hours. The business can be open or closed during the exception. */
2630
+ interface SpecialHourPeriod {
2631
+ /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
2632
+ startDate?: string;
2633
+ /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
2634
+ endDate?: string;
2635
+ /**
2636
+ * Whether the business is closed (or the service is not available) during the exception.
2637
+ *
2638
+ * Default: `true`.
2639
+ */
2640
+ isClosed?: boolean;
2641
+ /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
2642
+ comment?: string;
2643
+ }
2644
+ interface Multilingual {
2645
+ /**
2646
+ * Supported languages list.
2647
+ * @maxSize 200
2648
+ */
2649
+ supportedLanguages?: SupportedLanguage[];
2650
+ /** Whether to redirect to user language. */
2651
+ autoRedirect?: boolean;
2652
+ }
2653
+ interface SupportedLanguage {
2654
+ /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
2655
+ languageCode?: string;
2656
+ /** Locale. */
2657
+ locale?: Locale;
2658
+ /** Whether the supported language is the primary language for the site. */
2659
+ isPrimary?: boolean;
2660
+ /** Language icon. */
2661
+ countryCode?: string;
2662
+ /** How the language will be resolved. For internal use. */
2663
+ resolutionMethod?: ResolutionMethodWithLiterals;
2664
+ /** Whether the supported language is the primary language for site visitors. */
2665
+ isVisitorPrimary?: boolean | null;
2666
+ }
2667
+ declare enum ResolutionMethod {
2668
+ QUERY_PARAM = "QUERY_PARAM",
2669
+ SUBDOMAIN = "SUBDOMAIN",
2670
+ SUBDIRECTORY = "SUBDIRECTORY"
2671
+ }
2672
+ /** @enumType */
2673
+ type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
2674
+ interface ConsentPolicy {
2675
+ /** Whether the site uses cookies that are essential to site operation. Always `true`. */
2676
+ essential?: boolean | null;
2677
+ /** Whether the site uses cookies that affect site performance and other functional measurements. */
2678
+ functional?: boolean | null;
2679
+ /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
2680
+ analytics?: boolean | null;
2681
+ /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
2682
+ advertising?: boolean | null;
2683
+ /** CCPA compliance flag. */
2684
+ dataToThirdParty?: boolean | null;
2685
+ }
2686
+ /** A single mapping from the MetaSite ID to a particular service. */
2687
+ interface Translation {
2688
+ /** The service type. */
2689
+ serviceType?: string;
2690
+ /** The application definition ID; this only applies to services of type ThirdPartyApps. */
2691
+ appDefId?: string;
2692
+ /** The instance ID of the service. */
2693
+ instanceId?: string;
2694
+ }
2695
+ interface ChangeContext extends ChangeContextPayloadOneOf {
2696
+ /** Properties were updated. */
2697
+ propertiesChange?: PropertiesChange;
2698
+ /** Default properties were created on site creation. */
2699
+ siteCreated?: SiteCreated;
2700
+ /** Properties were cloned on site cloning. */
2701
+ siteCloned?: SiteCloned;
2702
+ }
2703
+ /** @oneof */
2704
+ interface ChangeContextPayloadOneOf {
2705
+ /** Properties were updated. */
2706
+ propertiesChange?: PropertiesChange;
2707
+ /** Default properties were created on site creation. */
2708
+ siteCreated?: SiteCreated;
2709
+ /** Properties were cloned on site cloning. */
2710
+ siteCloned?: SiteCloned;
2711
+ }
2712
+ interface PropertiesChange {
2713
+ }
2714
+ interface SiteCreated {
2715
+ /** Origin template site id. */
2716
+ originTemplateId?: string | null;
2717
+ }
2718
+ interface SiteCloned {
2719
+ /** Origin site id. */
2720
+ originMetaSiteId?: string;
2721
+ }
2722
+ interface Empty {
2723
+ }
2724
+ interface DomainEvent extends DomainEventBodyOneOf {
2725
+ createdEvent?: EntityCreatedEvent;
2726
+ updatedEvent?: EntityUpdatedEvent;
2727
+ deletedEvent?: EntityDeletedEvent;
2728
+ actionEvent?: ActionEvent;
2729
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2730
+ _id?: string;
2731
+ /**
2732
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2733
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2734
+ */
2735
+ entityFqdn?: string;
2736
+ /**
2737
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
2738
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2739
+ */
2740
+ slug?: string;
2741
+ /** ID of the entity associated with the event. */
2742
+ entityId?: string;
2743
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2744
+ eventTime?: Date | null;
2745
+ /**
2746
+ * Whether the event was triggered as a result of a privacy regulation application
2747
+ * (for example, GDPR).
2748
+ */
2749
+ triggeredByAnonymizeRequest?: boolean | null;
2750
+ /** If present, indicates the action that triggered the event. */
2751
+ originatedFrom?: string | null;
2752
+ /**
2753
+ * 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.
2754
+ * 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.
2755
+ */
2756
+ entityEventSequence?: string | null;
2757
+ }
2758
+ /** @oneof */
2759
+ interface DomainEventBodyOneOf {
2760
+ createdEvent?: EntityCreatedEvent;
2761
+ updatedEvent?: EntityUpdatedEvent;
2762
+ deletedEvent?: EntityDeletedEvent;
2763
+ actionEvent?: ActionEvent;
2764
+ }
2765
+ interface EntityCreatedEvent {
2766
+ entity?: string;
2767
+ }
2768
+ interface RestoreInfo {
2769
+ deletedDate?: Date | null;
2770
+ }
2771
+ interface EntityUpdatedEvent {
2772
+ /**
2773
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2774
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2775
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2776
+ */
2777
+ currentEntity?: string;
2778
+ }
2779
+ interface EntityDeletedEvent {
2780
+ /** Entity that was deleted. */
2781
+ deletedEntity?: string | null;
2782
+ }
2783
+ interface ActionEvent {
2784
+ body?: string;
2785
+ }
2786
+ interface MessageEnvelope {
2787
+ /**
2788
+ * App instance ID.
2789
+ * @format GUID
2790
+ */
2791
+ instanceId?: string | null;
2792
+ /**
2793
+ * Event type.
2794
+ * @maxLength 150
2795
+ */
2796
+ eventType?: string;
2797
+ /** The identification type and identity data. */
2798
+ identity?: IdentificationData;
2799
+ /** Stringify payload. */
2800
+ data?: string;
2801
+ }
2802
+ interface IdentificationData extends IdentificationDataIdOneOf {
2803
+ /**
2804
+ * ID of a site visitor that has not logged in to the site.
2805
+ * @format GUID
2806
+ */
2807
+ anonymousVisitorId?: string;
2808
+ /**
2809
+ * ID of a site visitor that has logged in to the site.
2810
+ * @format GUID
2811
+ */
2812
+ memberId?: string;
2813
+ /**
2814
+ * ID of a Wix user (site owner, contributor, etc.).
2815
+ * @format GUID
2816
+ */
2817
+ wixUserId?: string;
2818
+ /**
2819
+ * ID of an app.
2820
+ * @format GUID
2821
+ */
2822
+ appId?: string;
2823
+ /** @readonly */
2824
+ identityType?: WebhookIdentityTypeWithLiterals;
2825
+ }
2826
+ /** @oneof */
2827
+ interface IdentificationDataIdOneOf {
2828
+ /**
2829
+ * ID of a site visitor that has not logged in to the site.
2830
+ * @format GUID
2831
+ */
2832
+ anonymousVisitorId?: string;
2833
+ /**
2834
+ * ID of a site visitor that has logged in to the site.
2835
+ * @format GUID
2836
+ */
2837
+ memberId?: string;
2838
+ /**
2839
+ * ID of a Wix user (site owner, contributor, etc.).
2840
+ * @format GUID
2841
+ */
2842
+ wixUserId?: string;
2843
+ /**
2844
+ * ID of an app.
2845
+ * @format GUID
2846
+ */
2847
+ appId?: string;
2848
+ }
2849
+ declare enum WebhookIdentityType {
2850
+ UNKNOWN = "UNKNOWN",
2851
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2852
+ MEMBER = "MEMBER",
2853
+ WIX_USER = "WIX_USER",
2854
+ APP = "APP"
2855
+ }
2856
+ /** @enumType */
2857
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2858
+ /** @docsIgnore */
2859
+ type BulkUpdateExperienceTagsApplicationErrors = {
2860
+ code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
2861
+ description?: string;
2862
+ data?: Record<string, any>;
2863
+ };
2864
+ /** @docsIgnore */
2865
+ type BulkUpdateExperienceTagsByFilterApplicationErrors = {
2866
+ code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
2867
+ description?: string;
2868
+ data?: Record<string, any>;
2869
+ };
2870
+ interface BaseEventMetadata {
2871
+ /**
2872
+ * App instance ID.
2873
+ * @format GUID
2874
+ */
2875
+ instanceId?: string | null;
2876
+ /**
2877
+ * Event type.
2878
+ * @maxLength 150
2879
+ */
2880
+ eventType?: string;
2881
+ /** The identification type and identity data. */
2882
+ identity?: IdentificationData;
2883
+ }
2884
+ interface EventMetadata extends BaseEventMetadata {
2885
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2886
+ _id?: string;
2887
+ /**
2888
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2889
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2890
+ */
2891
+ entityFqdn?: string;
2892
+ /**
2893
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
2894
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2895
+ */
2896
+ slug?: string;
2897
+ /** ID of the entity associated with the event. */
2898
+ entityId?: string;
2899
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2900
+ eventTime?: Date | null;
2901
+ /**
2902
+ * Whether the event was triggered as a result of a privacy regulation application
2903
+ * (for example, GDPR).
2904
+ */
2905
+ triggeredByAnonymizeRequest?: boolean | null;
2906
+ /** If present, indicates the action that triggered the event. */
2907
+ originatedFrom?: string | null;
2908
+ /**
2909
+ * 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.
2910
+ * 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.
2911
+ */
2912
+ entityEventSequence?: string | null;
2913
+ }
2914
+ interface ExperienceCreatedEnvelope {
2915
+ entity: Experience;
2916
+ metadata: EventMetadata;
2917
+ }
2918
+ /** @permissionId TABLE_RESERVATIONS.EXPERIENCE_DOMAIN_EVENTS_READ
2919
+ * @webhook
2920
+ * @eventType wix.table_reservations.v1.experience_created
2921
+ * @slug created
2922
+ * @documentationMaturity preview
2923
+ */
2924
+ declare function onExperienceCreated(handler: (event: ExperienceCreatedEnvelope) => void | Promise<void>): void;
2925
+ interface ExperienceTagsModifiedEnvelope {
2926
+ data: TagsModified;
2927
+ metadata: EventMetadata;
2928
+ }
2929
+ /** @permissionId TABLE_RESERVATIONS.EXPERIENCE_DOMAIN_EVENTS_READ
2930
+ * @webhook
2931
+ * @eventType wix.table_reservations.v1.experience_tags_modified
2932
+ * @slug tags_modified
2933
+ * @documentationMaturity preview
2934
+ */
2935
+ declare function onExperienceTagsModified(handler: (event: ExperienceTagsModifiedEnvelope) => void | Promise<void>): void;
2936
+ interface ExperienceUpdatedEnvelope {
2937
+ entity: Experience;
2938
+ metadata: EventMetadata;
2939
+ }
2940
+ /** @permissionId TABLE_RESERVATIONS.EXPERIENCE_DOMAIN_EVENTS_READ
2941
+ * @webhook
2942
+ * @eventType wix.table_reservations.v1.experience_updated
2943
+ * @slug updated
2944
+ * @documentationMaturity preview
2945
+ */
2946
+ declare function onExperienceUpdated(handler: (event: ExperienceUpdatedEnvelope) => void | Promise<void>): void;
2947
+ /**
2948
+ * Creates an Experience.
2949
+ * @param experience - Experience to be created.
2950
+ * @public
2951
+ * @documentationMaturity preview
2952
+ * @requiredField experience
2953
+ * @requiredField experience.configuration
2954
+ * @requiredField experience.configuration.displayInfo
2955
+ * @requiredField experience.configuration.displayInfo.name
2956
+ * @requiredField experience.configuration.onlineReservations
2957
+ * @requiredField experience.configuration.onlineReservations.approval
2958
+ * @requiredField experience.configuration.onlineReservations.approval.mode
2959
+ * @requiredField experience.configuration.onlineReservations.maxGuests.number
2960
+ * @requiredField experience.configuration.onlineReservations.maximumReservationNotice.number
2961
+ * @requiredField experience.configuration.onlineReservations.maximumReservationNotice.unit
2962
+ * @requiredField experience.configuration.onlineReservations.minimumReservationNotice.number
2963
+ * @requiredField experience.configuration.onlineReservations.minimumReservationNotice.unit
2964
+ * @requiredField experience.configuration.onlineReservations.partySize
2965
+ * @requiredField experience.configuration.onlineReservations.partySize.max
2966
+ * @requiredField experience.configuration.onlineReservations.partySize.min
2967
+ * @requiredField experience.configuration.paymentPolicy
2968
+ * @requiredField experience.configuration.paymentPolicy.paymentPolicyType
2969
+ * @requiredField experience.reservationLocationId
2970
+ * @permissionId TABLE_RESERVATIONS.EXPERIENCE_CREATE
2971
+ * @applicableIdentity APP
2972
+ * @returns The created Experience.
2973
+ * @fqn wix.table_reservations.experience.v1.ExperiencesService.CreateExperience
2974
+ */
2975
+ declare function createExperience(experience: NonNullablePaths<Experience, `configuration` | `configuration.displayInfo` | `configuration.displayInfo.name` | `configuration.onlineReservations` | `configuration.onlineReservations.approval` | `configuration.onlineReservations.approval.mode` | `configuration.onlineReservations.maxGuests.number` | `configuration.onlineReservations.maximumReservationNotice.number` | `configuration.onlineReservations.maximumReservationNotice.unit` | `configuration.onlineReservations.minimumReservationNotice.number` | `configuration.onlineReservations.minimumReservationNotice.unit` | `configuration.onlineReservations.partySize` | `configuration.onlineReservations.partySize.max` | `configuration.onlineReservations.partySize.min` | `configuration.paymentPolicy` | `configuration.paymentPolicy.paymentPolicyType` | `reservationLocationId`, 5>): Promise<NonNullablePaths<Experience, `configuration.paymentPolicy.paymentPolicyType` | `configuration.onlineReservations.minimumReservationNotice.unit` | `configuration.onlineReservations.approval.mode` | `configuration.onlineReservations.businessSchedule.entries` | `configuration.onlineReservations.businessSchedule.entries.${number}.recurrence` | `configuration.reservationForm.customFieldDefinitions` | `configuration.tableManagement.onOptions.specificTablesOptions.tables` | `configuration.tableManagement.onOptions.specificTablesOptions.tableCombinations` | `configuration.tableManagement.onOptions.tableAvailabilityType` | `configuration.tableManagement.onOptions.tableAssignmentType` | `configuration.tableManagement.mode` | `tags.privateTags.tagIds`, 7>>;
2976
+ /**
2977
+ * Retrieves an Experience.
2978
+ * @param experienceId - ID of the Experience to retrieve.
2979
+ * @public
2980
+ * @documentationMaturity preview
2981
+ * @requiredField experienceId
2982
+ * @permissionId TABLE_RESERVATIONS.EXPERIENCE_READ
2983
+ * @permissionId TABLE_RESERVATIONS.EXPERIENCE_READ_FULL
2984
+ * @applicableIdentity APP
2985
+ * @returns The requested Experience.
2986
+ * @fqn wix.table_reservations.experience.v1.ExperiencesService.GetExperience
2987
+ */
2988
+ declare function getExperience(experienceId: string): Promise<NonNullablePaths<Experience, `configuration.paymentPolicy.paymentPolicyType` | `configuration.onlineReservations.minimumReservationNotice.unit` | `configuration.onlineReservations.approval.mode` | `configuration.onlineReservations.businessSchedule.entries` | `configuration.onlineReservations.businessSchedule.entries.${number}.recurrence` | `configuration.reservationForm.customFieldDefinitions` | `configuration.tableManagement.onOptions.specificTablesOptions.tables` | `configuration.tableManagement.onOptions.specificTablesOptions.tableCombinations` | `configuration.tableManagement.onOptions.tableAvailabilityType` | `configuration.tableManagement.onOptions.tableAssignmentType` | `configuration.tableManagement.mode` | `tags.privateTags.tagIds`, 7>>;
2989
+ /**
2990
+ * Updates an Experience.
2991
+ *
2992
+ * Each time the Experience is updated,
2993
+ * `revision` increments by 1.
2994
+ * The current `revision` must be passed when updating the Experience.
2995
+ * This ensures you're working with the latest Experience
2996
+ * and prevents unintended overwrites.
2997
+ * @param _id - Experience ID.
2998
+ * @public
2999
+ * @documentationMaturity preview
3000
+ * @requiredField _id
3001
+ * @requiredField experience
3002
+ * @requiredField experience.revision
3003
+ * @permissionId TABLE_RESERVATIONS.EXPERIENCE_UPDATE
3004
+ * @applicableIdentity APP
3005
+ * @returns Updated Experience.
3006
+ * @fqn wix.table_reservations.experience.v1.ExperiencesService.UpdateExperience
3007
+ */
3008
+ declare function updateExperience(_id: string, experience: NonNullablePaths<UpdateExperience, `revision`, 2>): Promise<NonNullablePaths<Experience, `configuration.paymentPolicy.paymentPolicyType` | `configuration.onlineReservations.minimumReservationNotice.unit` | `configuration.onlineReservations.approval.mode` | `configuration.onlineReservations.businessSchedule.entries` | `configuration.onlineReservations.businessSchedule.entries.${number}.recurrence` | `configuration.reservationForm.customFieldDefinitions` | `configuration.tableManagement.onOptions.specificTablesOptions.tables` | `configuration.tableManagement.onOptions.specificTablesOptions.tableCombinations` | `configuration.tableManagement.onOptions.tableAvailabilityType` | `configuration.tableManagement.onOptions.tableAssignmentType` | `configuration.tableManagement.mode` | `tags.privateTags.tagIds`, 7>>;
3009
+ interface UpdateExperience {
3010
+ /**
3011
+ * Experience ID.
3012
+ * @format GUID
3013
+ * @readonly
3014
+ */
3015
+ _id?: string | null;
3016
+ /**
3017
+ * Id of reservation location experience is assigned to.
3018
+ * @format GUID
3019
+ * @readonly
3020
+ */
3021
+ reservationLocationId?: string | null;
3022
+ /**
3023
+ * Revision number, which increments by 1 each time the Experience is updated.
3024
+ * To prevent conflicting changes,
3025
+ * the current revision must be passed when updating the Experience.
3026
+ *
3027
+ * Ignored when creating an Experience.
3028
+ * @readonly
3029
+ */
3030
+ revision?: string | null;
3031
+ /**
3032
+ * Date and time the Experience was created.
3033
+ * @readonly
3034
+ */
3035
+ _createdDate?: Date | null;
3036
+ /**
3037
+ * Date and time the Experience was last updated.
3038
+ * @readonly
3039
+ */
3040
+ _updatedDate?: Date | null;
3041
+ /** Configuration. */
3042
+ configuration?: Configuration;
3043
+ /**
3044
+ * Currency code. Must be valid ISO 4217 currency code (e.g., USD).
3045
+ * @format CURRENCY
3046
+ * @readonly
3047
+ */
3048
+ currency?: string | null;
3049
+ /** Data Extensions. */
3050
+ extendedFields?: ExtendedFields;
3051
+ /** Tags. */
3052
+ tags?: Tags;
3053
+ }
3054
+ /**
3055
+ * Queries Experiences.
3056
+ * @public
3057
+ * @documentationMaturity preview
3058
+ * @permissionId TABLE_RESERVATIONS.EXPERIENCE_READ
3059
+ * @permissionId TABLE_RESERVATIONS.EXPERIENCE_READ_FULL
3060
+ * @applicableIdentity APP
3061
+ * @fqn wix.table_reservations.experience.v1.ExperiencesService.QueryExperiences
3062
+ */
3063
+ declare function queryExperiences(): ExperiencesQueryBuilder;
3064
+ interface QueryCursorResult {
3065
+ cursors: Cursors;
3066
+ hasNext: () => boolean;
3067
+ hasPrev: () => boolean;
3068
+ length: number;
3069
+ pageSize: number;
3070
+ }
3071
+ interface ExperiencesQueryResult extends QueryCursorResult {
3072
+ items: Experience[];
3073
+ query: ExperiencesQueryBuilder;
3074
+ next: () => Promise<ExperiencesQueryResult>;
3075
+ prev: () => Promise<ExperiencesQueryResult>;
3076
+ }
3077
+ interface ExperiencesQueryBuilder {
3078
+ /** @param propertyName - Property whose value is compared with `value`.
3079
+ * @param value - Value to compare against.
3080
+ * @documentationMaturity preview
3081
+ */
3082
+ eq: (propertyName: '_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate' | 'configuration.visible' | 'tags', value: any) => ExperiencesQueryBuilder;
3083
+ /** @param propertyName - Property whose value is compared with `value`.
3084
+ * @param value - Value to compare against.
3085
+ * @documentationMaturity preview
3086
+ */
3087
+ ne: (propertyName: '_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate' | 'configuration.visible' | 'tags', value: any) => ExperiencesQueryBuilder;
3088
+ /** @param propertyName - Property whose value is compared with `value`.
3089
+ * @param value - Value to compare against.
3090
+ * @documentationMaturity preview
3091
+ */
3092
+ ge: (propertyName: '_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate', value: any) => ExperiencesQueryBuilder;
3093
+ /** @param propertyName - Property whose value is compared with `value`.
3094
+ * @param value - Value to compare against.
3095
+ * @documentationMaturity preview
3096
+ */
3097
+ gt: (propertyName: '_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate', value: any) => ExperiencesQueryBuilder;
3098
+ /** @param propertyName - Property whose value is compared with `value`.
3099
+ * @param value - Value to compare against.
3100
+ * @documentationMaturity preview
3101
+ */
3102
+ le: (propertyName: '_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate', value: any) => ExperiencesQueryBuilder;
3103
+ /** @param propertyName - Property whose value is compared with `value`.
3104
+ * @param value - Value to compare against.
3105
+ * @documentationMaturity preview
3106
+ */
3107
+ lt: (propertyName: '_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate', value: any) => ExperiencesQueryBuilder;
3108
+ /** @param propertyName - Property whose value is compared with `string`.
3109
+ * @param string - String to compare against. Case-insensitive.
3110
+ * @documentationMaturity preview
3111
+ */
3112
+ startsWith: (propertyName: '_id' | 'reservationLocationId' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate', value: string) => ExperiencesQueryBuilder;
3113
+ /** @param propertyName - Property whose value is compared with `values`.
3114
+ * @param values - List of values to compare against.
3115
+ * @documentationMaturity preview
3116
+ */
3117
+ hasSome: (propertyName: '_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate' | 'configuration.visible' | 'tags', value: any[]) => ExperiencesQueryBuilder;
3118
+ /** @documentationMaturity preview */
3119
+ in: (propertyName: '_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate' | 'configuration.visible' | 'tags', value: any) => ExperiencesQueryBuilder;
3120
+ /** @documentationMaturity preview */
3121
+ exists: (propertyName: '_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate' | 'configuration.visible' | 'tags', value: boolean) => ExperiencesQueryBuilder;
3122
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
3123
+ * @documentationMaturity preview
3124
+ */
3125
+ ascending: (...propertyNames: Array<'_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate' | 'configuration.visible' | 'tags'>) => ExperiencesQueryBuilder;
3126
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
3127
+ * @documentationMaturity preview
3128
+ */
3129
+ descending: (...propertyNames: Array<'_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate' | 'configuration.visible' | 'tags'>) => ExperiencesQueryBuilder;
3130
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
3131
+ * @documentationMaturity preview
3132
+ */
3133
+ limit: (limit: number) => ExperiencesQueryBuilder;
3134
+ /** @param cursor - A pointer to specific record
3135
+ * @documentationMaturity preview
3136
+ */
3137
+ skipTo: (cursor: string) => ExperiencesQueryBuilder;
3138
+ /** @documentationMaturity preview */
3139
+ find: () => Promise<ExperiencesQueryResult>;
3140
+ }
3141
+ /**
3142
+ * Synchronously update tags on multiple Experiences, by list of Experiences ids
3143
+ * A tag that appears both in the list of assign and unassign tags, will be assigned
3144
+ * @param experienceIds - List of NileProtoTagsEntities that their tags will update.
3145
+ * @public
3146
+ * @documentationMaturity preview
3147
+ * @requiredField experienceIds
3148
+ * @permissionId TABLE_RESERVATIONS.EXPERIENCE_UPDATE_TAGS
3149
+ * @applicableIdentity APP
3150
+ * @fqn wix.table_reservations.experience.v1.ExperiencesService.BulkUpdateExperienceTags
3151
+ */
3152
+ declare function bulkUpdateExperienceTags(experienceIds: string[], options?: BulkUpdateExperienceTagsOptions): Promise<NonNullablePaths<BulkUpdateExperienceTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
3153
+ __applicationErrorsType?: BulkUpdateExperienceTagsApplicationErrors;
3154
+ }>;
3155
+ interface BulkUpdateExperienceTagsOptions {
3156
+ /** List of Tags to assign */
3157
+ assignTags?: Tags;
3158
+ /** List of Tags to unAssign */
3159
+ unassignTags?: Tags;
3160
+ }
3161
+ /**
3162
+ * Asynchronously update tags on multiple Experiences, by provided filter
3163
+ * An empty filter will update all Experiences
3164
+ * A tag that appears both in the list of assign and unassign tags, will be assigned
3165
+ * @param filter - Filter
3166
+ * @public
3167
+ * @documentationMaturity preview
3168
+ * @requiredField filter
3169
+ * @permissionId TABLE_RESERVATIONS.EXPERIENCE_UPDATE_TAGS
3170
+ * @applicableIdentity APP
3171
+ * @fqn wix.table_reservations.experience.v1.ExperiencesService.BulkUpdateExperienceTagsByFilter
3172
+ */
3173
+ declare function bulkUpdateExperienceTagsByFilter(filter: Record<string, any>, options?: BulkUpdateExperienceTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateExperienceTagsByFilterResponse, `jobId`, 2> & {
3174
+ __applicationErrorsType?: BulkUpdateExperienceTagsByFilterApplicationErrors;
3175
+ }>;
3176
+ interface BulkUpdateExperienceTagsByFilterOptions {
3177
+ /** List of Tags to assign */
3178
+ assignTags?: Tags;
3179
+ /** List of Tags to unAssign */
3180
+ unassignTags?: Tags;
3181
+ }
3182
+
3183
+ export { type ActionEvent, type Address, type AddressHint, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, type ApplicationError, type Approval, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, BackgroundType, type BackgroundTypeWithLiterals, type BaseEventMetadata, type BlockquoteData, type BookingData, type Border, type BorderColors, type BulkActionMetadata, type BulkUpdateExperienceTagsApplicationErrors, type BulkUpdateExperienceTagsByFilterApplicationErrors, type BulkUpdateExperienceTagsByFilterOptions, type BulkUpdateExperienceTagsByFilterRequest, type BulkUpdateExperienceTagsByFilterResponse, type BulkUpdateExperienceTagsOptions, type BulkUpdateExperienceTagsRequest, type BulkUpdateExperienceTagsResponse, type BulkUpdateExperienceTagsResult, type BulletedListData, type BusinessSchedule, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardStyles, type Categories, type CellStyle, type ChangeContext, type ChangeContextPayloadOneOf, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type Configuration, type ConsentPolicy, type CreateExperienceRequest, type CreateExperienceResponse, Crop, type CropWithLiterals, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomFieldDefinition, DayOfWeek, type DayOfWeekWithLiterals, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type Design, type Dimensions, Direction, type DirectionWithLiterals, type DisplayInfo, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmailMarketingCheckbox, type EmbedData, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type Entry, type EntryRecurrenceOptionsOneOf, type EventData, type EventMetadata, type Experience, type ExperienceCreatedEnvelope, type ExperienceTagsModifiedEnvelope, type ExperienceUpdatedEnvelope, type ExperiencesQueryBuilder, type ExperiencesQueryResult, type ExtendedFields, type FileData, type FileSource, type FileSourceDataOneOf, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GeoCoordinates, type GetExperienceRequest, type GetExperienceResponse, type Gradient, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type Item, type ItemDataOneOf, type ItemMetadata, type ItemStyle, Layout, type LayoutCellData, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListValue, type Locale, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type MaxGuests, type Media, type MentionData, type MessageEnvelope, type Metadata, Mode, type ModeWithLiterals, type Multilingual, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, type NoticePeriod, NullValue, type NullValueWithLiterals, type Oembed, type OnOptions, type OnOptionsOptionsOneOf, type OneTimeOptions, type OnlineReservations, type OnlineReservationsBusinessSchedule, type Option, type OptionDesign, type OptionLayout, type OrderedListData, Orientation, type OrientationWithLiterals, type PDFSettings, type ParagraphData, type PartySize, type PaymentPolicy, type PaymentPolicyOptionsOneOf, PaymentPolicyType, type PaymentPolicyTypeWithLiterals, type PerGuestOptions, type Permissions, Placement, PlacementType, type PlacementTypeWithLiterals, type PlacementWithLiterals, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, Position, type PositionWithLiterals, type PricingData, type PrivacyPolicy, type PrivacyPolicyValueOneOf, type Properties, type PropertiesChange, type QueryExperiencesRequest, type QueryExperiencesResponse, Recurrence, type RecurrenceWithLiterals, type Rel, type ReservationForm, Resizing, type ResizingWithLiterals, ResolutionMethod, type ResolutionMethodWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, type Settings, type SiteCloned, type SiteCreated, type SitePropertiesEvent, type SitePropertiesNotification, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type SpecialHourPeriod, type SpecificTablesOptions, type Spoiler, type SpoilerData, type StartDaysAndTimes, StartDaysAndTimesDayOfWeek, type StartDaysAndTimesDayOfWeekWithLiterals, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type SupportedLanguage, type Table, TableAssignmentType, type TableAssignmentTypeWithLiterals, TableAvailabilityType, type TableAvailabilityTypeWithLiterals, type TableCellData, type TableCombination, type TableData, type TableManagement, TableManagementMode, type TableManagementModeWithLiterals, type TableManagementOptionsOneOf, type TagList, type Tags, type TagsModified, Target, type TargetWithLiterals, type TermsAndConditions, type TermsAndConditionsValueOneOf, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type TimePeriod, type Translation, Type, type TypeWithLiterals, Unit, type UnitWithLiterals, type UpdateExperience, type UpdateExperienceRequest, type UpdateExperienceResponse, VerticalAlignment, type VerticalAlignmentWithLiterals, type Video, type VideoData, ViewMode, type ViewModeWithLiterals, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WeeklyOptions, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, bulkUpdateExperienceTags, bulkUpdateExperienceTagsByFilter, createExperience, getExperience, onExperienceCreated, onExperienceTagsModified, onExperienceUpdated, queryExperiences, updateExperience };