@wix/auto_sdk_forms_forms 1.0.4 → 1.0.6
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 -234
- 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 -242
- 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 -234
- 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 -242
- 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 -234
- 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 -242
- 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 -234
- 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 -242
- 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,24 @@
|
|
|
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.
|
|
9
|
-
* @
|
|
10
|
+
* @maxSize 500
|
|
10
11
|
*/
|
|
11
12
|
fieldsV2?: FormFieldV2[];
|
|
12
|
-
/**
|
|
13
|
+
/**
|
|
14
|
+
* Defines the layout for form fields in each submission step.
|
|
15
|
+
* @maxSize 100
|
|
16
|
+
*/
|
|
13
17
|
steps?: Step[];
|
|
14
|
-
/**
|
|
18
|
+
/**
|
|
19
|
+
* Form rules, can be applied to layout and items properties.
|
|
20
|
+
* @maxSize 100
|
|
21
|
+
*/
|
|
15
22
|
rules?: FormRule[];
|
|
16
23
|
/**
|
|
17
24
|
* 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 +39,28 @@ export interface Form {
|
|
|
32
39
|
properties?: FormProperties;
|
|
33
40
|
/**
|
|
34
41
|
* Fields which were soft deleted.
|
|
42
|
+
* @maxSize 150
|
|
35
43
|
* @readonly
|
|
36
44
|
*/
|
|
37
45
|
deletedFields?: FormField[];
|
|
38
46
|
/**
|
|
39
47
|
* List of form fields that represent input elements.
|
|
48
|
+
* @maxSize 150
|
|
40
49
|
* @readonly
|
|
41
50
|
*/
|
|
42
51
|
deletedFieldsV2?: FormFieldV2[];
|
|
43
52
|
/** Data extensions ExtendedFields. */
|
|
44
53
|
extendedFields?: ExtendedFields;
|
|
45
|
-
/**
|
|
54
|
+
/**
|
|
55
|
+
* Identifies the namespace that the form belongs to.
|
|
56
|
+
* @minLength 10
|
|
57
|
+
* @maxLength 50
|
|
58
|
+
* @immutable
|
|
59
|
+
*/
|
|
46
60
|
namespace?: string;
|
|
47
61
|
/**
|
|
48
62
|
* Media folder ID.
|
|
63
|
+
* @maxLength 100
|
|
49
64
|
* @readonly
|
|
50
65
|
*/
|
|
51
66
|
mediaFolderId?: string | null;
|
|
@@ -60,15 +75,23 @@ export interface Form {
|
|
|
60
75
|
requiredIndicatorProperties?: RequiredIndicatorProperties;
|
|
61
76
|
/** Settings for actions to be taken after form submission. */
|
|
62
77
|
submitSettings?: SubmitSettings;
|
|
63
|
-
/**
|
|
78
|
+
/**
|
|
79
|
+
* Settings for field groups
|
|
80
|
+
* @maxSize 50
|
|
81
|
+
*/
|
|
64
82
|
fieldGroups?: FieldGroup[];
|
|
65
83
|
/** Message shown when the form is disabled */
|
|
66
84
|
disabledFormMessage?: RichContent;
|
|
67
85
|
/**
|
|
68
|
-
* Identifies if the form is
|
|
86
|
+
* Identifies if the form is enabled.
|
|
69
87
|
* Default true
|
|
70
88
|
*/
|
|
71
89
|
enabled?: boolean | null;
|
|
90
|
+
/**
|
|
91
|
+
* Form name.
|
|
92
|
+
* @maxLength 200
|
|
93
|
+
*/
|
|
94
|
+
name?: string | null;
|
|
72
95
|
}
|
|
73
96
|
export declare enum RequiredIndicator {
|
|
74
97
|
/** Unknown required indicator. */
|
|
@@ -89,9 +112,17 @@ export declare enum RequiredIndicatorPlacement {
|
|
|
89
112
|
BEFORE_FIELD_TITLE = "BEFORE_FIELD_TITLE"
|
|
90
113
|
}
|
|
91
114
|
export interface FormField {
|
|
92
|
-
/**
|
|
115
|
+
/**
|
|
116
|
+
* Item ID.
|
|
117
|
+
* @format GUID
|
|
118
|
+
* @immutable
|
|
119
|
+
*/
|
|
93
120
|
id?: string;
|
|
94
|
-
/**
|
|
121
|
+
/**
|
|
122
|
+
* Definition of a target where the value of field belongs.
|
|
123
|
+
* @maxLength 200
|
|
124
|
+
* @immutable
|
|
125
|
+
*/
|
|
95
126
|
target?: string | null;
|
|
96
127
|
/** Validation of field output value. */
|
|
97
128
|
validation?: Validation;
|
|
@@ -120,17 +151,30 @@ export interface StringType extends StringTypeFormatOptionsOneOf {
|
|
|
120
151
|
dateOptionalTimeOptions?: DateTimeConstraints;
|
|
121
152
|
/** PHONE format options */
|
|
122
153
|
phoneOptions?: PhoneConstraints;
|
|
123
|
-
/**
|
|
154
|
+
/**
|
|
155
|
+
* Minimum length.
|
|
156
|
+
* @max 20000
|
|
157
|
+
*/
|
|
124
158
|
minLength?: number | null;
|
|
125
|
-
/**
|
|
159
|
+
/**
|
|
160
|
+
* Maximum length.
|
|
161
|
+
* @max 20000
|
|
162
|
+
*/
|
|
126
163
|
maxLength?: number | null;
|
|
127
|
-
/**
|
|
164
|
+
/**
|
|
165
|
+
* Pattern for a regular expression match.
|
|
166
|
+
* @maxLength 500
|
|
167
|
+
*/
|
|
128
168
|
pattern?: string | null;
|
|
129
169
|
/** Format of a string. */
|
|
130
170
|
format?: FormatEnumFormat;
|
|
131
171
|
/** Custom error messages when validation fails. */
|
|
132
172
|
errorMessages?: StringErrorMessages;
|
|
133
|
-
/**
|
|
173
|
+
/**
|
|
174
|
+
* List of allowed values.
|
|
175
|
+
* @maxSize 500
|
|
176
|
+
* @maxLength 20000
|
|
177
|
+
*/
|
|
134
178
|
enum?: string[] | null;
|
|
135
179
|
}
|
|
136
180
|
/** @oneof */
|
|
@@ -163,7 +207,10 @@ export declare enum FormatEnumFormat {
|
|
|
163
207
|
DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
|
|
164
208
|
}
|
|
165
209
|
export interface StringErrorMessages {
|
|
166
|
-
/**
|
|
210
|
+
/**
|
|
211
|
+
* Default error message on invalid validation.
|
|
212
|
+
* @maxLength 200
|
|
213
|
+
*/
|
|
167
214
|
default?: string | null;
|
|
168
215
|
}
|
|
169
216
|
export interface DateTimeConstraints {
|
|
@@ -172,6 +219,7 @@ export interface DateTimeConstraints {
|
|
|
172
219
|
* dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
|
|
173
220
|
* The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
|
|
174
221
|
* The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
|
|
222
|
+
* @maxLength 50
|
|
175
223
|
*/
|
|
176
224
|
minimum?: string | null;
|
|
177
225
|
/**
|
|
@@ -179,11 +227,16 @@ export interface DateTimeConstraints {
|
|
|
179
227
|
* dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
|
|
180
228
|
* The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
|
|
181
229
|
* The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
|
|
230
|
+
* @maxLength 50
|
|
182
231
|
*/
|
|
183
232
|
maximum?: string | null;
|
|
184
233
|
}
|
|
185
234
|
export interface PhoneConstraints {
|
|
186
|
-
/**
|
|
235
|
+
/**
|
|
236
|
+
* Country codes for phone number that are allowed
|
|
237
|
+
* @maxSize 250
|
|
238
|
+
* @maxLength 2
|
|
239
|
+
*/
|
|
187
240
|
allowedCountryCodes?: string[];
|
|
188
241
|
}
|
|
189
242
|
export interface NumberType {
|
|
@@ -195,11 +248,17 @@ export interface NumberType {
|
|
|
195
248
|
multipleOf?: number | null;
|
|
196
249
|
/** Custom error message when validation fails. */
|
|
197
250
|
errorMessages?: NumberErrorMessages;
|
|
198
|
-
/**
|
|
251
|
+
/**
|
|
252
|
+
* List of allowed values.
|
|
253
|
+
* @maxSize 500
|
|
254
|
+
*/
|
|
199
255
|
enum?: number[] | null;
|
|
200
256
|
}
|
|
201
257
|
export interface NumberErrorMessages {
|
|
202
|
-
/**
|
|
258
|
+
/**
|
|
259
|
+
* Default error message on invalid validation.
|
|
260
|
+
* @maxLength 200
|
|
261
|
+
*/
|
|
203
262
|
default?: string | null;
|
|
204
263
|
}
|
|
205
264
|
export interface IntegerType {
|
|
@@ -211,23 +270,38 @@ export interface IntegerType {
|
|
|
211
270
|
multipleOf?: number | null;
|
|
212
271
|
/** Custom error message when validation fails. */
|
|
213
272
|
errorMessages?: NumberErrorMessages;
|
|
214
|
-
/**
|
|
273
|
+
/**
|
|
274
|
+
* List of allowed values.
|
|
275
|
+
* @maxSize 500
|
|
276
|
+
*/
|
|
215
277
|
enum?: number[] | null;
|
|
216
278
|
}
|
|
217
279
|
export interface BooleanType {
|
|
218
280
|
/** Custom error message when validation fails. */
|
|
219
281
|
errorMessages?: BooleanErrorMessages;
|
|
220
|
-
/**
|
|
282
|
+
/**
|
|
283
|
+
* List of allowed values.
|
|
284
|
+
* @maxSize 2
|
|
285
|
+
*/
|
|
221
286
|
enum?: boolean[];
|
|
222
287
|
}
|
|
223
288
|
export interface BooleanErrorMessages {
|
|
224
|
-
/**
|
|
289
|
+
/**
|
|
290
|
+
* Default error message on invalid validation.
|
|
291
|
+
* @maxLength 200
|
|
292
|
+
*/
|
|
225
293
|
default?: string | null;
|
|
226
294
|
}
|
|
227
295
|
export interface ArrayType {
|
|
228
|
-
/**
|
|
296
|
+
/**
|
|
297
|
+
* Maximum amount of array elements.
|
|
298
|
+
* @max 1000
|
|
299
|
+
*/
|
|
229
300
|
maxItems?: number | null;
|
|
230
|
-
/**
|
|
301
|
+
/**
|
|
302
|
+
* Minimum amount of array elements.
|
|
303
|
+
* @max 1000
|
|
304
|
+
*/
|
|
231
305
|
minItems?: number | null;
|
|
232
306
|
/** Type of items allowed in array. */
|
|
233
307
|
items?: ArrayItems;
|
|
@@ -268,7 +342,10 @@ export interface PropertiesTypePropertiesTypeOneOf {
|
|
|
268
342
|
array?: ArrayType;
|
|
269
343
|
}
|
|
270
344
|
export interface ObjectErrorMessages {
|
|
271
|
-
/**
|
|
345
|
+
/**
|
|
346
|
+
* Default error message on invalid validation.
|
|
347
|
+
* @maxLength 200
|
|
348
|
+
*/
|
|
272
349
|
default?: string | null;
|
|
273
350
|
}
|
|
274
351
|
export interface ArrayItems extends ArrayItemsItemsOneOf {
|
|
@@ -297,7 +374,10 @@ export interface ArrayItemsItemsOneOf {
|
|
|
297
374
|
object?: ObjectType;
|
|
298
375
|
}
|
|
299
376
|
export interface ArrayErrorMessages {
|
|
300
|
-
/**
|
|
377
|
+
/**
|
|
378
|
+
* Default error message on invalid validation.
|
|
379
|
+
* @maxLength 200
|
|
380
|
+
*/
|
|
301
381
|
default?: string | null;
|
|
302
382
|
}
|
|
303
383
|
export interface PredefinedValidation extends PredefinedValidationFormatOptionsOneOf {
|
|
@@ -327,11 +407,21 @@ export declare enum ValidationFormat {
|
|
|
327
407
|
SCHEDULING = "SCHEDULING"
|
|
328
408
|
}
|
|
329
409
|
export interface PaymentType {
|
|
330
|
-
/**
|
|
410
|
+
/**
|
|
411
|
+
* Field mapped to products.
|
|
412
|
+
* @minSize 1
|
|
413
|
+
* @maxSize 100
|
|
414
|
+
*/
|
|
331
415
|
products?: Product[];
|
|
332
|
-
/**
|
|
416
|
+
/**
|
|
417
|
+
* Minimum amount of different products.
|
|
418
|
+
* @max 100
|
|
419
|
+
*/
|
|
333
420
|
minItems?: number | null;
|
|
334
|
-
/**
|
|
421
|
+
/**
|
|
422
|
+
* Maximum amount of different products.
|
|
423
|
+
* @max 100
|
|
424
|
+
*/
|
|
335
425
|
maxItems?: number | null;
|
|
336
426
|
}
|
|
337
427
|
export declare enum ProductType {
|
|
@@ -351,19 +441,36 @@ export declare enum PriceType {
|
|
|
351
441
|
DYNAMIC_PRICE = "DYNAMIC_PRICE"
|
|
352
442
|
}
|
|
353
443
|
export interface QuantityLimit {
|
|
354
|
-
/**
|
|
444
|
+
/**
|
|
445
|
+
* Minimum quantity.
|
|
446
|
+
* @min 1
|
|
447
|
+
* @max 100000
|
|
448
|
+
*/
|
|
355
449
|
minimum?: number | null;
|
|
356
|
-
/**
|
|
450
|
+
/**
|
|
451
|
+
* Maximum quantity.
|
|
452
|
+
* @min 1
|
|
453
|
+
* @max 100000
|
|
454
|
+
*/
|
|
357
455
|
maximum?: number | null;
|
|
358
456
|
}
|
|
359
457
|
export interface FixedPriceOptions {
|
|
360
|
-
/**
|
|
458
|
+
/**
|
|
459
|
+
* Fixed price monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99).
|
|
460
|
+
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
461
|
+
*/
|
|
361
462
|
price?: string;
|
|
362
463
|
}
|
|
363
464
|
export interface DynamicPriceOptions {
|
|
364
|
-
/**
|
|
465
|
+
/**
|
|
466
|
+
* Minimal price monetary amount.
|
|
467
|
+
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
468
|
+
*/
|
|
365
469
|
minPrice?: string;
|
|
366
|
-
/**
|
|
470
|
+
/**
|
|
471
|
+
* Maximal price monetary amount.
|
|
472
|
+
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
473
|
+
*/
|
|
367
474
|
maxPrice?: string | null;
|
|
368
475
|
}
|
|
369
476
|
export interface Product extends ProductPriceOptionsOneOf {
|
|
@@ -373,6 +480,7 @@ export interface Product extends ProductPriceOptionsOneOf {
|
|
|
373
480
|
dynamicPriceOptions?: DynamicPriceOptions;
|
|
374
481
|
/**
|
|
375
482
|
* Product ID.
|
|
483
|
+
* @format GUID
|
|
376
484
|
* @readonly
|
|
377
485
|
*/
|
|
378
486
|
id?: string;
|
|
@@ -391,7 +499,11 @@ export interface ProductPriceOptionsOneOf {
|
|
|
391
499
|
dynamicPriceOptions?: DynamicPriceOptions;
|
|
392
500
|
}
|
|
393
501
|
export interface MultilineAddressValidation {
|
|
394
|
-
/**
|
|
502
|
+
/**
|
|
503
|
+
* Allowed countries. No countries treated as all.
|
|
504
|
+
* @format COUNTRY
|
|
505
|
+
* @maxSize 200
|
|
506
|
+
*/
|
|
395
507
|
allowedCountries?: string[];
|
|
396
508
|
/** Fields overrides. */
|
|
397
509
|
fields?: FieldsOverrides;
|
|
@@ -460,7 +572,12 @@ export interface ValidationValidationOneOf {
|
|
|
460
572
|
predefined?: PredefinedValidation;
|
|
461
573
|
}
|
|
462
574
|
export interface DataExtensionsDetails {
|
|
463
|
-
/**
|
|
575
|
+
/**
|
|
576
|
+
* FQDNS which can be extended with this field
|
|
577
|
+
* @maxSize 10
|
|
578
|
+
* @maxLength 100
|
|
579
|
+
* @immutable
|
|
580
|
+
*/
|
|
464
581
|
fqdns?: string[];
|
|
465
582
|
}
|
|
466
583
|
export interface NestedFormOverrides {
|
|
@@ -472,7 +589,11 @@ export interface FormFieldV2 extends FormFieldV2FieldTypeOptionsOneOf {
|
|
|
472
589
|
inputOptions?: InputField;
|
|
473
590
|
/** Field for displaying information such as header or text paragraph */
|
|
474
591
|
displayOptions?: DisplayField;
|
|
475
|
-
/**
|
|
592
|
+
/**
|
|
593
|
+
* Field id.
|
|
594
|
+
* @format GUID
|
|
595
|
+
* @immutable
|
|
596
|
+
*/
|
|
476
597
|
id?: string;
|
|
477
598
|
/**
|
|
478
599
|
* Whether the field is hidden.
|
|
@@ -503,17 +624,30 @@ export interface InputFieldStringType extends InputFieldStringTypeFormatOptionsO
|
|
|
503
624
|
dateOptionalTimeOptions?: StringTypeDateTimeConstraints;
|
|
504
625
|
/** PHONE format options */
|
|
505
626
|
phoneOptions?: StringTypePhoneConstraints;
|
|
506
|
-
/**
|
|
627
|
+
/**
|
|
628
|
+
* Minimum length.
|
|
629
|
+
* @max 20000
|
|
630
|
+
*/
|
|
507
631
|
minLength?: number | null;
|
|
508
|
-
/**
|
|
632
|
+
/**
|
|
633
|
+
* Maximum length.
|
|
634
|
+
* @max 20000
|
|
635
|
+
*/
|
|
509
636
|
maxLength?: number | null;
|
|
510
|
-
/**
|
|
637
|
+
/**
|
|
638
|
+
* Pattern for a regular expression match.
|
|
639
|
+
* @maxLength 500
|
|
640
|
+
*/
|
|
511
641
|
pattern?: string | null;
|
|
512
642
|
/** Format of a string. */
|
|
513
643
|
format?: StringTypeFormatEnumFormat;
|
|
514
644
|
/** Custom error messages when validation fails. */
|
|
515
645
|
errorMessages?: InputFieldStringErrorMessages;
|
|
516
|
-
/**
|
|
646
|
+
/**
|
|
647
|
+
* List of allowed values.
|
|
648
|
+
* @maxSize 500
|
|
649
|
+
* @maxLength 20000
|
|
650
|
+
*/
|
|
517
651
|
enum?: string[] | null;
|
|
518
652
|
}
|
|
519
653
|
/** @oneof */
|
|
@@ -546,7 +680,10 @@ export declare enum StringTypeFormatEnumFormat {
|
|
|
546
680
|
DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
|
|
547
681
|
}
|
|
548
682
|
export interface InputFieldStringErrorMessages {
|
|
549
|
-
/**
|
|
683
|
+
/**
|
|
684
|
+
* Default error message on invalid validation.
|
|
685
|
+
* @maxLength 200
|
|
686
|
+
*/
|
|
550
687
|
default?: string | null;
|
|
551
688
|
}
|
|
552
689
|
export interface StringTypeDateTimeConstraints {
|
|
@@ -555,6 +692,7 @@ export interface StringTypeDateTimeConstraints {
|
|
|
555
692
|
* dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
|
|
556
693
|
* The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
|
|
557
694
|
* The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
|
|
695
|
+
* @maxLength 50
|
|
558
696
|
*/
|
|
559
697
|
minimum?: string | null;
|
|
560
698
|
/**
|
|
@@ -562,11 +700,16 @@ export interface StringTypeDateTimeConstraints {
|
|
|
562
700
|
* dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
|
|
563
701
|
* The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
|
|
564
702
|
* The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
|
|
703
|
+
* @maxLength 50
|
|
565
704
|
*/
|
|
566
705
|
maximum?: string | null;
|
|
567
706
|
}
|
|
568
707
|
export interface StringTypePhoneConstraints {
|
|
569
|
-
/**
|
|
708
|
+
/**
|
|
709
|
+
* Country codes for phone number that are allowed
|
|
710
|
+
* @maxSize 250
|
|
711
|
+
* @maxLength 2
|
|
712
|
+
*/
|
|
570
713
|
allowedCountryCodes?: string[];
|
|
571
714
|
}
|
|
572
715
|
export declare enum StringComponentType {
|
|
@@ -581,18 +724,27 @@ export declare enum StringComponentType {
|
|
|
581
724
|
DATE_PICKER = "DATE_PICKER"
|
|
582
725
|
}
|
|
583
726
|
export interface TextInput {
|
|
584
|
-
/**
|
|
727
|
+
/**
|
|
728
|
+
* Label of the field
|
|
729
|
+
* @maxLength 350
|
|
730
|
+
*/
|
|
585
731
|
label?: string | null;
|
|
586
732
|
/** Description of the field */
|
|
587
733
|
description?: RichContent;
|
|
588
|
-
/**
|
|
734
|
+
/**
|
|
735
|
+
* Placeholder for the value input
|
|
736
|
+
* @maxLength 100
|
|
737
|
+
*/
|
|
589
738
|
placeholder?: string | null;
|
|
590
739
|
/**
|
|
591
740
|
* Flag identifying to hide or not label
|
|
592
741
|
* Default: true
|
|
593
742
|
*/
|
|
594
743
|
showLabel?: boolean | null;
|
|
595
|
-
/**
|
|
744
|
+
/**
|
|
745
|
+
* Default value for the text input
|
|
746
|
+
* @maxLength 20000
|
|
747
|
+
*/
|
|
596
748
|
default?: string | null;
|
|
597
749
|
}
|
|
598
750
|
export interface RichContent {
|
|
@@ -1193,11 +1345,20 @@ export interface GIFData {
|
|
|
1193
1345
|
gifType?: GIFType;
|
|
1194
1346
|
}
|
|
1195
1347
|
export interface GIF {
|
|
1196
|
-
/**
|
|
1348
|
+
/**
|
|
1349
|
+
* GIF format URL.
|
|
1350
|
+
* @format WEB_URL
|
|
1351
|
+
*/
|
|
1197
1352
|
gif?: string | null;
|
|
1198
|
-
/**
|
|
1353
|
+
/**
|
|
1354
|
+
* MP4 format URL.
|
|
1355
|
+
* @format WEB_URL
|
|
1356
|
+
*/
|
|
1199
1357
|
mp4?: string | null;
|
|
1200
|
-
/**
|
|
1358
|
+
/**
|
|
1359
|
+
* Thumbnail URL.
|
|
1360
|
+
* @format WEB_URL
|
|
1361
|
+
*/
|
|
1201
1362
|
still?: string | null;
|
|
1202
1363
|
}
|
|
1203
1364
|
export declare enum GIFType {
|
|
@@ -1271,7 +1432,10 @@ export interface ImageData {
|
|
|
1271
1432
|
export interface StylesBorder {
|
|
1272
1433
|
/** Border width in pixels. */
|
|
1273
1434
|
width?: number | null;
|
|
1274
|
-
/**
|
|
1435
|
+
/**
|
|
1436
|
+
* Border color as a hexadecimal value.
|
|
1437
|
+
* @format COLOR_HEX
|
|
1438
|
+
*/
|
|
1275
1439
|
color?: string | null;
|
|
1276
1440
|
/** Border radius in pixels. */
|
|
1277
1441
|
radius?: number | null;
|
|
@@ -1425,13 +1589,22 @@ export declare enum BackgroundType {
|
|
|
1425
1589
|
export interface Gradient {
|
|
1426
1590
|
/** The gradient angle in degrees. */
|
|
1427
1591
|
angle?: number | null;
|
|
1428
|
-
/**
|
|
1592
|
+
/**
|
|
1593
|
+
* The start color as a hexademical value.
|
|
1594
|
+
* @format COLOR_HEX
|
|
1595
|
+
*/
|
|
1429
1596
|
startColor?: string | null;
|
|
1430
|
-
/**
|
|
1597
|
+
/**
|
|
1598
|
+
* The end color as a hexademical value.
|
|
1599
|
+
* @format COLOR_HEX
|
|
1600
|
+
*/
|
|
1431
1601
|
lastColor?: string | null;
|
|
1432
1602
|
}
|
|
1433
1603
|
export interface Background extends BackgroundBackgroundOneOf {
|
|
1434
|
-
/**
|
|
1604
|
+
/**
|
|
1605
|
+
* The background color as a hexademical value.
|
|
1606
|
+
* @format COLOR_HEX
|
|
1607
|
+
*/
|
|
1435
1608
|
color?: string | null;
|
|
1436
1609
|
/** An image to use for the background. */
|
|
1437
1610
|
image?: Media;
|
|
@@ -1442,7 +1615,10 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1442
1615
|
}
|
|
1443
1616
|
/** @oneof */
|
|
1444
1617
|
export interface BackgroundBackgroundOneOf {
|
|
1445
|
-
/**
|
|
1618
|
+
/**
|
|
1619
|
+
* The background color as a hexademical value.
|
|
1620
|
+
* @format COLOR_HEX
|
|
1621
|
+
*/
|
|
1446
1622
|
color?: string | null;
|
|
1447
1623
|
/** An image to use for the background. */
|
|
1448
1624
|
image?: Media;
|
|
@@ -1754,17 +1930,32 @@ export declare enum VerticalAlignment {
|
|
|
1754
1930
|
export interface CellStyle {
|
|
1755
1931
|
/** Vertical alignment for the cell's text. */
|
|
1756
1932
|
verticalAlignment?: VerticalAlignment;
|
|
1757
|
-
/**
|
|
1933
|
+
/**
|
|
1934
|
+
* Cell background color as a hexadecimal value.
|
|
1935
|
+
* @format COLOR_HEX
|
|
1936
|
+
*/
|
|
1758
1937
|
backgroundColor?: string | null;
|
|
1759
1938
|
}
|
|
1760
1939
|
export interface BorderColors {
|
|
1761
|
-
/**
|
|
1940
|
+
/**
|
|
1941
|
+
* Left border color as a hexadecimal value.
|
|
1942
|
+
* @format COLOR_HEX
|
|
1943
|
+
*/
|
|
1762
1944
|
left?: string | null;
|
|
1763
|
-
/**
|
|
1945
|
+
/**
|
|
1946
|
+
* Right border color as a hexadecimal value.
|
|
1947
|
+
* @format COLOR_HEX
|
|
1948
|
+
*/
|
|
1764
1949
|
right?: string | null;
|
|
1765
|
-
/**
|
|
1950
|
+
/**
|
|
1951
|
+
* Top border color as a hexadecimal value.
|
|
1952
|
+
* @format COLOR_HEX
|
|
1953
|
+
*/
|
|
1766
1954
|
top?: string | null;
|
|
1767
|
-
/**
|
|
1955
|
+
/**
|
|
1956
|
+
* Bottom border color as a hexadecimal value.
|
|
1957
|
+
* @format COLOR_HEX
|
|
1958
|
+
*/
|
|
1768
1959
|
bottom?: string | null;
|
|
1769
1960
|
}
|
|
1770
1961
|
/**
|
|
@@ -1873,13 +2064,17 @@ export interface TextNodeStyle {
|
|
|
1873
2064
|
lineHeight?: string | null;
|
|
1874
2065
|
}
|
|
1875
2066
|
export interface RadioGroup {
|
|
1876
|
-
/**
|
|
2067
|
+
/**
|
|
2068
|
+
* Label of the field
|
|
2069
|
+
* @maxLength 350
|
|
2070
|
+
*/
|
|
1877
2071
|
label?: string | null;
|
|
1878
2072
|
/** Description of the field */
|
|
1879
2073
|
description?: RichContent;
|
|
1880
2074
|
/**
|
|
1881
2075
|
* Flag identifying to show option allowing input custom value
|
|
1882
2076
|
* List of options to select from
|
|
2077
|
+
* @maxSize 400
|
|
1883
2078
|
*/
|
|
1884
2079
|
options?: RadioGroupOption[];
|
|
1885
2080
|
/**
|
|
@@ -1896,19 +2091,35 @@ export interface RadioGroup {
|
|
|
1896
2091
|
numberOfColumns?: NumberOfColumns;
|
|
1897
2092
|
}
|
|
1898
2093
|
export interface RadioGroupOption {
|
|
1899
|
-
/**
|
|
2094
|
+
/**
|
|
2095
|
+
* Selectable option label
|
|
2096
|
+
* @maxLength 400
|
|
2097
|
+
*/
|
|
1900
2098
|
label?: string | null;
|
|
1901
|
-
/**
|
|
2099
|
+
/**
|
|
2100
|
+
* Selectable option value, which is saved to DB.
|
|
2101
|
+
* @maxLength 20000
|
|
2102
|
+
*/
|
|
1902
2103
|
value?: string | null;
|
|
1903
2104
|
/** Flag identifying that option should be selected by default */
|
|
1904
2105
|
default?: boolean;
|
|
1905
|
-
/**
|
|
2106
|
+
/**
|
|
2107
|
+
* Option id. Used as binding for translations
|
|
2108
|
+
* @format GUID
|
|
2109
|
+
* @immutable
|
|
2110
|
+
*/
|
|
1906
2111
|
id?: string;
|
|
1907
2112
|
}
|
|
1908
2113
|
export interface RadioGroupCustomOption {
|
|
1909
|
-
/**
|
|
2114
|
+
/**
|
|
2115
|
+
* Label of custom option input
|
|
2116
|
+
* @maxLength 350
|
|
2117
|
+
*/
|
|
1910
2118
|
label?: string | null;
|
|
1911
|
-
/**
|
|
2119
|
+
/**
|
|
2120
|
+
* Placeholder of custom option input
|
|
2121
|
+
* @maxLength 100
|
|
2122
|
+
*/
|
|
1912
2123
|
placeholder?: string | null;
|
|
1913
2124
|
}
|
|
1914
2125
|
export declare enum NumberOfColumns {
|
|
@@ -1924,11 +2135,17 @@ export declare enum NumberOfColumns {
|
|
|
1924
2135
|
THREE = "THREE"
|
|
1925
2136
|
}
|
|
1926
2137
|
export interface Dropdown {
|
|
1927
|
-
/**
|
|
2138
|
+
/**
|
|
2139
|
+
* Label of the field
|
|
2140
|
+
* @maxLength 350
|
|
2141
|
+
*/
|
|
1928
2142
|
label?: string | null;
|
|
1929
2143
|
/** Description of the field */
|
|
1930
2144
|
description?: RichContent;
|
|
1931
|
-
/**
|
|
2145
|
+
/**
|
|
2146
|
+
* List of options to select from
|
|
2147
|
+
* @maxSize 400
|
|
2148
|
+
*/
|
|
1932
2149
|
options?: DropdownOption[];
|
|
1933
2150
|
/**
|
|
1934
2151
|
* Flag identifying to hide or not label
|
|
@@ -1937,27 +2154,49 @@ export interface Dropdown {
|
|
|
1937
2154
|
showLabel?: boolean | null;
|
|
1938
2155
|
/** Option which can be specified by UoU, enabled when this object is specified. */
|
|
1939
2156
|
customOption?: DropdownCustomOption;
|
|
1940
|
-
/**
|
|
2157
|
+
/**
|
|
2158
|
+
* Placeholder of dropdown input
|
|
2159
|
+
* @maxLength 100
|
|
2160
|
+
*/
|
|
1941
2161
|
placeholder?: string | null;
|
|
1942
2162
|
}
|
|
1943
2163
|
export interface DropdownOption {
|
|
1944
|
-
/**
|
|
2164
|
+
/**
|
|
2165
|
+
* Selectable option label
|
|
2166
|
+
* @maxLength 400
|
|
2167
|
+
*/
|
|
1945
2168
|
label?: string | null;
|
|
1946
|
-
/**
|
|
2169
|
+
/**
|
|
2170
|
+
* Selectable option value, which is saved to DB.
|
|
2171
|
+
* @maxLength 20000
|
|
2172
|
+
*/
|
|
1947
2173
|
value?: string | null;
|
|
1948
2174
|
/** Flag identifying that option should be selected by default */
|
|
1949
2175
|
default?: boolean;
|
|
1950
|
-
/**
|
|
2176
|
+
/**
|
|
2177
|
+
* Option id. Used as binding for translations
|
|
2178
|
+
* @format GUID
|
|
2179
|
+
* @immutable
|
|
2180
|
+
*/
|
|
1951
2181
|
id?: string;
|
|
1952
2182
|
}
|
|
1953
2183
|
export interface DropdownCustomOption {
|
|
1954
|
-
/**
|
|
2184
|
+
/**
|
|
2185
|
+
* Label of custom option input
|
|
2186
|
+
* @maxLength 350
|
|
2187
|
+
*/
|
|
1955
2188
|
label?: string | null;
|
|
1956
|
-
/**
|
|
2189
|
+
/**
|
|
2190
|
+
* Placeholder of custom option input
|
|
2191
|
+
* @maxLength 100
|
|
2192
|
+
*/
|
|
1957
2193
|
placeholder?: string | null;
|
|
1958
2194
|
}
|
|
1959
2195
|
export interface DateTimeInput {
|
|
1960
|
-
/**
|
|
2196
|
+
/**
|
|
2197
|
+
* Label of the field. Displayed text for the date/time input.
|
|
2198
|
+
* @maxLength 350
|
|
2199
|
+
*/
|
|
1961
2200
|
label?: string | null;
|
|
1962
2201
|
/** Description of the field. Additional information about the date/time input. */
|
|
1963
2202
|
description?: RichContent;
|
|
@@ -1976,22 +2215,35 @@ export interface DateTimeInput {
|
|
|
1976
2215
|
* Default: false.
|
|
1977
2216
|
*/
|
|
1978
2217
|
use24HourFormat?: boolean;
|
|
1979
|
-
/**
|
|
2218
|
+
/**
|
|
2219
|
+
* Default value for the date time input.
|
|
2220
|
+
* @format LOCAL_DATE_TIME
|
|
2221
|
+
*/
|
|
1980
2222
|
default?: string | null;
|
|
1981
2223
|
}
|
|
1982
2224
|
export interface PhoneInput {
|
|
1983
|
-
/**
|
|
2225
|
+
/**
|
|
2226
|
+
* Label of the field
|
|
2227
|
+
* @maxLength 350
|
|
2228
|
+
*/
|
|
1984
2229
|
label?: string | null;
|
|
1985
2230
|
/** Description of the field */
|
|
1986
2231
|
description?: RichContent;
|
|
1987
|
-
/**
|
|
2232
|
+
/**
|
|
2233
|
+
* Placeholder for the value input
|
|
2234
|
+
* @maxLength 100
|
|
2235
|
+
*/
|
|
1988
2236
|
placeholder?: string | null;
|
|
1989
2237
|
/**
|
|
1990
2238
|
* Flag identifying to show label or not
|
|
1991
2239
|
* Default: true
|
|
1992
2240
|
*/
|
|
1993
2241
|
showLabel?: boolean | null;
|
|
1994
|
-
/**
|
|
2242
|
+
/**
|
|
2243
|
+
* Default value of the country code
|
|
2244
|
+
* @minLength 1
|
|
2245
|
+
* @maxLength 5
|
|
2246
|
+
*/
|
|
1995
2247
|
defaultCountryCode?: string | null;
|
|
1996
2248
|
/**
|
|
1997
2249
|
* Flag identifying to show country flag or not
|
|
@@ -2000,7 +2252,10 @@ export interface PhoneInput {
|
|
|
2000
2252
|
showCountryFlag?: boolean;
|
|
2001
2253
|
}
|
|
2002
2254
|
export interface DateInput {
|
|
2003
|
-
/**
|
|
2255
|
+
/**
|
|
2256
|
+
* Label of the field. Displayed text for the date/time input.
|
|
2257
|
+
* @maxLength 350
|
|
2258
|
+
*/
|
|
2004
2259
|
label?: string | null;
|
|
2005
2260
|
/** Description of the field. Additional information about the date/time input. */
|
|
2006
2261
|
description?: RichContent;
|
|
@@ -2014,11 +2269,17 @@ export interface DateInput {
|
|
|
2014
2269
|
* Default: true
|
|
2015
2270
|
*/
|
|
2016
2271
|
showPlaceholder?: boolean | null;
|
|
2017
|
-
/**
|
|
2272
|
+
/**
|
|
2273
|
+
* Default value for the date input.
|
|
2274
|
+
* @format LOCAL_DATE
|
|
2275
|
+
*/
|
|
2018
2276
|
default?: string | null;
|
|
2019
2277
|
}
|
|
2020
2278
|
export interface TimeInput {
|
|
2021
|
-
/**
|
|
2279
|
+
/**
|
|
2280
|
+
* Label of the field. Displayed text for the date/time input.
|
|
2281
|
+
* @maxLength 350
|
|
2282
|
+
*/
|
|
2022
2283
|
label?: string | null;
|
|
2023
2284
|
/** Description of the field. Additional information about the date/time input. */
|
|
2024
2285
|
description?: RichContent;
|
|
@@ -2037,11 +2298,17 @@ export interface TimeInput {
|
|
|
2037
2298
|
* Default: false.
|
|
2038
2299
|
*/
|
|
2039
2300
|
use24HourFormat?: boolean;
|
|
2040
|
-
/**
|
|
2301
|
+
/**
|
|
2302
|
+
* Default value for the time input.
|
|
2303
|
+
* @format LOCAL_TIME
|
|
2304
|
+
*/
|
|
2041
2305
|
default?: string | null;
|
|
2042
2306
|
}
|
|
2043
2307
|
export interface DatePicker {
|
|
2044
|
-
/**
|
|
2308
|
+
/**
|
|
2309
|
+
* Label of the field. Displayed text for the date/time input.
|
|
2310
|
+
* @maxLength 350
|
|
2311
|
+
*/
|
|
2045
2312
|
label?: string | null;
|
|
2046
2313
|
/** Description of the field. Additional information about the date/time input. */
|
|
2047
2314
|
description?: RichContent;
|
|
@@ -2050,11 +2317,17 @@ export interface DatePicker {
|
|
|
2050
2317
|
* Default: true
|
|
2051
2318
|
*/
|
|
2052
2319
|
showLabel?: boolean | null;
|
|
2053
|
-
/**
|
|
2320
|
+
/**
|
|
2321
|
+
* Placeholder of date picker input
|
|
2322
|
+
* @maxLength 100
|
|
2323
|
+
*/
|
|
2054
2324
|
placeholder?: string | null;
|
|
2055
2325
|
/** First day of the week displayed on date picker. */
|
|
2056
2326
|
firstDayOfWeek?: FirstDayOfWeek;
|
|
2057
|
-
/**
|
|
2327
|
+
/**
|
|
2328
|
+
* Default value for the date picker.
|
|
2329
|
+
* @format LOCAL_DATE
|
|
2330
|
+
*/
|
|
2058
2331
|
default?: string | null;
|
|
2059
2332
|
}
|
|
2060
2333
|
export declare enum FirstDayOfWeek {
|
|
@@ -2072,11 +2345,17 @@ export interface InputFieldNumberType {
|
|
|
2072
2345
|
multipleOf?: number | null;
|
|
2073
2346
|
/** Custom error message when validation fails. */
|
|
2074
2347
|
errorMessages?: InputFieldNumberErrorMessages;
|
|
2075
|
-
/**
|
|
2348
|
+
/**
|
|
2349
|
+
* List of allowed values.
|
|
2350
|
+
* @maxSize 500
|
|
2351
|
+
*/
|
|
2076
2352
|
enum?: number[] | null;
|
|
2077
2353
|
}
|
|
2078
2354
|
export interface InputFieldNumberErrorMessages {
|
|
2079
|
-
/**
|
|
2355
|
+
/**
|
|
2356
|
+
* Default error message on invalid validation.
|
|
2357
|
+
* @maxLength 200
|
|
2358
|
+
*/
|
|
2080
2359
|
default?: string | null;
|
|
2081
2360
|
}
|
|
2082
2361
|
export declare enum NumberComponentType {
|
|
@@ -2085,11 +2364,17 @@ export declare enum NumberComponentType {
|
|
|
2085
2364
|
RATING_INPUT = "RATING_INPUT"
|
|
2086
2365
|
}
|
|
2087
2366
|
export interface NumberInput {
|
|
2088
|
-
/**
|
|
2367
|
+
/**
|
|
2368
|
+
* Label of the field
|
|
2369
|
+
* @maxLength 350
|
|
2370
|
+
*/
|
|
2089
2371
|
label?: string | null;
|
|
2090
2372
|
/** Description of the field */
|
|
2091
2373
|
description?: RichContent;
|
|
2092
|
-
/**
|
|
2374
|
+
/**
|
|
2375
|
+
* Placeholder for the value input
|
|
2376
|
+
* @maxLength 100
|
|
2377
|
+
*/
|
|
2093
2378
|
placeholder?: string | null;
|
|
2094
2379
|
/**
|
|
2095
2380
|
* Flag identifying to hide or not label
|
|
@@ -2100,7 +2385,10 @@ export interface NumberInput {
|
|
|
2100
2385
|
default?: number | null;
|
|
2101
2386
|
}
|
|
2102
2387
|
export interface RatingInput {
|
|
2103
|
-
/**
|
|
2388
|
+
/**
|
|
2389
|
+
* Label of the field
|
|
2390
|
+
* @maxLength 350
|
|
2391
|
+
*/
|
|
2104
2392
|
label?: string | null;
|
|
2105
2393
|
/** Description of the field */
|
|
2106
2394
|
description?: RichContent;
|
|
@@ -2109,17 +2397,27 @@ export interface RatingInput {
|
|
|
2109
2397
|
* Default: true
|
|
2110
2398
|
*/
|
|
2111
2399
|
showLabel?: boolean | null;
|
|
2112
|
-
/**
|
|
2400
|
+
/**
|
|
2401
|
+
* Default rating
|
|
2402
|
+
* @min 1
|
|
2403
|
+
* @max 5
|
|
2404
|
+
*/
|
|
2113
2405
|
defaultValue?: number | null;
|
|
2114
2406
|
}
|
|
2115
2407
|
export interface InputFieldBooleanType {
|
|
2116
2408
|
/** Custom error message when validation fails. */
|
|
2117
2409
|
errorMessages?: InputFieldBooleanErrorMessages;
|
|
2118
|
-
/**
|
|
2410
|
+
/**
|
|
2411
|
+
* List of allowed values.
|
|
2412
|
+
* @maxSize 2
|
|
2413
|
+
*/
|
|
2119
2414
|
enum?: boolean[];
|
|
2120
2415
|
}
|
|
2121
2416
|
export interface InputFieldBooleanErrorMessages {
|
|
2122
|
-
/**
|
|
2417
|
+
/**
|
|
2418
|
+
* Default error message on invalid validation.
|
|
2419
|
+
* @maxLength 200
|
|
2420
|
+
*/
|
|
2123
2421
|
default?: string | null;
|
|
2124
2422
|
}
|
|
2125
2423
|
export declare enum BooleanComponentType {
|
|
@@ -2136,9 +2434,15 @@ export interface Checkbox {
|
|
|
2136
2434
|
checked?: boolean;
|
|
2137
2435
|
}
|
|
2138
2436
|
export interface InputFieldArrayType {
|
|
2139
|
-
/**
|
|
2437
|
+
/**
|
|
2438
|
+
* Maximum amount of array elements.
|
|
2439
|
+
* @max 1000
|
|
2440
|
+
*/
|
|
2140
2441
|
maxItems?: number | null;
|
|
2141
|
-
/**
|
|
2442
|
+
/**
|
|
2443
|
+
* Minimum amount of array elements.
|
|
2444
|
+
* @max 1000
|
|
2445
|
+
*/
|
|
2142
2446
|
minItems?: number | null;
|
|
2143
2447
|
/** Type of items allowed in array. */
|
|
2144
2448
|
items?: ArrayTypeArrayItems;
|
|
@@ -2162,7 +2466,10 @@ export interface InputFieldIntegerType {
|
|
|
2162
2466
|
multipleOf?: number | null;
|
|
2163
2467
|
/** Custom error message when validation fails. */
|
|
2164
2468
|
errorMessages?: InputFieldNumberErrorMessages;
|
|
2165
|
-
/**
|
|
2469
|
+
/**
|
|
2470
|
+
* List of allowed values.
|
|
2471
|
+
* @maxSize 500
|
|
2472
|
+
*/
|
|
2166
2473
|
enum?: number[] | null;
|
|
2167
2474
|
}
|
|
2168
2475
|
export interface InputFieldObjectType {
|
|
@@ -2212,7 +2519,10 @@ export interface ObjectTypePropertiesTypePropertiesTypeOptionsOneOf {
|
|
|
2212
2519
|
arrayOptions?: InputFieldArrayType;
|
|
2213
2520
|
}
|
|
2214
2521
|
export interface InputFieldObjectErrorMessages {
|
|
2215
|
-
/**
|
|
2522
|
+
/**
|
|
2523
|
+
* Default error message on invalid validation.
|
|
2524
|
+
* @maxLength 200
|
|
2525
|
+
*/
|
|
2216
2526
|
default?: string | null;
|
|
2217
2527
|
}
|
|
2218
2528
|
export interface ArrayTypeArrayItems extends ArrayTypeArrayItemsItemTypeOptionsOneOf {
|
|
@@ -2246,7 +2556,10 @@ export interface ArrayTypeArrayItemsItemTypeOptionsOneOf {
|
|
|
2246
2556
|
objectOptions?: InputFieldObjectType;
|
|
2247
2557
|
}
|
|
2248
2558
|
export interface InputFieldArrayErrorMessages {
|
|
2249
|
-
/**
|
|
2559
|
+
/**
|
|
2560
|
+
* Default error message on invalid validation.
|
|
2561
|
+
* @maxLength 200
|
|
2562
|
+
*/
|
|
2250
2563
|
default?: string | null;
|
|
2251
2564
|
}
|
|
2252
2565
|
export declare enum ComponentType {
|
|
@@ -2255,11 +2568,17 @@ export declare enum ComponentType {
|
|
|
2255
2568
|
TAGS = "TAGS"
|
|
2256
2569
|
}
|
|
2257
2570
|
export interface CheckboxGroup {
|
|
2258
|
-
/**
|
|
2571
|
+
/**
|
|
2572
|
+
* Label of the field
|
|
2573
|
+
* @maxLength 350
|
|
2574
|
+
*/
|
|
2259
2575
|
label?: string | null;
|
|
2260
2576
|
/** Description of the field */
|
|
2261
2577
|
description?: RichContent;
|
|
2262
|
-
/**
|
|
2578
|
+
/**
|
|
2579
|
+
* List of options to select from
|
|
2580
|
+
* @maxSize 400
|
|
2581
|
+
*/
|
|
2263
2582
|
options?: Option[];
|
|
2264
2583
|
/**
|
|
2265
2584
|
* Flag identifying to hide or not label
|
|
@@ -2284,9 +2603,15 @@ export interface MediaItemMediaOneOf {
|
|
|
2284
2603
|
image?: Image;
|
|
2285
2604
|
}
|
|
2286
2605
|
export interface Image {
|
|
2287
|
-
/**
|
|
2606
|
+
/**
|
|
2607
|
+
* WixMedia image ID.
|
|
2608
|
+
* @maxLength 100
|
|
2609
|
+
*/
|
|
2288
2610
|
id?: string;
|
|
2289
|
-
/**
|
|
2611
|
+
/**
|
|
2612
|
+
* Image URL.
|
|
2613
|
+
* @maxLength 2000
|
|
2614
|
+
*/
|
|
2290
2615
|
url?: string;
|
|
2291
2616
|
/**
|
|
2292
2617
|
* Original image height.
|
|
@@ -2298,38 +2623,61 @@ export interface Image {
|
|
|
2298
2623
|
* @readonly
|
|
2299
2624
|
*/
|
|
2300
2625
|
width?: number;
|
|
2301
|
-
/**
|
|
2626
|
+
/**
|
|
2627
|
+
* Image alt text.
|
|
2628
|
+
* @maxLength 1000
|
|
2629
|
+
*/
|
|
2302
2630
|
altText?: string | null;
|
|
2303
2631
|
/**
|
|
2304
2632
|
* Image filename.
|
|
2305
2633
|
* @readonly
|
|
2634
|
+
* @maxLength 1000
|
|
2306
2635
|
*/
|
|
2307
2636
|
filename?: string | null;
|
|
2308
2637
|
}
|
|
2309
2638
|
export interface Option {
|
|
2310
|
-
/**
|
|
2639
|
+
/**
|
|
2640
|
+
* Selectable option label
|
|
2641
|
+
* @maxLength 400
|
|
2642
|
+
*/
|
|
2311
2643
|
label?: string | null;
|
|
2312
2644
|
/** Selectable option value, which is saved to DB. */
|
|
2313
2645
|
value?: any;
|
|
2314
2646
|
/** Flag identifying that option should be selected by default */
|
|
2315
2647
|
default?: boolean;
|
|
2316
|
-
/**
|
|
2648
|
+
/**
|
|
2649
|
+
* Option id. Used as binding for translations
|
|
2650
|
+
* @format GUID
|
|
2651
|
+
* @immutable
|
|
2652
|
+
*/
|
|
2317
2653
|
id?: string;
|
|
2318
2654
|
/** Media item. Media, associated with option, like image. */
|
|
2319
2655
|
media?: MediaItem;
|
|
2320
2656
|
}
|
|
2321
2657
|
export interface CustomOption {
|
|
2322
|
-
/**
|
|
2658
|
+
/**
|
|
2659
|
+
* Label of custom option input
|
|
2660
|
+
* @maxLength 350
|
|
2661
|
+
*/
|
|
2323
2662
|
label?: string | null;
|
|
2324
|
-
/**
|
|
2663
|
+
/**
|
|
2664
|
+
* Placeholder of custom option input
|
|
2665
|
+
* @maxLength 100
|
|
2666
|
+
*/
|
|
2325
2667
|
placeholder?: string | null;
|
|
2326
2668
|
}
|
|
2327
2669
|
export interface Tags {
|
|
2328
|
-
/**
|
|
2670
|
+
/**
|
|
2671
|
+
* Label of the field
|
|
2672
|
+
* @maxLength 350
|
|
2673
|
+
*/
|
|
2329
2674
|
label?: string | null;
|
|
2330
2675
|
/** Description of the field */
|
|
2331
2676
|
description?: RichContent;
|
|
2332
|
-
/**
|
|
2677
|
+
/**
|
|
2678
|
+
* List of options to select from
|
|
2679
|
+
* @maxSize 400
|
|
2680
|
+
*/
|
|
2333
2681
|
options?: TagsOption[];
|
|
2334
2682
|
/**
|
|
2335
2683
|
* Flag identifying to hide or not label
|
|
@@ -2345,21 +2693,34 @@ export interface Tags {
|
|
|
2345
2693
|
numberOfColumns?: NumberOfColumns;
|
|
2346
2694
|
}
|
|
2347
2695
|
export interface TagsOption {
|
|
2348
|
-
/**
|
|
2696
|
+
/**
|
|
2697
|
+
* Selectable option label
|
|
2698
|
+
* @maxLength 400
|
|
2699
|
+
*/
|
|
2349
2700
|
label?: string | null;
|
|
2350
2701
|
/** Selectable option value, which is saved to DB. */
|
|
2351
2702
|
value?: any;
|
|
2352
2703
|
/** Flag identifying that option should be selected by default */
|
|
2353
2704
|
default?: boolean;
|
|
2354
|
-
/**
|
|
2705
|
+
/**
|
|
2706
|
+
* Option id. Used as binding for translations
|
|
2707
|
+
* @format GUID
|
|
2708
|
+
* @immutable
|
|
2709
|
+
*/
|
|
2355
2710
|
id?: string;
|
|
2356
2711
|
/** Media item. Media, associated with option, like image. */
|
|
2357
2712
|
media?: MediaItem;
|
|
2358
2713
|
}
|
|
2359
2714
|
export interface CommonCustomOption {
|
|
2360
|
-
/**
|
|
2715
|
+
/**
|
|
2716
|
+
* Label of custom option input
|
|
2717
|
+
* @maxLength 350
|
|
2718
|
+
*/
|
|
2361
2719
|
label?: string | null;
|
|
2362
|
-
/**
|
|
2720
|
+
/**
|
|
2721
|
+
* Placeholder of custom option input
|
|
2722
|
+
* @maxLength 100
|
|
2723
|
+
*/
|
|
2363
2724
|
placeholder?: string | null;
|
|
2364
2725
|
}
|
|
2365
2726
|
export declare enum WixFileComponentType {
|
|
@@ -2368,7 +2729,10 @@ export declare enum WixFileComponentType {
|
|
|
2368
2729
|
SIGNATURE = "SIGNATURE"
|
|
2369
2730
|
}
|
|
2370
2731
|
export interface FileUpload {
|
|
2371
|
-
/**
|
|
2732
|
+
/**
|
|
2733
|
+
* Selectable option label
|
|
2734
|
+
* @maxLength 350
|
|
2735
|
+
*/
|
|
2372
2736
|
label?: string | null;
|
|
2373
2737
|
/** Description of the field */
|
|
2374
2738
|
description?: RichContent;
|
|
@@ -2377,13 +2741,26 @@ export interface FileUpload {
|
|
|
2377
2741
|
* Default: true
|
|
2378
2742
|
*/
|
|
2379
2743
|
showLabel?: boolean | null;
|
|
2380
|
-
/**
|
|
2744
|
+
/**
|
|
2745
|
+
* Text on upload button
|
|
2746
|
+
* @maxLength 500
|
|
2747
|
+
*/
|
|
2381
2748
|
buttonText?: string | null;
|
|
2382
|
-
/**
|
|
2749
|
+
/**
|
|
2750
|
+
* Amount of files allowed to upload
|
|
2751
|
+
* @min 1
|
|
2752
|
+
* @max 30
|
|
2753
|
+
*/
|
|
2383
2754
|
fileLimit?: number;
|
|
2384
|
-
/**
|
|
2755
|
+
/**
|
|
2756
|
+
* Supported file formats for upload
|
|
2757
|
+
* @maxSize 5
|
|
2758
|
+
*/
|
|
2385
2759
|
uploadFileFormats?: UploadFileFormat[];
|
|
2386
|
-
/**
|
|
2760
|
+
/**
|
|
2761
|
+
* Custom text which appears when file is uploaded, if missing file name will be shown
|
|
2762
|
+
* @maxLength 255
|
|
2763
|
+
*/
|
|
2387
2764
|
explanationText?: string | null;
|
|
2388
2765
|
}
|
|
2389
2766
|
export declare enum UploadFileFormat {
|
|
@@ -2401,7 +2778,10 @@ export declare enum UploadFileFormat {
|
|
|
2401
2778
|
ARCHIVE = "ARCHIVE"
|
|
2402
2779
|
}
|
|
2403
2780
|
export interface Signature {
|
|
2404
|
-
/**
|
|
2781
|
+
/**
|
|
2782
|
+
* Selectable option label
|
|
2783
|
+
* @maxLength 350
|
|
2784
|
+
*/
|
|
2405
2785
|
label?: string | null;
|
|
2406
2786
|
/**
|
|
2407
2787
|
* Flag identifying to hide label or not
|
|
@@ -2421,11 +2801,17 @@ export declare enum PaymentComponentType {
|
|
|
2421
2801
|
FIXED_PAYMENT = "FIXED_PAYMENT"
|
|
2422
2802
|
}
|
|
2423
2803
|
export interface ProductCheckboxGroup {
|
|
2424
|
-
/**
|
|
2804
|
+
/**
|
|
2805
|
+
* Label of the field.
|
|
2806
|
+
* @maxLength 350
|
|
2807
|
+
*/
|
|
2425
2808
|
label?: string | null;
|
|
2426
2809
|
/** Description of the field. */
|
|
2427
2810
|
description?: RichContent;
|
|
2428
|
-
/**
|
|
2811
|
+
/**
|
|
2812
|
+
* List of options to select from.
|
|
2813
|
+
* @maxSize 400
|
|
2814
|
+
*/
|
|
2429
2815
|
options?: ProductCheckboxGroupOption[];
|
|
2430
2816
|
/**
|
|
2431
2817
|
* Flag identifying to hide or not label
|
|
@@ -2439,11 +2825,18 @@ export interface ProductCheckboxGroup {
|
|
|
2439
2825
|
imageFit?: ImageFit;
|
|
2440
2826
|
}
|
|
2441
2827
|
export interface ProductCheckboxGroupOption {
|
|
2442
|
-
/**
|
|
2828
|
+
/**
|
|
2829
|
+
* Selectable option label.
|
|
2830
|
+
* @maxLength 400
|
|
2831
|
+
*/
|
|
2443
2832
|
label?: string | null;
|
|
2444
2833
|
/** Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list. */
|
|
2445
2834
|
value?: any;
|
|
2446
|
-
/**
|
|
2835
|
+
/**
|
|
2836
|
+
* Option id. Used as binding for translations.
|
|
2837
|
+
* @format GUID
|
|
2838
|
+
* @immutable
|
|
2839
|
+
*/
|
|
2447
2840
|
id?: string;
|
|
2448
2841
|
/** Media item. Media, associated with option, like image. */
|
|
2449
2842
|
media?: MediaItem;
|
|
@@ -2458,11 +2851,17 @@ export declare enum ImageFit {
|
|
|
2458
2851
|
CONTAIN = "CONTAIN"
|
|
2459
2852
|
}
|
|
2460
2853
|
export interface DonationInput {
|
|
2461
|
-
/**
|
|
2854
|
+
/**
|
|
2855
|
+
* Label of the field.
|
|
2856
|
+
* @maxLength 350
|
|
2857
|
+
*/
|
|
2462
2858
|
label?: string | null;
|
|
2463
2859
|
/** Description of the field. */
|
|
2464
2860
|
description?: RichContent;
|
|
2465
|
-
/**
|
|
2861
|
+
/**
|
|
2862
|
+
* List of options to select from.
|
|
2863
|
+
* @maxSize 400
|
|
2864
|
+
*/
|
|
2466
2865
|
options?: DonationInputOption[];
|
|
2467
2866
|
/** Option which can be specified by UoU, enabled when this object is specified. */
|
|
2468
2867
|
customOption?: CommonCustomOption;
|
|
@@ -2478,13 +2877,19 @@ export interface DonationInput {
|
|
|
2478
2877
|
showLabel?: boolean | null;
|
|
2479
2878
|
}
|
|
2480
2879
|
export interface DonationInputOption {
|
|
2481
|
-
/**
|
|
2880
|
+
/**
|
|
2881
|
+
* Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list.
|
|
2882
|
+
* @format GUID
|
|
2883
|
+
*/
|
|
2482
2884
|
value?: string;
|
|
2483
2885
|
/** Flag identifying that option should be selected by default */
|
|
2484
2886
|
default?: boolean;
|
|
2485
2887
|
}
|
|
2486
2888
|
export interface PaymentInput {
|
|
2487
|
-
/**
|
|
2889
|
+
/**
|
|
2890
|
+
* Label of the field.
|
|
2891
|
+
* @maxLength 350
|
|
2892
|
+
*/
|
|
2488
2893
|
label?: string | null;
|
|
2489
2894
|
/** Description of the field. */
|
|
2490
2895
|
description?: RichContent;
|
|
@@ -2493,13 +2898,19 @@ export interface PaymentInput {
|
|
|
2493
2898
|
* Default: true
|
|
2494
2899
|
*/
|
|
2495
2900
|
showLabel?: boolean | null;
|
|
2496
|
-
/**
|
|
2901
|
+
/**
|
|
2902
|
+
* Placeholder of custom option input
|
|
2903
|
+
* @maxLength 100
|
|
2904
|
+
*/
|
|
2497
2905
|
placeholder?: string | null;
|
|
2498
2906
|
/** Default value for the payment input */
|
|
2499
2907
|
default?: number | null;
|
|
2500
2908
|
}
|
|
2501
2909
|
export interface FixedPayment {
|
|
2502
|
-
/**
|
|
2910
|
+
/**
|
|
2911
|
+
* Label of the field.
|
|
2912
|
+
* @maxLength 350
|
|
2913
|
+
*/
|
|
2503
2914
|
label?: string | null;
|
|
2504
2915
|
/** Description of the field. */
|
|
2505
2916
|
description?: RichContent;
|
|
@@ -2520,15 +2931,30 @@ export interface Appointment extends AppointmentFormatInfoOneOf {
|
|
|
2520
2931
|
videoConferenceOptions?: VideoConferenceOptions;
|
|
2521
2932
|
/** Phone options for the appointment */
|
|
2522
2933
|
phoneOptions?: PhoneOptions;
|
|
2523
|
-
/**
|
|
2934
|
+
/**
|
|
2935
|
+
* Label of the field
|
|
2936
|
+
* @maxLength 255
|
|
2937
|
+
*/
|
|
2524
2938
|
label?: string | null;
|
|
2525
|
-
/**
|
|
2939
|
+
/**
|
|
2940
|
+
* Name of the appointment
|
|
2941
|
+
* @minLength 1
|
|
2942
|
+
* @maxLength 400
|
|
2943
|
+
*/
|
|
2526
2944
|
name?: string | null;
|
|
2527
|
-
/**
|
|
2945
|
+
/**
|
|
2946
|
+
* Duration of the appointment in minutes
|
|
2947
|
+
* @min 1
|
|
2948
|
+
* @max 44639
|
|
2949
|
+
*/
|
|
2528
2950
|
durationInMinutes?: number | null;
|
|
2529
2951
|
/** Indicates whether manual approval is required for the appointment */
|
|
2530
2952
|
manualApprovalRequired?: boolean | null;
|
|
2531
|
-
/**
|
|
2953
|
+
/**
|
|
2954
|
+
* ID of the staff members providing the appointment
|
|
2955
|
+
* @maxSize 220
|
|
2956
|
+
* @format GUID
|
|
2957
|
+
*/
|
|
2532
2958
|
staffIds?: string[] | null;
|
|
2533
2959
|
/** The format of the appointment */
|
|
2534
2960
|
format?: Format;
|
|
@@ -2543,16 +2969,28 @@ export interface AppointmentFormatInfoOneOf {
|
|
|
2543
2969
|
phoneOptions?: PhoneOptions;
|
|
2544
2970
|
}
|
|
2545
2971
|
export interface Location extends LocationLocationInfoOneOf {
|
|
2546
|
-
/**
|
|
2972
|
+
/**
|
|
2973
|
+
* Custom address details
|
|
2974
|
+
* @maxLength 512
|
|
2975
|
+
*/
|
|
2547
2976
|
customAddress?: string | null;
|
|
2548
|
-
/**
|
|
2977
|
+
/**
|
|
2978
|
+
* ID of a business location
|
|
2979
|
+
* @format GUID
|
|
2980
|
+
*/
|
|
2549
2981
|
businessLocationId?: string | null;
|
|
2550
2982
|
}
|
|
2551
2983
|
/** @oneof */
|
|
2552
2984
|
export interface LocationLocationInfoOneOf {
|
|
2553
|
-
/**
|
|
2985
|
+
/**
|
|
2986
|
+
* Custom address details
|
|
2987
|
+
* @maxLength 512
|
|
2988
|
+
*/
|
|
2554
2989
|
customAddress?: string | null;
|
|
2555
|
-
/**
|
|
2990
|
+
/**
|
|
2991
|
+
* ID of a business location
|
|
2992
|
+
* @format GUID
|
|
2993
|
+
*/
|
|
2556
2994
|
businessLocationId?: string | null;
|
|
2557
2995
|
}
|
|
2558
2996
|
export declare enum Format {
|
|
@@ -2562,15 +3000,25 @@ export declare enum Format {
|
|
|
2562
3000
|
PHONE = "PHONE"
|
|
2563
3001
|
}
|
|
2564
3002
|
export interface InPersonOptions {
|
|
2565
|
-
/**
|
|
3003
|
+
/**
|
|
3004
|
+
* The locations details
|
|
3005
|
+
* @minSize 1
|
|
3006
|
+
* @maxSize 500
|
|
3007
|
+
*/
|
|
2566
3008
|
locations?: Location[];
|
|
2567
3009
|
}
|
|
2568
3010
|
export interface VideoConferenceOptions {
|
|
2569
|
-
/**
|
|
3011
|
+
/**
|
|
3012
|
+
* Description or instructions for the online video conference
|
|
3013
|
+
* @maxLength 512
|
|
3014
|
+
*/
|
|
2570
3015
|
description?: string | null;
|
|
2571
3016
|
}
|
|
2572
3017
|
export interface PhoneOptions {
|
|
2573
|
-
/**
|
|
3018
|
+
/**
|
|
3019
|
+
* Description or instructions for the phone appointment
|
|
3020
|
+
* @maxLength 512
|
|
3021
|
+
*/
|
|
2574
3022
|
description?: string | null;
|
|
2575
3023
|
}
|
|
2576
3024
|
export declare enum MultilineAddressComponentType {
|
|
@@ -2578,7 +3026,10 @@ export declare enum MultilineAddressComponentType {
|
|
|
2578
3026
|
MULTILINE_ADDRESS = "MULTILINE_ADDRESS"
|
|
2579
3027
|
}
|
|
2580
3028
|
export interface MultilineAddress {
|
|
2581
|
-
/**
|
|
3029
|
+
/**
|
|
3030
|
+
* Label of the field.
|
|
3031
|
+
* @maxLength 350
|
|
3032
|
+
*/
|
|
2582
3033
|
label?: string | null;
|
|
2583
3034
|
/** Description of the field. */
|
|
2584
3035
|
description?: RichContent;
|
|
@@ -2604,14 +3055,20 @@ export interface AddressLine2 {
|
|
|
2604
3055
|
show?: boolean;
|
|
2605
3056
|
}
|
|
2606
3057
|
export interface DefaultCountryConfig extends DefaultCountryConfigOptionsOneOf {
|
|
2607
|
-
/**
|
|
3058
|
+
/**
|
|
3059
|
+
* Country.
|
|
3060
|
+
* @format COUNTRY
|
|
3061
|
+
*/
|
|
2608
3062
|
countryOptions?: string;
|
|
2609
3063
|
/** Default country type. */
|
|
2610
3064
|
type?: Type;
|
|
2611
3065
|
}
|
|
2612
3066
|
/** @oneof */
|
|
2613
3067
|
export interface DefaultCountryConfigOptionsOneOf {
|
|
2614
|
-
/**
|
|
3068
|
+
/**
|
|
3069
|
+
* Country.
|
|
3070
|
+
* @format COUNTRY
|
|
3071
|
+
*/
|
|
2615
3072
|
countryOptions?: string;
|
|
2616
3073
|
}
|
|
2617
3074
|
export interface FieldsSettings {
|
|
@@ -2701,7 +3158,11 @@ export interface AddressInfo {
|
|
|
2701
3158
|
tag?: Tag;
|
|
2702
3159
|
}
|
|
2703
3160
|
export interface CustomFieldInfo {
|
|
2704
|
-
/**
|
|
3161
|
+
/**
|
|
3162
|
+
* Custom field key.
|
|
3163
|
+
* @minLength 1
|
|
3164
|
+
* @maxLength 500
|
|
3165
|
+
*/
|
|
2705
3166
|
key?: string;
|
|
2706
3167
|
}
|
|
2707
3168
|
export interface SubscriptionInfo {
|
|
@@ -2920,7 +3381,12 @@ export interface InputField extends InputFieldInputTypeOptionsOneOf {
|
|
|
2920
3381
|
multilineAddressOptions?: InputFieldMultilineAddress;
|
|
2921
3382
|
/** Input returns scheduling as value. */
|
|
2922
3383
|
schedulingOptions?: Scheduling;
|
|
2923
|
-
/**
|
|
3384
|
+
/**
|
|
3385
|
+
* Definition of a target where the value of field belongs.
|
|
3386
|
+
* @minLength 1
|
|
3387
|
+
* @maxLength 200
|
|
3388
|
+
* @immutable
|
|
3389
|
+
*/
|
|
2924
3390
|
target?: string | null;
|
|
2925
3391
|
/**
|
|
2926
3392
|
* Mark the field as containing personal information. This will encrypt user data when storing it.
|
|
@@ -2992,17 +3458,33 @@ export interface RichContentOptions {
|
|
|
2992
3458
|
richContent?: RichContent;
|
|
2993
3459
|
}
|
|
2994
3460
|
export interface PageNavigationOptions {
|
|
2995
|
-
/**
|
|
3461
|
+
/**
|
|
3462
|
+
* When button is not on last page it behaves as switch between pages page, text of label to go to next page.
|
|
3463
|
+
* @maxLength 65
|
|
3464
|
+
*/
|
|
2996
3465
|
nextPageText?: string | null;
|
|
2997
|
-
/**
|
|
3466
|
+
/**
|
|
3467
|
+
* When button is not on last page it behaves as switch between pages page, text of label to go to previous page.
|
|
3468
|
+
* @maxLength 65
|
|
3469
|
+
*/
|
|
2998
3470
|
previousPageText?: string | null;
|
|
2999
|
-
/**
|
|
3471
|
+
/**
|
|
3472
|
+
* Text on the button when button is submitting a form
|
|
3473
|
+
* @maxLength 65
|
|
3474
|
+
*/
|
|
3000
3475
|
submitText?: string | null;
|
|
3001
3476
|
}
|
|
3002
3477
|
export interface Step {
|
|
3003
|
-
/**
|
|
3478
|
+
/**
|
|
3479
|
+
* Step ID.
|
|
3480
|
+
* @format GUID
|
|
3481
|
+
* @immutable
|
|
3482
|
+
*/
|
|
3004
3483
|
id?: string;
|
|
3005
|
-
/**
|
|
3484
|
+
/**
|
|
3485
|
+
* Name of the step.
|
|
3486
|
+
* @maxLength 200
|
|
3487
|
+
*/
|
|
3006
3488
|
name?: string | null;
|
|
3007
3489
|
/** Is step hidden */
|
|
3008
3490
|
hidden?: boolean;
|
|
@@ -3018,7 +3500,10 @@ export interface FormLayout {
|
|
|
3018
3500
|
small?: BreakPoint;
|
|
3019
3501
|
}
|
|
3020
3502
|
export interface BreakPoint {
|
|
3021
|
-
/**
|
|
3503
|
+
/**
|
|
3504
|
+
* Description of layouts for items.
|
|
3505
|
+
* @maxSize 500
|
|
3506
|
+
*/
|
|
3022
3507
|
items?: ItemLayout[];
|
|
3023
3508
|
/** Amount of columns of layout grid. */
|
|
3024
3509
|
columns?: number | null;
|
|
@@ -3028,11 +3513,17 @@ export interface BreakPoint {
|
|
|
3028
3513
|
margin?: Margin;
|
|
3029
3514
|
/** Description of elements paddings. */
|
|
3030
3515
|
padding?: Margin;
|
|
3031
|
-
/**
|
|
3516
|
+
/**
|
|
3517
|
+
* Sections of the layout, which allow manage fields
|
|
3518
|
+
* @maxSize 100
|
|
3519
|
+
*/
|
|
3032
3520
|
sections?: Section[];
|
|
3033
3521
|
}
|
|
3034
3522
|
export interface ItemLayout extends ItemLayoutItemOneOf {
|
|
3035
|
-
/**
|
|
3523
|
+
/**
|
|
3524
|
+
* Form field reference id.
|
|
3525
|
+
* @format GUID
|
|
3526
|
+
*/
|
|
3036
3527
|
fieldId?: string;
|
|
3037
3528
|
/** Group info, defining that this item is a group of multiple fields */
|
|
3038
3529
|
group?: Group;
|
|
@@ -3047,15 +3538,25 @@ export interface ItemLayout extends ItemLayoutItemOneOf {
|
|
|
3047
3538
|
}
|
|
3048
3539
|
/** @oneof */
|
|
3049
3540
|
export interface ItemLayoutItemOneOf {
|
|
3050
|
-
/**
|
|
3541
|
+
/**
|
|
3542
|
+
* Form field reference id.
|
|
3543
|
+
* @format GUID
|
|
3544
|
+
*/
|
|
3051
3545
|
fieldId?: string;
|
|
3052
3546
|
/** Group info, defining that this item is a group of multiple fields */
|
|
3053
3547
|
group?: Group;
|
|
3054
3548
|
}
|
|
3055
3549
|
export interface Group {
|
|
3056
|
-
/**
|
|
3550
|
+
/**
|
|
3551
|
+
* Field group reference id.
|
|
3552
|
+
* @format GUID
|
|
3553
|
+
*/
|
|
3057
3554
|
groupId?: string;
|
|
3058
|
-
/**
|
|
3555
|
+
/**
|
|
3556
|
+
* Description of layouts for items.
|
|
3557
|
+
* @minSize 1
|
|
3558
|
+
* @maxSize 500
|
|
3559
|
+
*/
|
|
3059
3560
|
items?: ItemLayout[];
|
|
3060
3561
|
}
|
|
3061
3562
|
export interface Margin {
|
|
@@ -3065,7 +3566,11 @@ export interface Margin {
|
|
|
3065
3566
|
vertical?: number | null;
|
|
3066
3567
|
}
|
|
3067
3568
|
export interface Section {
|
|
3068
|
-
/**
|
|
3569
|
+
/**
|
|
3570
|
+
* Id of the section
|
|
3571
|
+
* @format GUID
|
|
3572
|
+
* @minLength 1
|
|
3573
|
+
*/
|
|
3069
3574
|
id?: string;
|
|
3070
3575
|
/** Horizontal coordinate in the grid. */
|
|
3071
3576
|
row?: number | null;
|
|
@@ -3075,20 +3580,30 @@ export interface Section {
|
|
|
3075
3580
|
* If the section encounters the $new key within the list,
|
|
3076
3581
|
* it allows the inclusion of fields not explicitly listed,
|
|
3077
3582
|
* enabling dynamic addition of new fields.
|
|
3583
|
+
* @maxSize 100
|
|
3584
|
+
* @maxLength 100
|
|
3078
3585
|
*/
|
|
3079
3586
|
allowedFieldIds?: string[];
|
|
3080
3587
|
}
|
|
3081
3588
|
export interface FormRule {
|
|
3082
|
-
/**
|
|
3589
|
+
/**
|
|
3590
|
+
* Id of the rule
|
|
3591
|
+
* @format GUID
|
|
3592
|
+
* @immutable
|
|
3593
|
+
*/
|
|
3083
3594
|
id?: string;
|
|
3084
3595
|
/** Rule on which item properties or layouts will be changed. */
|
|
3085
3596
|
condition?: Record<string, any> | null;
|
|
3086
3597
|
/**
|
|
3087
3598
|
* Form items with defined properties that will be
|
|
3088
3599
|
* changed when given condition is resolved to true.
|
|
3600
|
+
* @maxSize 500
|
|
3089
3601
|
*/
|
|
3090
3602
|
overrides?: FormOverride[];
|
|
3091
|
-
/**
|
|
3603
|
+
/**
|
|
3604
|
+
* Name of the rule
|
|
3605
|
+
* @maxLength 200
|
|
3606
|
+
*/
|
|
3092
3607
|
name?: string | null;
|
|
3093
3608
|
}
|
|
3094
3609
|
export declare enum OverrideEntityType {
|
|
@@ -3096,15 +3611,28 @@ export declare enum OverrideEntityType {
|
|
|
3096
3611
|
FIELD = "FIELD"
|
|
3097
3612
|
}
|
|
3098
3613
|
export interface FormOverride {
|
|
3099
|
-
/**
|
|
3614
|
+
/**
|
|
3615
|
+
* Override entity type.
|
|
3616
|
+
* @immutable
|
|
3617
|
+
*/
|
|
3100
3618
|
entityType?: OverrideEntityType;
|
|
3101
|
-
/**
|
|
3619
|
+
/**
|
|
3620
|
+
* Overridden entity id. Either fieldId, or "{fieldIdWithNestedForm}/{nestedFormFieldId}"
|
|
3621
|
+
* @immutable
|
|
3622
|
+
* @maxLength 73
|
|
3623
|
+
*/
|
|
3102
3624
|
entityId?: string | null;
|
|
3103
3625
|
/** Form entity properties path with new value, that will be changed on condition. */
|
|
3104
3626
|
valueChanges?: Record<string, any>;
|
|
3105
3627
|
}
|
|
3106
3628
|
export interface FormProperties {
|
|
3107
|
-
/**
|
|
3629
|
+
/**
|
|
3630
|
+
* Form name.
|
|
3631
|
+
* @maxLength 200
|
|
3632
|
+
* @deprecated
|
|
3633
|
+
* @replacedBy wix.forms.v4.Form.name
|
|
3634
|
+
* @targetRemovalDate 2026-01-06
|
|
3635
|
+
*/
|
|
3108
3636
|
name?: string | null;
|
|
3109
3637
|
/**
|
|
3110
3638
|
* Identifies if the form is disabled.
|
|
@@ -3125,12 +3653,18 @@ export interface PostSubmissionTriggers {
|
|
|
3125
3653
|
upsertContact?: UpsertContact;
|
|
3126
3654
|
}
|
|
3127
3655
|
export interface UpsertContact {
|
|
3128
|
-
/**
|
|
3656
|
+
/**
|
|
3657
|
+
* Fields mapping (target field mapped to corresponding contact field).
|
|
3658
|
+
* @maxSize 250
|
|
3659
|
+
*/
|
|
3129
3660
|
fieldsMapping?: Record<string, FormFieldContactInfo>;
|
|
3130
3661
|
/**
|
|
3131
3662
|
* List of contact label keys.
|
|
3132
3663
|
* [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
|
|
3133
3664
|
* help categorize contacts.
|
|
3665
|
+
* @minLength 1
|
|
3666
|
+
* @maxLength 100
|
|
3667
|
+
* @maxSize 20
|
|
3134
3668
|
*/
|
|
3135
3669
|
labels?: string[];
|
|
3136
3670
|
}
|
|
@@ -3146,7 +3680,11 @@ export interface ExtendedFields {
|
|
|
3146
3680
|
namespaces?: Record<string, Record<string, any>>;
|
|
3147
3681
|
}
|
|
3148
3682
|
export interface NestedForm {
|
|
3149
|
-
/**
|
|
3683
|
+
/**
|
|
3684
|
+
* Targets which have this form.
|
|
3685
|
+
* @maxSize 10
|
|
3686
|
+
* @maxLength 200
|
|
3687
|
+
*/
|
|
3150
3688
|
targets?: string[];
|
|
3151
3689
|
/** Nested form. */
|
|
3152
3690
|
form?: Form;
|
|
@@ -3213,37 +3751,67 @@ export interface ThankYouMessageOptions {
|
|
|
3213
3751
|
richContent?: RichContent;
|
|
3214
3752
|
}
|
|
3215
3753
|
export interface RedirectOptions {
|
|
3216
|
-
/**
|
|
3754
|
+
/**
|
|
3755
|
+
* The URL to which the user should be redirected after a successful form submission.
|
|
3756
|
+
* @maxLength 2000
|
|
3757
|
+
*/
|
|
3217
3758
|
redirectUrl?: string | null;
|
|
3218
3759
|
/** How the URL should be opened. */
|
|
3219
3760
|
target?: Target;
|
|
3220
3761
|
}
|
|
3221
3762
|
export interface FieldGroup {
|
|
3222
|
-
/**
|
|
3763
|
+
/**
|
|
3764
|
+
* Id of group, on layout
|
|
3765
|
+
* @format GUID
|
|
3766
|
+
*/
|
|
3223
3767
|
id?: string;
|
|
3224
|
-
/**
|
|
3768
|
+
/**
|
|
3769
|
+
* Label of group
|
|
3770
|
+
* @maxLength 350
|
|
3771
|
+
*/
|
|
3225
3772
|
label?: string | null;
|
|
3226
3773
|
}
|
|
3227
3774
|
export interface PiiFieldsUpdated {
|
|
3228
|
-
/**
|
|
3775
|
+
/**
|
|
3776
|
+
* Collection of fields which are marked as PII
|
|
3777
|
+
* @maxSize 100
|
|
3778
|
+
* @maxLength 200
|
|
3779
|
+
*/
|
|
3229
3780
|
piiFields?: string[];
|
|
3230
|
-
/**
|
|
3781
|
+
/**
|
|
3782
|
+
* Collection of fields which are non PII
|
|
3783
|
+
* @maxSize 100
|
|
3784
|
+
* @maxLength 200
|
|
3785
|
+
*/
|
|
3231
3786
|
nonPiiFields?: string[];
|
|
3232
3787
|
}
|
|
3233
3788
|
export interface SubmissionKeysPermanentlyDeleted {
|
|
3234
|
-
/**
|
|
3789
|
+
/**
|
|
3790
|
+
* Keys which should be deleted
|
|
3791
|
+
* @maxSize 200
|
|
3792
|
+
* @maxLength 200
|
|
3793
|
+
*/
|
|
3235
3794
|
keys?: string[] | null;
|
|
3236
3795
|
}
|
|
3237
3796
|
export interface FormTranslationChanged {
|
|
3238
3797
|
/** The form with updated translations */
|
|
3239
3798
|
form?: Form;
|
|
3240
|
-
/**
|
|
3799
|
+
/**
|
|
3800
|
+
* Language of the translation
|
|
3801
|
+
* @maxLength 20
|
|
3802
|
+
*/
|
|
3241
3803
|
language?: string;
|
|
3242
3804
|
}
|
|
3243
3805
|
export interface FormTranslationDeleted {
|
|
3244
|
-
/**
|
|
3806
|
+
/**
|
|
3807
|
+
* ID of the form with the deleted translation
|
|
3808
|
+
* @format GUID
|
|
3809
|
+
*/
|
|
3245
3810
|
formId?: string;
|
|
3246
|
-
/**
|
|
3811
|
+
/**
|
|
3812
|
+
* Language of the deleted translation
|
|
3813
|
+
* @maxLength 20
|
|
3814
|
+
*/
|
|
3247
3815
|
language?: string;
|
|
3248
3816
|
}
|
|
3249
3817
|
export interface CreateFormRequest {
|
|
@@ -3255,19 +3823,35 @@ export interface CreateFormResponse {
|
|
|
3255
3823
|
form?: Form;
|
|
3256
3824
|
}
|
|
3257
3825
|
export interface TargetBasedErrorDetails {
|
|
3258
|
-
/**
|
|
3826
|
+
/**
|
|
3827
|
+
* Targets which are related to the error.
|
|
3828
|
+
* @maxSize 100
|
|
3829
|
+
* @maxLength 200
|
|
3830
|
+
*/
|
|
3259
3831
|
targets?: string[];
|
|
3260
3832
|
}
|
|
3261
3833
|
export interface FieldIdBasedErrorDetails {
|
|
3262
|
-
/**
|
|
3834
|
+
/**
|
|
3835
|
+
* Field ids which are related to the error.
|
|
3836
|
+
* @maxSize 100
|
|
3837
|
+
* @format GUID
|
|
3838
|
+
*/
|
|
3263
3839
|
ids?: string[];
|
|
3264
3840
|
}
|
|
3265
3841
|
export interface StepIdBasedErrorDetails {
|
|
3266
|
-
/**
|
|
3842
|
+
/**
|
|
3843
|
+
* Step ids which are related to the error.
|
|
3844
|
+
* @maxSize 100
|
|
3845
|
+
* @format GUID
|
|
3846
|
+
*/
|
|
3267
3847
|
ids?: string[];
|
|
3268
3848
|
}
|
|
3269
3849
|
export interface RuleIdBasedErrorDetails {
|
|
3270
|
-
/**
|
|
3850
|
+
/**
|
|
3851
|
+
* Rule ids which are related to the error.
|
|
3852
|
+
* @maxSize 100
|
|
3853
|
+
* @format GUID
|
|
3854
|
+
*/
|
|
3271
3855
|
ids?: string[];
|
|
3272
3856
|
}
|
|
3273
3857
|
export interface NonExistingNestedFormsErrorDetails {
|
|
@@ -3279,17 +3863,33 @@ export interface NestedFormFieldsMissingErrorDetails {
|
|
|
3279
3863
|
targetToNestedFormFieldIds?: Record<string, FieldIdBasedErrorDetails>;
|
|
3280
3864
|
}
|
|
3281
3865
|
export interface FormFieldV2ApiValidationErrorDetails {
|
|
3282
|
-
/**
|
|
3866
|
+
/**
|
|
3867
|
+
* Field ids which are related to the error.
|
|
3868
|
+
* @maxSize 100
|
|
3869
|
+
* @format GUID
|
|
3870
|
+
*/
|
|
3283
3871
|
ids?: string[];
|
|
3284
|
-
/**
|
|
3872
|
+
/**
|
|
3873
|
+
* Violations which are related to the error.
|
|
3874
|
+
* @maxSize 100
|
|
3875
|
+
* @maxLength 500
|
|
3876
|
+
*/
|
|
3285
3877
|
violations?: string[];
|
|
3286
3878
|
}
|
|
3287
3879
|
export interface ProductIdBasedErrorDetails {
|
|
3288
|
-
/**
|
|
3880
|
+
/**
|
|
3881
|
+
* Product ids which are related to the error.
|
|
3882
|
+
* @maxSize 100
|
|
3883
|
+
* @format GUID
|
|
3884
|
+
*/
|
|
3289
3885
|
ids?: string[];
|
|
3290
3886
|
}
|
|
3291
3887
|
export interface BulkCreateFormRequest {
|
|
3292
|
-
/**
|
|
3888
|
+
/**
|
|
3889
|
+
* Forms to be created.
|
|
3890
|
+
* @minSize 1
|
|
3891
|
+
* @maxSize 30
|
|
3892
|
+
*/
|
|
3293
3893
|
forms?: Form[];
|
|
3294
3894
|
/** When set, items will be returned on successful create */
|
|
3295
3895
|
returnEntity?: boolean;
|
|
@@ -3307,7 +3907,10 @@ export interface BulkFormResult {
|
|
|
3307
3907
|
item?: Form;
|
|
3308
3908
|
}
|
|
3309
3909
|
export interface ItemMetadata {
|
|
3310
|
-
/**
|
|
3910
|
+
/**
|
|
3911
|
+
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
3912
|
+
* @format GUID
|
|
3913
|
+
*/
|
|
3311
3914
|
id?: string | null;
|
|
3312
3915
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
3313
3916
|
originalIndex?: number;
|
|
@@ -3333,7 +3936,10 @@ export interface BulkActionMetadata {
|
|
|
3333
3936
|
undetailedFailures?: number;
|
|
3334
3937
|
}
|
|
3335
3938
|
export interface CloneFormRequest {
|
|
3336
|
-
/**
|
|
3939
|
+
/**
|
|
3940
|
+
* Id of the form to clone.
|
|
3941
|
+
* @format GUID
|
|
3942
|
+
*/
|
|
3337
3943
|
formId: string;
|
|
3338
3944
|
}
|
|
3339
3945
|
export interface CloneFormResponse {
|
|
@@ -3341,9 +3947,15 @@ export interface CloneFormResponse {
|
|
|
3341
3947
|
form?: Form;
|
|
3342
3948
|
}
|
|
3343
3949
|
export interface CloneFormFromTemplateRequest {
|
|
3344
|
-
/**
|
|
3950
|
+
/**
|
|
3951
|
+
* Namespace of the vertical owning template
|
|
3952
|
+
* @maxLength 50
|
|
3953
|
+
*/
|
|
3345
3954
|
namespace?: string;
|
|
3346
|
-
/**
|
|
3955
|
+
/**
|
|
3956
|
+
* Template id which can be copied
|
|
3957
|
+
* @format GUID
|
|
3958
|
+
*/
|
|
3347
3959
|
templateId?: string;
|
|
3348
3960
|
/**
|
|
3349
3961
|
* When true, will try to create form with same id as template
|
|
@@ -3356,12 +3968,16 @@ export interface CloneFormFromTemplateResponse {
|
|
|
3356
3968
|
form?: Form;
|
|
3357
3969
|
}
|
|
3358
3970
|
export interface GetFormRequest {
|
|
3359
|
-
/**
|
|
3971
|
+
/**
|
|
3972
|
+
* Id of the form to retrieve.
|
|
3973
|
+
* @format GUID
|
|
3974
|
+
*/
|
|
3360
3975
|
formId: string;
|
|
3361
3976
|
/**
|
|
3362
3977
|
* 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
3978
|
* the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3364
3979
|
* only the form’s base fields are returned.
|
|
3980
|
+
* @maxSize 3
|
|
3365
3981
|
*/
|
|
3366
3982
|
fieldsets?: Fieldset[];
|
|
3367
3983
|
/** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
|
|
@@ -3385,13 +4001,19 @@ export interface UpdateFormResponse {
|
|
|
3385
4001
|
form?: Form;
|
|
3386
4002
|
}
|
|
3387
4003
|
export interface RemoveFormFromTrashBinRequest {
|
|
3388
|
-
/**
|
|
4004
|
+
/**
|
|
4005
|
+
* Id of the form to delete.
|
|
4006
|
+
* @format GUID
|
|
4007
|
+
*/
|
|
3389
4008
|
formId: string;
|
|
3390
4009
|
}
|
|
3391
4010
|
export interface RemoveFormFromTrashBinResponse {
|
|
3392
4011
|
}
|
|
3393
4012
|
export interface DeleteFormRequest {
|
|
3394
|
-
/**
|
|
4013
|
+
/**
|
|
4014
|
+
* Id of the form to delete.
|
|
4015
|
+
* @format GUID
|
|
4016
|
+
*/
|
|
3395
4017
|
formId: string;
|
|
3396
4018
|
/**
|
|
3397
4019
|
* Delete form bypassing trash-bin.
|
|
@@ -3402,7 +4024,10 @@ export interface DeleteFormRequest {
|
|
|
3402
4024
|
export interface DeleteFormResponse {
|
|
3403
4025
|
}
|
|
3404
4026
|
export interface RestoreFromTrashBinRequest {
|
|
3405
|
-
/**
|
|
4027
|
+
/**
|
|
4028
|
+
* Id of the form to restore.
|
|
4029
|
+
* @format GUID
|
|
4030
|
+
*/
|
|
3406
4031
|
formId: string;
|
|
3407
4032
|
}
|
|
3408
4033
|
export interface RestoreFromTrashBinResponse {
|
|
@@ -3416,6 +4041,7 @@ export interface QueryFormsRequest {
|
|
|
3416
4041
|
* 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
4042
|
* the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3418
4043
|
* only the form’s base fields are returned.
|
|
4044
|
+
* @maxSize 3
|
|
3419
4045
|
*/
|
|
3420
4046
|
fieldsets?: Fieldset[];
|
|
3421
4047
|
/** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
|
|
@@ -3436,6 +4062,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
3436
4062
|
/**
|
|
3437
4063
|
* Sort object in the following format:
|
|
3438
4064
|
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
4065
|
+
* @maxSize 3
|
|
3439
4066
|
*/
|
|
3440
4067
|
sort?: Sorting[];
|
|
3441
4068
|
}
|
|
@@ -3445,7 +4072,10 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
3445
4072
|
cursorPaging?: CursorPaging;
|
|
3446
4073
|
}
|
|
3447
4074
|
export interface Sorting {
|
|
3448
|
-
/**
|
|
4075
|
+
/**
|
|
4076
|
+
* Name of the field to sort by.
|
|
4077
|
+
* @maxLength 512
|
|
4078
|
+
*/
|
|
3449
4079
|
fieldName?: string;
|
|
3450
4080
|
/** Sort order. */
|
|
3451
4081
|
order?: SortOrder;
|
|
@@ -3455,7 +4085,10 @@ export declare enum SortOrder {
|
|
|
3455
4085
|
DESC = "DESC"
|
|
3456
4086
|
}
|
|
3457
4087
|
export interface CursorPaging {
|
|
3458
|
-
/**
|
|
4088
|
+
/**
|
|
4089
|
+
* Number of items to load.
|
|
4090
|
+
* @max 100
|
|
4091
|
+
*/
|
|
3459
4092
|
limit?: number | null;
|
|
3460
4093
|
/**
|
|
3461
4094
|
* Pointer to the next or previous page in the list of results.
|
|
@@ -3463,11 +4096,15 @@ export interface CursorPaging {
|
|
|
3463
4096
|
* You can get the relevant cursor token
|
|
3464
4097
|
* from the `pagingMetadata` object in the previous call's response.
|
|
3465
4098
|
* Not relevant for the first request.
|
|
4099
|
+
* @maxLength 16000
|
|
3466
4100
|
*/
|
|
3467
4101
|
cursor?: string | null;
|
|
3468
4102
|
}
|
|
3469
4103
|
export interface QueryFormsResponse {
|
|
3470
|
-
/**
|
|
4104
|
+
/**
|
|
4105
|
+
* The retrieved forms
|
|
4106
|
+
* @maxSize 100
|
|
4107
|
+
*/
|
|
3471
4108
|
forms?: Form[];
|
|
3472
4109
|
/** Details on the paged set of results returned. */
|
|
3473
4110
|
metadata?: CursorPagingMetadata;
|
|
@@ -3485,15 +4122,28 @@ export interface CursorPagingMetadata {
|
|
|
3485
4122
|
hasNext?: boolean | null;
|
|
3486
4123
|
}
|
|
3487
4124
|
export interface Cursors {
|
|
3488
|
-
/**
|
|
4125
|
+
/**
|
|
4126
|
+
* Cursor pointing to next page in the list of results.
|
|
4127
|
+
* @maxLength 16000
|
|
4128
|
+
*/
|
|
3489
4129
|
next?: string | null;
|
|
3490
|
-
/**
|
|
4130
|
+
/**
|
|
4131
|
+
* Cursor pointing to previous page in the list of results.
|
|
4132
|
+
* @maxLength 16000
|
|
4133
|
+
*/
|
|
3491
4134
|
prev?: string | null;
|
|
3492
4135
|
}
|
|
3493
4136
|
export interface CountFormsRequest {
|
|
3494
|
-
/**
|
|
4137
|
+
/**
|
|
4138
|
+
* Namespace name.
|
|
4139
|
+
* @minLength 10
|
|
4140
|
+
* @maxLength 50
|
|
4141
|
+
*/
|
|
3495
4142
|
namespace: string;
|
|
3496
|
-
/**
|
|
4143
|
+
/**
|
|
4144
|
+
* Fieldsets.
|
|
4145
|
+
* @maxSize 3
|
|
4146
|
+
*/
|
|
3497
4147
|
fieldsets?: CountFormsFieldset[];
|
|
3498
4148
|
}
|
|
3499
4149
|
export declare enum CountFormsFieldset {
|
|
@@ -3512,7 +4162,11 @@ export interface CountFormsResponse {
|
|
|
3512
4162
|
deletedCount?: number | null;
|
|
3513
4163
|
}
|
|
3514
4164
|
export interface ListTemplateExtensionsRequest {
|
|
3515
|
-
/**
|
|
4165
|
+
/**
|
|
4166
|
+
* Namespace name.
|
|
4167
|
+
* @minLength 10
|
|
4168
|
+
* @maxLength 50
|
|
4169
|
+
*/
|
|
3516
4170
|
namespace?: string;
|
|
3517
4171
|
/** Identifies if the form is disabled. */
|
|
3518
4172
|
disabled?: boolean | null;
|
|
@@ -3535,15 +4189,25 @@ export interface ListTemplateExtensionsRequest {
|
|
|
3535
4189
|
* 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
4190
|
* the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3537
4191
|
* only the form’s base fields are returned.
|
|
4192
|
+
* @maxSize 3
|
|
3538
4193
|
*/
|
|
3539
4194
|
fieldsets?: Fieldset[];
|
|
3540
|
-
/**
|
|
4195
|
+
/**
|
|
4196
|
+
* Form ids.
|
|
4197
|
+
* @maxSize 10
|
|
4198
|
+
* @format GUID
|
|
4199
|
+
*/
|
|
3541
4200
|
formIds?: string[];
|
|
3542
4201
|
/** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
|
|
3543
4202
|
additionalMetadata?: Record<string, any> | null;
|
|
3544
4203
|
/** Filter by name */
|
|
3545
4204
|
nameFilter?: NameFilter;
|
|
3546
|
-
/**
|
|
4205
|
+
/**
|
|
4206
|
+
* List of templates id, which extensions expected
|
|
4207
|
+
* @minSize 1
|
|
4208
|
+
* @maxSize 100
|
|
4209
|
+
* @format GUID
|
|
4210
|
+
*/
|
|
3547
4211
|
templateIds?: string[];
|
|
3548
4212
|
}
|
|
3549
4213
|
export declare enum ListFormsOrder {
|
|
@@ -3563,7 +4227,10 @@ export declare enum ListFormsOrder {
|
|
|
3563
4227
|
export interface NameFilter {
|
|
3564
4228
|
/** Type of filter */
|
|
3565
4229
|
filterType?: FilterType;
|
|
3566
|
-
/**
|
|
4230
|
+
/**
|
|
4231
|
+
* Expected name
|
|
4232
|
+
* @maxLength 200
|
|
4233
|
+
*/
|
|
3567
4234
|
name?: string;
|
|
3568
4235
|
}
|
|
3569
4236
|
export declare enum FilterType {
|
|
@@ -3571,13 +4238,20 @@ export declare enum FilterType {
|
|
|
3571
4238
|
STARTS_WITH = "STARTS_WITH"
|
|
3572
4239
|
}
|
|
3573
4240
|
export interface ListTemplateExtensionsResponse {
|
|
3574
|
-
/**
|
|
4241
|
+
/**
|
|
4242
|
+
* The retrieved forms.
|
|
4243
|
+
* @maxSize 100
|
|
4244
|
+
*/
|
|
3575
4245
|
forms?: Form[];
|
|
3576
4246
|
/** Details on the paged set of results returned. */
|
|
3577
4247
|
pagingMetadata?: CursorPagingMetadata;
|
|
3578
4248
|
}
|
|
3579
4249
|
export interface ListFormsRequest {
|
|
3580
|
-
/**
|
|
4250
|
+
/**
|
|
4251
|
+
* Namespace name.
|
|
4252
|
+
* @minLength 10
|
|
4253
|
+
* @maxLength 50
|
|
4254
|
+
*/
|
|
3581
4255
|
namespace: string;
|
|
3582
4256
|
/**
|
|
3583
4257
|
* Identifies if the form is disabled.
|
|
@@ -3605,9 +4279,14 @@ export interface ListFormsRequest {
|
|
|
3605
4279
|
* 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
4280
|
* the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3607
4281
|
* only the form’s base fields are returned.
|
|
4282
|
+
* @maxSize 3
|
|
3608
4283
|
*/
|
|
3609
4284
|
fieldsets?: Fieldset[];
|
|
3610
|
-
/**
|
|
4285
|
+
/**
|
|
4286
|
+
* Form ids.
|
|
4287
|
+
* @maxSize 10
|
|
4288
|
+
* @format GUID
|
|
4289
|
+
*/
|
|
3611
4290
|
formIds?: string[];
|
|
3612
4291
|
/** Identifies if the form is a payment form */
|
|
3613
4292
|
paymentForm?: boolean | null;
|
|
@@ -3636,13 +4315,19 @@ export declare enum ListFormsRequestListFormsOrder {
|
|
|
3636
4315
|
NAME_DESC = "NAME_DESC"
|
|
3637
4316
|
}
|
|
3638
4317
|
export interface ListFormsResponse {
|
|
3639
|
-
/**
|
|
4318
|
+
/**
|
|
4319
|
+
* The retrieved forms.
|
|
4320
|
+
* @maxSize 100
|
|
4321
|
+
*/
|
|
3640
4322
|
forms?: Form[];
|
|
3641
4323
|
/** Details on the paged set of results returned. */
|
|
3642
4324
|
pagingMetadata?: CursorPagingMetadata;
|
|
3643
4325
|
}
|
|
3644
4326
|
export interface GetDeletedFormRequest {
|
|
3645
|
-
/**
|
|
4327
|
+
/**
|
|
4328
|
+
* Id of the Form to retrieve
|
|
4329
|
+
* @format GUID
|
|
4330
|
+
*/
|
|
3646
4331
|
formId: string;
|
|
3647
4332
|
}
|
|
3648
4333
|
export interface GetDeletedFormResponse {
|
|
@@ -3654,17 +4339,28 @@ export interface QueryDeletedFormsRequest {
|
|
|
3654
4339
|
query: CursorQuery;
|
|
3655
4340
|
}
|
|
3656
4341
|
export interface QueryDeletedFormsResponse {
|
|
3657
|
-
/**
|
|
4342
|
+
/**
|
|
4343
|
+
* The retrieved Forms
|
|
4344
|
+
* @maxSize 100
|
|
4345
|
+
*/
|
|
3658
4346
|
forms?: Form[];
|
|
3659
4347
|
/** Details on the paged set of results returned. */
|
|
3660
4348
|
metadata?: CursorPagingMetadata;
|
|
3661
4349
|
}
|
|
3662
4350
|
export interface ListDeletedFormsRequest {
|
|
3663
|
-
/**
|
|
4351
|
+
/**
|
|
4352
|
+
* Namespace name.
|
|
4353
|
+
* @minLength 10
|
|
4354
|
+
* @maxLength 50
|
|
4355
|
+
*/
|
|
3664
4356
|
namespace: string;
|
|
3665
4357
|
/** Identifies if the form is disabled. */
|
|
3666
4358
|
disabled?: boolean | null;
|
|
3667
|
-
/**
|
|
4359
|
+
/**
|
|
4360
|
+
* Form ids.
|
|
4361
|
+
* @maxSize 100
|
|
4362
|
+
* @format GUID
|
|
4363
|
+
*/
|
|
3668
4364
|
formIds?: string[];
|
|
3669
4365
|
/**
|
|
3670
4366
|
* Ordering options.
|
|
@@ -3693,15 +4389,25 @@ export declare enum ListDeletedFormsOrder {
|
|
|
3693
4389
|
NAME_ASC = "NAME_ASC"
|
|
3694
4390
|
}
|
|
3695
4391
|
export interface ListDeletedFormsResponse {
|
|
3696
|
-
/**
|
|
4392
|
+
/**
|
|
4393
|
+
* The retrieved forms.
|
|
4394
|
+
* @maxSize 100
|
|
4395
|
+
*/
|
|
3697
4396
|
forms?: Form[];
|
|
3698
4397
|
/** Details on the paged set of results returned. */
|
|
3699
4398
|
pagingMetadata?: CursorPagingMetadata;
|
|
3700
4399
|
}
|
|
3701
4400
|
export interface BulkRemoveDeletedFieldRequest {
|
|
3702
|
-
/**
|
|
4401
|
+
/**
|
|
4402
|
+
* Id of the form to delete.
|
|
4403
|
+
* @format GUID
|
|
4404
|
+
*/
|
|
3703
4405
|
formId: string;
|
|
3704
|
-
/**
|
|
4406
|
+
/**
|
|
4407
|
+
* Ids of the deleted fields to remove.
|
|
4408
|
+
* @maxSize 100
|
|
4409
|
+
* @format GUID
|
|
4410
|
+
*/
|
|
3705
4411
|
fieldsIds?: string[];
|
|
3706
4412
|
}
|
|
3707
4413
|
export interface BulkRemoveDeletedFieldResponse {
|
|
@@ -3717,7 +4423,11 @@ export interface UpdateExtendedFieldsRequest {
|
|
|
3717
4423
|
namespaceData: Record<string, any> | null;
|
|
3718
4424
|
}
|
|
3719
4425
|
export interface UpdateExtendedFieldsResponse {
|
|
3720
|
-
/**
|
|
4426
|
+
/**
|
|
4427
|
+
* namespace that was updated
|
|
4428
|
+
* @minLength 10
|
|
4429
|
+
* @maxLength 50
|
|
4430
|
+
*/
|
|
3721
4431
|
namespace?: string;
|
|
3722
4432
|
/** only data from UpdateExtendedFieldsRequest namespace_data */
|
|
3723
4433
|
namespaceData?: Record<string, any> | null;
|
|
@@ -3725,23 +4435,42 @@ export interface UpdateExtendedFieldsResponse {
|
|
|
3725
4435
|
export interface ListFormsProvidersConfigsRequest {
|
|
3726
4436
|
}
|
|
3727
4437
|
export interface ListFormsProvidersConfigsResponse {
|
|
3728
|
-
/**
|
|
4438
|
+
/**
|
|
4439
|
+
* List of configs set by form providers
|
|
4440
|
+
* @maxSize 50
|
|
4441
|
+
*/
|
|
3729
4442
|
configs?: FormsSchemaProvidersConfig[];
|
|
3730
4443
|
}
|
|
3731
4444
|
export interface FormsSchemaProvidersConfig {
|
|
3732
|
-
/**
|
|
4445
|
+
/**
|
|
4446
|
+
* Namespace which can be used to create form
|
|
4447
|
+
* @maxLength 50
|
|
4448
|
+
*/
|
|
3733
4449
|
namespace?: string;
|
|
3734
|
-
/**
|
|
4450
|
+
/**
|
|
4451
|
+
* Id of app which provides this config.
|
|
4452
|
+
* @maxLength 36
|
|
4453
|
+
*/
|
|
3735
4454
|
appId?: string;
|
|
3736
4455
|
/** Restrictions associated with this namespace. */
|
|
3737
4456
|
restrictions?: FormProviderRestrictions;
|
|
3738
4457
|
}
|
|
3739
4458
|
export interface FormProviderRestrictions {
|
|
3740
|
-
/**
|
|
4459
|
+
/**
|
|
4460
|
+
* Maximum amount of forms allowed per namespace.
|
|
4461
|
+
* @max 15000
|
|
4462
|
+
*/
|
|
3741
4463
|
maxFormsAmount?: number;
|
|
3742
|
-
/**
|
|
4464
|
+
/**
|
|
4465
|
+
* Maximum amount of fields allowed per form.
|
|
4466
|
+
* @max 200
|
|
4467
|
+
*/
|
|
3743
4468
|
maxFieldsAmount?: number;
|
|
3744
|
-
/**
|
|
4469
|
+
/**
|
|
4470
|
+
* Maximum amount of deleted forms allowed per namespace.
|
|
4471
|
+
* @min 1000
|
|
4472
|
+
* @max 1000
|
|
4473
|
+
*/
|
|
3745
4474
|
maxDeletedFormsAmount?: number | null;
|
|
3746
4475
|
}
|
|
3747
4476
|
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
@@ -3819,7 +4548,10 @@ export interface ActionEvent {
|
|
|
3819
4548
|
export interface Empty {
|
|
3820
4549
|
}
|
|
3821
4550
|
export interface GetFormSummaryRequest {
|
|
3822
|
-
/**
|
|
4551
|
+
/**
|
|
4552
|
+
* Id of the form to retrieve.
|
|
4553
|
+
* @format GUID
|
|
4554
|
+
*/
|
|
3823
4555
|
formId: string;
|
|
3824
4556
|
}
|
|
3825
4557
|
export interface GetFormSummaryResponse {
|
|
@@ -3827,9 +4559,15 @@ export interface GetFormSummaryResponse {
|
|
|
3827
4559
|
formSummary?: FormSummary;
|
|
3828
4560
|
}
|
|
3829
4561
|
export interface FormSummary {
|
|
3830
|
-
/**
|
|
4562
|
+
/**
|
|
4563
|
+
* Form ID.
|
|
4564
|
+
* @format GUID
|
|
4565
|
+
*/
|
|
3831
4566
|
id?: string;
|
|
3832
|
-
/**
|
|
4567
|
+
/**
|
|
4568
|
+
* Summarized form fields.
|
|
4569
|
+
* @maxSize 500
|
|
4570
|
+
*/
|
|
3833
4571
|
fields?: Field[];
|
|
3834
4572
|
}
|
|
3835
4573
|
export declare enum FieldInputType {
|
|
@@ -3859,32 +4597,57 @@ export declare enum FieldInputType {
|
|
|
3859
4597
|
DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
|
|
3860
4598
|
}
|
|
3861
4599
|
export interface FieldOption {
|
|
3862
|
-
/**
|
|
4600
|
+
/**
|
|
4601
|
+
* Selectable option label
|
|
4602
|
+
* @maxLength 400
|
|
4603
|
+
*/
|
|
3863
4604
|
label?: string | null;
|
|
3864
|
-
/**
|
|
4605
|
+
/**
|
|
4606
|
+
* Selectable option value, which is saved to DB.
|
|
4607
|
+
* @maxLength 400
|
|
4608
|
+
*/
|
|
3865
4609
|
value?: string | null;
|
|
3866
4610
|
}
|
|
3867
4611
|
export interface Field {
|
|
3868
|
-
/**
|
|
4612
|
+
/**
|
|
4613
|
+
* Definition of a target where the value of field belongs.
|
|
4614
|
+
* @maxLength 200
|
|
4615
|
+
* @immutable
|
|
4616
|
+
*/
|
|
3869
4617
|
target?: string | null;
|
|
3870
|
-
/**
|
|
4618
|
+
/**
|
|
4619
|
+
* Label of the field
|
|
4620
|
+
* @maxLength 350
|
|
4621
|
+
*/
|
|
3871
4622
|
label?: string | null;
|
|
3872
4623
|
/** Input type of the field */
|
|
3873
4624
|
type?: FieldInputType;
|
|
3874
|
-
/**
|
|
4625
|
+
/**
|
|
4626
|
+
* List of options to select from
|
|
4627
|
+
* @maxSize 400
|
|
4628
|
+
*/
|
|
3875
4629
|
options?: FieldOption[];
|
|
3876
4630
|
/**
|
|
3877
4631
|
* Flag indicating whether field is deleted.
|
|
3878
4632
|
* Default: false.
|
|
3879
4633
|
*/
|
|
3880
4634
|
deleted?: boolean;
|
|
3881
|
-
/**
|
|
4635
|
+
/**
|
|
4636
|
+
* Id of the field.
|
|
4637
|
+
* @format GUID
|
|
4638
|
+
*/
|
|
3882
4639
|
id?: string;
|
|
3883
4640
|
}
|
|
3884
4641
|
export interface MessageEnvelope {
|
|
3885
|
-
/**
|
|
4642
|
+
/**
|
|
4643
|
+
* App instance ID.
|
|
4644
|
+
* @format GUID
|
|
4645
|
+
*/
|
|
3886
4646
|
instanceId?: string | null;
|
|
3887
|
-
/**
|
|
4647
|
+
/**
|
|
4648
|
+
* Event type.
|
|
4649
|
+
* @maxLength 150
|
|
4650
|
+
*/
|
|
3888
4651
|
eventType?: string;
|
|
3889
4652
|
/** The identification type and identity data. */
|
|
3890
4653
|
identity?: IdentificationData;
|
|
@@ -3892,26 +4655,50 @@ export interface MessageEnvelope {
|
|
|
3892
4655
|
data?: string;
|
|
3893
4656
|
}
|
|
3894
4657
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3895
|
-
/**
|
|
4658
|
+
/**
|
|
4659
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4660
|
+
* @format GUID
|
|
4661
|
+
*/
|
|
3896
4662
|
anonymousVisitorId?: string;
|
|
3897
|
-
/**
|
|
4663
|
+
/**
|
|
4664
|
+
* ID of a site visitor that has logged in to the site.
|
|
4665
|
+
* @format GUID
|
|
4666
|
+
*/
|
|
3898
4667
|
memberId?: string;
|
|
3899
|
-
/**
|
|
4668
|
+
/**
|
|
4669
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4670
|
+
* @format GUID
|
|
4671
|
+
*/
|
|
3900
4672
|
wixUserId?: string;
|
|
3901
|
-
/**
|
|
4673
|
+
/**
|
|
4674
|
+
* ID of an app.
|
|
4675
|
+
* @format GUID
|
|
4676
|
+
*/
|
|
3902
4677
|
appId?: string;
|
|
3903
4678
|
/** @readonly */
|
|
3904
4679
|
identityType?: WebhookIdentityType;
|
|
3905
4680
|
}
|
|
3906
4681
|
/** @oneof */
|
|
3907
4682
|
export interface IdentificationDataIdOneOf {
|
|
3908
|
-
/**
|
|
4683
|
+
/**
|
|
4684
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4685
|
+
* @format GUID
|
|
4686
|
+
*/
|
|
3909
4687
|
anonymousVisitorId?: string;
|
|
3910
|
-
/**
|
|
4688
|
+
/**
|
|
4689
|
+
* ID of a site visitor that has logged in to the site.
|
|
4690
|
+
* @format GUID
|
|
4691
|
+
*/
|
|
3911
4692
|
memberId?: string;
|
|
3912
|
-
/**
|
|
4693
|
+
/**
|
|
4694
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4695
|
+
* @format GUID
|
|
4696
|
+
*/
|
|
3913
4697
|
wixUserId?: string;
|
|
3914
|
-
/**
|
|
4698
|
+
/**
|
|
4699
|
+
* ID of an app.
|
|
4700
|
+
* @format GUID
|
|
4701
|
+
*/
|
|
3915
4702
|
appId?: string;
|
|
3916
4703
|
}
|
|
3917
4704
|
export declare enum WebhookIdentityType {
|