@wix/auto_sdk_events_forms 1.0.4 → 1.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -137,21 +137,29 @@ export declare enum ValueType {
137
137
  * Defaults to first (0th) option if not configured.
138
138
  */
139
139
  export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
140
- /** 0-based index from predefined `input.options` which is selected initially. */
140
+ /**
141
+ * 0-based index from predefined `input.options` which is selected initially.
142
+ * @max 199
143
+ */
141
144
  optionIndex?: number;
142
145
  /**
143
146
  * Placeholder hint describing expected choices (such as "Please select").
144
147
  * Considered an empty choice.
148
+ * @maxLength 200
145
149
  */
146
150
  placeholderText?: string;
147
151
  }
148
152
  /** @oneof */
149
153
  export interface OptionSelectionSelectedOptionOneOf {
150
- /** 0-based index from predefined `input.options` which is selected initially. */
154
+ /**
155
+ * 0-based index from predefined `input.options` which is selected initially.
156
+ * @max 199
157
+ */
151
158
  optionIndex?: number;
152
159
  /**
153
160
  * Placeholder hint describing expected choices (such as "Please select").
154
161
  * Considered an empty choice.
162
+ * @maxLength 200
155
163
  */
156
164
  placeholderText?: string;
157
165
  }
@@ -273,7 +281,10 @@ export interface FormInputControlDeleted {
273
281
  deletedInputControl?: InputControl;
274
282
  }
275
283
  export interface GetFormRequest {
276
- /** Event ID to which the form belongs. */
284
+ /**
285
+ * Event ID to which the form belongs.
286
+ * @format GUID
287
+ */
277
288
  eventId: string;
278
289
  }
