@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,9 +2604,15 @@ export interface MediaItemMediaOneOf {
|
|
|
2284
2604
|
image?: Image;
|
|
2285
2605
|
}
|
|
2286
2606
|
export interface Image {
|
|
2287
|
-
/**
|
|
2607
|
+
/**
|
|
2608
|
+
* WixMedia image ID.
|
|
2609
|
+
* @maxLength 100
|
|
2610
|
+
*/
|
|
2288
2611
|
id?: string;
|
|
2289
|
-
/**
|
|
2612
|
+
/**
|
|
2613
|
+
* Image URL.
|
|
2614
|
+
* @maxLength 2000
|
|
2615
|
+
*/
|
|
2290
2616
|
url?: string;
|
|
2291
2617
|
/**
|
|
2292
2618
|
* Original image height.
|
|
@@ -2298,38 +2624,61 @@ export interface Image {
|
|
|
2298
2624
|
* @readonly
|
|
2299
2625
|
*/
|
|
2300
2626
|
width?: number;
|
|
2301
|
-
/**
|
|
2627
|
+
/**
|
|
2628
|
+
* Image alt text.
|
|
2629
|
+
* @maxLength 1000
|
|
2630
|
+
*/
|
|
2302
2631
|
altText?: string | null;
|
|
2303
2632
|
/**
|
|
2304
2633
|
* Image filename.
|
|
2305
2634
|
* @readonly
|
|
2635
|
+
* @maxLength 1000
|
|
2306
2636
|
*/
|
|
2307
2637
|
filename?: string | null;
|
|
2308
2638
|
}
|
|
2309
2639
|
export interface Option {
|
|
2310
|
-
/**
|
|
2640
|
+
/**
|
|
2641
|
+
* Selectable option label
|
|
2642
|
+
* @maxLength 400
|
|
2643
|
+
*/
|
|
2311
2644
|
label?: string | null;
|
|
2312
2645
|
/** Selectable option value, which is saved to DB. */
|
|
2313
2646
|
value?: any;
|
|
2314
2647
|
/** Flag identifying that option should be selected by default */
|
|
2315
2648
|
default?: boolean;
|
|
2316
|
-
/**
|
|
2649
|
+
/**
|
|
2650
|
+
* Option id. Used as binding for translations
|
|
2651
|
+
* @format GUID
|
|
2652
|
+
* @immutable
|
|
2653
|
+
*/
|
|
2317
2654
|
id?: string;
|
|
2318
2655
|
/** Media item. Media, associated with option, like image. */
|
|
2319
2656
|
media?: MediaItem;
|
|
2320
2657
|
}
|
|
2321
2658
|
export interface CustomOption {
|
|
2322
|
-
/**
|
|
2659
|
+
/**
|
|
2660
|
+
* Label of custom option input
|
|
2661
|
+
* @maxLength 350
|
|
2662
|
+
*/
|
|
2323
2663
|
label?: string | null;
|
|
2324
|
-
/**
|
|
2664
|
+
/**
|
|
2665
|
+
* Placeholder of custom option input
|
|
2666
|
+
* @maxLength 100
|
|
2667
|
+
*/
|
|
2325
2668
|
placeholder?: string | null;
|
|
2326
2669
|
}
|
|
2327
2670
|
export interface Tags {
|
|
2328
|
-
/**
|
|
2671
|
+
/**
|
|
2672
|
+
* Label of the field
|
|
2673
|
+
* @maxLength 350
|
|
2674
|
+
*/
|
|
2329
2675
|
label?: string | null;
|
|
2330
2676
|
/** Description of the field */
|
|
2331
2677
|
description?: RichContent;
|
|
2332
|
-
/**
|
|
2678
|
+
/**
|
|
2679
|
+
* List of options to select from
|
|
2680
|
+
* @maxSize 400
|
|
2681
|
+
*/
|
|
2333
2682
|
options?: TagsOption[];
|
|
2334
2683
|
/**
|
|
2335
2684
|
* Flag identifying to hide or not label
|
|
@@ -2345,21 +2694,34 @@ export interface Tags {
|
|
|
2345
2694
|
numberOfColumns?: NumberOfColumns;
|
|
2346
2695
|
}
|
|
2347
2696
|
export interface TagsOption {
|
|
2348
|
-
/**
|
|
2697
|
+
/**
|
|
2698
|
+
* Selectable option label
|
|
2699
|
+
* @maxLength 400
|
|
2700
|
+
*/
|
|
2349
2701
|
label?: string | null;
|
|
2350
2702
|
/** Selectable option value, which is saved to DB. */
|
|
2351
2703
|
value?: any;
|
|
2352
2704
|
/** Flag identifying that option should be selected by default */
|
|
2353
2705
|
default?: boolean;
|
|
2354
|
-
/**
|
|
2706
|
+
/**
|
|
2707
|
+
* Option id. Used as binding for translations
|
|
2708
|
+
* @format GUID
|
|
2709
|
+
* @immutable
|
|
2710
|
+
*/
|
|
2355
2711
|
id?: string;
|
|
2356
2712
|
/** Media item. Media, associated with option, like image. */
|
|
2357
2713
|
media?: MediaItem;
|
|
2358
2714
|
}
|
|
2359
2715
|
export interface CommonCustomOption {
|
|
2360
|
-
/**
|
|
2716
|
+
/**
|
|
2717
|
+
* Label of custom option input
|
|
2718
|
+
* @maxLength 350
|
|
2719
|
+
*/
|
|
2361
2720
|
label?: string | null;
|
|
2362
|
-
/**
|
|
2721
|
+
/**
|
|
2722
|
+
* Placeholder of custom option input
|
|
2723
|
+
* @maxLength 100
|
|
2724
|
+
*/
|
|
2363
2725
|
placeholder?: string | null;
|
|
2364
2726
|
}
|
|
2365
2727
|
export declare enum WixFileComponentType {
|
|
@@ -2368,7 +2730,10 @@ export declare enum WixFileComponentType {
|
|
|
2368
2730
|
SIGNATURE = "SIGNATURE"
|
|
2369
2731
|
}
|
|
2370
2732
|
export interface FileUpload {
|
|
2371
|
-
/**
|
|
2733
|
+
/**
|
|
2734
|
+
* Selectable option label
|
|
2735
|
+
* @maxLength 350
|
|
2736
|
+
*/
|
|
2372
2737
|
label?: string | null;
|
|
2373
2738
|
/** Description of the field */
|
|
2374
2739
|
description?: RichContent;
|
|
@@ -2377,13 +2742,26 @@ export interface FileUpload {
|
|
|
2377
2742
|
* Default: true
|
|
2378
2743
|
*/
|
|
2379
2744
|
showLabel?: boolean | null;
|
|
2380
|
-
/**
|
|
2745
|
+
/**
|
|
2746
|
+
* Text on upload button
|
|
2747
|
+
* @maxLength 500
|
|
2748
|
+
*/
|
|
2381
2749
|
buttonText?: string | null;
|
|
2382
|
-
/**
|
|
2750
|
+
/**
|
|
2751
|
+
* Amount of files allowed to upload
|
|
2752
|
+
* @min 1
|
|
2753
|
+
* @max 30
|
|
2754
|
+
*/
|
|
2383
2755
|
fileLimit?: number;
|
|
2384
|
-
/**
|
|
2756
|
+
/**
|
|
2757
|
+
* Supported file formats for upload
|
|
2758
|
+
* @maxSize 5
|
|
2759
|
+
*/
|
|
2385
2760
|
uploadFileFormats?: UploadFileFormat[];
|
|
2386
|
-
/**
|
|
2761
|
+
/**
|
|
2762
|
+
* Custom text which appears when file is uploaded, if missing file name will be shown
|
|
2763
|
+
* @maxLength 255
|
|
2764
|
+
*/
|
|
2387
2765
|
explanationText?: string | null;
|
|
2388
2766
|
}
|
|
2389
2767
|
export declare enum UploadFileFormat {
|
|
@@ -2401,7 +2779,10 @@ export declare enum UploadFileFormat {
|
|
|
2401
2779
|
ARCHIVE = "ARCHIVE"
|
|
2402
2780
|
}
|
|
2403
2781
|
export interface Signature {
|
|
2404
|
-
/**
|
|
2782
|
+
/**
|
|
2783
|
+
* Selectable option label
|
|
2784
|
+
* @maxLength 350
|
|
2785
|
+
*/
|
|
2405
2786
|
label?: string | null;
|
|
2406
2787
|
/**
|
|
2407
2788
|
* Flag identifying to hide label or not
|
|
@@ -2421,11 +2802,17 @@ export declare enum PaymentComponentType {
|
|
|
2421
2802
|
FIXED_PAYMENT = "FIXED_PAYMENT"
|
|
2422
2803
|
}
|
|
2423
2804
|
export interface ProductCheckboxGroup {
|
|
2424
|
-
/**
|
|
2805
|
+
/**
|
|
2806
|
+
* Label of the field.
|
|
2807
|
+
* @maxLength 350
|
|
2808
|
+
*/
|
|
2425
2809
|
label?: string | null;
|
|
2426
2810
|
/** Description of the field. */
|
|
2427
2811
|
description?: RichContent;
|
|
2428
|
-
/**
|
|
2812
|
+
/**
|
|
2813
|
+
* List of options to select from.
|
|
2814
|
+
* @maxSize 400
|
|
2815
|
+
*/
|
|
2429
2816
|
options?: ProductCheckboxGroupOption[];
|
|
2430
2817
|
/**
|
|
2431
2818
|
* Flag identifying to hide or not label
|
|
@@ -2439,11 +2826,18 @@ export interface ProductCheckboxGroup {
|
|
|
2439
2826
|
imageFit?: ImageFit;
|
|
2440
2827
|
}
|
|
2441
2828
|
export interface ProductCheckboxGroupOption {
|
|
2442
|
-
/**
|
|
2829
|
+
/**
|
|
2830
|
+
* Selectable option label.
|
|
2831
|
+
* @maxLength 400
|
|
2832
|
+
*/
|
|
2443
2833
|
label?: string | null;
|
|
2444
2834
|
/** Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list. */
|
|
2445
2835
|
value?: any;
|
|
2446
|
-
/**
|
|
2836
|
+
/**
|
|
2837
|
+
* Option id. Used as binding for translations.
|
|
2838
|
+
* @format GUID
|
|
2839
|
+
* @immutable
|
|
2840
|
+
*/
|
|
2447
2841
|
id?: string;
|
|
2448
2842
|
/** Media item. Media, associated with option, like image. */
|
|
2449
2843
|
media?: MediaItem;
|
|
@@ -2458,11 +2852,17 @@ export declare enum ImageFit {
|
|
|
2458
2852
|
CONTAIN = "CONTAIN"
|
|
2459
2853
|
}
|
|
2460
2854
|
export interface DonationInput {
|
|
2461
|
-
/**
|
|
2855
|
+
/**
|
|
2856
|
+
* Label of the field.
|
|
2857
|
+
* @maxLength 350
|
|
2858
|
+
*/
|
|
2462
2859
|
label?: string | null;
|
|
2463
2860
|
/** Description of the field. */
|
|
2464
2861
|
description?: RichContent;
|
|
2465
|
-
/**
|
|
2862
|
+
/**
|
|
2863
|
+
* List of options to select from.
|
|
2864
|
+
* @maxSize 400
|
|
2865
|
+
*/
|
|
2466
2866
|
options?: DonationInputOption[];
|
|
2467
2867
|
/** Option which can be specified by UoU, enabled when this object is specified. */
|
|
2468
2868
|
customOption?: CommonCustomOption;
|
|
@@ -2478,13 +2878,19 @@ export interface DonationInput {
|
|
|
2478
2878
|
showLabel?: boolean | null;
|
|
2479
2879
|
}
|
|
2480
2880
|
export interface DonationInputOption {
|
|
2481
|
-
/**
|
|
2881
|
+
/**
|
|
2882
|
+
* Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list.
|
|
2883
|
+
* @format GUID
|
|
2884
|
+
*/
|
|
2482
2885
|
value?: string;
|
|
2483
2886
|
/** Flag identifying that option should be selected by default */
|
|
2484
2887
|
default?: boolean;
|
|
2485
2888
|
}
|
|
2486
2889
|
export interface PaymentInput {
|
|
2487
|
-
/**
|
|
2890
|
+
/**
|
|
2891
|
+
* Label of the field.
|
|
2892
|
+
* @maxLength 350
|
|
2893
|
+
*/
|
|
2488
2894
|
label?: string | null;
|
|
2489
2895
|
/** Description of the field. */
|
|
2490
2896
|
description?: RichContent;
|
|
@@ -2493,13 +2899,19 @@ export interface PaymentInput {
|
|
|
2493
2899
|
* Default: true
|
|
2494
2900
|
*/
|
|
2495
2901
|
showLabel?: boolean | null;
|
|
2496
|
-
/**
|
|
2902
|
+
/**
|
|
2903
|
+
* Placeholder of custom option input
|
|
2904
|
+
* @maxLength 100
|
|
2905
|
+
*/
|
|
2497
2906
|
placeholder?: string | null;
|
|
2498
2907
|
/** Default value for the payment input */
|
|
2499
2908
|
default?: number | null;
|
|
2500
2909
|
}
|
|
2501
2910
|
export interface FixedPayment {
|
|
2502
|
-
/**
|
|
2911
|
+
/**
|
|
2912
|
+
* Label of the field.
|
|
2913
|
+
* @maxLength 350
|
|
2914
|
+
*/
|
|
2503
2915
|
label?: string | null;
|
|
2504
2916
|
/** Description of the field. */
|
|
2505
2917
|
description?: RichContent;
|
|
@@ -2520,15 +2932,30 @@ export interface Appointment extends AppointmentFormatInfoOneOf {
|
|
|
2520
2932
|
videoConferenceOptions?: VideoConferenceOptions;
|
|
2521
2933
|
/** Phone options for the appointment */
|
|
2522
2934
|
phoneOptions?: PhoneOptions;
|
|
2523
|
-
/**
|
|
2935
|
+
/**
|
|
2936
|
+
* Label of the field
|
|
2937
|
+
* @maxLength 255
|
|
2938
|
+
*/
|
|
2524
2939
|
label?: string | null;
|
|
2525
|
-
/**
|
|
2940
|
+
/**
|
|
2941
|
+
* Name of the appointment
|
|
2942
|
+
* @minLength 1
|
|
2943
|
+
* @maxLength 400
|
|
2944
|
+
*/
|
|
2526
2945
|
name?: string | null;
|
|
2527
|
-
/**
|
|
2946
|
+
/**
|
|
2947
|
+
* Duration of the appointment in minutes
|
|
2948
|
+
* @min 1
|
|
2949
|
+
* @max 44639
|
|
2950
|
+
*/
|
|
2528
2951
|
durationInMinutes?: number | null;
|
|
2529
2952
|
/** Indicates whether manual approval is required for the appointment */
|
|
2530
2953
|
manualApprovalRequired?: boolean | null;
|
|
2531
|
-
/**
|
|
2954
|
+
/**
|
|
2955
|
+
* ID of the staff members providing the appointment
|
|
2956
|
+
* @maxSize 220
|
|
2957
|
+
* @format GUID
|
|
2958
|
+
*/
|
|
2532
2959
|
staffIds?: string[] | null;
|
|
2533
2960
|
/** The format of the appointment */
|
|
2534
2961
|
format?: Format;
|
|
@@ -2543,16 +2970,28 @@ export interface AppointmentFormatInfoOneOf {
|
|
|
2543
2970
|
phoneOptions?: PhoneOptions;
|
|
2544
2971
|
}
|
|
2545
2972
|
export interface Location extends LocationLocationInfoOneOf {
|
|
2546
|
-
/**
|
|
2973
|
+
/**
|
|
2974
|
+
* Custom address details
|
|
2975
|
+
* @maxLength 512
|
|
2976
|
+
*/
|
|
2547
2977
|
customAddress?: string | null;
|
|
2548
|
-
/**
|
|
2978
|
+
/**
|
|
2979
|
+
* ID of a business location
|
|
2980
|
+
* @format GUID
|
|
2981
|
+
*/
|
|
2549
2982
|
businessLocationId?: string | null;
|
|
2550
2983
|
}
|
|
2551
2984
|
/** @oneof */
|
|
2552
2985
|
export interface LocationLocationInfoOneOf {
|
|
2553
|
-
/**
|
|
2986
|
+
/**
|
|
2987
|
+
* Custom address details
|
|
2988
|
+
* @maxLength 512
|
|
2989
|
+
*/
|
|
2554
2990
|
customAddress?: string | null;
|
|
2555
|
-
/**
|
|
2991
|
+
/**
|
|
2992
|
+
* ID of a business location
|
|
2993
|
+
* @format GUID
|
|
2994
|
+
*/
|
|
2556
2995
|
businessLocationId?: string | null;
|
|
2557
2996
|
}
|
|
2558
2997
|
export declare enum Format {
|
|
@@ -2562,15 +3001,25 @@ export declare enum Format {
|
|
|
2562
3001
|
PHONE = "PHONE"
|
|
2563
3002
|
}
|
|
2564
3003
|
export interface InPersonOptions {
|
|
2565
|
-
/**
|
|
3004
|
+
/**
|
|
3005
|
+
* The locations details
|
|
3006
|
+
* @minSize 1
|
|
3007
|
+
* @maxSize 500
|
|
3008
|
+
*/
|
|
2566
3009
|
locations?: Location[];
|
|
2567
3010
|
}
|
|
2568
3011
|
export interface VideoConferenceOptions {
|
|
2569
|
-
/**
|
|
3012
|
+
/**
|
|
3013
|
+
* Description or instructions for the online video conference
|
|
3014
|
+
* @maxLength 512
|
|
3015
|
+
*/
|
|
2570
3016
|
description?: string | null;
|
|
2571
3017
|
}
|
|
2572
3018
|
export interface PhoneOptions {
|
|
2573
|
-
/**
|
|
3019
|
+
/**
|
|
3020
|
+
* Description or instructions for the phone appointment
|
|
3021
|
+
* @maxLength 512
|
|
3022
|
+
*/
|
|
2574
3023
|
description?: string | null;
|
|
2575
3024
|
}
|
|
2576
3025
|
export declare enum MultilineAddressComponentType {
|
|
@@ -2578,7 +3027,10 @@ export declare enum MultilineAddressComponentType {
|
|
|
2578
3027
|
MULTILINE_ADDRESS = "MULTILINE_ADDRESS"
|
|
2579
3028
|
}
|
|
2580
3029
|
export interface MultilineAddress {
|
|
2581
|
-
/**
|
|
3030
|
+
/**
|
|
3031
|
+
* Label of the field.
|
|
3032
|
+
* @maxLength 350
|
|
3033
|
+
*/
|
|
2582
3034
|
label?: string | null;
|
|
2583
3035
|
/** Description of the field. */
|
|
2584
3036
|
description?: RichContent;
|
|
@@ -2604,14 +3056,20 @@ export interface AddressLine2 {
|
|
|
2604
3056
|
show?: boolean;
|
|
2605
3057
|
}
|
|
2606
3058
|
export interface DefaultCountryConfig extends DefaultCountryConfigOptionsOneOf {
|
|
2607
|
-
/**
|
|
3059
|
+
/**
|
|
3060
|
+
* Country.
|
|
3061
|
+
* @format COUNTRY
|
|
3062
|
+
*/
|
|
2608
3063
|
countryOptions?: string;
|
|
2609
3064
|
/** Default country type. */
|
|
2610
3065
|
type?: Type;
|
|
2611
3066
|
}
|
|
2612
3067
|
/** @oneof */
|
|
2613
3068
|
export interface DefaultCountryConfigOptionsOneOf {
|
|
2614
|
-
/**
|
|
3069
|
+
/**
|
|
3070
|
+
* Country.
|
|
3071
|
+
* @format COUNTRY
|
|
3072
|
+
*/
|
|
2615
3073
|
countryOptions?: string;
|
|
2616
3074
|
}
|
|
2617
3075
|
export interface FieldsSettings {
|
|
@@ -2701,7 +3159,11 @@ export interface AddressInfo {
|
|
|
2701
3159
|
tag?: Tag;
|
|
2702
3160
|
}
|
|
2703
3161
|
export interface CustomFieldInfo {
|
|
2704
|
-
/**
|
|
3162
|
+
/**
|
|
3163
|
+
* Custom field key.
|
|
3164
|
+
* @minLength 1
|
|
3165
|
+
* @maxLength 500
|
|
3166
|
+
*/
|
|
2705
3167
|
key?: string;
|
|
2706
3168
|
}
|
|
2707
3169
|
export interface SubscriptionInfo {
|
|
@@ -2920,7 +3382,12 @@ export interface InputField extends InputFieldInputTypeOptionsOneOf {
|
|
|
2920
3382
|
multilineAddressOptions?: InputFieldMultilineAddress;
|
|
2921
3383
|
/** Input returns scheduling as value. */
|
|
2922
3384
|
schedulingOptions?: Scheduling;
|
|
2923
|
-
/**
|
|
3385
|
+
/**
|
|
3386
|
+
* Definition of a target where the value of field belongs.
|
|
3387
|
+
* @minLength 1
|
|
3388
|
+
* @maxLength 200
|
|
3389
|
+
* @immutable
|
|
3390
|
+
*/
|
|
2924
3391
|
target?: string | null;
|
|
2925
3392
|
/**
|
|
2926
3393
|
* Mark the field as containing personal information. This will encrypt user data when storing it.
|
|
@@ -2992,17 +3459,33 @@ export interface RichContentOptions {
|
|
|
2992
3459
|
richContent?: RichContent;
|
|
2993
3460
|
}
|
|
2994
3461
|
export interface PageNavigationOptions {
|
|
2995
|
-
/**
|
|
3462
|
+
/**
|
|
3463
|
+
* When button is not on last page it behaves as switch between pages page, text of label to go to next page.
|
|
3464
|
+
* @maxLength 65
|
|
3465
|
+
*/
|
|
2996
3466
|
nextPageText?: string | null;
|
|
2997
|
-
/**
|
|
3467
|
+
/**
|
|
3468
|
+
* When button is not on last page it behaves as switch between pages page, text of label to go to previous page.
|
|
3469
|
+
* @maxLength 65
|
|
3470
|
+
*/
|
|
2998
3471
|
previousPageText?: string | null;
|
|
2999
|
-
/**
|
|
3472
|
+
/**
|
|
3473
|
+
* Text on the button when button is submitting a form
|
|
3474
|
+
* @maxLength 65
|
|
3475
|
+
*/
|
|
3000
3476
|
submitText?: string | null;
|
|
3001
3477
|
}
|
|
3002
3478
|
export interface Step {
|
|
3003
|
-
/**
|
|
3479
|
+
/**
|
|
3480
|
+
* Step ID.
|
|
3481
|
+
* @format GUID
|
|
3482
|
+
* @immutable
|
|
3483
|
+
*/
|
|
3004
3484
|
id?: string;
|
|
3005
|
-
/**
|
|
3485
|
+
/**
|
|
3486
|
+
* Name of the step.
|
|
3487
|
+
* @maxLength 200
|
|
3488
|
+
*/
|
|
3006
3489
|
name?: string | null;
|
|
3007
3490
|
/** Is step hidden */
|
|
3008
3491
|
hidden?: boolean;
|
|
@@ -3018,7 +3501,10 @@ export interface FormLayout {
|
|
|
3018
3501
|
small?: BreakPoint;
|
|
3019
3502
|
}
|
|
3020
3503
|
export interface BreakPoint {
|
|
3021
|
-
/**
|
|
3504
|
+
/**
|
|
3505
|
+
* Description of layouts for items.
|
|
3506
|
+
* @maxSize 500
|
|
3507
|
+
*/
|
|
3022
3508
|
items?: ItemLayout[];
|
|
3023
3509
|
/** Amount of columns of layout grid. */
|
|
3024
3510
|
columns?: number | null;
|
|
@@ -3028,11 +3514,17 @@ export interface BreakPoint {
|
|
|
3028
3514
|
margin?: Margin;
|
|
3029
3515
|
/** Description of elements paddings. */
|
|
3030
3516
|
padding?: Margin;
|
|
3031
|
-
/**
|
|
3517
|
+
/**
|
|
3518
|
+
* Sections of the layout, which allow manage fields
|
|
3519
|
+
* @maxSize 100
|
|
3520
|
+
*/
|
|
3032
3521
|
sections?: Section[];
|
|
3033
3522
|
}
|
|
3034
3523
|
export interface ItemLayout extends ItemLayoutItemOneOf {
|
|
3035
|
-
/**
|
|
3524
|
+
/**
|
|
3525
|
+
* Form field reference id.
|
|
3526
|
+
* @format GUID
|
|
3527
|
+
*/
|
|
3036
3528
|
fieldId?: string;
|
|
3037
3529
|
/** Group info, defining that this item is a group of multiple fields */
|
|
3038
3530
|
group?: Group;
|
|
@@ -3047,15 +3539,25 @@ export interface ItemLayout extends ItemLayoutItemOneOf {
|
|
|
3047
3539
|
}
|
|
3048
3540
|
/** @oneof */
|
|
3049
3541
|
export interface ItemLayoutItemOneOf {
|
|
3050
|
-
/**
|
|
3542
|
+
/**
|
|
3543
|
+
* Form field reference id.
|
|
3544
|
+
* @format GUID
|
|
3545
|
+
*/
|
|
3051
3546
|
fieldId?: string;
|
|
3052
3547
|
/** Group info, defining that this item is a group of multiple fields */
|
|
3053
3548
|
group?: Group;
|
|
3054
3549
|
}
|
|
3055
3550
|
export interface Group {
|
|
3056
|
-
/**
|
|
3551
|
+
/**
|
|
3552
|
+
* Field group reference id.
|
|
3553
|
+
* @format GUID
|
|
3554
|
+
*/
|
|
3057
3555
|
groupId?: string;
|
|
3058
|
-
/**
|
|
3556
|
+
/**
|
|
3557
|
+
* Description of layouts for items.
|
|
3558
|
+
* @minSize 1
|
|
3559
|
+
* @maxSize 500
|
|
3560
|
+
*/
|
|
3059
3561
|
items?: ItemLayout[];
|
|
3060
3562
|
}
|
|
3061
3563
|
export interface Margin {
|
|
@@ -3065,7 +3567,11 @@ export interface Margin {
|
|
|
3065
3567
|
vertical?: number | null;
|
|
3066
3568
|
}
|
|
3067
3569
|
export interface Section {
|
|
3068
|
-
/**
|
|
3570
|
+
/**
|
|
3571
|
+
* Id of the section
|
|
3572
|
+
* @format GUID
|
|
3573
|
+
* @minLength 1
|
|
3574
|
+
*/
|
|
3069
3575
|
id?: string;
|
|
3070
3576
|
/** Horizontal coordinate in the grid. */
|
|
3071
3577
|
row?: number | null;
|
|
@@ -3075,20 +3581,30 @@ export interface Section {
|
|
|
3075
3581
|
* If the section encounters the $new key within the list,
|
|
3076
3582
|
* it allows the inclusion of fields not explicitly listed,
|
|
3077
3583
|
* enabling dynamic addition of new fields.
|
|
3584
|
+
* @maxSize 100
|
|
3585
|
+
* @maxLength 100
|
|
3078
3586
|
*/
|
|
3079
3587
|
allowedFieldIds?: string[];
|
|
3080
3588
|
}
|
|
3081
3589
|
export interface FormRule {
|
|
3082
|
-
/**
|
|
3590
|
+
/**
|
|
3591
|
+
* Id of the rule
|
|
3592
|
+
* @format GUID
|
|
3593
|
+
* @immutable
|
|
3594
|
+
*/
|
|
3083
3595
|
id?: string;
|
|
3084
3596
|
/** Rule on which item properties or layouts will be changed. */
|
|
3085
3597
|
condition?: Record<string, any> | null;
|
|
3086
3598
|
/**
|
|
3087
3599
|
* Form items with defined properties that will be
|
|
3088
3600
|
* changed when given condition is resolved to true.
|
|
3601
|
+
* @maxSize 500
|
|
3089
3602
|
*/
|
|
3090
3603
|
overrides?: FormOverride[];
|
|
3091
|
-
/**
|
|
3604
|
+
/**
|
|
3605
|
+
* Name of the rule
|
|
3606
|
+
* @maxLength 200
|
|
3607
|
+
*/
|
|
3092
3608
|
name?: string | null;
|
|
3093
3609
|
}
|
|
3094
3610
|
export declare enum OverrideEntityType {
|
|
@@ -3096,15 +3612,28 @@ export declare enum OverrideEntityType {
|
|
|
3096
3612
|
FIELD = "FIELD"
|
|
3097
3613
|
}
|
|
3098
3614
|
export interface FormOverride {
|
|
3099
|
-
/**
|
|
3615
|
+
/**
|
|
3616
|
+
* Override entity type.
|
|
3617
|
+
* @immutable
|
|
3618
|
+
*/
|
|
3100
3619
|
entityType?: OverrideEntityType;
|
|
3101
|
-
/**
|
|
3620
|
+
/**
|
|
3621
|
+
* Overridden entity id. Either fieldId, or "{fieldIdWithNestedForm}/{nestedFormFieldId}"
|
|
3622
|
+
* @immutable
|
|
3623
|
+
* @maxLength 73
|
|
3624
|
+
*/
|
|
3102
3625
|
entityId?: string | null;
|
|
3103
3626
|
/** Form entity properties path with new value, that will be changed on condition. */
|
|
3104
3627
|
valueChanges?: Record<string, any>;
|
|
3105
3628
|
}
|
|
3106
3629
|
export interface FormProperties {
|
|
3107
|
-
/**
|
|
3630
|
+
/**
|
|
3631
|
+
* Form name.
|
|
3632
|
+
* @maxLength 200
|
|
3633
|
+
* @deprecated
|
|
3634
|
+
* @replacedBy wix.forms.v4.Form.name
|
|
3635
|
+
* @targetRemovalDate 2026-01-06
|
|
3636
|
+
*/
|
|
3108
3637
|
name?: string | null;
|
|
3109
3638
|
/**
|
|
3110
3639
|
* Identifies if the form is disabled.
|
|
@@ -3125,12 +3654,18 @@ export interface PostSubmissionTriggers {
|
|
|
3125
3654
|
upsertContact?: UpsertContact;
|
|
3126
3655
|
}
|
|
3127
3656
|
export interface UpsertContact {
|
|
3128
|
-
/**
|
|
3657
|
+
/**
|
|
3658
|
+
* Fields mapping (target field mapped to corresponding contact field).
|
|
3659
|
+
* @maxSize 250
|
|
3660
|
+
*/
|
|
3129
3661
|
fieldsMapping?: Record<string, FormFieldContactInfo>;
|
|
3130
3662
|
/**
|
|
3131
3663
|
* List of contact label keys.
|
|
3132
3664
|
* [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
|
|
3133
3665
|
* help categorize contacts.
|
|
3666
|
+
* @minLength 1
|
|
3667
|
+
* @maxLength 100
|
|
3668
|
+
* @maxSize 20
|
|
3134
3669
|
*/
|
|
3135
3670
|
labels?: string[];
|
|
3136
3671
|
}
|
|
@@ -3146,7 +3681,11 @@ export interface ExtendedFields {
|
|
|
3146
3681
|
namespaces?: Record<string, Record<string, any>>;
|
|
3147
3682
|
}
|
|
3148
3683
|
export interface NestedForm {
|
|
3149
|
-
/**
|
|
3684
|
+
/**
|
|
3685
|
+
* Targets which have this form.
|
|
3686
|
+
* @maxSize 10
|
|
3687
|
+
* @maxLength 200
|
|
3688
|
+
*/
|
|
3150
3689
|
targets?: string[];
|
|
3151
3690
|
/** Nested form. */
|
|
3152
3691
|
form?: Form;
|
|
@@ -3213,37 +3752,67 @@ export interface ThankYouMessageOptions {
|
|
|
3213
3752
|
richContent?: RichContent;
|
|
3214
3753
|
}
|
|
3215
3754
|
export interface RedirectOptions {
|
|
3216
|
-
/**
|
|
3755
|
+
/**
|
|
3756
|
+
* The URL to which the user should be redirected after a successful form submission.
|
|
3757
|
+
* @maxLength 2000
|
|
3758
|
+
*/
|
|
3217
3759
|
redirectUrl?: string | null;
|
|
3218
3760
|
/** How the URL should be opened. */
|
|
3219
3761
|
target?: Target;
|
|
3220
3762
|
}
|
|
3221
3763
|
export interface FieldGroup {
|
|
3222
|
-
/**
|
|
3764
|
+
/**
|
|
3765
|
+
* Id of group, on layout
|
|
3766
|
+
* @format GUID
|
|
3767
|
+
*/
|
|
3223
3768
|
id?: string;
|
|
3224
|
-
/**
|
|
3769
|
+
/**
|
|
3770
|
+
* Label of group
|
|
3771
|
+
* @maxLength 350
|
|
3772
|
+
*/
|
|
3225
3773
|
label?: string | null;
|
|
3226
3774
|
}
|
|
3227
3775
|
export interface PiiFieldsUpdated {
|
|
3228
|
-
/**
|
|
3776
|
+
/**
|
|
3777
|
+
* Collection of fields which are marked as PII
|
|
3778
|
+
* @maxSize 100
|
|
3779
|
+
* @maxLength 200
|
|
3780
|
+
*/
|
|
3229
3781
|
piiFields?: string[];
|
|
3230
|
-
/**
|
|
3782
|
+
/**
|
|
3783
|
+
* Collection of fields which are non PII
|
|
3784
|
+
* @maxSize 100
|
|
3785
|
+
* @maxLength 200
|
|
3786
|
+
*/
|
|
3231
3787
|
nonPiiFields?: string[];
|
|
3232
3788
|
}
|
|
3233
3789
|
export interface SubmissionKeysPermanentlyDeleted {
|
|
3234
|
-
/**
|
|
3790
|
+
/**
|
|
3791
|
+
* Keys which should be deleted
|
|
3792
|
+
* @maxSize 200
|
|
3793
|
+
* @maxLength 200
|
|
3794
|
+
*/
|
|
3235
3795
|
keys?: string[] | null;
|
|
3236
3796
|
}
|
|
3237
3797
|
export interface FormTranslationChanged {
|
|
3238
3798
|
/** The form with updated translations */
|
|
3239
3799
|
form?: Form;
|
|
3240
|
-
/**
|
|
3800
|
+
/**
|
|
3801
|
+
* Language of the translation
|
|
3802
|
+
* @maxLength 20
|
|
3803
|
+
*/
|
|
3241
3804
|
language?: string;
|
|
3242
3805
|
}
|
|
3243
3806
|
export interface FormTranslationDeleted {
|
|
3244
|
-
/**
|
|
3807
|
+
/**
|
|
3808
|
+
* ID of the form with the deleted translation
|
|
3809
|
+
* @format GUID
|
|
3810
|
+
*/
|
|
3245
3811
|
formId?: string;
|
|
3246
|
-
/**
|
|
3812
|
+
/**
|
|
3813
|
+
* Language of the deleted translation
|
|
3814
|
+
* @maxLength 20
|
|
3815
|
+
*/
|
|
3247
3816
|
language?: string;
|
|
3248
3817
|
}
|
|
3249
3818
|
export interface CreateFormRequest {
|
|
@@ -3255,19 +3824,35 @@ export interface CreateFormResponse {
|
|
|
3255
3824
|
form?: Form;
|
|
3256
3825
|
}
|
|
3257
3826
|
export interface TargetBasedErrorDetails {
|
|
3258
|
-
/**
|
|
3827
|
+
/**
|
|
3828
|
+
* Targets which are related to the error.
|
|
3829
|
+
* @maxSize 100
|
|
3830
|
+
* @maxLength 200
|
|
3831
|
+
*/
|
|
3259
3832
|
targets?: string[];
|
|
3260
3833
|
}
|
|
3261
3834
|
export interface FieldIdBasedErrorDetails {
|
|
3262
|
-
/**
|
|
3835
|
+
/**
|
|
3836
|
+
* Field ids which are related to the error.
|
|
3837
|
+
* @maxSize 100
|
|
3838
|
+
* @format GUID
|
|
3839
|
+
*/
|
|
3263
3840
|
ids?: string[];
|
|
3264
3841
|
}
|
|
3265
3842
|
export interface StepIdBasedErrorDetails {
|
|
3266
|
-
/**
|
|
3843
|
+
/**
|
|
3844
|
+
* Step ids which are related to the error.
|
|
3845
|
+
* @maxSize 100
|
|
3846
|
+
* @format GUID
|
|
3847
|
+
*/
|
|
3267
3848
|
ids?: string[];
|
|
3268
3849
|
}
|
|
3269
3850
|
export interface RuleIdBasedErrorDetails {
|
|
3270
|
-
/**
|
|
3851
|
+
/**
|
|
3852
|
+
* Rule ids which are related to the error.
|
|
3853
|
+
* @maxSize 100
|
|
3854
|
+
* @format GUID
|
|
3855
|
+
*/
|
|
3271
3856
|
ids?: string[];
|
|
3272
3857
|
}
|
|
3273
3858
|
export interface NonExistingNestedFormsErrorDetails {
|
|
@@ -3279,17 +3864,33 @@ export interface NestedFormFieldsMissingErrorDetails {
|
|
|
3279
3864
|
targetToNestedFormFieldIds?: Record<string, FieldIdBasedErrorDetails>;
|
|
3280
3865
|
}
|
|
3281
3866
|
export interface FormFieldV2ApiValidationErrorDetails {
|
|
3282
|
-
/**
|
|
3867
|
+
/**
|
|
3868
|
+
* Field ids which are related to the error.
|
|
3869
|
+
* @maxSize 100
|
|
3870
|
+
* @format GUID
|
|
3871
|
+
*/
|
|
3283
3872
|
ids?: string[];
|
|
3284
|
-
/**
|
|
3873
|
+
/**
|
|
3874
|
+
* Violations which are related to the error.
|
|
3875
|
+
* @maxSize 100
|
|
3876
|
+
* @maxLength 500
|
|
3877
|
+
*/
|
|
3285
3878
|
violations?: string[];
|
|
3286
3879
|
}
|
|
3287
3880
|
export interface ProductIdBasedErrorDetails {
|
|
3288
|
-
/**
|
|
3881
|
+
/**
|
|
3882
|
+
* Product ids which are related to the error.
|
|
3883
|
+
* @maxSize 100
|
|
3884
|
+
* @format GUID
|
|
3885
|
+
*/
|
|
3289
3886
|
ids?: string[];
|
|
3290
3887
|
}
|
|
3291
3888
|
export interface BulkCreateFormRequest {
|
|
3292
|
-
/**
|
|
3889
|
+
/**
|
|
3890
|
+
* Forms to be created.
|
|
3891
|
+
* @minSize 1
|
|
3892
|
+
* @maxSize 30
|
|
3893
|
+
*/
|
|
3293
3894
|
forms?: Form[];
|
|
3294
3895
|
/** When set, items will be returned on successful create */
|
|
3295
3896
|
returnEntity?: boolean;
|
|
@@ -3307,7 +3908,10 @@ export interface BulkFormResult {
|
|
|
3307
3908
|
item?: Form;
|
|
3308
3909
|
}
|
|
3309
3910
|
export interface ItemMetadata {
|
|
3310
|
-
/**
|
|
3911
|
+
/**
|
|
3912
|
+
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
3913
|
+
* @format GUID
|
|
3914
|
+
*/
|
|
3311
3915
|
id?: string | null;
|
|
3312
3916
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
3313
3917
|
originalIndex?: number;
|
|
@@ -3333,7 +3937,10 @@ export interface BulkActionMetadata {
|
|
|
3333
3937
|
undetailedFailures?: number;
|
|
3334
3938
|
}
|
|
3335
3939
|
export interface CloneFormRequest {
|
|
3336
|
-
/**
|
|
3940
|
+
/**
|
|
3941
|
+
* Id of the form to clone.
|
|
3942
|
+
* @format GUID
|
|
3943
|
+
*/
|
|
3337
3944
|
formId: string;
|
|
3338
3945
|
}
|
|
3339
3946
|
export interface CloneFormResponse {
|
|
@@ -3341,9 +3948,15 @@ export interface CloneFormResponse {
|
|
|
3341
3948
|
form?: Form;
|
|
3342
3949
|
}
|
|
3343
3950
|
export interface CloneFormFromTemplateRequest {
|
|
3344
|
-
/**
|
|
3951
|
+
/**
|
|
3952
|
+
* Namespace of the vertical owning template
|
|
3953
|
+
* @maxLength 50
|
|
3954
|
+
*/
|
|
3345
3955
|
namespace?: string;
|
|
3346
|
-
/**
|
|
3956
|
+
/**
|
|
3957
|
+
* Template id which can be copied
|
|
3958
|
+
* @format GUID
|
|
3959
|
+
*/
|
|
3347
3960
|
templateId?: string;
|
|
3348
3961
|
/**
|
|
3349
3962
|
* When true, will try to create form with same id as template
|
|
@@ -3356,12 +3969,16 @@ export interface CloneFormFromTemplateResponse {
|
|
|
3356
3969
|
form?: Form;
|
|
3357
3970
|
}
|
|
3358
3971
|
export interface GetFormRequest {
|
|
3359
|
-
/**
|
|
3972
|
+
/**
|
|
3973
|
+
* Id of the form to retrieve.
|
|
3974
|
+
* @format GUID
|
|
3975
|
+
*/
|
|
3360
3976
|
formId: string;
|
|
3361
3977
|
/**
|
|
3362
3978
|
* List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
|
|
3363
3979
|
* the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3364
3980
|
* only the form’s base fields are returned.
|
|
3981
|
+
* @maxSize 3
|
|
3365
3982
|
*/
|
|
3366
3983
|
fieldsets?: Fieldset[];
|
|
3367
3984
|
/** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
|
|
@@ -3385,13 +4002,19 @@ export interface UpdateFormResponse {
|
|
|
3385
4002
|
form?: Form;
|
|
3386
4003
|
}
|
|
3387
4004
|
export interface RemoveFormFromTrashBinRequest {
|
|
3388
|
-
/**
|
|
4005
|
+
/**
|
|
4006
|
+
* Id of the form to delete.
|
|
4007
|
+
* @format GUID
|
|
4008
|
+
*/
|
|
3389
4009
|
formId: string;
|
|
3390
4010
|
}
|
|
3391
4011
|
export interface RemoveFormFromTrashBinResponse {
|
|
3392
4012
|
}
|
|
3393
4013
|
export interface DeleteFormRequest {
|
|
3394
|
-
/**
|
|
4014
|
+
/**
|
|
4015
|
+
* Id of the form to delete.
|
|
4016
|
+
* @format GUID
|
|
4017
|
+
*/
|
|
3395
4018
|
formId: string;
|
|
3396
4019
|
/**
|
|
3397
4020
|
* Delete form bypassing trash-bin.
|
|
@@ -3402,7 +4025,10 @@ export interface DeleteFormRequest {
|
|
|
3402
4025
|
export interface DeleteFormResponse {
|
|
3403
4026
|
}
|
|
3404
4027
|
export interface RestoreFromTrashBinRequest {
|
|
3405
|
-
/**
|
|
4028
|
+
/**
|
|
4029
|
+
* Id of the form to restore.
|
|
4030
|
+
* @format GUID
|
|
4031
|
+
*/
|
|
3406
4032
|
formId: string;
|
|
3407
4033
|
}
|
|
3408
4034
|
export interface RestoreFromTrashBinResponse {
|
|
@@ -3416,6 +4042,7 @@ export interface QueryFormsRequest {
|
|
|
3416
4042
|
* List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
|
|
3417
4043
|
* the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3418
4044
|
* only the form’s base fields are returned.
|
|
4045
|
+
* @maxSize 3
|
|
3419
4046
|
*/
|
|
3420
4047
|
fieldsets?: Fieldset[];
|
|
3421
4048
|
/** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
|
|
@@ -3436,6 +4063,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
3436
4063
|
/**
|
|
3437
4064
|
* Sort object in the following format:
|
|
3438
4065
|
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
4066
|
+
* @maxSize 3
|
|
3439
4067
|
*/
|
|
3440
4068
|
sort?: Sorting[];
|
|
3441
4069
|
}
|
|
@@ -3445,7 +4073,10 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
3445
4073
|
cursorPaging?: CursorPaging;
|
|
3446
4074
|
}
|
|
3447
4075
|
export interface Sorting {
|
|
3448
|
-
/**
|
|
4076
|
+
/**
|
|
4077
|
+
* Name of the field to sort by.
|
|
4078
|
+
* @maxLength 512
|
|
4079
|
+
*/
|
|
3449
4080
|
fieldName?: string;
|
|
3450
4081
|
/** Sort order. */
|
|
3451
4082
|
order?: SortOrder;
|
|
@@ -3455,7 +4086,10 @@ export declare enum SortOrder {
|
|
|
3455
4086
|
DESC = "DESC"
|
|
3456
4087
|
}
|
|
3457
4088
|
export interface CursorPaging {
|
|
3458
|
-
/**
|
|
4089
|
+
/**
|
|
4090
|
+
* Number of items to load.
|
|
4091
|
+
* @max 100
|
|
4092
|
+
*/
|
|
3459
4093
|
limit?: number | null;
|
|
3460
4094
|
/**
|
|
3461
4095
|
* Pointer to the next or previous page in the list of results.
|
|
@@ -3463,11 +4097,15 @@ export interface CursorPaging {
|
|
|
3463
4097
|
* You can get the relevant cursor token
|
|
3464
4098
|
* from the `pagingMetadata` object in the previous call's response.
|
|
3465
4099
|
* Not relevant for the first request.
|
|
4100
|
+
* @maxLength 16000
|
|
3466
4101
|
*/
|
|
3467
4102
|
cursor?: string | null;
|
|
3468
4103
|
}
|
|
3469
4104
|
export interface QueryFormsResponse {
|
|
3470
|
-
/**
|
|
4105
|
+
/**
|
|
4106
|
+
* The retrieved forms
|
|
4107
|
+
* @maxSize 100
|
|
4108
|
+
*/
|
|
3471
4109
|
forms?: Form[];
|
|
3472
4110
|
/** Details on the paged set of results returned. */
|
|
3473
4111
|
metadata?: CursorPagingMetadata;
|
|
@@ -3485,15 +4123,28 @@ export interface CursorPagingMetadata {
|
|
|
3485
4123
|
hasNext?: boolean | null;
|
|
3486
4124
|
}
|
|
3487
4125
|
export interface Cursors {
|
|
3488
|
-
/**
|
|
4126
|
+
/**
|
|
4127
|
+
* Cursor pointing to next page in the list of results.
|
|
4128
|
+
* @maxLength 16000
|
|
4129
|
+
*/
|
|
3489
4130
|
next?: string | null;
|
|
3490
|
-
/**
|
|
4131
|
+
/**
|
|
4132
|
+
* Cursor pointing to previous page in the list of results.
|
|
4133
|
+
* @maxLength 16000
|
|
4134
|
+
*/
|
|
3491
4135
|
prev?: string | null;
|
|
3492
4136
|
}
|
|
3493
4137
|
export interface CountFormsRequest {
|
|
3494
|
-
/**
|
|
4138
|
+
/**
|
|
4139
|
+
* Namespace name.
|
|
4140
|
+
* @minLength 10
|
|
4141
|
+
* @maxLength 50
|
|
4142
|
+
*/
|
|
3495
4143
|
namespace: string;
|
|
3496
|
-
/**
|
|
4144
|
+
/**
|
|
4145
|
+
* Fieldsets.
|
|
4146
|
+
* @maxSize 3
|
|
4147
|
+
*/
|
|
3497
4148
|
fieldsets?: CountFormsFieldset[];
|
|
3498
4149
|
}
|
|
3499
4150
|
export declare enum CountFormsFieldset {
|
|
@@ -3512,7 +4163,11 @@ export interface CountFormsResponse {
|
|
|
3512
4163
|
deletedCount?: number | null;
|
|
3513
4164
|
}
|
|
3514
4165
|
export interface ListTemplateExtensionsRequest {
|
|
3515
|
-
/**
|
|
4166
|
+
/**
|
|
4167
|
+
* Namespace name.
|
|
4168
|
+
* @minLength 10
|
|
4169
|
+
* @maxLength 50
|
|
4170
|
+
*/
|
|
3516
4171
|
namespace?: string;
|
|
3517
4172
|
/** Identifies if the form is disabled. */
|
|
3518
4173
|
disabled?: boolean | null;
|
|
@@ -3535,15 +4190,25 @@ export interface ListTemplateExtensionsRequest {
|
|
|
3535
4190
|
* List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
|
|
3536
4191
|
* the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3537
4192
|
* only the form’s base fields are returned.
|
|
4193
|
+
* @maxSize 3
|
|
3538
4194
|
*/
|
|
3539
4195
|
fieldsets?: Fieldset[];
|
|
3540
|
-
/**
|
|
4196
|
+
/**
|
|
4197
|
+
* Form ids.
|
|
4198
|
+
* @maxSize 10
|
|
4199
|
+
* @format GUID
|
|
4200
|
+
*/
|
|
3541
4201
|
formIds?: string[];
|
|
3542
4202
|
/** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
|
|
3543
4203
|
additionalMetadata?: Record<string, any> | null;
|
|
3544
4204
|
/** Filter by name */
|
|
3545
4205
|
nameFilter?: NameFilter;
|
|
3546
|
-
/**
|
|
4206
|
+
/**
|
|
4207
|
+
* List of templates id, which extensions expected
|
|
4208
|
+
* @minSize 1
|
|
4209
|
+
* @maxSize 100
|
|
4210
|
+
* @format GUID
|
|
4211
|
+
*/
|
|
3547
4212
|
templateIds?: string[];
|
|
3548
4213
|
}
|
|
3549
4214
|
export declare enum ListFormsOrder {
|
|
@@ -3563,7 +4228,10 @@ export declare enum ListFormsOrder {
|
|
|
3563
4228
|
export interface NameFilter {
|
|
3564
4229
|
/** Type of filter */
|
|
3565
4230
|
filterType?: FilterType;
|
|
3566
|
-
/**
|
|
4231
|
+
/**
|
|
4232
|
+
* Expected name
|
|
4233
|
+
* @maxLength 200
|
|
4234
|
+
*/
|
|
3567
4235
|
name?: string;
|
|
3568
4236
|
}
|
|
3569
4237
|
export declare enum FilterType {
|
|
@@ -3571,13 +4239,20 @@ export declare enum FilterType {
|
|
|
3571
4239
|
STARTS_WITH = "STARTS_WITH"
|
|
3572
4240
|
}
|
|
3573
4241
|
export interface ListTemplateExtensionsResponse {
|
|
3574
|
-
/**
|
|
4242
|
+
/**
|
|
4243
|
+
* The retrieved forms.
|
|
4244
|
+
* @maxSize 100
|
|
4245
|
+
*/
|
|
3575
4246
|
forms?: Form[];
|
|
3576
4247
|
/** Details on the paged set of results returned. */
|
|
3577
4248
|
pagingMetadata?: CursorPagingMetadata;
|
|
3578
4249
|
}
|
|
3579
4250
|
export interface ListFormsRequest {
|
|
3580
|
-
/**
|
|
4251
|
+
/**
|
|
4252
|
+
* Namespace name.
|
|
4253
|
+
* @minLength 10
|
|
4254
|
+
* @maxLength 50
|
|
4255
|
+
*/
|
|
3581
4256
|
namespace: string;
|
|
3582
4257
|
/**
|
|
3583
4258
|
* Identifies if the form is disabled.
|
|
@@ -3605,9 +4280,14 @@ export interface ListFormsRequest {
|
|
|
3605
4280
|
* List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
|
|
3606
4281
|
* the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3607
4282
|
* only the form’s base fields are returned.
|
|
4283
|
+
* @maxSize 3
|
|
3608
4284
|
*/
|
|
3609
4285
|
fieldsets?: Fieldset[];
|
|
3610
|
-
/**
|
|
4286
|
+
/**
|
|
4287
|
+
* Form ids.
|
|
4288
|
+
* @maxSize 10
|
|
4289
|
+
* @format GUID
|
|
4290
|
+
*/
|
|
3611
4291
|
formIds?: string[];
|
|
3612
4292
|
/** Identifies if the form is a payment form */
|
|
3613
4293
|
paymentForm?: boolean | null;
|
|
@@ -3636,13 +4316,19 @@ export declare enum ListFormsRequestListFormsOrder {
|
|
|
3636
4316
|
NAME_DESC = "NAME_DESC"
|
|
3637
4317
|
}
|
|
3638
4318
|
export interface ListFormsResponse {
|
|
3639
|
-
/**
|
|
4319
|
+
/**
|
|
4320
|
+
* The retrieved forms.
|
|
4321
|
+
* @maxSize 100
|
|
4322
|
+
*/
|
|
3640
4323
|
forms?: Form[];
|
|
3641
4324
|
/** Details on the paged set of results returned. */
|
|
3642
4325
|
pagingMetadata?: CursorPagingMetadata;
|
|
3643
4326
|
}
|
|
3644
4327
|
export interface GetDeletedFormRequest {
|
|
3645
|
-
/**
|
|
4328
|
+
/**
|
|
4329
|
+
* Id of the Form to retrieve
|
|
4330
|
+
* @format GUID
|
|
4331
|
+
*/
|
|
3646
4332
|
formId: string;
|
|
3647
4333
|
}
|
|
3648
4334
|
export interface GetDeletedFormResponse {
|
|
@@ -3654,17 +4340,28 @@ export interface QueryDeletedFormsRequest {
|
|
|
3654
4340
|
query: CursorQuery;
|
|
3655
4341
|
}
|
|
3656
4342
|
export interface QueryDeletedFormsResponse {
|
|
3657
|
-
/**
|
|
4343
|
+
/**
|
|
4344
|
+
* The retrieved Forms
|
|
4345
|
+
* @maxSize 100
|
|
4346
|
+
*/
|
|
3658
4347
|
forms?: Form[];
|
|
3659
4348
|
/** Details on the paged set of results returned. */
|
|
3660
4349
|
metadata?: CursorPagingMetadata;
|
|
3661
4350
|
}
|
|
3662
4351
|
export interface ListDeletedFormsRequest {
|
|
3663
|
-
/**
|
|
4352
|
+
/**
|
|
4353
|
+
* Namespace name.
|
|
4354
|
+
* @minLength 10
|
|
4355
|
+
* @maxLength 50
|
|
4356
|
+
*/
|
|
3664
4357
|
namespace: string;
|
|
3665
4358
|
/** Identifies if the form is disabled. */
|
|
3666
4359
|
disabled?: boolean | null;
|
|
3667
|
-
/**
|
|
4360
|
+
/**
|
|
4361
|
+
* Form ids.
|
|
4362
|
+
* @maxSize 100
|
|
4363
|
+
* @format GUID
|
|
4364
|
+
*/
|
|
3668
4365
|
formIds?: string[];
|
|
3669
4366
|
/**
|
|
3670
4367
|
* Ordering options.
|
|
@@ -3693,15 +4390,25 @@ export declare enum ListDeletedFormsOrder {
|
|
|
3693
4390
|
NAME_ASC = "NAME_ASC"
|
|
3694
4391
|
}
|
|
3695
4392
|
export interface ListDeletedFormsResponse {
|
|
3696
|
-
/**
|
|
4393
|
+
/**
|
|
4394
|
+
* The retrieved forms.
|
|
4395
|
+
* @maxSize 100
|
|
4396
|
+
*/
|
|
3697
4397
|
forms?: Form[];
|
|
3698
4398
|
/** Details on the paged set of results returned. */
|
|
3699
4399
|
pagingMetadata?: CursorPagingMetadata;
|
|
3700
4400
|
}
|
|
3701
4401
|
export interface BulkRemoveDeletedFieldRequest {
|
|
3702
|
-
/**
|
|
4402
|
+
/**
|
|
4403
|
+
* Id of the form to delete.
|
|
4404
|
+
* @format GUID
|
|
4405
|
+
*/
|
|
3703
4406
|
formId: string;
|
|
3704
|
-
/**
|
|
4407
|
+
/**
|
|
4408
|
+
* Ids of the deleted fields to remove.
|
|
4409
|
+
* @maxSize 100
|
|
4410
|
+
* @format GUID
|
|
4411
|
+
*/
|
|
3705
4412
|
fieldsIds?: string[];
|
|
3706
4413
|
}
|
|
3707
4414
|
export interface BulkRemoveDeletedFieldResponse {
|
|
@@ -3717,7 +4424,11 @@ export interface UpdateExtendedFieldsRequest {
|
|
|
3717
4424
|
namespaceData: Record<string, any> | null;
|
|
3718
4425
|
}
|
|
3719
4426
|
export interface UpdateExtendedFieldsResponse {
|
|
3720
|
-
/**
|
|
4427
|
+
/**
|
|
4428
|
+
* namespace that was updated
|
|
4429
|
+
* @minLength 10
|
|
4430
|
+
* @maxLength 50
|
|
4431
|
+
*/
|
|
3721
4432
|
namespace?: string;
|
|
3722
4433
|
/** only data from UpdateExtendedFieldsRequest namespace_data */
|
|
3723
4434
|
namespaceData?: Record<string, any> | null;
|
|
@@ -3725,23 +4436,42 @@ export interface UpdateExtendedFieldsResponse {
|
|
|
3725
4436
|
export interface ListFormsProvidersConfigsRequest {
|
|
3726
4437
|
}
|
|
3727
4438
|
export interface ListFormsProvidersConfigsResponse {
|
|
3728
|
-
/**
|
|
4439
|
+
/**
|
|
4440
|
+
* List of configs set by form providers
|
|
4441
|
+
* @maxSize 50
|
|
4442
|
+
*/
|
|
3729
4443
|
configs?: FormsSchemaProvidersConfig[];
|
|
3730
4444
|
}
|
|
3731
4445
|
export interface FormsSchemaProvidersConfig {
|
|
3732
|
-
/**
|
|
4446
|
+
/**
|
|
4447
|
+
* Namespace which can be used to create form
|
|
4448
|
+
* @maxLength 50
|
|
4449
|
+
*/
|
|
3733
4450
|
namespace?: string;
|
|
3734
|
-
/**
|
|
4451
|
+
/**
|
|
4452
|
+
* Id of app which provides this config.
|
|
4453
|
+
* @maxLength 36
|
|
4454
|
+
*/
|
|
3735
4455
|
appId?: string;
|
|
3736
4456
|
/** Restrictions associated with this namespace. */
|
|
3737
4457
|
restrictions?: FormProviderRestrictions;
|
|
3738
4458
|
}
|
|
3739
4459
|
export interface FormProviderRestrictions {
|
|
3740
|
-
/**
|
|
4460
|
+
/**
|
|
4461
|
+
* Maximum amount of forms allowed per namespace.
|
|
4462
|
+
* @max 15000
|
|
4463
|
+
*/
|
|
3741
4464
|
maxFormsAmount?: number;
|
|
3742
|
-
/**
|
|
4465
|
+
/**
|
|
4466
|
+
* Maximum amount of fields allowed per form.
|
|
4467
|
+
* @max 200
|
|
4468
|
+
*/
|
|
3743
4469
|
maxFieldsAmount?: number;
|
|
3744
|
-
/**
|
|
4470
|
+
/**
|
|
4471
|
+
* Maximum amount of deleted forms allowed per namespace.
|
|
4472
|
+
* @min 1000
|
|
4473
|
+
* @max 1000
|
|
4474
|
+
*/
|
|
3745
4475
|
maxDeletedFormsAmount?: number | null;
|
|
3746
4476
|
}
|
|
3747
4477
|
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
@@ -3819,7 +4549,10 @@ export interface ActionEvent {
|
|
|
3819
4549
|
export interface Empty {
|
|
3820
4550
|
}
|
|
3821
4551
|
export interface GetFormSummaryRequest {
|
|
3822
|
-
/**
|
|
4552
|
+
/**
|
|
4553
|
+
* Id of the form to retrieve.
|
|
4554
|
+
* @format GUID
|
|
4555
|
+
*/
|
|
3823
4556
|
formId: string;
|
|
3824
4557
|
}
|
|
3825
4558
|
export interface GetFormSummaryResponse {
|
|
@@ -3827,9 +4560,15 @@ export interface GetFormSummaryResponse {
|
|
|
3827
4560
|
formSummary?: FormSummary;
|
|
3828
4561
|
}
|
|
3829
4562
|
export interface FormSummary {
|
|
3830
|
-
/**
|
|
4563
|
+
/**
|
|
4564
|
+
* Form ID.
|
|
4565
|
+
* @format GUID
|
|
4566
|
+
*/
|
|
3831
4567
|
id?: string;
|
|
3832
|
-
/**
|
|
4568
|
+
/**
|
|
4569
|
+
* Summarized form fields.
|
|
4570
|
+
* @maxSize 500
|
|
4571
|
+
*/
|
|
3833
4572
|
fields?: Field[];
|
|
3834
4573
|
}
|
|
3835
4574
|
export declare enum FieldInputType {
|
|
@@ -3859,32 +4598,57 @@ export declare enum FieldInputType {
|
|
|
3859
4598
|
DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
|
|
3860
4599
|
}
|
|
3861
4600
|
export interface FieldOption {
|
|
3862
|
-
/**
|
|
4601
|
+
/**
|
|
4602
|
+
* Selectable option label
|
|
4603
|
+
* @maxLength 400
|
|
4604
|
+
*/
|
|
3863
4605
|
label?: string | null;
|
|
3864
|
-
/**
|
|
4606
|
+
/**
|
|
4607
|
+
* Selectable option value, which is saved to DB.
|
|
4608
|
+
* @maxLength 400
|
|
4609
|
+
*/
|
|
3865
4610
|
value?: string | null;
|
|
3866
4611
|
}
|
|
3867
4612
|
export interface Field {
|
|
3868
|
-
/**
|
|
4613
|
+
/**
|
|
4614
|
+
* Definition of a target where the value of field belongs.
|
|
4615
|
+
* @maxLength 200
|
|
4616
|
+
* @immutable
|
|
4617
|
+
*/
|
|
3869
4618
|
target?: string | null;
|
|
3870
|
-
/**
|
|
4619
|
+
/**
|
|
4620
|
+
* Label of the field
|
|
4621
|
+
* @maxLength 350
|
|
4622
|
+
*/
|
|
3871
4623
|
label?: string | null;
|
|
3872
4624
|
/** Input type of the field */
|
|
3873
4625
|
type?: FieldInputType;
|
|
3874
|
-
/**
|
|
4626
|
+
/**
|
|
4627
|
+
* List of options to select from
|
|
4628
|
+
* @maxSize 400
|
|
4629
|
+
*/
|
|
3875
4630
|
options?: FieldOption[];
|
|
3876
4631
|
/**
|
|
3877
4632
|
* Flag indicating whether field is deleted.
|
|
3878
4633
|
* Default: false.
|
|
3879
4634
|
*/
|
|
3880
4635
|
deleted?: boolean;
|
|
3881
|
-
/**
|
|
4636
|
+
/**
|
|
4637
|
+
* Id of the field.
|
|
4638
|
+
* @format GUID
|
|
4639
|
+
*/
|
|
3882
4640
|
id?: string;
|
|
3883
4641
|
}
|
|
3884
4642
|
export interface MessageEnvelope {
|
|
3885
|
-
/**
|
|
4643
|
+
/**
|
|
4644
|
+
* App instance ID.
|
|
4645
|
+
* @format GUID
|
|
4646
|
+
*/
|
|
3886
4647
|
instanceId?: string | null;
|
|
3887
|
-
/**
|
|
4648
|
+
/**
|
|
4649
|
+
* Event type.
|
|
4650
|
+
* @maxLength 150
|
|
4651
|
+
*/
|
|
3888
4652
|
eventType?: string;
|
|
3889
4653
|
/** The identification type and identity data. */
|
|
3890
4654
|
identity?: IdentificationData;
|
|
@@ -3892,26 +4656,50 @@ export interface MessageEnvelope {
|
|
|
3892
4656
|
data?: string;
|
|
3893
4657
|
}
|
|
3894
4658
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3895
|
-
/**
|
|
4659
|
+
/**
|
|
4660
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4661
|
+
* @format GUID
|
|
4662
|
+
*/
|
|
3896
4663
|
anonymousVisitorId?: string;
|
|
3897
|
-
/**
|
|
4664
|
+
/**
|
|
4665
|
+
* ID of a site visitor that has logged in to the site.
|
|
4666
|
+
* @format GUID
|
|
4667
|
+
*/
|
|
3898
4668
|
memberId?: string;
|
|
3899
|
-
/**
|
|
4669
|
+
/**
|
|
4670
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4671
|
+
* @format GUID
|
|
4672
|
+
*/
|
|
3900
4673
|
wixUserId?: string;
|
|
3901
|
-
/**
|
|
4674
|
+
/**
|
|
4675
|
+
* ID of an app.
|
|
4676
|
+
* @format GUID
|
|
4677
|
+
*/
|
|
3902
4678
|
appId?: string;
|
|
3903
4679
|
/** @readonly */
|
|
3904
4680
|
identityType?: WebhookIdentityType;
|
|
3905
4681
|
}
|
|
3906
4682
|
/** @oneof */
|
|
3907
4683
|
export interface IdentificationDataIdOneOf {
|
|
3908
|
-
/**
|
|
4684
|
+
/**
|
|
4685
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4686
|
+
* @format GUID
|
|
4687
|
+
*/
|
|
3909
4688
|
anonymousVisitorId?: string;
|
|
3910
|
-
/**
|
|
4689
|
+
/**
|
|
4690
|
+
* ID of a site visitor that has logged in to the site.
|
|
4691
|
+
* @format GUID
|
|
4692
|
+
*/
|
|
3911
4693
|
memberId?: string;
|
|
3912
|
-
/**
|
|
4694
|
+
/**
|
|
4695
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4696
|
+
* @format GUID
|
|
4697
|
+
*/
|
|
3913
4698
|
wixUserId?: string;
|
|
3914
|
-
/**
|
|
4699
|
+
/**
|
|
4700
|
+
* ID of an app.
|
|
4701
|
+
* @format GUID
|
|
4702
|
+
*/
|
|
3915
4703
|
appId?: string;
|
|
3916
4704
|
}
|
|
3917
4705
|
export declare enum WebhookIdentityType {
|