@wix/auto_sdk_forms_submissions 1.0.47 → 1.0.49

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 (33) hide show
  1. package/build/cjs/{forms-v4-submission-submissions.universal-BQxE18i-.d.ts → forms-v4-submission-submissions.universal-BEPxuOFF.d.ts} +860 -578
  2. package/build/cjs/index.d.ts +2 -2
  3. package/build/cjs/index.js +2 -0
  4. package/build/cjs/index.js.map +1 -1
  5. package/build/cjs/index.typings.d.ts +2 -2
  6. package/build/cjs/index.typings.js +2 -0
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1 -1
  9. package/build/es/{forms-v4-submission-submissions.universal-BQxE18i-.d.mts → forms-v4-submission-submissions.universal-BEPxuOFF.d.mts} +860 -578
  10. package/build/es/index.d.mts +2 -2
  11. package/build/es/index.mjs +2 -0
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +2 -2
  14. package/build/es/index.typings.mjs +2 -0
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +1 -1
  17. package/build/internal/cjs/{forms-v4-submission-submissions.universal-DcchBxo2.d.ts → forms-v4-submission-submissions.universal-38ZdY7HP.d.ts} +860 -578
  18. package/build/internal/cjs/index.d.ts +2 -2
  19. package/build/internal/cjs/index.js +2 -0
  20. package/build/internal/cjs/index.js.map +1 -1
  21. package/build/internal/cjs/index.typings.d.ts +2 -2
  22. package/build/internal/cjs/index.typings.js +2 -0
  23. package/build/internal/cjs/index.typings.js.map +1 -1
  24. package/build/internal/cjs/meta.d.ts +1 -1
  25. package/build/internal/es/{forms-v4-submission-submissions.universal-DcchBxo2.d.mts → forms-v4-submission-submissions.universal-38ZdY7HP.d.mts} +860 -578
  26. package/build/internal/es/index.d.mts +2 -2
  27. package/build/internal/es/index.mjs +2 -0
  28. package/build/internal/es/index.mjs.map +1 -1
  29. package/build/internal/es/index.typings.d.mts +2 -2
  30. package/build/internal/es/index.typings.mjs +2 -0
  31. package/build/internal/es/index.typings.mjs.map +1 -1
  32. package/build/internal/es/meta.d.mts +1 -1
  33. package/package.json +2 -2
@@ -272,18 +272,19 @@ interface CreateCheckoutFromSubmissionRequestFormSchemaIdentifierOneOf {
272
272
  }
