@wix/auto_sdk_forms_submissions 1.0.49 → 1.0.50

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 (25) hide show
  1. package/build/cjs/{forms-v4-submission-submissions.universal-BEPxuOFF.d.ts → forms-v4-submission-submissions.universal-CAOCOZwK.d.ts} +570 -816
  2. package/build/cjs/index.d.ts +2 -2
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +2 -2
  5. package/build/cjs/index.typings.js.map +1 -1
  6. package/build/cjs/meta.d.ts +1 -1
  7. package/build/es/{forms-v4-submission-submissions.universal-BEPxuOFF.d.mts → forms-v4-submission-submissions.universal-CAOCOZwK.d.mts} +570 -816
  8. package/build/es/index.d.mts +2 -2
  9. package/build/es/index.mjs.map +1 -1
  10. package/build/es/index.typings.d.mts +2 -2
  11. package/build/es/index.typings.mjs.map +1 -1
  12. package/build/es/meta.d.mts +1 -1
  13. package/build/internal/cjs/{forms-v4-submission-submissions.universal-38ZdY7HP.d.ts → forms-v4-submission-submissions.universal-Bgv6JDTp.d.ts} +570 -816
  14. package/build/internal/cjs/index.d.ts +2 -2
  15. package/build/internal/cjs/index.js.map +1 -1
  16. package/build/internal/cjs/index.typings.d.ts +2 -2
  17. package/build/internal/cjs/index.typings.js.map +1 -1
  18. package/build/internal/cjs/meta.d.ts +1 -1
  19. package/build/internal/es/{forms-v4-submission-submissions.universal-38ZdY7HP.d.mts → forms-v4-submission-submissions.universal-Bgv6JDTp.d.mts} +570 -816
  20. package/build/internal/es/index.d.mts +2 -2
  21. package/build/internal/es/index.mjs.map +1 -1
  22. package/build/internal/es/index.typings.d.mts +2 -2
  23. package/build/internal/es/index.typings.mjs.map +1 -1
  24. package/build/internal/es/meta.d.mts +1 -1
  25. package/package.json +2 -2
@@ -272,19 +272,18 @@ interface CreateCheckoutFromSubmissionRequestFormSchemaIdentifierOneOf {
272
272
  }