279
290
  export declare enum RequestedFields {
@@ -310,7 +321,10 @@ export interface AddControlRequest extends AddControlRequestControlOneOf {
310
321
  text?: TextControl;
311
322
  /** Single-choice radio button style input control. */
312
323
  radioButton?: RadioButtonControl;
313
- /** Event ID to which the form belongs. */
324
+ /**
325
+ * Event ID to which the form belongs.
326
+ * @format GUID
327
+ */
314
328
  eventId: string;
315
329
  }
316
330
  /** @oneof */
@@ -333,7 +347,10 @@ export interface AddControlRequestControlOneOf {
333
347
  radioButton?: RadioButtonControl;
334
348
  }
335
349
  export interface PhoneControl {
336
- /** Phone input label. */
350
+ /**
351
+ * Phone input label.
352
+ * @maxLength 100
353
+ */
337
354
  label?: string;
338
355
  /** Whether phone input is required. */
339
356
  mandatory?: boolean;
@@ -347,21 +364,42 @@ export interface AddressControl {
347
364
  mandatory?: boolean;
348
365
  }
349
366
  export interface AddressControlLabels {
350
- /** Single-line address input label. */
367
+ /**
368
+ * Single-line address input label.
369
+ * @maxLength 100
370
+ */
351
371
  addressLine?: string;
352
- /** Country input label. */
372
+ /**
373
+ * Country input label.
374
+ * @maxLength 100
375
+ */
353
376
  country?: string;
354
- /** Subdivision input label. */
377
+ /**
378
+ * Subdivision input label.
379
+ * @maxLength 100
380
+ */
355
381
  subdivision?: string;
356
- /** City input label. */
382
+ /**
383
+ * City input label.
384
+ * @maxLength 100
385
+ */
357
386
  city?: string;
358
- /** Postal code input label. */
387
+ /**
388
+ * Postal code input label.
389
+ * @maxLength 100
390
+ */
359
391
  postalCode?: string;
360
- /** Street address input label. */
392
+ /**
393
+ * Street address input label.
394
+ * @maxLength 100
395
+ */
361
396
  streetAddress?: string;
362
397
  }
363
398
  export interface DateControl {
364
- /** Input control label. */
399
+ /**
400
+ * Input control label.
401
+ * @maxLength 100
402
+ */
365
403
  label?: string;
366
404
  /** Whether date input is required */
367
405
  mandatory?: boolean;
@@ -371,19 +409,37 @@ export interface AdditionalGuestsControl {
371
409
  labels?: Labels;
372
410
  /** Whether individual guest names are required. */
373
411
  namesMandatory?: boolean;
374
- /** Maximum number of additional guests. */
412
+ /**
413
+ * Maximum number of additional guests.
414
+ * @min 1
415
+ * @max 10
416
+ */
375
417
  maxGuests?: number;
376
418
  }
377
419
  export interface Labels {
378
- /** Input label for a single guest. */
420
+ /**
421
+ * Input label for a single guest.
422
+ * @maxLength 200
423
+ */
379
424
  single?: string;
380
- /** Input label for multiple guests. */
425
+ /**
426
+ * Input label for multiple guests.
427
+ * @maxLength 200
428
+ */
381
429
  multiple?: string;
382
430
  }
383
431
  export interface DropdownControl {
384
- /** Input control label. */
432
+ /**
433
+ * Input control label.
434
+ * @maxLength 200
435
+ */
385
436
  label?: string;
386
- /** Predefined options guests can choose from. */
437
+ /**
438
+ * Predefined options guests can choose from.
439
+ * @minSize 2
440
+ * @maxSize 200
441
+ * @maxLength 200
442
+ */
387
443
  options?: string[];
388
444
  /** Whether choice is required. */
389
445
  mandatory?: boolean;
@@ -391,25 +447,47 @@ export interface DropdownControl {
391
447
  defaultOptionSelection?: OptionSelection;
392
448
  }
393
449
  export interface RadioButtonControl {
394
- /** Input control label. */
450
+ /**
451
+ * Input control label.
452
+ * @maxLength 200
453
+ */
395
454
  label?: string;
396
- /** Predefined options guests can choose from. */
455
+ /**
456
+ * Predefined options guests can choose from.
457
+ * @minSize 2
458
+ * @maxSize 200
459
+ * @maxLength 200
460
+ */
397
461
  options?: string[];
398
462
  }
399
463
  export interface CheckboxControl {
400
- /** Input control label. */
464
+ /**
465
+ * Input control label.
466
+ * @maxLength 200
467
+ */
401
468
  label?: string;
402
469
  /** Whether at least one checkbox is required. */
403
470
  mandatory?: boolean;
404
- /** Predefined options guests can choose from. */
471
+ /**
472
+ * Predefined options guests can choose from.
473
+ * @minSize 1
474
+ * @maxSize 200
475
+ * @maxLength 200
476
+ */
405
477
  options?: string[];
406
478
  }
407
479
  export interface TextControl {
408
- /** Input control label. */
480
+ /**
481
+ * Input control label.
482
+ * @maxLength 200
483
+ */
409
484
  label?: string;
410
485
  /** Whether text input is required. */
411
486
  mandatory?: boolean;
412
- /** Maximum number of characters allowed. */
487
+ /**
488
+ * Maximum number of characters allowed.
489
+ * @max 1000
490
+ */
413
491
  maxLength?: number;
414
492
  /** Whether input control should allow multiple lines in text. */
415
493
  multiLine?: boolean;
@@ -443,7 +521,10 @@ export interface UpdateControlRequest extends UpdateControlRequestControlOneOf {
443
521
  email?: EmailControl;
444
522
  /** Single-choice radio style input control. */
445
523
  radioButton?: RadioButtonControl;
446
- /** Event ID to which the form belongs. */
524
+ /**
525
+ * Event ID to which the form belongs.
526
+ * @format GUID
527
+ */
447
528
  eventId: string;
448
529
  /** Unique input control ID. */
449
530
  _id: string;
@@ -478,13 +559,22 @@ export interface NameControl {
478
559
  labels?: NameControlLabels;
479
560
  }
480
561
  export interface NameControlLabels {
481
- /** First name input label */
562
+ /**
563
+ * First name input label
564
+ * @maxLength 100
565
+ */
482
566
  firstName?: string;
483
- /** Last name input label */
567
+ /**
568
+ * Last name input label
569
+ * @maxLength 100
570
+ */
484
571
  lastName?: string;
485
572
  }
486
573
  export interface EmailControl {
487
- /** Email input label. */
574
+ /**
575
+ * Email input label.
576
+ * @maxLength 100
577
+ */
488
578
  label?: string;
489
579
  }
490
580
  export interface UpdateControlResponse {
@@ -492,9 +582,15 @@ export interface UpdateControlResponse {
492
582
  form?: Form;
493
583
  }
494
584
  export interface DeleteControlRequest {
495
- /** Event ID to which the form belongs. */
585
+ /**
586
+ * Event ID to which the form belongs.
587
+ * @format GUID
588
+ */
496
589
  eventId: string;
497
- /** Unique input control ID. */
590
+ /**
591
+ * Unique input control ID.
592
+ * @maxLength 100
593
+ */
498
594
  _id: string;
499
595
  }
500
596
  export interface DeleteControlResponse {
@@ -502,7 +598,10 @@ export interface DeleteControlResponse {
502
598
  form?: Form;
503
599
  }
504
600
  export interface UpdateMessagesRequest {
505
- /** Event ID to which the form belongs. */
601
+ /**
602
+ * Event ID to which the form belongs.
603
+ * @format GUID
604
+ */
506
605
  eventId: string;
507
606
  /**
508
607
  * Set of field paths, specifying which parts of this resource to update.
@@ -518,7 +617,10 @@ export interface UpdateMessagesResponse {
518
617
  form?: Form;
519
618
  }
520
619
  export interface PublishDraftRequest {
521
- /** Event ID to which the form belongs. */
620
+ /**
621
+ * Event ID to which the form belongs.
622
+ * @format GUID
623
+ */
522
624
  eventId: string;
523
625
  }
524
626
  export interface PublishDraftResponse {
@@ -528,7 +630,10 @@ export interface PublishDraftResponse {
528
630
  export interface EventUpdated {
529
631
  /** Event update timestamp in ISO UTC format. */
530
632
  timestamp?: Date | null;
531
- /** Event ID. */
633
+ /**
634
+ * Event ID.
635
+ * @format GUID
636
+ */
532
637
  eventId?: string;
533
638
  /** Event location. */
534
639
  location?: Location;
@@ -545,11 +650,17 @@ export interface EventUpdated {
545
650
  event?: Event;
546
651
  }
547
652
  export interface Location {
548
- /** Location name. */
653
+ /**
654
+ * Location name.
655
+ * @maxLength 50
656
+ */
549
657
  name?: string | null;
550
658
  /** Location map coordinates. */
551
659
  coordinates?: MapCoordinates;
552
- /** Single line address representation. */
660
+ /**
661
+ * Single line address representation.
662
+ * @maxLength 300
663
+ */
553
664
  address?: string | null;
554
665
  /** Location type. */
555
666
  type?: LocationType;
@@ -571,9 +682,17 @@ export interface Location {
571
682
  tbd?: boolean | null;
572
683
  }
573
684
  export interface MapCoordinates {
574
- /** Latitude. */
685
+ /**
686
+ * Latitude.
687
+ * @min -90
688
+ * @max 90
689
+ */
575
690
  lat?: number;
576
- /** Longitude. */
691
+ /**
692
+ * Longitude.
693
+ * @min -180
694
+ * @max 180
695
+ */
577
696
  lng?: number;
578
697
  }
579
698
  export declare enum LocationType {
@@ -586,7 +705,10 @@ export interface Address extends AddressStreetOneOf {
586
705
  streetAddress?: StreetAddress;
587
706
  /** Main address line (usually street and number) as free text */
588
707
  addressLine1?: string | null;
589
- /** country code */
708
+ /**
709
+ * country code
710
+ * @format COUNTRY
711
+ */
590
712
  country?: string | null;
591
713
  /** subdivision (usually state or region) code according to ISO 3166-2 */
592
714
  subdivision?: string | null;
@@ -602,7 +724,10 @@ export interface Address extends AddressStreetOneOf {
602
724
  location?: AddressLocation;
603
725
  /** country full-name */
604
726
  countryFullname?: string | null;
605
- /** multi-level subdivisions from top to bottom */
727
+ /**
728
+ * multi-level subdivisions from top to bottom
729
+ * @maxSize 6
730
+ */
606
731
  subdivisions?: Subdivision[];
607
732
  }
608
733
  /** @oneof */
@@ -619,9 +744,17 @@ export interface StreetAddress {
619
744
  name?: string;
620
745
  }
621
746
  export interface AddressLocation {
622
- /** address latitude coordinates */
747
+ /**
748
+ * address latitude coordinates
749
+ * @min -90
750
+ * @max 90
751
+ */
623
752
  latitude?: number | null;
624
- /** address longitude coordinates */
753
+ /**
754
+ * address longitude coordinates
755
+ * @min -180
756
+ * @max 180
757
+ */
625
758
  longitude?: number | null;
626
759
  }
627
760
  export interface Subdivision {
@@ -652,13 +785,19 @@ export interface ScheduleConfig {
652
785
  * `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
653
786
  */
654
787
  scheduleTbd?: boolean;
655
- /** TBD message. */
788
+ /**
789
+ * TBD message.
790
+ * @maxLength 100
791
+ */
656
792
  scheduleTbdMessage?: string | null;
657
793
  /** Event start timestamp. */
658
794
  startDate?: Date | null;
659
795
  /** Event end timestamp. */
660
796
  endDate?: Date | null;
661
- /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
797
+ /**
798
+ * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
799
+ * @maxLength 100
800
+ */
662
801
  timeZoneId?: string | null;
663
802
  /** Whether end date is hidden in the formatted schedule. */
664
803
  endDateHidden?: boolean;
@@ -668,7 +807,10 @@ export interface ScheduleConfig {
668
807
  recurrences?: Recurrences;
669
808
  }
670
809
  export interface Recurrences {
671
- /** Event occurrences. */
810
+ /**
811
+ * Event occurrences.
812
+ * @maxSize 1000
813
+ */
672
814
  occurrences?: Occurrence[];
673
815
  /**
674
816
  * Recurring event category ID.
@@ -686,7 +828,10 @@ export interface Occurrence {
686
828
  startDate?: Date | null;
687
829
  /** Event end timestamp. */
688
830
  endDate?: Date | null;
689
- /** Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
831
+ /**
832
+ * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
833
+ * @maxLength 100
834
+ */
690
835
  timeZoneId?: string | null;
691
836
  /** Whether time zone is displayed in formatted schedule. */
692
837
  showTimeZone?: boolean;
@@ -706,6 +851,7 @@ export declare enum Status {
706
851
  export interface Event {
707
852
  /**
708
853
  * Event ID.
854
+ * @format GUID
709
855
  * @readonly
710
856
  */
711
857
  _id?: string;
@@ -745,7 +891,10 @@ export interface Event {
745
891
  instanceId?: string;
746
892
  /** Guest list configuration. */
747
893
  guestListConfig?: GuestListConfig;
748
- /** Event creator user ID. */
894
+ /**
895
+ * Event creator user ID.
896
+ * @maxLength 36
897
+ */
749
898
  userId?: string;
750
899
  /** Event discussion feed. For internal use. */
751
900
  feed?: Feed;
@@ -910,17 +1059,31 @@ export interface TicketingConfig {
910
1059
  guestAssignedTickets?: boolean;
911
1060
  /** Tax configuration. */
912
1061
  taxConfig?: TaxConfig;
913
- /** Limit of tickets that can be purchased per order, default 20. */
1062
+ /**
1063
+ * Limit of tickets that can be purchased per order, default 20.
1064
+ * @max 50
1065
+ */
914
1066
  ticketLimitPerOrder?: number;
915
- /** Duration for which the tickets being bought are reserved. */
1067
+ /**
1068
+ * Duration for which the tickets being bought are reserved.
1069
+ * @min 5
1070
+ * @max 30
1071
+ */
916
1072
  reservationDurationInMinutes?: number | null;
917
1073
  }
918
1074
  export interface TaxConfig {
919
1075
  /** Tax application settings. */
920
1076
  type?: TaxType;
921
- /** Tax name. */
1077
+ /**
1078
+ * Tax name.
1079
+ * @minLength 1
1080
+ * @maxLength 10
1081
+ */
922
1082
  name?: string | null;
923
- /** Tax rate (e.g.,`21.55`). */
1083
+ /**
1084
+ * Tax rate (e.g.,`21.55`).
1085
+ * @decimalValue options - {gte:0.001,lte:100,maxScale:3}
1086
+ */
924
1087
  rate?: string | null;
925
1088
  /** Applies taxes for donations, default true. */
926
1089
  appliesToDonations?: boolean | null;
@@ -936,12 +1099,19 @@ export declare enum TaxType {
936
1099
  export interface Money {
937
1100
  /**
938
1101
  * *Deprecated:** Use `value` instead.
1102
+ * @format DECIMAL_VALUE
939
1103
  * @deprecated
940
1104
  */
941
1105
  amount?: string;
942
- /** ISO 4217 format of the currency e.g., `USD`. */
1106
+ /**
1107
+ * ISO 4217 format of the currency e.g., `USD`.
1108
+ * @format CURRENCY
1109
+ */
943
1110
  currency?: string;
944
- /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative. */
1111
+ /**
1112
+ * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative.
1113
+ * @format DECIMAL_VALUE
1114
+ */
945
1115
  value?: string | null;
946
1116
  }
947
1117
  export interface ExternalEvent {
@@ -1024,7 +1194,10 @@ export interface OnlineConferencingConfig {
1024
1194
  * When enabled, links to join conferencing are generated and provided to guests.
1025
1195
  */
1026
1196
  enabled?: boolean;
1027
- /** Conferencing provider ID. */
1197
+ /**
1198
+ * Conferencing provider ID.
1199
+ * @format GUID
1200
+ */
1028
1201
  providerId?: string | null;
1029
1202
  /** Conference type */
1030
1203
  conferenceType?: ConferenceType;
@@ -1063,7 +1236,10 @@ export interface OnlineConferencingSession {
1063
1236
  sessionId?: string | null;
1064
1237
  }
1065
1238
  export interface SeoSettings {
1066
- /** URL slug */
1239
+ /**
1240
+ * URL slug
1241
+ * @maxLength 130
1242
+ */
1067
1243
  slug?: string;
1068
1244
  /** Advanced SEO data */
1069
1245
  advancedSeoData?: SeoSchema;
@@ -1089,7 +1265,10 @@ export interface Keyword {
1089
1265
  term?: string;
1090
1266
  /** Whether the keyword is the main focus keyword. */
1091
1267
  isMain?: boolean;
1092
- /** The source that added the keyword terms to the SEO settings. */
1268
+ /**
1269
+ * The source that added the keyword terms to the SEO settings.
1270
+ * @maxLength 1000
1271
+ */
1093
1272
  origin?: string | null;
1094
1273
  }
1095
1274
  export interface Tag {
@@ -1122,7 +1301,10 @@ export interface Settings {
1122
1301
  * Default: `false` (Auto Redirect is enabled.)
1123
1302
  */
1124
1303
  preventAutoRedirect?: boolean;
1125
- /** User-selected keyword terms for a specific page. */
1304
+ /**
1305
+ * User-selected keyword terms for a specific page.
1306
+ * @maxSize 5
1307
+ */
1126
1308
  keywords?: Keyword[];
1127
1309
  }
1128
1310
  export interface Agenda {
@@ -1137,10 +1319,15 @@ export interface Agenda {
1137
1319
  export interface Category {
1138
1320
  /**
1139
1321
  * Category ID.
1322
+ * @format GUID
1140
1323
  * @readonly
1141
1324
  */
1142
1325
  _id?: string;
1143
- /** Category name. */
1326
+ /**
1327
+ * Category name.
1328
+ * @minLength 1
1329
+ * @maxLength 30
1330
+ */
1144
1331
  name?: string;
1145
1332
  /**
1146
1333
  * Date and time when category was created.
@@ -1163,6 +1350,7 @@ export interface Category {
1163
1350
  * Default: `MANUAL`.
1164
1351
  *
1165
1352
  * **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
1353
+ * @maxSize 3
1166
1354
  */
1167
1355
  states?: State[];
1168
1356
  }
@@ -1788,11 +1976,20 @@ export interface GIFData {
1788
1976
  gifType?: GIFType;
1789
1977
  }
1790
1978
  export interface GIF {
1791
- /** GIF format URL. */
1979
+ /**
1980
+ * GIF format URL.
1981
+ * @format WEB_URL
1982
+ */
1792
1983
  gif?: string | null;
1793
- /** MP4 format URL. */
1984
+ /**
1985
+ * MP4 format URL.
1986
+ * @format WEB_URL
1987
+ */
1794
1988
  mp4?: string | null;
1795
- /** Thumbnail URL. */
1989
+ /**
1990
+ * Thumbnail URL.
1991
+ * @format WEB_URL
1992
+ */
1796
1993
  still?: string | null;
1797
1994
  }
1798
1995
  export declare enum GIFType {
@@ -2020,13 +2217,22 @@ export declare enum BackgroundType {
2020
2217
  export interface Gradient {
2021
2218
  /** The gradient angle in degrees. */
2022
2219
  angle?: number | null;
2023
- /** The start color as a hexademical value. */
2220
+ /**
2221
+ * The start color as a hexademical value.
2222
+ * @format COLOR_HEX
2223
+ */
2024
2224
  startColor?: string | null;
2025
- /** The end color as a hexademical value. */
2225
+ /**
2226
+ * The end color as a hexademical value.
2227
+ * @format COLOR_HEX
2228
+ */
2026
2229
  lastColor?: string | null;
2027
2230
  }
2028
2231
  export interface Background extends BackgroundBackgroundOneOf {
2029
- /** The background color as a hexademical value. */
2232
+ /**
2233
+ * The background color as a hexademical value.
2234
+ * @format COLOR_HEX
2235
+ */
2030
2236
  color?: string | null;
2031
2237
  /** An image to use for the background. */
2032
2238
  image?: Media;
@@ -2037,7 +2243,10 @@ export interface Background extends BackgroundBackgroundOneOf {
2037
2243
  }
2038
2244
  /** @oneof */
2039
2245
  export interface BackgroundBackgroundOneOf {
2040
- /** The background color as a hexademical value. */
2246
+ /**
2247
+ * The background color as a hexademical value.
2248
+ * @format COLOR_HEX
2249
+ */
2041
2250
  color?: string | null;
2042
2251
  /** An image to use for the background. */
2043
2252
  image?: Media;
@@ -2349,17 +2558,32 @@ export declare enum VerticalAlignment {
2349
2558
  export interface CellStyle {
2350
2559
  /** Vertical alignment for the cell's text. */
2351
2560
  verticalAlignment?: VerticalAlignment;
2352
- /** Cell background color as a hexadecimal value. */
2561
+ /**
2562
+ * Cell background color as a hexadecimal value.
2563
+ * @format COLOR_HEX
2564
+ */
2353
2565
  backgroundColor?: string | null;
2354
2566
  }
2355
2567
  export interface BorderColors {
2356
- /** Left border color as a hexadecimal value. */
2568
+ /**
2569
+ * Left border color as a hexadecimal value.
2570
+ * @format COLOR_HEX
2571
+ */
2357
2572
  left?: string | null;
2358
- /** Right border color as a hexadecimal value. */
2573
+ /**
2574
+ * Right border color as a hexadecimal value.
2575
+ * @format COLOR_HEX
2576
+ */
2359
2577
  right?: string | null;
2360
- /** Top border color as a hexadecimal value. */
2578
+ /**
2579
+ * Top border color as a hexadecimal value.
2580
+ * @format COLOR_HEX
2581
+ */
2361
2582
  top?: string | null;
2362
- /** Bottom border color as a hexadecimal value. */
2583
+ /**
2584
+ * Bottom border color as a hexadecimal value.
2585
+ * @format COLOR_HEX
2586
+ */
2363
2587
  bottom?: string | null;
2364
2588
  }
2365
2589
  /**
@@ -2468,7 +2692,10 @@ export interface TextNodeStyle {
2468
2692
  lineHeight?: string | null;
2469
2693
  }
2470
2694
  export interface DiscardDraftRequest {
2471
- /** Event ID to which the form belongs. */
2695
+ /**
2696
+ * Event ID to which the form belongs.
2697
+ * @format GUID
2698
+ */
2472
2699
  eventId: string;
2473
2700
  }
2474
2701
  export interface DiscardDraftResponse {
@@ -2544,9 +2771,15 @@ export interface ActionEvent {
2544
2771
  body?: string;
2545
2772
  }
2546
2773
  export interface MessageEnvelope {
2547
- /** App instance ID. */
2774
+ /**
2775
+ * App instance ID.
2776
+ * @format GUID
2777
+ */
2548
2778
  instanceId?: string | null;
2549
- /** Event type. */
2779
+ /**
2780
+ * Event type.
2781
+ * @maxLength 150
2782
+ */
2550
2783
  eventType?: string;
2551
2784
  /** The identification type and identity data. */
2552
2785
  identity?: IdentificationData;
@@ -2554,26 +2787,50 @@ export interface MessageEnvelope {
2554
2787
  data?: string;
2555
2788
  }
2556
2789
  export interface IdentificationData extends IdentificationDataIdOneOf {
2557
- /** ID of a site visitor that has not logged in to the site. */
2790
+ /**
2791
+ * ID of a site visitor that has not logged in to the site.
2792
+ * @format GUID
2793
+ */
2558
2794
  anonymousVisitorId?: string;
2559
- /** ID of a site visitor that has logged in to the site. */
2795
+ /**
2796
+ * ID of a site visitor that has logged in to the site.
2797
+ * @format GUID
2798
+ */
2560
2799
  memberId?: string;
2561
- /** ID of a Wix user (site owner, contributor, etc.). */
2800
+ /**
2801
+ * ID of a Wix user (site owner, contributor, etc.).
2802
+ * @format GUID
2803
+ */
2562
2804
  wixUserId?: string;
2563
- /** ID of an app. */
2805
+ /**
2806
+ * ID of an app.
2807
+ * @format GUID
2808
+ */
2564
2809
  appId?: string;
2565
2810
  /** @readonly */
2566
2811
  identityType?: WebhookIdentityType;
2567
2812
  }
2568
2813
  /** @oneof */
2569
2814
  export interface IdentificationDataIdOneOf {
2570
- /** ID of a site visitor that has not logged in to the site. */
2815
+ /**
2816
+ * ID of a site visitor that has not logged in to the site.
2817
+ * @format GUID
2818
+ */
2571
2819
  anonymousVisitorId?: string;
2572
- /** ID of a site visitor that has logged in to the site. */
2820
+ /**
2821
+ * ID of a site visitor that has logged in to the site.
2822
+ * @format GUID
2823
+ */
2573
2824
  memberId?: string;
2574
- /** ID of a Wix user (site owner, contributor, etc.). */
2825
+ /**
2826
+ * ID of a Wix user (site owner, contributor, etc.).
2827
+ * @format GUID
2828
+ */
2575
2829
  wixUserId?: string;
2576
- /** ID of an app. */
2830
+ /**
2831
+ * ID of an app.
2832
+ * @format GUID
2833
+ */
2577
2834
  appId?: string;
2578
2835
  }
2579
2836
  export declare enum WebhookIdentityType {
@@ -2688,9 +2945,15 @@ export interface PublishDraftResponseNonNullableFields {
2688
2945
  form?: FormNonNullableFields;
2689
2946
  }
2690
2947
  export interface BaseEventMetadata {
2691
- /** App instance ID. */
2948
+ /**
2949
+ * App instance ID.
2950
+ * @format GUID
2951
+ */
2692
2952
  instanceId?: string | null;
2693
- /** Event type. */
2953
+ /**
2954
+ * Event type.
2955
+ * @maxLength 150
2956
+ */
2694
2957
  eventType?: string;
2695
2958
  /** The identification type and identity data. */
2696
2959
  identity?: IdentificationData;
@@ -2715,6 +2978,8 @@ export interface FormEventUpdatedEnvelope {
2715
2978
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2716
2979
  * @permissionScope Manage Restaurants - all permissions
2717
2980
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2981
+ * @permissionScope Set Up Automations
2982
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
2718
2983
  * @permissionScope Manage Guest List
2719
2984
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
2720
2985
  * @permissionScope Manage Events
@@ -2749,6 +3014,8 @@ export declare function onFormEventUpdated(handler: (event: FormEventUpdatedEnve
2749
3014
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2750
3015
  * @permissionScope Manage Restaurants - all permissions
2751
3016
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3017
+ * @permissionScope Set Up Automations
3018
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
2752
3019
  * @permissionScope Manage Guest List
2753
3020
  * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
2754
3021
  * @permissionScope Manage Events
@@ -2778,7 +3045,26 @@ export declare function getForm(eventId: string): Promise<Form & FormNonNullable
2778
3045
  * @fqn wix.events.form.FormBuilder.AddControl
2779
3046
  */
2780
3047
  export declare function addControl(eventId: string, options?: AddControlOptions): Promise<AddControlResponse & AddControlResponseNonNullableFields>;
2781
- export interface AddControlOptions extends AddControlRequestControlOneOf {
3048
+ export interface AddControlOptions extends AddControlOptionsControlOneOf {
3049
+ /** Phone number input control. */
3050
+ phone?: PhoneControl;
3051
+ /** Single-line or full address input control. */
3052
+ address?: AddressControl;
3053
+ /** Day, month, year date input control. */
3054
+ date?: DateControl;
3055
+ /** Additional guests input control. */
3056
+ additionalGuests?: AdditionalGuestsControl;
3057
+ /** Single-choice dropdown style input control. */
3058
+ dropdown?: DropdownControl;
3059
+ /** Multiple-choice checkbox style input control. */
3060
+ checkbox?: CheckboxControl;
3061
+ /** Free-form text input control. */
3062
+ text?: TextControl;
3063
+ /** Single-choice radio button style input control. */
3064
+ radioButton?: RadioButtonControl;
3065
+ }
3066
+ /** @oneof */
3067
+ interface AddControlOptionsControlOneOf {
2782
3068
  /** Phone number input control. */
2783
3069
  phone?: PhoneControl;
2784
3070
  /** Single-line or full address input control. */
@@ -2816,13 +3102,39 @@ export interface AddControlOptions extends AddControlRequestControlOneOf {
2816
3102
  * @fqn wix.events.form.FormBuilder.UpdateControl
2817
3103
  */
2818
3104
  export declare function updateControl(identifiers: UpdateControlIdentifiers, options?: UpdateControlOptions): Promise<UpdateControlResponse & UpdateControlResponseNonNullableFields>;
2819
- export interface UpdateControlIdentifiers extends UpdateControlRequestControlOneOf {
2820
- /** Event ID to which the form belongs. */
3105
+ export interface UpdateControlIdentifiers extends UpdateControlIdentifiersControlOneOf {
3106
+ /**
3107
+ * Event ID to which the form belongs.
3108
+ * @format GUID
3109
+ */
2821
3110
  eventId: string;
2822
3111
  /** Unique input control ID. */
2823
3112
  _id: string;
2824
3113
  }
2825
- export interface UpdateControlOptions extends UpdateControlRequestControlOneOf {
3114
+ /** @oneof */
3115
+ interface UpdateControlIdentifiersControlOneOf {
3116
+ /** Phone number input control. */
3117
+ phone?: PhoneControl;
3118
+ /** Single-line or full address input control. */
3119
+ address?: AddressControl;
3120
+ /** Day, month, year date input control. */
3121
+ date?: DateControl;
3122
+ /** Additional guests input control. */
3123
+ additionalGuests?: AdditionalGuestsControl;
3124
+ /** Single-choice dropdown style input control. */
3125
+ dropdown?: DropdownControl;
3126
+ /** Multiple-choice checkbox style input control. */
3127
+ checkbox?: CheckboxControl;
3128
+ /** Free-form text input control. */
3129
+ text?: TextControl;
3130
+ /** Main guest name input control. */
3131
+ name?: NameControl;
3132
+ /** Main guest email input control. */
3133
+ email?: EmailControl;
3134
+ /** Single-choice radio style input control. */
3135
+ radioButton?: RadioButtonControl;
3136
+ }
3137
+ export interface UpdateControlOptions extends UpdateControlOptionsControlOneOf {
2826
3138
  /** Index used to sort input controls in ascending order. */
2827
3139
  orderIndex?: number;
2828
3140
  /** Phone number input control. */
@@ -2846,6 +3158,29 @@ export interface UpdateControlOptions extends UpdateControlRequestControlOneOf {
2846
3158
  /** Single-choice radio style input control. */
2847
3159
  radioButton?: RadioButtonControl;
2848
3160
  }
3161
+ /** @oneof */
3162
+ interface UpdateControlOptionsControlOneOf {
3163
+ /** Phone number input control. */
3164
+ phone?: PhoneControl;
3165
+ /** Single-line or full address input control. */
3166
+ address?: AddressControl;
3167
+ /** Day, month, year date input control. */
3168
+ date?: DateControl;
3169
+ /** Additional guests input control. */
3170
+ additionalGuests?: AdditionalGuestsControl;
3171
+ /** Single-choice dropdown style input control. */
3172
+ dropdown?: DropdownControl;
3173
+ /** Multiple-choice checkbox style input control. */
3174
+ checkbox?: CheckboxControl;
3175
+ /** Free-form text input control. */
3176
+ text?: TextControl;
3177
+ /** Main guest name input control. */
3178
+ name?: NameControl;
3179
+ /** Main guest email input control. */
3180
+ email?: EmailControl;
3181
+ /** Single-choice radio style input control. */
3182
+ radioButton?: RadioButtonControl;
3183
+ }
2849
3184
  /**
2850
3185
  * Deletes an input control from the draft form.
2851
3186
  * @public
@@ -2865,9 +3200,15 @@ export interface UpdateControlOptions extends UpdateControlRequestControlOneOf {
2865
3200
  */
2866
3201
  export declare function deleteControl(identifiers: DeleteControlIdentifiers): Promise<DeleteControlResponse & DeleteControlResponseNonNullableFields>;
2867
3202
  export interface DeleteControlIdentifiers {
2868
- /** Event ID to which the form belongs. */
3203
+ /**
3204
+ * Event ID to which the form belongs.
3205
+ * @format GUID
3206
+ */
2869
3207
  eventId: string;
2870
- /** Unique input control ID. */
3208
+ /**
3209
+ * Unique input control ID.
3210
+ * @maxLength 100
3211
+ */
2871
3212
  _id: string;
2872
3213
  }
2873
3214
  /**