@wix/auto_sdk_forms_forms 1.0.4 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/forms-v4-form-forms.types.d.ts +1021 -233
- package/build/cjs/src/forms-v4-form-forms.types.js.map +1 -1
- package/build/cjs/src/forms-v4-form-forms.universal.d.ts +1080 -240
- package/build/cjs/src/forms-v4-form-forms.universal.js +16 -0
- package/build/cjs/src/forms-v4-form-forms.universal.js.map +1 -1
- package/build/es/src/forms-v4-form-forms.types.d.ts +1021 -233
- package/build/es/src/forms-v4-form-forms.types.js.map +1 -1
- package/build/es/src/forms-v4-form-forms.universal.d.ts +1080 -240
- package/build/es/src/forms-v4-form-forms.universal.js +16 -0
- package/build/es/src/forms-v4-form-forms.universal.js.map +1 -1
- package/build/internal/cjs/src/forms-v4-form-forms.types.d.ts +1021 -233
- package/build/internal/cjs/src/forms-v4-form-forms.types.js.map +1 -1
- package/build/internal/cjs/src/forms-v4-form-forms.universal.d.ts +1080 -240
- package/build/internal/cjs/src/forms-v4-form-forms.universal.js +16 -0
- package/build/internal/cjs/src/forms-v4-form-forms.universal.js.map +1 -1
- package/build/internal/es/src/forms-v4-form-forms.types.d.ts +1021 -233
- package/build/internal/es/src/forms-v4-form-forms.types.js.map +1 -1
- package/build/internal/es/src/forms-v4-form-forms.universal.d.ts +1080 -240
- package/build/internal/es/src/forms-v4-form-forms.universal.js +16 -0
- package/build/internal/es/src/forms-v4-form-forms.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,17 +1,25 @@
|
|
|
1
1
|
export interface Form {
|
|
2
2
|
/**
|
|
3
3
|
* Form ID.
|
|
4
|
+
* @format GUID
|
|
4
5
|
* @readonly
|
|
5
6
|
*/
|
|
6
7
|
_id?: string | null;
|
|
7
8
|
/**
|
|
8
9
|
* List of form fields that represent input elements.
|
|
10
|
+
* @maxSize 500
|
|
9
11
|
* @readonly
|
|
10
12
|
*/
|
|
11
13
|
fieldsV2?: FormFieldV2[];
|
|
12
|
-
/**
|
|
14
|
+
/**
|
|
15
|
+
* Defines the layout for form fields in each submission step.
|
|
16
|
+
* @maxSize 100
|
|
17
|
+
*/
|
|
13
18
|
steps?: Step[];
|
|
14
|
-
/**
|
|
19
|
+
/**
|
|
20
|
+
* Form rules, can be applied to layout and items properties.
|
|
21
|
+
* @maxSize 100
|
|
22
|
+
*/
|
|
15
23
|
rules?: FormRule[];
|
|
16
24
|
/**
|
|
17
25
|
* Represents the current state of an item. Each time the item is modified, its `revision` changes. For an update operation to succeed, you MUST pass the latest revision.
|
|
@@ -32,20 +40,28 @@ export interface Form {
|
|
|
32
40
|
properties?: FormProperties;
|
|
33
41
|
/**
|
|
34
42
|
* Fields which were soft deleted.
|
|
43
|
+
* @maxSize 150
|
|
35
44
|
* @readonly
|
|
36
45
|
*/
|
|
37
46
|
deletedFields?: FormField[];
|
|
38
47
|
/**
|
|
39
48
|
* List of form fields that represent input elements.
|
|
49
|
+
* @maxSize 150
|
|
40
50
|
* @readonly
|
|
41
51
|
*/
|
|
42
52
|
deletedFieldsV2?: FormFieldV2[];
|
|
43
53
|
/** Data extensions ExtendedFields. */
|
|
44
54
|
extendedFields?: ExtendedFields;
|
|
45
|
-
/**
|
|
55
|
+
/**
|
|
56
|
+
* Identifies the namespace that the form belongs to.
|
|
57
|
+
* @minLength 10
|
|
58
|
+
* @maxLength 50
|
|
59
|
+
* @immutable
|
|
60
|
+
*/
|
|
46
61
|
namespace?: string;
|
|
47
62
|
/**
|
|
48
63
|
* Media folder ID.
|
|
64
|
+
* @maxLength 100
|
|
49
65
|
* @readonly
|
|
50
66
|
*/
|
|
51
67
|
mediaFolderId?: string | null;
|
|
@@ -60,15 +76,23 @@ export interface Form {
|
|
|
60
76
|
requiredIndicatorProperties?: RequiredIndicatorProperties;
|
|
61
77
|
/** Settings for actions to be taken after form submission. */
|
|
62
78
|
submitSettings?: SubmitSettings;
|
|
63
|
-
/**
|
|
79
|
+
/**
|
|
80
|
+
* Settings for field groups
|
|
81
|
+
* @maxSize 50
|
|
82
|
+
*/
|
|
64
83
|
fieldGroups?: FieldGroup[];
|
|
65
84
|
/** Message shown when the form is disabled */
|
|
66
85
|
disabledFormMessage?: RichContent;
|
|
67
86
|
/**
|
|
68
|
-
* Identifies if the form is
|
|
87
|
+
* Identifies if the form is enabled.
|
|
69
88
|
* Default true
|
|
70
89
|
*/
|
|
71
90
|
enabled?: boolean | null;
|
|
91
|
+
/**
|
|
92
|
+
* Form name.
|
|
93
|
+
* @maxLength 200
|
|
94
|
+
*/
|
|
95
|
+
name?: string | null;
|
|
72
96
|
}
|
|
73
97
|
export declare enum RequiredIndicator {
|
|
74
98
|
/** Unknown required indicator. */
|
|
@@ -89,9 +113,17 @@ export declare enum RequiredIndicatorPlacement {
|
|
|
89
113
|
BEFORE_FIELD_TITLE = "BEFORE_FIELD_TITLE"
|
|
90
114
|
}
|
|
91
115
|
export interface FormField {
|
|
92
|
-
/**
|
|
116
|
+
/**
|
|
117
|
+
* Item ID.
|
|
118
|
+
* @format GUID
|
|
119
|
+
* @immutable
|
|
120
|
+
*/
|
|
93
121
|
_id?: string;
|
|
94
|
-
/**
|
|
122
|
+
/**
|
|
123
|
+
* Definition of a target where the value of field belongs.
|
|
124
|
+
* @maxLength 200
|
|
125
|
+
* @immutable
|
|
126
|
+
*/
|
|
95
127
|
target?: string | null;
|
|
96
128
|
/** Validation of field output value. */
|
|
97
129
|
validation?: Validation;
|
|
@@ -120,17 +152,30 @@ export interface StringType extends StringTypeFormatOptionsOneOf {
|
|
|
120
152
|
dateOptionalTimeOptions?: DateTimeConstraints;
|
|
121
153
|
/** PHONE format options */
|
|
122
154
|
phoneOptions?: PhoneConstraints;
|
|
123
|
-
/**
|
|
155
|
+
/**
|
|
156
|
+
* Minimum length.
|
|
157
|
+
* @max 20000
|
|
158
|
+
*/
|
|
124
159
|
minLength?: number | null;
|
|
125
|
-
/**
|
|
160
|
+
/**
|
|
161
|
+
* Maximum length.
|
|
162
|
+
* @max 20000
|
|
163
|
+
*/
|
|
126
164
|
maxLength?: number | null;
|
|
127
|
-
/**
|
|
165
|
+
/**
|
|
166
|
+
* Pattern for a regular expression match.
|
|
167
|
+
* @maxLength 500
|
|
168
|
+
*/
|
|
128
169
|
pattern?: string | null;
|
|
129
170
|
/** Format of a string. */
|
|
130
171
|
format?: FormatEnumFormat;
|
|
131
172
|
/** Custom error messages when validation fails. */
|
|
132
173
|
errorMessages?: StringErrorMessages;
|
|
133
|
-
/**
|
|
174
|
+
/**
|
|
175
|
+
* List of allowed values.
|
|
176
|
+
* @maxSize 500
|
|
177
|
+
* @maxLength 20000
|
|
178
|
+
*/
|
|
134
179
|
enum?: string[] | null;
|
|
135
180
|
}
|
|
136
181
|
/** @oneof */
|
|
@@ -163,7 +208,10 @@ export declare enum FormatEnumFormat {
|
|
|
163
208
|
DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
|
|
164
209
|
}
|
|
165
210
|
export interface StringErrorMessages {
|
|
166
|
-
/**
|
|
211
|
+
/**
|
|
212
|
+
* Default error message on invalid validation.
|
|
213
|
+
* @maxLength 200
|
|
214
|
+
*/
|
|
167
215
|
default?: string | null;
|
|
168
216
|
}
|
|
169
217
|
export interface DateTimeConstraints {
|
|
@@ -172,6 +220,7 @@ export interface DateTimeConstraints {
|
|
|
172
220
|
* dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
|
|
173
221
|
* The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
|
|
174
222
|
* The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
|
|
223
|
+
* @maxLength 50
|
|
175
224
|
*/
|
|
176
225
|
minimum?: string | null;
|
|
177
226
|
/**
|
|
@@ -179,11 +228,16 @@ export interface DateTimeConstraints {
|
|
|
179
228
|
* dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
|
|
180
229
|
* The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
|
|
181
230
|
* The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
|
|
231
|
+
* @maxLength 50
|
|
182
232
|
*/
|
|
183
233
|
maximum?: string | null;
|
|
184
234
|
}
|
|
185
235
|
export interface PhoneConstraints {
|
|
186
|
-
/**
|
|
236
|
+
/**
|
|
237
|
+
* Country codes for phone number that are allowed
|
|
238
|
+
* @maxSize 250
|
|
239
|
+
* @maxLength 2
|
|
240
|
+
*/
|
|
187
241
|
allowedCountryCodes?: string[];
|
|
188
242
|
}
|
|
189
243
|
export interface NumberType {
|
|
@@ -195,11 +249,17 @@ export interface NumberType {
|
|
|
195
249
|
multipleOf?: number | null;
|
|
196
250
|
/** Custom error message when validation fails. */
|
|
197
251
|
errorMessages?: NumberErrorMessages;
|
|
198
|
-
/**
|
|
252
|
+
/**
|
|
253
|
+
* List of allowed values.
|
|
254
|
+
* @maxSize 500
|
|
255
|
+
*/
|
|
199
256
|
enum?: number[] | null;
|
|
200
257
|
}
|
|
201
258
|
export interface NumberErrorMessages {
|
|
202
|
-
/**
|
|
259
|
+
/**
|
|
260
|
+
* Default error message on invalid validation.
|
|
261
|
+
* @maxLength 200
|
|
262
|
+
*/
|
|
203
263
|
default?: string | null;
|
|
204
264
|
}
|
|
205
265
|
export interface IntegerType {
|
|
@@ -211,23 +271,38 @@ export interface IntegerType {
|
|
|
211
271
|
multipleOf?: number | null;
|
|
212
272
|
/** Custom error message when validation fails. */
|
|
213
273
|
errorMessages?: NumberErrorMessages;
|
|
214
|
-
/**
|
|
274
|
+
/**
|
|
275
|
+
* List of allowed values.
|
|
276
|
+
* @maxSize 500
|
|
277
|
+
*/
|
|
215
278
|
enum?: number[] | null;
|
|
216
279
|
}
|
|
217
280
|
export interface BooleanType {
|
|
218
281
|
/** Custom error message when validation fails. */
|
|
219
282
|
errorMessages?: BooleanErrorMessages;
|
|
220
|
-
/**
|
|
283
|
+
/**
|
|
284
|
+
* List of allowed values.
|
|
285
|
+
* @maxSize 2
|
|
286
|
+
*/
|
|
221
287
|
enum?: boolean[];
|
|
222
288
|
}
|
|
223
289
|
export interface BooleanErrorMessages {
|
|
224
|
-
/**
|
|
290
|
+
/**
|
|
291
|
+
* Default error message on invalid validation.
|
|
292
|
+
* @maxLength 200
|
|
293
|
+
*/
|
|
225
294
|
default?: string | null;
|
|
226
295
|
}
|
|
227
296
|
export interface ArrayType {
|
|
228
|
-
/**
|
|
297
|
+
/**
|
|
298
|
+
* Maximum amount of array elements.
|
|
299
|
+
* @max 1000
|
|
300
|
+
*/
|
|
229
301
|
maxItems?: number | null;
|
|
230
|
-
/**
|
|
302
|
+
/**
|
|
303
|
+
* Minimum amount of array elements.
|
|
304
|
+
* @max 1000
|
|
305
|
+
*/
|
|
231
306
|
minItems?: number | null;
|
|
232
307
|
/** Type of items allowed in array. */
|
|
233
308
|
items?: ArrayItems;
|
|
@@ -268,7 +343,10 @@ export interface PropertiesTypePropertiesTypeOneOf {
|
|
|
268
343
|
array?: ArrayType;
|
|
269
344
|
}
|
|
270
345
|
export interface ObjectErrorMessages {
|
|
271
|
-
/**
|
|
346
|
+
/**
|
|
347
|
+
* Default error message on invalid validation.
|
|
348
|
+
* @maxLength 200
|
|
349
|
+
*/
|
|
272
350
|
default?: string | null;
|
|
273
351
|
}
|
|
274
352
|
export interface ArrayItems extends ArrayItemsItemsOneOf {
|
|
@@ -297,7 +375,10 @@ export interface ArrayItemsItemsOneOf {
|
|
|
297
375
|
object?: ObjectType;
|
|
298
376
|
}
|
|
299
377
|
export interface ArrayErrorMessages {
|
|
300
|
-
/**
|
|
378
|
+
/**
|
|
379
|
+
* Default error message on invalid validation.
|
|
380
|
+
* @maxLength 200
|
|
381
|
+
*/
|
|
301
382
|
default?: string | null;
|
|
302
383
|
}
|
|
303
384
|
export interface PredefinedValidation extends PredefinedValidationFormatOptionsOneOf {
|
|
@@ -327,11 +408,21 @@ export declare enum ValidationFormat {
|
|
|
327
408
|
SCHEDULING = "SCHEDULING"
|
|
328
409
|
}
|
|
329
410
|
export interface PaymentType {
|
|
330
|
-
/**
|
|
411
|
+
/**
|
|
412
|
+
* Field mapped to products.
|
|
413
|
+
* @minSize 1
|
|
414
|
+
* @maxSize 100
|
|
415
|
+
*/
|
|
331
416
|
products?: Product[];
|
|
332
|
-
/**
|
|
417
|
+
/**
|
|
418
|
+
* Minimum amount of different products.
|
|
419
|
+
* @max 100
|
|
420
|
+
*/
|
|
333
421
|
minItems?: number | null;
|
|
334
|
-
/**
|
|
422
|
+
/**
|
|
423
|
+
* Maximum amount of different products.
|
|
424
|
+
* @max 100
|
|
425
|
+
*/
|
|
335
426
|
maxItems?: number | null;
|
|
336
427
|
}
|
|
337
428
|
export declare enum ProductType {
|
|
@@ -351,19 +442,36 @@ export declare enum PriceType {
|
|
|
351
442
|
DYNAMIC_PRICE = "DYNAMIC_PRICE"
|
|
352
443
|
}
|
|
353
444
|
export interface QuantityLimit {
|
|
354
|
-
/**
|
|
445
|
+
/**
|
|
446
|
+
* Minimum quantity.
|
|
447
|
+
* @min 1
|
|
448
|
+
* @max 100000
|
|
449
|
+
*/
|
|
355
450
|
minimum?: number | null;
|
|
356
|
-
/**
|
|
451
|
+
/**
|
|
452
|
+
* Maximum quantity.
|
|
453
|
+
* @min 1
|
|
454
|
+
* @max 100000
|
|
455
|
+
*/
|
|
357
456
|
maximum?: number | null;
|
|
358
457
|
}
|
|
359
458
|
export interface FixedPriceOptions {
|
|
360
|
-
/**
|
|
459
|
+
/**
|
|
460
|
+
* Fixed price monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99).
|
|
461
|
+
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
462
|
+
*/
|
|
361
463
|
price?: string;
|
|
362
464
|
}
|
|
363
465
|
export interface DynamicPriceOptions {
|
|
364
|
-
/**
|
|
466
|
+
/**
|
|
467
|
+
* Minimal price monetary amount.
|
|
468
|
+
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
469
|
+
*/
|
|
365
470
|
minPrice?: string;
|
|
366
|
-
/**
|
|
471
|
+
/**
|
|
472
|
+
* Maximal price monetary amount.
|
|
473
|
+
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
474
|
+
*/
|
|
367
475
|
maxPrice?: string | null;
|
|
368
476
|
}
|
|
369
477
|
export interface Product extends ProductPriceOptionsOneOf {
|
|
@@ -373,6 +481,7 @@ export interface Product extends ProductPriceOptionsOneOf {
|
|
|
373
481
|
dynamicPriceOptions?: DynamicPriceOptions;
|
|
374
482
|
/**
|
|
375
483
|
* Product ID.
|
|
484
|
+
* @format GUID
|
|
376
485
|
* @readonly
|
|
377
486
|
*/
|
|
378
487
|
_id?: string;
|
|
@@ -391,7 +500,11 @@ export interface ProductPriceOptionsOneOf {
|
|
|
391
500
|
dynamicPriceOptions?: DynamicPriceOptions;
|
|
392
501
|
}
|
|
393
502
|
export interface MultilineAddressValidation {
|
|
394
|
-
/**
|
|
503
|
+
/**
|
|
504
|
+
* Allowed countries. No countries treated as all.
|
|
505
|
+
* @format COUNTRY
|
|
506
|
+
* @maxSize 200
|
|
507
|
+
*/
|
|
395
508
|
allowedCountries?: string[];
|
|
396
509
|
/** Fields overrides. */
|
|
397
510
|
fields?: FieldsOverrides;
|
|
@@ -460,7 +573,12 @@ export interface ValidationValidationOneOf {
|
|
|
460
573
|
predefined?: PredefinedValidation;
|
|
461
574
|
}
|
|
462
575
|
export interface DataExtensionsDetails {
|
|
463
|
-
/**
|
|
576
|
+
/**
|
|
577
|
+
* FQDNS which can be extended with this field
|
|
578
|
+
* @maxSize 10
|
|
579
|
+
* @maxLength 100
|
|
580
|
+
* @immutable
|
|
581
|
+
*/
|
|
464
582
|
fqdns?: string[];
|
|
465
583
|
}
|
|
466
584
|
export interface NestedFormOverrides {
|
|
@@ -472,7 +590,11 @@ export interface FormFieldV2 extends FormFieldV2FieldTypeOptionsOneOf {
|
|
|
472
590
|
inputOptions?: InputField;
|
|
473
591
|
/** Field for displaying information such as header or text paragraph */
|
|
474
592
|
displayOptions?: DisplayField;
|
|
475
|
-
/**
|
|
593
|
+
/**
|
|
594
|
+
* Field id.
|
|
595
|
+
* @format GUID
|
|
596
|
+
* @immutable
|
|
597
|
+
*/
|
|
476
598
|
_id?: string;
|
|
477
599
|
/**
|
|
478
600
|
* Whether the field is hidden.
|
|
@@ -503,17 +625,30 @@ export interface InputFieldStringType extends InputFieldStringTypeFormatOptionsO
|
|
|
503
625
|
dateOptionalTimeOptions?: StringTypeDateTimeConstraints;
|
|
504
626
|
/** PHONE format options */
|
|
505
627
|
phoneOptions?: StringTypePhoneConstraints;
|
|
506
|
-
/**
|
|
628
|
+
/**
|
|
629
|
+
* Minimum length.
|
|
630
|
+
* @max 20000
|
|
631
|
+
*/
|
|
507
632
|
minLength?: number | null;
|
|
508
|
-
/**
|
|
633
|
+
/**
|
|
634
|
+
* Maximum length.
|
|
635
|
+
* @max 20000
|
|
636
|
+
*/
|
|
509
637
|
maxLength?: number | null;
|
|
510
|
-
/**
|
|
638
|
+
/**
|
|
639
|
+
* Pattern for a regular expression match.
|
|
640
|
+
* @maxLength 500
|
|
641
|
+
*/
|
|
511
642
|
pattern?: string | null;
|
|
512
643
|
/** Format of a string. */
|
|
513
644
|
format?: StringTypeFormatEnumFormat;
|
|
514
645
|
/** Custom error messages when validation fails. */
|
|
515
646
|
errorMessages?: InputFieldStringErrorMessages;
|
|
516
|
-
/**
|
|
647
|
+
/**
|
|
648
|
+
* List of allowed values.
|
|
649
|
+
* @maxSize 500
|
|
650
|
+
* @maxLength 20000
|
|
651
|
+
*/
|
|
517
652
|
enum?: string[] | null;
|
|
518
653
|
}
|
|
519
654
|
/** @oneof */
|
|
@@ -546,7 +681,10 @@ export declare enum StringTypeFormatEnumFormat {
|
|
|
546
681
|
DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
|
|
547
682
|
}
|
|
548
683
|
export interface InputFieldStringErrorMessages {
|
|
549
|
-
/**
|
|
684
|
+
/**
|
|
685
|
+
* Default error message on invalid validation.
|
|
686
|
+
* @maxLength 200
|
|
687
|
+
*/
|
|
550
688
|
default?: string | null;
|
|
551
689
|
}
|
|
552
690
|
export interface StringTypeDateTimeConstraints {
|
|
@@ -555,6 +693,7 @@ export interface StringTypeDateTimeConstraints {
|
|
|
555
693
|
* dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
|
|
556
694
|
* The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
|
|
557
695
|
* The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
|
|
696
|
+
* @maxLength 50
|
|
558
697
|
*/
|
|
559
698
|
minimum?: string | null;
|
|
560
699
|
/**
|
|
@@ -562,11 +701,16 @@ export interface StringTypeDateTimeConstraints {
|
|
|
562
701
|
* dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
|
|
563
702
|
* The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
|
|
564
703
|
* The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
|
|
704
|
+
* @maxLength 50
|
|
565
705
|
*/
|
|
566
706
|
maximum?: string | null;
|
|
567
707
|
}
|
|
568
708
|
export interface StringTypePhoneConstraints {
|
|
569
|
-
/**
|
|
709
|
+
/**
|
|
710
|
+
* Country codes for phone number that are allowed
|
|
711
|
+
* @maxSize 250
|
|
712
|
+
* @maxLength 2
|
|
713
|
+
*/
|
|
570
714
|
allowedCountryCodes?: string[];
|
|
571
715
|
}
|
|
572
716
|
export declare enum StringComponentType {
|
|
@@ -581,18 +725,27 @@ export declare enum StringComponentType {
|
|
|
581
725
|
DATE_PICKER = "DATE_PICKER"
|
|
582
726
|
}
|
|
583
727
|
export interface TextInput {
|
|
584
|
-
/**
|
|
728
|
+
/**
|
|
729
|
+
* Label of the field
|
|
730
|
+
* @maxLength 350
|
|
731
|
+
*/
|
|
585
732
|
label?: string | null;
|
|
586
733
|
/** Description of the field */
|
|
587
734
|
description?: RichContent;
|
|
588
|
-
/**
|
|
735
|
+
/**
|
|
736
|
+
* Placeholder for the value input
|
|
737
|
+
* @maxLength 100
|
|
738
|
+
*/
|
|
589
739
|
placeholder?: string | null;
|
|
590
740
|
/**
|
|
591
741
|
* Flag identifying to hide or not label
|
|
592
742
|
* Default: true
|
|
593
743
|
*/
|
|
594
744
|
showLabel?: boolean | null;
|
|
595
|
-
/**
|
|
745
|
+
/**
|
|
746
|
+
* Default value for the text input
|
|
747
|
+
* @maxLength 20000
|
|
748
|
+
*/
|
|
596
749
|
default?: string | null;
|
|
597
750
|
}
|
|
598
751
|
export interface RichContent {
|
|
@@ -1193,11 +1346,20 @@ export interface GIFData {
|
|
|
1193
1346
|
gifType?: GIFType;
|
|
1194
1347
|
}
|
|
1195
1348
|
export interface GIF {
|
|
1196
|
-
/**
|
|
1349
|
+
/**
|
|
1350
|
+
* GIF format URL.
|
|
1351
|
+
* @format WEB_URL
|
|
1352
|
+
*/
|
|
1197
1353
|
gif?: string | null;
|
|
1198
|
-
/**
|
|
1354
|
+
/**
|
|
1355
|
+
* MP4 format URL.
|
|
1356
|
+
* @format WEB_URL
|
|
1357
|
+
*/
|
|
1199
1358
|
mp4?: string | null;
|
|
1200
|
-
/**
|
|
1359
|
+
/**
|
|
1360
|
+
* Thumbnail URL.
|
|
1361
|
+
* @format WEB_URL
|
|
1362
|
+
*/
|
|
1201
1363
|
still?: string | null;
|
|
1202
1364
|
}
|
|
1203
1365
|
export declare enum GIFType {
|
|
@@ -1271,7 +1433,10 @@ export interface ImageData {
|
|
|
1271
1433
|
export interface StylesBorder {
|
|
1272
1434
|
/** Border width in pixels. */
|
|
1273
1435
|
width?: number | null;
|
|
1274
|
-
/**
|
|
1436
|
+
/**
|
|
1437
|
+
* Border color as a hexadecimal value.
|
|
1438
|
+
* @format COLOR_HEX
|
|
1439
|
+
*/
|
|
1275
1440
|
color?: string | null;
|
|
1276
1441
|
/** Border radius in pixels. */
|
|
1277
1442
|
radius?: number | null;
|
|
@@ -1425,13 +1590,22 @@ export declare enum BackgroundType {
|
|
|
1425
1590
|
export interface Gradient {
|
|
1426
1591
|
/** The gradient angle in degrees. */
|
|
1427
1592
|
angle?: number | null;
|
|
1428
|
-
/**
|
|
1593
|
+
/**
|
|
1594
|
+
* The start color as a hexademical value.
|
|
1595
|
+
* @format COLOR_HEX
|
|
1596
|
+
*/
|
|
1429
1597
|
startColor?: string | null;
|
|
1430
|
-
/**
|
|
1598
|
+
/**
|
|
1599
|
+
* The end color as a hexademical value.
|
|
1600
|
+
* @format COLOR_HEX
|
|
1601
|
+
*/
|
|
1431
1602
|
lastColor?: string | null;
|
|
1432
1603
|
}
|
|
1433
1604
|
export interface Background extends BackgroundBackgroundOneOf {
|
|
1434
|
-
/**
|
|
1605
|
+
/**
|
|
1606
|
+
* The background color as a hexademical value.
|
|
1607
|
+
* @format COLOR_HEX
|
|
1608
|
+
*/
|
|
1435
1609
|
color?: string | null;
|
|
1436
1610
|
/** An image to use for the background. */
|
|
1437
1611
|
image?: Media;
|
|
@@ -1442,7 +1616,10 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1442
1616
|
}
|
|
1443
1617
|
/** @oneof */
|
|
1444
1618
|
export interface BackgroundBackgroundOneOf {
|
|
1445
|
-
/**
|
|
1619
|
+
/**
|
|
1620
|
+
* The background color as a hexademical value.
|
|
1621
|
+
* @format COLOR_HEX
|
|
1622
|
+
*/
|
|
1446
1623
|
color?: string | null;
|
|
1447
1624
|
/** An image to use for the background. */
|
|
1448
1625
|
image?: Media;
|
|
@@ -1754,17 +1931,32 @@ export declare enum VerticalAlignment {
|
|
|
1754
1931
|
export interface CellStyle {
|
|
1755
1932
|
/** Vertical alignment for the cell's text. */
|
|
1756
1933
|
verticalAlignment?: VerticalAlignment;
|
|
1757
|
-
/**
|
|
1934
|
+
/**
|
|
1935
|
+
* Cell background color as a hexadecimal value.
|
|
1936
|
+
* @format COLOR_HEX
|
|
1937
|
+
*/
|
|
1758
1938
|
backgroundColor?: string | null;
|
|
1759
1939
|
}
|
|
1760
1940
|
export interface BorderColors {
|
|
1761
|
-
/**
|
|
1941
|
+
/**
|
|
1942
|
+
* Left border color as a hexadecimal value.
|
|
1943
|
+
* @format COLOR_HEX
|
|
1944
|
+
*/
|
|
1762
1945
|
left?: string | null;
|
|
1763
|
-
/**
|
|
1946
|
+
/**
|
|
1947
|
+
* Right border color as a hexadecimal value.
|
|
1948
|
+
* @format COLOR_HEX
|
|
1949
|
+
*/
|
|
1764
1950
|
right?: string | null;
|
|
1765
|
-
/**
|
|
1951
|
+
/**
|
|
1952
|
+
* Top border color as a hexadecimal value.
|
|
1953
|
+
* @format COLOR_HEX
|
|
1954
|
+
*/
|
|
1766
1955
|
top?: string | null;
|
|
1767
|
-
/**
|
|
1956
|
+
/**
|
|
1957
|
+
* Bottom border color as a hexadecimal value.
|
|
1958
|
+
* @format COLOR_HEX
|
|
1959
|
+
*/
|
|
1768
1960
|
bottom?: string | null;
|
|
1769
1961
|
}
|
|
1770
1962
|
/**
|
|
@@ -1873,13 +2065,17 @@ export interface TextNodeStyle {
|
|
|
1873
2065
|
lineHeight?: string | null;
|
|
1874
2066
|
}
|
|
1875
2067
|
export interface RadioGroup {
|
|
1876
|
-
/**
|
|
2068
|
+
/**
|
|
2069
|
+
* Label of the field
|
|
2070
|
+
* @maxLength 350
|
|
2071
|
+
*/
|
|
1877
2072
|
label?: string | null;
|
|
1878
2073
|
/** Description of the field */
|
|
1879
2074
|
description?: RichContent;
|
|
1880
2075
|
/**
|
|
1881
2076
|
* Flag identifying to show option allowing input custom value
|
|
1882
2077
|
* List of options to select from
|
|
2078
|
+
* @maxSize 400
|
|
1883
2079
|
*/
|
|
1884
2080
|
options?: RadioGroupOption[];
|
|
1885
2081
|
/**
|
|
@@ -1896,19 +2092,35 @@ export interface RadioGroup {
|
|
|
1896
2092
|
numberOfColumns?: NumberOfColumns;
|
|
1897
2093
|
}
|
|
1898
2094
|
export interface RadioGroupOption {
|
|
1899
|
-
/**
|
|
2095
|
+
/**
|
|
2096
|
+
* Selectable option label
|
|
2097
|
+
* @maxLength 400
|
|
2098
|
+
*/
|
|
1900
2099
|
label?: string | null;
|
|
1901
|
-
/**
|
|
2100
|
+
/**
|
|
2101
|
+
* Selectable option value, which is saved to DB.
|
|
2102
|
+
* @maxLength 20000
|
|
2103
|
+
*/
|
|
1902
2104
|
value?: string | null;
|
|
1903
2105
|
/** Flag identifying that option should be selected by default */
|
|
1904
2106
|
default?: boolean;
|
|
1905
|
-
/**
|
|
2107
|
+
/**
|
|
2108
|
+
* Option id. Used as binding for translations
|
|
2109
|
+
* @format GUID
|
|
2110
|
+
* @immutable
|
|
2111
|
+
*/
|
|
1906
2112
|
_id?: string;
|
|
1907
2113
|
}
|
|
1908
2114
|
export interface RadioGroupCustomOption {
|
|
1909
|
-
/**
|
|
2115
|
+
/**
|
|
2116
|
+
* Label of custom option input
|
|
2117
|
+
* @maxLength 350
|
|
2118
|
+
*/
|
|
1910
2119
|
label?: string | null;
|
|
1911
|
-
/**
|
|
2120
|
+
/**
|
|
2121
|
+
* Placeholder of custom option input
|
|
2122
|
+
* @maxLength 100
|
|
2123
|
+
*/
|
|
1912
2124
|
placeholder?: string | null;
|
|
1913
2125
|
}
|
|
1914
2126
|
export declare enum NumberOfColumns {
|
|
@@ -1924,11 +2136,17 @@ export declare enum NumberOfColumns {
|
|
|
1924
2136
|
THREE = "THREE"
|
|
1925
2137
|
}
|
|
1926
2138
|
export interface Dropdown {
|
|
1927
|
-
/**
|
|
2139
|
+
/**
|
|
2140
|
+
* Label of the field
|
|
2141
|
+
* @maxLength 350
|
|
2142
|
+
*/
|
|
1928
2143
|
label?: string | null;
|
|
1929
2144
|
/** Description of the field */
|
|
1930
2145
|
description?: RichContent;
|
|
1931
|
-
/**
|
|
2146
|
+
/**
|
|
2147
|
+
* List of options to select from
|
|
2148
|
+
* @maxSize 400
|
|
2149
|
+
*/
|
|
1932
2150
|
options?: DropdownOption[];
|
|
1933
2151
|
/**
|
|
1934
2152
|
* Flag identifying to hide or not label
|
|
@@ -1937,27 +2155,49 @@ export interface Dropdown {
|
|
|
1937
2155
|
showLabel?: boolean | null;
|
|
1938
2156
|
/** Option which can be specified by UoU, enabled when this object is specified. */
|
|
1939
2157
|
customOption?: DropdownCustomOption;
|
|
1940
|
-
/**
|
|
2158
|
+
/**
|
|
2159
|
+
* Placeholder of dropdown input
|
|
2160
|
+
* @maxLength 100
|
|
2161
|
+
*/
|
|
1941
2162
|
placeholder?: string | null;
|
|
1942
2163
|
}
|
|
1943
2164
|
export interface DropdownOption {
|
|
1944
|
-
/**
|
|
2165
|
+
/**
|
|
2166
|
+
* Selectable option label
|
|
2167
|
+
* @maxLength 400
|
|
2168
|
+
*/
|
|
1945
2169
|
label?: string | null;
|
|
1946
|
-
/**
|
|
2170
|
+
/**
|
|
2171
|
+
* Selectable option value, which is saved to DB.
|
|
2172
|
+
* @maxLength 20000
|
|
2173
|
+
*/
|
|
1947
2174
|
value?: string | null;
|
|
1948
2175
|
/** Flag identifying that option should be selected by default */
|
|
1949
2176
|
default?: boolean;
|
|
1950
|
-
/**
|
|
2177
|
+
/**
|
|
2178
|
+
* Option id. Used as binding for translations
|
|
2179
|
+
* @format GUID
|
|
2180
|
+
* @immutable
|
|
2181
|
+
*/
|
|
1951
2182
|
_id?: string;
|
|
1952
2183
|
}
|
|
1953
2184
|
export interface DropdownCustomOption {
|
|
1954
|
-
/**
|
|
2185
|
+
/**
|
|
2186
|
+
* Label of custom option input
|
|
2187
|
+
* @maxLength 350
|
|
2188
|
+
*/
|
|
1955
2189
|
label?: string | null;
|
|
1956
|
-
/**
|
|
2190
|
+
/**
|
|
2191
|
+
* Placeholder of custom option input
|
|
2192
|
+
* @maxLength 100
|
|
2193
|
+
*/
|
|
1957
2194
|
placeholder?: string | null;
|
|
1958
2195
|
}
|
|
1959
2196
|
export interface DateTimeInput {
|
|
1960
|
-
/**
|
|
2197
|
+
/**
|
|
2198
|
+
* Label of the field. Displayed text for the date/time input.
|
|
2199
|
+
* @maxLength 350
|
|
2200
|
+
*/
|
|
1961
2201
|
label?: string | null;
|
|
1962
2202
|
/** Description of the field. Additional information about the date/time input. */
|
|
1963
2203
|
description?: RichContent;
|
|
@@ -1976,22 +2216,35 @@ export interface DateTimeInput {
|
|
|
1976
2216
|
* Default: false.
|
|
1977
2217
|
*/
|
|
1978
2218
|
use24HourFormat?: boolean;
|
|
1979
|
-
/**
|
|
2219
|
+
/**
|
|
2220
|
+
* Default value for the date time input.
|
|
2221
|
+
* @format LOCAL_DATE_TIME
|
|
2222
|
+
*/
|
|
1980
2223
|
default?: string | null;
|
|
1981
2224
|
}
|
|
1982
2225
|
export interface PhoneInput {
|
|
1983
|
-
/**
|
|
2226
|
+
/**
|
|
2227
|
+
* Label of the field
|
|
2228
|
+
* @maxLength 350
|
|
2229
|
+
*/
|
|
1984
2230
|
label?: string | null;
|
|
1985
2231
|
/** Description of the field */
|
|
1986
2232
|
description?: RichContent;
|
|
1987
|
-
/**
|
|
2233
|
+
/**
|
|
2234
|
+
* Placeholder for the value input
|
|
2235
|
+
* @maxLength 100
|
|
2236
|
+
*/
|
|
1988
2237
|
placeholder?: string | null;
|
|
1989
2238
|
/**
|
|
1990
2239
|
* Flag identifying to show label or not
|
|
1991
2240
|
* Default: true
|
|
1992
2241
|
*/
|
|
1993
2242
|
showLabel?: boolean | null;
|
|
1994
|
-
/**
|
|
2243
|
+
/**
|
|
2244
|
+
* Default value of the country code
|
|
2245
|
+
* @minLength 1
|
|
2246
|
+
* @maxLength 5
|
|
2247
|
+
*/
|
|
1995
2248
|
defaultCountryCode?: string | null;
|
|
1996
2249
|
/**
|
|
1997
2250
|
* Flag identifying to show country flag or not
|
|
@@ -2000,7 +2253,10 @@ export interface PhoneInput {
|
|
|
2000
2253
|
showCountryFlag?: boolean;
|
|
2001
2254
|
}
|
|
2002
2255
|
export interface DateInput {
|
|
2003
|
-
/**
|
|
2256
|
+
/**
|
|
2257
|
+
* Label of the field. Displayed text for the date/time input.
|
|
2258
|
+
* @maxLength 350
|
|
2259
|
+
*/
|
|
2004
2260
|
label?: string | null;
|
|
2005
2261
|
/** Description of the field. Additional information about the date/time input. */
|
|
2006
2262
|
description?: RichContent;
|
|
@@ -2014,11 +2270,17 @@ export interface DateInput {
|
|
|
2014
2270
|
* Default: true
|
|
2015
2271
|
*/
|
|
2016
2272
|
showPlaceholder?: boolean | null;
|
|
2017
|
-
/**
|
|
2273
|
+
/**
|
|
2274
|
+
* Default value for the date input.
|
|
2275
|
+
* @format LOCAL_DATE
|
|
2276
|
+
*/
|
|
2018
2277
|
default?: string | null;
|
|
2019
2278
|
}
|
|
2020
2279
|
export interface TimeInput {
|
|
2021
|
-
/**
|
|
2280
|
+
/**
|
|
2281
|
+
* Label of the field. Displayed text for the date/time input.
|
|
2282
|
+
* @maxLength 350
|
|
2283
|
+
*/
|
|
2022
2284
|
label?: string | null;
|
|
2023
2285
|
/** Description of the field. Additional information about the date/time input. */
|
|
2024
2286
|
description?: RichContent;
|
|
@@ -2037,11 +2299,17 @@ export interface TimeInput {
|
|
|
2037
2299
|
* Default: false.
|
|
2038
2300
|
*/
|
|
2039
2301
|
use24HourFormat?: boolean;
|
|
2040
|
-
/**
|
|
2302
|
+
/**
|
|
2303
|
+
* Default value for the time input.
|
|
2304
|
+
* @format LOCAL_TIME
|
|
2305
|
+
*/
|
|
2041
2306
|
default?: string | null;
|
|
2042
2307
|
}
|
|
2043
2308
|
export interface DatePicker {
|
|
2044
|
-
/**
|
|
2309
|
+
/**
|
|
2310
|
+
* Label of the field. Displayed text for the date/time input.
|
|
2311
|
+
* @maxLength 350
|
|
2312
|
+
*/
|
|
2045
2313
|
label?: string | null;
|
|
2046
2314
|
/** Description of the field. Additional information about the date/time input. */
|
|
2047
2315
|
description?: RichContent;
|
|
@@ -2050,11 +2318,17 @@ export interface DatePicker {
|
|
|
2050
2318
|
* Default: true
|
|
2051
2319
|
*/
|
|
2052
2320
|
showLabel?: boolean | null;
|
|
2053
|
-
/**
|
|
2321
|
+
/**
|
|
2322
|
+
* Placeholder of date picker input
|
|
2323
|
+
* @maxLength 100
|
|
2324
|
+
*/
|
|
2054
2325
|
placeholder?: string | null;
|
|
2055
2326
|
/** First day of the week displayed on date picker. */
|
|
2056
2327
|
firstDayOfWeek?: FirstDayOfWeek;
|
|
2057
|
-
/**
|
|
2328
|
+
/**
|
|
2329
|
+
* Default value for the date picker.
|
|
2330
|
+
* @format LOCAL_DATE
|
|
2331
|
+
*/
|
|
2058
2332
|
default?: string | null;
|
|
2059
2333
|
}
|
|
2060
2334
|
export declare enum FirstDayOfWeek {
|
|
@@ -2072,11 +2346,17 @@ export interface InputFieldNumberType {
|
|
|
2072
2346
|
multipleOf?: number | null;
|
|
2073
2347
|
/** Custom error message when validation fails. */
|
|
2074
2348
|
errorMessages?: InputFieldNumberErrorMessages;
|
|
2075
|
-
/**
|
|
2349
|
+
/**
|
|
2350
|
+
* List of allowed values.
|
|
2351
|
+
* @maxSize 500
|
|
2352
|
+
*/
|
|
2076
2353
|
enum?: number[] | null;
|
|
2077
2354
|
}
|
|
2078
2355
|
export interface InputFieldNumberErrorMessages {
|
|
2079
|
-
/**
|
|
2356
|
+
/**
|
|
2357
|
+
* Default error message on invalid validation.
|
|
2358
|
+
* @maxLength 200
|
|
2359
|
+
*/
|
|
2080
2360
|
default?: string | null;
|
|
2081
2361
|
}
|
|
2082
2362
|
export declare enum NumberComponentType {
|
|
@@ -2085,11 +2365,17 @@ export declare enum NumberComponentType {
|
|
|
2085
2365
|
RATING_INPUT = "RATING_INPUT"
|
|
2086
2366
|
}
|
|
2087
2367
|
export interface NumberInput {
|
|
2088
|
-
/**
|
|
2368
|
+
/**
|
|
2369
|
+
* Label of the field
|
|
2370
|
+
* @maxLength 350
|
|
2371
|
+
*/
|
|
2089
2372
|
label?: string | null;
|
|
2090
2373
|
/** Description of the field */
|
|
2091
2374
|
description?: RichContent;
|
|
2092
|
-
/**
|
|
2375
|
+
/**
|
|
2376
|
+
* Placeholder for the value input
|
|
2377
|
+
* @maxLength 100
|
|
2378
|
+
*/
|
|
2093
2379
|
placeholder?: string | null;
|
|
2094
2380
|
/**
|
|
2095
2381
|
* Flag identifying to hide or not label
|
|
@@ -2100,7 +2386,10 @@ export interface NumberInput {
|
|
|
2100
2386
|
default?: number | null;
|
|
2101
2387
|
}
|
|
2102
2388
|
export interface RatingInput {
|
|
2103
|
-
/**
|
|
2389
|
+
/**
|
|
2390
|
+
* Label of the field
|
|
2391
|
+
* @maxLength 350
|
|
2392
|
+
*/
|
|
2104
2393
|
label?: string | null;
|
|
2105
2394
|
/** Description of the field */
|
|
2106
2395
|
description?: RichContent;
|
|
@@ -2109,17 +2398,27 @@ export interface RatingInput {
|
|
|
2109
2398
|
* Default: true
|
|
2110
2399
|
*/
|
|
2111
2400
|
showLabel?: boolean | null;
|
|
2112
|
-
/**
|
|
2401
|
+
/**
|
|
2402
|
+
* Default rating
|
|
2403
|
+
* @min 1
|
|
2404
|
+
* @max 5
|
|
2405
|
+
*/
|
|
2113
2406
|
defaultValue?: number | null;
|
|
2114
2407
|
}
|
|
2115
2408
|
export interface InputFieldBooleanType {
|
|
2116
2409
|
/** Custom error message when validation fails. */
|
|
2117
2410
|
errorMessages?: InputFieldBooleanErrorMessages;
|
|
2118
|
-
/**
|
|
2411
|
+
/**
|
|
2412
|
+
* List of allowed values.
|
|
2413
|
+
* @maxSize 2
|
|
2414
|
+
*/
|
|
2119
2415
|
enum?: boolean[];
|
|
2120
2416
|
}
|
|
2121
2417
|
export interface InputFieldBooleanErrorMessages {
|
|
2122
|
-
/**
|
|
2418
|
+
/**
|
|
2419
|
+
* Default error message on invalid validation.
|
|
2420
|
+
* @maxLength 200
|
|
2421
|
+
*/
|
|
2123
2422
|
default?: string | null;
|
|
2124
2423
|
}
|
|
2125
2424
|
export declare enum BooleanComponentType {
|
|
@@ -2136,9 +2435,15 @@ export interface Checkbox {
|
|
|
2136
2435
|
checked?: boolean;
|
|
2137
2436
|
}
|
|
2138
2437
|
export interface InputFieldArrayType {
|
|
2139
|
-
/**
|
|
2438
|
+
/**
|
|
2439
|
+
* Maximum amount of array elements.
|
|
2440
|
+
* @max 1000
|
|
2441
|
+
*/
|
|
2140
2442
|
maxItems?: number | null;
|
|
2141
|
-
/**
|
|
2443
|
+
/**
|
|
2444
|
+
* Minimum amount of array elements.
|
|
2445
|
+
* @max 1000
|
|
2446
|
+
*/
|
|
2142
2447
|
minItems?: number | null;
|
|
2143
2448
|
/** Type of items allowed in array. */
|
|
2144
2449
|
items?: ArrayTypeArrayItems;
|
|
@@ -2162,7 +2467,10 @@ export interface InputFieldIntegerType {
|
|
|
2162
2467
|
multipleOf?: number | null;
|
|
2163
2468
|
/** Custom error message when validation fails. */
|
|
2164
2469
|
errorMessages?: InputFieldNumberErrorMessages;
|
|
2165
|
-
/**
|
|
2470
|
+
/**
|
|
2471
|
+
* List of allowed values.
|
|
2472
|
+
* @maxSize 500
|
|
2473
|
+
*/
|
|
2166
2474
|
enum?: number[] | null;
|
|
2167
2475
|
}
|
|
2168
2476
|
export interface InputFieldObjectType {
|
|
@@ -2212,7 +2520,10 @@ export interface ObjectTypePropertiesTypePropertiesTypeOptionsOneOf {
|
|
|
2212
2520
|
arrayOptions?: InputFieldArrayType;
|
|
2213
2521
|
}
|
|
2214
2522
|
export interface InputFieldObjectErrorMessages {
|
|
2215
|
-
/**
|
|
2523
|
+
/**
|
|
2524
|
+
* Default error message on invalid validation.
|
|
2525
|
+
* @maxLength 200
|
|
2526
|
+
*/
|
|
2216
2527
|
default?: string | null;
|
|
2217
2528
|
}
|
|
2218
2529
|
export interface ArrayTypeArrayItems extends ArrayTypeArrayItemsItemTypeOptionsOneOf {
|
|
@@ -2246,7 +2557,10 @@ export interface ArrayTypeArrayItemsItemTypeOptionsOneOf {
|
|
|
2246
2557
|
objectOptions?: InputFieldObjectType;
|
|
2247
2558
|
}
|
|
2248
2559
|
export interface InputFieldArrayErrorMessages {
|
|
2249
|
-
/**
|
|
2560
|
+
/**
|
|
2561
|
+
* Default error message on invalid validation.
|
|
2562
|
+
* @maxLength 200
|
|
2563
|
+
*/
|
|
2250
2564
|
default?: string | null;
|
|
2251
2565
|
}
|
|
2252
2566
|
export declare enum ComponentType {
|
|
@@ -2255,11 +2569,17 @@ export declare enum ComponentType {
|
|
|
2255
2569
|
TAGS = "TAGS"
|
|
2256
2570
|
}
|
|
2257
2571
|
export interface CheckboxGroup {
|
|
2258
|
-
/**
|
|
2572
|
+
/**
|
|
2573
|
+
* Label of the field
|
|
2574
|
+
* @maxLength 350
|
|
2575
|
+
*/
|
|
2259
2576
|
label?: string | null;
|
|
2260
2577
|
/** Description of the field */
|
|
2261
2578
|
description?: RichContent;
|
|
2262
|
-
/**
|
|
2579
|
+
/**
|
|
2580
|
+
* List of options to select from
|
|
2581
|
+
* @maxSize 400
|
|
2582
|
+
*/
|
|
2263
2583
|
options?: Option[];
|
|
2264
2584
|
/**
|
|
2265
2585
|
* Flag identifying to hide or not label
|
|
@@ -2284,29 +2604,48 @@ export interface MediaItemMediaOneOf {
|
|
|
2284
2604
|
image?: string;
|
|
2285
2605
|
}
|
|
2286
2606
|
export interface Option {
|
|
2287
|
-
/**
|
|
2607
|
+
/**
|
|
2608
|
+
* Selectable option label
|
|
2609
|
+
* @maxLength 400
|
|
2610
|
+
*/
|
|
2288
2611
|
label?: string | null;
|
|
2289
2612
|
/** Selectable option value, which is saved to DB. */
|
|
2290
2613
|
value?: any;
|
|
2291
2614
|
/** Flag identifying that option should be selected by default */
|
|
2292
2615
|
default?: boolean;
|
|
2293
|
-
/**
|
|
2616
|
+
/**
|
|
2617
|
+
* Option id. Used as binding for translations
|
|
2618
|
+
* @format GUID
|
|
2619
|
+
* @immutable
|
|
2620
|
+
*/
|
|
2294
2621
|
_id?: string;
|
|
2295
2622
|
/** Media item. Media, associated with option, like image. */
|
|
2296
2623
|
media?: MediaItem;
|
|
2297
2624
|
}
|
|
2298
2625
|
export interface CustomOption {
|
|
2299
|
-
/**
|
|
2626
|
+
/**
|
|
2627
|
+
* Label of custom option input
|
|
2628
|
+
* @maxLength 350
|
|
2629
|
+
*/
|
|
2300
2630
|
label?: string | null;
|
|
2301
|
-
/**
|
|
2631
|
+
/**
|
|
2632
|
+
* Placeholder of custom option input
|
|
2633
|
+
* @maxLength 100
|
|
2634
|
+
*/
|
|
2302
2635
|
placeholder?: string | null;
|
|
2303
2636
|
}
|
|
2304
2637
|
export interface Tags {
|
|
2305
|
-
/**
|
|
2638
|
+
/**
|
|
2639
|
+
* Label of the field
|
|
2640
|
+
* @maxLength 350
|
|
2641
|
+
*/
|
|
2306
2642
|
label?: string | null;
|
|
2307
2643
|
/** Description of the field */
|
|
2308
2644
|
description?: RichContent;
|
|
2309
|
-
/**
|
|
2645
|
+
/**
|
|
2646
|
+
* List of options to select from
|
|
2647
|
+
* @maxSize 400
|
|
2648
|
+
*/
|
|
2310
2649
|
options?: TagsOption[];
|
|
2311
2650
|
/**
|
|
2312
2651
|
* Flag identifying to hide or not label
|
|
@@ -2322,21 +2661,34 @@ export interface Tags {
|
|
|
2322
2661
|
numberOfColumns?: NumberOfColumns;
|
|
2323
2662
|
}
|
|
2324
2663
|
export interface TagsOption {
|
|
2325
|
-
/**
|
|
2664
|
+
/**
|
|
2665
|
+
* Selectable option label
|
|
2666
|
+
* @maxLength 400
|
|
2667
|
+
*/
|
|
2326
2668
|
label?: string | null;
|
|
2327
2669
|
/** Selectable option value, which is saved to DB. */
|
|
2328
2670
|
value?: any;
|
|
2329
2671
|
/** Flag identifying that option should be selected by default */
|
|
2330
2672
|
default?: boolean;
|
|
2331
|
-
/**
|
|
2673
|
+
/**
|
|
2674
|
+
* Option id. Used as binding for translations
|
|
2675
|
+
* @format GUID
|
|
2676
|
+
* @immutable
|
|
2677
|
+
*/
|
|
2332
2678
|
_id?: string;
|
|
2333
2679
|
/** Media item. Media, associated with option, like image. */
|
|
2334
2680
|
media?: MediaItem;
|
|
2335
2681
|
}
|
|
2336
2682
|
export interface CommonCustomOption {
|
|
2337
|
-
/**
|
|
2683
|
+
/**
|
|
2684
|
+
* Label of custom option input
|
|
2685
|
+
* @maxLength 350
|
|
2686
|
+
*/
|
|
2338
2687
|
label?: string | null;
|
|
2339
|
-
/**
|
|
2688
|
+
/**
|
|
2689
|
+
* Placeholder of custom option input
|
|
2690
|
+
* @maxLength 100
|
|
2691
|
+
*/
|
|
2340
2692
|
placeholder?: string | null;
|
|
2341
2693
|
}
|
|
2342
2694
|
export declare enum WixFileComponentType {
|
|
@@ -2345,7 +2697,10 @@ export declare enum WixFileComponentType {
|
|
|
2345
2697
|
SIGNATURE = "SIGNATURE"
|
|
2346
2698
|
}
|
|
2347
2699
|
export interface FileUpload {
|
|
2348
|
-
/**
|
|
2700
|
+
/**
|
|
2701
|
+
* Selectable option label
|
|
2702
|
+
* @maxLength 350
|
|
2703
|
+
*/
|
|
2349
2704
|
label?: string | null;
|
|
2350
2705
|
/** Description of the field */
|
|
2351
2706
|
description?: RichContent;
|
|
@@ -2354,13 +2709,26 @@ export interface FileUpload {
|
|
|
2354
2709
|
* Default: true
|
|
2355
2710
|
*/
|
|
2356
2711
|
showLabel?: boolean | null;
|
|
2357
|
-
/**
|
|
2712
|
+
/**
|
|
2713
|
+
* Text on upload button
|
|
2714
|
+
* @maxLength 500
|
|
2715
|
+
*/
|
|
2358
2716
|
buttonText?: string | null;
|
|
2359
|
-
/**
|
|
2717
|
+
/**
|
|
2718
|
+
* Amount of files allowed to upload
|
|
2719
|
+
* @min 1
|
|
2720
|
+
* @max 30
|
|
2721
|
+
*/
|
|
2360
2722
|
fileLimit?: number;
|
|
2361
|
-
/**
|
|
2723
|
+
/**
|
|
2724
|
+
* Supported file formats for upload
|
|
2725
|
+
* @maxSize 5
|
|
2726
|
+
*/
|
|
2362
2727
|
uploadFileFormats?: UploadFileFormat[];
|
|
2363
|
-
/**
|
|
2728
|
+
/**
|
|
2729
|
+
* Custom text which appears when file is uploaded, if missing file name will be shown
|
|
2730
|
+
* @maxLength 255
|
|
2731
|
+
*/
|
|
2364
2732
|
explanationText?: string | null;
|
|
2365
2733
|
}
|
|
2366
2734
|
export declare enum UploadFileFormat {
|
|
@@ -2378,7 +2746,10 @@ export declare enum UploadFileFormat {
|
|
|
2378
2746
|
ARCHIVE = "ARCHIVE"
|
|
2379
2747
|
}
|
|
2380
2748
|
export interface Signature {
|
|
2381
|
-
/**
|
|
2749
|
+
/**
|
|
2750
|
+
* Selectable option label
|
|
2751
|
+
* @maxLength 350
|
|
2752
|
+
*/
|
|
2382
2753
|
label?: string | null;
|
|
2383
2754
|
/**
|
|
2384
2755
|
* Flag identifying to hide label or not
|
|
@@ -2398,11 +2769,17 @@ export declare enum PaymentComponentType {
|
|
|
2398
2769
|
FIXED_PAYMENT = "FIXED_PAYMENT"
|
|
2399
2770
|
}
|
|
2400
2771
|
export interface ProductCheckboxGroup {
|
|
2401
|
-
/**
|
|
2772
|
+
/**
|
|
2773
|
+
* Label of the field.
|
|
2774
|
+
* @maxLength 350
|
|
2775
|
+
*/
|
|
2402
2776
|
label?: string | null;
|
|
2403
2777
|
/** Description of the field. */
|
|
2404
2778
|
description?: RichContent;
|
|
2405
|
-
/**
|
|
2779
|
+
/**
|
|
2780
|
+
* List of options to select from.
|
|
2781
|
+
* @maxSize 400
|
|
2782
|
+
*/
|
|
2406
2783
|
options?: ProductCheckboxGroupOption[];
|
|
2407
2784
|
/**
|
|
2408
2785
|
* Flag identifying to hide or not label
|
|
@@ -2416,11 +2793,18 @@ export interface ProductCheckboxGroup {
|
|
|
2416
2793
|
imageFit?: ImageFit;
|
|
2417
2794
|
}
|
|
2418
2795
|
export interface ProductCheckboxGroupOption {
|
|
2419
|
-
/**
|
|
2796
|
+
/**
|
|
2797
|
+
* Selectable option label.
|
|
2798
|
+
* @maxLength 400
|
|
2799
|
+
*/
|
|
2420
2800
|
label?: string | null;
|
|
2421
2801
|
/** Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list. */
|
|
2422
2802
|
value?: any;
|
|
2423
|
-
/**
|
|
2803
|
+
/**
|
|
2804
|
+
* Option id. Used as binding for translations.
|
|
2805
|
+
* @format GUID
|
|
2806
|
+
* @immutable
|
|
2807
|
+
*/
|
|
2424
2808
|
_id?: string;
|
|
2425
2809
|
/** Media item. Media, associated with option, like image. */
|
|
2426
2810
|
media?: MediaItem;
|
|
@@ -2435,11 +2819,17 @@ export declare enum ImageFit {
|
|
|
2435
2819
|
CONTAIN = "CONTAIN"
|
|
2436
2820
|
}
|
|
2437
2821
|
export interface DonationInput {
|
|
2438
|
-
/**
|
|
2822
|
+
/**
|
|
2823
|
+
* Label of the field.
|
|
2824
|
+
* @maxLength 350
|
|
2825
|
+
*/
|
|
2439
2826
|
label?: string | null;
|
|
2440
2827
|
/** Description of the field. */
|
|
2441
2828
|
description?: RichContent;
|
|
2442
|
-
/**
|
|
2829
|
+
/**
|
|
2830
|
+
* List of options to select from.
|
|
2831
|
+
* @maxSize 400
|
|
2832
|
+
*/
|
|
2443
2833
|
options?: DonationInputOption[];
|
|
2444
2834
|
/** Option which can be specified by UoU, enabled when this object is specified. */
|
|
2445
2835
|
customOption?: CommonCustomOption;
|
|
@@ -2455,13 +2845,19 @@ export interface DonationInput {
|
|
|
2455
2845
|
showLabel?: boolean | null;
|
|
2456
2846
|
}
|
|
2457
2847
|
export interface DonationInputOption {
|
|
2458
|
-
/**
|
|
2848
|
+
/**
|
|
2849
|
+
* Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list.
|
|
2850
|
+
* @format GUID
|
|
2851
|
+
*/
|
|
2459
2852
|
value?: string;
|
|
2460
2853
|
/** Flag identifying that option should be selected by default */
|
|
2461
2854
|
default?: boolean;
|
|
2462
2855
|
}
|
|
2463
2856
|
export interface PaymentInput {
|
|
2464
|
-
/**
|
|
2857
|
+
/**
|
|
2858
|
+
* Label of the field.
|
|
2859
|
+
* @maxLength 350
|
|
2860
|
+
*/
|
|
2465
2861
|
label?: string | null;
|
|
2466
2862
|
/** Description of the field. */
|
|
2467
2863
|
description?: RichContent;
|
|
@@ -2470,13 +2866,19 @@ export interface PaymentInput {
|
|
|
2470
2866
|
* Default: true
|
|
2471
2867
|
*/
|
|
2472
2868
|
showLabel?: boolean | null;
|
|
2473
|
-
/**
|
|
2869
|
+
/**
|
|
2870
|
+
* Placeholder of custom option input
|
|
2871
|
+
* @maxLength 100
|
|
2872
|
+
*/
|
|
2474
2873
|
placeholder?: string | null;
|
|
2475
2874
|
/** Default value for the payment input */
|
|
2476
2875
|
default?: number | null;
|
|
2477
2876
|
}
|
|
2478
2877
|
export interface FixedPayment {
|
|
2479
|
-
/**
|
|
2878
|
+
/**
|
|
2879
|
+
* Label of the field.
|
|
2880
|
+
* @maxLength 350
|
|
2881
|
+
*/
|
|
2480
2882
|
label?: string | null;
|
|
2481
2883
|
/** Description of the field. */
|
|
2482
2884
|
description?: RichContent;
|
|
@@ -2497,15 +2899,30 @@ export interface Appointment extends AppointmentFormatInfoOneOf {
|
|
|
2497
2899
|
videoConferenceOptions?: VideoConferenceOptions;
|
|
2498
2900
|
/** Phone options for the appointment */
|
|
2499
2901
|
phoneOptions?: PhoneOptions;
|
|
2500
|
-
/**
|
|
2902
|
+
/**
|
|
2903
|
+
* Label of the field
|
|
2904
|
+
* @maxLength 255
|
|
2905
|
+
*/
|
|
2501
2906
|
label?: string | null;
|
|
2502
|
-
/**
|
|
2907
|
+
/**
|
|
2908
|
+
* Name of the appointment
|
|
2909
|
+
* @minLength 1
|
|
2910
|
+
* @maxLength 400
|
|
2911
|
+
*/
|
|
2503
2912
|
name?: string | null;
|
|
2504
|
-
/**
|
|
2913
|
+
/**
|
|
2914
|
+
* Duration of the appointment in minutes
|
|
2915
|
+
* @min 1
|
|
2916
|
+
* @max 44639
|
|
2917
|
+
*/
|
|
2505
2918
|
durationInMinutes?: number | null;
|
|
2506
2919
|
/** Indicates whether manual approval is required for the appointment */
|
|
2507
2920
|
manualApprovalRequired?: boolean | null;
|
|
2508
|
-
/**
|
|
2921
|
+
/**
|
|
2922
|
+
* ID of the staff members providing the appointment
|
|
2923
|
+
* @maxSize 220
|
|
2924
|
+
* @format GUID
|
|
2925
|
+
*/
|
|
2509
2926
|
staffIds?: string[] | null;
|
|
2510
2927
|
/** The format of the appointment */
|
|
2511
2928
|
format?: Format;
|
|
@@ -2520,16 +2937,28 @@ export interface AppointmentFormatInfoOneOf {
|
|
|
2520
2937
|
phoneOptions?: PhoneOptions;
|
|
2521
2938
|
}
|
|
2522
2939
|
export interface Location extends LocationLocationInfoOneOf {
|
|
2523
|
-
/**
|
|
2940
|
+
/**
|
|
2941
|
+
* Custom address details
|
|
2942
|
+
* @maxLength 512
|
|
2943
|
+
*/
|
|
2524
2944
|
customAddress?: string | null;
|
|
2525
|
-
/**
|
|
2945
|
+
/**
|
|
2946
|
+
* ID of a business location
|
|
2947
|
+
* @format GUID
|
|
2948
|
+
*/
|
|
2526
2949
|
businessLocationId?: string | null;
|
|
2527
2950
|
}
|
|
2528
2951
|
/** @oneof */
|
|
2529
2952
|
export interface LocationLocationInfoOneOf {
|
|
2530
|
-
/**
|
|
2953
|
+
/**
|
|
2954
|
+
* Custom address details
|
|
2955
|
+
* @maxLength 512
|
|
2956
|
+
*/
|
|
2531
2957
|
customAddress?: string | null;
|
|
2532
|
-
/**
|
|
2958
|
+
/**
|
|
2959
|
+
* ID of a business location
|
|
2960
|
+
* @format GUID
|
|
2961
|
+
*/
|
|
2533
2962
|
businessLocationId?: string | null;
|
|
2534
2963
|
}
|
|
2535
2964
|
export declare enum Format {
|
|
@@ -2539,15 +2968,25 @@ export declare enum Format {
|
|
|
2539
2968
|
PHONE = "PHONE"
|
|
2540
2969
|
}
|
|
2541
2970
|
export interface InPersonOptions {
|
|
2542
|
-
/**
|
|
2971
|
+
/**
|
|
2972
|
+
* The locations details
|
|
2973
|
+
* @minSize 1
|
|
2974
|
+
* @maxSize 500
|
|
2975
|
+
*/
|
|
2543
2976
|
locations?: Location[];
|
|
2544
2977
|
}
|
|
2545
2978
|
export interface VideoConferenceOptions {
|
|
2546
|
-
/**
|
|
2979
|
+
/**
|
|
2980
|
+
* Description or instructions for the online video conference
|
|
2981
|
+
* @maxLength 512
|
|
2982
|
+
*/
|
|
2547
2983
|
description?: string | null;
|
|
2548
2984
|
}
|
|
2549
2985
|
export interface PhoneOptions {
|
|
2550
|
-
/**
|
|
2986
|
+
/**
|
|
2987
|
+
* Description or instructions for the phone appointment
|
|
2988
|
+
* @maxLength 512
|
|
2989
|
+
*/
|
|
2551
2990
|
description?: string | null;
|
|
2552
2991
|
}
|
|
2553
2992
|
export declare enum MultilineAddressComponentType {
|
|
@@ -2555,7 +2994,10 @@ export declare enum MultilineAddressComponentType {
|
|
|
2555
2994
|
MULTILINE_ADDRESS = "MULTILINE_ADDRESS"
|
|
2556
2995
|
}
|
|
2557
2996
|
export interface MultilineAddress {
|
|
2558
|
-
/**
|
|
2997
|
+
/**
|
|
2998
|
+
* Label of the field.
|
|
2999
|
+
* @maxLength 350
|
|
3000
|
+
*/
|
|
2559
3001
|
label?: string | null;
|
|
2560
3002
|
/** Description of the field. */
|
|
2561
3003
|
description?: RichContent;
|
|
@@ -2581,14 +3023,20 @@ export interface AddressLine2 {
|
|
|
2581
3023
|
show?: boolean;
|
|
2582
3024
|
}
|
|
2583
3025
|
export interface DefaultCountryConfig extends DefaultCountryConfigOptionsOneOf {
|
|
2584
|
-
/**
|
|
3026
|
+
/**
|
|
3027
|
+
* Country.
|
|
3028
|
+
* @format COUNTRY
|
|
3029
|
+
*/
|
|
2585
3030
|
countryOptions?: string;
|
|
2586
3031
|
/** Default country type. */
|
|
2587
3032
|
type?: Type;
|
|
2588
3033
|
}
|
|
2589
3034
|
/** @oneof */
|
|
2590
3035
|
export interface DefaultCountryConfigOptionsOneOf {
|
|
2591
|
-
/**
|
|
3036
|
+
/**
|
|
3037
|
+
* Country.
|
|
3038
|
+
* @format COUNTRY
|
|
3039
|
+
*/
|
|
2592
3040
|
countryOptions?: string;
|
|
2593
3041
|
}
|
|
2594
3042
|
export interface FieldsSettings {
|
|
@@ -2678,7 +3126,11 @@ export interface AddressInfo {
|
|
|
2678
3126
|
tag?: Tag;
|
|
2679
3127
|
}
|
|
2680
3128
|
export interface CustomFieldInfo {
|
|
2681
|
-
/**
|
|
3129
|
+
/**
|
|
3130
|
+
* Custom field key.
|
|
3131
|
+
* @minLength 1
|
|
3132
|
+
* @maxLength 500
|
|
3133
|
+
*/
|
|
2682
3134
|
key?: string;
|
|
2683
3135
|
}
|
|
2684
3136
|
export interface SubscriptionInfo {
|
|
@@ -2897,7 +3349,12 @@ export interface InputField extends InputFieldInputTypeOptionsOneOf {
|
|
|
2897
3349
|
multilineAddressOptions?: InputFieldMultilineAddress;
|
|
2898
3350
|
/** Input returns scheduling as value. */
|
|
2899
3351
|
schedulingOptions?: Scheduling;
|
|
2900
|
-
/**
|
|
3352
|
+
/**
|
|
3353
|
+
* Definition of a target where the value of field belongs.
|
|
3354
|
+
* @minLength 1
|
|
3355
|
+
* @maxLength 200
|
|
3356
|
+
* @immutable
|
|
3357
|
+
*/
|
|
2901
3358
|
target?: string | null;
|
|
2902
3359
|
/**
|
|
2903
3360
|
* Mark the field as containing personal information. This will encrypt user data when storing it.
|
|
@@ -2969,17 +3426,33 @@ export interface RichContentOptions {
|
|
|
2969
3426
|
richContent?: RichContent;
|
|
2970
3427
|
}
|
|
2971
3428
|
export interface PageNavigationOptions {
|
|
2972
|
-
/**
|
|
3429
|
+
/**
|
|
3430
|
+
* When button is not on last page it behaves as switch between pages page, text of label to go to next page.
|
|
3431
|
+
* @maxLength 65
|
|
3432
|
+
*/
|
|
2973
3433
|
nextPageText?: string | null;
|
|
2974
|
-
/**
|
|
3434
|
+
/**
|
|
3435
|
+
* When button is not on last page it behaves as switch between pages page, text of label to go to previous page.
|
|
3436
|
+
* @maxLength 65
|
|
3437
|
+
*/
|
|
2975
3438
|
previousPageText?: string | null;
|
|
2976
|
-
/**
|
|
3439
|
+
/**
|
|
3440
|
+
* Text on the button when button is submitting a form
|
|
3441
|
+
* @maxLength 65
|
|
3442
|
+
*/
|
|
2977
3443
|
submitText?: string | null;
|
|
2978
3444
|
}
|
|
2979
3445
|
export interface Step {
|
|
2980
|
-
/**
|
|
3446
|
+
/**
|
|
3447
|
+
* Step ID.
|
|
3448
|
+
* @format GUID
|
|
3449
|
+
* @immutable
|
|
3450
|
+
*/
|
|
2981
3451
|
_id?: string;
|
|
2982
|
-
/**
|
|
3452
|
+
/**
|
|
3453
|
+
* Name of the step.
|
|
3454
|
+
* @maxLength 200
|
|
3455
|
+
*/
|
|
2983
3456
|
name?: string | null;
|
|
2984
3457
|
/** Is step hidden */
|
|
2985
3458
|
hidden?: boolean;
|
|
@@ -2995,7 +3468,10 @@ export interface FormLayout {
|
|
|
2995
3468
|
small?: BreakPoint;
|
|
2996
3469
|
}
|
|
2997
3470
|
export interface BreakPoint {
|
|
2998
|
-
/**
|
|
3471
|
+
/**
|
|
3472
|
+
* Description of layouts for items.
|
|
3473
|
+
* @maxSize 500
|
|
3474
|
+
*/
|
|
2999
3475
|
items?: ItemLayout[];
|
|
3000
3476
|
/** Amount of columns of layout grid. */
|
|
3001
3477
|
columns?: number | null;
|
|
@@ -3005,11 +3481,17 @@ export interface BreakPoint {
|
|
|
3005
3481
|
margin?: Margin;
|
|
3006
3482
|
/** Description of elements paddings. */
|
|
3007
3483
|
padding?: Margin;
|
|
3008
|
-
/**
|
|
3484
|
+
/**
|
|
3485
|
+
* Sections of the layout, which allow manage fields
|
|
3486
|
+
* @maxSize 100
|
|
3487
|
+
*/
|
|
3009
3488
|
sections?: Section[];
|
|
3010
3489
|
}
|
|
3011
3490
|
export interface ItemLayout extends ItemLayoutItemOneOf {
|
|
3012
|
-
/**
|
|
3491
|
+
/**
|
|
3492
|
+
* Form field reference id.
|
|
3493
|
+
* @format GUID
|
|
3494
|
+
*/
|
|
3013
3495
|
fieldId?: string;
|
|
3014
3496
|
/** Group info, defining that this item is a group of multiple fields */
|
|
3015
3497
|
group?: Group;
|
|
@@ -3024,15 +3506,25 @@ export interface ItemLayout extends ItemLayoutItemOneOf {
|
|
|
3024
3506
|
}
|
|
3025
3507
|
/** @oneof */
|
|
3026
3508
|
export interface ItemLayoutItemOneOf {
|
|
3027
|
-
/**
|
|
3509
|
+
/**
|
|
3510
|
+
* Form field reference id.
|
|
3511
|
+
* @format GUID
|
|
3512
|
+
*/
|
|
3028
3513
|
fieldId?: string;
|
|
3029
3514
|
/** Group info, defining that this item is a group of multiple fields */
|
|
3030
3515
|
group?: Group;
|
|
3031
3516
|
}
|
|
3032
3517
|
export interface Group {
|
|
3033
|
-
/**
|
|
3518
|
+
/**
|
|
3519
|
+
* Field group reference id.
|
|
3520
|
+
* @format GUID
|
|
3521
|
+
*/
|
|
3034
3522
|
groupId?: string;
|
|
3035
|
-
/**
|
|
3523
|
+
/**
|
|
3524
|
+
* Description of layouts for items.
|
|
3525
|
+
* @minSize 1
|
|
3526
|
+
* @maxSize 500
|
|
3527
|
+
*/
|
|
3036
3528
|
items?: ItemLayout[];
|
|
3037
3529
|
}
|
|
3038
3530
|
export interface Margin {
|
|
@@ -3042,7 +3534,11 @@ export interface Margin {
|
|
|
3042
3534
|
vertical?: number | null;
|
|
3043
3535
|
}
|
|
3044
3536
|
export interface Section {
|
|
3045
|
-
/**
|
|
3537
|
+
/**
|
|
3538
|
+
* Id of the section
|
|
3539
|
+
* @format GUID
|
|
3540
|
+
* @minLength 1
|
|
3541
|
+
*/
|
|
3046
3542
|
_id?: string;
|
|
3047
3543
|
/** Horizontal coordinate in the grid. */
|
|
3048
3544
|
row?: number | null;
|
|
@@ -3052,20 +3548,30 @@ export interface Section {
|
|
|
3052
3548
|
* If the section encounters the $new key within the list,
|
|
3053
3549
|
* it allows the inclusion of fields not explicitly listed,
|
|
3054
3550
|
* enabling dynamic addition of new fields.
|
|
3551
|
+
* @maxSize 100
|
|
3552
|
+
* @maxLength 100
|
|
3055
3553
|
*/
|
|
3056
3554
|
allowedFieldIds?: string[];
|
|
3057
3555
|
}
|
|
3058
3556
|
export interface FormRule {
|
|
3059
|
-
/**
|
|
3557
|
+
/**
|
|
3558
|
+
* Id of the rule
|
|
3559
|
+
* @format GUID
|
|
3560
|
+
* @immutable
|
|
3561
|
+
*/
|
|
3060
3562
|
_id?: string;
|
|
3061
3563
|
/** Rule on which item properties or layouts will be changed. */
|
|
3062
3564
|
condition?: Record<string, any> | null;
|
|
3063
3565
|
/**
|
|
3064
3566
|
* Form items with defined properties that will be
|
|
3065
3567
|
* changed when given condition is resolved to true.
|
|
3568
|
+
* @maxSize 500
|
|
3066
3569
|
*/
|
|
3067
3570
|
overrides?: FormOverride[];
|
|
3068
|
-
/**
|
|
3571
|
+
/**
|
|
3572
|
+
* Name of the rule
|
|
3573
|
+
* @maxLength 200
|
|
3574
|
+
*/
|
|
3069
3575
|
name?: string | null;
|
|
3070
3576
|
}
|
|
3071
3577
|
export declare enum OverrideEntityType {
|
|
@@ -3073,15 +3579,28 @@ export declare enum OverrideEntityType {
|
|
|
3073
3579
|
FIELD = "FIELD"
|
|
3074
3580
|
}
|
|
3075
3581
|
export interface FormOverride {
|
|
3076
|
-
/**
|
|
3582
|
+
/**
|
|
3583
|
+
* Override entity type.
|
|
3584
|
+
* @immutable
|
|
3585
|
+
*/
|
|
3077
3586
|
entityType?: OverrideEntityType;
|
|
3078
|
-
/**
|
|
3587
|
+
/**
|
|
3588
|
+
* Overridden entity id. Either fieldId, or "{fieldIdWithNestedForm}/{nestedFormFieldId}"
|
|
3589
|
+
* @immutable
|
|
3590
|
+
* @maxLength 73
|
|
3591
|
+
*/
|
|
3079
3592
|
entityId?: string | null;
|
|
3080
3593
|
/** Form entity properties path with new value, that will be changed on condition. */
|
|
3081
3594
|
valueChanges?: Record<string, any>;
|
|
3082
3595
|
}
|
|
3083
3596
|
export interface FormProperties {
|
|
3084
|
-
/**
|
|
3597
|
+
/**
|
|
3598
|
+
* Form name.
|
|
3599
|
+
* @maxLength 200
|
|
3600
|
+
* @deprecated
|
|
3601
|
+
* @replacedBy wix.forms.v4.Form.name
|
|
3602
|
+
* @targetRemovalDate 2026-01-06
|
|
3603
|
+
*/
|
|
3085
3604
|
name?: string | null;
|
|
3086
3605
|
/**
|
|
3087
3606
|
* Identifies if the form is disabled.
|
|
@@ -3102,12 +3621,18 @@ export interface PostSubmissionTriggers {
|
|
|
3102
3621
|
upsertContact?: UpsertContact;
|
|
3103
3622
|
}
|
|
3104
3623
|
export interface UpsertContact {
|
|
3105
|
-
/**
|
|
3624
|
+
/**
|
|
3625
|
+
* Fields mapping (target field mapped to corresponding contact field).
|
|
3626
|
+
* @maxSize 250
|
|
3627
|
+
*/
|
|
3106
3628
|
fieldsMapping?: Record<string, FormFieldContactInfo>;
|
|
3107
3629
|
/**
|
|
3108
3630
|
* List of contact label keys.
|
|
3109
3631
|
* [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
|
|
3110
3632
|
* help categorize contacts.
|
|
3633
|
+
* @minLength 1
|
|
3634
|
+
* @maxLength 100
|
|
3635
|
+
* @maxSize 20
|
|
3111
3636
|
*/
|
|
3112
3637
|
labels?: string[];
|
|
3113
3638
|
}
|
|
@@ -3123,7 +3648,11 @@ export interface ExtendedFields {
|
|
|
3123
3648
|
namespaces?: Record<string, Record<string, any>>;
|
|
3124
3649
|
}
|
|
3125
3650
|
export interface NestedForm {
|
|
3126
|
-
/**
|
|
3651
|
+
/**
|
|
3652
|
+
* Targets which have this form.
|
|
3653
|
+
* @maxSize 10
|
|
3654
|
+
* @maxLength 200
|
|
3655
|
+
*/
|
|
3127
3656
|
targets?: string[];
|
|
3128
3657
|
/** Nested form. */
|
|
3129
3658
|
form?: Form;
|
|
@@ -3190,37 +3719,67 @@ export interface ThankYouMessageOptions {
|
|
|
3190
3719
|
richContent?: RichContent;
|
|
3191
3720
|
}
|
|
3192
3721
|
export interface RedirectOptions {
|
|
3193
|
-
/**
|
|
3722
|
+
/**
|
|
3723
|
+
* The URL to which the user should be redirected after a successful form submission.
|
|
3724
|
+
* @maxLength 2000
|
|
3725
|
+
*/
|
|
3194
3726
|
redirectUrl?: string | null;
|
|
3195
3727
|
/** How the URL should be opened. */
|
|
3196
3728
|
target?: Target;
|
|
3197
3729
|
}
|
|
3198
3730
|
export interface FieldGroup {
|
|
3199
|
-
/**
|
|
3731
|
+
/**
|
|
3732
|
+
* Id of group, on layout
|
|
3733
|
+
* @format GUID
|
|
3734
|
+
*/
|
|
3200
3735
|
_id?: string;
|
|
3201
|
-
/**
|
|
3736
|
+
/**
|
|
3737
|
+
* Label of group
|
|
3738
|
+
* @maxLength 350
|
|
3739
|
+
*/
|
|
3202
3740
|
label?: string | null;
|
|
3203
3741
|
}
|
|
3204
3742
|
export interface PiiFieldsUpdated {
|
|
3205
|
-
/**
|
|
3743
|
+
/**
|
|
3744
|
+
* Collection of fields which are marked as PII
|
|
3745
|
+
* @maxSize 100
|
|
3746
|
+
* @maxLength 200
|
|
3747
|
+
*/
|
|
3206
3748
|
piiFields?: string[];
|
|
3207
|
-
/**
|
|
3749
|
+
/**
|
|
3750
|
+
* Collection of fields which are non PII
|
|
3751
|
+
* @maxSize 100
|
|
3752
|
+
* @maxLength 200
|
|
3753
|
+
*/
|
|
3208
3754
|
nonPiiFields?: string[];
|
|
3209
3755
|
}
|
|
3210
3756
|
export interface SubmissionKeysPermanentlyDeleted {
|
|
3211
|
-
/**
|
|
3757
|
+
/**
|
|
3758
|
+
* Keys which should be deleted
|
|
3759
|
+
* @maxSize 200
|
|
3760
|
+
* @maxLength 200
|
|
3761
|
+
*/
|
|
3212
3762
|
keys?: string[] | null;
|
|
3213
3763
|
}
|
|
3214
3764
|
export interface FormTranslationChanged {
|
|
3215
3765
|
/** The form with updated translations */
|
|
3216
3766
|
form?: Form;
|
|
3217
|
-
/**
|
|
3767
|
+
/**
|
|
3768
|
+
* Language of the translation
|
|
3769
|
+
* @maxLength 20
|
|
3770
|
+
*/
|
|
3218
3771
|
language?: string;
|
|
3219
3772
|
}
|
|
3220
3773
|
export interface FormTranslationDeleted {
|
|
3221
|
-
/**
|
|
3774
|
+
/**
|
|
3775
|
+
* ID of the form with the deleted translation
|
|
3776
|
+
* @format GUID
|
|
3777
|
+
*/
|
|
3222
3778
|
formId?: string;
|
|
3223
|
-
/**
|
|
3779
|
+
/**
|
|
3780
|
+
* Language of the deleted translation
|
|
3781
|
+
* @maxLength 20
|
|
3782
|
+
*/
|
|
3224
3783
|
language?: string;
|
|
3225
3784
|
}
|
|
3226
3785
|
export interface CreateFormRequest {
|
|
@@ -3232,19 +3791,35 @@ export interface CreateFormResponse {
|
|
|
3232
3791
|
form?: Form;
|
|
3233
3792
|
}
|
|
3234
3793
|
export interface TargetBasedErrorDetails {
|
|
3235
|
-
/**
|
|
3794
|
+
/**
|
|
3795
|
+
* Targets which are related to the error.
|
|
3796
|
+
* @maxSize 100
|
|
3797
|
+
* @maxLength 200
|
|
3798
|
+
*/
|
|
3236
3799
|
targets?: string[];
|
|
3237
3800
|
}
|
|
3238
3801
|
export interface FieldIdBasedErrorDetails {
|
|
3239
|
-
/**
|
|
3802
|
+
/**
|
|
3803
|
+
* Field ids which are related to the error.
|
|
3804
|
+
* @maxSize 100
|
|
3805
|
+
* @format GUID
|
|
3806
|
+
*/
|
|
3240
3807
|
ids?: string[];
|
|
3241
3808
|
}
|
|
3242
3809
|
export interface StepIdBasedErrorDetails {
|
|
3243
|
-
/**
|
|
3810
|
+
/**
|
|
3811
|
+
* Step ids which are related to the error.
|
|
3812
|
+
* @maxSize 100
|
|
3813
|
+
* @format GUID
|
|
3814
|
+
*/
|
|
3244
3815
|
ids?: string[];
|
|
3245
3816
|
}
|
|
3246
3817
|
export interface RuleIdBasedErrorDetails {
|
|
3247
|
-
/**
|
|
3818
|
+
/**
|
|
3819
|
+
* Rule ids which are related to the error.
|
|
3820
|
+
* @maxSize 100
|
|
3821
|
+
* @format GUID
|
|
3822
|
+
*/
|
|
3248
3823
|
ids?: string[];
|
|
3249
3824
|
}
|
|
3250
3825
|
export interface NonExistingNestedFormsErrorDetails {
|
|
@@ -3256,17 +3831,33 @@ export interface NestedFormFieldsMissingErrorDetails {
|
|
|
3256
3831
|
targetToNestedFormFieldIds?: Record<string, FieldIdBasedErrorDetails>;
|
|
3257
3832
|
}
|
|
3258
3833
|
export interface FormFieldV2ApiValidationErrorDetails {
|
|
3259
|
-
/**
|
|
3834
|
+
/**
|
|
3835
|
+
* Field ids which are related to the error.
|
|
3836
|
+
* @maxSize 100
|
|
3837
|
+
* @format GUID
|
|
3838
|
+
*/
|
|
3260
3839
|
ids?: string[];
|
|
3261
|
-
/**
|
|
3840
|
+
/**
|
|
3841
|
+
* Violations which are related to the error.
|
|
3842
|
+
* @maxSize 100
|
|
3843
|
+
* @maxLength 500
|
|
3844
|
+
*/
|
|
3262
3845
|
violations?: string[];
|
|
3263
3846
|
}
|
|
3264
3847
|
export interface ProductIdBasedErrorDetails {
|
|
3265
|
-
/**
|
|
3848
|
+
/**
|
|
3849
|
+
* Product ids which are related to the error.
|
|
3850
|
+
* @maxSize 100
|
|
3851
|
+
* @format GUID
|
|
3852
|
+
*/
|
|
3266
3853
|
ids?: string[];
|
|
3267
3854
|
}
|
|
3268
3855
|
export interface BulkCreateFormRequest {
|
|
3269
|
-
/**
|
|
3856
|
+
/**
|
|
3857
|
+
* Forms to be created.
|
|
3858
|
+
* @minSize 1
|
|
3859
|
+
* @maxSize 30
|
|
3860
|
+
*/
|
|
3270
3861
|
forms?: Form[];
|
|
3271
3862
|
/** When set, items will be returned on successful create */
|
|
3272
3863
|
returnEntity?: boolean;
|
|
@@ -3284,7 +3875,10 @@ export interface BulkFormResult {
|
|
|
3284
3875
|
item?: Form;
|
|
3285
3876
|
}
|
|
3286
3877
|
export interface ItemMetadata {
|
|
3287
|
-
/**
|
|
3878
|
+
/**
|
|
3879
|
+
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
3880
|
+
* @format GUID
|
|
3881
|
+
*/
|
|
3288
3882
|
_id?: string | null;
|
|
3289
3883
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
3290
3884
|
originalIndex?: number;
|
|
@@ -3310,7 +3904,10 @@ export interface BulkActionMetadata {
|
|
|
3310
3904
|
undetailedFailures?: number;
|
|
3311
3905
|
}
|
|
3312
3906
|
export interface CloneFormRequest {
|
|
3313
|
-
/**
|
|
3907
|
+
/**
|
|
3908
|
+
* Id of the form to clone.
|
|
3909
|
+
* @format GUID
|
|
3910
|
+
*/
|
|
3314
3911
|
formId: string;
|
|
3315
3912
|
}
|
|
3316
3913
|
export interface CloneFormResponse {
|
|
@@ -3318,9 +3915,15 @@ export interface CloneFormResponse {
|
|
|
3318
3915
|
form?: Form;
|
|
3319
3916
|
}
|
|
3320
3917
|
export interface CloneFormFromTemplateRequest {
|
|
3321
|
-
/**
|
|
3918
|
+
/**
|
|
3919
|
+
* Namespace of the vertical owning template
|
|
3920
|
+
* @maxLength 50
|
|
3921
|
+
*/
|
|
3322
3922
|
namespace?: string;
|
|
3323
|
-
/**
|
|
3923
|
+
/**
|
|
3924
|
+
* Template id which can be copied
|
|
3925
|
+
* @format GUID
|
|
3926
|
+
*/
|
|
3324
3927
|
templateId?: string;
|
|
3325
3928
|
/**
|
|
3326
3929
|
* When true, will try to create form with same id as template
|
|
@@ -3333,12 +3936,16 @@ export interface CloneFormFromTemplateResponse {
|
|
|
3333
3936
|
form?: Form;
|
|
3334
3937
|
}
|
|
3335
3938
|
export interface GetFormRequest {
|
|
3336
|
-
/**
|
|
3939
|
+
/**
|
|
3940
|
+
* Id of the form to retrieve.
|
|
3941
|
+
* @format GUID
|
|
3942
|
+
*/
|
|
3337
3943
|
formId: string;
|
|
3338
3944
|
/**
|
|
3339
3945
|
* List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
|
|
3340
3946
|
* the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3341
3947
|
* only the form’s base fields are returned.
|
|
3948
|
+
* @maxSize 3
|
|
3342
3949
|
*/
|
|
3343
3950
|
fieldsets?: Fieldset[];
|
|
3344
3951
|
/** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
|
|
@@ -3362,13 +3969,19 @@ export interface UpdateFormResponse {
|
|
|
3362
3969
|
form?: Form;
|
|
3363
3970
|
}
|
|
3364
3971
|
export interface RemoveFormFromTrashBinRequest {
|
|
3365
|
-
/**
|
|
3972
|
+
/**
|
|
3973
|
+
* Id of the form to delete.
|
|
3974
|
+
* @format GUID
|
|
3975
|
+
*/
|
|
3366
3976
|
formId: string;
|
|
3367
3977
|
}
|
|
3368
3978
|
export interface RemoveFormFromTrashBinResponse {
|
|
3369
3979
|
}
|
|
3370
3980
|
export interface DeleteFormRequest {
|
|
3371
|
-
/**
|
|
3981
|
+
/**
|
|
3982
|
+
* Id of the form to delete.
|
|
3983
|
+
* @format GUID
|
|
3984
|
+
*/
|
|
3372
3985
|
formId: string;
|
|
3373
3986
|
/**
|
|
3374
3987
|
* Delete form bypassing trash-bin.
|
|
@@ -3379,7 +3992,10 @@ export interface DeleteFormRequest {
|
|
|
3379
3992
|
export interface DeleteFormResponse {
|
|
3380
3993
|
}
|
|
3381
3994
|
export interface RestoreFromTrashBinRequest {
|
|
3382
|
-
/**
|
|
3995
|
+
/**
|
|
3996
|
+
* Id of the form to restore.
|
|
3997
|
+
* @format GUID
|
|
3998
|
+
*/
|
|
3383
3999
|
formId: string;
|
|
3384
4000
|
}
|
|
3385
4001
|
export interface RestoreFromTrashBinResponse {
|
|
@@ -3393,6 +4009,7 @@ export interface QueryFormsRequest {
|
|
|
3393
4009
|
* List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
|
|
3394
4010
|
* the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3395
4011
|
* only the form’s base fields are returned.
|
|
4012
|
+
* @maxSize 3
|
|
3396
4013
|
*/
|
|
3397
4014
|
fieldsets?: Fieldset[];
|
|
3398
4015
|
/** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
|
|
@@ -3413,6 +4030,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
3413
4030
|
/**
|
|
3414
4031
|
* Sort object in the following format:
|
|
3415
4032
|
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
4033
|
+
* @maxSize 3
|
|
3416
4034
|
*/
|
|
3417
4035
|
sort?: Sorting[];
|
|
3418
4036
|
}
|
|
@@ -3422,7 +4040,10 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
3422
4040
|
cursorPaging?: CursorPaging;
|
|
3423
4041
|
}
|
|
3424
4042
|
export interface Sorting {
|
|
3425
|
-
/**
|
|
4043
|
+
/**
|
|
4044
|
+
* Name of the field to sort by.
|
|
4045
|
+
* @maxLength 512
|
|
4046
|
+
*/
|
|
3426
4047
|
fieldName?: string;
|
|
3427
4048
|
/** Sort order. */
|
|
3428
4049
|
order?: SortOrder;
|
|
@@ -3432,7 +4053,10 @@ export declare enum SortOrder {
|
|
|
3432
4053
|
DESC = "DESC"
|
|
3433
4054
|
}
|
|
3434
4055
|
export interface CursorPaging {
|
|
3435
|
-
/**
|
|
4056
|
+
/**
|
|
4057
|
+
* Number of items to load.
|
|
4058
|
+
* @max 100
|
|
4059
|
+
*/
|
|
3436
4060
|
limit?: number | null;
|
|
3437
4061
|
/**
|
|
3438
4062
|
* Pointer to the next or previous page in the list of results.
|
|
@@ -3440,11 +4064,15 @@ export interface CursorPaging {
|
|
|
3440
4064
|
* You can get the relevant cursor token
|
|
3441
4065
|
* from the `pagingMetadata` object in the previous call's response.
|
|
3442
4066
|
* Not relevant for the first request.
|
|
4067
|
+
* @maxLength 16000
|
|
3443
4068
|
*/
|
|
3444
4069
|
cursor?: string | null;
|
|
3445
4070
|
}
|
|
3446
4071
|
export interface QueryFormsResponse {
|
|
3447
|
-
/**
|
|
4072
|
+
/**
|
|
4073
|
+
* The retrieved forms
|
|
4074
|
+
* @maxSize 100
|
|
4075
|
+
*/
|
|
3448
4076
|
forms?: Form[];
|
|
3449
4077
|
/** Details on the paged set of results returned. */
|
|
3450
4078
|
metadata?: CursorPagingMetadata;
|
|
@@ -3462,15 +4090,28 @@ export interface CursorPagingMetadata {
|
|
|
3462
4090
|
hasNext?: boolean | null;
|
|
3463
4091
|
}
|
|
3464
4092
|
export interface Cursors {
|
|
3465
|
-
/**
|
|
4093
|
+
/**
|
|
4094
|
+
* Cursor pointing to next page in the list of results.
|
|
4095
|
+
* @maxLength 16000
|
|
4096
|
+
*/
|
|
3466
4097
|
next?: string | null;
|
|
3467
|
-
/**
|
|
4098
|
+
/**
|
|
4099
|
+
* Cursor pointing to previous page in the list of results.
|
|
4100
|
+
* @maxLength 16000
|
|
4101
|
+
*/
|
|
3468
4102
|
prev?: string | null;
|
|
3469
4103
|
}
|
|
3470
4104
|
export interface CountFormsRequest {
|
|
3471
|
-
/**
|
|
4105
|
+
/**
|
|
4106
|
+
* Namespace name.
|
|
4107
|
+
* @minLength 10
|
|
4108
|
+
* @maxLength 50
|
|
4109
|
+
*/
|
|
3472
4110
|
namespace: string;
|
|
3473
|
-
/**
|
|
4111
|
+
/**
|
|
4112
|
+
* Fieldsets.
|
|
4113
|
+
* @maxSize 3
|
|
4114
|
+
*/
|
|
3474
4115
|
fieldsets?: CountFormsFieldset[];
|
|
3475
4116
|
}
|
|
3476
4117
|
export declare enum CountFormsFieldset {
|
|
@@ -3489,7 +4130,11 @@ export interface CountFormsResponse {
|
|
|
3489
4130
|
deletedCount?: number | null;
|
|
3490
4131
|
}
|
|
3491
4132
|
export interface ListTemplateExtensionsRequest {
|
|
3492
|
-
/**
|
|
4133
|
+
/**
|
|
4134
|
+
* Namespace name.
|
|
4135
|
+
* @minLength 10
|
|
4136
|
+
* @maxLength 50
|
|
4137
|
+
*/
|
|
3493
4138
|
namespace?: string;
|
|
3494
4139
|
/** Identifies if the form is disabled. */
|
|
3495
4140
|
disabled?: boolean | null;
|
|
@@ -3512,15 +4157,25 @@ export interface ListTemplateExtensionsRequest {
|
|
|
3512
4157
|
* List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
|
|
3513
4158
|
* the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3514
4159
|
* only the form’s base fields are returned.
|
|
4160
|
+
* @maxSize 3
|
|
3515
4161
|
*/
|
|
3516
4162
|
fieldsets?: Fieldset[];
|
|
3517
|
-
/**
|
|
4163
|
+
/**
|
|
4164
|
+
* Form ids.
|
|
4165
|
+
* @maxSize 10
|
|
4166
|
+
* @format GUID
|
|
4167
|
+
*/
|
|
3518
4168
|
formIds?: string[];
|
|
3519
4169
|
/** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
|
|
3520
4170
|
additionalMetadata?: Record<string, any> | null;
|
|
3521
4171
|
/** Filter by name */
|
|
3522
4172
|
nameFilter?: NameFilter;
|
|
3523
|
-
/**
|
|
4173
|
+
/**
|
|
4174
|
+
* List of templates id, which extensions expected
|
|
4175
|
+
* @minSize 1
|
|
4176
|
+
* @maxSize 100
|
|
4177
|
+
* @format GUID
|
|
4178
|
+
*/
|
|
3524
4179
|
templateIds?: string[];
|
|
3525
4180
|
}
|
|
3526
4181
|
export declare enum ListFormsOrder {
|
|
@@ -3540,7 +4195,10 @@ export declare enum ListFormsOrder {
|
|
|
3540
4195
|
export interface NameFilter {
|
|
3541
4196
|
/** Type of filter */
|
|
3542
4197
|
filterType?: FilterType;
|
|
3543
|
-
/**
|
|
4198
|
+
/**
|
|
4199
|
+
* Expected name
|
|
4200
|
+
* @maxLength 200
|
|
4201
|
+
*/
|
|
3544
4202
|
name?: string;
|
|
3545
4203
|
}
|
|
3546
4204
|
export declare enum FilterType {
|
|
@@ -3548,13 +4206,20 @@ export declare enum FilterType {
|
|
|
3548
4206
|
STARTS_WITH = "STARTS_WITH"
|
|
3549
4207
|
}
|
|
3550
4208
|
export interface ListTemplateExtensionsResponse {
|
|
3551
|
-
/**
|
|
4209
|
+
/**
|
|
4210
|
+
* The retrieved forms.
|
|
4211
|
+
* @maxSize 100
|
|
4212
|
+
*/
|
|
3552
4213
|
forms?: Form[];
|
|
3553
4214
|
/** Details on the paged set of results returned. */
|
|
3554
4215
|
pagingMetadata?: CursorPagingMetadata;
|
|
3555
4216
|
}
|
|
3556
4217
|
export interface ListFormsRequest {
|
|
3557
|
-
/**
|
|
4218
|
+
/**
|
|
4219
|
+
* Namespace name.
|
|
4220
|
+
* @minLength 10
|
|
4221
|
+
* @maxLength 50
|
|
4222
|
+
*/
|
|
3558
4223
|
namespace: string;
|
|
3559
4224
|
/**
|
|
3560
4225
|
* Identifies if the form is disabled.
|
|
@@ -3582,9 +4247,14 @@ export interface ListFormsRequest {
|
|
|
3582
4247
|
* List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
|
|
3583
4248
|
* the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3584
4249
|
* only the form’s base fields are returned.
|
|
4250
|
+
* @maxSize 3
|
|
3585
4251
|
*/
|
|
3586
4252
|
fieldsets?: Fieldset[];
|
|
3587
|
-
/**
|
|
4253
|
+
/**
|
|
4254
|
+
* Form ids.
|
|
4255
|
+
* @maxSize 10
|
|
4256
|
+
* @format GUID
|
|
4257
|
+
*/
|
|
3588
4258
|
formIds?: string[];
|
|
3589
4259
|
/** Identifies if the form is a payment form */
|
|
3590
4260
|
paymentForm?: boolean | null;
|
|
@@ -3613,13 +4283,19 @@ export declare enum ListFormsRequestListFormsOrder {
|
|
|
3613
4283
|
NAME_DESC = "NAME_DESC"
|
|
3614
4284
|
}
|
|
3615
4285
|
export interface ListFormsResponse {
|
|
3616
|
-
/**
|
|
4286
|
+
/**
|
|
4287
|
+
* The retrieved forms.
|
|
4288
|
+
* @maxSize 100
|
|
4289
|
+
*/
|
|
3617
4290
|
forms?: Form[];
|
|
3618
4291
|
/** Details on the paged set of results returned. */
|
|
3619
4292
|
pagingMetadata?: CursorPagingMetadata;
|
|
3620
4293
|
}
|
|
3621
4294
|
export interface GetDeletedFormRequest {
|
|
3622
|
-
/**
|
|
4295
|
+
/**
|
|
4296
|
+
* Id of the Form to retrieve
|
|
4297
|
+
* @format GUID
|
|
4298
|
+
*/
|
|
3623
4299
|
formId: string;
|
|
3624
4300
|
}
|
|
3625
4301
|
export interface GetDeletedFormResponse {
|
|
@@ -3631,17 +4307,28 @@ export interface QueryDeletedFormsRequest {
|
|
|
3631
4307
|
query: CursorQuery;
|
|
3632
4308
|
}
|
|
3633
4309
|
export interface QueryDeletedFormsResponse {
|
|
3634
|
-
/**
|
|
4310
|
+
/**
|
|
4311
|
+
* The retrieved Forms
|
|
4312
|
+
* @maxSize 100
|
|
4313
|
+
*/
|
|
3635
4314
|
forms?: Form[];
|
|
3636
4315
|
/** Details on the paged set of results returned. */
|
|
3637
4316
|
metadata?: CursorPagingMetadata;
|
|
3638
4317
|
}
|
|
3639
4318
|
export interface ListDeletedFormsRequest {
|
|
3640
|
-
/**
|
|
4319
|
+
/**
|
|
4320
|
+
* Namespace name.
|
|
4321
|
+
* @minLength 10
|
|
4322
|
+
* @maxLength 50
|
|
4323
|
+
*/
|
|
3641
4324
|
namespace: string;
|
|
3642
4325
|
/** Identifies if the form is disabled. */
|
|
3643
4326
|
disabled?: boolean | null;
|
|
3644
|
-
/**
|
|
4327
|
+
/**
|
|
4328
|
+
* Form ids.
|
|
4329
|
+
* @maxSize 100
|
|
4330
|
+
* @format GUID
|
|
4331
|
+
*/
|
|
3645
4332
|
formIds?: string[];
|
|
3646
4333
|
/**
|
|
3647
4334
|
* Ordering options.
|
|
@@ -3670,15 +4357,25 @@ export declare enum ListDeletedFormsOrder {
|
|
|
3670
4357
|
NAME_ASC = "NAME_ASC"
|
|
3671
4358
|
}
|
|
3672
4359
|
export interface ListDeletedFormsResponse {
|
|
3673
|
-
/**
|
|
4360
|
+
/**
|
|
4361
|
+
* The retrieved forms.
|
|
4362
|
+
* @maxSize 100
|
|
4363
|
+
*/
|
|
3674
4364
|
forms?: Form[];
|
|
3675
4365
|
/** Details on the paged set of results returned. */
|
|
3676
4366
|
pagingMetadata?: CursorPagingMetadata;
|
|
3677
4367
|
}
|
|
3678
4368
|
export interface BulkRemoveDeletedFieldRequest {
|
|
3679
|
-
/**
|
|
4369
|
+
/**
|
|
4370
|
+
* Id of the form to delete.
|
|
4371
|
+
* @format GUID
|
|
4372
|
+
*/
|
|
3680
4373
|
formId: string;
|
|
3681
|
-
/**
|
|
4374
|
+
/**
|
|
4375
|
+
* Ids of the deleted fields to remove.
|
|
4376
|
+
* @maxSize 100
|
|
4377
|
+
* @format GUID
|
|
4378
|
+
*/
|
|
3682
4379
|
fieldsIds?: string[];
|
|
3683
4380
|
}
|
|
3684
4381
|
export interface BulkRemoveDeletedFieldResponse {
|
|
@@ -3694,7 +4391,11 @@ export interface UpdateExtendedFieldsRequest {
|
|
|
3694
4391
|
namespaceData: Record<string, any> | null;
|
|
3695
4392
|
}
|
|
3696
4393
|
export interface UpdateExtendedFieldsResponse {
|
|
3697
|
-
/**
|
|
4394
|
+
/**
|
|
4395
|
+
* namespace that was updated
|
|
4396
|
+
* @minLength 10
|
|
4397
|
+
* @maxLength 50
|
|
4398
|
+
*/
|
|
3698
4399
|
namespace?: string;
|
|
3699
4400
|
/** only data from UpdateExtendedFieldsRequest namespace_data */
|
|
3700
4401
|
namespaceData?: Record<string, any> | null;
|
|
@@ -3702,23 +4403,42 @@ export interface UpdateExtendedFieldsResponse {
|
|
|
3702
4403
|
export interface ListFormsProvidersConfigsRequest {
|
|
3703
4404
|
}
|
|
3704
4405
|
export interface ListFormsProvidersConfigsResponse {
|
|
3705
|
-
/**
|
|
4406
|
+
/**
|
|
4407
|
+
* List of configs set by form providers
|
|
4408
|
+
* @maxSize 50
|
|
4409
|
+
*/
|
|
3706
4410
|
configs?: FormsSchemaProvidersConfig[];
|
|
3707
4411
|
}
|
|
3708
4412
|
export interface FormsSchemaProvidersConfig {
|
|
3709
|
-
/**
|
|
4413
|
+
/**
|
|
4414
|
+
* Namespace which can be used to create form
|
|
4415
|
+
* @maxLength 50
|
|
4416
|
+
*/
|
|
3710
4417
|
namespace?: string;
|
|
3711
|
-
/**
|
|
4418
|
+
/**
|
|
4419
|
+
* Id of app which provides this config.
|
|
4420
|
+
* @maxLength 36
|
|
4421
|
+
*/
|
|
3712
4422
|
appId?: string;
|
|
3713
4423
|
/** Restrictions associated with this namespace. */
|
|
3714
4424
|
restrictions?: FormProviderRestrictions;
|
|
3715
4425
|
}
|
|
3716
4426
|
export interface FormProviderRestrictions {
|
|
3717
|
-
/**
|
|
4427
|
+
/**
|
|
4428
|
+
* Maximum amount of forms allowed per namespace.
|
|
4429
|
+
* @max 15000
|
|
4430
|
+
*/
|
|
3718
4431
|
maxFormsAmount?: number;
|
|
3719
|
-
/**
|
|
4432
|
+
/**
|
|
4433
|
+
* Maximum amount of fields allowed per form.
|
|
4434
|
+
* @max 200
|
|
4435
|
+
*/
|
|
3720
4436
|
maxFieldsAmount?: number;
|
|
3721
|
-
/**
|
|
4437
|
+
/**
|
|
4438
|
+
* Maximum amount of deleted forms allowed per namespace.
|
|
4439
|
+
* @min 1000
|
|
4440
|
+
* @max 1000
|
|
4441
|
+
*/
|
|
3722
4442
|
maxDeletedFormsAmount?: number | null;
|
|
3723
4443
|
}
|
|
3724
4444
|
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
@@ -3794,7 +4514,10 @@ export interface ActionEvent {
|
|
|
3794
4514
|
export interface Empty {
|
|
3795
4515
|
}
|
|
3796
4516
|
export interface GetFormSummaryRequest {
|
|
3797
|
-
/**
|
|
4517
|
+
/**
|
|
4518
|
+
* Id of the form to retrieve.
|
|
4519
|
+
* @format GUID
|
|
4520
|
+
*/
|
|
3798
4521
|
formId: string;
|
|
3799
4522
|
}
|
|
3800
4523
|
export interface GetFormSummaryResponse {
|
|
@@ -3802,9 +4525,15 @@ export interface GetFormSummaryResponse {
|
|
|
3802
4525
|
formSummary?: FormSummary;
|
|
3803
4526
|
}
|
|
3804
4527
|
export interface FormSummary {
|
|
3805
|
-
/**
|
|
4528
|
+
/**
|
|
4529
|
+
* Form ID.
|
|
4530
|
+
* @format GUID
|
|
4531
|
+
*/
|
|
3806
4532
|
_id?: string;
|
|
3807
|
-
/**
|
|
4533
|
+
/**
|
|
4534
|
+
* Summarized form fields.
|
|
4535
|
+
* @maxSize 500
|
|
4536
|
+
*/
|
|
3808
4537
|
fields?: Field[];
|
|
3809
4538
|
}
|
|
3810
4539
|
export declare enum FieldInputType {
|
|
@@ -3834,32 +4563,57 @@ export declare enum FieldInputType {
|
|
|
3834
4563
|
DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
|
|
3835
4564
|
}
|
|
3836
4565
|
export interface FieldOption {
|
|
3837
|
-
/**
|
|
4566
|
+
/**
|
|
4567
|
+
* Selectable option label
|
|
4568
|
+
* @maxLength 400
|
|
4569
|
+
*/
|
|
3838
4570
|
label?: string | null;
|
|
3839
|
-
/**
|
|
4571
|
+
/**
|
|
4572
|
+
* Selectable option value, which is saved to DB.
|
|
4573
|
+
* @maxLength 400
|
|
4574
|
+
*/
|
|
3840
4575
|
value?: string | null;
|
|
3841
4576
|
}
|
|
3842
4577
|
export interface Field {
|
|
3843
|
-
/**
|
|
4578
|
+
/**
|
|
4579
|
+
* Definition of a target where the value of field belongs.
|
|
4580
|
+
* @maxLength 200
|
|
4581
|
+
* @immutable
|
|
4582
|
+
*/
|
|
3844
4583
|
target?: string | null;
|
|
3845
|
-
/**
|
|
4584
|
+
/**
|
|
4585
|
+
* Label of the field
|
|
4586
|
+
* @maxLength 350
|
|
4587
|
+
*/
|
|
3846
4588
|
label?: string | null;
|
|
3847
4589
|
/** Input type of the field */
|
|
3848
4590
|
type?: FieldInputType;
|
|
3849
|
-
/**
|
|
4591
|
+
/**
|
|
4592
|
+
* List of options to select from
|
|
4593
|
+
* @maxSize 400
|
|
4594
|
+
*/
|
|
3850
4595
|
options?: FieldOption[];
|
|
3851
4596
|
/**
|
|
3852
4597
|
* Flag indicating whether field is deleted.
|
|
3853
4598
|
* Default: false.
|
|
3854
4599
|
*/
|
|
3855
4600
|
deleted?: boolean;
|
|
3856
|
-
/**
|
|
4601
|
+
/**
|
|
4602
|
+
* Id of the field.
|
|
4603
|
+
* @format GUID
|
|
4604
|
+
*/
|
|
3857
4605
|
_id?: string;
|
|
3858
4606
|
}
|
|
3859
4607
|
export interface MessageEnvelope {
|
|
3860
|
-
/**
|
|
4608
|
+
/**
|
|
4609
|
+
* App instance ID.
|
|
4610
|
+
* @format GUID
|
|
4611
|
+
*/
|
|
3861
4612
|
instanceId?: string | null;
|
|
3862
|
-
/**
|
|
4613
|
+
/**
|
|
4614
|
+
* Event type.
|
|
4615
|
+
* @maxLength 150
|
|
4616
|
+
*/
|
|
3863
4617
|
eventType?: string;
|
|
3864
4618
|
/** The identification type and identity data. */
|
|
3865
4619
|
identity?: IdentificationData;
|
|
@@ -3867,26 +4621,50 @@ export interface MessageEnvelope {
|
|
|
3867
4621
|
data?: string;
|
|
3868
4622
|
}
|
|
3869
4623
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3870
|
-
/**
|
|
4624
|
+
/**
|
|
4625
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4626
|
+
* @format GUID
|
|
4627
|
+
*/
|
|
3871
4628
|
anonymousVisitorId?: string;
|
|
3872
|
-
/**
|
|
4629
|
+
/**
|
|
4630
|
+
* ID of a site visitor that has logged in to the site.
|
|
4631
|
+
* @format GUID
|
|
4632
|
+
*/
|
|
3873
4633
|
memberId?: string;
|
|
3874
|
-
/**
|
|
4634
|
+
/**
|
|
4635
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4636
|
+
* @format GUID
|
|
4637
|
+
*/
|
|
3875
4638
|
wixUserId?: string;
|
|
3876
|
-
/**
|
|
4639
|
+
/**
|
|
4640
|
+
* ID of an app.
|
|
4641
|
+
* @format GUID
|
|
4642
|
+
*/
|
|
3877
4643
|
appId?: string;
|
|
3878
4644
|
/** @readonly */
|
|
3879
4645
|
identityType?: WebhookIdentityType;
|
|
3880
4646
|
}
|
|
3881
4647
|
/** @oneof */
|
|
3882
4648
|
export interface IdentificationDataIdOneOf {
|
|
3883
|
-
/**
|
|
4649
|
+
/**
|
|
4650
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4651
|
+
* @format GUID
|
|
4652
|
+
*/
|
|
3884
4653
|
anonymousVisitorId?: string;
|
|
3885
|
-
/**
|
|
4654
|
+
/**
|
|
4655
|
+
* ID of a site visitor that has logged in to the site.
|
|
4656
|
+
* @format GUID
|
|
4657
|
+
*/
|
|
3886
4658
|
memberId?: string;
|
|
3887
|
-
/**
|
|
4659
|
+
/**
|
|
4660
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4661
|
+
* @format GUID
|
|
4662
|
+
*/
|
|
3888
4663
|
wixUserId?: string;
|
|
3889
|
-
/**
|
|
4664
|
+
/**
|
|
4665
|
+
* ID of an app.
|
|
4666
|
+
* @format GUID
|
|
4667
|
+
*/
|
|
3890
4668
|
appId?: string;
|
|
3891
4669
|
}
|
|
3892
4670
|
export declare enum WebhookIdentityType {
|
|
@@ -4658,7 +5436,11 @@ export declare function createForm(form: Form): Promise<Form & FormNonNullableFi
|
|
|
4658
5436
|
*/
|
|
4659
5437
|
export declare function bulkCreateForm(options?: BulkCreateFormOptions): Promise<BulkCreateFormResponse & BulkCreateFormResponseNonNullableFields>;
|
|
4660
5438
|
export interface BulkCreateFormOptions {
|
|
4661
|
-
/**
|
|
5439
|
+
/**
|
|
5440
|
+
* Forms to be created.
|
|
5441
|
+
* @minSize 1
|
|
5442
|
+
* @maxSize 30
|
|
5443
|
+
*/
|
|
4662
5444
|
forms?: Form[];
|
|
4663
5445
|
/** When set, items will be returned on successful create */
|
|
4664
5446
|
returnEntity?: boolean;
|
|
@@ -4682,6 +5464,8 @@ export declare function cloneForm(formId: string): Promise<CloneFormResponse & C
|
|
|
4682
5464
|
* @permissionId WIX_FORMS.FORM_SCHEMA_READ
|
|
4683
5465
|
* @permissionScope Manage Submissions
|
|
4684
5466
|
* @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
|
|
5467
|
+
* @permissionScope Set Up Automations
|
|
5468
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4685
5469
|
* @applicableIdentity APP
|
|
4686
5470
|
* @applicableIdentity VISITOR
|
|
4687
5471
|
* @returns The retrieved form.
|
|
@@ -4693,6 +5477,7 @@ export interface GetFormOptions {
|
|
|
4693
5477
|
* List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
|
|
4694
5478
|
* the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
4695
5479
|
* only the form’s base fields are returned.
|
|
5480
|
+
* @maxSize 3
|
|
4696
5481
|
*/
|
|
4697
5482
|
fieldsets?: Fieldset[];
|
|
4698
5483
|
/** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
|
|
@@ -4717,17 +5502,25 @@ export declare function updateForm(_id: string | null, form: UpdateForm): Promis
|
|
|
4717
5502
|
export interface UpdateForm {
|
|
4718
5503
|
/**
|
|
4719
5504
|
* Form ID.
|
|
5505
|
+
* @format GUID
|
|
4720
5506
|
* @readonly
|
|
4721
5507
|
*/
|
|
4722
5508
|
_id?: string | null;
|
|
4723
5509
|
/**
|
|
4724
5510
|
* List of form fields that represent input elements.
|
|
5511
|
+
* @maxSize 500
|
|
4725
5512
|
* @readonly
|
|
4726
5513
|
*/
|
|
4727
5514
|
fieldsV2?: FormFieldV2[];
|
|
4728
|
-
/**
|
|
5515
|
+
/**
|
|
5516
|
+
* Defines the layout for form fields in each submission step.
|
|
5517
|
+
* @maxSize 100
|
|
5518
|
+
*/
|
|
4729
5519
|
steps?: Step[];
|
|
4730
|
-
/**
|
|
5520
|
+
/**
|
|
5521
|
+
* Form rules, can be applied to layout and items properties.
|
|
5522
|
+
* @maxSize 100
|
|
5523
|
+
*/
|
|
4731
5524
|
rules?: FormRule[];
|
|
4732
5525
|
/**
|
|
4733
5526
|
* Represents the current state of an item. Each time the item is modified, its `revision` changes. For an update operation to succeed, you MUST pass the latest revision.
|
|
@@ -4748,20 +5541,28 @@ export interface UpdateForm {
|
|
|
4748
5541
|
properties?: FormProperties;
|
|
4749
5542
|
/**
|
|
4750
5543
|
* Fields which were soft deleted.
|
|
5544
|
+
* @maxSize 150
|
|
4751
5545
|
* @readonly
|
|
4752
5546
|
*/
|
|
4753
5547
|
deletedFields?: FormField[];
|
|
4754
5548
|
/**
|
|
4755
5549
|
* List of form fields that represent input elements.
|
|
5550
|
+
* @maxSize 150
|
|
4756
5551
|
* @readonly
|
|
4757
5552
|
*/
|
|
4758
5553
|
deletedFieldsV2?: FormFieldV2[];
|
|
4759
5554
|
/** Data extensions ExtendedFields. */
|
|
4760
5555
|
extendedFields?: ExtendedFields;
|
|
4761
|
-
/**
|
|
5556
|
+
/**
|
|
5557
|
+
* Identifies the namespace that the form belongs to.
|
|
5558
|
+
* @minLength 10
|
|
5559
|
+
* @maxLength 50
|
|
5560
|
+
* @immutable
|
|
5561
|
+
*/
|
|
4762
5562
|
namespace?: string;
|
|
4763
5563
|
/**
|
|
4764
5564
|
* Media folder ID.
|
|
5565
|
+
* @maxLength 100
|
|
4765
5566
|
* @readonly
|
|
4766
5567
|
*/
|
|
4767
5568
|
mediaFolderId?: string | null;
|
|
@@ -4776,15 +5577,23 @@ export interface UpdateForm {
|
|
|
4776
5577
|
requiredIndicatorProperties?: RequiredIndicatorProperties;
|
|
4777
5578
|
/** Settings for actions to be taken after form submission. */
|
|
4778
5579
|
submitSettings?: SubmitSettings;
|
|
4779
|
-
/**
|
|
5580
|
+
/**
|
|
5581
|
+
* Settings for field groups
|
|
5582
|
+
* @maxSize 50
|
|
5583
|
+
*/
|
|
4780
5584
|
fieldGroups?: FieldGroup[];
|
|
4781
5585
|
/** Message shown when the form is disabled */
|
|
4782
5586
|
disabledFormMessage?: RichContent;
|
|
4783
5587
|
/**
|
|
4784
|
-
* Identifies if the form is
|
|
5588
|
+
* Identifies if the form is enabled.
|
|
4785
5589
|
* Default true
|
|
4786
5590
|
*/
|
|
4787
5591
|
enabled?: boolean | null;
|
|
5592
|
+
/**
|
|
5593
|
+
* Form name.
|
|
5594
|
+
* @maxLength 200
|
|
5595
|
+
*/
|
|
5596
|
+
name?: string | null;
|
|
4788
5597
|
}
|
|
4789
5598
|
/**
|
|
4790
5599
|
* Deletes a form. It is stored in trash for 90 days.
|
|
@@ -4831,6 +5640,8 @@ export declare function restoreFromTrashBin(formId: string): Promise<RestoreFrom
|
|
|
4831
5640
|
* @documentationMaturity preview
|
|
4832
5641
|
* @permissionScope Manage Submissions
|
|
4833
5642
|
* @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
|
|
5643
|
+
* @permissionScope Set Up Automations
|
|
5644
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4834
5645
|
* @permissionId WIX_FORMS.FORM_SCHEMA_READ
|
|
4835
5646
|
* @applicableIdentity APP
|
|
4836
5647
|
* @applicableIdentity VISITOR
|
|
@@ -4842,6 +5653,7 @@ export interface QueryFormsOptions {
|
|
|
4842
5653
|
* List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
|
|
4843
5654
|
* the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
4844
5655
|
* only the form’s base fields are returned.
|
|
5656
|
+
* @maxSize 3
|
|
4845
5657
|
*/
|
|
4846
5658
|
fieldsets?: Fieldset[] | undefined;
|
|
4847
5659
|
/** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
|
|
@@ -4926,13 +5738,18 @@ export interface FormsQueryBuilder {
|
|
|
4926
5738
|
* @permissionId WIX_FORMS.FORM_SCHEMA_READ
|
|
4927
5739
|
* @permissionScope Manage Submissions
|
|
4928
5740
|
* @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
|
|
5741
|
+
* @permissionScope Set Up Automations
|
|
5742
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4929
5743
|
* @applicableIdentity APP
|
|
4930
5744
|
* @applicableIdentity VISITOR
|
|
4931
5745
|
* @fqn wix.forms.v4.FormSchemaService.CountForms
|
|
4932
5746
|
*/
|
|
4933
5747
|
export declare function countForms(namespace: string, options?: CountFormsOptions): Promise<CountFormsResponse & CountFormsResponseNonNullableFields>;
|
|
4934
5748
|
export interface CountFormsOptions {
|
|
4935
|
-
/**
|
|
5749
|
+
/**
|
|
5750
|
+
* Fieldsets.
|
|
5751
|
+
* @maxSize 3
|
|
5752
|
+
*/
|
|
4936
5753
|
fieldsets?: CountFormsFieldset[];
|
|
4937
5754
|
}
|
|
4938
5755
|
/**
|
|
@@ -4945,6 +5762,8 @@ export interface CountFormsOptions {
|
|
|
4945
5762
|
* @permissionId WIX_FORMS.FORM_SCHEMA_READ
|
|
4946
5763
|
* @permissionScope Manage Submissions
|
|
4947
5764
|
* @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
|
|
5765
|
+
* @permissionScope Set Up Automations
|
|
5766
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
4948
5767
|
* @applicableIdentity APP
|
|
4949
5768
|
* @applicableIdentity VISITOR
|
|
4950
5769
|
* @fqn wix.forms.v4.FormSchemaService.ListForms
|
|
@@ -4977,9 +5796,14 @@ export interface ListFormsOptions {
|
|
|
4977
5796
|
* List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
|
|
4978
5797
|
* the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
4979
5798
|
* only the form’s base fields are returned.
|
|
5799
|
+
* @maxSize 3
|
|
4980
5800
|
*/
|
|
4981
5801
|
fieldsets?: Fieldset[];
|
|
4982
|
-
/**
|
|
5802
|
+
/**
|
|
5803
|
+
* Form ids.
|
|
5804
|
+
* @maxSize 10
|
|
5805
|
+
* @format GUID
|
|
5806
|
+
*/
|
|
4983
5807
|
formIds?: string[];
|
|
4984
5808
|
/** Identifies if the form is a payment form */
|
|
4985
5809
|
paymentForm?: boolean | null;
|
|
@@ -5002,6 +5826,8 @@ export interface ListFormsOptions {
|
|
|
5002
5826
|
* @permissionId WIX_FORMS.FORM_SCHEMA_READ
|
|
5003
5827
|
* @permissionScope Manage Submissions
|
|
5004
5828
|
* @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
|
|
5829
|
+
* @permissionScope Set Up Automations
|
|
5830
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
5005
5831
|
* @applicableIdentity APP
|
|
5006
5832
|
* @applicableIdentity VISITOR
|
|
5007
5833
|
* @fqn wix.forms.v4.FormSchemaService.GetDeletedForm
|
|
@@ -5016,6 +5842,8 @@ export declare function getDeletedForm(formId: string): Promise<GetDeletedFormRe
|
|
|
5016
5842
|
* @permissionId WIX_FORMS.FORM_SCHEMA_READ
|
|
5017
5843
|
* @permissionScope Manage Submissions
|
|
5018
5844
|
* @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
|
|
5845
|
+
* @permissionScope Set Up Automations
|
|
5846
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
5019
5847
|
* @applicableIdentity APP
|
|
5020
5848
|
* @applicableIdentity VISITOR
|
|
5021
5849
|
* @fqn wix.forms.v4.FormSchemaService.QueryDeletedForms
|
|
@@ -5030,6 +5858,8 @@ export declare function queryDeletedForms(query: CursorQuery): Promise<QueryDele
|
|
|
5030
5858
|
* @permissionId WIX_FORMS.FORM_SCHEMA_READ
|
|
5031
5859
|
* @permissionScope Manage Submissions
|
|
5032
5860
|
* @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
|
|
5861
|
+
* @permissionScope Set Up Automations
|
|
5862
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
5033
5863
|
* @applicableIdentity APP
|
|
5034
5864
|
* @applicableIdentity VISITOR
|
|
5035
5865
|
* @fqn wix.forms.v4.FormSchemaService.ListDeletedForms
|
|
@@ -5038,7 +5868,11 @@ export declare function listDeletedForms(namespace: string, options?: ListDelete
|
|
|
5038
5868
|
export interface ListDeletedFormsOptions {
|
|
5039
5869
|
/** Identifies if the form is disabled. */
|
|
5040
5870
|
disabled?: boolean | null;
|
|
5041
|
-
/**
|
|
5871
|
+
/**
|
|
5872
|
+
* Form ids.
|
|
5873
|
+
* @maxSize 100
|
|
5874
|
+
* @format GUID
|
|
5875
|
+
*/
|
|
5042
5876
|
formIds?: string[];
|
|
5043
5877
|
/**
|
|
5044
5878
|
* Ordering options.
|
|
@@ -5067,7 +5901,11 @@ export interface ListDeletedFormsOptions {
|
|
|
5067
5901
|
*/
|
|
5068
5902
|
export declare function bulkRemoveDeletedField(formId: string, options?: BulkRemoveDeletedFieldOptions): Promise<BulkRemoveDeletedFieldResponse & BulkRemoveDeletedFieldResponseNonNullableFields>;
|
|
5069
5903
|
export interface BulkRemoveDeletedFieldOptions {
|
|
5070
|
-
/**
|
|
5904
|
+
/**
|
|
5905
|
+
* Ids of the deleted fields to remove.
|
|
5906
|
+
* @maxSize 100
|
|
5907
|
+
* @format GUID
|
|
5908
|
+
*/
|
|
5071
5909
|
fieldsIds?: string[];
|
|
5072
5910
|
}
|
|
5073
5911
|
/**
|
|
@@ -5105,6 +5943,8 @@ export declare function listFormsProvidersConfigs(): Promise<ListFormsProvidersC
|
|
|
5105
5943
|
* @permissionId WIX_FORMS.FORM_SCHEMA_READ
|
|
5106
5944
|
* @permissionScope Manage Submissions
|
|
5107
5945
|
* @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
|
|
5946
|
+
* @permissionScope Set Up Automations
|
|
5947
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
5108
5948
|
* @applicableIdentity APP
|
|
5109
5949
|
* @applicableIdentity VISITOR
|
|
5110
5950
|
* @fqn wix.forms.v4.FormSchemaService.GetFormSummary
|