273
273
  interface Form {
274
274
  /**
275
- * Form ID.
275
+ * Form schema ID.
276
276
  * @format GUID
277
277
  * @readonly
278
278
  */
279
279
  _id?: string | null;
280
280
  /**
281
- * List of form fields that represent input elements.
281
+ * Form fields that define the input elements and their validation rules.
282
282
  * @maxSize 500
283
283
  */
284
284
  formFields?: Field[];
285
285
  /**
286
- * Defines the layout for form fields in each submission step.
286
+ * Layout configuration that defines how form fields are organized across multiple steps.
287
+ * Each step represents a page of the form.
287
288
  * @maxSize 100
288
289
  */
289
290
  steps?: Step[];
@@ -296,17 +297,18 @@ interface Form {
296
297
  */
297
298
  rules?: FormRule[];
298
299
  /**
299
- * Represents the current state of an item. Each time the item is modified, its `revision` changes. For an update operation to succeed, you MUST pass the latest revision.
300
+ * Revision number, which increments by 1 each time the form schema is updated.
301
+ * To prevent conflicting changes, the current revision must be passed when updating the form schema.
300
302
  * @readonly
301
303
  */
302
304
  revision?: string | null;
303
305
  /**
304
- * Date of creation.
306
+ * Date and time when the form schema was created.
305
307
  * @readonly
306
308
  */
307
309
  _createdDate?: Date | null;
308
310
  /**
309
- * Date of last update.
311
+ * Date and time when the form schema was last updated.
310
312
  * @readonly
311
313
  */
312
314
  _updatedDate?: Date | null;
@@ -323,51 +325,60 @@ interface Form {
323
325
  */
324
326
  deletedFieldsV2?: FormFieldV2[];
325
327
  /**
326
- * List of form fields which were soft deleted.
328
+ * Form fields that were soft deleted.
327
329
  * @maxSize 150
328
330
  * @readonly
329
331
  */
330
332
  deletedFormFields?: Field[];
331
- /** Data extensions ExtendedFields. */
333
+ /** Data extensions for storing additional custom properties. */
332
334
  extendedFields?: ExtendedFields;
333
335
  /**
334
- * Identifies the namespace that the form belongs to.
336
+ * Unique identifier for the app that owns this form schema.
337
+ * For example, `wix.form_app.form` for Wix Forms.
338
+ *
339
+ * See a list of namespaces for [apps made by Wix](https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/introduction#namespaces-of-apps-made-by-wix) section.
335
340
  * @minLength 10
336
341
  * @maxLength 50
337
342
  * @immutable
338
343
  */
339
344
  namespace?: string;
340
345
  /**
341
- * Media folder ID.
346
+ * Media folder ID for storing uploaded files from form submissions.
342
347
  * @maxLength 100
343
348
  * @readonly
344
349
  */
345
350
  mediaFolderId?: string | null;
346
- /** Rules that limit submissions on this form. */
351
+ /** Submission limits that can automatically disable the form when reached. */
347
352
  limitationRule?: LimitationRule;
348
353
  /**
349
- * Spam filter protection level.
350
- * Default: ADVANCED.
354
+ * Level of spam protection applied to form submissions.
355
+ *
356
+ * Default: `ADVANCED`
351
357
  */
352
358
  spamFilterProtectionLevel?: SpamFilterProtectionLevelWithLiterals;
353
- /** Required indicator properties. */
359
+ /** Configuration for how required field indicators are displayed to the submitter. */
354
360
  requiredIndicatorProperties?: RequiredIndicatorProperties;
355
- /** Settings for actions to be taken after form submission. */
361
+ /** Configuration for actions taken after a form is successfully submitted. */
356
362
  submitSettings?: SubmitSettings;
357
- /** Message shown when the form is disabled */
363
+ /**
364
+ * Message displayed to visitors when the form is disabled.
365
+ * This allows you to inform submitters why the form isn't available.
366
+ */
358
367
  disabledFormMessage?: RichContent;
359
368
  /**
360
- * Identifies if the form is enabled.
361
- * Default true
369
+ * Whether the form schema is enabled.
370
+ *
371
+ * Default: `true`
362
372
  */
363
373
  enabled?: boolean | null;
364
374
  /**
365
- * Form name.
375
+ * Display name of the form schema.
366
376
  * @maxLength 200
367
377
  */
368
378
  name?: string | null;
369
379
  /**
370
- * Form rules, can be applied to layout and items properties.
380
+ * Business logic rules that can modify form behavior based on user input or other conditions.
381
+ * These rules can show/hide fields, change validation, or trigger actions.
371
382
  * @maxSize 100
372
383
  */
373
384
  formRules?: Rule[];
@@ -682,18 +693,18 @@ declare enum ValidationFormat {
682
693
  type ValidationFormatWithLiterals = ValidationFormat | 'UNDEFINED' | 'WIX_FILE' | 'PAYMENT' | 'MULTILINE_ADDRESS' | 'SCHEDULING';
683
694
  interface PaymentType {
684
695
  /**
685
- * Field mapped to products.
696
+ * Products the submitter can select to make a payment for.
686
697
  * @minSize 1
687
698
  * @maxSize 100
688
699
  */
689
700
  products?: Product[];
690
701
  /**
691
- * Minimum amount of different products.
702
+ * Minimum number of different products that must be selected.
692
703
  * @max 100
693
704
  */
694
705
  minItems?: number | null;
695
706
  /**
696
- * Maximum amount of different products.
707
+ * Maximum number of different products that can be selected.
697
708
  * @max 100
698
709
  */
699
710
  maxItems?: number | null;
@@ -701,7 +712,7 @@ interface PaymentType {
701
712
  declare enum ProductType {
702
713
  /** Unknown product type. */
703
714
  UNKNOWN_PRODUCT_TYPE = "UNKNOWN_PRODUCT_TYPE",
704
- /** Shippable (physical) product. */
715
+ /** Physical product that can be shipped. */
705
716
  SHIPPABLE = "SHIPPABLE",
706
717
  /** Digital product. */
707
718
  DIGITAL = "DIGITAL"
@@ -711,22 +722,22 @@ type ProductTypeWithLiterals = ProductType | 'UNKNOWN_PRODUCT_TYPE' | 'SHIPPABLE
711
722
  declare enum PriceType {
712
723
  /** Unknown price type. */
713
724
  UNKNOWN_PRICE_TYPE = "UNKNOWN_PRICE_TYPE",
714
- /** Fixed price. */
725
+ /** Product has a single, unchanging price. */
715
726
  FIXED_PRICE = "FIXED_PRICE",
716
- /** Dynamic price from price range. */
727
+ /** Product price can vary within a specified range. */
717
728
  DYNAMIC_PRICE = "DYNAMIC_PRICE"
718
729
  }
719
730
  /** @enumType */
720
731
  type PriceTypeWithLiterals = PriceType | 'UNKNOWN_PRICE_TYPE' | 'FIXED_PRICE' | 'DYNAMIC_PRICE';
721
732
  interface QuantityLimit {
722
733
  /**
723
- * Minimum quantity.
734
+ * Minimum quantity that must be selected for this product.
724
735
  * @min 1
725
736
  * @max 100000
726
737
  */
727
738
  minimum?: number | null;
728
739
  /**
729
- * Maximum quantity.
740
+ * Maximum quantity that can be selected for this product.
730
741
  * @min 1
731
742
  * @max 100000
732
743
  */
@@ -734,27 +745,35 @@ interface QuantityLimit {
734
745
  }
735
746
  interface FixedPriceOptions {
736
747
  /**
737
- * Fixed price monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99).
748
+ * Fixed price of the product.
749
+ *
750
+ * Specified as a decimal string with period as decimal separator. For example, `"3.99"`.
738
751
  * @decimalValue options { gte:0.00, maxScale:2 }
739
752
  */
740
753
  price?: string;
741
754
  }
742
755
  interface DynamicPriceOptions {
743
756
  /**
744
- * Minimal price monetary amount.
757
+ * Minimum price of the product.
758
+ *
759
+ * Specified as a decimal string with period as decimal separator. For example, `"1.00"`.
745
760
  * @decimalValue options { gte:0.00, maxScale:2 }
746
761
  */
747
762
  minPrice?: string;
748
763
  /**
749
- * Maximal price monetary amount.
764
+ * Maximum monetary price of the product.
765
+ *
766
+ * Specified as a decimal string with period as decimal separator. For example, `"10.00"`.
767
+ *
768
+ * If not specified, there is no upper limit on the price.
750
769
  * @decimalValue options { gte:0.00, maxScale:2 }
751
770
  */
752
771
  maxPrice?: string | null;
753
772
  }
754
773
  interface Product extends ProductPriceOptionsOneOf {
755
- /** Fixed price options. */
774
+ /** Configuration for products with fixed pricing. */
756
775
  fixedPriceOptions?: FixedPriceOptions;
757
- /** Dynamic price options. */
776
+ /** Configuration for products with variable pricing within a range. */
758
777
  dynamicPriceOptions?: DynamicPriceOptions;
759
778
  /**
760
779
  * Product ID.
@@ -766,24 +785,25 @@ interface Product extends ProductPriceOptionsOneOf {
766
785
  productType?: ProductTypeWithLiterals;
767
786
  /** Price type. */
768
787
  priceType?: PriceTypeWithLiterals;
769
- /** Quantity limit. */
788
+ /** Limits on how many units of this product can be selected. */
770
789
  quantityLimit?: QuantityLimit;
771
790
  }
772
791
  /** @oneof */
773
792
  interface ProductPriceOptionsOneOf {
774
- /** Fixed price options. */
793
+ /** Configuration for products with fixed pricing. */
775
794
  fixedPriceOptions?: FixedPriceOptions;
776
- /** Dynamic price options. */
795
+ /** Configuration for products with variable pricing within a range. */
777
796
  dynamicPriceOptions?: DynamicPriceOptions;
778
797
  }
779
798
  interface MultilineAddressValidation {
780
799
  /**
781
- * Allowed countries. No countries treated as all.
800
+ * Countries from which addresses are accepted.
801
+ * If empty, addresses from all countries are allowed.
782
802
  * @format COUNTRY
783
803
  * @maxSize 200
784
804
  */
785
805
  allowedCountries?: string[];
786
- /** Fields overrides. */
806
+ /** Customization configuration for individual address field components. */
787
807
  fields?: FieldsOverrides;
788
808
  }
789
809
  interface FieldOverrides {
@@ -791,21 +811,21 @@ interface FieldOverrides {
791
811
  required?: boolean;
792
812
  }
793
813
  interface FieldsOverrides {
794
- /** Subdivision. */
814
+ /** Subdivision settings. */
795
815
  subdivision?: FieldOverrides;
796
- /** City. */
816
+ /** City settings. */
797
817
  city?: FieldOverrides;
798
- /** Postal code. */
818
+ /** Postal code settings. */
799
819
  postalCode?: FieldOverrides;
800
- /** Street name. */
820
+ /** Street name settings. */
801
821
  streetName?: FieldOverrides;
802
- /** Street number. */
822
+ /** Street number settings. */
803
823
  streetNumber?: FieldOverrides;
804
- /** Address line. */
824
+ /** Address line settings. */
805
825
  addressLine?: FieldOverrides;
806
- /** Address line 2. */
826
+ /** Address line 2 settings. */
807
827
  addressLine2?: FieldOverrides;
808
- /** Country. */
828
+ /** Country settings. */
809
829
  country?: FieldOverrides;
810
830
  }
811
831
  interface NestedFormFieldOverrides {
@@ -999,30 +1019,32 @@ declare enum InputFieldStringComponentType {
999
1019
  type InputFieldStringComponentTypeWithLiterals = InputFieldStringComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'TEXT_INPUT' | 'RADIO_GROUP' | 'DROPDOWN' | 'DATE_TIME' | 'PHONE_INPUT' | 'DATE_INPUT' | 'TIME_INPUT' | 'DATE_PICKER' | 'SERVICES_DROPDOWN';
1000
1020
  interface TextInput {
1001
1021
  /**
1002
- * Label of the field
1022
+ * Field label.
1003
1023
  * @maxLength 350
1004
1024
  */
1005
1025
  label?: string | null;
1006
- /** Description of the field */
1026
+ /** Additional description or instructions for the field. */
1007
1027
  description?: RichContent;
1008
1028
  /**
1009
- * Placeholder for the value input
1029
+ * Placeholder text shown inside the field when it's empty.
1030
+ * Useful for providing a hint about the expected format or content.
1010
1031
  * @maxLength 100
1011
1032
  */
1012
1033
  placeholder?: string | null;
1013
1034
  /**
1014
- * Flag identifying to hide or not label
1015
- * Default: true
1035
+ * Whether to display the field label.
1036
+ *
1037
+ * Default: `true`
1016
1038
  */
1017
1039
  showLabel?: boolean | null;
1018
1040
  /**
1019
- * Default value for the text input
1041
+ * Default value for the field. This value is pre-populated in the field when the form loads.
1020
1042
  * @maxLength 20000
1021
1043
  */
1022
1044
  default?: string | null;
1023
- /** Media item. Media, associated with field, like image. */
1045
+ /** Media content associated with the field, such as an image. */
1024
1046
  media?: MediaItem;
1025
- /** Settings for media item */
1047
+ /** Configuration for the media content. */
1026
1048
  mediaSettings?: MediaSettings;
1027
1049
  }
1028
1050
  interface RichContent {
@@ -2767,27 +2789,27 @@ interface MediaItemMediaOneOf {
2767
2789
  }
2768
2790
  interface MediaSettings {
2769
2791
  /**
2770
- * Specifies where image should be displayed.
2771
- * Default: BELOW
2792
+ * Specifies where the image should be displayed relative to the field's label.
2793
+ * Default: `BELOW`
2772
2794
  */
2773
2795
  imagePosition?: ImagePositionWithLiterals;
2774
2796
  /**
2775
- * Specifies image alignment.
2776
- * Default: CENTER
2797
+ * Specifies the image alignment.
2798
+ * Default: `CENTER`
2777
2799
  */
2778
2800
  imageAlignment?: AlignmentWithLiterals;
2779
2801
  /**
2780
- * Defines how an image should be resized to fit.
2781
- * Default: COVER
2802
+ * Specifies how an image should be resized to fit.
2803
+ * Default: `COVER`
2782
2804
  */
2783
2805
  imageFit?: ImageFitWithLiterals;
2784
2806
  }
2785
2807
  declare enum ImagePosition {
2786
2808
  /** Undefined position. */
2787
2809
  UNKNOWN_IMAGE_POSITION = "UNKNOWN_IMAGE_POSITION",
2788
- /** Above label. */
2810
+ /** Above the field's label. */
2789
2811
  ABOVE = "ABOVE",
2790
- /** Below label. */
2812
+ /** Below the field's label. */
2791
2813
  BELOW = "BELOW"
2792
2814
  }
2793
2815
  /** @enumType */
@@ -2795,70 +2817,71 @@ type ImagePositionWithLiterals = ImagePosition | 'UNKNOWN_IMAGE_POSITION' | 'ABO
2795
2817
  declare enum Alignment {
2796
2818
  /** Undefined alignment. */
2797
2819
  UNKNOWN_ALIGNMENT = "UNKNOWN_ALIGNMENT",
2798
- /** Left. */
2820
+ /** Align left. */
2799
2821
  LEFT = "LEFT",
2800
- /** Center. */
2822
+ /** Align center. */
2801
2823
  CENTER = "CENTER",
2802
- /** Right. */
2824
+ /** Align right. */
2803
2825
  RIGHT = "RIGHT"
2804
2826
  }
2805
2827
  /** @enumType */
2806
2828
  type AlignmentWithLiterals = Alignment | 'UNKNOWN_ALIGNMENT' | 'LEFT' | 'CENTER' | 'RIGHT';
2807
2829
  declare enum ImageFit {
2808
2830
  UNKNOWN_IMAGE_FIT = "UNKNOWN_IMAGE_FIT",
2809
- /** Image is scaled to maintain its aspect ratio while filling the element's entire content box. Portions of the image may be clipped if the aspect ratios do not match. */
2831
+ /** Scale the image to maintain its aspect ratio while filling the element's entire content box. Portions of the image may be clipped if the aspect ratios don't match. */
2810
2832
  COVER = "COVER",
2811
- /** Image is resized to fill the element's content box. Aspect ratio may not be preserved. */
2833
+ /** Resize the image to fill the element's content box. The image's original sspect ratio may not be preserved. */
2812
2834
  CONTAIN = "CONTAIN"
2813
2835
  }
2814
2836
  /** @enumType */
2815
2837
  type ImageFitWithLiterals = ImageFit | 'UNKNOWN_IMAGE_FIT' | 'COVER' | 'CONTAIN';
2816
2838
  interface RadioGroup {
2817
2839
  /**
2818
- * Label of the field
2840
+ * Field label.
2819
2841
  * @maxLength 350
2820
2842
  */
2821
2843
  label?: string | null;
2822
- /** Description of the field */
2844
+ /** Additional description or instructions for the field. */
2823
2845
  description?: RichContent;
2824
2846
  /**
2825
- * Flag identifying to show option allowing input custom value
2826
- * List of options to select from
2847
+ * List of options the submitter can select from.
2827
2848
  * @maxSize 400
2828
2849
  */
2829
2850
  options?: RadioGroupOption[];
2830
2851
  /**
2831
- * Flag identifying to hide or not label
2832
- * Default: true
2852
+ * Whether to display the field label.
2853
+ *
2854
+ * Default: `true`
2833
2855
  */
2834
2856
  showLabel?: boolean | null;
2835
- /** Option which can be specified by UoU, enabled when this object is specified. */
2857
+ /** Custom option which can be specified by the submitter. */
2836
2858
  customOption?: CustomOption;
2837
2859
  /**
2838
2860
  * Specifies the number of columns used to display the selections within the component.
2839
- * Default: ONE
2861
+ *
2862
+ * Default: `ONE`
2840
2863
  */
2841
2864
  numberOfColumns?: NumberOfColumnsWithLiterals;
2842
- /** Media item. Media, associated with field, like image. */
2865
+ /** Media content associated with the field, such as an image. */
2843
2866
  media?: MediaItem;
2844
- /** Settings for media item */
2867
+ /** Configuration for the media content. */
2845
2868
  mediaSettings?: MediaSettings;
2846
2869
  }
2847
2870
  interface RadioGroupOption {
2848
2871
  /**
2849
- * Selectable option label
2872
+ * Selectable option label.
2850
2873
  * @maxLength 400
2851
2874
  */
2852
2875
  label?: string | null;
2853
2876
  /**
2854
- * Selectable option value, which is saved to DB.
2877
+ * Value stored on submission when this option is selected.
2855
2878
  * @maxLength 20000
2856
2879
  */
2857
2880
  value?: string | null;
2858
- /** Flag identifying that option should be selected by default */
2881
+ /** Whether this option is selected by default. */
2859
2882
  default?: boolean;
2860
2883
  /**
2861
- * Option id. Used as binding for translations
2884
+ * Option ID. Used to connect this option with [Wix Multilingual](https://dev.wix.com/docs/api-reference/business-management/multilingual/translation/introduction) for translation.
2862
2885
  * @format GUID
2863
2886
  * @immutable
2864
2887
  */
@@ -2866,12 +2889,12 @@ interface RadioGroupOption {
2866
2889
  }
2867
2890
  interface CustomOption {
2868
2891
  /**
2869
- * Label of custom option input
2892
+ * Custom option label.
2870
2893
  * @maxLength 350
2871
2894
  */
2872
2895
  label?: string | null;
2873
2896
  /**
2874
- * Placeholder of custom option input
2897
+ * Custom option placeholder text.
2875
2898
  * @maxLength 100
2876
2899
  */
2877
2900
  placeholder?: string | null;
@@ -2892,49 +2915,50 @@ declare enum NumberOfColumns {
2892
2915
  type NumberOfColumnsWithLiterals = NumberOfColumns | 'UNKNOWN_NUMBER_OF_COLUMNS' | 'ZERO' | 'ONE' | 'TWO' | 'THREE';
2893
2916
  interface Dropdown {
2894
2917
  /**
2895
- * Label of the field
2918
+ * Field label.
2896
2919
  * @maxLength 350
2897
2920
  */
2898
2921
  label?: string | null;
2899
- /** Description of the field */
2922
+ /** Additional description or instructions for the field. */
2900
2923
  description?: RichContent;
2901
2924
  /**
2902
- * List of options to select from
2925
+ * List of options the submitter can select from.
2903
2926
  * @maxSize 400
2904
2927
  */
2905
2928
  options?: DropdownOption[];
2906
2929
  /**
2907
- * Flag identifying to hide or not label
2908
- * Default: true
2930
+ * Whether to display the field label.
2931
+ *
2932
+ * Default: `true`
2909
2933
  */
2910
2934
  showLabel?: boolean | null;
2911
- /** Option which can be specified by UoU, enabled when this object is specified. */
2935
+ /** Custom option which can be specified by the submitter. */
2912
2936
  customOption?: CustomOption;
2913
2937
  /**
2914
- * Placeholder of dropdown input
2938
+ * Placeholder text shown when no option is selected.
2915
2939
  * @maxLength 100
2916
2940
  */
2917
2941
  placeholder?: string | null;
2918
- /** Media item. Media, associated with field, like image. */
2942
+ /** Media content associated with the field, such as an image. */
2919
2943
  media?: MediaItem;
2920
- /** Settings for media item */
2944
+ /** Configuration for the media content. */
2921
2945
  mediaSettings?: MediaSettings;
2922
2946
  }
2923
2947
  interface DropdownOption {
2924
2948
  /**
2925
- * Selectable option label
2949
+ * Selectable option label.
2926
2950
  * @maxLength 400
2927
2951
  */
2928
2952
  label?: string | null;
2929
2953
  /**
2930
- * Selectable option value, which is saved to DB.
2954
+ * Value stored on submission when this option is selected.
2931
2955
  * @maxLength 20000
2932
2956
  */
2933
2957
  value?: string | null;
2934
- /** Flag identifying that option should be selected by default */
2958
+ /** Whether this option is selected by default. */
2935
2959
  default?: boolean;
2936
2960
  /**
2937
- * Option id. Used as binding for translations
2961
+ * Option ID. Used to connect this option with [Wix Multilingual](https://dev.wix.com/docs/api-reference/business-management/multilingual/translation/introduction) for translation.
2938
2962
  * @format GUID
2939
2963
  * @immutable
2940
2964
  */
@@ -2942,35 +2966,38 @@ interface DropdownOption {
2942
2966
  }
2943
2967
  interface DateTimeInput {
2944
2968
  /**
2945
- * Label of the field. Displayed text for the date/time input.
2969
+ * Field label.
2946
2970
  * @maxLength 350
2947
2971
  */
2948
2972
  label?: string | null;
2949
- /** Description of the field. Additional information about the date/time input. */
2973
+ /** Additional description or instructions for the field. */
2950
2974
  description?: RichContent;
2951
2975
  /**
2952
- * Flag identifying whether to show or hide the label.
2953
- * Default: true
2976
+ * Whether to display the field label.
2977
+ *
2978
+ * Default: `true`
2954
2979
  */
2955
2980
  showLabel?: boolean | null;
2956
2981
  /**
2957
- * Flag identifying whether to show or hide the placeholder.
2958
- * Default: true
2982
+ * Whether to display placeholder text in the field when it's empty.
2983
+ *
2984
+ * Default: `true`
2959
2985
  */
2960
2986
  showPlaceholder?: boolean | null;
2961
2987
  /**
2962
- * Flag indicating whether to use the 24-hour time format.
2963
- * Default: false.
2988
+ * Whether to use 24-hour time format.
2989
+ *
2990
+ * Default: `false`
2964
2991
  */
2965
2992
  use24HourFormat?: boolean;
2966
2993
  /**
2967
- * Default value for the date time input.
2994
+ * Default value for the field. This value is pre-populated in the field when the form loads.
2968
2995
  * @format LOCAL_DATE_TIME
2969
2996
  */
2970
2997
  default?: string | null;
2971
- /** Media item. Media, associated with field, like image. */
2998
+ /** Media content associated with the field, such as an image. */
2972
2999
  media?: MediaItem;
2973
- /** Settings for media item */
3000
+ /** Configuration for the media content. */
2974
3001
  mediaSettings?: MediaSettings;
2975
3002
  /**
2976
3003
  * Flag identifying whether to show or hide the date labels.
@@ -2980,64 +3007,68 @@ interface DateTimeInput {
2980
3007
  }
2981
3008
  interface PhoneInput {
2982
3009
  /**
2983
- * Label of the field
3010
+ * Field label.
2984
3011
  * @maxLength 350
2985
3012
  */
2986
3013
  label?: string | null;
2987
- /** Description of the field */
3014
+ /** Additional description or instructions for the field. */
2988
3015
  description?: RichContent;
2989
3016
  /**
2990
- * Placeholder for the value input
3017
+ * Placeholder text shown inside the field when it's empty.
2991
3018
  * @maxLength 100
2992
3019
  */
2993
3020
  placeholder?: string | null;
2994
3021
  /**
2995
- * Flag identifying to show label or not
2996
- * Default: true
3022
+ * Whether to display the field label.
3023
+ *
3024
+ * Default: `true`
2997
3025
  */
2998
3026
  showLabel?: boolean | null;
2999
3027
  /**
3000
- * Default value of the country code
3028
+ * Default country code for the phone number input. Two-letter country code in ISO-3166 alpha-2 format.
3001
3029
  * @minLength 1
3002
3030
  * @maxLength 5
3003
3031
  */
3004
3032
  defaultCountryCode?: string | null;
3005
3033
  /**
3006
- * Flag identifying to show country flag or not
3007
- * Default: false
3034
+ * Whether to display the country flag next to the country code.
3035
+ *
3036
+ * Default: `false`
3008
3037
  */
3009
3038
  showCountryFlag?: boolean;
3010
- /** Media item. Media, associated with field, like image. */
3039
+ /** Media content associated with the field, such as an image. */
3011
3040
  media?: MediaItem;
3012
- /** Settings for media item */
3041
+ /** Configuration for the media content. */
3013
3042
  mediaSettings?: MediaSettings;
3014
3043
  }
3015
3044
  interface DateInput {
3016
3045
  /**
3017
- * Label of the field. Displayed text for the date/time input.
3046
+ * Field label.
3018
3047
  * @maxLength 350
3019
3048
  */
3020
3049
  label?: string | null;
3021
- /** Description of the field. Additional information about the date/time input. */
3050
+ /** Additional description or instructions for the field. */
3022
3051
  description?: RichContent;
3023
3052
  /**
3024
- * Flag identifying whether to show or hide the label.
3025
- * Default: true
3053
+ * Whether to display the field label.
3054
+ *
3055
+ * Default: `true`
3026
3056
  */
3027
3057
  showLabel?: boolean | null;
3028
3058
  /**
3029
- * Flag identifying whether to show or hide the placeholder.
3030
- * Default: true
3059
+ * Whether to display placeholder text in the field when it's empty.
3060
+ *
3061
+ * Default: `true`
3031
3062
  */
3032
3063
  showPlaceholder?: boolean | null;
3033
3064
  /**
3034
- * Default value for the date input.
3065
+ * Default value for the field. This value is pre-populated in the field when the form loads.
3035
3066
  * @format LOCAL_DATE
3036
3067
  */
3037
3068
  default?: string | null;
3038
- /** Media item. Media, associated with field, like image. */
3069
+ /** Media content associated with the field, such as an image. */
3039
3070
  media?: MediaItem;
3040
- /** Settings for media item */
3071
+ /** Configuration for the media content. */
3041
3072
  mediaSettings?: MediaSettings;
3042
3073
  /**
3043
3074
  * Flag identifying whether to show or hide the date labels.
@@ -3047,65 +3078,69 @@ interface DateInput {
3047
3078
  }
3048
3079
  interface TimeInput {
3049
3080
  /**
3050
- * Label of the field. Displayed text for the date/time input.
3081
+ * Field label.
3051
3082
  * @maxLength 350
3052
3083
  */
3053
3084
  label?: string | null;
3054
- /** Description of the field. Additional information about the date/time input. */
3085
+ /** Field description. */
3055
3086
  description?: RichContent;
3056
3087
  /**
3057
- * Flag identifying whether to show or hide the label.
3058
- * Default: true
3088
+ * Whether to display the label.
3089
+ *
3090
+ * Default: `true`
3059
3091
  */
3060
3092
  showLabel?: boolean | null;
3061
3093
  /**
3062
- * Flag identifying whether to show or hide the placeholder.
3063
- * Default: true
3094
+ * Whether to display placeholder text in the field when it's empty.
3095
+ *
3096
+ * Default: `true`
3064
3097
  */
3065
3098
  showPlaceholder?: boolean | null;
3066
3099
  /**
3067
- * Flag indicating whether to use the 24-hour time format.
3068
- * Default: false.
3100
+ * Whether to use 24-hour time format.
3101
+ *
3102
+ * Default: `false`
3069
3103
  */
3070
3104
  use24HourFormat?: boolean;
3071
3105
  /**
3072
- * Default value for the time input.
3106
+ * Default value for the field. This value is pre-populated in the field when the form loads.
3073
3107
  * @format LOCAL_TIME
3074
3108
  */
3075
3109
  default?: string | null;
3076
- /** Media item. Media, associated with field, like image. */
3110
+ /** Media content associated with the field, such as an image. */
3077
3111
  media?: MediaItem;
3078
- /** Settings for media item */
3112
+ /** Configuration for the media content. */
3079
3113
  mediaSettings?: MediaSettings;
3080
3114
  }
3081
3115
  interface DatePicker {
3082
3116
  /**
3083
- * Label of the field. Displayed text for the date/time input.
3117
+ * Field label.
3084
3118
  * @maxLength 350
3085
3119
  */
3086
3120
  label?: string | null;
3087
- /** Description of the field. Additional information about the date/time input. */
3121
+ /** Additional description or instructions for the field. */
3088
3122
  description?: RichContent;
3089
3123
  /**
3090
- * Flag identifying whether to show or hide the label.
3091
- * Default: true
3124
+ * Whether to display the field label.
3125
+ *
3126
+ * Default: `true`
3092
3127
  */
3093
3128
  showLabel?: boolean | null;
3094
3129
  /**
3095
- * Placeholder of date picker input
3130
+ * Placeholder text shown when no date is selected.
3096
3131
  * @maxLength 100
3097
3132
  */
3098
3133
  placeholder?: string | null;
3099
- /** First day of the week displayed on date picker. */
3134
+ /** First day of the week displayed on the date picker. */
3100
3135
  firstDayOfWeek?: FirstDayOfWeekWithLiterals;
3101
3136
  /**
3102
- * Default value for the date picker.
3137
+ * Default value for the field. This value is pre-populated in the field when the form loads.
3103
3138
  * @format LOCAL_DATE
3104
3139
  */
3105
3140
  default?: string | null;
3106
- /** Media item. Media, associated with field, like image. */
3141
+ /** Media content associated with the field, such as an image. */
3107
3142
  media?: MediaItem;
3108
- /** Settings for media item */
3143
+ /** Configuration for the media content. */
3109
3144
  mediaSettings?: MediaSettings;
3110
3145
  }
3111
3146
  declare enum FirstDayOfWeek {
@@ -3118,29 +3153,30 @@ declare enum FirstDayOfWeek {
3118
3153
  type FirstDayOfWeekWithLiterals = FirstDayOfWeek | 'MONDAY' | 'SUNDAY';
3119
3154
  interface ServicesDropdown {
3120
3155
  /**
3121
- * Label of the field
3156
+ * Field label.
3122
3157
  * @maxLength 350
3123
3158
  */
3124
3159
  label?: string | null;
3125
3160
  /**
3126
- * Flag identifying to hide or not label
3127
- * Default: true
3161
+ * Whether to display the field label.
3162
+ *
3163
+ * Default: `true`
3128
3164
  */
3129
3165
  showLabel?: boolean | null;
3130
3166
  /**
3131
- * Placeholder of services dropdown input
3167
+ * Placeholder text shown when no service is selected.
3132
3168
  * @maxLength 100
3133
3169
  */
3134
3170
  placeholder?: string | null;
3135
3171
  /**
3136
- * List of service options to select from
3172
+ * List of service options the submitter can select from.
3137
3173
  * @maxSize 400
3138
3174
  */
3139
- options?: ServicesDropdownOption[];
3140
- /** Option which can be specified by UoU, enabled when this object is specified. */
3175
+ options?: ServiceOption[];
3176
+ /** Custom option which can be specified by the submitter. */
3141
3177
  customOption?: CustomOption;
3142
3178
  }
3143
- interface ServicesDropdownOption {
3179
+ interface ServiceOption {
3144
3180
  /**
3145
3181
  * Service name/label
3146
3182
  * @maxLength 400
@@ -3181,51 +3217,53 @@ declare enum InputFieldNumberComponentType {
3181
3217
  type InputFieldNumberComponentTypeWithLiterals = InputFieldNumberComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'NUMBER_INPUT' | 'RATING_INPUT';
3182
3218
  interface NumberInput {
3183
3219
  /**
3184
- * Label of the field
3220
+ * Field label.
3185
3221
  * @maxLength 350
3186
3222
  */
3187
3223
  label?: string | null;
3188
- /** Description of the field */
3224
+ /** Additional description or instructions for the field. */
3189
3225
  description?: RichContent;
3190
3226
  /**
3191
- * Placeholder for the value input
3227
+ * Placeholder text shown inside the field when it's empty.
3192
3228
  * @maxLength 100
3193
3229
  */
3194
3230
  placeholder?: string | null;
3195
3231
  /**
3196
- * Flag identifying to hide or not label
3197
- * Default: true
3232
+ * Whether to display the field label.
3233
+ *
3234
+ * Default: `true`
3198
3235
  */
3199
3236
  showLabel?: boolean | null;
3200
- /** Default value for the number input */
3237
+ /** Default value for the field. This value is pre-populated in the field when the form loads. */
3201
3238
  default?: number | null;
3202
- /** Media item. Media, associated with field, like image. */
3239
+ /** Media content associated with the field, such as an image. */
3203
3240
  media?: MediaItem;
3204
- /** Settings for media item */
3241
+ /** Configuration for the media content. */
3205
3242
  mediaSettings?: MediaSettings;
3206
3243
  }
3207
3244
  interface RatingInput {
3208
3245
  /**
3209
- * Label of the field
3246
+ * Field label.
3210
3247
  * @maxLength 350
3211
3248
  */
3212
3249
  label?: string | null;
3213
- /** Description of the field */
3250
+ /** Additional description or instructions for the field. */
3214
3251
  description?: RichContent;
3215
3252
  /**
3216
- * Flag identifying to hide label or not
3217
- * Default: true
3253
+ * Whether to display the field label.
3254
+ *
3255
+ * Default: `true`
3218
3256
  */
3219
3257
  showLabel?: boolean | null;
3220
3258
  /**
3221
- * Default rating
3259
+ * Default rating value for the field.
3222
3260
  * @min 1
3223
3261
  * @max 5
3224
3262
  */
3225
3263
  defaultValue?: number | null;
3226
- /** Media item. Media, associated with field, like image. */
3264
+ /** Media content associated with the field, such as an image. */
3227
3265
  media?: MediaItem;
3228
- /** Settings for media item */
3266
+ /** Configuration for the media content. */
3229
3267
  mediaSettings?: MediaSettings;
3230
3268
  }
3231
3269
  interface InputFieldBooleanType {
@@ -3242,11 +3280,12 @@ declare enum InputFieldBooleanComponentType {
3242
3280
  /** @enumType */
3243
3281
  type InputFieldBooleanComponentTypeWithLiterals = InputFieldBooleanComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX';
3244
3282
  interface Checkbox {
3245
- /** Label of the field */
3283
+ /** Field label. */
3246
3284
  label?: RichContent;
3247
3285
  /**
3248
- * Flag identifying if checked by default
3249
- * Default: false
3286
+ * Whether the checkbox is selected by default when the form loads.
3287
+ *
3288
+ * Default: `false`
3250
3289
  */
3251
3290
  checked?: boolean;
3252
3291
  }
@@ -3366,98 +3405,103 @@ interface InputFieldArrayTypeArrayItemsItemTypeOptionsOneOf {
3366
3405
  declare enum InputFieldArrayComponentType {
3367
3406
  UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
3368
3407
  CHECKBOX_GROUP = "CHECKBOX_GROUP",
3369
- TAGS = "TAGS"
3408
+ TAGS = "TAGS",
3409
+ SERVICES_CHECKBOX_GROUP = "SERVICES_CHECKBOX_GROUP"
3370
3410
  }
3371
3411
  /** @enumType */
3372
- type InputFieldArrayComponentTypeWithLiterals = InputFieldArrayComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX_GROUP' | 'TAGS';
3412
+ type InputFieldArrayComponentTypeWithLiterals = InputFieldArrayComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX_GROUP' | 'TAGS' | 'SERVICES_CHECKBOX_GROUP';
3373
3413
  interface CheckboxGroup {
3374
3414
  /**
3375
- * Label of the field
3415
+ * Field label.
3376
3416
  * @maxLength 350
3377
3417
  */
3378
3418
  label?: string | null;
3379
- /** Description of the field */
3419
+ /** Additional description or instructions for the field. */
3380
3420
  description?: RichContent;
3381
3421
  /**
3382
- * List of options to select from
3422
+ * List of options the submitter can select from.
3383
3423
  * @maxSize 400
3384
3424
  */
3385
3425
  options?: Option[];
3386
3426
  /**
3387
- * Flag identifying to hide or not label
3388
- * Default: true
3427
+ * Whether to display the field label.
3428
+ *
3429
+ * Default: `true`
3389
3430
  */
3390
3431
  showLabel?: boolean | null;
3391
- /** Option which can be specified by UoU, enabled when this object is specified. */
3432
+ /** Custom option which can be specified by the submitter. */
3392
3433
  customOption?: CustomOption;
3393
3434
  /**
3394
3435
  * Specifies the number of columns used to display the selections within the component.
3395
- * Default: ONE
3436
+ *
3437
+ * Default: `ONE`
3396
3438
  */
3397
3439
  numberOfColumns?: NumberOfColumnsWithLiterals;
3398
- /** Media item. Media, associated with field, like image. */
3440
+ /** Media content associated with the field, such as an image. */
3399
3441
  media?: MediaItem;
3400
- /** Settings for media item */
3442
+ /** Configuration for the media content. */
3401
3443
  mediaSettings?: MediaSettings;
3402
3444
  }
3403
3445
  interface Option {
3404
3446
  /**
3405
- * Selectable option label
3447
+ * Selectable option label.
3406
3448
  * @maxLength 400
3407
3449
  */
3408
3450
  label?: string | null;
3409
- /** Selectable option value, which is saved to DB. */
3451
+ /** Value stored on submission when this option is selected. */
3410
3452
  value?: any;
3411
- /** Flag identifying that option should be selected by default */
3453
+ /** Whether this option is selected by default. */
3412
3454
  default?: boolean;
3413
3455
  /**
3414
- * Option id. Used as binding for translations
3456
+ * Option ID. Used to connect this option with [Wix Multilingual](https://dev.wix.com/docs/api-reference/business-management/multilingual/translation/introduction) for translation.
3415
3457
  * @format GUID
3416
3458
  * @immutable
3417
3459
  */
3418
3460
  _id?: string;
3419
- /** Media item. Media, associated with option, like image. */
3461
+ /** Media content associated with this option. */
3420
3462
  media?: MediaItem;
3421
3463
  }
3422
3464
  interface Tags {
3423
3465
  /**
3424
- * Label of the field
3466
+ * Field label.
3425
3467
  * @maxLength 350
3426
3468
  */
3427
3469
  label?: string | null;
3428
- /** Description of the field */
3470
+ /** Additional description or instructions for the field. */
3429
3471
  description?: RichContent;
3430
3472
  /**
3431
- * List of options to select from
3473
+ * List of options the submitter can select from.
3432
3474
  * @maxSize 400
3433
3475
  */
3434
3476
  options?: TagsOption[];
3435
3477
  /**
3436
- * Flag identifying to hide or not label
3437
- * Default: true
3478
+ * Whether to display the label.
3479
+ *
3480
+ * Default: `true`
3438
3481
  */
3439
3482
  showLabel?: boolean | null;
3440
- /** Option which can be specified by UoU, enabled when this object is specified. */
3483
+ /** Custom option which can be specified by the submitter. */
3441
3484
  customOption?: CustomOption;
3442
3485
  /**
3443
3486
  * Specifies the number of columns used to display the selections within the component.
3444
- * Default: ONE
3487
+ *
3488
+ * Default: `ONE`
3445
3489
  */
3446
3490
  numberOfColumns?: NumberOfColumnsWithLiterals;
3447
3491
  /** Media item. Media, associated with field, like image. */
3448
3492
  media?: MediaItem;
3449
- /** Settings for media item */
3493
+ /** Configuration for the media item. */
3450
3494
  mediaSettings?: MediaSettings;
3451
3495
  }
3452
3496
  interface TagsOption {
3453
3497
  /**
3454
- * Selectable option label
3498
+ * Selectable option label.
3455
3499
  * @maxLength 400
3456
3500
  */
3457
3501
  label?: string | null;
3458
- /** Selectable option value, which is saved to DB. */
3502
+ /** Value stored on submission when this option is selected. */
3459
3503
  value?: any;
3460
- /** Flag identifying that option should be selected by default */
3504
+ /** Flag identifying that option should be selected by default. */
3461
3505
  default?: boolean;
3462
3506
  /**
3463
3507
  * Option id. Used as binding for translations
@@ -3465,9 +3509,35 @@ interface TagsOption {
3465
3509
  * @immutable
3466
3510
  */
3467
3511
  _id?: string;
3468
- /** Media item. Media, associated with option, like image. */
3512
+ /** Media content associated with the option, such as an image. */
3469
3513
  media?: MediaItem;
3470
3514
  }
3515
+ interface ServicesCheckboxGroup {
3516
+ /**
3517
+ * Label of the field
3518
+ * @maxLength 350
3519
+ */
3520
+ label?: string | null;
3521
+ /** Description of the field */
3522
+ description?: RichContent;
3523
+ /**
3524
+ * List of options to select from
3525
+ * @maxSize 100
3526
+ */
3527
+ options?: ServiceOption[];
3528
+ /**
3529
+ * Flag identifying to hide or not label
3530
+ * Default: true
3531
+ */
3532
+ showLabel?: boolean | null;
3533
+ /** Option which can be specified by UoU, enabled when this object is specified. */
3534
+ customOption?: CustomOption;
3535
+ /**
3536
+ * Specifies the number of columns used to display the selections within the component.
3537
+ * Default: ONE
3538
+ */
3539
+ numberOfColumns?: NumberOfColumnsWithLiterals;
3540
+ }
3471
3541
  declare enum InputFieldWixFileComponentType {
3472
3542
  UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
3473
3543
  FILE_UPLOAD = "FILE_UPLOAD",
@@ -3477,13 +3547,13 @@ declare enum InputFieldWixFileComponentType {
3477
3547
  type InputFieldWixFileComponentTypeWithLiterals = InputFieldWixFileComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'FILE_UPLOAD' | 'SIGNATURE';
3478
3548
  interface FileType {
3479
3549
  /**
3480
- * Amount of files allowed to upload
3550
+ * Maximum number of files that can be uploaded.
3481
3551
  * @min 1
3482
3552
  * @max 30
3483
3553
  */
3484
3554
  fileLimit?: number;
3485
3555
  /**
3486
- * Supported file formats for upload
3556
+ * Supported file formats for uploaded files.
3487
3557
  * @maxSize 5
3488
3558
  */
3489
3559
  uploadFileFormats?: UploadFileFormatWithLiterals[];
@@ -3506,50 +3576,52 @@ declare enum UploadFileFormat {
3506
3576
  type UploadFileFormatWithLiterals = UploadFileFormat | 'UNKNOWN_UPLOAD_FILE_FORMAT' | 'VIDEO' | 'IMAGE' | 'AUDIO' | 'DOCUMENT' | 'ARCHIVE';
3507
3577
  interface FileUpload {
3508
3578
  /**
3509
- * Selectable option label
3579
+ * Field label.
3510
3580
  * @maxLength 350
3511
3581
  */
3512
3582
  label?: string | null;
3513
- /** Description of the field */
3583
+ /** Additional description or instructions for the field. */
3514
3584
  description?: RichContent;
3515
3585
  /**
3516
- * Flag identifying to hide or not label
3517
- * Default: true
3586
+ * Whether to display the field label.
3587
+ *
3588
+ * Default: `true`
3518
3589
  */
3519
3590
  showLabel?: boolean | null;
3520
3591
  /**
3521
- * Text on upload button
3592
+ * Text displayed on the upload button.
3522
3593
  * @maxLength 500
3523
3594
  */
3524
3595
  buttonText?: string | null;
3525
3596
  /**
3526
- * Custom text which appears when file is uploaded, if missing file name will be shown
3597
+ * Custom text displayed when a file is uploaded. If not specified, the file name is shown.
3527
3598
  * @maxLength 255
3528
3599
  */
3529
3600
  explanationText?: string | null;
3530
- /** Media item. Media, associated with field, like image. */
3601
+ /** Media content associated with the field, such as an image. */
3531
3602
  media?: MediaItem;
3532
- /** Settings for media item */
3603
+ /** Configuration for the media content. */
3533
3604
  mediaSettings?: MediaSettings;
3534
3605
  }
3535
3606
  interface Signature {
3536
3607
  /**
3537
- * Selectable option label
3608
+ * Field label.
3538
3609
  * @maxLength 350
3539
3610
  */
3540
3611
  label?: string | null;
3541
3612
  /**
3542
- * Flag identifying to hide label or not
3543
- * Default: true
3613
+ * Whether to display the field label.
3614
+ *
3615
+ * Default: `true`
3544
3616
  */
3545
3617
  showLabel?: boolean | null;
3546
- /** Description of the field */
3618
+ /** Additional description or instructions for the field. */
3547
3619
  description?: RichContent;
3548
- /** Is image upload enabled */
3620
+ /** Whether image upload is enabled for the signature field. */
3549
3621
  imageUploadEnabled?: boolean;
3550
- /** Media item. Media, associated with field, like image. */
3622
+ /** Media content associated with the field, such as an image. */
3551
3623
  media?: MediaItem;
3552
- /** Settings for media item */
3624
+ /** Configuration for the media item. */
3553
3625
  mediaSettings?: MediaSettings;
3554
3626
  }
3555
3627
  declare enum InputFieldPaymentComponentType {
@@ -3563,30 +3635,32 @@ declare enum InputFieldPaymentComponentType {
3563
3635
  type InputFieldPaymentComponentTypeWithLiterals = InputFieldPaymentComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX_GROUP' | 'DONATION_INPUT' | 'PAYMENT_INPUT' | 'FIXED_PAYMENT';
3564
3636
  interface ProductCheckboxGroup {
3565
3637
  /**
3566
- * Label of the field.
3638
+ * Field label.
3567
3639
  * @maxLength 350
3568
3640
  */
3569
3641
  label?: string | null;
3570
- /** Description of the field. */
3642
+ /** Additional description or instructions for the field. */
3571
3643
  description?: RichContent;
3572
3644
  /**
3573
- * List of options to select from.
3645
+ * List of product options the submitter can select from.
3574
3646
  * @maxSize 400
3575
3647
  */
3576
3648
  options?: ProductCheckboxGroupOption[];
3577
3649
  /**
3578
- * Flag identifying to hide or not label
3579
- * Default: true
3650
+ * Whether to display the field label.
3651
+ *
3652
+ * Default: `true`
3580
3653
  */
3581
3654
  showLabel?: boolean | null;
3582
3655
  /**
3583
- * Defines how an image should be resized to fit within its option.
3584
- * Default: COVER
3656
+ * How an image should be resized to fit within its option container.
3657
+ *
3658
+ * Default: `COVER`
3585
3659
  */
3586
3660
  imageFit?: ImageFitWithLiterals;
3587
- /** Media item. Media, associated with field, like image. */
3661
+ /** Media content associated with the field, such as an image. */
3588
3662
  media?: MediaItem;
3589
- /** Settings for media item */
3663
+ /** Configuration for the media content. */
3590
3664
  mediaSettings?: MediaSettings;
3591
3665
  }
3592
3666
  interface ProductCheckboxGroupOption {
@@ -3595,99 +3669,103 @@ interface ProductCheckboxGroupOption {
3595
3669
  * @maxLength 400
3596
3670
  */
3597
3671
  label?: string | null;
3598
- /** Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list. */
3672
+ /** Value stored on submission when this option is selected. Must match a product ID found in the field's products list. */
3599
3673
  value?: any;
3600
3674
  /**
3601
- * Option id. Used as binding for translations.
3675
+ * Option ID. Used to connect this option with [Wix Multilingual](https://dev.wix.com/docs/api-reference/business-management/multilingual/translation/introduction) for translation.
3602
3676
  * @format GUID
3603
3677
  * @immutable
3604
3678
  */
3605
3679
  _id?: string;
3606
- /** Media item. Media, associated with option, like image. */
3680
+ /** Media content associated with this option, such as an image. */
3607
3681
  media?: MediaItem;
3608
- /** Flag identifying that option should be selected by default */
3682
+ /** Whether this option is selected by default. */
3609
3683
  default?: boolean;
3610
3684
  }
3611
3685
  interface DonationInput {
3612
3686
  /**
3613
- * Label of the field.
3687
+ * Field label.
3614
3688
  * @maxLength 350
3615
3689
  */
3616
3690
  label?: string | null;
3617
- /** Description of the field. */
3691
+ /** Additional description or instructions for the field. */
3618
3692
  description?: RichContent;
3619
3693
  /**
3620
- * List of options to select from.
3694
+ * List of donation amount options the submitter can select from.
3621
3695
  * @maxSize 400
3622
3696
  */
3623
3697
  options?: DonationInputOption[];
3624
- /** Option which can be specified by UoU, enabled when this object is specified. */
3698
+ /** Custom option which can be specified by the submitter. */
3625
3699
  customOption?: CustomOption;
3626
3700
  /**
3627
3701
  * Specifies the number of columns used to display the selections within the component.
3628
- * Default: ONE
3702
+ *
3703
+ * Default: `ONE`
3629
3704
  */
3630
3705
  numberOfColumns?: NumberOfColumnsWithLiterals;
3631
3706
  /**
3632
- * Flag identifying to hide or not label
3633
- * Default: true
3707
+ * Whether to display the field label.
3708
+ *
3709
+ * Default: `true`
3634
3710
  */
3635
3711
  showLabel?: boolean | null;
3636
- /** Media item. Media, associated with field, like image. */
3712
+ /** Media content associated with the field, such as an image. */
3637
3713
  media?: MediaItem;
3638
- /** Settings for media item */
3714
+ /** Configuration for the media content. */
3639
3715
  mediaSettings?: MediaSettings;
3640
3716
  }
3641
3717
  interface DonationInputOption {
3642
3718
  /**
3643
- * Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list.
3719
+ * Value stored on submission when this option is selected. Must match a product ID found in the field's products list.
3644
3720
  * @format GUID
3645
3721
  */
3646
3722
  value?: string;
3647
- /** Flag identifying that option should be selected by default */
3723
+ /** Whether this option is selected by default. */
3648
3724
  default?: boolean;
3649
3725
  }
3650
3726
  interface PaymentInput {
3651
3727
  /**
3652
- * Label of the field.
3728
+ * Field label.
3653
3729
  * @maxLength 350
3654
3730
  */
3655
3731
  label?: string | null;
3656
- /** Description of the field. */
3732
+ /** Additional description or instructions for the field. */
3657
3733
  description?: RichContent;
3658
3734
  /**
3659
- * Flag identifying to hide or not label
3660
- * Default: true
3735
+ * Whether to display the field label.
3736
+ *
3737
+ * Default: `true`
3661
3738
  */
3662
3739
  showLabel?: boolean | null;
3663
3740
  /**
3664
- * Placeholder of custom option input
3741
+ * Placeholder text shown inside the field when it's empty.
3665
3742
  * @maxLength 100
3666
3743
  */
3667
3744
  placeholder?: string | null;
3668
- /** Default value for the payment input */
3745
+ /** Default value for the field. This value is pre-populated in the field when the form loads. */
3669
3746
  default?: number | null;
3670
- /** Media item. Media, associated with field, like image. */
3747
+ /** Media content associated with the field, such as an image. */
3671
3748
  media?: MediaItem;
3672
- /** Settings for media item */
3749
+ /** Configuration for the media content. */
3673
3750
  mediaSettings?: MediaSettings;
3674
3751
  }
3675
3752
  interface FixedPayment {
3676
3753
  /**
3677
- * Label of the field.
3754
+ * Field label.
3678
3755
  * @maxLength 350
3679
3756
  */
3680
3757
  label?: string | null;
3681
- /** Description of the field. */
3758
+ /** Additional description or instructions for the field. */
3682
3759
  description?: RichContent;
3683
3760
  /**
3684
- * Flag identifying to hide or not label
3685
- * Default: true
3761
+ * Whether to display the field label.
3762
+ *
3763
+ * Default: `true`
3686
3764
  */
3687
3765
  showLabel?: boolean | null;
3688
- /** Media item. Media, associated with field, like image. */
3766
+ /** Media content associated with the field, such as an image. */
3689
3767
  media?: MediaItem;
3690
- /** Settings for media item */
3768
+ /** Configuration for the media content. */
3691
3769
  mediaSettings?: MediaSettings;
3692
3770
  }
3693
3771
  declare enum InputFieldSchedulingComponentType {
@@ -3697,64 +3775,65 @@ declare enum InputFieldSchedulingComponentType {
3697
3775
  /** @enumType */
3698
3776
  type InputFieldSchedulingComponentTypeWithLiterals = InputFieldSchedulingComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'APPOINTMENT';
3699
3777
  interface Appointment extends AppointmentFormatInfoOneOf {
3700
- /** In person options for the appointment */
3778
+ /** Configuration for in-person appointments. */
3701
3779
  inPersonOptions?: InPersonOptions;
3702
- /** Online video conference options for the appointment */
3780
+ /** Configuration for video conference appointments. */
3703
3781
  videoConferenceOptions?: VideoConferenceOptions;
3704
- /** Phone options for the appointment */
3782
+ /** Configuration for phone appointments. */
3705
3783
  phoneOptions?: PhoneOptions;
3706
3784
  /**
3707
- * Label of the field
3785
+ * Field label.
3708
3786
  * @maxLength 255
3709
3787
  */
3710
3788
  label?: string | null;
3711
3789
  /**
3712
- * Name of the appointment
3790
+ * Appointment name.
3713
3791
  * @minLength 1
3714
3792
  * @maxLength 400
3715
3793
  */
3716
3794
  name?: string | null;
3717
3795
  /**
3718
- * Duration of the appointment in minutes
3796
+ * Duration of the appointment in minutes.
3719
3797
  * @min 1
3720
3798
  * @max 44639
3721
3799
  */
3722
3800
  durationInMinutes?: number | null;
3723
- /** Indicates whether manual approval is required for the appointment */
3801
+ /** Whether appointments require manual approval before confirmation. */
3724
3802
  manualApprovalRequired?: boolean | null;
3725
3803
  /**
3726
- * ID of the staff members providing the appointment
3804
+ * IDs of staff members who provide this service.
3727
3805
  * @maxSize 220
3728
3806
  * @format GUID
3729
3807
  */
3730
3808
  staffIds?: string[] | null;
3731
- /** The format of the appointment */
3809
+ /** Appointment format. */
3732
3810
  format?: FormatWithLiterals;
3733
- /** Description of the field */
3811
+ /** Additional description or instructions for the field. */
3734
3812
  description?: RichContent;
3735
3813
  /**
3736
- * Flag identifying to hide or not label
3737
- * Default: true
3814
+ * Whether to display the field label.
3815
+ *
3816
+ * Default: `true`
3738
3817
  */
3739
3818
  showLabel?: boolean | null;
3740
3819
  }
3741
3820
  /** @oneof */
3742
3821
  interface AppointmentFormatInfoOneOf {
3743
- /** In person options for the appointment */
3822
+ /** Configuration for in-person appointments. */
3744
3823
  inPersonOptions?: InPersonOptions;
3745
- /** Online video conference options for the appointment */
3824
+ /** Configuration for video conference appointments. */
3746
3825
  videoConferenceOptions?: VideoConferenceOptions;
3747
- /** Phone options for the appointment */
3826
+ /** Configuration for phone appointments. */
3748
3827
  phoneOptions?: PhoneOptions;
3749
3828
  }
3750
3829
  interface Location extends LocationLocationInfoOneOf {
3751
3830
  /**
3752
- * Custom address details
3831
+ * Custom address specified as a text string.
3753
3832
  * @maxLength 512
3754
3833
  */
3755
3834
  customAddress?: string | null;
3756
3835
  /**
3757
- * ID of a business location
3836
+ * ID of a predefined business [location](https://dev.wix.com/docs/rest/crm/members-contacts/locations/locations/introduction).
3758
3837
  * @format GUID
3759
3838
  */
3760
3839
  businessLocationId?: string | null;
@@ -3762,27 +3841,30 @@ interface Location extends LocationLocationInfoOneOf {
3762
3841
  /** @oneof */
3763
3842
  interface LocationLocationInfoOneOf {
3764
3843
  /**
3765
- * Custom address details
3844
+ * Custom address specified as a text string.
3766
3845
  * @maxLength 512
3767
3846
  */
3768
3847
  customAddress?: string | null;
3769
3848
  /**
3770
- * ID of a business location
3849
+ * ID of a predefined business [location](https://dev.wix.com/docs/rest/crm/members-contacts/locations/locations/introduction).
3771
3850
  * @format GUID
3772
3851
  */
3773
3852
  businessLocationId?: string | null;
3774
3853
  }
3775
3854
  declare enum Format {
3776
3855
  UNKNOWN_FORMAT_TYPE = "UNKNOWN_FORMAT_TYPE",
3856
+ /** Face-to-face meeting at a physical location. */
3777
3857
  IN_PERSON = "IN_PERSON",
3858
+ /** Online meeting via video conference. */
3778
3859
  VIDEO_CONFERENCE = "VIDEO_CONFERENCE",
3860
+ /** Appointment conducted over the phone. */
3779
3861
  PHONE = "PHONE"
3780
3862
  }
3781
3863
  /** @enumType */
3782
3864
  type FormatWithLiterals = Format | 'UNKNOWN_FORMAT_TYPE' | 'IN_PERSON' | 'VIDEO_CONFERENCE' | 'PHONE';
3783
3865
  interface InPersonOptions {
3784
3866
  /**
3785
- * The locations details
3867
+ * Physical locations where the appointment can take place.
3786
3868
  * @minSize 1
3787
3869
  * @maxSize 1
3788
3870
  */
@@ -3790,14 +3872,14 @@ interface InPersonOptions {
3790
3872
  }
3791
3873
  interface VideoConferenceOptions {
3792
3874
  /**
3793
- * Description or instructions for the online video conference
3875
+ * Description or instructions for video conference appointments.
3794
3876
  * @maxLength 512
3795
3877
  */
3796
3878
  description?: string | null;
3797
3879
  }
3798
3880
  interface PhoneOptions {
3799
3881
  /**
3800
- * Description or instructions for the phone appointment
3882
+ * Description or instructions for phone appointments.
3801
3883
  * @maxLength 512
3802
3884
  */
3803
3885
  description?: string | null;
@@ -3810,19 +3892,19 @@ declare enum MultilineAddressComponentType {
3810
3892
  type MultilineAddressComponentTypeWithLiterals = MultilineAddressComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'MULTILINE_ADDRESS';
3811
3893
  interface MultilineAddress {
3812
3894
  /**
3813
- * Label of the field.
3895
+ * Field label.
3814
3896
  * @maxLength 350
3815
3897
  */
3816
3898
  label?: string | null;
3817
- /** Description of the field. */
3899
+ /** Additional description or instructions for the field. */
3818
3900
  description?: RichContent;
3819
- /** Show country flags. */
3901
+ /** Whether to display country flags in the country selection. */
3820
3902
  showCountryFlags?: boolean;
3821
- /** Default country configuration. */
3903
+ /** Default country configuration for the address field. */
3822
3904
  defaultCountryConfig?: DefaultCountryConfig;
3823
3905
  /** Fields settings. */
3824
3906
  fieldSettings?: FieldsSettings;
3825
- /** Autocomplete enabled for address line field. */
3907
+ /** Whether autocomplete is enabled for the address line field. */
3826
3908
  autocompleteEnabled?: boolean;
3827
3909
  /**
3828
3910
  * Flag identifying whether to show or hide the address labels.
@@ -3836,9 +3918,9 @@ interface MultilineAddress {
3836
3918
  showLabel?: boolean | null;
3837
3919
  }
3838
3920
  declare enum Type {
3839
- /** Unknown default country config type. */
3921
+ /** Unknown default country configuration type. */
3840
3922
  UNKNOWN_DEFAULT_COUNTRY = "UNKNOWN_DEFAULT_COUNTRY",
3841
- /** Country is determined by customer's IP address. */
3923
+ /** Country is determined by the submitter's IP address. */
3842
3924
  BY_IP = "BY_IP",
3843
3925
  /** Pre-selected default country. */
3844
3926
  COUNTRY = "COUNTRY"
@@ -3846,12 +3928,12 @@ declare enum Type {
3846
3928
  /** @enumType */
3847
3929
  type TypeWithLiterals = Type | 'UNKNOWN_DEFAULT_COUNTRY' | 'BY_IP' | 'COUNTRY';
3848
3930
  interface AddressLine2 {
3849
- /** Show address line 2 field. */
3931
+ /** Whether to display the address line 2 field. */
3850
3932
  show?: boolean;
3851
3933
  }
3852
3934
  interface DefaultCountryConfig extends DefaultCountryConfigOptionsOneOf {
3853
3935
  /**
3854
- * Country.
3936
+ * Country code for the pre-selected default country. Two-letter country code in ISO-3166 alpha-2 format.
3855
3937
  * @format COUNTRY
3856
3938
  */
3857
3939
  countryOptions?: string;
@@ -3861,13 +3943,13 @@ interface DefaultCountryConfig extends DefaultCountryConfigOptionsOneOf {
3861
3943
  /** @oneof */
3862
3944
  interface DefaultCountryConfigOptionsOneOf {
3863
3945
  /**
3864
- * Country.
3946
+ * Country code for the pre-selected default country. Two-letter country code in ISO-3166 alpha-2 format.
3865
3947
  * @format COUNTRY
3866
3948
  */
3867
3949
  countryOptions?: string;
3868
3950
  }
3869
3951
  interface FieldsSettings {
3870
- /** Address line 2. */
3952
+ /** Configuration for the address line 2 field. */
3871
3953
  addressLine2?: AddressLine2;
3872
3954
  }
3873
3955
  declare enum InputFieldInputType {
@@ -3893,9 +3975,9 @@ interface V4FormFieldContactInfo extends V4FormFieldContactInfoAdditionalInfoOne
3893
3975
  addressInfo?: FormFieldContactInfoAddressInfo;
3894
3976
  /** Custom field info. */
3895
3977
  customFieldInfo?: FormFieldContactInfoCustomFieldInfo;
3896
- /** Subscription info */
3978
+ /** Subscription info. */
3897
3979
  subscriptionInfo?: FormFieldContactInfoSubscriptionInfo;
3898
- /** Field mapped to contacts. */
3980
+ /** The contact field that the form field maps to. */
3899
3981
  contactField?: FormFieldContactInfoContactFieldWithLiterals;
3900
3982
  }
3901
3983
  /** @oneof */
@@ -3908,46 +3990,67 @@ interface V4FormFieldContactInfoAdditionalInfoOneOf {
3908
3990
  addressInfo?: FormFieldContactInfoAddressInfo;
3909
3991
  /** Custom field info. */
3910
3992
  customFieldInfo?: FormFieldContactInfoCustomFieldInfo;
3911
- /** Subscription info */
3993
+ /** Subscription info. */
3912
3994
  subscriptionInfo?: FormFieldContactInfoSubscriptionInfo;
3913
3995
  }
3914
3996
  declare enum FormFieldContactInfoEmailInfoTag {
3997
+ /** Email without a specific tag. */
3915
3998
  UNTAGGED = "UNTAGGED",
3999
+ /** Primary email address for the contact. */
3916
4000
  MAIN = "MAIN"
3917
4001
  }
3918
4002
  /** @enumType */
3919
4003
  type FormFieldContactInfoEmailInfoTagWithLiterals = FormFieldContactInfoEmailInfoTag | 'UNTAGGED' | 'MAIN';
3920
4004
  declare enum FormFieldContactInfoPhoneInfoTag {
4005
+ /** Phone number without a specific tag. */
3921
4006
  UNTAGGED = "UNTAGGED",
4007
+ /** Primary phone number for the contact. */
3922
4008
  MAIN = "MAIN"
3923
4009
  }
3924
4010
  /** @enumType */
3925
4011
  type FormFieldContactInfoPhoneInfoTagWithLiterals = FormFieldContactInfoPhoneInfoTag | 'UNTAGGED' | 'MAIN';
3926
4012
  declare enum AddressInfoTag {
4013
+ /** Address without a specific tag. */
3927
4014
  UNTAGGED = "UNTAGGED",
4015
+ /** Home address for the contact. */
3928
4016
  HOME = "HOME"
3929
4017
  }
3930
4018
  /** @enumType */
3931
4019
  type AddressInfoTagWithLiterals = AddressInfoTag | 'UNTAGGED' | 'HOME';
3932
4020
  declare enum SubscriptionInfoOptInLevel {
4021
+ /** Unknown opt-in level. */
3933
4022
  UNKNOWN = "UNKNOWN",
4023
+ /** Single confirmation opt-in. The contact is subscribed immediately. */
3934
4024
  SINGLE_CONFIRMATION = "SINGLE_CONFIRMATION",
4025
+ /** Double confirmation opt-in. The contact must confirm their subscription via email. */
3935
4026
  DOUBLE_CONFIRMATION = "DOUBLE_CONFIRMATION"
3936
4027
  }
3937
4028
  /** @enumType */
3938
4029
  type SubscriptionInfoOptInLevelWithLiterals = SubscriptionInfoOptInLevel | 'UNKNOWN' | 'SINGLE_CONFIRMATION' | 'DOUBLE_CONFIRMATION';
3939
4030
  declare enum FormFieldContactInfoContactField {
4031
+ /** Unknown contact field. */
3940
4032
  UNDEFINED = "UNDEFINED",
4033
+ /** First name. */
3941
4034
  FIRST_NAME = "FIRST_NAME",
4035
+ /** CLast name. */
3942
4036
  LAST_NAME = "LAST_NAME",
4037
+ /** Company name. */
3943
4038
  COMPANY = "COMPANY",
4039
+ /** Job position or title. */
3944
4040
  POSITION = "POSITION",
4041
+ /** Email address. */
3945
4042
  EMAIL = "EMAIL",
4043
+ /** Phone number. */
3946
4044
  PHONE = "PHONE",
4045
+ /** Physical address. */
3947
4046
  ADDRESS = "ADDRESS",
4047
+ /** Birth date. */
3948
4048
  BIRTHDATE = "BIRTHDATE",
4049
+ /** Custom field. */
3949
4050
  CUSTOM_FIELD = "CUSTOM_FIELD",
4051
+ /** Subscription status. */
3950
4052
  SUBSCRIPTION = "SUBSCRIPTION",
4053
+ /** VAT identification number. */
3951
4054
  VAT_ID = "VAT_ID"
3952
4055
  }
3953
4056
  /** @enumType */
@@ -3974,8 +4077,8 @@ interface FormFieldContactInfoCustomFieldInfo {
3974
4077
  }
3975
4078
  interface FormFieldContactInfoSubscriptionInfo {
3976
4079
  /**
3977
- * Subscription consent opt in level, either single or double confirmation.
3978
- * Default: SINGLE_CONFIRMATION
4080
+ * Subscription consent opt-in level.
4081
+ * Default: `SINGLE_CONFIRMATION`
3979
4082
  */
3980
4083
  optInLevel?: SubscriptionInfoOptInLevelWithLiterals;
3981
4084
  }
@@ -4068,6 +4171,8 @@ interface InputField_Array extends InputField_ArrayComponentTypeOptionsOneOf {
4068
4171
  checkboxGroupOptions?: CheckboxGroup;
4069
4172
  /** Tags input field */
4070
4173
  tagsOptions?: Tags;
4174
+ /** Services checkbox group input field */
4175
+ servicesCheckboxGroupOptions?: ServicesCheckboxGroup;
4071
4176
  /** Validation of array type. */
4072
4177
  validation?: InputFieldArrayType;
4073
4178
  /**
@@ -4082,6 +4187,8 @@ interface InputField_ArrayComponentTypeOptionsOneOf {
4082
4187
  checkboxGroupOptions?: CheckboxGroup;
4083
4188
  /** Tags input field */
4084
4189
  tagsOptions?: Tags;
4190
+ /** Services checkbox group input field */
4191
+ servicesCheckboxGroupOptions?: ServicesCheckboxGroup;
4085
4192
  }
4086
4193
  interface InputField_Object extends InputField_ObjectValidationOneOf {
4087
4194
  /** Validation of object type. */
@@ -4249,250 +4356,297 @@ interface FormFieldV2InputFieldInputTypeOptionsOneOf {
4249
4356
  }
4250
4357
  /** Copy of the entity existing in form template project, needed to hide translations. */
4251
4358
  interface DisplayField extends DisplayFieldDisplayFieldTypeOptionsOneOf {
4252
- /** Component displaying rich content */
4359
+ /** Configuration for rich content display fields. */
4253
4360
  richContentOptions?: V4RichContentOptions;
4254
- /** Page navigation component resolving as navigation or submit buttons */
4361
+ /** Configuration for page navigation display fields. */
4255
4362
  pageNavigationOptions?: V4PageNavigationOptions;
4256
- /** Type of the display field */
4363
+ /** Type of display field that determines its appearance and behavior. */
4257
4364
  displayFieldType?: DisplayFieldTypeWithLiterals;
4258
4365
  }
4259
4366
  /** @oneof */
4260
4367
  interface DisplayFieldDisplayFieldTypeOptionsOneOf {
4261
- /** Component displaying rich content */
4368
+ /** Configuration for rich content display fields. */
4262
4369
  richContentOptions?: V4RichContentOptions;
4263
- /** Page navigation component resolving as navigation or submit buttons */
4370
+ /** Configuration for page navigation display fields. */
4264
4371
  pageNavigationOptions?: V4PageNavigationOptions;
4265
4372
  }
4266
4373
  declare enum DisplayFieldType {
4374
+ /** Unknown display field type. */
4267
4375
  UNKNOWN_FIELD_TYPE = "UNKNOWN_FIELD_TYPE",
4376
+ /** Rich content element for displaying formatted text, images, and media. */
4268
4377
  RICH_CONTENT = "RICH_CONTENT",
4378
+ /** Navigation element with buttons for moving between form pages or submitting. */
4269
4379
  PAGE_NAVIGATION = "PAGE_NAVIGATION"
4270
4380
  }
4271
4381
  /** @enumType */
4272
4382
  type DisplayFieldTypeWithLiterals = DisplayFieldType | 'UNKNOWN_FIELD_TYPE' | 'RICH_CONTENT' | 'PAGE_NAVIGATION';
4273
4383
  interface V4RichContentOptions {
4274
- /** Content of the header */
4384
+ /** Rich content to display, including formatted text, images, and embedded media. */
4275
4385
  richContent?: RichContent;
4276
- /** Number of paragraphs visible. Other part is hidden under expandable section. If not provided all text visible. */
4386
+ /**
4387
+ * Maximum number of paragraphs to show initially.
4388
+ * Additional content is hidden behind an expandable section. If not specified, all content is visible.
4389
+ */
4277
4390
  maxShownParagraphs?: number | null;
4278
4391
  }
4279
4392
  interface V4PageNavigationOptions {
4280
4393
  /**
4281
- * When button is not on last page it behaves as switch between pages page, text of label to go to next page.
4394
+ * Text displayed on the button when it navigates to the next page.
4395
+ * Only applicable when the button is not on the final form page.
4282
4396
  * @maxLength 65
4283
4397
  */
4284
4398
  nextPageText?: string | null;
4285
4399
  /**
4286
- * When button is not on last page it behaves as switch between pages page, text of label to go to previous page.
4400
+ * Text displayed on the button when it navigates to the previous page.
4401
+ * Only applicable when the button is not on the first form page.
4287
4402
  * @maxLength 65
4288
4403
  */
4289
4404
  previousPageText?: string | null;
4290
4405
  /**
4291
- * Text on the button when button is submitting a form
4406
+ * Text displayed on the button when it submits the form.
4407
+ * Only applicable when the button is on the final form page.
4292
4408
  * @maxLength 65
4293
4409
  */
4294
4410
  submitText?: string | null;
4295
4411
  }
4296
4412
  interface Field extends FieldFieldTypeOptionsOneOf {
4297
- /** Field accept input of data */
4413
+ /** Configuration for input fields that collect user data. */
4298
4414
  inputOptions?: InputField;
4299
- /** Field for displaying information such as header or text paragraph */
4415
+ /** Configuration for display fields that show information without collecting input. */
4300
4416
  displayOptions?: FieldsDisplayField;
4301
4417
  /**
4302
- * Field id.
4418
+ * Field ID.
4303
4419
  * @format GUID
4304
4420
  * @immutable
4305
4421
  */
4306
4422
  _id?: string;
4307
4423
  /**
4308
- * Whether the field is hidden.
4309
- * Default: false
4424
+ * Whether the field is hidden from submitters.
4425
+ *
4426
+ * Default: `false`
4310
4427
  */
4311
4428
  hidden?: boolean;
4312
4429
  /**
4313
- * Custom identification of field, can be used to specify exceptional behaviour of client for specific field
4430
+ * Custom identification for the field. This is intended as a way for you to identify certain fields that you want to apply special behavior to in your own logic.
4314
4431
  * @maxLength 50
4315
4432
  */
4316
4433
  identifier?: string | null;
4317
4434
  /**
4318
- * Type of the field
4435
+ * Field type.
4319
4436
  * @readonly
4320
4437
  */
4321
4438
  fieldType?: FieldTypeWithLiterals;
4322
4439
  }
4323
4440
  /** @oneof */
4324
4441
  interface FieldFieldTypeOptionsOneOf {
4325
- /** Field accept input of data */
4442
+ /** Configuration for input fields that collect user data. */
4326
4443
  inputOptions?: InputField;
4327
- /** Field for displaying information such as header or text paragraph */
4444
+ /** Configuration for display fields that show information without collecting input. */
4328
4445
  displayOptions?: FieldsDisplayField;
4329
4446
  }
4330
4447
  declare enum FieldType {
4448
+ /** Unknown field type. */
4331
4449
  UNKNOWN_FIELD_TYPE = "UNKNOWN_FIELD_TYPE",
4450
+ /** Input field that collects data from users. */
4332
4451
  INPUT = "INPUT",
4452
+ /** Display field that shows information without collecting input. */
4333
4453
  DISPLAY = "DISPLAY"
4334
4454
  }
4335
4455
  /** @enumType */
4336
4456
  type FieldTypeWithLiterals = FieldType | 'UNKNOWN_FIELD_TYPE' | 'INPUT' | 'DISPLAY';
4337
4457
  interface InputField extends InputFieldInputTypeOptionsOneOf {
4338
- /** Input return string as value */
4458
+ /** String input field settings. */
4339
4459
  stringOptions?: _String;
4340
- /** Input return number as value */
4460
+ /** Number input field settings. */
4341
4461
  numberOptions?: _Number;
4342
- /** Input return boolean as value */
4462
+ /** Boolean input field settings. */
4343
4463
  booleanOptions?: _Boolean;
4344
- /** Input return array as value */
4464
+ /** Array input field settings. */
4345
4465
  arrayOptions?: _Array;
4346
- /** Input return object as value */
4466
+ /** Object input field settings. */
4347
4467
  objectOptions?: _Object;
4348
- /** Input return "Wix file" as value */
4468
+ /** File input field settings. Files are uploaded to the [Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager). */
4349
4469
  wixFileOptions?: WixFile;
4350
- /** Input returns selected products as value. */
4470
+ /** Payment input field settings. */
4351
4471
  paymentOptions?: Payment;
4352
- /** Input returns scheduling as value. */
4472
+ /** Scheduling input field settings. */
4353
4473
  schedulingOptions?: Scheduling;
4354
- /** Input returns multiline address as value. */
4474
+ /** Address input field settings. */
4355
4475
  addressOptions?: Address;
4356
4476
  /**
4357
- * Definition of a target where the value of field belongs.
4477
+ * Human readable identifier used to reference a field. For example, `"address"`.
4478
+ *
4479
+ * Can be set once.
4358
4480
  * @minLength 1
4359
4481
  * @maxLength 200
4360
4482
  * @immutable
4361
4483
  */
4362
4484
  target?: string;
4363
4485
  /**
4364
- * Mark the field as containing personal information. This will encrypt user data when storing it.
4365
- * Default: false
4486
+ * Whether this field contains Personally Identifiable Information (PII).
4487
+ *
4488
+ * PII fields are automatically encrypted when stored.
4489
+ *
4490
+ * Default: `false`
4366
4491
  */
4367
4492
  pii?: boolean;
4368
4493
  /**
4369
- * Whether the field is required.
4370
- * Default: false
4494
+ * Whether the field is required for form submission.
4495
+ *
4496
+ * Default: `false`
4371
4497
  */
4372
4498
  required?: boolean;
4373
4499
  /**
4374
- * Type of the input field
4500
+ * Type of the input field that determines what kind of data it collects.
4375
4501
  * @readonly
4376
4502
  */
4377
4503
  inputType?: InputTypeWithLiterals;
4378
- /** Mapping to contacts, telling to what contact property field input value should be saved. */
4504
+ /**
4505
+ * Mapping configuration for automatically saving field values to contact properties.
4506
+ *
4507
+ * When specified, form submissions automatically create or update contacts with the field data.
4508
+ */
4379
4509
  contactMapping?: FormFieldContactInfo;
4380
4510
  /**
4381
- * Whether the field is read only.
4382
- * Default: false
4511
+ * Whether the field is read-only.
4512
+ *
4513
+ * Default: `false`
4383
4514
  */
4384
4515
  readOnly?: boolean;
4385
4516
  }
4386
4517
  /** @oneof */
4387
4518
  interface InputFieldInputTypeOptionsOneOf {
4388
- /** Input return string as value */
4519
+ /** String input field settings. */
4389
4520
  stringOptions?: _String;
4390
- /** Input return number as value */
4521
+ /** Number input field settings. */
4391
4522
  numberOptions?: _Number;
4392
- /** Input return boolean as value */
4523
+ /** Boolean input field settings. */
4393
4524
  booleanOptions?: _Boolean;
4394
- /** Input return array as value */
4525
+ /** Array input field settings. */
4395
4526
  arrayOptions?: _Array;
4396
- /** Input return object as value */
4527
+ /** Object input field settings. */
4397
4528
  objectOptions?: _Object;
4398
- /** Input return "Wix file" as value */
4529
+ /** File input field settings. Files are uploaded to the [Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager). */
4399
4530
  wixFileOptions?: WixFile;
4400
- /** Input returns selected products as value. */
4531
+ /** Payment input field settings. */
4401
4532
  paymentOptions?: Payment;
4402
- /** Input returns scheduling as value. */
4533
+ /** Scheduling input field settings. */
4403
4534
  schedulingOptions?: Scheduling;
4404
- /** Input returns multiline address as value. */
4535
+ /** Address input field settings. */
4405
4536
  addressOptions?: Address;
4406
4537
  }
4407
4538
  interface StringType extends StringTypeFormatOptionsOneOf {
4408
- /** DATE format options */
4539
+ /** Validation rules for strings with date format. */
4409
4540
  dateOptions?: DateTimeConstraints;
4410
- /** DATE_TIME format options */
4541
+ /** Validation rules for strings with date and time format. */
4411
4542
  dateTimeOptions?: DateTimeConstraints;
4412
- /** TIME format options */
4543
+ /** Validation rules for strings with time format. */
4413
4544
  timeOptions?: DateTimeConstraints;
4414
- /** DATE_OPTIONAL_TIME format options */
4545
+ /** Validation rules for string with date and time format, where time is optional. */
4415
4546
  dateOptionalTimeOptions?: DateTimeConstraints;
4416
- /** PHONE format options */
4547
+ /** Validation rules for strings with phone number format. */
4417
4548
  phoneOptions?: PhoneConstraints;
4418
4549
  /**
4419
- * Minimum length.
4550
+ * Minimum required length for the string value.
4420
4551
  * @max 20000
4421
4552
  */
4422
4553
  minLength?: number | null;
4423
4554
  /**
4424
- * Maximum length.
4555
+ * Maximum allowed length for the string value.
4425
4556
  * @max 20000
4426
4557
  */
4427
4558
  maxLength?: number | null;
4428
4559
  /**
4429
- * Pattern for a regular expression match.
4560
+ * Regular expression pattern that the string value must match.
4430
4561
  * @maxLength 500
4431
4562
  */
4432
4563
  pattern?: string | null;
4433
- /** Format of a string. */
4564
+ /** Expected format of the string value. */
4434
4565
  format?: FormatEnumFormatWithLiterals;
4435
4566
  /**
4436
- * List of allowed values.
4567
+ * List of specific values that are allowed for this field.
4568
+ * When specified, the input must match one of these predefined values.
4437
4569
  * @maxSize 500
4438
4570
  * @maxLength 20000
4439
4571
  */
4440
4572
  enum?: string[] | null;
4441
- /** User defined error messages when particular validation constraint fails */
4573
+ /** Custom error messages displayed when validation fails. */
4442
4574
  validationMessages?: ValidationMessages;
4443
4575
  }
4444
4576
  /** @oneof */
4445
4577
  interface StringTypeFormatOptionsOneOf {
4446
- /** DATE format options */
4578
+ /** Validation rules for strings with date format. */
4447
4579
  dateOptions?: DateTimeConstraints;
4448
- /** DATE_TIME format options */
4580
+ /** Validation rules for strings with date and time format. */
4449
4581
  dateTimeOptions?: DateTimeConstraints;
4450
- /** TIME format options */
4582
+ /** Validation rules for strings with time format. */
4451
4583
  timeOptions?: DateTimeConstraints;
4452
- /** DATE_OPTIONAL_TIME format options */
4584
+ /** Validation rules for string with date and time format, where time is optional. */
4453
4585
  dateOptionalTimeOptions?: DateTimeConstraints;
4454
- /** PHONE format options */
4586
+ /** Validation rules for strings with phone number format. */
4455
4587
  phoneOptions?: PhoneConstraints;
4456
4588
  }
4457
4589
  declare enum FormatEnumFormat {
4590
+ /** Unknown format. */
4458
4591
  UNKNOWN_FORMAT = "UNKNOWN_FORMAT",
4592
+ /** Date format. */
4459
4593
  DATE = "DATE",
4594
+ /** Time format. */
4460
4595
  TIME = "TIME",
4596
+ /** Date and time format. */
4461
4597
  DATE_TIME = "DATE_TIME",
4598
+ /** Email format. */
4462
4599
  EMAIL = "EMAIL",
4600
+ /** URL format. */
4463
4601
  URL = "URL",
4602
+ /** UUID format. */
4464
4603
  UUID = "UUID",
4604
+ /** Phone number format. */
4465
4605
  PHONE = "PHONE",
4606
+ /** URI format. */
4466
4607
  URI = "URI",
4608
+ /** Hostname format. */
4467
4609
  HOSTNAME = "HOSTNAME",
4610
+ /** Hexadecimal color code format. */
4468
4611
  COLOR_HEX = "COLOR_HEX",
4612
+ /** Currency format. */
4469
4613
  CURRENCY = "CURRENCY",
4614
+ /** Language code format. */
4470
4615
  LANGUAGE = "LANGUAGE",
4616
+ /** Date with optional time format. */
4471
4617
  DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
4472
4618
  }
4473
4619
  /** @enumType */
4474
4620
  type FormatEnumFormatWithLiterals = FormatEnumFormat | 'UNKNOWN_FORMAT' | 'DATE' | 'TIME' | 'DATE_TIME' | 'EMAIL' | 'URL' | 'UUID' | 'PHONE' | 'URI' | 'HOSTNAME' | 'COLOR_HEX' | 'CURRENCY' | 'LANGUAGE' | 'DATE_OPTIONAL_TIME';
4475
4621
  interface DateTimeConstraints {
4476
4622
  /**
4477
- * Support static constrains defined as ISO date/time format, as well as
4478
- * dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
4479
- * The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
4480
- * The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
4623
+ * Minimum allowed datetime value.
4624
+ *
4625
+ * Supports ISO datetime format or dynamic calculations using "$now" keyword.
4626
+ * The dynamic calculation supports times in the future and past.
4627
+ * The pattern for dynamic calculations: $now([+-]\d{1,2})([yMdmh]).
4628
+ *
4629
+ * Examples: `"2023-01-01"`, `"$now-1d"` (1 day ago), `"$now+2h"` (2 hours from now).
4481
4630
  * @maxLength 50
4482
4631
  */
4483
4632
  minimum?: string | null;
4484
4633
  /**
4485
- * Support static constrains defined as ISO date/time format, as well as
4486
- * dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
4487
- * The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
4488
- * The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
4634
+ * Maximum allowed datetime value.
4635
+ *
4636
+ * Supports ISO datetime format or dynamic calculations using "$now" keyword.
4637
+ * The dynamic calculation supports times in the future and past.
4638
+ * The pattern for dynamic calculations: $now([+-]\d{1,2})([yMdmh]).
4639
+ *
4640
+ * Examples: `"2023-01-01"`, `"$now-1d"` (1 day ago), `"$now+2h"` (2 hours from now).
4489
4641
  * @maxLength 50
4490
4642
  */
4491
4643
  maximum?: string | null;
4492
4644
  }
4493
4645
  interface PhoneConstraints {
4494
4646
  /**
4495
- * Country codes for phone number that are allowed
4647
+ * Country codes that are allowed for phone number validation.
4648
+ *
4649
+ * Use ISO 3166-1 alpha-2 country codes. For example, `"US"`, `"GB"`, `"CA"`.
4496
4650
  * @maxSize 250
4497
4651
  * @maxLength 2
4498
4652
  */
@@ -4500,31 +4654,43 @@ interface PhoneConstraints {
4500
4654
  }
4501
4655
  interface ValidationMessages {
4502
4656
  /**
4503
- * Error message shown when validation of patter fails
4657
+ * Error message shown when the pattern validation fails.
4658
+ *
4659
+ * This message is displayed to users when their input doesn't match the specified regex pattern.
4504
4660
  * @maxLength 200
4505
4661
  */
4506
4662
  pattern?: string | null;
4507
4663
  }
4508
4664
  declare enum StringComponentType {
4665
+ /** Unknown component type. */
4509
4666
  UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
4667
+ /** Text input component. */
4510
4668
  TEXT_INPUT = "TEXT_INPUT",
4669
+ /** Radio group component. */
4511
4670
  RADIO_GROUP = "RADIO_GROUP",
4671
+ /** Dropdown component. */
4512
4672
  DROPDOWN = "DROPDOWN",
4673
+ /** Date and time component. */
4513
4674
  DATE_TIME = "DATE_TIME",
4675
+ /** Phone number component. */
4514
4676
  PHONE_INPUT = "PHONE_INPUT",
4677
+ /** Date selection component. */
4515
4678
  DATE_INPUT = "DATE_INPUT",
4679
+ /** Time selection component. */
4516
4680
  TIME_INPUT = "TIME_INPUT",
4681
+ /** Calendar-style date picker component. */
4517
4682
  DATE_PICKER = "DATE_PICKER",
4683
+ /** Dropdown component for selecting available services. */
4518
4684
  SERVICES_DROPDOWN = "SERVICES_DROPDOWN"
4519
4685
  }
4520
4686
  /** @enumType */
4521
4687
  type StringComponentTypeWithLiterals = StringComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'TEXT_INPUT' | 'RADIO_GROUP' | 'DROPDOWN' | 'DATE_TIME' | 'PHONE_INPUT' | 'DATE_INPUT' | 'TIME_INPUT' | 'DATE_PICKER' | 'SERVICES_DROPDOWN';
4522
4688
  interface NumberType {
4523
- /** Inclusive maximum value. */
4689
+ /** The maximum value of the number. Inclusive. */
4524
4690
  maximum?: number | null;
4525
- /** Inclusive minimum value. */
4691
+ /** The minimum value of the number. Inclusive. */
4526
4692
  minimum?: number | null;
4527
- /** Multiple of value. */
4693
+ /** A number that the value must be a multiple of. */
4528
4694
  multipleOf?: number | null;
4529
4695
  /**
4530
4696
  * List of allowed values.
@@ -4533,8 +4699,11 @@ interface NumberType {
4533
4699
  enum?: number[] | null;
4534
4700
  }
4535
4701
  declare enum NumberComponentType {
4702
+ /** Unknown component type. */
4536
4703
  UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
4704
+ /** Numeric input component. */
4537
4705
  NUMBER_INPUT = "NUMBER_INPUT",
4706
+ /** Rating input component. */
4538
4707
  RATING_INPUT = "RATING_INPUT"
4539
4708
  }
4540
4709
  /** @enumType */
@@ -4547,228 +4716,286 @@ interface BooleanType {
4547
4716
  enum?: boolean[];
4548
4717
  }
4549
4718
  declare enum BooleanComponentType {
4719
+ /** Unknown component type. */
4550
4720
  UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
4721
+ /** Checkbox component. */
4551
4722
  CHECKBOX = "CHECKBOX"
4552
4723
  }
4553
4724
  /** @enumType */
4554
4725
  type BooleanComponentTypeWithLiterals = BooleanComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX';
4555
4726
  interface ArrayType {
4556
4727
  /**
4557
- * Maximum amount of array elements.
4728
+ * Maximum number of elements allowed in the array.
4558
4729
  * @max 1000
4559
4730
  */
4560
4731
  maxItems?: number | null;
4561
4732
  /**
4562
- * Minimum amount of array elements.
4733
+ * Minimum number of elements required in the array.
4563
4734
  * @max 1000
4564
4735
  */
4565
4736
  minItems?: number | null;
4566
- /** Type of items allowed in array. */
4737
+ /** Type of items allowed in the array. */
4567
4738
  items?: ArrayItems;
4568
4739
  }
4569
4740
  declare enum ItemType {
4741
+ /** Unknown item type. */
4570
4742
  UNKNOWN_ITEM_TYPE = "UNKNOWN_ITEM_TYPE",
4743
+ /** Array can contain string values. */
4571
4744
  STRING = "STRING",
4745
+ /** Array can contain numeric values. */
4572
4746
  NUMBER = "NUMBER",
4747
+ /** Array can contain boolean values. */
4573
4748
  BOOLEAN = "BOOLEAN",
4749
+ /** Array can contain object values. */
4574
4750
  OBJECT = "OBJECT"
4575
4751
  }
4576
4752
  /** @enumType */
4577
4753
  type ItemTypeWithLiterals = ItemType | 'UNKNOWN_ITEM_TYPE' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'OBJECT';
4578
4754
  interface ObjectType {
4579
- /** Description of object properties. */
4755
+ /** Definition of object properties and their validation rules. */
4580
4756
  properties?: Record<string, PropertiesType>;
4581
4757
  }
4582
4758
  declare enum PropertiesTypeEnum {
4759
+ /** Unknown property type. */
4583
4760
  UNKNOWN_PROPERTY_TYPE = "UNKNOWN_PROPERTY_TYPE",
4761
+ /** Property must contain a string value. */
4584
4762
  STRING = "STRING",
4763
+ /** Property must contain a numeric value. */
4585
4764
  NUMBER = "NUMBER",
4765
+ /** Property must contain a boolean value. */
4586
4766
  BOOLEAN = "BOOLEAN",
4767
+ /** Property must contain an array. */
4587
4768
  ARRAY = "ARRAY"
4588
4769
  }
4589
4770
  /** @enumType */
4590
4771
  type PropertiesTypeEnumWithLiterals = PropertiesTypeEnum | 'UNKNOWN_PROPERTY_TYPE' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'ARRAY';
4591
4772
  interface PropertiesType extends PropertiesTypePropertiesTypeOptionsOneOf {
4592
- /** String type validation for property. */
4773
+ /** Validation rules for string properties. */
4593
4774
  stringOptions?: StringType;
4594
- /** Number type validation for property. */
4775
+ /** Validation rules for numeric properties. */
4595
4776
  numberOptions?: NumberType;
4596
- /** Boolean type validation for property. */
4777
+ /** Validation rules for boolean properties. */
4597
4778
  booleanOptions?: BooleanType;
4598
- /** Array type validation for property. */
4779
+ /** Validation rules for array properties. */
4599
4780
  arrayOptions?: ArrayType;
4600
4781
  /**
4601
- * Type of object properties
4782
+ * Data type of the object property.
4602
4783
  * @readonly
4603
4784
  */
4604
4785
  propertiesType?: PropertiesTypeEnumWithLiterals;
4605
- /** Whether the property is required. */
4786
+ /** Whether the object property is required for validation. */
4606
4787
  required?: boolean;
4607
4788
  }
4608
4789
  /** @oneof */
4609
4790
  interface PropertiesTypePropertiesTypeOptionsOneOf {
4610
- /** String type validation for property. */
4791
+ /** Validation rules for string properties. */
4611
4792
  stringOptions?: StringType;
4612
- /** Number type validation for property. */
4793
+ /** Validation rules for numeric properties. */
4613
4794
  numberOptions?: NumberType;
4614
- /** Boolean type validation for property. */
4795
+ /** Validation rules for boolean properties. */
4615
4796
  booleanOptions?: BooleanType;
4616
- /** Array type validation for property. */
4797
+ /** Validation rules for array properties. */
4617
4798
  arrayOptions?: ArrayType;
4618
4799
  }
4619
4800
  interface ArrayItems extends ArrayItemsItemTypeOptionsOneOf {
4620
- /** String type validation for items. */
4801
+ /** Validation rules for string array elements. */
4621
4802
  stringOptions?: StringType;
4622
- /** Number type validation for items. */
4803
+ /** Validation rules for numeric array elements. */
4623
4804
  numberOptions?: NumberType;
4624
- /** Boolean type validation for items. */
4805
+ /** Validation rules for boolean array elements. */
4625
4806
  booleanOptions?: BooleanType;
4626
- /** Object type validation for items */
4807
+ /** Validation rules for object array elements. */
4627
4808
  objectOptions?: ObjectType;
4628
4809
  /**
4629
- * Type of array items
4810
+ * Allowed item type.
4630
4811
  * @readonly
4631
4812
  */
4632
4813
  itemType?: ItemTypeWithLiterals;
4633
4814
  }
4634
4815
  /** @oneof */
4635
4816
  interface ArrayItemsItemTypeOptionsOneOf {
4636
- /** String type validation for items. */
4817
+ /** Validation rules for string array elements. */
4637
4818
  stringOptions?: StringType;
4638
- /** Number type validation for items. */
4819
+ /** Validation rules for numeric array elements. */
4639
4820
  numberOptions?: NumberType;
4640
- /** Boolean type validation for items. */
4821
+ /** Validation rules for boolean array elements. */
4641
4822
  booleanOptions?: BooleanType;
4642
- /** Object type validation for items */
4823
+ /** Validation rules for object array elements. */
4643
4824
  objectOptions?: ObjectType;
4644
4825
  }
4645
4826
  declare enum ArrayComponentType {
4827
+ /** Unknown component type. */
4646
4828
  UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
4829
+ /** Checkbox group component. */
4647
4830
  CHECKBOX_GROUP = "CHECKBOX_GROUP",
4648
- TAGS = "TAGS"
4831
+ /** Tags component. */
4832
+ TAGS = "TAGS",
4833
+ SERVICES_CHECKBOX_GROUP = "SERVICES_CHECKBOX_GROUP"
4649
4834
  }
4650
4835
  /** @enumType */
4651
- type ArrayComponentTypeWithLiterals = ArrayComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX_GROUP' | 'TAGS';
4836
+ type ArrayComponentTypeWithLiterals = ArrayComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX_GROUP' | 'TAGS' | 'SERVICES_CHECKBOX_GROUP';
4652
4837
  declare enum WixFileComponentType {
4838
+ /** Unknown component type. */
4653
4839
  UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
4840
+ /** File upload component. */
4654
4841
  FILE_UPLOAD = "FILE_UPLOAD",
4842
+ /** Signature component. */
4655
4843
  SIGNATURE = "SIGNATURE"
4656
4844
  }
4657
4845
  /** @enumType */
4658
4846
  type WixFileComponentTypeWithLiterals = WixFileComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'FILE_UPLOAD' | 'SIGNATURE';
4659
4847
  declare enum PaymentComponentType {
4848
+ /** Unknown component type. */
4660
4849
  UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
4850
+ /** Checkbox group component. */
4661
4851
  CHECKBOX_GROUP = "CHECKBOX_GROUP",
4852
+ /** Donation input component. */
4662
4853
  DONATION_INPUT = "DONATION_INPUT",
4854
+ /** Payment input component. */
4663
4855
  PAYMENT_INPUT = "PAYMENT_INPUT",
4856
+ /** Fixed payment component. */
4664
4857
  FIXED_PAYMENT = "FIXED_PAYMENT"
4665
4858
  }
4666
4859
  /** @enumType */
4667
4860
  type PaymentComponentTypeWithLiterals = PaymentComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX_GROUP' | 'DONATION_INPUT' | 'PAYMENT_INPUT' | 'FIXED_PAYMENT';
4668
4861
  declare enum ComponentType {
4862
+ /** Unknown component type. */
4669
4863
  UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
4864
+ /** Multiline address component. */
4670
4865
  MULTILINE_ADDRESS = "MULTILINE_ADDRESS"
4671
4866
  }
4672
4867
  /** @enumType */
4673
4868
  type ComponentTypeWithLiterals = ComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'MULTILINE_ADDRESS';
4674
4869
  declare enum SchedulingComponentType {
4870
+ /** Unknown component type. */
4675
4871
  UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
4872
+ /** Appointment component. */
4676
4873
  APPOINTMENT = "APPOINTMENT"
4677
4874
  }
4678
4875
  /** @enumType */
4679
4876
  type SchedulingComponentTypeWithLiterals = SchedulingComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'APPOINTMENT';
4680
4877
  declare enum InputType {
4878
+ /** Unknown input type. */
4681
4879
  UNKNOWN_INPUT_TYPE = "UNKNOWN_INPUT_TYPE",
4880
+ /** String input. */
4682
4881
  STRING = "STRING",
4882
+ /** Numeric input. */
4683
4883
  NUMBER = "NUMBER",
4884
+ /** Boolean input. */
4684
4885
  BOOLEAN = "BOOLEAN",
4886
+ /** Array input. */
4685
4887
  ARRAY = "ARRAY",
4888
+ /** Object input. */
4686
4889
  OBJECT = "OBJECT",
4890
+ /** File upload input. */
4687
4891
  WIX_FILE = "WIX_FILE",
4892
+ /** Payment input. */
4688
4893
  PAYMENT = "PAYMENT",
4894
+ /** Scheduling input. */
4689
4895
  SCHEDULING = "SCHEDULING",
4896
+ /** Address input. */
4690
4897
  ADDRESS = "ADDRESS"
4691
4898
  }
4692
4899
  /** @enumType */
4693
4900
  type InputTypeWithLiterals = InputType | 'UNKNOWN_INPUT_TYPE' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'ARRAY' | 'OBJECT' | 'WIX_FILE' | 'PAYMENT' | 'SCHEDULING' | 'ADDRESS';
4694
4901
  interface FormFieldContactInfo extends FormFieldContactInfoAdditionalInfoOneOf {
4695
- /** Email info. */
4902
+ /** Configuration for email contact fields. */
4696
4903
  emailInfo?: EmailInfo;
4697
- /** Phone info. */
4904
+ /** Configuration for phone contact fields. */
4698
4905
  phoneInfo?: PhoneInfo;
4699
- /** Address info. */
4906
+ /** Configuration for address contact fields. */
4700
4907
  addressInfo?: AddressInfo;
4701
- /** Custom field info. */
4908
+ /** Configuration for custom contact fields. */
4702
4909
  customFieldInfo?: CustomFieldInfo;
4703
- /** Subscription info */
4910
+ /** Configuration for subscription contact fields. */
4704
4911
  subscriptionInfo?: SubscriptionInfo;
4705
- /** Field mapped to contacts. */
4912
+ /** The [Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/introduction) field that this form field maps to. */
4706
4913
  contactField?: ContactFieldWithLiterals;
4707
4914
  }
4708
4915
  /** @oneof */
4709
4916
  interface FormFieldContactInfoAdditionalInfoOneOf {
4710
- /** Email info. */
4917
+ /** Configuration for email contact fields. */
4711
4918
  emailInfo?: EmailInfo;
4712
- /** Phone info. */
4919
+ /** Configuration for phone contact fields. */
4713
4920
  phoneInfo?: PhoneInfo;
4714
- /** Address info. */
4921
+ /** Configuration for address contact fields. */
4715
4922
  addressInfo?: AddressInfo;
4716
- /** Custom field info. */
4923
+ /** Configuration for custom contact fields. */
4717
4924
  customFieldInfo?: CustomFieldInfo;
4718
- /** Subscription info */
4925
+ /** Configuration for subscription contact fields. */
4719
4926
  subscriptionInfo?: SubscriptionInfo;
4720
4927
  }
4721
4928
  declare enum EmailInfoTag {
4929
+ /** Untagged email address. */
4722
4930
  UNTAGGED = "UNTAGGED",
4931
+ /** Primary email address for the contact. */
4723
4932
  MAIN = "MAIN"
4724
4933
  }
4725
4934
  /** @enumType */
4726
4935
  type EmailInfoTagWithLiterals = EmailInfoTag | 'UNTAGGED' | 'MAIN';
4727
4936
  declare enum PhoneInfoTag {
4937
+ /** Untagged phone number. */
4728
4938
  UNTAGGED = "UNTAGGED",
4939
+ /** Primary phone number for the contact. */
4729
4940
  MAIN = "MAIN"
4730
4941
  }
4731
4942
  /** @enumType */
4732
4943
  type PhoneInfoTagWithLiterals = PhoneInfoTag | 'UNTAGGED' | 'MAIN';
4733
4944
  declare enum Tag {
4945
+ /** Untagged address. */
4734
4946
  UNTAGGED = "UNTAGGED",
4947
+ /** Home address. */
4735
4948
  HOME = "HOME"
4736
4949
  }
4737
4950
  /** @enumType */
4738
4951
  type TagWithLiterals = Tag | 'UNTAGGED' | 'HOME';
4739
4952
  declare enum ConfirmationLevel {
4953
+ /** Unknown confirmation level. */
4740
4954
  UNKNOWN_CONFIRMATION_LEVEL = "UNKNOWN_CONFIRMATION_LEVEL",
4955
+ /** Single confirmation level. */
4741
4956
  SINGLE_CONFIRMATION = "SINGLE_CONFIRMATION",
4957
+ /** Double confirmation level. */
4742
4958
  DOUBLE_CONFIRMATION = "DOUBLE_CONFIRMATION"
4743
4959
  }
4744
4960
  /** @enumType */
4745
4961
  type ConfirmationLevelWithLiterals = ConfirmationLevel | 'UNKNOWN_CONFIRMATION_LEVEL' | 'SINGLE_CONFIRMATION' | 'DOUBLE_CONFIRMATION';
4746
4962
  declare enum ContactField {
4747
4963
  UNKNOWN_CONTACT_FIELD = "UNKNOWN_CONTACT_FIELD",
4964
+ /** Contact's first name. */
4748
4965
  FIRST_NAME = "FIRST_NAME",
4966
+ /** Contact's last name. */
4749
4967
  LAST_NAME = "LAST_NAME",
4968
+ /** Contact's company or organization. */
4750
4969
  COMPANY = "COMPANY",
4970
+ /** Contact's job title or position. */
4751
4971
  POSITION = "POSITION",
4972
+ /** Contact's email address. */
4752
4973
  EMAIL = "EMAIL",
4974
+ /** Contact's phone number. */
4753
4975
  PHONE = "PHONE",
4976
+ /** Contact's physical address. */
4754
4977
  ADDRESS = "ADDRESS",
4978
+ /** Contact's birth date. */
4755
4979
  BIRTHDATE = "BIRTHDATE",
4980
+ /** Custom contact field defined by the site owner. */
4756
4981
  CUSTOM_FIELD = "CUSTOM_FIELD",
4982
+ /** Contact's subscription preferences. */
4757
4983
  SUBSCRIPTION = "SUBSCRIPTION",
4984
+ /** Contact's VAT identification number. */
4758
4985
  VAT_ID = "VAT_ID"
4759
4986
  }
4760
4987
  /** @enumType */
4761
4988
  type ContactFieldWithLiterals = ContactField | 'UNKNOWN_CONTACT_FIELD' | 'FIRST_NAME' | 'LAST_NAME' | 'COMPANY' | 'POSITION' | 'EMAIL' | 'PHONE' | 'ADDRESS' | 'BIRTHDATE' | 'CUSTOM_FIELD' | 'SUBSCRIPTION' | 'VAT_ID';
4762
4989
  interface EmailInfo {
4763
- /** Email tag. */
4990
+ /** Email categorization tag. */
4764
4991
  tag?: EmailInfoTagWithLiterals;
4765
4992
  }
4766
4993
  interface PhoneInfo {
4767
- /** Phone tag. */
4994
+ /** Phone number categorization tag. */
4768
4995
  tag?: PhoneInfoTagWithLiterals;
4769
4996
  }
4770
4997
  interface AddressInfo {
4771
- /** Address tag. */
4998
+ /** Address categorization tag. */
4772
4999
  tag?: TagWithLiterals;
4773
5000
  }
4774
5001
  interface CustomFieldInfo {
@@ -4781,239 +5008,253 @@ interface CustomFieldInfo {
4781
5008
  }
4782
5009
  interface SubscriptionInfo {
4783
5010
  /**
4784
- * Subscription consent opt in level, either single or double confirmation.
4785
- * Default: SINGLE_CONFIRMATION
5011
+ * Subscription consent opt-in level, either single or double confirmation.
5012
+ * Default: `SINGLE_CONFIRMATION`
4786
5013
  */
4787
5014
  confirmationLevel?: ConfirmationLevelWithLiterals;
4788
5015
  }
4789
5016
  interface _String extends _StringComponentTypeOptionsOneOf {
4790
- /** Text input field */
5017
+ /** Text input component settings. */
4791
5018
  textInputOptions?: TextInput;
4792
- /** Selection field as radio group */
5019
+ /** Radio group component settings. */
4793
5020
  radioGroupOptions?: RadioGroup;
4794
- /** Selection field as drop down */
5021
+ /** Dropdown component settings. */
4795
5022
  dropdownOptions?: Dropdown;
4796
- /** Field for selecting date and time */
5023
+ /** Date and time input component settings. */
4797
5024
  dateTimeOptions?: DateTimeInput;
4798
- /** Phone input field */
5025
+ /** Phone input component settings. */
4799
5026
  phoneInputOptions?: PhoneInput;
4800
- /** Dropdown based component for selecting date */
5027
+ /** Date input component settings. */
4801
5028
  dateInputOptions?: DateInput;
4802
- /** Field for selecting time */
5029
+ /** Time input component settings. */
4803
5030
  timeInputOptions?: TimeInput;
4804
- /** Calendar type component for selecting date */
5031
+ /** Date picker component settings. */
4805
5032
  datePickerOptions?: DatePicker;
4806
- /** Dropdown for selecting services */
5033
+ /** Services dropdown component settings. */
4807
5034
  servicesDropdownOptions?: ServicesDropdown;
4808
- /** Validation of field output value. */
5035
+ /** Validation configuration for the string input. */
4809
5036
  validation?: StringType;
4810
5037
  /**
4811
- * Component type of the string input field
5038
+ * Component type of the string input field.
4812
5039
  * @readonly
4813
5040
  */
4814
5041
  componentType?: StringComponentTypeWithLiterals;
4815
5042
  }
4816
5043
  /** @oneof */
4817
5044
  interface _StringComponentTypeOptionsOneOf {
4818
- /** Text input field */
5045
+ /** Text input component settings. */
4819
5046
  textInputOptions?: TextInput;
4820
- /** Selection field as radio group */
5047
+ /** Radio group component settings. */
4821
5048
  radioGroupOptions?: RadioGroup;
4822
- /** Selection field as drop down */
5049
+ /** Dropdown component settings. */
4823
5050
  dropdownOptions?: Dropdown;
4824
- /** Field for selecting date and time */
5051
+ /** Date and time input component settings. */
4825
5052
  dateTimeOptions?: DateTimeInput;
4826
- /** Phone input field */
5053
+ /** Phone input component settings. */
4827
5054
  phoneInputOptions?: PhoneInput;
4828
- /** Dropdown based component for selecting date */
5055
+ /** Date input component settings. */
4829
5056
  dateInputOptions?: DateInput;
4830
- /** Field for selecting time */
5057
+ /** Time input component settings. */
4831
5058
  timeInputOptions?: TimeInput;
4832
- /** Calendar type component for selecting date */
5059
+ /** Date picker component settings. */
4833
5060
  datePickerOptions?: DatePicker;
4834
- /** Dropdown for selecting services */
5061
+ /** Services dropdown component settings. */
4835
5062
  servicesDropdownOptions?: ServicesDropdown;
4836
5063
  }
4837
5064
  interface _Number extends _NumberComponentTypeOptionsOneOf {
4838
- /** Number value input field */
5065
+ /** Number input settings. */
4839
5066
  numberInputOptions?: NumberInput;
4840
- /** Rating value input field */
5067
+ /** Rating input settings. */
4841
5068
  ratingInputOptions?: RatingInput;
4842
- /** Validation of field output value. */
5069
+ /** Validation configuration for the number input. */
4843
5070
  validation?: NumberType;
4844
5071
  /**
4845
- * Component type of the number input field
5072
+ * Component type of the number input field.
4846
5073
  * @readonly
4847
5074
  */
4848
5075
  componentType?: NumberComponentTypeWithLiterals;
4849
5076
  }
4850
5077
  /** @oneof */
4851
5078
  interface _NumberComponentTypeOptionsOneOf {
4852
- /** Number value input field */
5079
+ /** Number input settings. */
4853
5080
  numberInputOptions?: NumberInput;
4854
- /** Rating value input field */
5081
+ /** Rating input settings. */
4855
5082
  ratingInputOptions?: RatingInput;
4856
5083
  }
4857
5084
  interface _Boolean extends _BooleanComponentTypeOptionsOneOf {
4858
- /** Checkbox input field */
5085
+ /** Checkbox component settings. */
4859
5086
  checkboxOptions?: Checkbox;
4860
- /** Validation of field output value. */
5087
+ /** Validation configuration for the boolean input. */
4861
5088
  validation?: BooleanType;
4862
5089
  /**
4863
- * Component type of the boolean input field
5090
+ * Component type of the boolean input field.
4864
5091
  * @readonly
4865
5092
  */
4866
5093
  componentType?: BooleanComponentTypeWithLiterals;
4867
5094
  }
4868
5095
  /** @oneof */
4869
5096
  interface _BooleanComponentTypeOptionsOneOf {
4870
- /** Checkbox input field */
5097
+ /** Checkbox component settings. */
4871
5098
  checkboxOptions?: Checkbox;
4872
5099
  }
4873
5100
  interface _Array extends _ArrayComponentTypeOptionsOneOf {
4874
- /** Checkbox group input field */
5101
+ /** Checkbox group component settings. */
4875
5102
  checkboxGroupOptions?: CheckboxGroup;
4876
- /** Tags input field */
5103
+ /** Tags component settings. */
4877
5104
  tagsOptions?: Tags;
4878
- /** Validation of array type. */
5105
+ /** Services checkbox group input field */
5106
+ servicesCheckboxGroupOptions?: ServicesCheckboxGroup;
5107
+ /** Validation configuration for the array input. */
4879
5108
  validation?: ArrayType;
4880
5109
  /**
4881
- * Component type of the array input field
5110
+ * Component type of the array input field.
4882
5111
  * @readonly
4883
5112
  */
4884
5113
  componentType?: ArrayComponentTypeWithLiterals;
4885
5114
  }
4886
5115
  /** @oneof */
4887
5116
  interface _ArrayComponentTypeOptionsOneOf {
4888
- /** Checkbox group input field */
5117
+ /** Checkbox group component settings. */
4889
5118
  checkboxGroupOptions?: CheckboxGroup;
4890
- /** Tags input field */
5119
+ /** Tags component settings. */
4891
5120
  tagsOptions?: Tags;
5121
+ /** Services checkbox group input field */
5122
+ servicesCheckboxGroupOptions?: ServicesCheckboxGroup;
4892
5123
  }
4893
5124
  interface _Object {
4894
- /** Validation of object type. */
5125
+ /** Validation configuration for the object input. */
4895
5126
  validation?: ObjectType;
4896
5127
  }
4897
5128
  interface WixFile extends WixFileComponentTypeOptionsOneOf {
4898
- /** File upload input field */
5129
+ /** File upload component settings. */
4899
5130
  fileUploadOptions?: FileUpload;
4900
- /** Signature input field */
5131
+ /** Signature component settings. */
4901
5132
  signatureOptions?: Signature;
4902
5133
  /**
4903
- * Component type of the array input field
5134
+ * Component type of the file input field.
4904
5135
  * @readonly
4905
5136
  */
4906
5137
  componentType?: WixFileComponentTypeWithLiterals;
4907
- /** Validation of field type. */
5138
+ /** Validation configuration for the file input. */
4908
5139
  validation?: FileType;
4909
5140
  }
4910
5141
  /** @oneof */
4911
5142
  interface WixFileComponentTypeOptionsOneOf {
4912
- /** File upload input field */
5143
+ /** File upload component settings. */
4913
5144
  fileUploadOptions?: FileUpload;
4914
- /** Signature input field */
5145
+ /** Signature component settings. */
4915
5146
  signatureOptions?: Signature;
4916
5147
  }
4917
5148
  interface Payment extends PaymentComponentTypeOptionsOneOf {
4918
- /** Checkbox group input field. */
5149
+ /** Checkbox group component settings. */
4919
5150
  checkboxGroupOptions?: ProductCheckboxGroup;
4920
- /** Donation input field. */
5151
+ /** Donation input component settings. */
4921
5152
  donationInputOptions?: DonationInput;
4922
- /** Payment input field. */
5153
+ /** Payment input component settings. */
4923
5154
  paymentInputOptions?: PaymentInput;
4924
- /** Fixed payment field. */
5155
+ /** Fixed payment component settings. */
4925
5156
  fixedPaymentOptions?: FixedPayment;
4926
5157
  /**
4927
5158
  * Component type of the payment input field.
4928
5159
  * @readonly
4929
5160
  */
4930
5161
  componentType?: PaymentComponentTypeWithLiterals;
4931
- /** Validation of payment type. */
5162
+ /** Validation configuration for the payment input. */
4932
5163
  validation?: PaymentType;
4933
5164
  }
4934
5165
  /** @oneof */
4935
5166
  interface PaymentComponentTypeOptionsOneOf {
4936
- /** Checkbox group input field. */
5167
+ /** Checkbox group component settings. */
4937
5168
  checkboxGroupOptions?: ProductCheckboxGroup;
4938
- /** Donation input field. */
5169
+ /** Donation input component settings. */
4939
5170
  donationInputOptions?: DonationInput;
4940
- /** Payment input field. */
5171
+ /** Payment input component settings. */
4941
5172
  paymentInputOptions?: PaymentInput;
4942
- /** Fixed payment field. */
5173
+ /** Fixed payment component settings. */
4943
5174
  fixedPaymentOptions?: FixedPayment;
4944
5175
  }
4945
5176
  interface Scheduling extends SchedulingComponentTypeOptionsOneOf {
4946
- /** Appointment input field */
5177
+ /** Appointment component settings. */
4947
5178
  appointmentOptions?: Appointment;
4948
5179
  /**
4949
- * Component type of the scheduling input field
5180
+ * Component type of the scheduling field.
4950
5181
  * @readonly
4951
5182
  */
4952
5183
  componentType?: SchedulingComponentTypeWithLiterals;
4953
5184
  }
4954
5185
  /** @oneof */
4955
5186
  interface SchedulingComponentTypeOptionsOneOf {
4956
- /** Appointment input field */
5187
+ /** Appointment component settings. */
4957
5188
  appointmentOptions?: Appointment;
4958
5189
  }
4959
5190
  interface Address extends AddressComponentTypeOptionsOneOf {
4960
- /** Multiline address input field. */
5191
+ /** Multiline address component settings. */
4961
5192
  multilineAddressOptions?: MultilineAddress;
4962
5193
  /**
4963
5194
  * Component type of the multiline address field.
4964
5195
  * @readonly
4965
5196
  */
4966
5197
  componentType?: ComponentTypeWithLiterals;
4967
- /** Validation of multiline address field output value. */
5198
+ /** Validation configuration for the multiline address input. */
4968
5199
  validation?: MultilineAddressValidation;
4969
5200
  }
4970
5201
  /** @oneof */
4971
5202
  interface AddressComponentTypeOptionsOneOf {
4972
- /** Multiline address input field. */
5203
+ /** Multiline address component settings. */
4973
5204
  multilineAddressOptions?: MultilineAddress;
4974
5205
  }
4975
5206
  interface FieldsDisplayField extends FieldsDisplayFieldDisplayFieldTypeOptionsOneOf {
4976
- /** Component displaying rich content */
5207
+ /** Configuration for rich content display fields. */
4977
5208
  richContentOptions?: RichContentOptions;
4978
- /** Page navigation component resolving as navigation or submit buttons */
5209
+ /** Configuration for page navigation display fields such as navigation or submit buttons. */
4979
5210
  pageNavigationOptions?: PageNavigationOptions;
4980
- /** Type of the display field */
5211
+ /** Type of display field that determines its appearance and behavior. */
4981
5212
  displayFieldType?: DisplayFieldDisplayFieldTypeWithLiterals;
4982
5213
  }
4983
5214
  /** @oneof */
4984
5215
  interface FieldsDisplayFieldDisplayFieldTypeOptionsOneOf {
4985
- /** Component displaying rich content */
5216
+ /** Configuration for rich content display fields. */
4986
5217
  richContentOptions?: RichContentOptions;
4987
- /** Page navigation component resolving as navigation or submit buttons */
5218
+ /** Configuration for page navigation display fields such as navigation or submit buttons. */
4988
5219
  pageNavigationOptions?: PageNavigationOptions;
4989
5220
  }
4990
5221
  declare enum DisplayFieldDisplayFieldType {
5222
+ /** Unknown field type. */
4991
5223
  UNKNOWN_FIELD_TYPE = "UNKNOWN_FIELD_TYPE",
5224
+ /** Rich content display field. */
4992
5225
  RICH_CONTENT = "RICH_CONTENT",
5226
+ /** Page navigation display field. */
4993
5227
  PAGE_NAVIGATION = "PAGE_NAVIGATION",
5228
+ /** Login bar display field. */
4994
5229
  LOGIN_BAR = "LOGIN_BAR"
4995
5230
  }
4996
5231
  /** @enumType */
4997
5232
  type DisplayFieldDisplayFieldTypeWithLiterals = DisplayFieldDisplayFieldType | 'UNKNOWN_FIELD_TYPE' | 'RICH_CONTENT' | 'PAGE_NAVIGATION' | 'LOGIN_BAR';
4998
5233
  interface RichContentOptions {
4999
- /** Content of the header */
5234
+ /** Rich content to display in the field. */
5000
5235
  richContent?: RichContent;
5001
- /** Number of paragraphs visible. Other part is hidden under expandable section. If not provided all text visible. */
5236
+ /**
5237
+ * Maximum number of paragraphs to show initially.
5238
+ * Additional content is hidden behind an expandable section. If not specified, all content is visible.
5239
+ */
5002
5240
  maxShownParagraphs?: number | null;
5003
5241
  }
5004
5242
  interface PageNavigationOptions {
5005
5243
  /**
5006
- * When button is not on last page it behaves as switch between pages page, text of label to go to next page.
5244
+ * Text displayed on the button when it navigates to the next page.
5245
+ * Only applicable when the button is not on the final form page.
5007
5246
  * @maxLength 65
5008
5247
  */
5009
5248
  nextPageText?: string | null;
5010
5249
  /**
5011
- * When button is not on last page it behaves as switch between pages page, text of label to go to previous page.
5250
+ * Text displayed on the button when it navigates to the previous page.
5251
+ * Only applicable when the button is not on the first form page.
5012
5252
  * @maxLength 65
5013
5253
  */
5014
5254
  previousPageText?: string | null;
5015
5255
  /**
5016
- * Text on the button when button is submitting a form
5256
+ * Text displayed on the button when it submits the form.
5257
+ * Only applicable when the button is on the final form page.
5017
5258
  * @maxLength 65
5018
5259
  */
5019
5260
  submitText?: string | null;
@@ -5030,95 +5271,93 @@ interface Step {
5030
5271
  * @maxLength 200
5031
5272
  */
5032
5273
  name?: string | null;
5033
- /** Is step hidden */
5274
+ /** Whether the step is hidden. */
5034
5275
  hidden?: boolean;
5035
- /** Form step properties */
5276
+ /** Layout configuration that defines how form fields are arranged within this step. */
5036
5277
  layout?: FormLayout;
5037
5278
  }
5038
5279
  interface FormLayout {
5039
- /** Layout for large break point. */
5280
+ /** Layout configuration for large screen breakpoints (desktop). */
5040
5281
  large?: BreakPoint;
5041
- /** Layout for medium break point. */
5282
+ /** Layout configuration for medium screen breakpoints (tablet). */
5042
5283
  medium?: BreakPoint;
5043
- /** Layout for small break point. */
5284
+ /** Layout configuration for small screen breakpoints (mobile). */
5044
5285
  small?: BreakPoint;
5045
5286
  }
5046
5287
  interface BreakPoint {
5047
5288
  /**
5048
- * Description of layouts for items.
5289
+ * Configuration for the layout of items in the breakpoint.
5049
5290
  * @maxSize 500
5050
5291
  */
5051
5292
  items?: ItemLayout[];
5052
- /** Amount of columns of layout grid. */
5293
+ /** Number of columns in the layout grid. */
5053
5294
  columns?: number | null;
5054
- /** Row height of layout grid. */
5295
+ /** Height of each row in the layout grid, measured in pixels. */
5055
5296
  rowHeight?: number | null;
5056
- /** Description of elements margins. */
5297
+ /** Margin spacing configuration for the form elements. */
5057
5298
  margin?: Margin;
5058
- /** Description of elements paddings. */
5299
+ /** Padding spacing inside form elements in pixels. */
5059
5300
  padding?: Margin;
5060
5301
  }
5061
5302
  interface ItemLayout extends ItemLayoutItemOneOf {
5062
5303
  /**
5063
- * Form field reference id.
5304
+ * ID of the form field to be positioned in the layout.
5064
5305
  * @format GUID
5065
5306
  */
5066
5307
  fieldId?: string;
5067
- /** Group info, defining that this item is a group of multiple fields */
5308
+ /** Group configuration for positioning multiple fields as a single layout unit. */
5068
5309
  group?: Group;
5069
- /** Horizontal coordinate in the grid. */
5310
+ /** Row position in the grid where this item is placed. */
5070
5311
  row?: number | null;
5071
- /** Vertical coordinate in the grid. */
5312
+ /** Column position in the grid where this item is placed. */
5072
5313
  column?: number | null;
5073
- /** Height. */
5314
+ /** Width of the item in grid units. */
5074
5315
  width?: number | null;
5075
- /** Width. */
5316
+ /** Height of the item in grid units. */
5076
5317
  height?: number | null;
5077
5318
  }
5078
5319
  /** @oneof */
5079
5320
  interface ItemLayoutItemOneOf {
5080
5321
  /**
5081
- * Form field reference id.
5322
+ * ID of the form field to be positioned in the layout.
5082
5323
  * @format GUID
5083
5324
  */
5084
5325
  fieldId?: string;
5085
- /** Group info, defining that this item is a group of multiple fields */
5326
+ /** Group configuration for positioning multiple fields as a single layout unit. */
5086
5327
  group?: Group;
5087
5328
  }
5088
5329
  interface Group {
5089
5330
  /**
5090
- * Field group reference id.
5331
+ * ID of the field group.
5091
5332
  * @format GUID
5092
5333
  */
5093
5334
  groupId?: string;
5094
5335
  /**
5095
- * Description of layouts for items.
5336
+ * Layout configuration for individual items within this group.
5096
5337
  * @minSize 1
5097
5338
  * @maxSize 500
5098
5339
  */
5099
5340
  items?: ItemLayout[];
5100
5341
  }
5101
5342
  interface Margin {
5102
- /** Horizontal value. */
5343
+ /** Horizontal spacing in pixels. */
5103
5344
  horizontal?: number | null;
5104
- /** Vertical value. */
5345
+ /** Vertical spacing in pixels. */
5105
5346
  vertical?: number | null;
5106
5347
  }
5107
5348
  interface Section {
5108
5349
  /**
5109
- * Id of the section
5350
+ * Section ID.
5110
5351
  * @format GUID
5111
5352
  * @minLength 1
5112
5353
  */
5113
5354
  _id?: string;
5114
- /** Horizontal coordinate in the grid. */
5355
+ /** Row position where this section is placed in the grid. */
5115
5356
  row?: number | null;
5116
5357
  /**
5117
- * A list of field identifiers that are permitted to be placed within a section.
5118
- * The section will only accept fields with IDs specified in this list.
5119
- * If the section encounters the $new key within the list,
5120
- * it allows the inclusion of fields not explicitly listed,
5121
- * enabling dynamic addition of new fields.
5358
+ * A list of field IDs that can be placed within the section.
5359
+ * The section only accepts fields with IDs specified in this list.
5360
+ * If the `$new` key is contained in this list, the section allows the inclusion of fields not explicitly listed, enabling dynamic addition of new fields.
5122
5361
  * @maxSize 100
5123
5362
  * @maxLength 100
5124
5363
  */
@@ -5126,44 +5365,49 @@ interface Section {
5126
5365
  }
5127
5366
  interface FormRule {
5128
5367
  /**
5129
- * Id of the rule
5368
+ * Rule ID.
5130
5369
  * @format GUID
5131
5370
  * @immutable
5132
5371
  */
5133
5372
  _id?: string;
5134
- /** Rule on which item properties or layouts will be changed. */
5373
+ /** Condition that determines when this rule's overrides should be applied. */
5135
5374
  condition?: Record<string, any> | null;
5136
5375
  /**
5137
- * Form items with defined properties that will be
5138
- * changed when given condition is resolved to true.
5376
+ * Changes to apply to form elements when the condition evaluates to true.
5139
5377
  * @maxSize 500
5140
5378
  */
5141
5379
  overrides?: FormOverride[];
5142
5380
  /**
5143
- * Name of the rule
5381
+ * Name for the rule.
5144
5382
  * @maxLength 200
5145
5383
  */
5146
5384
  name?: string | null;
5147
5385
  }
5148
5386
  declare enum OverrideEntityType {
5387
+ /** Unknown override entity type. */
5149
5388
  UNKNOWN = "UNKNOWN",
5389
+ /** Override applies to a form field. */
5150
5390
  FIELD = "FIELD"
5151
5391
  }
5152
5392
  /** @enumType */
5153
5393
  type OverrideEntityTypeWithLiterals = OverrideEntityType | 'UNKNOWN' | 'FIELD';
5154
5394
  interface FormOverride {
5155
5395
  /**
5156
- * Override entity type.
5396
+ * Type of form element that this override targets.
5157
5397
  * @immutable
5158
5398
  */
5159
5399
  entityType?: OverrideEntityTypeWithLiterals;
5160
5400
  /**
5161
- * Overridden entity id. Either fieldId, or "{fieldIdWithNestedForm}/{nestedFormFieldId}"
5401
+ * ID of the form element to modify.
5402
+ * For nested form fields, use the format: "{fieldIdWithNestedForm}/{nestedFormFieldId}".
5162
5403
  * @immutable
5163
5404
  * @maxLength 73
5164
5405
  */
5165
5406
  entityId?: string | null;
5166
- /** Form entity properties path with new value, that will be changed on condition. */
5407
+ /**
5408
+ * Property changes to apply to the form element when the rule condition is met.
5409
+ * Each key represents a property path, and the value is the new value to set.
5410
+ */
5167
5411
  valueChanges?: Record<string, any>;
5168
5412
  }
5169
5413
  interface FormProperties {
@@ -5192,19 +5436,21 @@ declare enum Kind {
5192
5436
  /** @enumType */
5193
5437
  type KindWithLiterals = Kind | 'REGULAR' | 'EXTENSION';
5194
5438
  interface PostSubmissionTriggers {
5195
- /** Upserts a contact from the submission data. */
5439
+ /** Upserts a [contact](https://support.wix.com/en/article/about-your-contact-list) to the Wix site from the form submission data. */
5196
5440
  upsertContact?: UpsertContact;
5197
5441
  }
5198
5442
  interface UpsertContact {
5199
5443
  /**
5200
- * Fields mapping (target field mapped to corresponding contact field).
5444
+ * Fields mapping between the form fields and the contact fields.
5445
+ *
5446
+ * This is the target form field mapped to the corresponding contact field.
5447
+ *
5448
+ * The key is the form field ID, and the value is the contact field.
5201
5449
  * @maxSize 250
5202
5450
  */
5203
5451
  fieldsMapping?: Record<string, V4FormFieldContactInfo>;
5204
5452
  /**
5205
- * List of contact label keys.
5206
- * [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
5207
- * help categorize contacts.
5453
+ * List of [labels](https://support.wix.com/en/article/creating-contact-labels) to add to the contact to help categorize it.
5208
5454
  * @minLength 1
5209
5455
  * @maxLength 100
5210
5456
  * @maxSize 20
@@ -5230,29 +5476,29 @@ interface LimitationRule {
5230
5476
  declare enum SpamFilterProtectionLevel {
5231
5477
  /** Unknown spam filter protection level. */
5232
5478
  UNKNOWN = "UNKNOWN",
5233
- /** Spam filter is not used. Form is open for spam submissions. */
5479
+ /** No spam filtering. All submissions are accepted without screening. */
5234
5480
  NONE = "NONE",
5235
- /** Spam filter operates in basic mode. Form is open to high risk of spam submissions. */
5481
+ /** Basic spam filtering. Provides minimal protection against obvious spam and the form is open to a high risk of spam submissions. */
5236
5482
  BASIC = "BASIC",
5237
- /** Spam filter operates in advanced mode. Form is open to low risk of spam submissions. */
5483
+ /** Advanced spam filtering. Provides comprehensive protection with intelligent screening and the form is open to a low risk of spam submissions. */
5238
5484
  ADVANCED = "ADVANCED"
5239
5485
  }
5240
5486
  /** @enumType */
5241
5487
  type SpamFilterProtectionLevelWithLiterals = SpamFilterProtectionLevel | 'UNKNOWN' | 'NONE' | 'BASIC' | 'ADVANCED';
5242
5488
  interface RequiredIndicatorProperties {
5243
- /** Required indicator. */
5489
+ /** Type of visual indicator used to mark required fields. */
5244
5490
  requiredIndicator?: RequiredIndicatorWithLiterals;
5245
- /** Required indicator placement. */
5491
+ /** Position where the required indicator appears relative to the field title. */
5246
5492
  requiredIndicatorPlacement?: RequiredIndicatorPlacementWithLiterals;
5247
5493
  }
5248
5494
  declare enum RequiredIndicator {
5249
- /** Unknown required indicator. */
5495
+ /** Unknown required indicator type. */
5250
5496
  UNKNOWN_INDICATOR = "UNKNOWN_INDICATOR",
5251
- /** Asterisk (*). */
5497
+ /** Display an asterisk (*) symbol to indicate required fields. */
5252
5498
  ASTERISK = "ASTERISK",
5253
- /** Text (default: "Required"). */
5499
+ /** Display the text "Required" to indicate required fields. */
5254
5500
  TEXT = "TEXT",
5255
- /** None. */
5501
+ /** No visual indicator is shown for required fields. */
5256
5502
  NONE = "NONE"
5257
5503
  }
5258
5504
  /** @enumType */
@@ -5260,34 +5506,34 @@ type RequiredIndicatorWithLiterals = RequiredIndicator | 'UNKNOWN_INDICATOR' | '
5260
5506
  declare enum RequiredIndicatorPlacement {
5261
5507
  /** Unknown required indicator placement. */
5262
5508
  UNKNOWN_PLACEMENT = "UNKNOWN_PLACEMENT",
5263
- /** After field title. */
5509
+ /** Place the required indicator after the field title. */
5264
5510
  AFTER_FIELD_TITLE = "AFTER_FIELD_TITLE",
5265
- /** Before field title. */
5511
+ /** Place the required indicator before the field title. */
5266
5512
  BEFORE_FIELD_TITLE = "BEFORE_FIELD_TITLE"
5267
5513
  }
5268
5514
  /** @enumType */
5269
5515
  type RequiredIndicatorPlacementWithLiterals = RequiredIndicatorPlacement | 'UNKNOWN_PLACEMENT' | 'AFTER_FIELD_TITLE' | 'BEFORE_FIELD_TITLE';
5270
5516
  interface SubmitSettings extends SubmitSettingsSubmitSuccessActionOptionsOneOf {
5271
- /** Options for showing a thank you message after submission. */
5517
+ /** Configuration for displaying a thank you message after submission. */
5272
5518
  thankYouMessageOptions?: ThankYouMessageOptions;
5273
- /** Options for redirecting to a URL after submission. */
5519
+ /** Configuration for redirecting submitters to a URL after submission. */
5274
5520
  redirectOptions?: RedirectOptions;
5275
- /** Action that is triggered after a successful form submission. */
5521
+ /** Action that's triggered after a form is successfully submitted. */
5276
5522
  submitSuccessAction?: SubmitSuccessActionWithLiterals;
5277
5523
  }
5278
5524
  /** @oneof */
5279
5525
  interface SubmitSettingsSubmitSuccessActionOptionsOneOf {
5280
- /** Options for showing a thank you message after submission. */
5526
+ /** Configuration for displaying a thank you message after submission. */
5281
5527
  thankYouMessageOptions?: ThankYouMessageOptions;
5282
- /** Options for redirecting to a URL after submission. */
5528
+ /** Configuration for redirecting submitters to a URL after submission. */
5283
5529
  redirectOptions?: RedirectOptions;
5284
5530
  }
5285
5531
  declare enum Target {
5286
- /** Unknown target. */
5532
+ /** Unknown target behavior. */
5287
5533
  UNKNOWN_TARGET = "UNKNOWN_TARGET",
5288
- /** Open in the same browser tab. */
5534
+ /** Open the URL in the same browser tab, replacing the current page. */
5289
5535
  SELF = "SELF",
5290
- /** Open in a new browser tab. */
5536
+ /** Open the URL in a new browser tab. */
5291
5537
  BLANK = "BLANK"
5292
5538
  }
5293
5539
  /** @enumType */
@@ -5295,28 +5541,31 @@ type TargetWithLiterals = Target | 'UNKNOWN_TARGET' | 'SELF' | 'BLANK';
5295
5541
  declare enum SubmitSuccessAction {
5296
5542
  /** Unknown submit success action. */
5297
5543
  UNKNOWN_SUBMIT_SUCCESS_ACTION = "UNKNOWN_SUBMIT_SUCCESS_ACTION",
5298
- /** No action will be taken after submission. */
5544
+ /** No action is taken after form submission. */
5299
5545
  NO_ACTION = "NO_ACTION",
5300
- /** A thank you message will be shown after submission. */
5546
+ /** Display a thank you message after form submission. */
5301
5547
  THANK_YOU_MESSAGE = "THANK_YOU_MESSAGE",
5302
- /** The user will be redirected to a URL after submission. */
5548
+ /** Redirect the user to a specified URL after form submission. */
5303
5549
  REDIRECT = "REDIRECT"
5304
5550
  }
5305
5551
  /** @enumType */
5306
5552
  type SubmitSuccessActionWithLiterals = SubmitSuccessAction | 'UNKNOWN_SUBMIT_SUCCESS_ACTION' | 'NO_ACTION' | 'THANK_YOU_MESSAGE' | 'REDIRECT';
5307
5553
  interface ThankYouMessageOptions {
5308
- /** Duration in seconds after which the message should disappear. If 0, the message will stay forever. */
5554
+ /**
5555
+ * Duration in seconds before the thank you message automatically disappears.
5556
+ * If set to 0, the message remains visible until manually dismissed.
5557
+ */
5309
5558
  durationInSeconds?: number | null;
5310
- /** The message shown after form submission. */
5559
+ /** Rich content message displayed to users after successful form submission. */
5311
5560
  richContent?: RichContent;
5312
5561
  }
5313
5562
  interface RedirectOptions {
5314
5563
  /**
5315
- * The URL to which the user should be redirected after a successful form submission.
5564
+ * URL to which the user should be redirected after successfully submitting the form.
5316
5565
  * @maxLength 2000
5317
5566
  */
5318
5567
  redirectUrl?: string | null;
5319
- /** How the URL should be opened. */
5568
+ /** How the redirect URL should be opened in the browser. */
5320
5569
  target?: TargetWithLiterals;
5321
5570
  }
5322
5571
  interface FieldGroup {
@@ -5333,26 +5582,29 @@ interface FieldGroup {
5333
5582
  }
5334
5583
  interface Rule {
5335
5584
  /**
5336
- * Id of the rule
5585
+ * Rule ID.
5337
5586
  * @format GUID
5338
5587
  * @immutable
5339
5588
  */
5340
5589
  _id?: string;
5341
- /** Rule on which item properties or layouts will be changed. */
5590
+ /**
5591
+ * Conditional expression that determines when this rule should be applied.
5592
+ * The overrides defined in this rule are applied when this expression evaluates to true.
5593
+ */
5342
5594
  expression?: ConditionNode;
5343
5595
  /**
5344
- * Form items with defined properties that will be
5345
- * changed when given condition is resolved to true.
5596
+ * Form modifications that are applied when the rule expression evaluates to true.
5597
+ * Each override specifies how a form element should be changed.
5346
5598
  * @maxSize 500
5347
5599
  */
5348
5600
  overrides?: RuleFormOverride[];
5349
5601
  /**
5350
- * Name of the rule
5602
+ * Human-readable name for the rule.
5351
5603
  * @maxLength 200
5352
5604
  */
5353
5605
  name?: string | null;
5354
5606
  }
5355
- /** Enum for different types of changeable properties. */
5607
+ /** Enum for different types of field properties that can be modified by rules. */
5356
5608
  declare enum ChangeableProperty {
5357
5609
  /** Unknown property type. */
5358
5610
  UNKNOWN_CHANGEABLE_PROPERTY = "UNKNOWN_CHANGEABLE_PROPERTY",
@@ -5366,72 +5618,75 @@ declare enum ChangeableProperty {
5366
5618
  /** @enumType */
5367
5619
  type ChangeablePropertyWithLiterals = ChangeableProperty | 'UNKNOWN_CHANGEABLE_PROPERTY' | 'REQUIRED' | 'HIDDEN' | 'ALLOWED_VALUES';
5368
5620
  interface RequiredOptions {
5369
- /** Value of required property */
5621
+ /** Whether the field should be required. */
5370
5622
  required?: boolean;
5371
5623
  }
5372
5624
  interface HiddenOptions {
5373
- /** Value of hidden property */
5625
+ /** Whether the field should be hidden. */
5374
5626
  hidden?: boolean;
5375
5627
  }
5376
5628
  interface AllowedValuesOptions {
5377
5629
  /**
5378
- * Allowed values
5630
+ * List of values that are allowed for the field when this rule is active.
5631
+ * Restricts user input to only these predefined options.
5379
5632
  * @maxSize 300
5380
5633
  * @maxLength 200
5381
5634
  */
5382
5635
  allowedValues?: string[];
5383
5636
  }
5384
5637
  declare enum OverrideEntityTypeEnumOverrideEntityType {
5638
+ /** Unknown override entity type. */
5385
5639
  UNKNOWN_OVERRIDE_ENTITY_TYPE = "UNKNOWN_OVERRIDE_ENTITY_TYPE",
5640
+ /** Override applies to a form field. */
5386
5641
  FIELD = "FIELD"
5387
5642
  }
5388
5643
  /** @enumType */
5389
5644
  type OverrideEntityTypeEnumOverrideEntityTypeWithLiterals = OverrideEntityTypeEnumOverrideEntityType | 'UNKNOWN_OVERRIDE_ENTITY_TYPE' | 'FIELD';
5390
5645
  interface FieldOverride extends FieldOverridePropertyTypeOptionsOneOf {
5391
- /** Required property overrides */
5646
+ /** Configuration for changing the required property of a field. */
5392
5647
  requiredOptions?: RequiredOptions;
5393
- /** Hidden property overrides */
5648
+ /** Configuration for changing the visibility property of a field. */
5394
5649
  hiddenOptions?: HiddenOptions;
5395
- /** Allowed values property overrides */
5650
+ /** Configuration for changing the allowed values of a field. */
5396
5651
  allowedValuesOptions?: AllowedValuesOptions;
5397
5652
  /**
5398
- * Overridden entity id
5653
+ * ID of the field to be modified by this override.
5399
5654
  * @immutable
5400
5655
  * @format GUID
5401
5656
  */
5402
5657
  fieldId?: string;
5403
- /** Form entity properties path with new value, that will be changed on condition. */
5658
+ /** The new value for the field property that will be set when the rule conditions are met. */
5404
5659
  propertyType?: ChangeablePropertyWithLiterals;
5405
5660
  }
5406
5661
  /** @oneof */
5407
5662
  interface FieldOverridePropertyTypeOptionsOneOf {
5408
- /** Required property overrides */
5663
+ /** Configuration for changing the required property of a field. */
5409
5664
  requiredOptions?: RequiredOptions;
5410
- /** Hidden property overrides */
5665
+ /** Configuration for changing the visibility property of a field. */
5411
5666
  hiddenOptions?: HiddenOptions;
5412
- /** Allowed values property overrides */
5667
+ /** Configuration for changing the allowed values of a field. */
5413
5668
  allowedValuesOptions?: AllowedValuesOptions;
5414
5669
  }
5415
5670
  interface ConditionNode extends ConditionNodeNodeOneOf {
5416
- /** A compound condition that requires all conditions to be true. */
5671
+ /** Logical AND condition with 1 or more child conditions. All child conditions must be true. */
5417
5672
  and?: AndCondition;
5418
- /** A compound condition that requires at least one condition to be true. */
5673
+ /** Logical OR condition with 1 or more child conditions. At least 1 child condition must be true. */
5419
5674
  or?: OrCondition;
5420
- /** A single condition in the rule. */
5675
+ /** Single condition to evaluate. */
5421
5676
  condition?: Condition;
5422
5677
  }
5423
5678
  /** @oneof */
5424
5679
  interface ConditionNodeNodeOneOf {
5425
- /** A compound condition that requires all conditions to be true. */
5680
+ /** Logical AND condition with 1 or more child conditions. All child conditions must be true. */
5426
5681
  and?: AndCondition;
5427
- /** A compound condition that requires at least one condition to be true. */
5682
+ /** Logical OR condition with 1 or more child conditions. At least 1 child condition must be true. */
5428
5683
  or?: OrCondition;
5429
- /** A single condition in the rule. */
5684
+ /** Single condition to evaluate. */
5430
5685
  condition?: Condition;
5431
5686
  }
5432
5687
  interface AndCondition {
5433
5688
  /**
5434
- * The list of conditions that must all be true.
5689
+ * List of conditions that must all evaluate to true.
5435
5690
  * @minSize 1
5436
5691
  * @maxSize 100
5437
5692
  */
@@ -5439,7 +5694,7 @@ interface AndCondition {
5439
5694
  }
5440
5695
  interface OrCondition {
5441
5696
  /**
5442
- * The list of conditions where at least one must be true.
5697
+ * List of conditions where at least 1 must evaluate to true.
5443
5698
  * @minSize 1
5444
5699
  * @maxSize 100
5445
5700
  */
@@ -5447,58 +5702,85 @@ interface OrCondition {
5447
5702
  }
5448
5703
  interface Condition {
5449
5704
  /**
5450
- * The property name to be evaluated, supports dot notation for nested properties.
5705
+ * Human readable identifier used to reference a field.
5706
+ * Supports dot notation for nested properties. For example, `"address.city"`.
5451
5707
  * @maxLength 100
5452
5708
  */
5453
5709
  target?: string;
5454
- /** The operator to use for comparison. */
5710
+ /** Comparison operator to use for evaluating the condition. */
5455
5711
  operator?: OperatorWithLiterals;
5456
- /** The value to compare against. */
5712
+ /** Value to compare against the value in the target field. */
5457
5713
  value?: any;
5458
5714
  }
5459
5715
  declare enum Operator {
5460
5716
  UNKNOWN_OPERATOR = "UNKNOWN_OPERATOR",
5717
+ /** Specified value equals the value in the target field. */
5461
5718
  EQUAL = "EQUAL",
5719
+ /** Specified value doesn't equal the value in the target field. */
5462
5720
  NOT_EQUAL = "NOT_EQUAL",
5721
+ /** Target field is empty or has no value. */
5463
5722
  EMPTY = "EMPTY",
5723
+ /** Target field isn't empty and has a value. */
5464
5724
  NOT_EMPTY = "NOT_EMPTY",
5725
+ /** String value in the target field contains the specified substring. */
5465
5726
  CONTAINS = "CONTAINS",
5727
+ /** String value in the target field doesn't contain the specified substring. */
5466
5728
  NOT_CONTAINS = "NOT_CONTAINS",
5729
+ /** Numeric value in the target field is less than the specified value. */
5467
5730
  LESS_THAN = "LESS_THAN",
5731
+ /** Numeric value in the target field is less than or equal to the specified value. */
5468
5732
  LESS_THAN_OR_EQUALS = "LESS_THAN_OR_EQUALS",
5733
+ /** Numeric value in the target field is greater than the specified value. */
5469
5734
  GREATER_THAN = "GREATER_THAN",
5735
+ /** Numeric value in the target field is greater than or equal to the specified value. */
5470
5736
  GREATER_THAN_OR_EQUALS = "GREATER_THAN_OR_EQUALS",
5737
+ /** Date value in the target field is before the specified date. */
5471
5738
  BEFORE = "BEFORE",
5739
+ /** Date value in the target field is before or equal to the specified date. */
5472
5740
  BEFORE_OR_EQUAL = "BEFORE_OR_EQUAL",
5741
+ /** Date value in the target field is after the specified date. */
5473
5742
  AFTER = "AFTER",
5743
+ /** Date value in the target field is after or equal to the specified date. */
5474
5744
  AFTER_OR_EQUAL = "AFTER_OR_EQUAL",
5745
+ /** Value in the target field falls within the specified range. */
5475
5746
  BETWEEN = "BETWEEN",
5747
+ /** Value in the target field matches any of the specified values. */
5476
5748
  ANY = "ANY",
5749
+ /** Array value in the target field exactly equals the specified array. */
5477
5750
  ARRAY_EQUAL = "ARRAY_EQUAL",
5751
+ /** Array value in the target field doesn't equal the specified array. */
5478
5752
  ARRAY_NOT_EQUAL = "ARRAY_NOT_EQUAL",
5753
+ /** Checkbox or boolean field value in the target field is checked. */
5479
5754
  CHECKED = "CHECKED",
5755
+ /** Checkbox or boolean field value in the target field isn't checked. */
5480
5756
  NOT_CHECKED = "NOT_CHECKED",
5757
+ /** Value in the target field is included in the specified list. */
5481
5758
  IN = "IN",
5759
+ /** Value in the target field isn't included in the specified list. */
5482
5760
  NOT_IN = "NOT_IN",
5761
+ /** Date value in the target field is older than the specified time period. */
5483
5762
  IS_DATE_OLDER_THAN = "IS_DATE_OLDER_THAN",
5763
+ /** Date value in the target field is older than or equal to the specified time period. */
5484
5764
  IS_DATE_OLDER_THAN_OR_EQUAL = "IS_DATE_OLDER_THAN_OR_EQUAL",
5765
+ /** Date value in the target field is newer than the specified time period. */
5485
5766
  IS_DATE_NEWER_THAN = "IS_DATE_NEWER_THAN",
5767
+ /** Date value in the target field is newer than or equal to the specified time period. */
5486
5768
  IS_DATE_NEWER_THAN_OR_EQUAL = "IS_DATE_NEWER_THAN_OR_EQUAL"
5487
5769
  }
5488
5770
  /** @enumType */
5489
5771
  type OperatorWithLiterals = Operator | 'UNKNOWN_OPERATOR' | 'EQUAL' | 'NOT_EQUAL' | 'EMPTY' | 'NOT_EMPTY' | 'CONTAINS' | 'NOT_CONTAINS' | 'LESS_THAN' | 'LESS_THAN_OR_EQUALS' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUALS' | 'BEFORE' | 'BEFORE_OR_EQUAL' | 'AFTER' | 'AFTER_OR_EQUAL' | 'BETWEEN' | 'ANY' | 'ARRAY_EQUAL' | 'ARRAY_NOT_EQUAL' | 'CHECKED' | 'NOT_CHECKED' | 'IN' | 'NOT_IN' | 'IS_DATE_OLDER_THAN' | 'IS_DATE_OLDER_THAN_OR_EQUAL' | 'IS_DATE_NEWER_THAN' | 'IS_DATE_NEWER_THAN_OR_EQUAL';
5490
5772
  interface RuleFormOverride extends RuleFormOverrideEntityTypeOptionsOneOf {
5491
- /** Field override properties. */
5773
+ /** Field override settings. */
5492
5774
  fieldOptions?: FieldOverride;
5493
5775
  /**
5494
- * Override entity type.
5776
+ * Type of form element being modified by this override.
5495
5777
  * @immutable
5496
5778
  */
5497
5779
  entityType?: OverrideEntityTypeEnumOverrideEntityTypeWithLiterals;
5498
5780
  }
5499
5781
  /** @oneof */
5500
5782
  interface RuleFormOverrideEntityTypeOptionsOneOf {
5501
- /** Field override properties. */
5783
+ /** Field override settings. */
5502
5784
  fieldOptions?: FieldOverride;
5503
5785
  }
5504
5786
  interface CreateCheckoutFromSubmissionResponse {
@@ -5742,7 +6024,7 @@ interface SubmissionValidationErrorsDetails {
5742
6024
  }
5743
6025
  interface ValidationError {
5744
6026
  /**
5745
- * Path indicating the source of the error, such as `submission.submissions.email``
6027
+ * Path indicating the source of the error, such as `submission.submissions.email`
5746
6028
  * @maxLength 1000
5747
6029
  */
5748
6030
  errorPath?: string;
@@ -7631,4 +7913,4 @@ interface ValidateFormSubmissionOptions {
7631
7913
  fieldsToValidate?: string[];
7632
7914
  }
7633
7915
 
7634
- export { ProductType as $, type BulkUpdateFormSubmissionTagsOptions as A, type BulkDeleteSubmissionOptions as B, type CreateSubmissionOptions as C, type DeleteSubmissionOptions as D, type BulkUpdateFormSubmissionTagsResponse as E, type FormSubmission as F, type GetDeletedSubmissionResponse as G, type BulkUpdateFormSubmissionTagsByFilterOptions as H, type BulkUpdateFormSubmissionTagsByFilterResponse as I, type ValidateFormSubmissionResponse as J, type SubmissionCreatedEnvelope as K, type ListDeletedSubmissionsOptions as L, type SubmissionDeletedEnvelope as M, type SubmissionRemovedSubmissionFromTrashEnvelope as N, type SubmissionStatusUpdatedEnvelope as O, type SubmissionContactMappedEnvelope as P, type QuerySubmissionOptions as Q, type RestoreSubmissionFromTrashBinResponse as R, type SearchSubmissionsByNamespaceResponse as S, type SubmissionContactMappingSkippedEnvelope as T, type UpsertContactFromSubmissionOptions as U, type ValidateFormSubmissionOptions as V, type SubmissionUpdatedEnvelope as W, SubmissionStatus as X, OptInLevel as Y, StringTypeFormatEnumFormat as Z, ValidationFormat as _, type UpsertContactFromSubmissionResponse as a, FormFieldV2FieldType as a$, PriceType as a0, InputFieldStringTypeFormatEnumFormat as a1, InputFieldStringComponentType as a2, NodeType as a3, WidthType as a4, PluginContainerDataAlignment as a5, ButtonDataType as a6, LinkTarget as a7, TextAlignment as a8, LineStyle as a9, InitialExpandedItems as aA, Direction as aB, VerticalAlignment as aC, NullValue as aD, ImagePosition as aE, Alignment as aF, ImageFit as aG, NumberOfColumns as aH, FirstDayOfWeek as aI, InputFieldNumberComponentType as aJ, InputFieldBooleanComponentType as aK, ArrayItemsItemType as aL, PropertiesTypePropertiesTypeEnum as aM, InputFieldArrayComponentType as aN, InputFieldWixFileComponentType as aO, UploadFileFormat as aP, InputFieldPaymentComponentType as aQ, InputFieldSchedulingComponentType as aR, Format as aS, MultilineAddressComponentType as aT, Type as aU, InputFieldInputType as aV, FormFieldContactInfoEmailInfoTag as aW, FormFieldContactInfoPhoneInfoTag as aX, AddressInfoTag as aY, SubscriptionInfoOptInLevel as aZ, FormFieldContactInfoContactField as a_, Width as aa, DividerDataAlignment as ab, ViewMode as ac, LayoutType as ad, Orientation as ae, Crop as af, ThumbnailsAlignment as ag, GIFType as ah, Source as ai, StylesPosition as aj, MapType as ak, ViewRole as al, VoteRole as am, PollLayoutType as an, PollLayoutDirection as ao, BackgroundType as ap, DecorationType as aq, FontType as ar, Position as as, AspectRatio as at, Resizing as au, Placement as av, CardStylesType as aw, CardStylesAlignment as ax, Layout as ay, AppType as az, type CreateSubmissionApplicationErrors as b, type FormFieldArrayType as b$, DisplayFieldType as b0, FieldType as b1, FormatEnumFormat as b2, StringComponentType as b3, NumberComponentType as b4, BooleanComponentType as b5, ItemType as b6, PropertiesTypeEnum as b7, ArrayComponentType as b8, WixFileComponentType as b9, SubmissionErrorType as bA, type Submitter as bB, type SubmitterSubmitterOneOf as bC, type ExtendedFields as bD, type OrderDetails as bE, type PublicTags as bF, type TagList as bG, type FormSubmissionStatusUpdatedEvent as bH, type RemovedSubmissionFromTrash as bI, type SubmissionContactMapped as bJ, type MarketingSubscriptionDetails as bK, type SubmissionContactMappingSkipped as bL, type CreateCheckoutFromSubmissionRequest as bM, type CreateCheckoutFromSubmissionRequestFormSchemaIdentifierOneOf as bN, type Form as bO, type FormField as bP, type FormFieldStringType as bQ, type FormFieldStringTypeFormatOptionsOneOf as bR, type StringErrorMessages as bS, type StringTypeDateTimeConstraints as bT, type StringTypePhoneConstraints as bU, type StringTypeValidationMessages as bV, type FormFieldNumberType as bW, type NumberErrorMessages as bX, type IntegerType as bY, type FormFieldBooleanType as bZ, type BooleanErrorMessages as b_, PaymentComponentType as ba, ComponentType as bb, SchedulingComponentType as bc, InputType as bd, EmailInfoTag as be, PhoneInfoTag as bf, Tag as bg, ConfirmationLevel as bh, ContactField as bi, DisplayFieldDisplayFieldType as bj, OverrideEntityType as bk, Kind as bl, SpamFilterProtectionLevel as bm, RequiredIndicator as bn, RequiredIndicatorPlacement as bo, Target as bp, SubmitSuccessAction as bq, ChangeableProperty as br, OverrideEntityTypeEnumOverrideEntityType as bs, Operator as bt, WebhookIdentityType as bu, IdentityType as bv, ErrorType as bw, SortOrder as bx, Mode as by, Status as bz, type CreateSubmissionValidationErrors as c, type GIFData as c$, type FormFieldObjectType as c0, type ObjectTypePropertiesType as c1, type ObjectTypePropertiesTypePropertiesTypeOneOf as c2, type ObjectErrorMessages as c3, type ArrayTypeArrayItems as c4, type ArrayTypeArrayItemsItemsOneOf as c5, type ArrayErrorMessages as c6, type PredefinedValidation as c7, type PredefinedValidationFormatOptionsOneOf as c8, type PaymentType as c9, type Colors as cA, type PluginContainerData as cB, type PluginContainerDataWidth as cC, type PluginContainerDataWidthDataOneOf as cD, type Spoiler as cE, type Height as cF, type Styles as cG, type Link as cH, type LinkDataOneOf as cI, type Rel as cJ, type CodeBlockData as cK, type TextStyle as cL, type DividerData as cM, type FileData as cN, type FileSource as cO, type FileSourceDataOneOf as cP, type PDFSettings as cQ, type GalleryData as cR, type Media as cS, type Image as cT, type Video as cU, type Item as cV, type ItemDataOneOf as cW, type GalleryOptions as cX, type GalleryOptionsLayout as cY, type ItemStyle as cZ, type Thumbnails as c_, type QuantityLimit as ca, type FixedPriceOptions as cb, type DynamicPriceOptions as cc, type Product as cd, type ProductPriceOptionsOneOf as ce, type MultilineAddressValidation as cf, type FieldOverrides as cg, type FieldsOverrides as ch, type NestedFormFieldOverrides as ci, type Validation as cj, type ValidationValidationOneOf as ck, type DataExtensionsDetails as cl, type NestedFormOverrides as cm, type FormFieldV2 as cn, type FormFieldV2FieldTypeOptionsOneOf as co, type InputFieldStringType as cp, type InputFieldStringTypeFormatOptionsOneOf as cq, type InputFieldStringTypeDateTimeConstraints as cr, type InputFieldStringTypePhoneConstraints as cs, type TextInput as ct, type RichContent as cu, type Node as cv, type NodeDataOneOf as cw, type NodeStyle as cx, type ButtonData as cy, type Border as cz, type UpdateSubmission as d, type DocumentStyle as d$, type GIF as d0, type HeadingData as d1, type HTMLData as d2, type HTMLDataDataOneOf as d3, type ImageData as d4, type StylesBorder as d5, type ImageDataStyles as d6, type LinkPreviewData as d7, type LinkPreviewDataStyles as d8, type MapData as d9, type AppEmbedData as dA, type AppEmbedDataAppDataOneOf as dB, type BookingData as dC, type EventData as dD, type ButtonStyles as dE, type ImageStyles as dF, type RibbonStyles as dG, type CardStyles as dH, type PricingData as dI, type VideoData as dJ, type PlaybackOptions as dK, type EmbedData as dL, type Oembed as dM, type CollapsibleListData as dN, type TableData as dO, type Dimensions as dP, type TableCellData as dQ, type CellStyle as dR, type BorderColors as dS, type ListValue as dT, type AudioData as dU, type OrderedListData as dV, type BulletedListData as dW, type BlockquoteData as dX, type CaptionData as dY, type LayoutCellData as dZ, type Metadata as d_, type MapSettings as da, type ParagraphData as db, type PollData as dc, type Permissions as dd, type PollOption as de, type Settings as df, type PollLayout as dg, type OptionLayout as dh, type Gradient as di, type Background as dj, type BackgroundBackgroundOneOf as dk, type PollDesign as dl, type OptionDesign as dm, type Poll as dn, type PollDataLayout as dp, type Design as dq, type TextData as dr, type Decoration as ds, type DecorationDataOneOf as dt, type AnchorData as du, type ColorData as dv, type LinkData as dw, type MentionData as dx, type FontSizeData as dy, type SpoilerData as dz, type UpdateSubmissionValidationErrors as e, type InputField_NumberComponentTypeOptionsOneOf as e$, type TextNodeStyle as e0, type MediaItem as e1, type MediaItemMediaOneOf as e2, type MediaSettings as e3, type RadioGroup as e4, type RadioGroupOption as e5, type CustomOption as e6, type Dropdown as e7, type DropdownOption as e8, type DateTimeInput as e9, type ProductCheckboxGroupOption as eA, type DonationInput as eB, type DonationInputOption as eC, type PaymentInput as eD, type FixedPayment as eE, type Appointment as eF, type AppointmentFormatInfoOneOf as eG, type Location as eH, type LocationLocationInfoOneOf as eI, type InPersonOptions as eJ, type VideoConferenceOptions as eK, type PhoneOptions as eL, type MultilineAddress as eM, type AddressLine2 as eN, type DefaultCountryConfig as eO, type DefaultCountryConfigOptionsOneOf as eP, type FieldsSettings as eQ, type V4FormFieldContactInfo as eR, type V4FormFieldContactInfoAdditionalInfoOneOf as eS, type FormFieldContactInfoEmailInfo as eT, type FormFieldContactInfoPhoneInfo as eU, type FormFieldContactInfoAddressInfo as eV, type FormFieldContactInfoCustomFieldInfo as eW, type FormFieldContactInfoSubscriptionInfo as eX, type InputField_String as eY, type InputField_StringComponentTypeOptionsOneOf as eZ, type InputField_Number as e_, type PhoneInput as ea, type DateInput as eb, type TimeInput as ec, type DatePicker as ed, type ServicesDropdown as ee, type ServicesDropdownOption as ef, type InputFieldNumberType as eg, type NumberInput as eh, type RatingInput as ei, type InputFieldBooleanType as ej, type Checkbox as ek, type InputFieldArrayType as el, type InputFieldIntegerType as em, type InputFieldObjectType as en, type InputFieldObjectTypePropertiesType as eo, type InputFieldObjectTypePropertiesTypePropertiesTypeOptionsOneOf as ep, type InputFieldArrayTypeArrayItems as eq, type InputFieldArrayTypeArrayItemsItemTypeOptionsOneOf as er, type CheckboxGroup as es, type Option as et, type Tags as eu, type TagsOption as ev, type FileType as ew, type FileUpload as ex, type Signature as ey, type ProductCheckboxGroup as ez, type ConfirmSubmissionResponse as f, type RichContentOptions as f$, type InputField_Boolean as f0, type InputField_BooleanComponentTypeOptionsOneOf as f1, type InputField_Array as f2, type InputField_ArrayComponentTypeOptionsOneOf as f3, type InputField_Object as f4, type InputField_ObjectValidationOneOf as f5, type InputFieldWixFile as f6, type InputFieldWixFileComponentTypeOptionsOneOf as f7, type InputFieldPayment as f8, type InputFieldPaymentComponentTypeOptionsOneOf as f9, type ArrayItemsItemTypeOptionsOneOf as fA, type FormFieldContactInfo as fB, type FormFieldContactInfoAdditionalInfoOneOf as fC, type EmailInfo as fD, type PhoneInfo as fE, type AddressInfo as fF, type CustomFieldInfo as fG, type SubscriptionInfo as fH, type _String as fI, type _StringComponentTypeOptionsOneOf as fJ, type _Number as fK, type _NumberComponentTypeOptionsOneOf as fL, type _Boolean as fM, type _BooleanComponentTypeOptionsOneOf as fN, type _Array as fO, type _ArrayComponentTypeOptionsOneOf as fP, type _Object as fQ, type WixFile as fR, type WixFileComponentTypeOptionsOneOf as fS, type Payment as fT, type PaymentComponentTypeOptionsOneOf as fU, type Scheduling as fV, type SchedulingComponentTypeOptionsOneOf as fW, type Address as fX, type AddressComponentTypeOptionsOneOf as fY, type FieldsDisplayField as fZ, type FieldsDisplayFieldDisplayFieldTypeOptionsOneOf as f_, type InputFieldMultilineAddress as fa, type InputFieldMultilineAddressComponentTypeOptionsOneOf as fb, type InputFieldScheduling as fc, type InputFieldSchedulingComponentTypeOptionsOneOf as fd, type FormFieldV2InputField as fe, type FormFieldV2InputFieldInputTypeOptionsOneOf as ff, type DisplayField as fg, type DisplayFieldDisplayFieldTypeOptionsOneOf as fh, type V4RichContentOptions as fi, type V4PageNavigationOptions as fj, type Field as fk, type FieldFieldTypeOptionsOneOf as fl, type InputField as fm, type InputFieldInputTypeOptionsOneOf as fn, type StringType as fo, type StringTypeFormatOptionsOneOf as fp, type DateTimeConstraints as fq, type PhoneConstraints as fr, type ValidationMessages as fs, type NumberType as ft, type BooleanType as fu, type ArrayType as fv, type ObjectType as fw, type PropertiesType as fx, type PropertiesTypePropertiesTypeOptionsOneOf as fy, type ArrayItems as fz, type BulkDeleteSubmissionResponse as g, type BulkSubmissionResult as g$, type PageNavigationOptions as g0, type Step as g1, type FormLayout as g2, type BreakPoint as g3, type ItemLayout as g4, type ItemLayoutItemOneOf as g5, type Group as g6, type Margin as g7, type Section as g8, type FormRule as g9, type Checkout as gA, type IsFormSubmittableRequest as gB, type IsFormSubmittableResponse as gC, type DomainEvent as gD, type DomainEventBodyOneOf as gE, type EntityCreatedEvent as gF, type RestoreInfo as gG, type EntityUpdatedEvent as gH, type EntityDeletedEvent as gI, type ActionEvent as gJ, type Empty as gK, type MessageEnvelope as gL, type IdentificationData as gM, type IdentificationDataIdOneOf as gN, type UpsertContactFromSubmissionRequest as gO, type SubmitContactResponse as gP, type CreateSubmissionRequest as gQ, type CreateSubmissionResponse as gR, type SubmissionValidationErrorsDetails as gS, type ValidationError as gT, type CreateSubmissionForMigrationRequest as gU, type CreateSubmissionForMigrationResponse as gV, type CreateSubmissionBySubmitterRequest as gW, type CreateSubmissionBySubmitterResponse as gX, type BulkCreateSubmissionBySubmitterRequest as gY, type BulkCreateSubmissionBySubmitterData as gZ, type BulkCreateSubmissionBySubmitterResponse as g_, type FormOverride as ga, type FormProperties as gb, type PostSubmissionTriggers as gc, type UpsertContact as gd, type NestedForm as ge, type LimitationRule as gf, type RequiredIndicatorProperties as gg, type SubmitSettings as gh, type SubmitSettingsSubmitSuccessActionOptionsOneOf as gi, type ThankYouMessageOptions as gj, type RedirectOptions as gk, type FieldGroup as gl, type Rule as gm, type RequiredOptions as gn, type HiddenOptions as go, type AllowedValuesOptions as gp, type FieldOverride as gq, type FieldOverridePropertyTypeOptionsOneOf as gr, type ConditionNode as gs, type ConditionNodeNodeOneOf as gt, type AndCondition as gu, type OrCondition as gv, type Condition as gw, type RuleFormOverride as gx, type RuleFormOverrideEntityTypeOptionsOneOf as gy, type CreateCheckoutFromSubmissionResponse as gz, type BulkRemoveSubmissionFromTrashBinOptions as h, type FieldViolationErrorDataOneOf as h$, type ItemMetadata as h0, type ApplicationError as h1, type BulkActionMetadata as h2, type GetSubmissionRequest as h3, type GetSubmissionResponse as h4, type GetSubmissionByCheckoutIdRequest as h5, type GetSubmissionByCheckoutIdResponse as h6, type UpdateSubmissionRequest as h7, type UpdateSubmissionResponse as h8, type ConfirmSubmissionRequest as h9, type QuerySubmissionsByNamespaceForExportResponse as hA, type CountSubmissionsByFilterRequest as hB, type FormSubmissionsCount as hC, type CountSubmissionsRequest as hD, type CountDeletedSubmissionsRequest as hE, type FormDeletedSubmissionsCount as hF, type GetMediaUploadURLRequest as hG, type BulkMarkSubmissionsAsSeenRequest as hH, type BulkMarkSubmissionsAsSeenResponse as hI, type GetSubmissionDownloadUrlRequest as hJ, type SubmissionDocument as hK, type SubmissionDocumentDocumentOneOf as hL, type DocumentReady as hM, type DownloadSubmissionRequest as hN, type RawHttpResponse as hO, type HeadersEntry as hP, type GetFormattedSubmissionRequest as hQ, type FormattedSubmission as hR, type ListFormattedSubmissionsRequest as hS, type ListFormattedSubmissionsResponse as hT, type FormattedFormSubmission as hU, type UpdateExtendedFieldsRequest as hV, type BulkUpdateFormSubmissionTagsRequest as hW, type BulkUpdateFormSubmissionTagsResult as hX, type BulkUpdateFormSubmissionTagsByFilterRequest as hY, type ValidateFormSubmissionRequest as hZ, type FieldViolation as h_, type DeleteSubmissionRequest as ha, type DeleteSubmissionResponse as hb, type BulkDeleteSubmissionRequest as hc, type BulkDeleteSubmissionResult as hd, type RestoreSubmissionFromTrashBinRequest as he, type RemoveSubmissionFromTrashBinRequest as hf, type RemoveSubmissionFromTrashBinResponse as hg, type BulkRemoveSubmissionFromTrashBinRequest as hh, type BulkRemoveSubmissionFromTrashBinResult as hi, type ListDeletedSubmissionsRequest as hj, type CursorPaging as hk, type CursorPagingMetadata as hl, type Cursors as hm, type GetDeletedSubmissionRequest as hn, type QuerySubmissionRequest as ho, type CursorQueryPagingMethodOneOf as hp, type Sorting as hq, type SearchSubmissionsByNamespaceRequest as hr, type CursorSearch as hs, type CursorSearchPagingMethodOneOf as ht, type SearchDetails as hu, type SearchSubmissionsByNamespaceForExportRequest as hv, type SearchSubmissionsByNamespaceForExportResponse as hw, type QuerySubmissionsByNamespaceRequest as hx, type QuerySubmissionsByNamespaceResponse as hy, type QuerySubmissionsByNamespaceForExportRequest as hz, type BulkRemoveSubmissionFromTrashBinResponse as i, type InputFieldArrayComponentTypeWithLiterals as i$, type SubmissionValidationErrors as i0, type SubmissionValidationError as i1, type SubmissionValidationErrorErrorMessageOneOf as i2, type BaseEventMetadata as i3, type EventMetadata as i4, type FormSubmissionSearchSpec as i5, type SubmissionsQueryResult as i6, type SubmissionStatusWithLiterals as i7, type OptInLevelWithLiterals as i8, type StringTypeFormatEnumFormatWithLiterals as i9, type VoteRoleWithLiterals as iA, type PollLayoutTypeWithLiterals as iB, type PollLayoutDirectionWithLiterals as iC, type BackgroundTypeWithLiterals as iD, type DecorationTypeWithLiterals as iE, type FontTypeWithLiterals as iF, type PositionWithLiterals as iG, type AspectRatioWithLiterals as iH, type ResizingWithLiterals as iI, type PlacementWithLiterals as iJ, type CardStylesTypeWithLiterals as iK, type CardStylesAlignmentWithLiterals as iL, type LayoutWithLiterals as iM, type AppTypeWithLiterals as iN, type InitialExpandedItemsWithLiterals as iO, type DirectionWithLiterals as iP, type VerticalAlignmentWithLiterals as iQ, type NullValueWithLiterals as iR, type ImagePositionWithLiterals as iS, type AlignmentWithLiterals as iT, type ImageFitWithLiterals as iU, type NumberOfColumnsWithLiterals as iV, type FirstDayOfWeekWithLiterals as iW, type InputFieldNumberComponentTypeWithLiterals as iX, type InputFieldBooleanComponentTypeWithLiterals as iY, type ArrayItemsItemTypeWithLiterals as iZ, type PropertiesTypePropertiesTypeEnumWithLiterals as i_, type ValidationFormatWithLiterals as ia, type ProductTypeWithLiterals as ib, type PriceTypeWithLiterals as ic, type InputFieldStringTypeFormatEnumFormatWithLiterals as id, type InputFieldStringComponentTypeWithLiterals as ie, type NodeTypeWithLiterals as ig, type WidthTypeWithLiterals as ih, type PluginContainerDataAlignmentWithLiterals as ii, type ButtonDataTypeWithLiterals as ij, type LinkTargetWithLiterals as ik, type TextAlignmentWithLiterals as il, type LineStyleWithLiterals as im, type WidthWithLiterals as io, type DividerDataAlignmentWithLiterals as ip, type ViewModeWithLiterals as iq, type LayoutTypeWithLiterals as ir, type OrientationWithLiterals as is, type CropWithLiterals as it, type ThumbnailsAlignmentWithLiterals as iu, type GIFTypeWithLiterals as iv, type SourceWithLiterals as iw, type StylesPositionWithLiterals as ix, type MapTypeWithLiterals as iy, type ViewRoleWithLiterals as iz, type ListDeletedSubmissionsResponse as j, confirmSubmission as j$, type InputFieldWixFileComponentTypeWithLiterals as j0, type UploadFileFormatWithLiterals as j1, type InputFieldPaymentComponentTypeWithLiterals as j2, type InputFieldSchedulingComponentTypeWithLiterals as j3, type FormatWithLiterals as j4, type MultilineAddressComponentTypeWithLiterals as j5, type TypeWithLiterals as j6, type InputFieldInputTypeWithLiterals as j7, type FormFieldContactInfoEmailInfoTagWithLiterals as j8, type FormFieldContactInfoPhoneInfoTagWithLiterals as j9, type SpamFilterProtectionLevelWithLiterals as jA, type RequiredIndicatorWithLiterals as jB, type RequiredIndicatorPlacementWithLiterals as jC, type TargetWithLiterals as jD, type SubmitSuccessActionWithLiterals as jE, type ChangeablePropertyWithLiterals as jF, type OverrideEntityTypeEnumOverrideEntityTypeWithLiterals as jG, type OperatorWithLiterals as jH, type WebhookIdentityTypeWithLiterals as jI, type IdentityTypeWithLiterals as jJ, type ErrorTypeWithLiterals as jK, type SortOrderWithLiterals as jL, type ModeWithLiterals as jM, type StatusWithLiterals as jN, type SubmissionErrorTypeWithLiterals as jO, type CommonSearchWithEntityContext as jP, onSubmissionCreated as jQ, onSubmissionDeleted as jR, onSubmissionRemovedSubmissionFromTrash as jS, onSubmissionStatusUpdated as jT, onSubmissionContactMapped as jU, onSubmissionContactMappingSkipped as jV, onSubmissionUpdated as jW, upsertContactFromSubmission as jX, createSubmission as jY, getSubmission as jZ, updateSubmission as j_, type AddressInfoTagWithLiterals as ja, type SubscriptionInfoOptInLevelWithLiterals as jb, type FormFieldContactInfoContactFieldWithLiterals as jc, type FormFieldV2FieldTypeWithLiterals as jd, type DisplayFieldTypeWithLiterals as je, type FieldTypeWithLiterals as jf, type FormatEnumFormatWithLiterals as jg, type StringComponentTypeWithLiterals as jh, type NumberComponentTypeWithLiterals as ji, type BooleanComponentTypeWithLiterals as jj, type ItemTypeWithLiterals as jk, type PropertiesTypeEnumWithLiterals as jl, type ArrayComponentTypeWithLiterals as jm, type WixFileComponentTypeWithLiterals as jn, type PaymentComponentTypeWithLiterals as jo, type ComponentTypeWithLiterals as jp, type SchedulingComponentTypeWithLiterals as jq, type InputTypeWithLiterals as jr, type EmailInfoTagWithLiterals as js, type PhoneInfoTagWithLiterals as jt, type TagWithLiterals as ju, type ConfirmationLevelWithLiterals as jv, type ContactFieldWithLiterals as jw, type DisplayFieldDisplayFieldTypeWithLiterals as jx, type OverrideEntityTypeWithLiterals as jy, type KindWithLiterals as jz, type CursorQuery as k, deleteSubmission as k0, bulkDeleteSubmission as k1, restoreSubmissionFromTrashBin as k2, removeSubmissionFromTrashBin as k3, bulkRemoveSubmissionFromTrashBin as k4, listDeletedSubmissions as k5, getDeletedSubmission as k6, querySubmission as k7, querySubmissionsByNamespace as k8, countSubmissionsByFilter as k9, countSubmissions as ka, countDeletedSubmissions as kb, getMediaUploadUrl as kc, bulkMarkSubmissionsAsSeen as kd, getSubmissionDownloadUrl as ke, getFormattedSubmission as kf, updateExtendedFields as kg, bulkUpdateFormSubmissionTags as kh, bulkUpdateFormSubmissionTagsByFilter as ki, validateFormSubmission as kj, type QuerySubmissionResponse as l, type FormSubmissionSearch as m, type QuerySubmissionsByNamespaceOptions as n, type SubmissionsQueryBuilder as o, type CountSubmissionsByFilterOptions as p, type CountSubmissionsByFilterResponse as q, type CountSubmissionsOptions as r, type CountSubmissionsResponse as s, type CountDeletedSubmissionsOptions as t, type CountDeletedSubmissionsResponse as u, type GetMediaUploadURLResponse as v, type GetSubmissionDownloadUrlResponse as w, type GetFormattedSubmissionResponse as x, type UpdateExtendedFieldsOptions as y, type UpdateExtendedFieldsResponse as z };
7916
+ export { ProductType as $, type BulkUpdateFormSubmissionTagsOptions as A, type BulkDeleteSubmissionOptions as B, type CreateSubmissionOptions as C, type DeleteSubmissionOptions as D, type BulkUpdateFormSubmissionTagsResponse as E, type FormSubmission as F, type GetDeletedSubmissionResponse as G, type BulkUpdateFormSubmissionTagsByFilterOptions as H, type BulkUpdateFormSubmissionTagsByFilterResponse as I, type ValidateFormSubmissionResponse as J, type SubmissionCreatedEnvelope as K, type ListDeletedSubmissionsOptions as L, type SubmissionDeletedEnvelope as M, type SubmissionRemovedSubmissionFromTrashEnvelope as N, type SubmissionStatusUpdatedEnvelope as O, type SubmissionContactMappedEnvelope as P, type QuerySubmissionOptions as Q, type RestoreSubmissionFromTrashBinResponse as R, type SearchSubmissionsByNamespaceResponse as S, type SubmissionContactMappingSkippedEnvelope as T, type UpsertContactFromSubmissionOptions as U, type ValidateFormSubmissionOptions as V, type SubmissionUpdatedEnvelope as W, SubmissionStatus as X, OptInLevel as Y, StringTypeFormatEnumFormat as Z, ValidationFormat as _, type UpsertContactFromSubmissionResponse as a, FormFieldV2FieldType as a$, PriceType as a0, InputFieldStringTypeFormatEnumFormat as a1, InputFieldStringComponentType as a2, NodeType as a3, WidthType as a4, PluginContainerDataAlignment as a5, ButtonDataType as a6, LinkTarget as a7, TextAlignment as a8, LineStyle as a9, InitialExpandedItems as aA, Direction as aB, VerticalAlignment as aC, NullValue as aD, ImagePosition as aE, Alignment as aF, ImageFit as aG, NumberOfColumns as aH, FirstDayOfWeek as aI, InputFieldNumberComponentType as aJ, InputFieldBooleanComponentType as aK, ArrayItemsItemType as aL, PropertiesTypePropertiesTypeEnum as aM, InputFieldArrayComponentType as aN, InputFieldWixFileComponentType as aO, UploadFileFormat as aP, InputFieldPaymentComponentType as aQ, InputFieldSchedulingComponentType as aR, Format as aS, MultilineAddressComponentType as aT, Type as aU, InputFieldInputType as aV, FormFieldContactInfoEmailInfoTag as aW, FormFieldContactInfoPhoneInfoTag as aX, AddressInfoTag as aY, SubscriptionInfoOptInLevel as aZ, FormFieldContactInfoContactField as a_, Width as aa, DividerDataAlignment as ab, ViewMode as ac, LayoutType as ad, Orientation as ae, Crop as af, ThumbnailsAlignment as ag, GIFType as ah, Source as ai, StylesPosition as aj, MapType as ak, ViewRole as al, VoteRole as am, PollLayoutType as an, PollLayoutDirection as ao, BackgroundType as ap, DecorationType as aq, FontType as ar, Position as as, AspectRatio as at, Resizing as au, Placement as av, CardStylesType as aw, CardStylesAlignment as ax, Layout as ay, AppType as az, type CreateSubmissionApplicationErrors as b, type FormFieldArrayType as b$, DisplayFieldType as b0, FieldType as b1, FormatEnumFormat as b2, StringComponentType as b3, NumberComponentType as b4, BooleanComponentType as b5, ItemType as b6, PropertiesTypeEnum as b7, ArrayComponentType as b8, WixFileComponentType as b9, SubmissionErrorType as bA, type Submitter as bB, type SubmitterSubmitterOneOf as bC, type ExtendedFields as bD, type OrderDetails as bE, type PublicTags as bF, type TagList as bG, type FormSubmissionStatusUpdatedEvent as bH, type RemovedSubmissionFromTrash as bI, type SubmissionContactMapped as bJ, type MarketingSubscriptionDetails as bK, type SubmissionContactMappingSkipped as bL, type CreateCheckoutFromSubmissionRequest as bM, type CreateCheckoutFromSubmissionRequestFormSchemaIdentifierOneOf as bN, type Form as bO, type FormField as bP, type FormFieldStringType as bQ, type FormFieldStringTypeFormatOptionsOneOf as bR, type StringErrorMessages as bS, type StringTypeDateTimeConstraints as bT, type StringTypePhoneConstraints as bU, type StringTypeValidationMessages as bV, type FormFieldNumberType as bW, type NumberErrorMessages as bX, type IntegerType as bY, type FormFieldBooleanType as bZ, type BooleanErrorMessages as b_, PaymentComponentType as ba, ComponentType as bb, SchedulingComponentType as bc, InputType as bd, EmailInfoTag as be, PhoneInfoTag as bf, Tag as bg, ConfirmationLevel as bh, ContactField as bi, DisplayFieldDisplayFieldType as bj, OverrideEntityType as bk, Kind as bl, SpamFilterProtectionLevel as bm, RequiredIndicator as bn, RequiredIndicatorPlacement as bo, Target as bp, SubmitSuccessAction as bq, ChangeableProperty as br, OverrideEntityTypeEnumOverrideEntityType as bs, Operator as bt, WebhookIdentityType as bu, IdentityType as bv, ErrorType as bw, SortOrder as bx, Mode as by, Status as bz, type CreateSubmissionValidationErrors as c, type GIFData as c$, type FormFieldObjectType as c0, type ObjectTypePropertiesType as c1, type ObjectTypePropertiesTypePropertiesTypeOneOf as c2, type ObjectErrorMessages as c3, type ArrayTypeArrayItems as c4, type ArrayTypeArrayItemsItemsOneOf as c5, type ArrayErrorMessages as c6, type PredefinedValidation as c7, type PredefinedValidationFormatOptionsOneOf as c8, type PaymentType as c9, type Colors as cA, type PluginContainerData as cB, type PluginContainerDataWidth as cC, type PluginContainerDataWidthDataOneOf as cD, type Spoiler as cE, type Height as cF, type Styles as cG, type Link as cH, type LinkDataOneOf as cI, type Rel as cJ, type CodeBlockData as cK, type TextStyle as cL, type DividerData as cM, type FileData as cN, type FileSource as cO, type FileSourceDataOneOf as cP, type PDFSettings as cQ, type GalleryData as cR, type Media as cS, type Image as cT, type Video as cU, type Item as cV, type ItemDataOneOf as cW, type GalleryOptions as cX, type GalleryOptionsLayout as cY, type ItemStyle as cZ, type Thumbnails as c_, type QuantityLimit as ca, type FixedPriceOptions as cb, type DynamicPriceOptions as cc, type Product as cd, type ProductPriceOptionsOneOf as ce, type MultilineAddressValidation as cf, type FieldOverrides as cg, type FieldsOverrides as ch, type NestedFormFieldOverrides as ci, type Validation as cj, type ValidationValidationOneOf as ck, type DataExtensionsDetails as cl, type NestedFormOverrides as cm, type FormFieldV2 as cn, type FormFieldV2FieldTypeOptionsOneOf as co, type InputFieldStringType as cp, type InputFieldStringTypeFormatOptionsOneOf as cq, type InputFieldStringTypeDateTimeConstraints as cr, type InputFieldStringTypePhoneConstraints as cs, type TextInput as ct, type RichContent as cu, type Node as cv, type NodeDataOneOf as cw, type NodeStyle as cx, type ButtonData as cy, type Border as cz, type UpdateSubmission as d, type DocumentStyle as d$, type GIF as d0, type HeadingData as d1, type HTMLData as d2, type HTMLDataDataOneOf as d3, type ImageData as d4, type StylesBorder as d5, type ImageDataStyles as d6, type LinkPreviewData as d7, type LinkPreviewDataStyles as d8, type MapData as d9, type AppEmbedData as dA, type AppEmbedDataAppDataOneOf as dB, type BookingData as dC, type EventData as dD, type ButtonStyles as dE, type ImageStyles as dF, type RibbonStyles as dG, type CardStyles as dH, type PricingData as dI, type VideoData as dJ, type PlaybackOptions as dK, type EmbedData as dL, type Oembed as dM, type CollapsibleListData as dN, type TableData as dO, type Dimensions as dP, type TableCellData as dQ, type CellStyle as dR, type BorderColors as dS, type ListValue as dT, type AudioData as dU, type OrderedListData as dV, type BulletedListData as dW, type BlockquoteData as dX, type CaptionData as dY, type LayoutCellData as dZ, type Metadata as d_, type MapSettings as da, type ParagraphData as db, type PollData as dc, type Permissions as dd, type PollOption as de, type Settings as df, type PollLayout as dg, type OptionLayout as dh, type Gradient as di, type Background as dj, type BackgroundBackgroundOneOf as dk, type PollDesign as dl, type OptionDesign as dm, type Poll as dn, type PollDataLayout as dp, type Design as dq, type TextData as dr, type Decoration as ds, type DecorationDataOneOf as dt, type AnchorData as du, type ColorData as dv, type LinkData as dw, type MentionData as dx, type FontSizeData as dy, type SpoilerData as dz, type UpdateSubmissionValidationErrors as e, type InputField_Number as e$, type TextNodeStyle as e0, type MediaItem as e1, type MediaItemMediaOneOf as e2, type MediaSettings as e3, type RadioGroup as e4, type RadioGroupOption as e5, type CustomOption as e6, type Dropdown as e7, type DropdownOption as e8, type DateTimeInput as e9, type ProductCheckboxGroup as eA, type ProductCheckboxGroupOption as eB, type DonationInput as eC, type DonationInputOption as eD, type PaymentInput as eE, type FixedPayment as eF, type Appointment as eG, type AppointmentFormatInfoOneOf as eH, type Location as eI, type LocationLocationInfoOneOf as eJ, type InPersonOptions as eK, type VideoConferenceOptions as eL, type PhoneOptions as eM, type MultilineAddress as eN, type AddressLine2 as eO, type DefaultCountryConfig as eP, type DefaultCountryConfigOptionsOneOf as eQ, type FieldsSettings as eR, type V4FormFieldContactInfo as eS, type V4FormFieldContactInfoAdditionalInfoOneOf as eT, type FormFieldContactInfoEmailInfo as eU, type FormFieldContactInfoPhoneInfo as eV, type FormFieldContactInfoAddressInfo as eW, type FormFieldContactInfoCustomFieldInfo as eX, type FormFieldContactInfoSubscriptionInfo as eY, type InputField_String as eZ, type InputField_StringComponentTypeOptionsOneOf as e_, type PhoneInput as ea, type DateInput as eb, type TimeInput as ec, type DatePicker as ed, type ServicesDropdown as ee, type ServiceOption as ef, type InputFieldNumberType as eg, type NumberInput as eh, type RatingInput as ei, type InputFieldBooleanType as ej, type Checkbox as ek, type InputFieldArrayType as el, type InputFieldIntegerType as em, type InputFieldObjectType as en, type InputFieldObjectTypePropertiesType as eo, type InputFieldObjectTypePropertiesTypePropertiesTypeOptionsOneOf as ep, type InputFieldArrayTypeArrayItems as eq, type InputFieldArrayTypeArrayItemsItemTypeOptionsOneOf as er, type CheckboxGroup as es, type Option as et, type Tags as eu, type TagsOption as ev, type ServicesCheckboxGroup as ew, type FileType as ex, type FileUpload as ey, type Signature as ez, type ConfirmSubmissionResponse as f, type FieldsDisplayFieldDisplayFieldTypeOptionsOneOf as f$, type InputField_NumberComponentTypeOptionsOneOf as f0, type InputField_Boolean as f1, type InputField_BooleanComponentTypeOptionsOneOf as f2, type InputField_Array as f3, type InputField_ArrayComponentTypeOptionsOneOf as f4, type InputField_Object as f5, type InputField_ObjectValidationOneOf as f6, type InputFieldWixFile as f7, type InputFieldWixFileComponentTypeOptionsOneOf as f8, type InputFieldPayment as f9, type ArrayItems as fA, type ArrayItemsItemTypeOptionsOneOf as fB, type FormFieldContactInfo as fC, type FormFieldContactInfoAdditionalInfoOneOf as fD, type EmailInfo as fE, type PhoneInfo as fF, type AddressInfo as fG, type CustomFieldInfo as fH, type SubscriptionInfo as fI, type _String as fJ, type _StringComponentTypeOptionsOneOf as fK, type _Number as fL, type _NumberComponentTypeOptionsOneOf as fM, type _Boolean as fN, type _BooleanComponentTypeOptionsOneOf as fO, type _Array as fP, type _ArrayComponentTypeOptionsOneOf as fQ, type _Object as fR, type WixFile as fS, type WixFileComponentTypeOptionsOneOf as fT, type Payment as fU, type PaymentComponentTypeOptionsOneOf as fV, type Scheduling as fW, type SchedulingComponentTypeOptionsOneOf as fX, type Address as fY, type AddressComponentTypeOptionsOneOf as fZ, type FieldsDisplayField as f_, type InputFieldPaymentComponentTypeOptionsOneOf as fa, type InputFieldMultilineAddress as fb, type InputFieldMultilineAddressComponentTypeOptionsOneOf as fc, type InputFieldScheduling as fd, type InputFieldSchedulingComponentTypeOptionsOneOf as fe, type FormFieldV2InputField as ff, type FormFieldV2InputFieldInputTypeOptionsOneOf as fg, type DisplayField as fh, type DisplayFieldDisplayFieldTypeOptionsOneOf as fi, type V4RichContentOptions as fj, type V4PageNavigationOptions as fk, type Field as fl, type FieldFieldTypeOptionsOneOf as fm, type InputField as fn, type InputFieldInputTypeOptionsOneOf as fo, type StringType as fp, type StringTypeFormatOptionsOneOf as fq, type DateTimeConstraints as fr, type PhoneConstraints as fs, type ValidationMessages as ft, type NumberType as fu, type BooleanType as fv, type ArrayType as fw, type ObjectType as fx, type PropertiesType as fy, type PropertiesTypePropertiesTypeOptionsOneOf as fz, type BulkDeleteSubmissionResponse as g, type BulkCreateSubmissionBySubmitterResponse as g$, type RichContentOptions as g0, type PageNavigationOptions as g1, type Step as g2, type FormLayout as g3, type BreakPoint as g4, type ItemLayout as g5, type ItemLayoutItemOneOf as g6, type Group as g7, type Margin as g8, type Section as g9, type CreateCheckoutFromSubmissionResponse as gA, type Checkout as gB, type IsFormSubmittableRequest as gC, type IsFormSubmittableResponse as gD, type DomainEvent as gE, type DomainEventBodyOneOf as gF, type EntityCreatedEvent as gG, type RestoreInfo as gH, type EntityUpdatedEvent as gI, type EntityDeletedEvent as gJ, type ActionEvent as gK, type Empty as gL, type MessageEnvelope as gM, type IdentificationData as gN, type IdentificationDataIdOneOf as gO, type UpsertContactFromSubmissionRequest as gP, type SubmitContactResponse as gQ, type CreateSubmissionRequest as gR, type CreateSubmissionResponse as gS, type SubmissionValidationErrorsDetails as gT, type ValidationError as gU, type CreateSubmissionForMigrationRequest as gV, type CreateSubmissionForMigrationResponse as gW, type CreateSubmissionBySubmitterRequest as gX, type CreateSubmissionBySubmitterResponse as gY, type BulkCreateSubmissionBySubmitterRequest as gZ, type BulkCreateSubmissionBySubmitterData as g_, type FormRule as ga, type FormOverride as gb, type FormProperties as gc, type PostSubmissionTriggers as gd, type UpsertContact as ge, type NestedForm as gf, type LimitationRule as gg, type RequiredIndicatorProperties as gh, type SubmitSettings as gi, type SubmitSettingsSubmitSuccessActionOptionsOneOf as gj, type ThankYouMessageOptions as gk, type RedirectOptions as gl, type FieldGroup as gm, type Rule as gn, type RequiredOptions as go, type HiddenOptions as gp, type AllowedValuesOptions as gq, type FieldOverride as gr, type FieldOverridePropertyTypeOptionsOneOf as gs, type ConditionNode as gt, type ConditionNodeNodeOneOf as gu, type AndCondition as gv, type OrCondition as gw, type Condition as gx, type RuleFormOverride as gy, type RuleFormOverrideEntityTypeOptionsOneOf as gz, type BulkRemoveSubmissionFromTrashBinOptions as h, type FieldViolation as h$, type BulkSubmissionResult as h0, type ItemMetadata as h1, type ApplicationError as h2, type BulkActionMetadata as h3, type GetSubmissionRequest as h4, type GetSubmissionResponse as h5, type GetSubmissionByCheckoutIdRequest as h6, type GetSubmissionByCheckoutIdResponse as h7, type UpdateSubmissionRequest as h8, type UpdateSubmissionResponse as h9, type QuerySubmissionsByNamespaceForExportRequest as hA, type QuerySubmissionsByNamespaceForExportResponse as hB, type CountSubmissionsByFilterRequest as hC, type FormSubmissionsCount as hD, type CountSubmissionsRequest as hE, type CountDeletedSubmissionsRequest as hF, type FormDeletedSubmissionsCount as hG, type GetMediaUploadURLRequest as hH, type BulkMarkSubmissionsAsSeenRequest as hI, type BulkMarkSubmissionsAsSeenResponse as hJ, type GetSubmissionDownloadUrlRequest as hK, type SubmissionDocument as hL, type SubmissionDocumentDocumentOneOf as hM, type DocumentReady as hN, type DownloadSubmissionRequest as hO, type RawHttpResponse as hP, type HeadersEntry as hQ, type GetFormattedSubmissionRequest as hR, type FormattedSubmission as hS, type ListFormattedSubmissionsRequest as hT, type ListFormattedSubmissionsResponse as hU, type FormattedFormSubmission as hV, type UpdateExtendedFieldsRequest as hW, type BulkUpdateFormSubmissionTagsRequest as hX, type BulkUpdateFormSubmissionTagsResult as hY, type BulkUpdateFormSubmissionTagsByFilterRequest as hZ, type ValidateFormSubmissionRequest as h_, type ConfirmSubmissionRequest as ha, type DeleteSubmissionRequest as hb, type DeleteSubmissionResponse as hc, type BulkDeleteSubmissionRequest as hd, type BulkDeleteSubmissionResult as he, type RestoreSubmissionFromTrashBinRequest as hf, type RemoveSubmissionFromTrashBinRequest as hg, type RemoveSubmissionFromTrashBinResponse as hh, type BulkRemoveSubmissionFromTrashBinRequest as hi, type BulkRemoveSubmissionFromTrashBinResult as hj, type ListDeletedSubmissionsRequest as hk, type CursorPaging as hl, type CursorPagingMetadata as hm, type Cursors as hn, type GetDeletedSubmissionRequest as ho, type QuerySubmissionRequest as hp, type CursorQueryPagingMethodOneOf as hq, type Sorting as hr, type SearchSubmissionsByNamespaceRequest as hs, type CursorSearch as ht, type CursorSearchPagingMethodOneOf as hu, type SearchDetails as hv, type SearchSubmissionsByNamespaceForExportRequest as hw, type SearchSubmissionsByNamespaceForExportResponse as hx, type QuerySubmissionsByNamespaceRequest as hy, type QuerySubmissionsByNamespaceResponse as hz, type BulkRemoveSubmissionFromTrashBinResponse as i, type PropertiesTypePropertiesTypeEnumWithLiterals as i$, type FieldViolationErrorDataOneOf as i0, type SubmissionValidationErrors as i1, type SubmissionValidationError as i2, type SubmissionValidationErrorErrorMessageOneOf as i3, type BaseEventMetadata as i4, type EventMetadata as i5, type FormSubmissionSearchSpec as i6, type SubmissionsQueryResult as i7, type SubmissionStatusWithLiterals as i8, type OptInLevelWithLiterals as i9, type ViewRoleWithLiterals as iA, type VoteRoleWithLiterals as iB, type PollLayoutTypeWithLiterals as iC, type PollLayoutDirectionWithLiterals as iD, type BackgroundTypeWithLiterals as iE, type DecorationTypeWithLiterals as iF, type FontTypeWithLiterals as iG, type PositionWithLiterals as iH, type AspectRatioWithLiterals as iI, type ResizingWithLiterals as iJ, type PlacementWithLiterals as iK, type CardStylesTypeWithLiterals as iL, type CardStylesAlignmentWithLiterals as iM, type LayoutWithLiterals as iN, type AppTypeWithLiterals as iO, type InitialExpandedItemsWithLiterals as iP, type DirectionWithLiterals as iQ, type VerticalAlignmentWithLiterals as iR, type NullValueWithLiterals as iS, type ImagePositionWithLiterals as iT, type AlignmentWithLiterals as iU, type ImageFitWithLiterals as iV, type NumberOfColumnsWithLiterals as iW, type FirstDayOfWeekWithLiterals as iX, type InputFieldNumberComponentTypeWithLiterals as iY, type InputFieldBooleanComponentTypeWithLiterals as iZ, type ArrayItemsItemTypeWithLiterals as i_, type StringTypeFormatEnumFormatWithLiterals as ia, type ValidationFormatWithLiterals as ib, type ProductTypeWithLiterals as ic, type PriceTypeWithLiterals as id, type InputFieldStringTypeFormatEnumFormatWithLiterals as ie, type InputFieldStringComponentTypeWithLiterals as ig, type NodeTypeWithLiterals as ih, type WidthTypeWithLiterals as ii, type PluginContainerDataAlignmentWithLiterals as ij, type ButtonDataTypeWithLiterals as ik, type LinkTargetWithLiterals as il, type TextAlignmentWithLiterals as im, type LineStyleWithLiterals as io, type WidthWithLiterals as ip, type DividerDataAlignmentWithLiterals as iq, type ViewModeWithLiterals as ir, type LayoutTypeWithLiterals as is, type OrientationWithLiterals as it, type CropWithLiterals as iu, type ThumbnailsAlignmentWithLiterals as iv, type GIFTypeWithLiterals as iw, type SourceWithLiterals as ix, type StylesPositionWithLiterals as iy, type MapTypeWithLiterals as iz, type ListDeletedSubmissionsResponse as j, updateSubmission as j$, type InputFieldArrayComponentTypeWithLiterals as j0, type InputFieldWixFileComponentTypeWithLiterals as j1, type UploadFileFormatWithLiterals as j2, type InputFieldPaymentComponentTypeWithLiterals as j3, type InputFieldSchedulingComponentTypeWithLiterals as j4, type FormatWithLiterals as j5, type MultilineAddressComponentTypeWithLiterals as j6, type TypeWithLiterals as j7, type InputFieldInputTypeWithLiterals as j8, type FormFieldContactInfoEmailInfoTagWithLiterals as j9, type KindWithLiterals as jA, type SpamFilterProtectionLevelWithLiterals as jB, type RequiredIndicatorWithLiterals as jC, type RequiredIndicatorPlacementWithLiterals as jD, type TargetWithLiterals as jE, type SubmitSuccessActionWithLiterals as jF, type ChangeablePropertyWithLiterals as jG, type OverrideEntityTypeEnumOverrideEntityTypeWithLiterals as jH, type OperatorWithLiterals as jI, type WebhookIdentityTypeWithLiterals as jJ, type IdentityTypeWithLiterals as jK, type ErrorTypeWithLiterals as jL, type SortOrderWithLiterals as jM, type ModeWithLiterals as jN, type StatusWithLiterals as jO, type SubmissionErrorTypeWithLiterals as jP, type CommonSearchWithEntityContext as jQ, onSubmissionCreated as jR, onSubmissionDeleted as jS, onSubmissionRemovedSubmissionFromTrash as jT, onSubmissionStatusUpdated as jU, onSubmissionContactMapped as jV, onSubmissionContactMappingSkipped as jW, onSubmissionUpdated as jX, upsertContactFromSubmission as jY, createSubmission as jZ, getSubmission as j_, type FormFieldContactInfoPhoneInfoTagWithLiterals as ja, type AddressInfoTagWithLiterals as jb, type SubscriptionInfoOptInLevelWithLiterals as jc, type FormFieldContactInfoContactFieldWithLiterals as jd, type FormFieldV2FieldTypeWithLiterals as je, type DisplayFieldTypeWithLiterals as jf, type FieldTypeWithLiterals as jg, type FormatEnumFormatWithLiterals as jh, type StringComponentTypeWithLiterals as ji, type NumberComponentTypeWithLiterals as jj, type BooleanComponentTypeWithLiterals as jk, type ItemTypeWithLiterals as jl, type PropertiesTypeEnumWithLiterals as jm, type ArrayComponentTypeWithLiterals as jn, type WixFileComponentTypeWithLiterals as jo, type PaymentComponentTypeWithLiterals as jp, type ComponentTypeWithLiterals as jq, type SchedulingComponentTypeWithLiterals as jr, type InputTypeWithLiterals as js, type EmailInfoTagWithLiterals as jt, type PhoneInfoTagWithLiterals as ju, type TagWithLiterals as jv, type ConfirmationLevelWithLiterals as jw, type ContactFieldWithLiterals as jx, type DisplayFieldDisplayFieldTypeWithLiterals as jy, type OverrideEntityTypeWithLiterals as jz, type CursorQuery as k, confirmSubmission as k0, deleteSubmission as k1, bulkDeleteSubmission as k2, restoreSubmissionFromTrashBin as k3, removeSubmissionFromTrashBin as k4, bulkRemoveSubmissionFromTrashBin as k5, listDeletedSubmissions as k6, getDeletedSubmission as k7, querySubmission as k8, querySubmissionsByNamespace as k9, countSubmissionsByFilter as ka, countSubmissions as kb, countDeletedSubmissions as kc, getMediaUploadUrl as kd, bulkMarkSubmissionsAsSeen as ke, getSubmissionDownloadUrl as kf, getFormattedSubmission as kg, updateExtendedFields as kh, bulkUpdateFormSubmissionTags as ki, bulkUpdateFormSubmissionTagsByFilter as kj, validateFormSubmission as kk, type QuerySubmissionResponse as l, type FormSubmissionSearch as m, type QuerySubmissionsByNamespaceOptions as n, type SubmissionsQueryBuilder as o, type CountSubmissionsByFilterOptions as p, type CountSubmissionsByFilterResponse as q, type CountSubmissionsOptions as r, type CountSubmissionsResponse as s, type CountDeletedSubmissionsOptions as t, type CountDeletedSubmissionsResponse as u, type GetMediaUploadURLResponse as v, type GetSubmissionDownloadUrlResponse as w, type GetFormattedSubmissionResponse as x, type UpdateExtendedFieldsOptions as y, type UpdateExtendedFieldsResponse as z };