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