@wix/auto_sdk_events_forms 1.0.35 → 1.0.37

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.
@@ -1,3 +1,5 @@
1
+ import { NonNullablePaths } from '@wix/sdk-types';
2
+
1
3
  /**
2
4
  * The form defines which elements are displayed to a site visitor during the registration process (RSVP or checkout).
3
5
  * It also contains customizable messages and labels.
@@ -287,6 +289,8 @@ declare enum RequestedFields {
287
289
  /** Include soft deleted input controls in the response. */
288
290
  DELETED = "DELETED"
289
291
  }
292
+ /** @enumType */
293
+ type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'DELETED';
290
294
  interface GetFormResponse {
291
295
  /**
292
296
  * Currently published event form.
@@ -779,6 +783,8 @@ declare enum SubdivisionType {
779
783
  /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
780
784
  COUNTRY = "COUNTRY"
781
785
  }
786
+ /** @enumType */
787
+ type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
782
788
  interface ScheduleConfig {
783
789
  /**
784
790
  * Defines event as TBD (To Be Determined) schedule.
@@ -1117,7 +1123,7 @@ interface Money {
1117
1123
  */
1118
1124
  amount?: string;
1119
1125
  /**
1120
- * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
1126
+ * 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `USD`.
1121
1127
  * @format CURRENCY
1122
1128
  */
1123
1129
  currency?: string;
@@ -1824,7 +1830,7 @@ interface DividerData {
1824
1830
  /** Divider width. */
1825
1831
  width?: WidthWithLiterals;
1826
1832
  /** Divider alignment. */
1827
- alignment?: AlignmentWithLiterals;
1833
+ alignment?: DividerDataAlignmentWithLiterals;
1828
1834
  }
1829
1835
  declare enum LineStyle {
1830
1836
  /** Single Line */
@@ -1848,7 +1854,7 @@ declare enum Width {
1848
1854
  }
1849
1855
  /** @enumType */
1850
1856
  type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
1851
- declare enum Alignment {
1857
+ declare enum DividerDataAlignment {
1852
1858
  /** Center alignment */
1853
1859
  CENTER = "CENTER",
1854
1860
  /** Left alignment */
@@ -1857,7 +1863,7 @@ declare enum Alignment {
1857
1863
  RIGHT = "RIGHT"
1858
1864
  }
1859
1865
  /** @enumType */
1860
- type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
1866
+ type DividerDataAlignmentWithLiterals = DividerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
1861
1867
  interface FileData {
1862
1868
  /** Styling for the file's container. */
1863
1869
  containerData?: PluginContainerData;
@@ -1982,7 +1988,7 @@ interface ItemDataOneOf {
1982
1988
  }
1983
1989
  interface GalleryOptions {
1984
1990
  /** Gallery layout. */
1985
- layout?: Layout;
1991
+ layout?: GalleryOptionsLayout;
1986
1992
  /** Styling for gallery items. */
1987
1993
  item?: ItemStyle;
1988
1994
  /** Styling for gallery thumbnail images. */
@@ -2042,7 +2048,7 @@ declare enum ThumbnailsAlignment {
2042
2048
  }
2043
2049
  /** @enumType */
2044
2050
  type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
2045
- interface Layout {
2051
+ interface GalleryOptionsLayout {
2046
2052
  /** Gallery layout type. */
2047
2053
  type?: LayoutTypeWithLiterals;
2048
2054
  /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
@@ -2204,7 +2210,7 @@ interface LinkPreviewData {
2204
2210
  /** Styling for the link preview. */
2205
2211
  styles?: LinkPreviewDataStyles;
2206
2212
  }
2207
- declare enum Position {
2213
+ declare enum StylesPosition {
2208
2214
  /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
2209
2215
  START = "START",
2210
2216
  /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
@@ -2215,7 +2221,7 @@ declare enum Position {
2215
2221
  HIDDEN = "HIDDEN"
2216
2222
  }
2217
2223
  /** @enumType */
2218
- type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
2224
+ type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HIDDEN';
2219
2225
  interface LinkPreviewDataStyles {
2220
2226
  /**
2221
2227
  * Background color as a hexadecimal value.
@@ -2247,7 +2253,7 @@ interface LinkPreviewDataStyles {
2247
2253
  */
2248
2254
  borderColor?: string | null;
2249
2255
  /** Position of thumbnail. Defaults to `START`. */
2250
- thumbnailPosition?: PositionWithLiterals;
2256
+ thumbnailPosition?: StylesPositionWithLiterals;
2251
2257
  }
2252
2258
  interface MapData {
2253
2259
  /** Styling for the map's container. */
@@ -2601,6 +2607,32 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
2601
2607
  url?: string | null;
2602
2608
  /** An image for the embedded content. */
2603
2609
  image?: Media;
2610
+ /** Whether to hide the image. */
2611
+ hideImage?: boolean | null;
2612
+ /** Whether to hide the title. */
2613
+ hideTitle?: boolean | null;
2614
+ /** Whether to hide the price. */
2615
+ hidePrice?: boolean | null;
2616
+ /** Whether to hide the description (Event and Booking). */
2617
+ hideDescription?: boolean | null;
2618
+ /** Whether to hide the date and time (Event). */
2619
+ hideDateTime?: boolean | null;
2620
+ /** Whether to hide the location (Event). */
2621
+ hideLocation?: boolean | null;
2622
+ /** Whether to hide the duration (Booking). */
2623
+ hideDuration?: boolean | null;
2624
+ /** Whether to hide the button. */
2625
+ hideButton?: boolean | null;
2626
+ /** Whether to hide the ribbon. */
2627
+ hideRibbon?: boolean | null;
2628
+ /** Button styling options. */
2629
+ buttonStyles?: ButtonStyles;
2630
+ /** Image styling options. */
2631
+ imageStyles?: ImageStyles;
2632
+ /** Ribbon styling options. */
2633
+ ribbonStyles?: RibbonStyles;
2634
+ /** Card styling options. */
2635
+ cardStyles?: CardStyles;
2604
2636
  }
2605
2637
  /** @oneof */
2606
2638
  interface AppEmbedDataAppDataOneOf {
@@ -2609,6 +2641,66 @@ interface AppEmbedDataAppDataOneOf {
2609
2641
  /** Data for embedded Wix Events content. */
2610
2642
  eventData?: EventData;
2611
2643
  }
2644
+ declare enum Position {
2645
+ /** Image positioned at the start (left in LTR layouts, right in RTL layouts) */
2646
+ START = "START",
2647
+ /** Image positioned at the end (right in LTR layouts, left in RTL layouts) */
2648
+ END = "END",
2649
+ /** Image positioned at the top */
2650
+ TOP = "TOP"
2651
+ }
2652
+ /** @enumType */
2653
+ type PositionWithLiterals = Position | 'START' | 'END' | 'TOP';
2654
+ declare enum AspectRatio {
2655
+ /** 1:1 aspect ratio */
2656
+ SQUARE = "SQUARE",
2657
+ /** 16:9 aspect ratio */
2658
+ RECTANGLE = "RECTANGLE"
2659
+ }
2660
+ /** @enumType */
2661
+ type AspectRatioWithLiterals = AspectRatio | 'SQUARE' | 'RECTANGLE';
2662
+ declare enum Resizing {
2663
+ /** Fill the container, may crop the image */
2664
+ FILL = "FILL",
2665
+ /** Fit the image within the container */
2666
+ FIT = "FIT"
2667
+ }
2668
+ /** @enumType */
2669
+ type ResizingWithLiterals = Resizing | 'FILL' | 'FIT';
2670
+ declare enum Placement {
2671
+ /** Ribbon placed on the image */
2672
+ IMAGE = "IMAGE",
2673
+ /** Ribbon placed on the product information */
2674
+ PRODUCT_INFO = "PRODUCT_INFO"
2675
+ }
2676
+ /** @enumType */
2677
+ type PlacementWithLiterals = Placement | 'IMAGE' | 'PRODUCT_INFO';
2678
+ declare enum CardStylesType {
2679
+ /** Card with visible border and background */
2680
+ CONTAINED = "CONTAINED",
2681
+ /** Card without visible border */
2682
+ FRAMELESS = "FRAMELESS"
2683
+ }
2684
+ /** @enumType */
2685
+ type CardStylesTypeWithLiterals = CardStylesType | 'CONTAINED' | 'FRAMELESS';
2686
+ declare enum Alignment {
2687
+ /** Content aligned to start (left in LTR layouts, right in RTL layouts) */
2688
+ START = "START",
2689
+ /** Content centered */
2690
+ CENTER = "CENTER",
2691
+ /** Content aligned to end (right in LTR layouts, left in RTL layouts) */
2692
+ END = "END"
2693
+ }
2694
+ /** @enumType */
2695
+ type AlignmentWithLiterals = Alignment | 'START' | 'CENTER' | 'END';
2696
+ declare enum Layout {
2697
+ /** Elements stacked vertically */
2698
+ STACKED = "STACKED",
2699
+ /** Elements arranged horizontally */
2700
+ SIDE_BY_SIDE = "SIDE_BY_SIDE"
2701
+ }
2702
+ /** @enumType */
2703
+ type LayoutWithLiterals = Layout | 'STACKED' | 'SIDE_BY_SIDE';
2612
2704
  declare enum AppType {
2613
2705
  PRODUCT = "PRODUCT",
2614
2706
  EVENT = "EVENT",
@@ -2626,6 +2718,122 @@ interface EventData {
2626
2718
  /** Event location. */
2627
2719
  location?: string | null;
2628
2720
  }
2721
+ interface ButtonStyles {
2722
+ /** Text to display on the button. */
2723
+ buttonText?: string | null;
2724
+ /** Border width in pixels. */
2725
+ borderWidth?: number | null;
2726
+ /** Border radius in pixels. */
2727
+ borderRadius?: number | null;
2728
+ /**
2729
+ * Border color as a hexadecimal value.
2730
+ * @format COLOR_HEX
2731
+ */
2732
+ borderColor?: string | null;
2733
+ /**
2734
+ * Text color as a hexadecimal value.
2735
+ * @format COLOR_HEX
2736
+ */
2737
+ textColor?: string | null;
2738
+ /**
2739
+ * Background color as a hexadecimal value.
2740
+ * @format COLOR_HEX
2741
+ */
2742
+ backgroundColor?: string | null;
2743
+ /**
2744
+ * Border color as a hexadecimal value (hover state).
2745
+ * @format COLOR_HEX
2746
+ */
2747
+ borderColorHover?: string | null;
2748
+ /**
2749
+ * Text color as a hexadecimal value (hover state).
2750
+ * @format COLOR_HEX
2751
+ */
2752
+ textColorHover?: string | null;
2753
+ /**
2754
+ * Background color as a hexadecimal value (hover state).
2755
+ * @format COLOR_HEX
2756
+ */
2757
+ backgroundColorHover?: string | null;
2758
+ /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
2759
+ buttonSize?: string | null;
2760
+ }
2761
+ interface ImageStyles {
2762
+ /** Whether to hide the image. */
2763
+ hideImage?: boolean | null;
2764
+ /** Position of image. Defaults to `START`. */
2765
+ imagePosition?: PositionWithLiterals;
2766
+ /** Aspect ratio for the image. Defaults to `SQUARE`. */
2767
+ aspectRatio?: AspectRatioWithLiterals;
2768
+ /** How the image should be resized. Defaults to `FILL`. */
2769
+ resizing?: ResizingWithLiterals;
2770
+ /**
2771
+ * Image border color as a hexadecimal value.
2772
+ * @format COLOR_HEX
2773
+ */
2774
+ borderColor?: string | null;
2775
+ /** Image border width in pixels. */
2776
+ borderWidth?: number | null;
2777
+ /** Image border radius in pixels. */
2778
+ borderRadius?: number | null;
2779
+ }
2780
+ interface RibbonStyles {
2781
+ /** Text to display on the ribbon. */
2782
+ ribbonText?: string | null;
2783
+ /**
2784
+ * Ribbon background color as a hexadecimal value.
2785
+ * @format COLOR_HEX
2786
+ */
2787
+ backgroundColor?: string | null;
2788
+ /**
2789
+ * Ribbon text color as a hexadecimal value.
2790
+ * @format COLOR_HEX
2791
+ */
2792
+ textColor?: string | null;
2793
+ /**
2794
+ * Ribbon border color as a hexadecimal value.
2795
+ * @format COLOR_HEX
2796
+ */
2797
+ borderColor?: string | null;
2798
+ /** Ribbon border width in pixels. */
2799
+ borderWidth?: number | null;
2800
+ /** Ribbon border radius in pixels. */
2801
+ borderRadius?: number | null;
2802
+ /** Placement of the ribbon. Defaults to `IMAGE`. */
2803
+ ribbonPlacement?: PlacementWithLiterals;
2804
+ }
2805
+ interface CardStyles {
2806
+ /**
2807
+ * Card background color as a hexadecimal value.
2808
+ * @format COLOR_HEX
2809
+ */
2810
+ backgroundColor?: string | null;
2811
+ /**
2812
+ * Card border color as a hexadecimal value.
2813
+ * @format COLOR_HEX
2814
+ */
2815
+ borderColor?: string | null;
2816
+ /** Card border width in pixels. */
2817
+ borderWidth?: number | null;
2818
+ /** Card border radius in pixels. */
2819
+ borderRadius?: number | null;
2820
+ /** Card type. Defaults to `CONTAINED`. */
2821
+ type?: CardStylesTypeWithLiterals;
2822
+ /** Content alignment. Defaults to `START`. */
2823
+ alignment?: AlignmentWithLiterals;
2824
+ /** Layout for title and price. Defaults to `STACKED`. */
2825
+ titlePriceLayout?: LayoutWithLiterals;
2826
+ /**
2827
+ * Title text color as a hexadecimal value.
2828
+ * @format COLOR_HEX
2829
+ */
2830
+ titleColor?: string | null;
2831
+ /**
2832
+ * Text color as a hexadecimal value.
2833
+ * @format COLOR_HEX
2834
+ */
2835
+ textColor?: string | null;
2836
+ }
2629
2837
  interface VideoData {
2630
2838
  /** Styling for the video's container. */
2631
2839
  containerData?: PluginContainerData;
@@ -2798,6 +3006,8 @@ declare enum NullValue {
2798
3006
  /** Null value. */
2799
3007
  NULL_VALUE = "NULL_VALUE"
2800
3008
  }
3009
+ /** @enumType */
3010
+ type NullValueWithLiterals = NullValue | 'NULL_VALUE';
2801
3011
  /**
2802
3012
  * `ListValue` is a wrapper around a repeated field of values.
2803
3013
  *
@@ -3057,6 +3267,25 @@ declare enum WebhookIdentityType {
3057
3267
  }
3058
3268
  /** @enumType */
3059
3269
  type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3270
+ type AddControlApplicationErrors = {
3271
+ code?: 'INVALID_EVENT_CONFIGURATION';
3272
+ description?: string;
3273
+ data?: Record<string, any>;
3274
+ };
3275
+ type UpdateControlApplicationErrors = {
3276
+ code?: 'INVALID_EVENT_CONFIGURATION';
3277
+ description?: string;
3278
+ data?: Record<string, any>;
3279
+ } | {
3280
+ code?: 'CONTROL_NOT_FOUND';
3281
+ description?: string;
3282
+ data?: Record<string, any>;
3283
+ };
3284
+ type DeleteControlApplicationErrors = {
3285
+ code?: 'CONTROL_NOT_FOUND';
3286
+ description?: string;
3287
+ data?: Record<string, any>;
3288
+ };
3060
3289
  interface BaseEventMetadata {
3061
3290
  /**
3062
3291
  * App instance ID.
@@ -3075,6 +3304,77 @@ interface FormEventUpdatedEnvelope {
3075
3304
  data: EventUpdated;
3076
3305
  metadata: BaseEventMetadata;
3077
3306
  }
3307
+ /**
3308
+ * Triggered when a form is updated or published.
3309
+ * @permissionScope Manage Stores
3310
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
3311
+ * @permissionScope Read Events - all read permissions
3312
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
3313
+ * @permissionScope Manage Bookings Services and Settings
3314
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
3315
+ * @permissionScope Manage Events - all permissions
3316
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
3317
+ * @permissionScope Manage Events
3318
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
3319
+ * @permissionScope Read Events
3320
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-EVENTS
3321
+ * @permissionScope Manage Challenges
3322
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
3323
+ * @permissionScope Manage Portfolio
3324
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
3325
+ * @permissionScope Manage Blog
3326
+ * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
3327
+ * @permissionScope Access Verticals by Automations
3328
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
3329
+ * @permissionScope Manage Restaurants - all permissions
3330
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3331
+ * @permissionScope Set Up Automations
3332
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
3333
+ * @permissionScope Manage Guest List
3334
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
3335
+ * @permissionScope Manage Events
3336
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-EVENTS
3337
+ * @permissionId WIX_EVENTS.READ_EVENTS
3338
+ * @webhook
3339
+ * @eventType wix.events.events.EventUpdated
3340
+ * @serviceIdentifier wix.events.form.FormBuilder
3341
+ * @slug event_updated
3342
+ */
3343
+ declare function onFormEventUpdated(handler: (event: FormEventUpdatedEnvelope) => void | Promise<void>): void;
3344
+ type FormNonNullablePaths = `controls` | `controls.${number}.type` | `controls.${number}.system` | `controls.${number}.name` | `controls.${number}.label` | `controls.${number}.orderIndex` | `controls.${number}._id` | `messages.rsvp.rsvpYesOption` | `messages.rsvp.rsvpNoOption` | `messages.rsvp.positiveMessages.title` | `messages.rsvp.positiveMessages.confirmation.title` | `messages.rsvp.positiveMessages.confirmation.message` | `messages.rsvp.positiveMessages.confirmation.addToCalendarActionLabel` | `messages.rsvp.positiveMessages.confirmation.shareActionLabel` | `messages.rsvp.negativeMessages.title` | `messages.rsvp.negativeMessages.confirmation.title` | `messages.rsvp.negativeMessages.confirmation.shareActionLabel` | `messages.rsvp.submitActionLabel` | `messages.checkout.title` | `messages.checkout.submitActionLabel` | `messages.checkout.confirmation.title` | `messages.checkout.confirmation.message` | `messages.checkout.confirmation.downloadTicketsLabel` | `messages.checkout.confirmation.addToCalendarLabel` | `messages.checkout.confirmation.shareEventLabel` | `messages.registrationClosed.message` | `messages.registrationClosed.exploreEventsActionLabel` | `messages.ticketsUnavailable.message` | `messages.ticketsUnavailable.exploreEventsActionLabel`;
3345
+ /**
3346
+ * Retrieves an event registration form.
3347
+ *
3348
+ * Retrieves both the draft and published versions.
3349
+ * @param eventId - Event ID to which the form belongs.
3350
+ * @public
3351
+ * @requiredField eventId
3352
+ * @param options - Optional fields.
3353
+ * @permissionId WIX_EVENTS.READ_EVENTS
3354
+ * @applicableIdentity APP
3355
+ * @applicableIdentity VISITOR
3356
+ * @returns Currently published event form.
3357
+ * Published form is visible to site visitors.
3358
+ * @fqn wix.events.form.FormBuilder.GetForm
3359
+ */
3360
+ declare function getForm(eventId: string): Promise<NonNullablePaths<Form, FormNonNullablePaths>>;
3361
+ /**
3362
+ * Adds an input control to the draft form.
3363
+ * @param eventId - Event ID to which the form belongs.
3364
+ * @public
3365
+ * @requiredField eventId
3366
+ * @requiredField options
3367
+ * @requiredField options.control
3368
+ * @param options - Optional fields.
3369
+ * @permissionId WIX_EVENTS.MANAGE_EVENTS
3370
+ * @applicableIdentity APP
3371
+ * @fqn wix.events.form.FormBuilder.AddControl
3372
+ */
3373
+ declare function addControl(eventId: string, options: AddControlOptions): Promise<NonNullablePaths<AddControlResponse, `_id` | {
3374
+ [P in FormNonNullablePaths]: `form.${P}`;
3375
+ }[FormNonNullablePaths]> & {
3376
+ __applicationErrorsType?: AddControlApplicationErrors;
3377
+ }>;
3078
3378
  interface AddControlOptions extends AddControlOptionsControlOneOf {
3079
3379
  /** Phone number input control. */
3080
3380
  phone?: PhoneControl;
@@ -3112,6 +3412,24 @@ interface AddControlOptionsControlOneOf {
3112
3412
  /** Single-choice radio button style input control. */
3113
3413
  radioButton?: RadioButtonControl;
3114
3414
  }
3415
+ /**
3416
+ * Updates an existing input control in the draft form.
3417
+ * @public
3418
+ * @requiredField identifiers
3419
+ * @requiredField identifiers._id
3420
+ * @requiredField identifiers.eventId
3421
+ * @requiredField options.control
3422
+ * @param options - Optional fields.
3423
+ * @param identifiers - Identifies what form to update.
3424
+ * @permissionId WIX_EVENTS.MANAGE_EVENTS
3425
+ * @applicableIdentity APP
3426
+ * @fqn wix.events.form.FormBuilder.UpdateControl
3427
+ */
3428
+ declare function updateControl(identifiers: NonNullablePaths<UpdateControlIdentifiers, `_id` | `eventId`>, options?: UpdateControlOptions): Promise<NonNullablePaths<UpdateControlResponse, {
3429
+ [P in FormNonNullablePaths]: `form.${P}`;
3430
+ }[FormNonNullablePaths]> & {
3431
+ __applicationErrorsType?: UpdateControlApplicationErrors;
3432
+ }>;
3115
3433
  interface UpdateControlIdentifiers extends UpdateControlIdentifiersControlOneOf {
3116
3434
  /**
3117
3435
  * Event ID to which the form belongs.
@@ -3191,6 +3509,22 @@ interface UpdateControlOptionsControlOneOf {
3191
3509
  /** Single-choice radio style input control. */
3192
3510
  radioButton?: RadioButtonControl;
3193
3511
  }
3512
+ /**
3513
+ * Deletes an input control from the draft form.
3514
+ * @public
3515
+ * @requiredField identifiers
3516
+ * @requiredField identifiers._id
3517
+ * @requiredField identifiers.eventId
3518
+ * @param identifiers - Identifies what form to delete.
3519
+ * @permissionId WIX_EVENTS.MANAGE_EVENTS
3520
+ * @applicableIdentity APP
3521
+ * @fqn wix.events.form.FormBuilder.DeleteControl
3522
+ */
3523
+ declare function deleteControl(identifiers: NonNullablePaths<DeleteControlIdentifiers, `_id` | `eventId`>): Promise<NonNullablePaths<DeleteControlResponse, {
3524
+ [P in FormNonNullablePaths]: `form.${P}`;
3525
+ }[FormNonNullablePaths]> & {
3526
+ __applicationErrorsType?: DeleteControlApplicationErrors;
3527
+ }>;
3194
3528
  interface DeleteControlIdentifiers {
3195
3529
  /**
3196
3530
  * Event ID to which the form belongs.
@@ -3203,6 +3537,20 @@ interface DeleteControlIdentifiers {
3203
3537
  */
3204
3538
  _id: string;
3205
3539
  }
3540
+ /**
3541
+ * Updates a set of defined form messages that are displayed to a site visitor before, during, and after the registration flow.
3542
+ * Includes the configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
3543
+ * @param eventId - Event ID to which the form belongs.
3544
+ * @public
3545
+ * @requiredField eventId
3546
+ * @param options - Optional fields.
3547
+ * @permissionId WIX_EVENTS.MANAGE_EVENTS
3548
+ * @applicableIdentity APP
3549
+ * @fqn wix.events.form.FormBuilder.UpdateMessages
3550
+ */
3551
+ declare function updateMessages(eventId: string, options?: UpdateMessagesOptions): Promise<NonNullablePaths<UpdateMessagesResponse, {
3552
+ [P in FormNonNullablePaths]: `form.${P}`;
3553
+ }[FormNonNullablePaths]>>;
3206
3554
  interface UpdateMessagesOptions {
3207
3555
  /**
3208
3556
  * Set of field paths, specifying which parts of this resource to update.
@@ -3213,5 +3561,27 @@ interface UpdateMessagesOptions {
3213
3561
  /** Set of configured form messages to update. */
3214
3562
  messages?: FormMessages;
3215
3563
  }
3564
+ /**
3565
+ * Publishes the draft form.
3566
+ * @param eventId - Event ID to which the form belongs.
3567
+ * @public
3568
+ * @requiredField eventId
3569
+ * @permissionId WIX_EVENTS.MANAGE_EVENTS
3570
+ * @applicableIdentity APP
3571
+ * @fqn wix.events.form.FormBuilder.PublishDraft
3572
+ */
3573
+ declare function publishDraft(eventId: string): Promise<NonNullablePaths<PublishDraftResponse, {
3574
+ [P in FormNonNullablePaths]: `form.${P}`;
3575
+ }[FormNonNullablePaths]>>;
3576
+ /**
3577
+ * Clears all changes to the draft form.
3578
+ * @param eventId - Event ID to which the form belongs.
3579
+ * @public
3580
+ * @requiredField eventId
3581
+ * @permissionId WIX_EVENTS.MANAGE_EVENTS
3582
+ * @applicableIdentity APP
3583
+ * @fqn wix.events.form.FormBuilder.DiscardDraft
3584
+ */
3585
+ declare function discardDraft(eventId: string): Promise<void>;
3216
3586
 
3217
- export { Direction as $, type AddControlOptions as A, ButtonDataType as B, ConferenceType as C, type DeleteControlIdentifiers as D, EventStatus as E, type Form as F, GIFType as G, VoteRole as H, InputControlType as I, PollLayoutType as J, PollLayoutDirection as K, LocationType as L, MapType as M, NodeType as N, Orientation as O, type PublishDraftResponse as P, BackgroundType as Q, RequestedFields as R, SubdivisionType as S, TaxType as T, type UpdateControlIdentifiers as U, ValueType as V, WidthType as W, DecorationType as X, FontType as Y, AppType as Z, InitialExpandedItems as _, type AddControlResponse as a, type Money as a$, VerticalAlignment as a0, NullValue as a1, Type as a2, WebhookIdentityType as a3, type InputControl as a4, type Input as a5, type OptionSelection as a6, type OptionSelectionSelectedOptionOneOf as a7, type Label as a8, type FormMessages as a9, type UpdateControlRequest as aA, type UpdateControlRequestControlOneOf as aB, type NameControl as aC, type NameControlLabels as aD, type EmailControl as aE, type DeleteControlRequest as aF, type UpdateMessagesRequest as aG, type PublishDraftRequest as aH, type EventUpdated as aI, type Location as aJ, type MapCoordinates as aK, type Address as aL, type AddressStreetOneOf as aM, type StreetAddress as aN, type AddressLocation as aO, type Subdivision as aP, type ScheduleConfig as aQ, type Recurrences as aR, type Occurrence as aS, type Event as aT, type Scheduling as aU, type Registration as aV, type RsvpCollection as aW, type RsvpCollectionConfig as aX, type Ticketing as aY, type TicketingConfig as aZ, type TaxConfig as a_, type RsvpFormMessages as aa, type PositiveResponseConfirmation as ab, type NegativeResponseConfirmation as ac, type Positive as ad, type Negative as ae, type CheckoutFormMessages as af, type ResponseConfirmation as ag, type RegistrationClosedMessages as ah, type TicketsUnavailableMessages as ai, type FormInputControlAdded as aj, type FormInputControlUpdated as ak, type FormInputControlDeleted as al, type GetFormRequest as am, type GetFormResponse as an, type AddControlRequest as ao, type AddControlRequestControlOneOf as ap, type PhoneControl as aq, type AddressControl as ar, type AddressControlLabels as as, type DateControl as at, type AdditionalGuestsControl as au, type Labels as av, type DropdownControl as aw, type RadioButtonControl as ax, type CheckboxControl as ay, type TextControl as az, type UpdateControlOptions as b, type LinkPreviewDataStyles as b$, type ExternalEvent as b0, type CalendarLinks as b1, type SiteUrl as b2, type Dashboard as b3, type RsvpSummary as b4, type TicketingSummary as b5, type GuestListConfig as b6, type Feed as b7, type OnlineConferencing as b8, type OnlineConferencingConfig as b9, type Rel as bA, type CodeBlockData as bB, type TextStyle as bC, type DividerData as bD, type FileData as bE, type FileSource as bF, type FileSourceDataOneOf as bG, type PDFSettings as bH, type GalleryData as bI, type Media as bJ, type Image as bK, type Video as bL, type Item as bM, type ItemDataOneOf as bN, type GalleryOptions as bO, type Layout as bP, type ItemStyle as bQ, type Thumbnails as bR, type GIFData as bS, type GIF as bT, type HeadingData as bU, type HTMLData as bV, type HTMLDataDataOneOf as bW, type ImageData as bX, type StylesBorder as bY, type ImageDataStyles as bZ, type LinkPreviewData as b_, type OnlineConferencingSession as ba, type SeoSettings as bb, type SeoSchema as bc, type Keyword as bd, type Tag as be, type Settings as bf, type Agenda as bg, type Category as bh, type CategoryCounts as bi, type EventDisplaySettings as bj, type LabellingSettings as bk, type RichContent as bl, type Node as bm, type NodeDataOneOf as bn, type NodeStyle as bo, type ButtonData as bp, type Border as bq, type Colors as br, type PluginContainerData as bs, type PluginContainerDataWidth as bt, type PluginContainerDataWidthDataOneOf as bu, type Spoiler as bv, type Height as bw, type Styles as bx, type Link as by, type LinkDataOneOf as bz, type UpdateControlResponse as c, type BaseEventMetadata as c$, type MapData as c0, type MapSettings as c1, type ParagraphData as c2, type PollData as c3, type Permissions as c4, type Option as c5, type PollSettings as c6, type PollLayout as c7, type OptionLayout as c8, type Gradient as c9, type Dimensions as cA, type TableCellData as cB, type CellStyle as cC, type BorderColors as cD, type ListValue as cE, type AudioData as cF, type OrderedListData as cG, type BulletedListData as cH, type BlockquoteData as cI, type CaptionData as cJ, type LayoutCellData as cK, type Metadata as cL, type DocumentStyle as cM, type TextNodeStyle as cN, type Badge as cO, type DiscardDraftRequest as cP, type DiscardDraftResponse as cQ, type DomainEvent as cR, type DomainEventBodyOneOf as cS, type EntityCreatedEvent as cT, type RestoreInfo as cU, type EntityUpdatedEvent as cV, type EntityDeletedEvent as cW, type ActionEvent as cX, type MessageEnvelope as cY, type IdentificationData as cZ, type IdentificationDataIdOneOf as c_, type Background as ca, type BackgroundBackgroundOneOf as cb, type PollDesign as cc, type OptionDesign as cd, type Poll as ce, type PollDataLayout as cf, type Design as cg, type TextData as ch, type Decoration as ci, type DecorationDataOneOf as cj, type AnchorData as ck, type ColorData as cl, type LinkData as cm, type MentionData as cn, type FontSizeData as co, type SpoilerData as cp, type AppEmbedData as cq, type AppEmbedDataAppDataOneOf as cr, type BookingData as cs, type EventData as ct, type VideoData as cu, type PlaybackOptions as cv, type EmbedData as cw, type Oembed as cx, type CollapsibleListData as cy, type TableData as cz, type DeleteControlResponse as d, type AddControlOptionsControlOneOf as d0, type UpdateControlIdentifiersControlOneOf as d1, type UpdateControlOptionsControlOneOf as d2, type UpdateMessagesOptions as e, type UpdateMessagesResponse as f, type FormEventUpdatedEnvelope as g, Status as h, EventType as i, RegistrationStatus as j, RsvpStatusOptions as k, VisitorType as l, State as m, PluginContainerDataAlignment as n, Target as o, TextAlignment as p, LineStyle as q, Width as r, Alignment as s, ViewMode as t, LayoutType as u, Crop as v, ThumbnailsAlignment as w, Source as x, Position as y, ViewRole as z };
3587
+ export { type ActionEvent, type AddControlApplicationErrors, type AddControlOptions, type AddControlOptionsControlOneOf, type AddControlRequest, type AddControlRequestControlOneOf, type AddControlResponse, type AdditionalGuestsControl, type Address, type AddressControl, type AddressControlLabels, type AddressLocation, type AddressStreetOneOf, type Agenda, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, BackgroundType, type BackgroundTypeWithLiterals, type Badge, type BaseEventMetadata, type BlockquoteData, type BookingData, type Border, type BorderColors, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CalendarLinks, type CaptionData, type CardStyles, CardStylesType, type CardStylesTypeWithLiterals, type Category, type CategoryCounts, type CellStyle, type CheckboxControl, type CheckoutFormMessages, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ConferenceType, type ConferenceTypeWithLiterals, Crop, type CropWithLiterals, type Dashboard, type DateControl, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeleteControlApplicationErrors, type DeleteControlIdentifiers, type DeleteControlRequest, type DeleteControlResponse, type Design, type Dimensions, Direction, type DirectionWithLiterals, type DiscardDraftRequest, type DiscardDraftResponse, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type DropdownControl, type EmailControl, type EmbedData, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type Event, type EventData, type EventDisplaySettings, EventStatus, type EventStatusWithLiterals, EventType, type EventTypeWithLiterals, type EventUpdated, type ExternalEvent, type Feed, type FileData, type FileSource, type FileSourceDataOneOf, type FontSizeData, FontType, type FontTypeWithLiterals, type Form, type FormEventUpdatedEnvelope, type FormInputControlAdded, type FormInputControlDeleted, type FormInputControlUpdated, type FormMessages, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetFormRequest, type GetFormResponse, type Gradient, type GuestListConfig, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type Input, type InputControl, InputControlType, type InputControlTypeWithLiterals, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, type Label, type LabellingSettings, type Labels, Layout, type LayoutCellData, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListValue, type Location, LocationType, type LocationTypeWithLiterals, type MapCoordinates, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MentionData, type MessageEnvelope, type Metadata, type Money, type NameControl, type NameControlLabels, type Negative, type NegativeResponseConfirmation, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Occurrence, type Oembed, type OnlineConferencing, type OnlineConferencingConfig, type OnlineConferencingSession, type Option, type OptionDesign, type OptionLayout, type OptionSelection, type OptionSelectionSelectedOptionOneOf, type OrderedListData, Orientation, type OrientationWithLiterals, type PDFSettings, type ParagraphData, type Permissions, type PhoneControl, Placement, 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, type PollSettings, Position, type PositionWithLiterals, type Positive, type PositiveResponseConfirmation, type PublishDraftRequest, type PublishDraftResponse, type RadioButtonControl, type Recurrences, type Registration, type RegistrationClosedMessages, RegistrationStatus, type RegistrationStatusWithLiterals, type Rel, RequestedFields, type RequestedFieldsWithLiterals, Resizing, type ResizingWithLiterals, type ResponseConfirmation, type RestoreInfo, type RibbonStyles, type RichContent, type RsvpCollection, type RsvpCollectionConfig, type RsvpFormMessages, RsvpStatusOptions, type RsvpStatusOptionsWithLiterals, type RsvpSummary, type ScheduleConfig, type Scheduling, type SeoSchema, type SeoSettings, type Settings, type SiteUrl, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, State, type StateWithLiterals, Status, type StatusWithLiterals, type StreetAddress, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type Subdivision, SubdivisionType, type SubdivisionTypeWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, type TaxConfig, TaxType, type TaxTypeWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextControl, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type Ticketing, type TicketingConfig, type TicketingSummary, type TicketsUnavailableMessages, Type, type TypeWithLiterals, type UpdateControlApplicationErrors, type UpdateControlIdentifiers, type UpdateControlIdentifiersControlOneOf, type UpdateControlOptions, type UpdateControlOptionsControlOneOf, type UpdateControlRequest, type UpdateControlRequestControlOneOf, type UpdateControlResponse, type UpdateMessagesOptions, type UpdateMessagesRequest, type UpdateMessagesResponse, ValueType, type ValueTypeWithLiterals, VerticalAlignment, type VerticalAlignmentWithLiterals, type Video, type VideoData, ViewMode, type ViewModeWithLiterals, ViewRole, type ViewRoleWithLiterals, VisitorType, type VisitorTypeWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, addControl, deleteControl, discardDraft, getForm, onFormEventUpdated, publishDraft, updateControl, updateMessages };