273
273
  interface Form {
274
274
  /**
275
- * Form schema ID.
275
+ * Form ID.
276
276
  * @format GUID
277
277
  * @readonly
278
278
  */
279
279
  _id?: string | null;
280
280
  /**
281
- * Form fields that define the input elements and their validation rules.
281
+ * List of form fields that represent input elements.
282
282
  * @maxSize 500
283
283
  */
284
284
  formFields?: Field[];
285
285
  /**
286
- * Layout configuration that defines how form fields are organized across multiple steps.
287
- * Each step represents a page of the form.
286
+ * Defines the layout for form fields in each submission step.
288
287
  * @maxSize 100
289
288
  */
290
289
  steps?: Step[];
@@ -297,18 +296,17 @@ interface Form {
297
296
  */
298
297
  rules?: FormRule[];
299
298
  /**
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.
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.
302
300
  * @readonly
303
301
  */
304
302
  revision?: string | null;
305
303
  /**
306
- * Date and time when the form schema was created.
304
+ * Date of creation.
307
305
  * @readonly
308
306
  */
309
307
  _createdDate?: Date | null;
310
308
  /**
311
- * Date and time when the form schema was last updated.
309
+ * Date of last update.
312
310
  * @readonly
313
311
  */
314
312
  _updatedDate?: Date | null;
@@ -325,60 +323,51 @@ interface Form {
325
323
  */
326
324
  deletedFieldsV2?: FormFieldV2[];
327
325
  /**
328
- * Form fields that were soft deleted.
326
+ * List of form fields which were soft deleted.
329
327
  * @maxSize 150
330
328
  * @readonly
331
329
  */
332
330
  deletedFormFields?: Field[];
333
- /** Data extensions for storing additional custom properties. */
331
+ /** Data extensions ExtendedFields. */
334
332
  extendedFields?: ExtendedFields;
335
333
  /**
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.
334
+ * Identifies the namespace that the form belongs to.
340
335
  * @minLength 10
341
336
  * @maxLength 50
342
337
  * @immutable
343
338
  */
344
339
  namespace?: string;
345
340
  /**
346
- * Media folder ID for storing uploaded files from form submissions.
341
+ * Media folder ID.
347
342
  * @maxLength 100
348
343
  * @readonly
349
344
  */
350
345
  mediaFolderId?: string | null;
351
- /** Submission limits that can automatically disable the form when reached. */
346
+ /** Rules that limit submissions on this form. */
352
347
  limitationRule?: LimitationRule;
353
348
  /**
354
- * Level of spam protection applied to form submissions.
355
- *
356
- * Default: `ADVANCED`
349
+ * Spam filter protection level.
350
+ * Default: ADVANCED.
357
351
  */
358
352
  spamFilterProtectionLevel?: SpamFilterProtectionLevelWithLiterals;
359
- /** Configuration for how required field indicators are displayed to the submitter. */
353
+ /** Required indicator properties. */
360
354
  requiredIndicatorProperties?: RequiredIndicatorProperties;
361
- /** Configuration for actions taken after a form is successfully submitted. */
355
+ /** Settings for actions to be taken after form submission. */
362
356
  submitSettings?: SubmitSettings;
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
- */
357
+ /** Message shown when the form is disabled */
367
358
  disabledFormMessage?: RichContent;
368
359
  /**
369
- * Whether the form schema is enabled.
370
- *
371
- * Default: `true`
360
+ * Identifies if the form is enabled.
361
+ * Default true
372
362
  */
373
363
  enabled?: boolean | null;
374
364
  /**
375
- * Display name of the form schema.
365
+ * Form name.
376
366
  * @maxLength 200
377
367
  */
378
368
  name?: string | null;
379
369
  /**
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.
370
+ * Form rules, can be applied to layout and items properties.
382
371
  * @maxSize 100
383
372
  */
384
373
  formRules?: Rule[];
@@ -693,18 +682,18 @@ declare enum ValidationFormat {
693
682
  type ValidationFormatWithLiterals = ValidationFormat | 'UNDEFINED' | 'WIX_FILE' | 'PAYMENT' | 'MULTILINE_ADDRESS' | 'SCHEDULING';
694
683
  interface PaymentType {
695
684
  /**
696
- * Products the submitter can select to make a payment for.
685
+ * Field mapped to products.
697
686
  * @minSize 1
698
687
  * @maxSize 100
699
688
  */
700
689
  products?: Product[];
701
690
  /**
702
- * Minimum number of different products that must be selected.
691
+ * Minimum amount of different products.
703
692
  * @max 100
704
693
  */
705
694
  minItems?: number | null;
706
695
  /**
707
- * Maximum number of different products that can be selected.
696
+ * Maximum amount of different products.
708
697
  * @max 100
709
698
  */
710
699
  maxItems?: number | null;
@@ -712,7 +701,7 @@ interface PaymentType {
712
701
  declare enum ProductType {
713
702
  /** Unknown product type. */
714
703
  UNKNOWN_PRODUCT_TYPE = "UNKNOWN_PRODUCT_TYPE",
715
- /** Physical product that can be shipped. */
704
+ /** Shippable (physical) product. */
716
705
  SHIPPABLE = "SHIPPABLE",
717
706
  /** Digital product. */
718
707
  DIGITAL = "DIGITAL"
@@ -722,22 +711,22 @@ type ProductTypeWithLiterals = ProductType | 'UNKNOWN_PRODUCT_TYPE' | 'SHIPPABLE
722
711
  declare enum PriceType {
723
712
  /** Unknown price type. */
724
713
  UNKNOWN_PRICE_TYPE = "UNKNOWN_PRICE_TYPE",
725
- /** Product has a single, unchanging price. */
714
+ /** Fixed price. */
726
715
  FIXED_PRICE = "FIXED_PRICE",
727
- /** Product price can vary within a specified range. */
716
+ /** Dynamic price from price range. */
728
717
  DYNAMIC_PRICE = "DYNAMIC_PRICE"
729
718
  }
730
719
  /** @enumType */
731
720
  type PriceTypeWithLiterals = PriceType | 'UNKNOWN_PRICE_TYPE' | 'FIXED_PRICE' | 'DYNAMIC_PRICE';
732
721
  interface QuantityLimit {
733
722
  /**
734
- * Minimum quantity that must be selected for this product.
723
+ * Minimum quantity.
735
724
  * @min 1
736
725
  * @max 100000
737
726
  */
738
727
  minimum?: number | null;
739
728
  /**
740
- * Maximum quantity that can be selected for this product.
729
+ * Maximum quantity.
741
730
  * @min 1
742
731
  * @max 100000
743
732
  */
@@ -745,35 +734,27 @@ interface QuantityLimit {
745
734
  }
746
735
  interface FixedPriceOptions {
747
736
  /**
748
- * Fixed price of the product.
749
- *
750
- * Specified as a decimal string with period as decimal separator. For example, `"3.99"`.
737
+ * Fixed price monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99).
751
738
  * @decimalValue options { gte:0.00, maxScale:2 }
752
739
  */
753
740
  price?: string;
754
741
  }
755
742
  interface DynamicPriceOptions {
756
743
  /**
757
- * Minimum price of the product.
758
- *
759
- * Specified as a decimal string with period as decimal separator. For example, `"1.00"`.
744
+ * Minimal price monetary amount.
760
745
  * @decimalValue options { gte:0.00, maxScale:2 }
761
746
  */
762
747
  minPrice?: string;
763
748
  /**
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.
749
+ * Maximal price monetary amount.
769
750
  * @decimalValue options { gte:0.00, maxScale:2 }
770
751
  */
771
752
  maxPrice?: string | null;
772
753
  }
773
754
  interface Product extends ProductPriceOptionsOneOf {
774
- /** Configuration for products with fixed pricing. */
755
+ /** Fixed price options. */
775
756
  fixedPriceOptions?: FixedPriceOptions;
776
- /** Configuration for products with variable pricing within a range. */
757
+ /** Dynamic price options. */
777
758
  dynamicPriceOptions?: DynamicPriceOptions;
778
759
  /**
779
760
  * Product ID.
@@ -785,25 +766,24 @@ interface Product extends ProductPriceOptionsOneOf {
785
766
  productType?: ProductTypeWithLiterals;
786
767
  /** Price type. */
787
768
  priceType?: PriceTypeWithLiterals;
788
- /** Limits on how many units of this product can be selected. */
769
+ /** Quantity limit. */
789
770
  quantityLimit?: QuantityLimit;
790
771
  }
791
772
  /** @oneof */
792
773
  interface ProductPriceOptionsOneOf {
793
- /** Configuration for products with fixed pricing. */
774
+ /** Fixed price options. */
794
775
  fixedPriceOptions?: FixedPriceOptions;
795
- /** Configuration for products with variable pricing within a range. */
776
+ /** Dynamic price options. */
796
777
  dynamicPriceOptions?: DynamicPriceOptions;
797
778
  }
798
779
  interface MultilineAddressValidation {
799
780
  /**
800
- * Countries from which addresses are accepted.
801
- * If empty, addresses from all countries are allowed.
781
+ * Allowed countries. No countries treated as all.
802
782
  * @format COUNTRY
803
783
  * @maxSize 200
804
784
  */
805
785
  allowedCountries?: string[];
806
- /** Customization configuration for individual address field components. */
786
+ /** Fields overrides. */
807
787
  fields?: FieldsOverrides;
808
788
  }
809
789
  interface FieldOverrides {
@@ -811,21 +791,21 @@ interface FieldOverrides {
811
791
  required?: boolean;
812
792
  }
813
793
  interface FieldsOverrides {
814
- /** Subdivision settings. */
794
+ /** Subdivision. */
815
795
  subdivision?: FieldOverrides;
816
- /** City settings. */
796
+ /** City. */
817
797
  city?: FieldOverrides;
818
- /** Postal code settings. */
798
+ /** Postal code. */
819
799
  postalCode?: FieldOverrides;
820
- /** Street name settings. */
800
+ /** Street name. */
821
801
  streetName?: FieldOverrides;
822
- /** Street number settings. */
802
+ /** Street number. */
823
803
  streetNumber?: FieldOverrides;
824
- /** Address line settings. */
804
+ /** Address line. */
825
805
  addressLine?: FieldOverrides;
826
- /** Address line 2 settings. */
806
+ /** Address line 2. */
827
807
  addressLine2?: FieldOverrides;
828
- /** Country settings. */
808
+ /** Country. */
829
809
  country?: FieldOverrides;
830
810
  }
831
811
  interface NestedFormFieldOverrides {
@@ -1019,32 +999,30 @@ declare enum InputFieldStringComponentType {
1019
999
  type InputFieldStringComponentTypeWithLiterals = InputFieldStringComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'TEXT_INPUT' | 'RADIO_GROUP' | 'DROPDOWN' | 'DATE_TIME' | 'PHONE_INPUT' | 'DATE_INPUT' | 'TIME_INPUT' | 'DATE_PICKER' | 'SERVICES_DROPDOWN';
1020
1000
  interface TextInput {
1021
1001
  /**
1022
- * Field label.
1002
+ * Label of the field
1023
1003
  * @maxLength 350
1024
1004
  */
1025
1005
  label?: string | null;
1026
- /** Additional description or instructions for the field. */
1006
+ /** Description of the field */
1027
1007
  description?: RichContent;
1028
1008
  /**
1029
- * Placeholder text shown inside the field when it's empty.
1030
- * Useful for providing a hint about the expected format or content.
1009
+ * Placeholder for the value input
1031
1010
  * @maxLength 100
1032
1011
  */
1033
1012
  placeholder?: string | null;
1034
1013
  /**
1035
- * Whether to display the field label.
1036
- *
1037
- * Default: `true`
1014
+ * Flag identifying to hide or not label
1015
+ * Default: true
1038
1016
  */
1039
1017
  showLabel?: boolean | null;
1040
1018
  /**
1041
- * Default value for the field. This value is pre-populated in the field when the form loads.
1019
+ * Default value for the text input
1042
1020
  * @maxLength 20000
1043
1021
  */
1044
1022
  default?: string | null;
1045
- /** Media content associated with the field, such as an image. */
1023
+ /** Media item. Media, associated with field, like image. */
1046
1024
  media?: MediaItem;
1047
- /** Configuration for the media content. */
1025
+ /** Settings for media item */
1048
1026
  mediaSettings?: MediaSettings;
1049
1027
  }
1050
1028
  interface RichContent {
@@ -2789,27 +2767,27 @@ interface MediaItemMediaOneOf {
2789
2767
  }
2790
2768
  interface MediaSettings {
2791
2769
  /**
2792
- * Specifies where the image should be displayed relative to the field's label.
2793
- * Default: `BELOW`
2770
+ * Specifies where image should be displayed.
2771
+ * Default: BELOW
2794
2772
  */
2795
2773
  imagePosition?: ImagePositionWithLiterals;
2796
2774
  /**
2797
- * Specifies the image alignment.
2798
- * Default: `CENTER`
2775
+ * Specifies image alignment.
2776
+ * Default: CENTER
2799
2777
  */
2800
2778
  imageAlignment?: AlignmentWithLiterals;
2801
2779
  /**
2802
- * Specifies how an image should be resized to fit.
2803
- * Default: `COVER`
2780
+ * Defines how an image should be resized to fit.
2781
+ * Default: COVER
2804
2782
  */
2805
2783
  imageFit?: ImageFitWithLiterals;
2806
2784
  }
2807
2785
  declare enum ImagePosition {
2808
2786
  /** Undefined position. */
2809
2787
  UNKNOWN_IMAGE_POSITION = "UNKNOWN_IMAGE_POSITION",
2810
- /** Above the field's label. */
2788
+ /** Above label. */
2811
2789
  ABOVE = "ABOVE",
2812
- /** Below the field's label. */
2790
+ /** Below label. */
2813
2791
  BELOW = "BELOW"
2814
2792
  }
2815
2793
  /** @enumType */
@@ -2817,71 +2795,70 @@ type ImagePositionWithLiterals = ImagePosition | 'UNKNOWN_IMAGE_POSITION' | 'ABO
2817
2795
  declare enum Alignment {
2818
2796
  /** Undefined alignment. */
2819
2797
  UNKNOWN_ALIGNMENT = "UNKNOWN_ALIGNMENT",
2820
- /** Align left. */
2798
+ /** Left. */
2821
2799
  LEFT = "LEFT",
2822
- /** Align center. */
2800
+ /** Center. */
2823
2801
  CENTER = "CENTER",
2824
- /** Align right. */
2802
+ /** Right. */
2825
2803
  RIGHT = "RIGHT"
2826
2804
  }
2827
2805
  /** @enumType */
2828
2806
  type AlignmentWithLiterals = Alignment | 'UNKNOWN_ALIGNMENT' | 'LEFT' | 'CENTER' | 'RIGHT';
2829
2807
  declare enum ImageFit {
2830
2808
  UNKNOWN_IMAGE_FIT = "UNKNOWN_IMAGE_FIT",
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. */
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. */
2832
2810
  COVER = "COVER",
2833
- /** Resize the image to fill the element's content box. The image's original sspect ratio may not be preserved. */
2811
+ /** Image is resized to fill the element's content box. Aspect ratio may not be preserved. */
2834
2812
  CONTAIN = "CONTAIN"
2835
2813
  }
2836
2814
  /** @enumType */
2837
2815
  type ImageFitWithLiterals = ImageFit | 'UNKNOWN_IMAGE_FIT' | 'COVER' | 'CONTAIN';
2838
2816
  interface RadioGroup {
2839
2817
  /**
2840
- * Field label.
2818
+ * Label of the field
2841
2819
  * @maxLength 350
2842
2820
  */
2843
2821
  label?: string | null;
2844
- /** Additional description or instructions for the field. */
2822
+ /** Description of the field */
2845
2823
  description?: RichContent;
2846
2824
  /**
2847
- * List of options the submitter can select from.
2825
+ * Flag identifying to show option allowing input custom value
2826
+ * List of options to select from
2848
2827
  * @maxSize 400
2849
2828
  */
2850
2829
  options?: RadioGroupOption[];
2851
2830
  /**
2852
- * Whether to display the field label.
2853
- *
2854
- * Default: `true`
2831
+ * Flag identifying to hide or not label
2832
+ * Default: true
2855
2833
  */
2856
2834
  showLabel?: boolean | null;
2857
- /** Custom option which can be specified by the submitter. */
2835
+ /** Option which can be specified by UoU, enabled when this object is specified. */
2858
2836
  customOption?: CustomOption;
2859
2837
  /**
2860
2838
  * Specifies the number of columns used to display the selections within the component.
2861
- *
2862
- * Default: `ONE`
2839
+ * Default: ONE
2863
2840
  */
2864
2841
  numberOfColumns?: NumberOfColumnsWithLiterals;
2865
- /** Media content associated with the field, such as an image. */
2842
+ /** Media item. Media, associated with field, like image. */
2866
2843
  media?: MediaItem;
2867
- /** Configuration for the media content. */
2844
+ /** Settings for media item */
2868
2845
  mediaSettings?: MediaSettings;
2869
2846
  }
2870
2847
  interface RadioGroupOption {
2871
2848
  /**
2872
- * Selectable option label.
2849
+ * Selectable option label
2873
2850
  * @maxLength 400
2874
2851
  */
2875
2852
  label?: string | null;
2876
2853
  /**
2877
- * Value stored on submission when this option is selected.
2854
+ * Selectable option value, which is saved to DB.
2878
2855
  * @maxLength 20000
2879
2856
  */
2880
2857
  value?: string | null;
2881
- /** Whether this option is selected by default. */
2858
+ /** Flag identifying that option should be selected by default */
2882
2859
  default?: boolean;
2883
2860
  /**
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.
2861
+ * Option id. Used as binding for translations
2885
2862
  * @format GUID
2886
2863
  * @immutable
2887
2864
  */
@@ -2889,12 +2866,12 @@ interface RadioGroupOption {
2889
2866
  }
2890
2867
  interface CustomOption {
2891
2868
  /**
2892
- * Custom option label.
2869
+ * Label of custom option input
2893
2870
  * @maxLength 350
2894
2871
  */
2895
2872
  label?: string | null;
2896
2873
  /**
2897
- * Custom option placeholder text.
2874
+ * Placeholder of custom option input
2898
2875
  * @maxLength 100
2899
2876
  */
2900
2877
  placeholder?: string | null;
@@ -2915,50 +2892,49 @@ declare enum NumberOfColumns {
2915
2892
  type NumberOfColumnsWithLiterals = NumberOfColumns | 'UNKNOWN_NUMBER_OF_COLUMNS' | 'ZERO' | 'ONE' | 'TWO' | 'THREE';
2916
2893
  interface Dropdown {
2917
2894
  /**
2918
- * Field label.
2895
+ * Label of the field
2919
2896
  * @maxLength 350
2920
2897
  */
2921
2898
  label?: string | null;
2922
- /** Additional description or instructions for the field. */
2899
+ /** Description of the field */
2923
2900
  description?: RichContent;
2924
2901
  /**
2925
- * List of options the submitter can select from.
2902
+ * List of options to select from
2926
2903
  * @maxSize 400
2927
2904
  */
2928
2905
  options?: DropdownOption[];
2929
2906
  /**
2930
- * Whether to display the field label.
2931
- *
2932
- * Default: `true`
2907
+ * Flag identifying to hide or not label
2908
+ * Default: true
2933
2909
  */
2934
2910
  showLabel?: boolean | null;
2935
- /** Custom option which can be specified by the submitter. */
2911
+ /** Option which can be specified by UoU, enabled when this object is specified. */
2936
2912
  customOption?: CustomOption;
2937
2913
  /**
2938
- * Placeholder text shown when no option is selected.
2914
+ * Placeholder of dropdown input
2939
2915
  * @maxLength 100
2940
2916
  */
2941
2917
  placeholder?: string | null;
2942
- /** Media content associated with the field, such as an image. */
2918
+ /** Media item. Media, associated with field, like image. */
2943
2919
  media?: MediaItem;
2944
- /** Configuration for the media content. */
2920
+ /** Settings for media item */
2945
2921
  mediaSettings?: MediaSettings;
2946
2922
  }
2947
2923
  interface DropdownOption {
2948
2924
  /**
2949
- * Selectable option label.
2925
+ * Selectable option label
2950
2926
  * @maxLength 400
2951
2927
  */
2952
2928
  label?: string | null;
2953
2929
  /**
2954
- * Value stored on submission when this option is selected.
2930
+ * Selectable option value, which is saved to DB.
2955
2931
  * @maxLength 20000
2956
2932
  */
2957
2933
  value?: string | null;
2958
- /** Whether this option is selected by default. */
2934
+ /** Flag identifying that option should be selected by default */
2959
2935
  default?: boolean;
2960
2936
  /**
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.
2937
+ * Option id. Used as binding for translations
2962
2938
  * @format GUID
2963
2939
  * @immutable
2964
2940
  */
@@ -2966,38 +2942,35 @@ interface DropdownOption {
2966
2942
  }
2967
2943
  interface DateTimeInput {
2968
2944
  /**
2969
- * Field label.
2945
+ * Label of the field. Displayed text for the date/time input.
2970
2946
  * @maxLength 350
2971
2947
  */
2972
2948
  label?: string | null;
2973
- /** Additional description or instructions for the field. */
2949
+ /** Description of the field. Additional information about the date/time input. */
2974
2950
  description?: RichContent;
2975
2951
  /**
2976
- * Whether to display the field label.
2977
- *
2978
- * Default: `true`
2952
+ * Flag identifying whether to show or hide the label.
2953
+ * Default: true
2979
2954
  */
2980
2955
  showLabel?: boolean | null;
2981
2956
  /**
2982
- * Whether to display placeholder text in the field when it's empty.
2983
- *
2984
- * Default: `true`
2957
+ * Flag identifying whether to show or hide the placeholder.
2958
+ * Default: true
2985
2959
  */
2986
2960
  showPlaceholder?: boolean | null;
2987
2961
  /**
2988
- * Whether to use 24-hour time format.
2989
- *
2990
- * Default: `false`
2962
+ * Flag indicating whether to use the 24-hour time format.
2963
+ * Default: false.
2991
2964
  */
2992
2965
  use24HourFormat?: boolean;
2993
2966
  /**
2994
- * Default value for the field. This value is pre-populated in the field when the form loads.
2967
+ * Default value for the date time input.
2995
2968
  * @format LOCAL_DATE_TIME
2996
2969
  */
2997
2970
  default?: string | null;
2998
- /** Media content associated with the field, such as an image. */
2971
+ /** Media item. Media, associated with field, like image. */
2999
2972
  media?: MediaItem;
3000
- /** Configuration for the media content. */
2973
+ /** Settings for media item */
3001
2974
  mediaSettings?: MediaSettings;
3002
2975
  /**
3003
2976
  * Flag identifying whether to show or hide the date labels.
@@ -3007,68 +2980,64 @@ interface DateTimeInput {
3007
2980
  }
3008
2981
  interface PhoneInput {
3009
2982
  /**
3010
- * Field label.
2983
+ * Label of the field
3011
2984
  * @maxLength 350
3012
2985
  */
3013
2986
  label?: string | null;
3014
- /** Additional description or instructions for the field. */
2987
+ /** Description of the field */
3015
2988
  description?: RichContent;
3016
2989
  /**
3017
- * Placeholder text shown inside the field when it's empty.
2990
+ * Placeholder for the value input
3018
2991
  * @maxLength 100
3019
2992
  */
3020
2993
  placeholder?: string | null;
3021
2994
  /**
3022
- * Whether to display the field label.
3023
- *
3024
- * Default: `true`
2995
+ * Flag identifying to show label or not
2996
+ * Default: true
3025
2997
  */
3026
2998
  showLabel?: boolean | null;
3027
2999
  /**
3028
- * Default country code for the phone number input. Two-letter country code in ISO-3166 alpha-2 format.
3000
+ * Default value of the country code
3029
3001
  * @minLength 1
3030
3002
  * @maxLength 5
3031
3003
  */
3032
3004
  defaultCountryCode?: string | null;
3033
3005
  /**
3034
- * Whether to display the country flag next to the country code.
3035
- *
3036
- * Default: `false`
3006
+ * Flag identifying to show country flag or not
3007
+ * Default: false
3037
3008
  */
3038
3009
  showCountryFlag?: boolean;
3039
- /** Media content associated with the field, such as an image. */
3010
+ /** Media item. Media, associated with field, like image. */
3040
3011
  media?: MediaItem;
3041
- /** Configuration for the media content. */
3012
+ /** Settings for media item */
3042
3013
  mediaSettings?: MediaSettings;
3043
3014
  }
3044
3015
  interface DateInput {
3045
3016
  /**
3046
- * Field label.
3017
+ * Label of the field. Displayed text for the date/time input.
3047
3018
  * @maxLength 350
3048
3019
  */
3049
3020
  label?: string | null;
3050
- /** Additional description or instructions for the field. */
3021
+ /** Description of the field. Additional information about the date/time input. */
3051
3022
  description?: RichContent;
3052
3023
  /**
3053
- * Whether to display the field label.
3054
- *
3055
- * Default: `true`
3024
+ * Flag identifying whether to show or hide the label.
3025
+ * Default: true
3056
3026
  */
3057
3027
  showLabel?: boolean | null;
3058
3028
  /**
3059
- * Whether to display placeholder text in the field when it's empty.
3060
- *
3061
- * Default: `true`
3029
+ * Flag identifying whether to show or hide the placeholder.
3030
+ * Default: true
3062
3031
  */
3063
3032
  showPlaceholder?: boolean | null;
3064
3033
  /**
3065
- * Default value for the field. This value is pre-populated in the field when the form loads.
3034
+ * Default value for the date input.
3066
3035
  * @format LOCAL_DATE
3067
3036
  */
3068
3037
  default?: string | null;
3069
- /** Media content associated with the field, such as an image. */
3038
+ /** Media item. Media, associated with field, like image. */
3070
3039
  media?: MediaItem;
3071
- /** Configuration for the media content. */
3040
+ /** Settings for media item */
3072
3041
  mediaSettings?: MediaSettings;
3073
3042
  /**
3074
3043
  * Flag identifying whether to show or hide the date labels.
@@ -3078,69 +3047,65 @@ interface DateInput {
3078
3047
  }
3079
3048
  interface TimeInput {
3080
3049
  /**
3081
- * Field label.
3050
+ * Label of the field. Displayed text for the date/time input.
3082
3051
  * @maxLength 350
3083
3052
  */
3084
3053
  label?: string | null;
3085
- /** Field description. */
3054
+ /** Description of the field. Additional information about the date/time input. */
3086
3055
  description?: RichContent;
3087
3056
  /**
3088
- * Whether to display the label.
3089
- *
3090
- * Default: `true`
3057
+ * Flag identifying whether to show or hide the label.
3058
+ * Default: true
3091
3059
  */
3092
3060
  showLabel?: boolean | null;
3093
3061
  /**
3094
- * Whether to display placeholder text in the field when it's empty.
3095
- *
3096
- * Default: `true`
3062
+ * Flag identifying whether to show or hide the placeholder.
3063
+ * Default: true
3097
3064
  */
3098
3065
  showPlaceholder?: boolean | null;
3099
3066
  /**
3100
- * Whether to use 24-hour time format.
3101
- *
3102
- * Default: `false`
3067
+ * Flag indicating whether to use the 24-hour time format.
3068
+ * Default: false.
3103
3069
  */
3104
3070
  use24HourFormat?: boolean;
3105
3071
  /**
3106
- * Default value for the field. This value is pre-populated in the field when the form loads.
3072
+ * Default value for the time input.
3107
3073
  * @format LOCAL_TIME
3108
3074
  */
3109
3075
  default?: string | null;
3110
- /** Media content associated with the field, such as an image. */
3076
+ /** Media item. Media, associated with field, like image. */
3111
3077
  media?: MediaItem;
3112
- /** Configuration for the media content. */
3078
+ /** Settings for media item */
3113
3079
  mediaSettings?: MediaSettings;
3114
3080
  }
3115
3081
  interface DatePicker {
3116
3082
  /**
3117
- * Field label.
3083
+ * Label of the field. Displayed text for the date/time input.
3118
3084
  * @maxLength 350
3119
3085
  */
3120
3086
  label?: string | null;
3121
- /** Additional description or instructions for the field. */
3087
+ /** Description of the field. Additional information about the date/time input. */
3122
3088
  description?: RichContent;
3123
3089
  /**
3124
- * Whether to display the field label.
3125
- *
3126
- * Default: `true`
3090
+ * Flag identifying whether to show or hide the label.
3091
+ * Default: true
3127
3092
  */
3128
3093
  showLabel?: boolean | null;
3129
3094
  /**
3130
- * Placeholder text shown when no date is selected.
3095
+ * Placeholder of date picker input
3131
3096
  * @maxLength 100
3132
3097
  */
3133
3098
  placeholder?: string | null;
3134
- /** First day of the week displayed on the date picker. */
3099
+ /** First day of the week displayed on date picker. */
3135
3100
  firstDayOfWeek?: FirstDayOfWeekWithLiterals;
3136
3101
  /**
3137
- * Default value for the field. This value is pre-populated in the field when the form loads.
3102
+ * Default value for the date picker.
3138
3103
  * @format LOCAL_DATE
3139
3104
  */
3140
3105
  default?: string | null;
3141
- /** Media content associated with the field, such as an image. */
3106
+ /** Media item. Media, associated with field, like image. */
3142
3107
  media?: MediaItem;
3143
- /** Configuration for the media content. */
3108
+ /** Settings for media item */
3144
3109
  mediaSettings?: MediaSettings;
3145
3110
  }
3146
3111
  declare enum FirstDayOfWeek {
@@ -3153,27 +3118,26 @@ declare enum FirstDayOfWeek {
3153
3118
  type FirstDayOfWeekWithLiterals = FirstDayOfWeek | 'MONDAY' | 'SUNDAY';
3154
3119
  interface ServicesDropdown {
3155
3120
  /**
3156
- * Field label.
3121
+ * Label of the field
3157
3122
  * @maxLength 350
3158
3123
  */
3159
3124
  label?: string | null;
3160
3125
  /**
3161
- * Whether to display the field label.
3162
- *
3163
- * Default: `true`
3126
+ * Flag identifying to hide or not label
3127
+ * Default: true
3164
3128
  */
3165
3129
  showLabel?: boolean | null;
3166
3130
  /**
3167
- * Placeholder text shown when no service is selected.
3131
+ * Placeholder of services dropdown input
3168
3132
  * @maxLength 100
3169
3133
  */
3170
3134
  placeholder?: string | null;
3171
3135
  /**
3172
- * List of service options the submitter can select from.
3136
+ * List of service options to select from
3173
3137
  * @maxSize 400
3174
3138
  */
3175
3139
  options?: ServiceOption[];
3176
- /** Custom option which can be specified by the submitter. */
3140
+ /** Option which can be specified by UoU, enabled when this object is specified. */
3177
3141
  customOption?: CustomOption;
3178
3142
  }
3179
3143
  interface ServiceOption {
@@ -3217,53 +3181,51 @@ declare enum InputFieldNumberComponentType {
3217
3181
  type InputFieldNumberComponentTypeWithLiterals = InputFieldNumberComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'NUMBER_INPUT' | 'RATING_INPUT';
3218
3182
  interface NumberInput {
3219
3183
  /**
3220
- * Field label.
3184
+ * Label of the field
3221
3185
  * @maxLength 350
3222
3186
  */
3223
3187
  label?: string | null;
3224
- /** Additional description or instructions for the field. */
3188
+ /** Description of the field */
3225
3189
  description?: RichContent;
3226
3190
  /**
3227
- * Placeholder text shown inside the field when it's empty.
3191
+ * Placeholder for the value input
3228
3192
  * @maxLength 100
3229
3193
  */
3230
3194
  placeholder?: string | null;
3231
3195
  /**
3232
- * Whether to display the field label.
3233
- *
3234
- * Default: `true`
3196
+ * Flag identifying to hide or not label
3197
+ * Default: true
3235
3198
  */
3236
3199
  showLabel?: boolean | null;
3237
- /** Default value for the field. This value is pre-populated in the field when the form loads. */
3200
+ /** Default value for the number input */
3238
3201
  default?: number | null;
3239
- /** Media content associated with the field, such as an image. */
3202
+ /** Media item. Media, associated with field, like image. */
3240
3203
  media?: MediaItem;
3241
- /** Configuration for the media content. */
3204
+ /** Settings for media item */
3242
3205
  mediaSettings?: MediaSettings;
3243
3206
  }
3244
3207
  interface RatingInput {
3245
3208
  /**
3246
- * Field label.
3209
+ * Label of the field
3247
3210
  * @maxLength 350
3248
3211
  */
3249
3212
  label?: string | null;
3250
- /** Additional description or instructions for the field. */
3213
+ /** Description of the field */
3251
3214
  description?: RichContent;
3252
3215
  /**
3253
- * Whether to display the field label.
3254
- *
3255
- * Default: `true`
3216
+ * Flag identifying to hide label or not
3217
+ * Default: true
3256
3218
  */
3257
3219
  showLabel?: boolean | null;
3258
3220
  /**
3259
- * Default rating value for the field.
3221
+ * Default rating
3260
3222
  * @min 1
3261
3223
  * @max 5
3262
3224
  */
3263
3225
  defaultValue?: number | null;
3264
- /** Media content associated with the field, such as an image. */
3226
+ /** Media item. Media, associated with field, like image. */
3265
3227
  media?: MediaItem;
3266
- /** Configuration for the media content. */
3228
+ /** Settings for media item */
3267
3229
  mediaSettings?: MediaSettings;
3268
3230
  }
3269
3231
  interface InputFieldBooleanType {
@@ -3280,12 +3242,11 @@ declare enum InputFieldBooleanComponentType {
3280
3242
  /** @enumType */
3281
3243
  type InputFieldBooleanComponentTypeWithLiterals = InputFieldBooleanComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX';
3282
3244
  interface Checkbox {
3283
- /** Field label. */
3245
+ /** Label of the field */
3284
3246
  label?: RichContent;
3285
3247
  /**
3286
- * Whether the checkbox is selected by default when the form loads.
3287
- *
3288
- * Default: `false`
3248
+ * Flag identifying if checked by default
3249
+ * Default: false
3289
3250
  */
3290
3251
  checked?: boolean;
3291
3252
  }
@@ -3412,96 +3373,92 @@ declare enum InputFieldArrayComponentType {
3412
3373
  type InputFieldArrayComponentTypeWithLiterals = InputFieldArrayComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX_GROUP' | 'TAGS' | 'SERVICES_CHECKBOX_GROUP';
3413
3374
  interface CheckboxGroup {
3414
3375
  /**
3415
- * Field label.
3376
+ * Label of the field
3416
3377
  * @maxLength 350
3417
3378
  */
3418
3379
  label?: string | null;
3419
- /** Additional description or instructions for the field. */
3380
+ /** Description of the field */
3420
3381
  description?: RichContent;
3421
3382
  /**
3422
- * List of options the submitter can select from.
3383
+ * List of options to select from
3423
3384
  * @maxSize 400
3424
3385
  */
3425
3386
  options?: Option[];
3426
3387
  /**
3427
- * Whether to display the field label.
3428
- *
3429
- * Default: `true`
3388
+ * Flag identifying to hide or not label
3389
+ * Default: true
3430
3390
  */
3431
3391
  showLabel?: boolean | null;
3432
- /** Custom option which can be specified by the submitter. */
3392
+ /** Option which can be specified by UoU, enabled when this object is specified. */
3433
3393
  customOption?: CustomOption;
3434
3394
  /**
3435
3395
  * Specifies the number of columns used to display the selections within the component.
3436
- *
3437
- * Default: `ONE`
3396
+ * Default: ONE
3438
3397
  */
3439
3398
  numberOfColumns?: NumberOfColumnsWithLiterals;
3440
- /** Media content associated with the field, such as an image. */
3399
+ /** Media item. Media, associated with field, like image. */
3441
3400
  media?: MediaItem;
3442
- /** Configuration for the media content. */
3401
+ /** Settings for media item */
3443
3402
  mediaSettings?: MediaSettings;
3444
3403
  }
3445
3404
  interface Option {
3446
3405
  /**
3447
- * Selectable option label.
3406
+ * Selectable option label
3448
3407
  * @maxLength 400
3449
3408
  */
3450
3409
  label?: string | null;
3451
- /** Value stored on submission when this option is selected. */
3410
+ /** Selectable option value, which is saved to DB. */
3452
3411
  value?: any;
3453
- /** Whether this option is selected by default. */
3412
+ /** Flag identifying that option should be selected by default */
3454
3413
  default?: boolean;
3455
3414
  /**
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
+ * Option id. Used as binding for translations
3457
3416
  * @format GUID
3458
3417
  * @immutable
3459
3418
  */
3460
3419
  _id?: string;
3461
- /** Media content associated with this option. */
3420
+ /** Media item. Media, associated with option, like image. */
3462
3421
  media?: MediaItem;
3463
3422
  }
3464
3423
  interface Tags {
3465
3424
  /**
3466
- * Field label.
3425
+ * Label of the field
3467
3426
  * @maxLength 350
3468
3427
  */
3469
3428
  label?: string | null;
3470
- /** Additional description or instructions for the field. */
3429
+ /** Description of the field */
3471
3430
  description?: RichContent;
3472
3431
  /**
3473
- * List of options the submitter can select from.
3432
+ * List of options to select from
3474
3433
  * @maxSize 400
3475
3434
  */
3476
3435
  options?: TagsOption[];
3477
3436
  /**
3478
- * Whether to display the label.
3479
- *
3480
- * Default: `true`
3437
+ * Flag identifying to hide or not label
3438
+ * Default: true
3481
3439
  */
3482
3440
  showLabel?: boolean | null;
3483
- /** Custom option which can be specified by the submitter. */
3441
+ /** Option which can be specified by UoU, enabled when this object is specified. */
3484
3442
  customOption?: CustomOption;
3485
3443
  /**
3486
3444
  * Specifies the number of columns used to display the selections within the component.
3487
- *
3488
- * Default: `ONE`
3445
+ * Default: ONE
3489
3446
  */
3490
3447
  numberOfColumns?: NumberOfColumnsWithLiterals;
3491
3448
  /** Media item. Media, associated with field, like image. */
3492
3449
  media?: MediaItem;
3493
- /** Configuration for the media item. */
3450
+ /** Settings for media item */
3494
3451
  mediaSettings?: MediaSettings;
3495
3452
  }
3496
3453
  interface TagsOption {
3497
3454
  /**
3498
- * Selectable option label.
3455
+ * Selectable option label
3499
3456
  * @maxLength 400
3500
3457
  */
3501
3458
  label?: string | null;
3502
- /** Value stored on submission when this option is selected. */
3459
+ /** Selectable option value, which is saved to DB. */
3503
3460
  value?: any;
3504
- /** Flag identifying that option should be selected by default. */
3461
+ /** Flag identifying that option should be selected by default */
3505
3462
  default?: boolean;
3506
3463
  /**
3507
3464
  * Option id. Used as binding for translations
@@ -3509,7 +3466,7 @@ interface TagsOption {
3509
3466
  * @immutable
3510
3467
  */
3511
3468
  _id?: string;
3512
- /** Media content associated with the option, such as an image. */
3469
+ /** Media item. Media, associated with option, like image. */
3513
3470
  media?: MediaItem;
3514
3471
  }
3515
3472
  interface ServicesCheckboxGroup {
@@ -3547,13 +3504,13 @@ declare enum InputFieldWixFileComponentType {
3547
3504
  type InputFieldWixFileComponentTypeWithLiterals = InputFieldWixFileComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'FILE_UPLOAD' | 'SIGNATURE';
3548
3505
  interface FileType {
3549
3506
  /**
3550
- * Maximum number of files that can be uploaded.
3507
+ * Amount of files allowed to upload
3551
3508
  * @min 1
3552
3509
  * @max 30
3553
3510
  */
3554
3511
  fileLimit?: number;
3555
3512
  /**
3556
- * Supported file formats for uploaded files.
3513
+ * Supported file formats for upload
3557
3514
  * @maxSize 5
3558
3515
  */
3559
3516
  uploadFileFormats?: UploadFileFormatWithLiterals[];
@@ -3576,52 +3533,50 @@ declare enum UploadFileFormat {
3576
3533
  type UploadFileFormatWithLiterals = UploadFileFormat | 'UNKNOWN_UPLOAD_FILE_FORMAT' | 'VIDEO' | 'IMAGE' | 'AUDIO' | 'DOCUMENT' | 'ARCHIVE';
3577
3534
  interface FileUpload {
3578
3535
  /**
3579
- * Field label.
3536
+ * Selectable option label
3580
3537
  * @maxLength 350
3581
3538
  */
3582
3539
  label?: string | null;
3583
- /** Additional description or instructions for the field. */
3540
+ /** Description of the field */
3584
3541
  description?: RichContent;
3585
3542
  /**
3586
- * Whether to display the field label.
3587
- *
3588
- * Default: `true`
3543
+ * Flag identifying to hide or not label
3544
+ * Default: true
3589
3545
  */
3590
3546
  showLabel?: boolean | null;
3591
3547
  /**
3592
- * Text displayed on the upload button.
3548
+ * Text on upload button
3593
3549
  * @maxLength 500
3594
3550
  */
3595
3551
  buttonText?: string | null;
3596
3552
  /**
3597
- * Custom text displayed when a file is uploaded. If not specified, the file name is shown.
3553
+ * Custom text which appears when file is uploaded, if missing file name will be shown
3598
3554
  * @maxLength 255
3599
3555
  */
3600
3556
  explanationText?: string | null;
3601
- /** Media content associated with the field, such as an image. */
3557
+ /** Media item. Media, associated with field, like image. */
3602
3558
  media?: MediaItem;
3603
- /** Configuration for the media content. */
3559
+ /** Settings for media item */
3604
3560
  mediaSettings?: MediaSettings;
3605
3561
  }
3606
3562
  interface Signature {
3607
3563
  /**
3608
- * Field label.
3564
+ * Selectable option label
3609
3565
  * @maxLength 350
3610
3566
  */
3611
3567
  label?: string | null;
3612
3568
  /**
3613
- * Whether to display the field label.
3614
- *
3615
- * Default: `true`
3569
+ * Flag identifying to hide label or not
3570
+ * Default: true
3616
3571
  */
3617
3572
  showLabel?: boolean | null;
3618
- /** Additional description or instructions for the field. */
3573
+ /** Description of the field */
3619
3574
  description?: RichContent;
3620
- /** Whether image upload is enabled for the signature field. */
3575
+ /** Is image upload enabled */
3621
3576
  imageUploadEnabled?: boolean;
3622
- /** Media content associated with the field, such as an image. */
3577
+ /** Media item. Media, associated with field, like image. */
3623
3578
  media?: MediaItem;
3624
- /** Configuration for the media item. */
3579
+ /** Settings for media item */
3625
3580
  mediaSettings?: MediaSettings;
3626
3581
  }
3627
3582
  declare enum InputFieldPaymentComponentType {
@@ -3635,32 +3590,30 @@ declare enum InputFieldPaymentComponentType {
3635
3590
  type InputFieldPaymentComponentTypeWithLiterals = InputFieldPaymentComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX_GROUP' | 'DONATION_INPUT' | 'PAYMENT_INPUT' | 'FIXED_PAYMENT';
3636
3591
  interface ProductCheckboxGroup {
3637
3592
  /**
3638
- * Field label.
3593
+ * Label of the field.
3639
3594
  * @maxLength 350
3640
3595
  */
3641
3596
  label?: string | null;
3642
- /** Additional description or instructions for the field. */
3597
+ /** Description of the field. */
3643
3598
  description?: RichContent;
3644
3599
  /**
3645
- * List of product options the submitter can select from.
3600
+ * List of options to select from.
3646
3601
  * @maxSize 400
3647
3602
  */
3648
3603
  options?: ProductCheckboxGroupOption[];
3649
3604
  /**
3650
- * Whether to display the field label.
3651
- *
3652
- * Default: `true`
3605
+ * Flag identifying to hide or not label
3606
+ * Default: true
3653
3607
  */
3654
3608
  showLabel?: boolean | null;
3655
3609
  /**
3656
- * How an image should be resized to fit within its option container.
3657
- *
3658
- * Default: `COVER`
3610
+ * Defines how an image should be resized to fit within its option.
3611
+ * Default: COVER
3659
3612
  */
3660
3613
  imageFit?: ImageFitWithLiterals;
3661
- /** Media content associated with the field, such as an image. */
3614
+ /** Media item. Media, associated with field, like image. */
3662
3615
  media?: MediaItem;
3663
- /** Configuration for the media content. */
3616
+ /** Settings for media item */
3664
3617
  mediaSettings?: MediaSettings;
3665
3618
  }
3666
3619
  interface ProductCheckboxGroupOption {
@@ -3669,103 +3622,99 @@ interface ProductCheckboxGroupOption {
3669
3622
  * @maxLength 400
3670
3623
  */
3671
3624
  label?: string | null;
3672
- /** Value stored on submission when this option is selected. Must match a product ID found in the field's products list. */
3625
+ /** Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list. */
3673
3626
  value?: any;
3674
3627
  /**
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.
3628
+ * Option id. Used as binding for translations.
3676
3629
  * @format GUID
3677
3630
  * @immutable
3678
3631
  */
3679
3632
  _id?: string;
3680
- /** Media content associated with this option, such as an image. */
3633
+ /** Media item. Media, associated with option, like image. */
3681
3634
  media?: MediaItem;
3682
- /** Whether this option is selected by default. */
3635
+ /** Flag identifying that option should be selected by default */
3683
3636
  default?: boolean;
3684
3637
  }
3685
3638
  interface DonationInput {
3686
3639
  /**
3687
- * Field label.
3640
+ * Label of the field.
3688
3641
  * @maxLength 350
3689
3642
  */
3690
3643
  label?: string | null;
3691
- /** Additional description or instructions for the field. */
3644
+ /** Description of the field. */
3692
3645
  description?: RichContent;
3693
3646
  /**
3694
- * List of donation amount options the submitter can select from.
3647
+ * List of options to select from.
3695
3648
  * @maxSize 400
3696
3649
  */
3697
3650
  options?: DonationInputOption[];
3698
- /** Custom option which can be specified by the submitter. */
3651
+ /** Option which can be specified by UoU, enabled when this object is specified. */
3699
3652
  customOption?: CustomOption;
3700
3653
  /**
3701
3654
  * Specifies the number of columns used to display the selections within the component.
3702
- *
3703
- * Default: `ONE`
3655
+ * Default: ONE
3704
3656
  */
3705
3657
  numberOfColumns?: NumberOfColumnsWithLiterals;
3706
3658
  /**
3707
- * Whether to display the field label.
3708
- *
3709
- * Default: `true`
3659
+ * Flag identifying to hide or not label
3660
+ * Default: true
3710
3661
  */
3711
3662
  showLabel?: boolean | null;
3712
- /** Media content associated with the field, such as an image. */
3663
+ /** Media item. Media, associated with field, like image. */
3713
3664
  media?: MediaItem;
3714
- /** Configuration for the media content. */
3665
+ /** Settings for media item */
3715
3666
  mediaSettings?: MediaSettings;
3716
3667
  }
3717
3668
  interface DonationInputOption {
3718
3669
  /**
3719
- * Value stored on submission when this option is selected. Must match a product ID found in the field's products list.
3670
+ * Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list.
3720
3671
  * @format GUID
3721
3672
  */
3722
3673
  value?: string;
3723
- /** Whether this option is selected by default. */
3674
+ /** Flag identifying that option should be selected by default */
3724
3675
  default?: boolean;
3725
3676
  }
3726
3677
  interface PaymentInput {
3727
3678
  /**
3728
- * Field label.
3679
+ * Label of the field.
3729
3680
  * @maxLength 350
3730
3681
  */
3731
3682
  label?: string | null;
3732
- /** Additional description or instructions for the field. */
3683
+ /** Description of the field. */
3733
3684
  description?: RichContent;
3734
3685
  /**
3735
- * Whether to display the field label.
3736
- *
3737
- * Default: `true`
3686
+ * Flag identifying to hide or not label
3687
+ * Default: true
3738
3688
  */
3739
3689
  showLabel?: boolean | null;
3740
3690
  /**
3741
- * Placeholder text shown inside the field when it's empty.
3691
+ * Placeholder of custom option input
3742
3692
  * @maxLength 100
3743
3693
  */
3744
3694
  placeholder?: string | null;
3745
- /** Default value for the field. This value is pre-populated in the field when the form loads. */
3695
+ /** Default value for the payment input */
3746
3696
  default?: number | null;
3747
- /** Media content associated with the field, such as an image. */
3697
+ /** Media item. Media, associated with field, like image. */
3748
3698
  media?: MediaItem;
3749
- /** Configuration for the media content. */
3699
+ /** Settings for media item */
3750
3700
  mediaSettings?: MediaSettings;
3751
3701
  }
3752
3702
  interface FixedPayment {
3753
3703
  /**
3754
- * Field label.
3704
+ * Label of the field.
3755
3705
  * @maxLength 350
3756
3706
  */
3757
3707
  label?: string | null;
3758
- /** Additional description or instructions for the field. */
3708
+ /** Description of the field. */
3759
3709
  description?: RichContent;
3760
3710
  /**
3761
- * Whether to display the field label.
3762
- *
3763
- * Default: `true`
3711
+ * Flag identifying to hide or not label
3712
+ * Default: true
3764
3713
  */
3765
3714
  showLabel?: boolean | null;
3766
- /** Media content associated with the field, such as an image. */
3715
+ /** Media item. Media, associated with field, like image. */
3767
3716
  media?: MediaItem;
3768
- /** Configuration for the media content. */
3717
+ /** Settings for media item */
3769
3718
  mediaSettings?: MediaSettings;
3770
3719
  }
3771
3720
  declare enum InputFieldSchedulingComponentType {
@@ -3775,65 +3724,64 @@ declare enum InputFieldSchedulingComponentType {
3775
3724
  /** @enumType */
3776
3725
  type InputFieldSchedulingComponentTypeWithLiterals = InputFieldSchedulingComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'APPOINTMENT';
3777
3726
  interface Appointment extends AppointmentFormatInfoOneOf {
3778
- /** Configuration for in-person appointments. */
3727
+ /** In person options for the appointment */
3779
3728
  inPersonOptions?: InPersonOptions;
3780
- /** Configuration for video conference appointments. */
3729
+ /** Online video conference options for the appointment */
3781
3730
  videoConferenceOptions?: VideoConferenceOptions;
3782
- /** Configuration for phone appointments. */
3731
+ /** Phone options for the appointment */
3783
3732
  phoneOptions?: PhoneOptions;
3784
3733
  /**
3785
- * Field label.
3734
+ * Label of the field
3786
3735
  * @maxLength 255
3787
3736
  */
3788
3737
  label?: string | null;
3789
3738
  /**
3790
- * Appointment name.
3739
+ * Name of the appointment
3791
3740
  * @minLength 1
3792
3741
  * @maxLength 400
3793
3742
  */
3794
3743
  name?: string | null;
3795
3744
  /**
3796
- * Duration of the appointment in minutes.
3745
+ * Duration of the appointment in minutes
3797
3746
  * @min 1
3798
3747
  * @max 44639
3799
3748
  */
3800
3749
  durationInMinutes?: number | null;
3801
- /** Whether appointments require manual approval before confirmation. */
3750
+ /** Indicates whether manual approval is required for the appointment */
3802
3751
  manualApprovalRequired?: boolean | null;
3803
3752
  /**
3804
- * IDs of staff members who provide this service.
3753
+ * ID of the staff members providing the appointment
3805
3754
  * @maxSize 220
3806
3755
  * @format GUID
3807
3756
  */
3808
3757
  staffIds?: string[] | null;
3809
- /** Appointment format. */
3758
+ /** The format of the appointment */
3810
3759
  format?: FormatWithLiterals;
3811
- /** Additional description or instructions for the field. */
3760
+ /** Description of the field */
3812
3761
  description?: RichContent;
3813
3762
  /**
3814
- * Whether to display the field label.
3815
- *
3816
- * Default: `true`
3763
+ * Flag identifying to hide or not label
3764
+ * Default: true
3817
3765
  */
3818
3766
  showLabel?: boolean | null;
3819
3767
  }
3820
3768
  /** @oneof */
3821
3769
  interface AppointmentFormatInfoOneOf {
3822
- /** Configuration for in-person appointments. */
3770
+ /** In person options for the appointment */
3823
3771
  inPersonOptions?: InPersonOptions;
3824
- /** Configuration for video conference appointments. */
3772
+ /** Online video conference options for the appointment */
3825
3773
  videoConferenceOptions?: VideoConferenceOptions;
3826
- /** Configuration for phone appointments. */
3774
+ /** Phone options for the appointment */
3827
3775
  phoneOptions?: PhoneOptions;
3828
3776
  }
3829
3777
  interface Location extends LocationLocationInfoOneOf {
3830
3778
  /**
3831
- * Custom address specified as a text string.
3779
+ * Custom address details
3832
3780
  * @maxLength 512
3833
3781
  */
3834
3782
  customAddress?: string | null;
3835
3783
  /**
3836
- * ID of a predefined business [location](https://dev.wix.com/docs/rest/crm/members-contacts/locations/locations/introduction).
3784
+ * ID of a business location
3837
3785
  * @format GUID
3838
3786
  */
3839
3787
  businessLocationId?: string | null;
@@ -3841,30 +3789,27 @@ interface Location extends LocationLocationInfoOneOf {
3841
3789
  /** @oneof */
3842
3790
  interface LocationLocationInfoOneOf {
3843
3791
  /**
3844
- * Custom address specified as a text string.
3792
+ * Custom address details
3845
3793
  * @maxLength 512
3846
3794
  */
3847
3795
  customAddress?: string | null;
3848
3796
  /**
3849
- * ID of a predefined business [location](https://dev.wix.com/docs/rest/crm/members-contacts/locations/locations/introduction).
3797
+ * ID of a business location
3850
3798
  * @format GUID
3851
3799
  */
3852
3800
  businessLocationId?: string | null;
3853
3801
  }
3854
3802
  declare enum Format {
3855
3803
  UNKNOWN_FORMAT_TYPE = "UNKNOWN_FORMAT_TYPE",
3856
- /** Face-to-face meeting at a physical location. */
3857
3804
  IN_PERSON = "IN_PERSON",
3858
- /** Online meeting via video conference. */
3859
3805
  VIDEO_CONFERENCE = "VIDEO_CONFERENCE",
3860
- /** Appointment conducted over the phone. */
3861
3806
  PHONE = "PHONE"
3862
3807
  }
3863
3808
  /** @enumType */
3864
3809
  type FormatWithLiterals = Format | 'UNKNOWN_FORMAT_TYPE' | 'IN_PERSON' | 'VIDEO_CONFERENCE' | 'PHONE';
3865
3810
  interface InPersonOptions {
3866
3811
  /**
3867
- * Physical locations where the appointment can take place.
3812
+ * The locations details
3868
3813
  * @minSize 1
3869
3814
  * @maxSize 1
3870
3815
  */
@@ -3872,14 +3817,14 @@ interface InPersonOptions {
3872
3817
  }
3873
3818
  interface VideoConferenceOptions {
3874
3819
  /**
3875
- * Description or instructions for video conference appointments.
3820
+ * Description or instructions for the online video conference
3876
3821
  * @maxLength 512
3877
3822
  */
3878
3823
  description?: string | null;
3879
3824
  }
3880
3825
  interface PhoneOptions {
3881
3826
  /**
3882
- * Description or instructions for phone appointments.
3827
+ * Description or instructions for the phone appointment
3883
3828
  * @maxLength 512
3884
3829
  */
3885
3830
  description?: string | null;
@@ -3892,19 +3837,19 @@ declare enum MultilineAddressComponentType {
3892
3837
  type MultilineAddressComponentTypeWithLiterals = MultilineAddressComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'MULTILINE_ADDRESS';
3893
3838
  interface MultilineAddress {
3894
3839
  /**
3895
- * Field label.
3840
+ * Label of the field.
3896
3841
  * @maxLength 350
3897
3842
  */
3898
3843
  label?: string | null;
3899
- /** Additional description or instructions for the field. */
3844
+ /** Description of the field. */
3900
3845
  description?: RichContent;
3901
- /** Whether to display country flags in the country selection. */
3846
+ /** Show country flags. */
3902
3847
  showCountryFlags?: boolean;
3903
- /** Default country configuration for the address field. */
3848
+ /** Default country configuration. */
3904
3849
  defaultCountryConfig?: DefaultCountryConfig;
3905
3850
  /** Fields settings. */
3906
3851
  fieldSettings?: FieldsSettings;
3907
- /** Whether autocomplete is enabled for the address line field. */
3852
+ /** Autocomplete enabled for address line field. */
3908
3853
  autocompleteEnabled?: boolean;
3909
3854
  /**
3910
3855
  * Flag identifying whether to show or hide the address labels.
@@ -3918,9 +3863,9 @@ interface MultilineAddress {
3918
3863
  showLabel?: boolean | null;
3919
3864
  }
3920
3865
  declare enum Type {
3921
- /** Unknown default country configuration type. */
3866
+ /** Unknown default country config type. */
3922
3867
  UNKNOWN_DEFAULT_COUNTRY = "UNKNOWN_DEFAULT_COUNTRY",
3923
- /** Country is determined by the submitter's IP address. */
3868
+ /** Country is determined by customer's IP address. */
3924
3869
  BY_IP = "BY_IP",
3925
3870
  /** Pre-selected default country. */
3926
3871
  COUNTRY = "COUNTRY"
@@ -3928,12 +3873,12 @@ declare enum Type {
3928
3873
  /** @enumType */
3929
3874
  type TypeWithLiterals = Type | 'UNKNOWN_DEFAULT_COUNTRY' | 'BY_IP' | 'COUNTRY';
3930
3875
  interface AddressLine2 {
3931
- /** Whether to display the address line 2 field. */
3876
+ /** Show address line 2 field. */
3932
3877
  show?: boolean;
3933
3878
  }
3934
3879
  interface DefaultCountryConfig extends DefaultCountryConfigOptionsOneOf {
3935
3880
  /**
3936
- * Country code for the pre-selected default country. Two-letter country code in ISO-3166 alpha-2 format.
3881
+ * Country.
3937
3882
  * @format COUNTRY
3938
3883
  */
3939
3884
  countryOptions?: string;
@@ -3943,13 +3888,13 @@ interface DefaultCountryConfig extends DefaultCountryConfigOptionsOneOf {
3943
3888
  /** @oneof */
3944
3889
  interface DefaultCountryConfigOptionsOneOf {
3945
3890
  /**
3946
- * Country code for the pre-selected default country. Two-letter country code in ISO-3166 alpha-2 format.
3891
+ * Country.
3947
3892
  * @format COUNTRY
3948
3893
  */
3949
3894
  countryOptions?: string;
3950
3895
  }
3951
3896
  interface FieldsSettings {
3952
- /** Configuration for the address line 2 field. */
3897
+ /** Address line 2. */
3953
3898
  addressLine2?: AddressLine2;
3954
3899
  }
3955
3900
  declare enum InputFieldInputType {
@@ -3975,9 +3920,9 @@ interface V4FormFieldContactInfo extends V4FormFieldContactInfoAdditionalInfoOne
3975
3920
  addressInfo?: FormFieldContactInfoAddressInfo;
3976
3921
  /** Custom field info. */
3977
3922
  customFieldInfo?: FormFieldContactInfoCustomFieldInfo;
3978
- /** Subscription info. */
3923
+ /** Subscription info */
3979
3924
  subscriptionInfo?: FormFieldContactInfoSubscriptionInfo;
3980
- /** The contact field that the form field maps to. */
3925
+ /** Field mapped to contacts. */
3981
3926
  contactField?: FormFieldContactInfoContactFieldWithLiterals;
3982
3927
  }
3983
3928
  /** @oneof */
@@ -3990,67 +3935,46 @@ interface V4FormFieldContactInfoAdditionalInfoOneOf {
3990
3935
  addressInfo?: FormFieldContactInfoAddressInfo;
3991
3936
  /** Custom field info. */
3992
3937
  customFieldInfo?: FormFieldContactInfoCustomFieldInfo;
3993
- /** Subscription info. */
3938
+ /** Subscription info */
3994
3939
  subscriptionInfo?: FormFieldContactInfoSubscriptionInfo;
3995
3940
  }
3996
3941
  declare enum FormFieldContactInfoEmailInfoTag {
3997
- /** Email without a specific tag. */
3998
3942
  UNTAGGED = "UNTAGGED",
3999
- /** Primary email address for the contact. */
4000
3943
  MAIN = "MAIN"
4001
3944
  }
4002
3945
  /** @enumType */
4003
3946
  type FormFieldContactInfoEmailInfoTagWithLiterals = FormFieldContactInfoEmailInfoTag | 'UNTAGGED' | 'MAIN';
4004
3947
  declare enum FormFieldContactInfoPhoneInfoTag {
4005
- /** Phone number without a specific tag. */
4006
3948
  UNTAGGED = "UNTAGGED",
4007
- /** Primary phone number for the contact. */
4008
3949
  MAIN = "MAIN"
4009
3950
  }
4010
3951
  /** @enumType */
4011
3952
  type FormFieldContactInfoPhoneInfoTagWithLiterals = FormFieldContactInfoPhoneInfoTag | 'UNTAGGED' | 'MAIN';
4012
3953
  declare enum AddressInfoTag {
4013
- /** Address without a specific tag. */
4014
3954
  UNTAGGED = "UNTAGGED",
4015
- /** Home address for the contact. */
4016
3955
  HOME = "HOME"
4017
3956
  }
4018
3957
  /** @enumType */
4019
3958
  type AddressInfoTagWithLiterals = AddressInfoTag | 'UNTAGGED' | 'HOME';
4020
3959
  declare enum SubscriptionInfoOptInLevel {
4021
- /** Unknown opt-in level. */
4022
3960
  UNKNOWN = "UNKNOWN",
4023
- /** Single confirmation opt-in. The contact is subscribed immediately. */
4024
3961
  SINGLE_CONFIRMATION = "SINGLE_CONFIRMATION",
4025
- /** Double confirmation opt-in. The contact must confirm their subscription via email. */
4026
3962
  DOUBLE_CONFIRMATION = "DOUBLE_CONFIRMATION"
4027
3963
  }
4028
3964
  /** @enumType */
4029
3965
  type SubscriptionInfoOptInLevelWithLiterals = SubscriptionInfoOptInLevel | 'UNKNOWN' | 'SINGLE_CONFIRMATION' | 'DOUBLE_CONFIRMATION';
4030
3966
  declare enum FormFieldContactInfoContactField {
4031
- /** Unknown contact field. */
4032
3967
  UNDEFINED = "UNDEFINED",
4033
- /** First name. */
4034
3968
  FIRST_NAME = "FIRST_NAME",
4035
- /** CLast name. */
4036
3969
  LAST_NAME = "LAST_NAME",
4037
- /** Company name. */
4038
3970
  COMPANY = "COMPANY",
4039
- /** Job position or title. */
4040
3971
  POSITION = "POSITION",
4041
- /** Email address. */
4042
3972
  EMAIL = "EMAIL",
4043
- /** Phone number. */
4044
3973
  PHONE = "PHONE",
4045
- /** Physical address. */
4046
3974
  ADDRESS = "ADDRESS",
4047
- /** Birth date. */
4048
3975
  BIRTHDATE = "BIRTHDATE",
4049
- /** Custom field. */
4050
3976
  CUSTOM_FIELD = "CUSTOM_FIELD",
4051
- /** Subscription status. */
4052
3977
  SUBSCRIPTION = "SUBSCRIPTION",
4053
- /** VAT identification number. */
4054
3978
  VAT_ID = "VAT_ID"
4055
3979
  }
4056
3980
  /** @enumType */
@@ -4077,8 +4001,8 @@ interface FormFieldContactInfoCustomFieldInfo {
4077
4001
  }
4078
4002
  interface FormFieldContactInfoSubscriptionInfo {
4079
4003
  /**
4080
- * Subscription consent opt-in level.
4081
- * Default: `SINGLE_CONFIRMATION`
4004
+ * Subscription consent opt in level, either single or double confirmation.
4005
+ * Default: SINGLE_CONFIRMATION
4082
4006
  */
4083
4007
  optInLevel?: SubscriptionInfoOptInLevelWithLiterals;
4084
4008
  }
@@ -4356,297 +4280,250 @@ interface FormFieldV2InputFieldInputTypeOptionsOneOf {
4356
4280
  }
4357
4281
  /** Copy of the entity existing in form template project, needed to hide translations. */
4358
4282
  interface DisplayField extends DisplayFieldDisplayFieldTypeOptionsOneOf {
4359
- /** Configuration for rich content display fields. */
4283
+ /** Component displaying rich content */
4360
4284
  richContentOptions?: V4RichContentOptions;
4361
- /** Configuration for page navigation display fields. */
4285
+ /** Page navigation component resolving as navigation or submit buttons */
4362
4286
  pageNavigationOptions?: V4PageNavigationOptions;
4363
- /** Type of display field that determines its appearance and behavior. */
4287
+ /** Type of the display field */
4364
4288
  displayFieldType?: DisplayFieldTypeWithLiterals;
4365
4289
  }
4366
4290
  /** @oneof */
4367
4291
  interface DisplayFieldDisplayFieldTypeOptionsOneOf {
4368
- /** Configuration for rich content display fields. */
4292
+ /** Component displaying rich content */
4369
4293
  richContentOptions?: V4RichContentOptions;
4370
- /** Configuration for page navigation display fields. */
4294
+ /** Page navigation component resolving as navigation or submit buttons */
4371
4295
  pageNavigationOptions?: V4PageNavigationOptions;
4372
4296
  }
4373
4297
  declare enum DisplayFieldType {
4374
- /** Unknown display field type. */
4375
4298
  UNKNOWN_FIELD_TYPE = "UNKNOWN_FIELD_TYPE",
4376
- /** Rich content element for displaying formatted text, images, and media. */
4377
4299
  RICH_CONTENT = "RICH_CONTENT",
4378
- /** Navigation element with buttons for moving between form pages or submitting. */
4379
4300
  PAGE_NAVIGATION = "PAGE_NAVIGATION"
4380
4301
  }
4381
4302
  /** @enumType */
4382
4303
  type DisplayFieldTypeWithLiterals = DisplayFieldType | 'UNKNOWN_FIELD_TYPE' | 'RICH_CONTENT' | 'PAGE_NAVIGATION';
4383
4304
  interface V4RichContentOptions {
4384
- /** Rich content to display, including formatted text, images, and embedded media. */
4305
+ /** Content of the header */
4385
4306
  richContent?: RichContent;
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
- */
4307
+ /** Number of paragraphs visible. Other part is hidden under expandable section. If not provided all text visible. */
4390
4308
  maxShownParagraphs?: number | null;
4391
4309
  }
4392
4310
  interface V4PageNavigationOptions {
4393
4311
  /**
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.
4312
+ * When button is not on last page it behaves as switch between pages page, text of label to go to next page.
4396
4313
  * @maxLength 65
4397
4314
  */
4398
4315
  nextPageText?: string | null;
4399
4316
  /**
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.
4317
+ * When button is not on last page it behaves as switch between pages page, text of label to go to previous page.
4402
4318
  * @maxLength 65
4403
4319
  */
4404
4320
  previousPageText?: string | null;
4405
4321
  /**
4406
- * Text displayed on the button when it submits the form.
4407
- * Only applicable when the button is on the final form page.
4322
+ * Text on the button when button is submitting a form
4408
4323
  * @maxLength 65
4409
4324
  */
4410
4325
  submitText?: string | null;
4411
4326
  }
4412
4327
  interface Field extends FieldFieldTypeOptionsOneOf {
4413
- /** Configuration for input fields that collect user data. */
4328
+ /** Field accept input of data */
4414
4329
  inputOptions?: InputField;
4415
- /** Configuration for display fields that show information without collecting input. */
4330
+ /** Field for displaying information such as header or text paragraph */
4416
4331
  displayOptions?: FieldsDisplayField;
4417
4332
  /**
4418
- * Field ID.
4333
+ * Field id.
4419
4334
  * @format GUID
4420
4335
  * @immutable
4421
4336
  */
4422
4337
  _id?: string;
4423
4338
  /**
4424
- * Whether the field is hidden from submitters.
4425
- *
4426
- * Default: `false`
4339
+ * Whether the field is hidden.
4340
+ * Default: false
4427
4341
  */
4428
4342
  hidden?: boolean;
4429
4343
  /**
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.
4344
+ * Custom identification of field, can be used to specify exceptional behaviour of client for specific field
4431
4345
  * @maxLength 50
4432
4346
  */
4433
4347
  identifier?: string | null;
4434
4348
  /**
4435
- * Field type.
4349
+ * Type of the field
4436
4350
  * @readonly
4437
4351
  */
4438
4352
  fieldType?: FieldTypeWithLiterals;
4439
4353
  }
4440
4354
  /** @oneof */
4441
4355
  interface FieldFieldTypeOptionsOneOf {
4442
- /** Configuration for input fields that collect user data. */
4356
+ /** Field accept input of data */
4443
4357
  inputOptions?: InputField;
4444
- /** Configuration for display fields that show information without collecting input. */
4358
+ /** Field for displaying information such as header or text paragraph */
4445
4359
  displayOptions?: FieldsDisplayField;
4446
4360
  }
4447
4361
  declare enum FieldType {
4448
- /** Unknown field type. */
4449
4362
  UNKNOWN_FIELD_TYPE = "UNKNOWN_FIELD_TYPE",
4450
- /** Input field that collects data from users. */
4451
4363
  INPUT = "INPUT",
4452
- /** Display field that shows information without collecting input. */
4453
4364
  DISPLAY = "DISPLAY"
4454
4365
  }
4455
4366
  /** @enumType */
4456
4367
  type FieldTypeWithLiterals = FieldType | 'UNKNOWN_FIELD_TYPE' | 'INPUT' | 'DISPLAY';
4457
4368
  interface InputField extends InputFieldInputTypeOptionsOneOf {
4458
- /** String input field settings. */
4369
+ /** Input return string as value */
4459
4370
  stringOptions?: _String;
4460
- /** Number input field settings. */
4371
+ /** Input return number as value */
4461
4372
  numberOptions?: _Number;
4462
- /** Boolean input field settings. */
4373
+ /** Input return boolean as value */
4463
4374
  booleanOptions?: _Boolean;
4464
- /** Array input field settings. */
4375
+ /** Input return array as value */
4465
4376
  arrayOptions?: _Array;
4466
- /** Object input field settings. */
4377
+ /** Input return object as value */
4467
4378
  objectOptions?: _Object;
4468
- /** File input field settings. Files are uploaded to the [Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager). */
4379
+ /** Input return "Wix file" as value */
4469
4380
  wixFileOptions?: WixFile;
4470
- /** Payment input field settings. */
4381
+ /** Input returns selected products as value. */
4471
4382
  paymentOptions?: Payment;
4472
- /** Scheduling input field settings. */
4383
+ /** Input returns scheduling as value. */
4473
4384
  schedulingOptions?: Scheduling;
4474
- /** Address input field settings. */
4385
+ /** Input returns multiline address as value. */
4475
4386
  addressOptions?: Address;
4476
4387
  /**
4477
- * Human readable identifier used to reference a field. For example, `"address"`.
4478
- *
4479
- * Can be set once.
4388
+ * Definition of a target where the value of field belongs.
4480
4389
  * @minLength 1
4481
4390
  * @maxLength 200
4482
4391
  * @immutable
4483
4392
  */
4484
4393
  target?: string;
4485
4394
  /**
4486
- * Whether this field contains Personally Identifiable Information (PII).
4487
- *
4488
- * PII fields are automatically encrypted when stored.
4489
- *
4490
- * Default: `false`
4395
+ * Mark the field as containing personal information. This will encrypt user data when storing it.
4396
+ * Default: false
4491
4397
  */
4492
4398
  pii?: boolean;
4493
4399
  /**
4494
- * Whether the field is required for form submission.
4495
- *
4496
- * Default: `false`
4400
+ * Whether the field is required.
4401
+ * Default: false
4497
4402
  */
4498
4403
  required?: boolean;
4499
4404
  /**
4500
- * Type of the input field that determines what kind of data it collects.
4405
+ * Type of the input field
4501
4406
  * @readonly
4502
4407
  */
4503
4408
  inputType?: InputTypeWithLiterals;
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
- */
4409
+ /** Mapping to contacts, telling to what contact property field input value should be saved. */
4509
4410
  contactMapping?: FormFieldContactInfo;
4510
4411
  /**
4511
- * Whether the field is read-only.
4512
- *
4513
- * Default: `false`
4412
+ * Whether the field is read only.
4413
+ * Default: false
4514
4414
  */
4515
4415
  readOnly?: boolean;
4516
4416
  }
4517
4417
  /** @oneof */
4518
4418
  interface InputFieldInputTypeOptionsOneOf {
4519
- /** String input field settings. */
4419
+ /** Input return string as value */
4520
4420
  stringOptions?: _String;
4521
- /** Number input field settings. */
4421
+ /** Input return number as value */
4522
4422
  numberOptions?: _Number;
4523
- /** Boolean input field settings. */
4423
+ /** Input return boolean as value */
4524
4424
  booleanOptions?: _Boolean;
4525
- /** Array input field settings. */
4425
+ /** Input return array as value */
4526
4426
  arrayOptions?: _Array;
4527
- /** Object input field settings. */
4427
+ /** Input return object as value */
4528
4428
  objectOptions?: _Object;
4529
- /** File input field settings. Files are uploaded to the [Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager). */
4429
+ /** Input return "Wix file" as value */
4530
4430
  wixFileOptions?: WixFile;
4531
- /** Payment input field settings. */
4431
+ /** Input returns selected products as value. */
4532
4432
  paymentOptions?: Payment;
4533
- /** Scheduling input field settings. */
4433
+ /** Input returns scheduling as value. */
4534
4434
  schedulingOptions?: Scheduling;
4535
- /** Address input field settings. */
4435
+ /** Input returns multiline address as value. */
4536
4436
  addressOptions?: Address;
4537
4437
  }
4538
4438
  interface StringType extends StringTypeFormatOptionsOneOf {
4539
- /** Validation rules for strings with date format. */
4439
+ /** DATE format options */
4540
4440
  dateOptions?: DateTimeConstraints;
4541
- /** Validation rules for strings with date and time format. */
4441
+ /** DATE_TIME format options */
4542
4442
  dateTimeOptions?: DateTimeConstraints;
4543
- /** Validation rules for strings with time format. */
4443
+ /** TIME format options */
4544
4444
  timeOptions?: DateTimeConstraints;
4545
- /** Validation rules for string with date and time format, where time is optional. */
4445
+ /** DATE_OPTIONAL_TIME format options */
4546
4446
  dateOptionalTimeOptions?: DateTimeConstraints;
4547
- /** Validation rules for strings with phone number format. */
4447
+ /** PHONE format options */
4548
4448
  phoneOptions?: PhoneConstraints;
4549
4449
  /**
4550
- * Minimum required length for the string value.
4450
+ * Minimum length.
4551
4451
  * @max 20000
4552
4452
  */
4553
4453
  minLength?: number | null;
4554
4454
  /**
4555
- * Maximum allowed length for the string value.
4455
+ * Maximum length.
4556
4456
  * @max 20000
4557
4457
  */
4558
4458
  maxLength?: number | null;
4559
4459
  /**
4560
- * Regular expression pattern that the string value must match.
4460
+ * Pattern for a regular expression match.
4561
4461
  * @maxLength 500
4562
4462
  */
4563
4463
  pattern?: string | null;
4564
- /** Expected format of the string value. */
4464
+ /** Format of a string. */
4565
4465
  format?: FormatEnumFormatWithLiterals;
4566
4466
  /**
4567
- * List of specific values that are allowed for this field.
4568
- * When specified, the input must match one of these predefined values.
4467
+ * List of allowed values.
4569
4468
  * @maxSize 500
4570
4469
  * @maxLength 20000
4571
4470
  */
4572
4471
  enum?: string[] | null;
4573
- /** Custom error messages displayed when validation fails. */
4472
+ /** User defined error messages when particular validation constraint fails */
4574
4473
  validationMessages?: ValidationMessages;
4575
4474
  }
4576
4475
  /** @oneof */
4577
4476
  interface StringTypeFormatOptionsOneOf {
4578
- /** Validation rules for strings with date format. */
4477
+ /** DATE format options */
4579
4478
  dateOptions?: DateTimeConstraints;
4580
- /** Validation rules for strings with date and time format. */
4479
+ /** DATE_TIME format options */
4581
4480
  dateTimeOptions?: DateTimeConstraints;
4582
- /** Validation rules for strings with time format. */
4481
+ /** TIME format options */
4583
4482
  timeOptions?: DateTimeConstraints;
4584
- /** Validation rules for string with date and time format, where time is optional. */
4483
+ /** DATE_OPTIONAL_TIME format options */
4585
4484
  dateOptionalTimeOptions?: DateTimeConstraints;
4586
- /** Validation rules for strings with phone number format. */
4485
+ /** PHONE format options */
4587
4486
  phoneOptions?: PhoneConstraints;
4588
4487
  }
4589
4488
  declare enum FormatEnumFormat {
4590
- /** Unknown format. */
4591
4489
  UNKNOWN_FORMAT = "UNKNOWN_FORMAT",
4592
- /** Date format. */
4593
4490
  DATE = "DATE",
4594
- /** Time format. */
4595
4491
  TIME = "TIME",
4596
- /** Date and time format. */
4597
4492
  DATE_TIME = "DATE_TIME",
4598
- /** Email format. */
4599
4493
  EMAIL = "EMAIL",
4600
- /** URL format. */
4601
4494
  URL = "URL",
4602
- /** UUID format. */
4603
4495
  UUID = "UUID",
4604
- /** Phone number format. */
4605
4496
  PHONE = "PHONE",
4606
- /** URI format. */
4607
4497
  URI = "URI",
4608
- /** Hostname format. */
4609
4498
  HOSTNAME = "HOSTNAME",
4610
- /** Hexadecimal color code format. */
4611
4499
  COLOR_HEX = "COLOR_HEX",
4612
- /** Currency format. */
4613
4500
  CURRENCY = "CURRENCY",
4614
- /** Language code format. */
4615
4501
  LANGUAGE = "LANGUAGE",
4616
- /** Date with optional time format. */
4617
4502
  DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
4618
4503
  }
4619
4504
  /** @enumType */
4620
4505
  type FormatEnumFormatWithLiterals = FormatEnumFormat | 'UNKNOWN_FORMAT' | 'DATE' | 'TIME' | 'DATE_TIME' | 'EMAIL' | 'URL' | 'UUID' | 'PHONE' | 'URI' | 'HOSTNAME' | 'COLOR_HEX' | 'CURRENCY' | 'LANGUAGE' | 'DATE_OPTIONAL_TIME';
4621
4506
  interface DateTimeConstraints {
4622
4507
  /**
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).
4508
+ * Support static constrains defined as ISO date/time format, as well as
4509
+ * dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
4510
+ * The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
4511
+ * The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
4630
4512
  * @maxLength 50
4631
4513
  */
4632
4514
  minimum?: string | null;
4633
4515
  /**
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).
4516
+ * Support static constrains defined as ISO date/time format, as well as
4517
+ * dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
4518
+ * The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
4519
+ * The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
4641
4520
  * @maxLength 50
4642
4521
  */
4643
4522
  maximum?: string | null;
4644
4523
  }
4645
4524
  interface PhoneConstraints {
4646
4525
  /**
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"`.
4526
+ * Country codes for phone number that are allowed
4650
4527
  * @maxSize 250
4651
4528
  * @maxLength 2
4652
4529
  */
@@ -4654,43 +4531,31 @@ interface PhoneConstraints {
4654
4531
  }
4655
4532
  interface ValidationMessages {
4656
4533
  /**
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.
4534
+ * Error message shown when validation of patter fails
4660
4535
  * @maxLength 200
4661
4536
  */
4662
4537
  pattern?: string | null;
4663
4538
  }
4664
4539
  declare enum StringComponentType {
4665
- /** Unknown component type. */
4666
4540
  UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
4667
- /** Text input component. */
4668
4541
  TEXT_INPUT = "TEXT_INPUT",
4669
- /** Radio group component. */
4670
4542
  RADIO_GROUP = "RADIO_GROUP",
4671
- /** Dropdown component. */
4672
4543
  DROPDOWN = "DROPDOWN",
4673
- /** Date and time component. */
4674
4544
  DATE_TIME = "DATE_TIME",
4675
- /** Phone number component. */
4676
4545
  PHONE_INPUT = "PHONE_INPUT",
4677
- /** Date selection component. */
4678
4546
  DATE_INPUT = "DATE_INPUT",
4679
- /** Time selection component. */
4680
4547
  TIME_INPUT = "TIME_INPUT",
4681
- /** Calendar-style date picker component. */
4682
4548
  DATE_PICKER = "DATE_PICKER",
4683
- /** Dropdown component for selecting available services. */
4684
4549
  SERVICES_DROPDOWN = "SERVICES_DROPDOWN"
4685
4550
  }
4686
4551
  /** @enumType */
4687
4552
  type StringComponentTypeWithLiterals = StringComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'TEXT_INPUT' | 'RADIO_GROUP' | 'DROPDOWN' | 'DATE_TIME' | 'PHONE_INPUT' | 'DATE_INPUT' | 'TIME_INPUT' | 'DATE_PICKER' | 'SERVICES_DROPDOWN';
4688
4553
  interface NumberType {
4689
- /** The maximum value of the number. Inclusive. */
4554
+ /** Inclusive maximum value. */
4690
4555
  maximum?: number | null;
4691
- /** The minimum value of the number. Inclusive. */
4556
+ /** Inclusive minimum value. */
4692
4557
  minimum?: number | null;
4693
- /** A number that the value must be a multiple of. */
4558
+ /** Multiple of value. */
4694
4559
  multipleOf?: number | null;
4695
4560
  /**
4696
4561
  * List of allowed values.
@@ -4699,11 +4564,8 @@ interface NumberType {
4699
4564
  enum?: number[] | null;
4700
4565
  }
4701
4566
  declare enum NumberComponentType {
4702
- /** Unknown component type. */
4703
4567
  UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
4704
- /** Numeric input component. */
4705
4568
  NUMBER_INPUT = "NUMBER_INPUT",
4706
- /** Rating input component. */
4707
4569
  RATING_INPUT = "RATING_INPUT"
4708
4570
  }
4709
4571
  /** @enumType */
@@ -4716,286 +4578,229 @@ interface BooleanType {
4716
4578
  enum?: boolean[];
4717
4579
  }
4718
4580
  declare enum BooleanComponentType {
4719
- /** Unknown component type. */
4720
4581
  UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
4721
- /** Checkbox component. */
4722
4582
  CHECKBOX = "CHECKBOX"
4723
4583
  }
4724
4584
  /** @enumType */
4725
4585
  type BooleanComponentTypeWithLiterals = BooleanComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX';
4726
4586
  interface ArrayType {
4727
4587
  /**
4728
- * Maximum number of elements allowed in the array.
4588
+ * Maximum amount of array elements.
4729
4589
  * @max 1000
4730
4590
  */
4731
4591
  maxItems?: number | null;
4732
4592
  /**
4733
- * Minimum number of elements required in the array.
4593
+ * Minimum amount of array elements.
4734
4594
  * @max 1000
4735
4595
  */
4736
4596
  minItems?: number | null;
4737
- /** Type of items allowed in the array. */
4597
+ /** Type of items allowed in array. */
4738
4598
  items?: ArrayItems;
4739
4599
  }
4740
4600
  declare enum ItemType {
4741
- /** Unknown item type. */
4742
4601
  UNKNOWN_ITEM_TYPE = "UNKNOWN_ITEM_TYPE",
4743
- /** Array can contain string values. */
4744
4602
  STRING = "STRING",
4745
- /** Array can contain numeric values. */
4746
4603
  NUMBER = "NUMBER",
4747
- /** Array can contain boolean values. */
4748
4604
  BOOLEAN = "BOOLEAN",
4749
- /** Array can contain object values. */
4750
4605
  OBJECT = "OBJECT"
4751
4606
  }
4752
4607
  /** @enumType */
4753
4608
  type ItemTypeWithLiterals = ItemType | 'UNKNOWN_ITEM_TYPE' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'OBJECT';
4754
4609
  interface ObjectType {
4755
- /** Definition of object properties and their validation rules. */
4610
+ /** Description of object properties. */
4756
4611
  properties?: Record<string, PropertiesType>;
4757
4612
  }
4758
4613
  declare enum PropertiesTypeEnum {
4759
- /** Unknown property type. */
4760
4614
  UNKNOWN_PROPERTY_TYPE = "UNKNOWN_PROPERTY_TYPE",
4761
- /** Property must contain a string value. */
4762
4615
  STRING = "STRING",
4763
- /** Property must contain a numeric value. */
4764
4616
  NUMBER = "NUMBER",
4765
- /** Property must contain a boolean value. */
4766
4617
  BOOLEAN = "BOOLEAN",
4767
- /** Property must contain an array. */
4768
4618
  ARRAY = "ARRAY"
4769
4619
  }
4770
4620
  /** @enumType */
4771
4621
  type PropertiesTypeEnumWithLiterals = PropertiesTypeEnum | 'UNKNOWN_PROPERTY_TYPE' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'ARRAY';
4772
4622
  interface PropertiesType extends PropertiesTypePropertiesTypeOptionsOneOf {
4773
- /** Validation rules for string properties. */
4623
+ /** String type validation for property. */
4774
4624
  stringOptions?: StringType;
4775
- /** Validation rules for numeric properties. */
4625
+ /** Number type validation for property. */
4776
4626
  numberOptions?: NumberType;
4777
- /** Validation rules for boolean properties. */
4627
+ /** Boolean type validation for property. */
4778
4628
  booleanOptions?: BooleanType;
4779
- /** Validation rules for array properties. */
4629
+ /** Array type validation for property. */
4780
4630
  arrayOptions?: ArrayType;
4781
4631
  /**
4782
- * Data type of the object property.
4632
+ * Type of object properties
4783
4633
  * @readonly
4784
4634
  */
4785
4635
  propertiesType?: PropertiesTypeEnumWithLiterals;
4786
- /** Whether the object property is required for validation. */
4636
+ /** Whether the property is required. */
4787
4637
  required?: boolean;
4788
4638
  }
4789
4639
  /** @oneof */
4790
4640
  interface PropertiesTypePropertiesTypeOptionsOneOf {
4791
- /** Validation rules for string properties. */
4641
+ /** String type validation for property. */
4792
4642
  stringOptions?: StringType;
4793
- /** Validation rules for numeric properties. */
4643
+ /** Number type validation for property. */
4794
4644
  numberOptions?: NumberType;
4795
- /** Validation rules for boolean properties. */
4645
+ /** Boolean type validation for property. */
4796
4646
  booleanOptions?: BooleanType;
4797
- /** Validation rules for array properties. */
4647
+ /** Array type validation for property. */
4798
4648
  arrayOptions?: ArrayType;
4799
4649
  }
4800
4650
  interface ArrayItems extends ArrayItemsItemTypeOptionsOneOf {
4801
- /** Validation rules for string array elements. */
4651
+ /** String type validation for items. */
4802
4652
  stringOptions?: StringType;
4803
- /** Validation rules for numeric array elements. */
4653
+ /** Number type validation for items. */
4804
4654
  numberOptions?: NumberType;
4805
- /** Validation rules for boolean array elements. */
4655
+ /** Boolean type validation for items. */
4806
4656
  booleanOptions?: BooleanType;
4807
- /** Validation rules for object array elements. */
4657
+ /** Object type validation for items */
4808
4658
  objectOptions?: ObjectType;
4809
4659
  /**
4810
- * Allowed item type.
4660
+ * Type of array items
4811
4661
  * @readonly
4812
4662
  */
4813
4663
  itemType?: ItemTypeWithLiterals;
4814
4664
  }
4815
4665
  /** @oneof */
4816
4666
  interface ArrayItemsItemTypeOptionsOneOf {
4817
- /** Validation rules for string array elements. */
4667
+ /** String type validation for items. */
4818
4668
  stringOptions?: StringType;
4819
- /** Validation rules for numeric array elements. */
4669
+ /** Number type validation for items. */
4820
4670
  numberOptions?: NumberType;
4821
- /** Validation rules for boolean array elements. */
4671
+ /** Boolean type validation for items. */
4822
4672
  booleanOptions?: BooleanType;
4823
- /** Validation rules for object array elements. */
4673
+ /** Object type validation for items */
4824
4674
  objectOptions?: ObjectType;
4825
4675
  }
4826
4676
  declare enum ArrayComponentType {
4827
- /** Unknown component type. */
4828
4677
  UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
4829
- /** Checkbox group component. */
4830
4678
  CHECKBOX_GROUP = "CHECKBOX_GROUP",
4831
- /** Tags component. */
4832
4679
  TAGS = "TAGS",
4833
4680
  SERVICES_CHECKBOX_GROUP = "SERVICES_CHECKBOX_GROUP"
4834
4681
  }
4835
4682
  /** @enumType */
4836
4683
  type ArrayComponentTypeWithLiterals = ArrayComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX_GROUP' | 'TAGS' | 'SERVICES_CHECKBOX_GROUP';
4837
4684
  declare enum WixFileComponentType {
4838
- /** Unknown component type. */
4839
4685
  UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
4840
- /** File upload component. */
4841
4686
  FILE_UPLOAD = "FILE_UPLOAD",
4842
- /** Signature component. */
4843
4687
  SIGNATURE = "SIGNATURE"
4844
4688
  }
4845
4689
  /** @enumType */
4846
4690
  type WixFileComponentTypeWithLiterals = WixFileComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'FILE_UPLOAD' | 'SIGNATURE';
4847
4691
  declare enum PaymentComponentType {
4848
- /** Unknown component type. */
4849
4692
  UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
4850
- /** Checkbox group component. */
4851
4693
  CHECKBOX_GROUP = "CHECKBOX_GROUP",
4852
- /** Donation input component. */
4853
4694
  DONATION_INPUT = "DONATION_INPUT",
4854
- /** Payment input component. */
4855
4695
  PAYMENT_INPUT = "PAYMENT_INPUT",
4856
- /** Fixed payment component. */
4857
4696
  FIXED_PAYMENT = "FIXED_PAYMENT"
4858
4697
  }
4859
4698
  /** @enumType */
4860
4699
  type PaymentComponentTypeWithLiterals = PaymentComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'CHECKBOX_GROUP' | 'DONATION_INPUT' | 'PAYMENT_INPUT' | 'FIXED_PAYMENT';
4861
4700
  declare enum ComponentType {
4862
- /** Unknown component type. */
4863
4701
  UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
4864
- /** Multiline address component. */
4865
4702
  MULTILINE_ADDRESS = "MULTILINE_ADDRESS"
4866
4703
  }
4867
4704
  /** @enumType */
4868
4705
  type ComponentTypeWithLiterals = ComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'MULTILINE_ADDRESS';
4869
4706
  declare enum SchedulingComponentType {
4870
- /** Unknown component type. */
4871
4707
  UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
4872
- /** Appointment component. */
4873
4708
  APPOINTMENT = "APPOINTMENT"
4874
4709
  }
4875
4710
  /** @enumType */
4876
4711
  type SchedulingComponentTypeWithLiterals = SchedulingComponentType | 'UNKNOWN_COMPONENT_TYPE' | 'APPOINTMENT';
4877
4712
  declare enum InputType {
4878
- /** Unknown input type. */
4879
4713
  UNKNOWN_INPUT_TYPE = "UNKNOWN_INPUT_TYPE",
4880
- /** String input. */
4881
4714
  STRING = "STRING",
4882
- /** Numeric input. */
4883
4715
  NUMBER = "NUMBER",
4884
- /** Boolean input. */
4885
4716
  BOOLEAN = "BOOLEAN",
4886
- /** Array input. */
4887
4717
  ARRAY = "ARRAY",
4888
- /** Object input. */
4889
4718
  OBJECT = "OBJECT",
4890
- /** File upload input. */
4891
4719
  WIX_FILE = "WIX_FILE",
4892
- /** Payment input. */
4893
4720
  PAYMENT = "PAYMENT",
4894
- /** Scheduling input. */
4895
4721
  SCHEDULING = "SCHEDULING",
4896
- /** Address input. */
4897
4722
  ADDRESS = "ADDRESS"
4898
4723
  }
4899
4724
  /** @enumType */
4900
4725
  type InputTypeWithLiterals = InputType | 'UNKNOWN_INPUT_TYPE' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'ARRAY' | 'OBJECT' | 'WIX_FILE' | 'PAYMENT' | 'SCHEDULING' | 'ADDRESS';
4901
4726
  interface FormFieldContactInfo extends FormFieldContactInfoAdditionalInfoOneOf {
4902
- /** Configuration for email contact fields. */
4727
+ /** Email info. */
4903
4728
  emailInfo?: EmailInfo;
4904
- /** Configuration for phone contact fields. */
4729
+ /** Phone info. */
4905
4730
  phoneInfo?: PhoneInfo;
4906
- /** Configuration for address contact fields. */
4731
+ /** Address info. */
4907
4732
  addressInfo?: AddressInfo;
4908
- /** Configuration for custom contact fields. */
4733
+ /** Custom field info. */
4909
4734
  customFieldInfo?: CustomFieldInfo;
4910
- /** Configuration for subscription contact fields. */
4735
+ /** Subscription info */
4911
4736
  subscriptionInfo?: SubscriptionInfo;
4912
- /** The [Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/introduction) field that this form field maps to. */
4737
+ /** Field mapped to contacts. */
4913
4738
  contactField?: ContactFieldWithLiterals;
4914
4739
  }
4915
4740
  /** @oneof */
4916
4741
  interface FormFieldContactInfoAdditionalInfoOneOf {
4917
- /** Configuration for email contact fields. */
4742
+ /** Email info. */
4918
4743
  emailInfo?: EmailInfo;
4919
- /** Configuration for phone contact fields. */
4744
+ /** Phone info. */
4920
4745
  phoneInfo?: PhoneInfo;
4921
- /** Configuration for address contact fields. */
4746
+ /** Address info. */
4922
4747
  addressInfo?: AddressInfo;
4923
- /** Configuration for custom contact fields. */
4748
+ /** Custom field info. */
4924
4749
  customFieldInfo?: CustomFieldInfo;
4925
- /** Configuration for subscription contact fields. */
4750
+ /** Subscription info */
4926
4751
  subscriptionInfo?: SubscriptionInfo;
4927
4752
  }
4928
4753
  declare enum EmailInfoTag {
4929
- /** Untagged email address. */
4930
4754
  UNTAGGED = "UNTAGGED",
4931
- /** Primary email address for the contact. */
4932
4755
  MAIN = "MAIN"
4933
4756
  }
4934
4757
  /** @enumType */
4935
4758
  type EmailInfoTagWithLiterals = EmailInfoTag | 'UNTAGGED' | 'MAIN';
4936
4759
  declare enum PhoneInfoTag {
4937
- /** Untagged phone number. */
4938
4760
  UNTAGGED = "UNTAGGED",
4939
- /** Primary phone number for the contact. */
4940
4761
  MAIN = "MAIN"
4941
4762
  }
4942
4763
  /** @enumType */
4943
4764
  type PhoneInfoTagWithLiterals = PhoneInfoTag | 'UNTAGGED' | 'MAIN';
4944
4765
  declare enum Tag {
4945
- /** Untagged address. */
4946
4766
  UNTAGGED = "UNTAGGED",
4947
- /** Home address. */
4948
4767
  HOME = "HOME"
4949
4768
  }
4950
4769
  /** @enumType */
4951
4770
  type TagWithLiterals = Tag | 'UNTAGGED' | 'HOME';
4952
4771
  declare enum ConfirmationLevel {
4953
- /** Unknown confirmation level. */
4954
4772
  UNKNOWN_CONFIRMATION_LEVEL = "UNKNOWN_CONFIRMATION_LEVEL",
4955
- /** Single confirmation level. */
4956
4773
  SINGLE_CONFIRMATION = "SINGLE_CONFIRMATION",
4957
- /** Double confirmation level. */
4958
4774
  DOUBLE_CONFIRMATION = "DOUBLE_CONFIRMATION"
4959
4775
  }
4960
4776
  /** @enumType */
4961
4777
  type ConfirmationLevelWithLiterals = ConfirmationLevel | 'UNKNOWN_CONFIRMATION_LEVEL' | 'SINGLE_CONFIRMATION' | 'DOUBLE_CONFIRMATION';
4962
4778
  declare enum ContactField {
4963
4779
  UNKNOWN_CONTACT_FIELD = "UNKNOWN_CONTACT_FIELD",
4964
- /** Contact's first name. */
4965
4780
  FIRST_NAME = "FIRST_NAME",
4966
- /** Contact's last name. */
4967
4781
  LAST_NAME = "LAST_NAME",
4968
- /** Contact's company or organization. */
4969
4782
  COMPANY = "COMPANY",
4970
- /** Contact's job title or position. */
4971
4783
  POSITION = "POSITION",
4972
- /** Contact's email address. */
4973
4784
  EMAIL = "EMAIL",
4974
- /** Contact's phone number. */
4975
4785
  PHONE = "PHONE",
4976
- /** Contact's physical address. */
4977
4786
  ADDRESS = "ADDRESS",
4978
- /** Contact's birth date. */
4979
4787
  BIRTHDATE = "BIRTHDATE",
4980
- /** Custom contact field defined by the site owner. */
4981
4788
  CUSTOM_FIELD = "CUSTOM_FIELD",
4982
- /** Contact's subscription preferences. */
4983
4789
  SUBSCRIPTION = "SUBSCRIPTION",
4984
- /** Contact's VAT identification number. */
4985
4790
  VAT_ID = "VAT_ID"
4986
4791
  }
4987
4792
  /** @enumType */
4988
4793
  type ContactFieldWithLiterals = ContactField | 'UNKNOWN_CONTACT_FIELD' | 'FIRST_NAME' | 'LAST_NAME' | 'COMPANY' | 'POSITION' | 'EMAIL' | 'PHONE' | 'ADDRESS' | 'BIRTHDATE' | 'CUSTOM_FIELD' | 'SUBSCRIPTION' | 'VAT_ID';
4989
4794
  interface EmailInfo {
4990
- /** Email categorization tag. */
4795
+ /** Email tag. */
4991
4796
  tag?: EmailInfoTagWithLiterals;
4992
4797
  }
4993
4798
  interface PhoneInfo {
4994
- /** Phone number categorization tag. */
4799
+ /** Phone tag. */
4995
4800
  tag?: PhoneInfoTagWithLiterals;
4996
4801
  }
4997
4802
  interface AddressInfo {
4998
- /** Address categorization tag. */
4803
+ /** Address tag. */
4999
4804
  tag?: TagWithLiterals;
5000
4805
  }
5001
4806
  interface CustomFieldInfo {
@@ -5008,253 +4813,243 @@ interface CustomFieldInfo {
5008
4813
  }
5009
4814
  interface SubscriptionInfo {
5010
4815
  /**
5011
- * Subscription consent opt-in level, either single or double confirmation.
5012
- * Default: `SINGLE_CONFIRMATION`
4816
+ * Subscription consent opt in level, either single or double confirmation.
4817
+ * Default: SINGLE_CONFIRMATION
5013
4818
  */
5014
4819
  confirmationLevel?: ConfirmationLevelWithLiterals;
5015
4820
  }
5016
4821
  interface _String extends _StringComponentTypeOptionsOneOf {
5017
- /** Text input component settings. */
4822
+ /** Text input field */
5018
4823
  textInputOptions?: TextInput;
5019
- /** Radio group component settings. */
4824
+ /** Selection field as radio group */
5020
4825
  radioGroupOptions?: RadioGroup;
5021
- /** Dropdown component settings. */
4826
+ /** Selection field as drop down */
5022
4827
  dropdownOptions?: Dropdown;
5023
- /** Date and time input component settings. */
4828
+ /** Field for selecting date and time */
5024
4829
  dateTimeOptions?: DateTimeInput;
5025
- /** Phone input component settings. */
4830
+ /** Phone input field */
5026
4831
  phoneInputOptions?: PhoneInput;
5027
- /** Date input component settings. */
4832
+ /** Dropdown based component for selecting date */
5028
4833
  dateInputOptions?: DateInput;
5029
- /** Time input component settings. */
4834
+ /** Field for selecting time */
5030
4835
  timeInputOptions?: TimeInput;
5031
- /** Date picker component settings. */
4836
+ /** Calendar type component for selecting date */
5032
4837
  datePickerOptions?: DatePicker;
5033
- /** Services dropdown component settings. */
4838
+ /** Dropdown for selecting services */
5034
4839
  servicesDropdownOptions?: ServicesDropdown;
5035
- /** Validation configuration for the string input. */
4840
+ /** Validation of field output value. */
5036
4841
  validation?: StringType;
5037
4842
  /**
5038
- * Component type of the string input field.
4843
+ * Component type of the string input field
5039
4844
  * @readonly
5040
4845
  */
5041
4846
  componentType?: StringComponentTypeWithLiterals;
5042
4847
  }
5043
4848
  /** @oneof */
5044
4849
  interface _StringComponentTypeOptionsOneOf {
5045
- /** Text input component settings. */
4850
+ /** Text input field */
5046
4851
  textInputOptions?: TextInput;
5047
- /** Radio group component settings. */
4852
+ /** Selection field as radio group */
5048
4853
  radioGroupOptions?: RadioGroup;
5049
- /** Dropdown component settings. */
4854
+ /** Selection field as drop down */
5050
4855
  dropdownOptions?: Dropdown;
5051
- /** Date and time input component settings. */
4856
+ /** Field for selecting date and time */
5052
4857
  dateTimeOptions?: DateTimeInput;
5053
- /** Phone input component settings. */
4858
+ /** Phone input field */
5054
4859
  phoneInputOptions?: PhoneInput;
5055
- /** Date input component settings. */
4860
+ /** Dropdown based component for selecting date */
5056
4861
  dateInputOptions?: DateInput;
5057
- /** Time input component settings. */
4862
+ /** Field for selecting time */
5058
4863
  timeInputOptions?: TimeInput;
5059
- /** Date picker component settings. */
4864
+ /** Calendar type component for selecting date */
5060
4865
  datePickerOptions?: DatePicker;
5061
- /** Services dropdown component settings. */
4866
+ /** Dropdown for selecting services */
5062
4867
  servicesDropdownOptions?: ServicesDropdown;
5063
4868
  }
5064
4869
  interface _Number extends _NumberComponentTypeOptionsOneOf {
5065
- /** Number input settings. */
4870
+ /** Number value input field */
5066
4871
  numberInputOptions?: NumberInput;
5067
- /** Rating input settings. */
4872
+ /** Rating value input field */
5068
4873
  ratingInputOptions?: RatingInput;
5069
- /** Validation configuration for the number input. */
4874
+ /** Validation of field output value. */
5070
4875
  validation?: NumberType;
5071
4876
  /**
5072
- * Component type of the number input field.
4877
+ * Component type of the number input field
5073
4878
  * @readonly
5074
4879
  */
5075
4880
  componentType?: NumberComponentTypeWithLiterals;
5076
4881
  }
5077
4882
  /** @oneof */
5078
4883
  interface _NumberComponentTypeOptionsOneOf {
5079
- /** Number input settings. */
4884
+ /** Number value input field */
5080
4885
  numberInputOptions?: NumberInput;
5081
- /** Rating input settings. */
4886
+ /** Rating value input field */
5082
4887
  ratingInputOptions?: RatingInput;
5083
4888
  }
5084
4889
  interface _Boolean extends _BooleanComponentTypeOptionsOneOf {
5085
- /** Checkbox component settings. */
4890
+ /** Checkbox input field */
5086
4891
  checkboxOptions?: Checkbox;
5087
- /** Validation configuration for the boolean input. */
4892
+ /** Validation of field output value. */
5088
4893
  validation?: BooleanType;
5089
4894
  /**
5090
- * Component type of the boolean input field.
4895
+ * Component type of the boolean input field
5091
4896
  * @readonly
5092
4897
  */
5093
4898
  componentType?: BooleanComponentTypeWithLiterals;
5094
4899
  }
5095
4900
  /** @oneof */
5096
4901
  interface _BooleanComponentTypeOptionsOneOf {
5097
- /** Checkbox component settings. */
4902
+ /** Checkbox input field */
5098
4903
  checkboxOptions?: Checkbox;
5099
4904
  }
5100
4905
  interface _Array extends _ArrayComponentTypeOptionsOneOf {
5101
- /** Checkbox group component settings. */
4906
+ /** Checkbox group input field */
5102
4907
  checkboxGroupOptions?: CheckboxGroup;
5103
- /** Tags component settings. */
4908
+ /** Tags input field */
5104
4909
  tagsOptions?: Tags;
5105
4910
  /** Services checkbox group input field */
5106
4911
  servicesCheckboxGroupOptions?: ServicesCheckboxGroup;
5107
- /** Validation configuration for the array input. */
4912
+ /** Validation of array type. */
5108
4913
  validation?: ArrayType;
5109
4914
  /**
5110
- * Component type of the array input field.
4915
+ * Component type of the array input field
5111
4916
  * @readonly
5112
4917
  */
5113
4918
  componentType?: ArrayComponentTypeWithLiterals;
5114
4919
  }
5115
4920
  /** @oneof */
5116
4921
  interface _ArrayComponentTypeOptionsOneOf {
5117
- /** Checkbox group component settings. */
4922
+ /** Checkbox group input field */
5118
4923
  checkboxGroupOptions?: CheckboxGroup;
5119
- /** Tags component settings. */
4924
+ /** Tags input field */
5120
4925
  tagsOptions?: Tags;
5121
4926
  /** Services checkbox group input field */
5122
4927
  servicesCheckboxGroupOptions?: ServicesCheckboxGroup;
5123
4928
  }
5124
4929
  interface _Object {
5125
- /** Validation configuration for the object input. */
4930
+ /** Validation of object type. */
5126
4931
  validation?: ObjectType;
5127
4932
  }
5128
4933
  interface WixFile extends WixFileComponentTypeOptionsOneOf {
5129
- /** File upload component settings. */
4934
+ /** File upload input field */
5130
4935
  fileUploadOptions?: FileUpload;
5131
- /** Signature component settings. */
4936
+ /** Signature input field */
5132
4937
  signatureOptions?: Signature;
5133
4938
  /**
5134
- * Component type of the file input field.
4939
+ * Component type of the array input field
5135
4940
  * @readonly
5136
4941
  */
5137
4942
  componentType?: WixFileComponentTypeWithLiterals;
5138
- /** Validation configuration for the file input. */
4943
+ /** Validation of field type. */
5139
4944
  validation?: FileType;
5140
4945
  }
5141
4946
  /** @oneof */
5142
4947
  interface WixFileComponentTypeOptionsOneOf {
5143
- /** File upload component settings. */
4948
+ /** File upload input field */
5144
4949
  fileUploadOptions?: FileUpload;
5145
- /** Signature component settings. */
4950
+ /** Signature input field */
5146
4951
  signatureOptions?: Signature;
5147
4952
  }
5148
4953
  interface Payment extends PaymentComponentTypeOptionsOneOf {
5149
- /** Checkbox group component settings. */
4954
+ /** Checkbox group input field. */
5150
4955
  checkboxGroupOptions?: ProductCheckboxGroup;
5151
- /** Donation input component settings. */
4956
+ /** Donation input field. */
5152
4957
  donationInputOptions?: DonationInput;
5153
- /** Payment input component settings. */
4958
+ /** Payment input field. */
5154
4959
  paymentInputOptions?: PaymentInput;
5155
- /** Fixed payment component settings. */
4960
+ /** Fixed payment field. */
5156
4961
  fixedPaymentOptions?: FixedPayment;
5157
4962
  /**
5158
4963
  * Component type of the payment input field.
5159
4964
  * @readonly
5160
4965
  */
5161
4966
  componentType?: PaymentComponentTypeWithLiterals;
5162
- /** Validation configuration for the payment input. */
4967
+ /** Validation of payment type. */
5163
4968
  validation?: PaymentType;
5164
4969
  }
5165
4970
  /** @oneof */
5166
4971
  interface PaymentComponentTypeOptionsOneOf {
5167
- /** Checkbox group component settings. */
4972
+ /** Checkbox group input field. */
5168
4973
  checkboxGroupOptions?: ProductCheckboxGroup;
5169
- /** Donation input component settings. */
4974
+ /** Donation input field. */
5170
4975
  donationInputOptions?: DonationInput;
5171
- /** Payment input component settings. */
4976
+ /** Payment input field. */
5172
4977
  paymentInputOptions?: PaymentInput;
5173
- /** Fixed payment component settings. */
4978
+ /** Fixed payment field. */
5174
4979
  fixedPaymentOptions?: FixedPayment;
5175
4980
  }
5176
4981
  interface Scheduling extends SchedulingComponentTypeOptionsOneOf {
5177
- /** Appointment component settings. */
4982
+ /** Appointment input field */
5178
4983
  appointmentOptions?: Appointment;
5179
4984
  /**
5180
- * Component type of the scheduling field.
4985
+ * Component type of the scheduling input field
5181
4986
  * @readonly
5182
4987
  */
5183
4988
  componentType?: SchedulingComponentTypeWithLiterals;
5184
4989
  }
5185
4990
  /** @oneof */
5186
4991
  interface SchedulingComponentTypeOptionsOneOf {
5187
- /** Appointment component settings. */
4992
+ /** Appointment input field */
5188
4993
  appointmentOptions?: Appointment;
5189
4994
  }
5190
4995
  interface Address extends AddressComponentTypeOptionsOneOf {
5191
- /** Multiline address component settings. */
4996
+ /** Multiline address input field. */
5192
4997
  multilineAddressOptions?: MultilineAddress;
5193
4998
  /**
5194
4999
  * Component type of the multiline address field.
5195
5000
  * @readonly
5196
5001
  */
5197
5002
  componentType?: ComponentTypeWithLiterals;
5198
- /** Validation configuration for the multiline address input. */
5003
+ /** Validation of multiline address field output value. */
5199
5004
  validation?: MultilineAddressValidation;
5200
5005
  }
5201
5006
  /** @oneof */
5202
5007
  interface AddressComponentTypeOptionsOneOf {
5203
- /** Multiline address component settings. */
5008
+ /** Multiline address input field. */
5204
5009
  multilineAddressOptions?: MultilineAddress;
5205
5010
  }
5206
5011
  interface FieldsDisplayField extends FieldsDisplayFieldDisplayFieldTypeOptionsOneOf {
5207
- /** Configuration for rich content display fields. */
5012
+ /** Component displaying rich content */
5208
5013
  richContentOptions?: RichContentOptions;
5209
- /** Configuration for page navigation display fields such as navigation or submit buttons. */
5014
+ /** Page navigation component resolving as navigation or submit buttons */
5210
5015
  pageNavigationOptions?: PageNavigationOptions;
5211
- /** Type of display field that determines its appearance and behavior. */
5016
+ /** Type of the display field */
5212
5017
  displayFieldType?: DisplayFieldDisplayFieldTypeWithLiterals;
5213
5018
  }
5214
5019
  /** @oneof */
5215
5020
  interface FieldsDisplayFieldDisplayFieldTypeOptionsOneOf {
5216
- /** Configuration for rich content display fields. */
5021
+ /** Component displaying rich content */
5217
5022
  richContentOptions?: RichContentOptions;
5218
- /** Configuration for page navigation display fields such as navigation or submit buttons. */
5023
+ /** Page navigation component resolving as navigation or submit buttons */
5219
5024
  pageNavigationOptions?: PageNavigationOptions;
5220
5025
  }
5221
5026
  declare enum DisplayFieldDisplayFieldType {
5222
- /** Unknown field type. */
5223
5027
  UNKNOWN_FIELD_TYPE = "UNKNOWN_FIELD_TYPE",
5224
- /** Rich content display field. */
5225
5028
  RICH_CONTENT = "RICH_CONTENT",
5226
- /** Page navigation display field. */
5227
5029
  PAGE_NAVIGATION = "PAGE_NAVIGATION",
5228
- /** Login bar display field. */
5229
5030
  LOGIN_BAR = "LOGIN_BAR"
5230
5031
  }
5231
5032
  /** @enumType */
5232
5033
  type DisplayFieldDisplayFieldTypeWithLiterals = DisplayFieldDisplayFieldType | 'UNKNOWN_FIELD_TYPE' | 'RICH_CONTENT' | 'PAGE_NAVIGATION' | 'LOGIN_BAR';
5233
5034
  interface RichContentOptions {
5234
- /** Rich content to display in the field. */
5035
+ /** Content of the header */
5235
5036
  richContent?: RichContent;
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
- */
5037
+ /** Number of paragraphs visible. Other part is hidden under expandable section. If not provided all text visible. */
5240
5038
  maxShownParagraphs?: number | null;
5241
5039
  }
5242
5040
  interface PageNavigationOptions {
5243
5041
  /**
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.
5042
+ * When button is not on last page it behaves as switch between pages page, text of label to go to next page.
5246
5043
  * @maxLength 65
5247
5044
  */
5248
5045
  nextPageText?: string | null;
5249
5046
  /**
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.
5047
+ * When button is not on last page it behaves as switch between pages page, text of label to go to previous page.
5252
5048
  * @maxLength 65
5253
5049
  */
5254
5050
  previousPageText?: string | null;
5255
5051
  /**
5256
- * Text displayed on the button when it submits the form.
5257
- * Only applicable when the button is on the final form page.
5052
+ * Text on the button when button is submitting a form
5258
5053
  * @maxLength 65
5259
5054
  */
5260
5055
  submitText?: string | null;
@@ -5271,93 +5066,95 @@ interface Step {
5271
5066
  * @maxLength 200
5272
5067
  */
5273
5068
  name?: string | null;
5274
- /** Whether the step is hidden. */
5069
+ /** Is step hidden */
5275
5070
  hidden?: boolean;
5276
- /** Layout configuration that defines how form fields are arranged within this step. */
5071
+ /** Form step properties */
5277
5072
  layout?: FormLayout;
5278
5073
  }
5279
5074
  interface FormLayout {
5280
- /** Layout configuration for large screen breakpoints (desktop). */
5075
+ /** Layout for large break point. */
5281
5076
  large?: BreakPoint;
5282
- /** Layout configuration for medium screen breakpoints (tablet). */
5077
+ /** Layout for medium break point. */
5283
5078
  medium?: BreakPoint;
5284
- /** Layout configuration for small screen breakpoints (mobile). */
5079
+ /** Layout for small break point. */
5285
5080
  small?: BreakPoint;
5286
5081
  }
5287
5082
  interface BreakPoint {
5288
5083
  /**
5289
- * Configuration for the layout of items in the breakpoint.
5084
+ * Description of layouts for items.
5290
5085
  * @maxSize 500
5291
5086
  */
5292
5087
  items?: ItemLayout[];
5293
- /** Number of columns in the layout grid. */
5088
+ /** Amount of columns of layout grid. */
5294
5089
  columns?: number | null;
5295
- /** Height of each row in the layout grid, measured in pixels. */
5090
+ /** Row height of layout grid. */
5296
5091
  rowHeight?: number | null;
5297
- /** Margin spacing configuration for the form elements. */
5092
+ /** Description of elements margins. */
5298
5093
  margin?: Margin;
5299
- /** Padding spacing inside form elements in pixels. */
5094
+ /** Description of elements paddings. */
5300
5095
  padding?: Margin;
5301
5096
  }
5302
5097
  interface ItemLayout extends ItemLayoutItemOneOf {
5303
5098
  /**
5304
- * ID of the form field to be positioned in the layout.
5099
+ * Form field reference id.
5305
5100
  * @format GUID
5306
5101
  */
5307
5102
  fieldId?: string;
5308
- /** Group configuration for positioning multiple fields as a single layout unit. */
5103
+ /** Group info, defining that this item is a group of multiple fields */
5309
5104
  group?: Group;
5310
- /** Row position in the grid where this item is placed. */
5105
+ /** Horizontal coordinate in the grid. */
5311
5106
  row?: number | null;
5312
- /** Column position in the grid where this item is placed. */
5107
+ /** Vertical coordinate in the grid. */
5313
5108
  column?: number | null;
5314
- /** Width of the item in grid units. */
5109
+ /** Height. */
5315
5110
  width?: number | null;
5316
- /** Height of the item in grid units. */
5111
+ /** Width. */
5317
5112
  height?: number | null;
5318
5113
  }
5319
5114
  /** @oneof */
5320
5115
  interface ItemLayoutItemOneOf {
5321
5116
  /**
5322
- * ID of the form field to be positioned in the layout.
5117
+ * Form field reference id.
5323
5118
  * @format GUID
5324
5119
  */
5325
5120
  fieldId?: string;
5326
- /** Group configuration for positioning multiple fields as a single layout unit. */
5121
+ /** Group info, defining that this item is a group of multiple fields */
5327
5122
  group?: Group;
5328
5123
  }
5329
5124
  interface Group {
5330
5125
  /**
5331
- * ID of the field group.
5126
+ * Field group reference id.
5332
5127
  * @format GUID
5333
5128
  */
5334
5129
  groupId?: string;
5335
5130
  /**
5336
- * Layout configuration for individual items within this group.
5131
+ * Description of layouts for items.
5337
5132
  * @minSize 1
5338
5133
  * @maxSize 500
5339
5134
  */
5340
5135
  items?: ItemLayout[];
5341
5136
  }
5342
5137
  interface Margin {
5343
- /** Horizontal spacing in pixels. */
5138
+ /** Horizontal value. */
5344
5139
  horizontal?: number | null;
5345
- /** Vertical spacing in pixels. */
5140
+ /** Vertical value. */
5346
5141
  vertical?: number | null;
5347
5142
  }
5348
5143
  interface Section {
5349
5144
  /**
5350
- * Section ID.
5145
+ * Id of the section
5351
5146
  * @format GUID
5352
5147
  * @minLength 1
5353
5148
  */
5354
5149
  _id?: string;
5355
- /** Row position where this section is placed in the grid. */
5150
+ /** Horizontal coordinate in the grid. */
5356
5151
  row?: number | null;
5357
5152
  /**
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.
5153
+ * A list of field identifiers that are permitted to be placed within a section.
5154
+ * The section will only accept fields with IDs specified in this list.
5155
+ * If the section encounters the $new key within the list,
5156
+ * it allows the inclusion of fields not explicitly listed,
5157
+ * enabling dynamic addition of new fields.
5361
5158
  * @maxSize 100
5362
5159
  * @maxLength 100
5363
5160
  */
@@ -5365,49 +5162,44 @@ interface Section {
5365
5162
  }
5366
5163
  interface FormRule {
5367
5164
  /**
5368
- * Rule ID.
5165
+ * Id of the rule
5369
5166
  * @format GUID
5370
5167
  * @immutable
5371
5168
  */
5372
5169
  _id?: string;
5373
- /** Condition that determines when this rule's overrides should be applied. */
5170
+ /** Rule on which item properties or layouts will be changed. */
5374
5171
  condition?: Record<string, any> | null;
5375
5172
  /**
5376
- * Changes to apply to form elements when the condition evaluates to true.
5173
+ * Form items with defined properties that will be
5174
+ * changed when given condition is resolved to true.
5377
5175
  * @maxSize 500
5378
5176
  */
5379
5177
  overrides?: FormOverride[];
5380
5178
  /**
5381
- * Name for the rule.
5179
+ * Name of the rule
5382
5180
  * @maxLength 200
5383
5181
  */
5384
5182
  name?: string | null;
5385
5183
  }
5386
5184
  declare enum OverrideEntityType {
5387
- /** Unknown override entity type. */
5388
5185
  UNKNOWN = "UNKNOWN",
5389
- /** Override applies to a form field. */
5390
5186
  FIELD = "FIELD"
5391
5187
  }
5392
5188
  /** @enumType */
5393
5189
  type OverrideEntityTypeWithLiterals = OverrideEntityType | 'UNKNOWN' | 'FIELD';
5394
5190
  interface FormOverride {
5395
5191
  /**
5396
- * Type of form element that this override targets.
5192
+ * Override entity type.
5397
5193
  * @immutable
5398
5194
  */
5399
5195
  entityType?: OverrideEntityTypeWithLiterals;
5400
5196
  /**
5401
- * ID of the form element to modify.
5402
- * For nested form fields, use the format: "{fieldIdWithNestedForm}/{nestedFormFieldId}".
5197
+ * Overridden entity id. Either fieldId, or "{fieldIdWithNestedForm}/{nestedFormFieldId}"
5403
5198
  * @immutable
5404
5199
  * @maxLength 73
5405
5200
  */
5406
5201
  entityId?: string | null;
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
- */
5202
+ /** Form entity properties path with new value, that will be changed on condition. */
5411
5203
  valueChanges?: Record<string, any>;
5412
5204
  }
5413
5205
  interface FormProperties {
@@ -5436,21 +5228,19 @@ declare enum Kind {
5436
5228
  /** @enumType */
5437
5229
  type KindWithLiterals = Kind | 'REGULAR' | 'EXTENSION';
5438
5230
  interface PostSubmissionTriggers {
5439
- /** Upserts a [contact](https://support.wix.com/en/article/about-your-contact-list) to the Wix site from the form submission data. */
5231
+ /** Upserts a contact from the submission data. */
5440
5232
  upsertContact?: UpsertContact;
5441
5233
  }
5442
5234
  interface UpsertContact {
5443
5235
  /**
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.
5236
+ * Fields mapping (target field mapped to corresponding contact field).
5449
5237
  * @maxSize 250
5450
5238
  */
5451
5239
  fieldsMapping?: Record<string, V4FormFieldContactInfo>;
5452
5240
  /**
5453
- * List of [labels](https://support.wix.com/en/article/creating-contact-labels) to add to the contact to help categorize it.
5241
+ * List of contact label keys.
5242
+ * [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
5243
+ * help categorize contacts.
5454
5244
  * @minLength 1
5455
5245
  * @maxLength 100
5456
5246
  * @maxSize 20
@@ -5476,29 +5266,29 @@ interface LimitationRule {
5476
5266
  declare enum SpamFilterProtectionLevel {
5477
5267
  /** Unknown spam filter protection level. */
5478
5268
  UNKNOWN = "UNKNOWN",
5479
- /** No spam filtering. All submissions are accepted without screening. */
5269
+ /** Spam filter is not used. Form is open for spam submissions. */
5480
5270
  NONE = "NONE",
5481
- /** Basic spam filtering. Provides minimal protection against obvious spam and the form is open to a high risk of spam submissions. */
5271
+ /** Spam filter operates in basic mode. Form is open to high risk of spam submissions. */
5482
5272
  BASIC = "BASIC",
5483
- /** Advanced spam filtering. Provides comprehensive protection with intelligent screening and the form is open to a low risk of spam submissions. */
5273
+ /** Spam filter operates in advanced mode. Form is open to low risk of spam submissions. */
5484
5274
  ADVANCED = "ADVANCED"
5485
5275
  }
5486
5276
  /** @enumType */
5487
5277
  type SpamFilterProtectionLevelWithLiterals = SpamFilterProtectionLevel | 'UNKNOWN' | 'NONE' | 'BASIC' | 'ADVANCED';
5488
5278
  interface RequiredIndicatorProperties {
5489
- /** Type of visual indicator used to mark required fields. */
5279
+ /** Required indicator. */
5490
5280
  requiredIndicator?: RequiredIndicatorWithLiterals;
5491
- /** Position where the required indicator appears relative to the field title. */
5281
+ /** Required indicator placement. */
5492
5282
  requiredIndicatorPlacement?: RequiredIndicatorPlacementWithLiterals;
5493
5283
  }
5494
5284
  declare enum RequiredIndicator {
5495
- /** Unknown required indicator type. */
5285
+ /** Unknown required indicator. */
5496
5286
  UNKNOWN_INDICATOR = "UNKNOWN_INDICATOR",
5497
- /** Display an asterisk (*) symbol to indicate required fields. */
5287
+ /** Asterisk (*). */
5498
5288
  ASTERISK = "ASTERISK",
5499
- /** Display the text "Required" to indicate required fields. */
5289
+ /** Text (default: "Required"). */
5500
5290
  TEXT = "TEXT",
5501
- /** No visual indicator is shown for required fields. */
5291
+ /** None. */
5502
5292
  NONE = "NONE"
5503
5293
  }
5504
5294
  /** @enumType */
@@ -5506,34 +5296,34 @@ type RequiredIndicatorWithLiterals = RequiredIndicator | 'UNKNOWN_INDICATOR' | '
5506
5296
  declare enum RequiredIndicatorPlacement {
5507
5297
  /** Unknown required indicator placement. */
5508
5298
  UNKNOWN_PLACEMENT = "UNKNOWN_PLACEMENT",
5509
- /** Place the required indicator after the field title. */
5299
+ /** After field title. */
5510
5300
  AFTER_FIELD_TITLE = "AFTER_FIELD_TITLE",
5511
- /** Place the required indicator before the field title. */
5301
+ /** Before field title. */
5512
5302
  BEFORE_FIELD_TITLE = "BEFORE_FIELD_TITLE"
5513
5303
  }
5514
5304
  /** @enumType */
5515
5305
  type RequiredIndicatorPlacementWithLiterals = RequiredIndicatorPlacement | 'UNKNOWN_PLACEMENT' | 'AFTER_FIELD_TITLE' | 'BEFORE_FIELD_TITLE';
5516
5306
  interface SubmitSettings extends SubmitSettingsSubmitSuccessActionOptionsOneOf {
5517
- /** Configuration for displaying a thank you message after submission. */
5307
+ /** Options for showing a thank you message after submission. */
5518
5308
  thankYouMessageOptions?: ThankYouMessageOptions;
5519
- /** Configuration for redirecting submitters to a URL after submission. */
5309
+ /** Options for redirecting to a URL after submission. */
5520
5310
  redirectOptions?: RedirectOptions;
5521
- /** Action that's triggered after a form is successfully submitted. */
5311
+ /** Action that is triggered after a successful form submission. */
5522
5312
  submitSuccessAction?: SubmitSuccessActionWithLiterals;
5523
5313
  }
5524
5314
  /** @oneof */
5525
5315
  interface SubmitSettingsSubmitSuccessActionOptionsOneOf {
5526
- /** Configuration for displaying a thank you message after submission. */
5316
+ /** Options for showing a thank you message after submission. */
5527
5317
  thankYouMessageOptions?: ThankYouMessageOptions;
5528
- /** Configuration for redirecting submitters to a URL after submission. */
5318
+ /** Options for redirecting to a URL after submission. */
5529
5319
  redirectOptions?: RedirectOptions;
5530
5320
  }
5531
5321
  declare enum Target {
5532
- /** Unknown target behavior. */
5322
+ /** Unknown target. */
5533
5323
  UNKNOWN_TARGET = "UNKNOWN_TARGET",
5534
- /** Open the URL in the same browser tab, replacing the current page. */
5324
+ /** Open in the same browser tab. */
5535
5325
  SELF = "SELF",
5536
- /** Open the URL in a new browser tab. */
5326
+ /** Open in a new browser tab. */
5537
5327
  BLANK = "BLANK"
5538
5328
  }
5539
5329
  /** @enumType */
@@ -5541,31 +5331,28 @@ type TargetWithLiterals = Target | 'UNKNOWN_TARGET' | 'SELF' | 'BLANK';
5541
5331
  declare enum SubmitSuccessAction {
5542
5332
  /** Unknown submit success action. */
5543
5333
  UNKNOWN_SUBMIT_SUCCESS_ACTION = "UNKNOWN_SUBMIT_SUCCESS_ACTION",
5544
- /** No action is taken after form submission. */
5334
+ /** No action will be taken after submission. */
5545
5335
  NO_ACTION = "NO_ACTION",
5546
- /** Display a thank you message after form submission. */
5336
+ /** A thank you message will be shown after submission. */
5547
5337
  THANK_YOU_MESSAGE = "THANK_YOU_MESSAGE",
5548
- /** Redirect the user to a specified URL after form submission. */
5338
+ /** The user will be redirected to a URL after submission. */
5549
5339
  REDIRECT = "REDIRECT"
5550
5340
  }
5551
5341
  /** @enumType */
5552
5342
  type SubmitSuccessActionWithLiterals = SubmitSuccessAction | 'UNKNOWN_SUBMIT_SUCCESS_ACTION' | 'NO_ACTION' | 'THANK_YOU_MESSAGE' | 'REDIRECT';
5553
5343
  interface ThankYouMessageOptions {
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
- */
5344
+ /** Duration in seconds after which the message should disappear. If 0, the message will stay forever. */
5558
5345
  durationInSeconds?: number | null;
5559
- /** Rich content message displayed to users after successful form submission. */
5346
+ /** The message shown after form submission. */
5560
5347
  richContent?: RichContent;
5561
5348
  }
5562
5349
  interface RedirectOptions {
5563
5350
  /**
5564
- * URL to which the user should be redirected after successfully submitting the form.
5351
+ * The URL to which the user should be redirected after a successful form submission.
5565
5352
  * @maxLength 2000
5566
5353
  */
5567
5354
  redirectUrl?: string | null;
5568
- /** How the redirect URL should be opened in the browser. */
5355
+ /** How the URL should be opened. */
5569
5356
  target?: TargetWithLiterals;
5570
5357
  }
5571
5358
  interface FieldGroup {
@@ -5582,29 +5369,26 @@ interface FieldGroup {
5582
5369
  }
5583
5370
  interface Rule {
5584
5371
  /**
5585
- * Rule ID.
5372
+ * Id of the rule
5586
5373
  * @format GUID
5587
5374
  * @immutable
5588
5375
  */
5589
5376
  _id?: string;
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
- */
5377
+ /** Rule on which item properties or layouts will be changed. */
5594
5378
  expression?: ConditionNode;
5595
5379
  /**
5596
- * Form modifications that are applied when the rule expression evaluates to true.
5597
- * Each override specifies how a form element should be changed.
5380
+ * Form items with defined properties that will be
5381
+ * changed when given condition is resolved to true.
5598
5382
  * @maxSize 500
5599
5383
  */
5600
5384
  overrides?: RuleFormOverride[];
5601
5385
  /**
5602
- * Human-readable name for the rule.
5386
+ * Name of the rule
5603
5387
  * @maxLength 200
5604
5388
  */
5605
5389
  name?: string | null;
5606
5390
  }
5607
- /** Enum for different types of field properties that can be modified by rules. */
5391
+ /** Enum for different types of changeable properties. */
5608
5392
  declare enum ChangeableProperty {
5609
5393
  /** Unknown property type. */
5610
5394
  UNKNOWN_CHANGEABLE_PROPERTY = "UNKNOWN_CHANGEABLE_PROPERTY",
@@ -5618,75 +5402,72 @@ declare enum ChangeableProperty {
5618
5402
  /** @enumType */
5619
5403
  type ChangeablePropertyWithLiterals = ChangeableProperty | 'UNKNOWN_CHANGEABLE_PROPERTY' | 'REQUIRED' | 'HIDDEN' | 'ALLOWED_VALUES';
5620
5404
  interface RequiredOptions {
5621
- /** Whether the field should be required. */
5405
+ /** Value of required property */
5622
5406
  required?: boolean;
5623
5407
  }
5624
5408
  interface HiddenOptions {
5625
- /** Whether the field should be hidden. */
5409
+ /** Value of hidden property */
5626
5410
  hidden?: boolean;
5627
5411
  }
5628
5412
  interface AllowedValuesOptions {
5629
5413
  /**
5630
- * List of values that are allowed for the field when this rule is active.
5631
- * Restricts user input to only these predefined options.
5414
+ * Allowed values
5632
5415
  * @maxSize 300
5633
5416
  * @maxLength 200
5634
5417
  */
5635
5418
  allowedValues?: string[];
5636
5419
  }
5637
5420
  declare enum OverrideEntityTypeEnumOverrideEntityType {
5638
- /** Unknown override entity type. */
5639
5421
  UNKNOWN_OVERRIDE_ENTITY_TYPE = "UNKNOWN_OVERRIDE_ENTITY_TYPE",
5640
- /** Override applies to a form field. */
5641
5422
  FIELD = "FIELD"
5642
5423
  }
5643
5424
  /** @enumType */
5644
5425
  type OverrideEntityTypeEnumOverrideEntityTypeWithLiterals = OverrideEntityTypeEnumOverrideEntityType | 'UNKNOWN_OVERRIDE_ENTITY_TYPE' | 'FIELD';
5645
5426
  interface FieldOverride extends FieldOverridePropertyTypeOptionsOneOf {
5646
- /** Configuration for changing the required property of a field. */
5427
+ /** Required property overrides */
5647
5428
  requiredOptions?: RequiredOptions;
5648
- /** Configuration for changing the visibility property of a field. */
5429
+ /** Hidden property overrides */
5649
5430
  hiddenOptions?: HiddenOptions;
5650
- /** Configuration for changing the allowed values of a field. */
5431
+ /** Allowed values property overrides */
5651
5432
  allowedValuesOptions?: AllowedValuesOptions;
5652
5433
  /**
5653
- * ID of the field to be modified by this override.
5434
+ * Overridden entity id
5654
5435
  * @immutable
5655
5436
  * @format GUID
5656
5437
  */
5657
5438
  fieldId?: string;
5658
- /** The new value for the field property that will be set when the rule conditions are met. */
5439
+ /** Form entity properties path with new value, that will be changed on condition. */
5659
5440
  propertyType?: ChangeablePropertyWithLiterals;
5660
5441
  }
5661
5442
  /** @oneof */
5662
5443
  interface FieldOverridePropertyTypeOptionsOneOf {
5663
- /** Configuration for changing the required property of a field. */
5444
+ /** Required property overrides */
5664
5445
  requiredOptions?: RequiredOptions;
5665
- /** Configuration for changing the visibility property of a field. */
5446
+ /** Hidden property overrides */
5666
5447
  hiddenOptions?: HiddenOptions;
5667
- /** Configuration for changing the allowed values of a field. */
5448
+ /** Allowed values property overrides */
5668
5449
  allowedValuesOptions?: AllowedValuesOptions;
5669
5450
  }
5670
5451
  interface ConditionNode extends ConditionNodeNodeOneOf {
5671
- /** Logical AND condition with 1 or more child conditions. All child conditions must be true. */
5452
+ /** A compound condition that requires all conditions to be true. */
5672
5453
  and?: AndCondition;
5673
- /** Logical OR condition with 1 or more child conditions. At least 1 child condition must be true. */
5454
+ /** A compound condition that requires at least one condition to be true. */
5674
5455
  or?: OrCondition;
5675
- /** Single condition to evaluate. */
5456
+ /** A single condition in the rule. */
5676
5457
  condition?: Condition;
5677
5458
  }
5678
5459
  /** @oneof */
5679
5460
  interface ConditionNodeNodeOneOf {
5680
- /** Logical AND condition with 1 or more child conditions. All child conditions must be true. */
5461
+ /** A compound condition that requires all conditions to be true. */
5681
5462
  and?: AndCondition;
5682
- /** Logical OR condition with 1 or more child conditions. At least 1 child condition must be true. */
5463
+ /** A compound condition that requires at least one condition to be true. */
5683
5464
  or?: OrCondition;
5684
- /** Single condition to evaluate. */
5465
+ /** A single condition in the rule. */
5685
5466
  condition?: Condition;
5686
5467
  }
5687
5468
  interface AndCondition {
5688
5469
  /**
5689
- * List of conditions that must all evaluate to true.
5470
+ * The list of conditions that must all be true.
5690
5471
  * @minSize 1
5691
5472
  * @maxSize 100
5692
5473
  */
@@ -5694,7 +5475,7 @@ interface AndCondition {
5694
5475
  }
5695
5476
  interface OrCondition {
5696
5477
  /**
5697
- * List of conditions where at least 1 must evaluate to true.
5478
+ * The list of conditions where at least one must be true.
5698
5479
  * @minSize 1
5699
5480
  * @maxSize 100
5700
5481
  */
@@ -5702,85 +5483,58 @@ interface OrCondition {
5702
5483
  }
5703
5484
  interface Condition {
5704
5485
  /**
5705
- * Human readable identifier used to reference a field.
5706
- * Supports dot notation for nested properties. For example, `"address.city"`.
5486
+ * The property name to be evaluated, supports dot notation for nested properties.
5707
5487
  * @maxLength 100
5708
5488
  */
5709
5489
  target?: string;
5710
- /** Comparison operator to use for evaluating the condition. */
5490
+ /** The operator to use for comparison. */
5711
5491
  operator?: OperatorWithLiterals;
5712
- /** Value to compare against the value in the target field. */
5492
+ /** The value to compare against. */
5713
5493
  value?: any;
5714
5494
  }
5715
5495
  declare enum Operator {
5716
5496
  UNKNOWN_OPERATOR = "UNKNOWN_OPERATOR",
5717
- /** Specified value equals the value in the target field. */
5718
5497
  EQUAL = "EQUAL",
5719
- /** Specified value doesn't equal the value in the target field. */
5720
5498
  NOT_EQUAL = "NOT_EQUAL",
5721
- /** Target field is empty or has no value. */
5722
5499
  EMPTY = "EMPTY",
5723
- /** Target field isn't empty and has a value. */
5724
5500
  NOT_EMPTY = "NOT_EMPTY",
5725
- /** String value in the target field contains the specified substring. */
5726
5501
  CONTAINS = "CONTAINS",
5727
- /** String value in the target field doesn't contain the specified substring. */
5728
5502
  NOT_CONTAINS = "NOT_CONTAINS",
5729
- /** Numeric value in the target field is less than the specified value. */
5730
5503
  LESS_THAN = "LESS_THAN",
5731
- /** Numeric value in the target field is less than or equal to the specified value. */
5732
5504
  LESS_THAN_OR_EQUALS = "LESS_THAN_OR_EQUALS",
5733
- /** Numeric value in the target field is greater than the specified value. */
5734
5505
  GREATER_THAN = "GREATER_THAN",
5735
- /** Numeric value in the target field is greater than or equal to the specified value. */
5736
5506
  GREATER_THAN_OR_EQUALS = "GREATER_THAN_OR_EQUALS",
5737
- /** Date value in the target field is before the specified date. */
5738
5507
  BEFORE = "BEFORE",
5739
- /** Date value in the target field is before or equal to the specified date. */
5740
5508
  BEFORE_OR_EQUAL = "BEFORE_OR_EQUAL",
5741
- /** Date value in the target field is after the specified date. */
5742
5509
  AFTER = "AFTER",
5743
- /** Date value in the target field is after or equal to the specified date. */
5744
5510
  AFTER_OR_EQUAL = "AFTER_OR_EQUAL",
5745
- /** Value in the target field falls within the specified range. */
5746
5511
  BETWEEN = "BETWEEN",
5747
- /** Value in the target field matches any of the specified values. */
5748
5512
  ANY = "ANY",
5749
- /** Array value in the target field exactly equals the specified array. */
5750
5513
  ARRAY_EQUAL = "ARRAY_EQUAL",
5751
- /** Array value in the target field doesn't equal the specified array. */
5752
5514
  ARRAY_NOT_EQUAL = "ARRAY_NOT_EQUAL",
5753
- /** Checkbox or boolean field value in the target field is checked. */
5754
5515
  CHECKED = "CHECKED",
5755
- /** Checkbox or boolean field value in the target field isn't checked. */
5756
5516
  NOT_CHECKED = "NOT_CHECKED",
5757
- /** Value in the target field is included in the specified list. */
5758
5517
  IN = "IN",
5759
- /** Value in the target field isn't included in the specified list. */
5760
5518
  NOT_IN = "NOT_IN",
5761
- /** Date value in the target field is older than the specified time period. */
5762
5519
  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. */
5764
5520
  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. */
5766
5521
  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. */
5768
5522
  IS_DATE_NEWER_THAN_OR_EQUAL = "IS_DATE_NEWER_THAN_OR_EQUAL"
5769
5523
  }
5770
5524
  /** @enumType */
5771
5525
  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';
5772
5526
  interface RuleFormOverride extends RuleFormOverrideEntityTypeOptionsOneOf {
5773
- /** Field override settings. */
5527
+ /** Field override properties. */
5774
5528
  fieldOptions?: FieldOverride;
5775
5529
  /**
5776
- * Type of form element being modified by this override.
5530
+ * Override entity type.
5777
5531
  * @immutable
5778
5532
  */
5779
5533
  entityType?: OverrideEntityTypeEnumOverrideEntityTypeWithLiterals;
5780
5534
  }
5781
5535
  /** @oneof */
5782
5536
  interface RuleFormOverrideEntityTypeOptionsOneOf {
5783
- /** Field override settings. */
5537
+ /** Field override properties. */
5784
5538
  fieldOptions?: FieldOverride;
5785
5539
  }
5786
5540
  interface CreateCheckoutFromSubmissionResponse {