@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.
@@ -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
- * @readonly
10
+ * @maxSize 500
10
11
  */
11
12
  fieldsV2?: FormFieldV2[];
12
- /** Defines the layout for form fields in each submission step. */
13
+ /**
14
+ * Defines the layout for form fields in each submission step.
15
+ * @maxSize 100
16
+ */
13
17
  steps?: Step[];
14
- /** Form rules, can be applied to layout and items properties. */
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
- /** Identifies the namespace that the form belongs to. */
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
- /** Settings for field groups */
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 disabled.
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
- /** Item ID. */
115
+ /**
116
+ * Item ID.
117
+ * @format GUID
118
+ * @immutable
119
+ */
93
120
  _id?: string;
94
- /** Definition of a target where the value of field belongs. */
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
- /** Minimum length. */
154
+ /**
155
+ * Minimum length.
156
+ * @max 20000
157
+ */
124
158
  minLength?: number | null;
125
- /** Maximum length. */
159
+ /**
160
+ * Maximum length.
161
+ * @max 20000
162
+ */
126
163
  maxLength?: number | null;
127
- /** Pattern for a regular expression match. */
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
- /** List of allowed values. */
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
- /** Default error message on invalid validation. */
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
- /** Country codes for phone number that are allowed */
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
- /** List of allowed values. */
251
+ /**
252
+ * List of allowed values.
253
+ * @maxSize 500
254
+ */
199
255
  enum?: number[] | null;
200
256
  }
201
257
  export interface NumberErrorMessages {
202
- /** Default error message on invalid validation. */
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
- /** List of allowed values. */
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
- /** List of allowed values. */
282
+ /**
283
+ * List of allowed values.
284
+ * @maxSize 2
285
+ */
221
286
  enum?: boolean[];
222
287
  }
223
288
  export interface BooleanErrorMessages {
224
- /** Default error message on invalid validation. */
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
- /** Maximum amount of array elements. */
296
+ /**
297
+ * Maximum amount of array elements.
298
+ * @max 1000
299
+ */
229
300
  maxItems?: number | null;
230
- /** Minimum amount of array elements. */
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
- /** Default error message on invalid validation. */
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
- /** Default error message on invalid validation. */
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
- /** Field mapped to products. */
410
+ /**
411
+ * Field mapped to products.
412
+ * @minSize 1
413
+ * @maxSize 100
414
+ */
331
415
  products?: Product[];
332
- /** Minimum amount of different products. */
416
+ /**
417
+ * Minimum amount of different products.
418
+ * @max 100
419
+ */
333
420
  minItems?: number | null;
334
- /** Maximum amount of different products. */
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
- /** Minimum quantity. */
444
+ /**
445
+ * Minimum quantity.
446
+ * @min 1
447
+ * @max 100000
448
+ */
355
449
  minimum?: number | null;
356
- /** Maximum quantity. */
450
+ /**
451
+ * Maximum quantity.
452
+ * @min 1
453
+ * @max 100000
454
+ */
357
455
  maximum?: number | null;
358
456
  }
359
457
  export interface FixedPriceOptions {
360
- /** Fixed price monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). */
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
- /** Minimal price monetary amount. */
465
+ /**
466
+ * Minimal price monetary amount.
467
+ * @decimalValue options { gte:0.00, maxScale:2 }
468
+ */
365
469
  minPrice?: string;
366
- /** Maximal price monetary amount. */
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
- /** Allowed countries. No countries treated as all. */
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
- /** FQDNS which can be extended with this field */
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
- /** Field id. */
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
- /** Minimum length. */
627
+ /**
628
+ * Minimum length.
629
+ * @max 20000
630
+ */
507
631
  minLength?: number | null;
508
- /** Maximum length. */
632
+ /**
633
+ * Maximum length.
634
+ * @max 20000
635
+ */
509
636
  maxLength?: number | null;
510
- /** Pattern for a regular expression match. */
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
- /** List of allowed values. */
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
- /** Default error message on invalid validation. */
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
- /** Country codes for phone number that are allowed */
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
- /** Label of the field */
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
- /** Placeholder for the value input */
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
- /** Default value for the text input */
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
- /** GIF format URL. */
1348
+ /**
1349
+ * GIF format URL.
1350
+ * @format WEB_URL
1351
+ */
1197
1352
  gif?: string | null;
1198
- /** MP4 format URL. */
1353
+ /**
1354
+ * MP4 format URL.
1355
+ * @format WEB_URL
1356
+ */
1199
1357
  mp4?: string | null;
1200
- /** Thumbnail URL. */
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
- /** Border color. */
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
- /** The start color as a hexademical value. */
1592
+ /**
1593
+ * The start color as a hexademical value.
1594
+ * @format COLOR_HEX
1595
+ */
1429
1596
  startColor?: string | null;
1430
- /** The end color as a hexademical value. */
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
- /** The background color as a hexademical value. */
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
- /** The background color as a hexademical value. */
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
- /** Cell background color as a hexadecimal value. */
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
- /** Left border color as a hexadecimal value. */
1940
+ /**
1941
+ * Left border color as a hexadecimal value.
1942
+ * @format COLOR_HEX
1943
+ */
1762
1944
  left?: string | null;
1763
- /** Right border color as a hexadecimal value. */
1945
+ /**
1946
+ * Right border color as a hexadecimal value.
1947
+ * @format COLOR_HEX
1948
+ */
1764
1949
  right?: string | null;
1765
- /** Top border color as a hexadecimal value. */
1950
+ /**
1951
+ * Top border color as a hexadecimal value.
1952
+ * @format COLOR_HEX
1953
+ */
1766
1954
  top?: string | null;
1767
- /** Bottom border color as a hexadecimal value. */
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
- /** Label of the field */
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
- /** Selectable option label */
2094
+ /**
2095
+ * Selectable option label
2096
+ * @maxLength 400
2097
+ */
1900
2098
  label?: string | null;
1901
- /** Selectable option value, which is saved to DB. */
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
- /** Option id. Used as binding for translations */
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
- /** Label of custom option input */
2114
+ /**
2115
+ * Label of custom option input
2116
+ * @maxLength 350
2117
+ */
1910
2118
  label?: string | null;
1911
- /** Placeholder of custom option input */
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
- /** Label of the field */
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
- /** List of options to select from */
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
- /** Placeholder of dropdown input */
2157
+ /**
2158
+ * Placeholder of dropdown input
2159
+ * @maxLength 100
2160
+ */
1941
2161
  placeholder?: string | null;
1942
2162
  }
1943
2163
  export interface DropdownOption {
1944
- /** Selectable option label */
2164
+ /**
2165
+ * Selectable option label
2166
+ * @maxLength 400
2167
+ */
1945
2168
  label?: string | null;
1946
- /** Selectable option value, which is saved to DB. */
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
- /** Option id. Used as binding for translations */
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
- /** Label of custom option input */
2184
+ /**
2185
+ * Label of custom option input
2186
+ * @maxLength 350
2187
+ */
1955
2188
  label?: string | null;
1956
- /** Placeholder of custom option input */
2189
+ /**
2190
+ * Placeholder of custom option input
2191
+ * @maxLength 100
2192
+ */
1957
2193
  placeholder?: string | null;
1958
2194
  }
1959
2195
  export interface DateTimeInput {
1960
- /** Label of the field. Displayed text for the date/time input. */
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
- /** Default value for the date time input. */
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
- /** Label of the field */
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
- /** Placeholder for the value input */
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
- /** Default value of the country code */
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
- /** Label of the field. Displayed text for the date/time input. */
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
- /** Default value for the date input. */
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
- /** Label of the field. Displayed text for the date/time input. */
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
- /** Default value for the time input. */
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
- /** Label of the field. Displayed text for the date/time input. */
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
- /** Placeholder of date picker input */
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
- /** Default value for the date picker. */
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
- /** List of allowed values. */
2348
+ /**
2349
+ * List of allowed values.
2350
+ * @maxSize 500
2351
+ */
2076
2352
  enum?: number[] | null;
2077
2353
  }
2078
2354
  export interface InputFieldNumberErrorMessages {
2079
- /** Default error message on invalid validation. */
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
- /** Label of the field */
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
- /** Placeholder for the value input */
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
- /** Label of the field */
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
- /** Default rating */
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
- /** List of allowed values. */
2410
+ /**
2411
+ * List of allowed values.
2412
+ * @maxSize 2
2413
+ */
2119
2414
  enum?: boolean[];
2120
2415
  }
2121
2416
  export interface InputFieldBooleanErrorMessages {
2122
- /** Default error message on invalid validation. */
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
- /** Maximum amount of array elements. */
2437
+ /**
2438
+ * Maximum amount of array elements.
2439
+ * @max 1000
2440
+ */
2140
2441
  maxItems?: number | null;
2141
- /** Minimum amount of array elements. */
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
- /** List of allowed values. */
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
- /** Default error message on invalid validation. */
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
- /** Default error message on invalid validation. */
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
- /** Label of the field */
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
- /** List of options to select from */
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,29 +2603,48 @@ export interface MediaItemMediaOneOf {
2284
2603
  image?: string;
2285
2604
  }
2286
2605
  export interface Option {
2287
- /** Selectable option label */
2606
+ /**
2607
+ * Selectable option label
2608
+ * @maxLength 400
2609
+ */
2288
2610
  label?: string | null;
2289
2611
  /** Selectable option value, which is saved to DB. */
2290
2612
  value?: any;
2291
2613
  /** Flag identifying that option should be selected by default */
2292
2614
  default?: boolean;
2293
- /** Option id. Used as binding for translations */
2615
+ /**
2616
+ * Option id. Used as binding for translations
2617
+ * @format GUID
2618
+ * @immutable
2619
+ */
2294
2620
  _id?: string;
2295
2621
  /** Media item. Media, associated with option, like image. */
2296
2622
  media?: MediaItem;
2297
2623
  }
2298
2624
  export interface CustomOption {
2299
- /** Label of custom option input */
2625
+ /**
2626
+ * Label of custom option input
2627
+ * @maxLength 350
2628
+ */
2300
2629
  label?: string | null;
2301
- /** Placeholder of custom option input */
2630
+ /**
2631
+ * Placeholder of custom option input
2632
+ * @maxLength 100
2633
+ */
2302
2634
  placeholder?: string | null;
2303
2635
  }
2304
2636
  export interface Tags {
2305
- /** Label of the field */
2637
+ /**
2638
+ * Label of the field
2639
+ * @maxLength 350
2640
+ */
2306
2641
  label?: string | null;
2307
2642
  /** Description of the field */
2308
2643
  description?: RichContent;
2309
- /** List of options to select from */
2644
+ /**
2645
+ * List of options to select from
2646
+ * @maxSize 400
2647
+ */
2310
2648
  options?: TagsOption[];
2311
2649
  /**
2312
2650
  * Flag identifying to hide or not label
@@ -2322,21 +2660,34 @@ export interface Tags {
2322
2660
  numberOfColumns?: NumberOfColumns;
2323
2661
  }
2324
2662
  export interface TagsOption {
2325
- /** Selectable option label */
2663
+ /**
2664
+ * Selectable option label
2665
+ * @maxLength 400
2666
+ */
2326
2667
  label?: string | null;
2327
2668
  /** Selectable option value, which is saved to DB. */
2328
2669
  value?: any;
2329
2670
  /** Flag identifying that option should be selected by default */
2330
2671
  default?: boolean;
2331
- /** Option id. Used as binding for translations */
2672
+ /**
2673
+ * Option id. Used as binding for translations
2674
+ * @format GUID
2675
+ * @immutable
2676
+ */
2332
2677
  _id?: string;
2333
2678
  /** Media item. Media, associated with option, like image. */
2334
2679
  media?: MediaItem;
2335
2680
  }
2336
2681
  export interface CommonCustomOption {
2337
- /** Label of custom option input */
2682
+ /**
2683
+ * Label of custom option input
2684
+ * @maxLength 350
2685
+ */
2338
2686
  label?: string | null;
2339
- /** Placeholder of custom option input */
2687
+ /**
2688
+ * Placeholder of custom option input
2689
+ * @maxLength 100
2690
+ */
2340
2691
  placeholder?: string | null;
2341
2692
  }
2342
2693
  export declare enum WixFileComponentType {
@@ -2345,7 +2696,10 @@ export declare enum WixFileComponentType {
2345
2696
  SIGNATURE = "SIGNATURE"
2346
2697
  }
2347
2698
  export interface FileUpload {
2348
- /** Selectable option label */
2699
+ /**
2700
+ * Selectable option label
2701
+ * @maxLength 350
2702
+ */
2349
2703
  label?: string | null;
2350
2704
  /** Description of the field */
2351
2705
  description?: RichContent;
@@ -2354,13 +2708,26 @@ export interface FileUpload {
2354
2708
  * Default: true
2355
2709
  */
2356
2710
  showLabel?: boolean | null;
2357
- /** Text on upload button */
2711
+ /**
2712
+ * Text on upload button
2713
+ * @maxLength 500
2714
+ */
2358
2715
  buttonText?: string | null;
2359
- /** Amount of files allowed to upload */
2716
+ /**
2717
+ * Amount of files allowed to upload
2718
+ * @min 1
2719
+ * @max 30
2720
+ */
2360
2721
  fileLimit?: number;
2361
- /** Supported file formats for upload */
2722
+ /**
2723
+ * Supported file formats for upload
2724
+ * @maxSize 5
2725
+ */
2362
2726
  uploadFileFormats?: UploadFileFormat[];
2363
- /** Custom text which appears when file is uploaded, if missing file name will be shown */
2727
+ /**
2728
+ * Custom text which appears when file is uploaded, if missing file name will be shown
2729
+ * @maxLength 255
2730
+ */
2364
2731
  explanationText?: string | null;
2365
2732
  }
2366
2733
  export declare enum UploadFileFormat {
@@ -2378,7 +2745,10 @@ export declare enum UploadFileFormat {
2378
2745
  ARCHIVE = "ARCHIVE"
2379
2746
  }
2380
2747
  export interface Signature {
2381
- /** Selectable option label */
2748
+ /**
2749
+ * Selectable option label
2750
+ * @maxLength 350
2751
+ */
2382
2752
  label?: string | null;
2383
2753
  /**
2384
2754
  * Flag identifying to hide label or not
@@ -2398,11 +2768,17 @@ export declare enum PaymentComponentType {
2398
2768
  FIXED_PAYMENT = "FIXED_PAYMENT"
2399
2769
  }
2400
2770
  export interface ProductCheckboxGroup {
2401
- /** Label of the field. */
2771
+ /**
2772
+ * Label of the field.
2773
+ * @maxLength 350
2774
+ */
2402
2775
  label?: string | null;
2403
2776
  /** Description of the field. */
2404
2777
  description?: RichContent;
2405
- /** List of options to select from. */
2778
+ /**
2779
+ * List of options to select from.
2780
+ * @maxSize 400
2781
+ */
2406
2782
  options?: ProductCheckboxGroupOption[];
2407
2783
  /**
2408
2784
  * Flag identifying to hide or not label
@@ -2416,11 +2792,18 @@ export interface ProductCheckboxGroup {
2416
2792
  imageFit?: ImageFit;
2417
2793
  }
2418
2794
  export interface ProductCheckboxGroupOption {
2419
- /** Selectable option label. */
2795
+ /**
2796
+ * Selectable option label.
2797
+ * @maxLength 400
2798
+ */
2420
2799
  label?: string | null;
2421
2800
  /** Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list. */
2422
2801
  value?: any;
2423
- /** Option id. Used as binding for translations. */
2802
+ /**
2803
+ * Option id. Used as binding for translations.
2804
+ * @format GUID
2805
+ * @immutable
2806
+ */
2424
2807
  _id?: string;
2425
2808
  /** Media item. Media, associated with option, like image. */
2426
2809
  media?: MediaItem;
@@ -2435,11 +2818,17 @@ export declare enum ImageFit {
2435
2818
  CONTAIN = "CONTAIN"
2436
2819
  }
2437
2820
  export interface DonationInput {
2438
- /** Label of the field. */
2821
+ /**
2822
+ * Label of the field.
2823
+ * @maxLength 350
2824
+ */
2439
2825
  label?: string | null;
2440
2826
  /** Description of the field. */
2441
2827
  description?: RichContent;
2442
- /** List of options to select from. */
2828
+ /**
2829
+ * List of options to select from.
2830
+ * @maxSize 400
2831
+ */
2443
2832
  options?: DonationInputOption[];
2444
2833
  /** Option which can be specified by UoU, enabled when this object is specified. */
2445
2834
  customOption?: CommonCustomOption;
@@ -2455,13 +2844,19 @@ export interface DonationInput {
2455
2844
  showLabel?: boolean | null;
2456
2845
  }
2457
2846
  export interface DonationInputOption {
2458
- /** Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list. */
2847
+ /**
2848
+ * Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list.
2849
+ * @format GUID
2850
+ */
2459
2851
  value?: string;
2460
2852
  /** Flag identifying that option should be selected by default */
2461
2853
  default?: boolean;
2462
2854
  }
2463
2855
  export interface PaymentInput {
2464
- /** Label of the field. */
2856
+ /**
2857
+ * Label of the field.
2858
+ * @maxLength 350
2859
+ */
2465
2860
  label?: string | null;
2466
2861
  /** Description of the field. */
2467
2862
  description?: RichContent;
@@ -2470,13 +2865,19 @@ export interface PaymentInput {
2470
2865
  * Default: true
2471
2866
  */
2472
2867
  showLabel?: boolean | null;
2473
- /** Placeholder of custom option input */
2868
+ /**
2869
+ * Placeholder of custom option input
2870
+ * @maxLength 100
2871
+ */
2474
2872
  placeholder?: string | null;
2475
2873
  /** Default value for the payment input */
2476
2874
  default?: number | null;
2477
2875
  }
2478
2876
  export interface FixedPayment {
2479
- /** Label of the field. */
2877
+ /**
2878
+ * Label of the field.
2879
+ * @maxLength 350
2880
+ */
2480
2881
  label?: string | null;
2481
2882
  /** Description of the field. */
2482
2883
  description?: RichContent;
@@ -2497,15 +2898,30 @@ export interface Appointment extends AppointmentFormatInfoOneOf {
2497
2898
  videoConferenceOptions?: VideoConferenceOptions;
2498
2899
  /** Phone options for the appointment */
2499
2900
  phoneOptions?: PhoneOptions;
2500
- /** Label of the field */
2901
+ /**
2902
+ * Label of the field
2903
+ * @maxLength 255
2904
+ */
2501
2905
  label?: string | null;
2502
- /** Name of the appointment */
2906
+ /**
2907
+ * Name of the appointment
2908
+ * @minLength 1
2909
+ * @maxLength 400
2910
+ */
2503
2911
  name?: string | null;
2504
- /** Duration of the appointment in minutes */
2912
+ /**
2913
+ * Duration of the appointment in minutes
2914
+ * @min 1
2915
+ * @max 44639
2916
+ */
2505
2917
  durationInMinutes?: number | null;
2506
2918
  /** Indicates whether manual approval is required for the appointment */
2507
2919
  manualApprovalRequired?: boolean | null;
2508
- /** ID of the staff members providing the appointment */
2920
+ /**
2921
+ * ID of the staff members providing the appointment
2922
+ * @maxSize 220
2923
+ * @format GUID
2924
+ */
2509
2925
  staffIds?: string[] | null;
2510
2926
  /** The format of the appointment */
2511
2927
  format?: Format;
@@ -2520,16 +2936,28 @@ export interface AppointmentFormatInfoOneOf {
2520
2936
  phoneOptions?: PhoneOptions;
2521
2937
  }
2522
2938
  export interface Location extends LocationLocationInfoOneOf {
2523
- /** Custom address details */
2939
+ /**
2940
+ * Custom address details
2941
+ * @maxLength 512
2942
+ */
2524
2943
  customAddress?: string | null;
2525
- /** ID of a business location */
2944
+ /**
2945
+ * ID of a business location
2946
+ * @format GUID
2947
+ */
2526
2948
  businessLocationId?: string | null;
2527
2949
  }
2528
2950
  /** @oneof */
2529
2951
  export interface LocationLocationInfoOneOf {
2530
- /** Custom address details */
2952
+ /**
2953
+ * Custom address details
2954
+ * @maxLength 512
2955
+ */
2531
2956
  customAddress?: string | null;
2532
- /** ID of a business location */
2957
+ /**
2958
+ * ID of a business location
2959
+ * @format GUID
2960
+ */
2533
2961
  businessLocationId?: string | null;
2534
2962
  }
2535
2963
  export declare enum Format {
@@ -2539,15 +2967,25 @@ export declare enum Format {
2539
2967
  PHONE = "PHONE"
2540
2968
  }
2541
2969
  export interface InPersonOptions {
2542
- /** The locations details */
2970
+ /**
2971
+ * The locations details
2972
+ * @minSize 1
2973
+ * @maxSize 500
2974
+ */
2543
2975
  locations?: Location[];
2544
2976
  }
2545
2977
  export interface VideoConferenceOptions {
2546
- /** Description or instructions for the online video conference */
2978
+ /**
2979
+ * Description or instructions for the online video conference
2980
+ * @maxLength 512
2981
+ */
2547
2982
  description?: string | null;
2548
2983
  }
2549
2984
  export interface PhoneOptions {
2550
- /** Description or instructions for the phone appointment */
2985
+ /**
2986
+ * Description or instructions for the phone appointment
2987
+ * @maxLength 512
2988
+ */
2551
2989
  description?: string | null;
2552
2990
  }
2553
2991
  export declare enum MultilineAddressComponentType {
@@ -2555,7 +2993,10 @@ export declare enum MultilineAddressComponentType {
2555
2993
  MULTILINE_ADDRESS = "MULTILINE_ADDRESS"
2556
2994
  }
2557
2995
  export interface MultilineAddress {
2558
- /** Label of the field. */
2996
+ /**
2997
+ * Label of the field.
2998
+ * @maxLength 350
2999
+ */
2559
3000
  label?: string | null;
2560
3001
  /** Description of the field. */
2561
3002
  description?: RichContent;
@@ -2581,14 +3022,20 @@ export interface AddressLine2 {
2581
3022
  show?: boolean;
2582
3023
  }
2583
3024
  export interface DefaultCountryConfig extends DefaultCountryConfigOptionsOneOf {
2584
- /** Country. */
3025
+ /**
3026
+ * Country.
3027
+ * @format COUNTRY
3028
+ */
2585
3029
  countryOptions?: string;
2586
3030
  /** Default country type. */
2587
3031
  type?: Type;
2588
3032
  }
2589
3033
  /** @oneof */
2590
3034
  export interface DefaultCountryConfigOptionsOneOf {
2591
- /** Country. */
3035
+ /**
3036
+ * Country.
3037
+ * @format COUNTRY
3038
+ */
2592
3039
  countryOptions?: string;
2593
3040
  }
2594
3041
  export interface FieldsSettings {
@@ -2678,7 +3125,11 @@ export interface AddressInfo {
2678
3125
  tag?: Tag;
2679
3126
  }
2680
3127
  export interface CustomFieldInfo {
2681
- /** Custom field key. */
3128
+ /**
3129
+ * Custom field key.
3130
+ * @minLength 1
3131
+ * @maxLength 500
3132
+ */
2682
3133
  key?: string;
2683
3134
  }
2684
3135
  export interface SubscriptionInfo {
@@ -2897,7 +3348,12 @@ export interface InputField extends InputFieldInputTypeOptionsOneOf {
2897
3348
  multilineAddressOptions?: InputFieldMultilineAddress;
2898
3349
  /** Input returns scheduling as value. */
2899
3350
  schedulingOptions?: Scheduling;
2900
- /** Definition of a target where the value of field belongs. */
3351
+ /**
3352
+ * Definition of a target where the value of field belongs.
3353
+ * @minLength 1
3354
+ * @maxLength 200
3355
+ * @immutable
3356
+ */
2901
3357
  target?: string | null;
2902
3358
  /**
2903
3359
  * Mark the field as containing personal information. This will encrypt user data when storing it.
@@ -2969,17 +3425,33 @@ export interface RichContentOptions {
2969
3425
  richContent?: RichContent;
2970
3426
  }
2971
3427
  export interface PageNavigationOptions {
2972
- /** When button is not on last page it behaves as switch between pages page, text of label to go to next page. */
3428
+ /**
3429
+ * When button is not on last page it behaves as switch between pages page, text of label to go to next page.
3430
+ * @maxLength 65
3431
+ */
2973
3432
  nextPageText?: string | null;
2974
- /** When button is not on last page it behaves as switch between pages page, text of label to go to previous page. */
3433
+ /**
3434
+ * When button is not on last page it behaves as switch between pages page, text of label to go to previous page.
3435
+ * @maxLength 65
3436
+ */
2975
3437
  previousPageText?: string | null;
2976
- /** Text on the button when button is submitting a form */
3438
+ /**
3439
+ * Text on the button when button is submitting a form
3440
+ * @maxLength 65
3441
+ */
2977
3442
  submitText?: string | null;
2978
3443
  }
2979
3444
  export interface Step {
2980
- /** Step ID. */
3445
+ /**
3446
+ * Step ID.
3447
+ * @format GUID
3448
+ * @immutable
3449
+ */
2981
3450
  _id?: string;
2982
- /** Name of the step. */
3451
+ /**
3452
+ * Name of the step.
3453
+ * @maxLength 200
3454
+ */
2983
3455
  name?: string | null;
2984
3456
  /** Is step hidden */
2985
3457
  hidden?: boolean;
@@ -2995,7 +3467,10 @@ export interface FormLayout {
2995
3467
  small?: BreakPoint;
2996
3468
  }
2997
3469
  export interface BreakPoint {
2998
- /** Description of layouts for items. */
3470
+ /**
3471
+ * Description of layouts for items.
3472
+ * @maxSize 500
3473
+ */
2999
3474
  items?: ItemLayout[];
3000
3475
  /** Amount of columns of layout grid. */
3001
3476
  columns?: number | null;
@@ -3005,11 +3480,17 @@ export interface BreakPoint {
3005
3480
  margin?: Margin;
3006
3481
  /** Description of elements paddings. */
3007
3482
  padding?: Margin;
3008
- /** Sections of the layout, which allow manage fields */
3483
+ /**
3484
+ * Sections of the layout, which allow manage fields
3485
+ * @maxSize 100
3486
+ */
3009
3487
  sections?: Section[];
3010
3488
  }
3011
3489
  export interface ItemLayout extends ItemLayoutItemOneOf {
3012
- /** Form field reference id. */
3490
+ /**
3491
+ * Form field reference id.
3492
+ * @format GUID
3493
+ */
3013
3494
  fieldId?: string;
3014
3495
  /** Group info, defining that this item is a group of multiple fields */
3015
3496
  group?: Group;
@@ -3024,15 +3505,25 @@ export interface ItemLayout extends ItemLayoutItemOneOf {
3024
3505
  }
3025
3506
  /** @oneof */
3026
3507
  export interface ItemLayoutItemOneOf {
3027
- /** Form field reference id. */
3508
+ /**
3509
+ * Form field reference id.
3510
+ * @format GUID
3511
+ */
3028
3512
  fieldId?: string;
3029
3513
  /** Group info, defining that this item is a group of multiple fields */
3030
3514
  group?: Group;
3031
3515
  }
3032
3516
  export interface Group {
3033
- /** Field group reference id. */
3517
+ /**
3518
+ * Field group reference id.
3519
+ * @format GUID
3520
+ */
3034
3521
  groupId?: string;
3035
- /** Description of layouts for items. */
3522
+ /**
3523
+ * Description of layouts for items.
3524
+ * @minSize 1
3525
+ * @maxSize 500
3526
+ */
3036
3527
  items?: ItemLayout[];
3037
3528
  }
3038
3529
  export interface Margin {
@@ -3042,7 +3533,11 @@ export interface Margin {
3042
3533
  vertical?: number | null;
3043
3534
  }
3044
3535
  export interface Section {
3045
- /** Id of the section */
3536
+ /**
3537
+ * Id of the section
3538
+ * @format GUID
3539
+ * @minLength 1
3540
+ */
3046
3541
  _id?: string;
3047
3542
  /** Horizontal coordinate in the grid. */
3048
3543
  row?: number | null;
@@ -3052,20 +3547,30 @@ export interface Section {
3052
3547
  * If the section encounters the $new key within the list,
3053
3548
  * it allows the inclusion of fields not explicitly listed,
3054
3549
  * enabling dynamic addition of new fields.
3550
+ * @maxSize 100
3551
+ * @maxLength 100
3055
3552
  */
3056
3553
  allowedFieldIds?: string[];
3057
3554
  }
3058
3555
  export interface FormRule {
3059
- /** Id of the rule */
3556
+ /**
3557
+ * Id of the rule
3558
+ * @format GUID
3559
+ * @immutable
3560
+ */
3060
3561
  _id?: string;
3061
3562
  /** Rule on which item properties or layouts will be changed. */
3062
3563
  condition?: Record<string, any> | null;
3063
3564
  /**
3064
3565
  * Form items with defined properties that will be
3065
3566
  * changed when given condition is resolved to true.
3567
+ * @maxSize 500
3066
3568
  */
3067
3569
  overrides?: FormOverride[];
3068
- /** Name of the rule */
3570
+ /**
3571
+ * Name of the rule
3572
+ * @maxLength 200
3573
+ */
3069
3574
  name?: string | null;
3070
3575
  }
3071
3576
  export declare enum OverrideEntityType {
@@ -3073,15 +3578,28 @@ export declare enum OverrideEntityType {
3073
3578
  FIELD = "FIELD"
3074
3579
  }
3075
3580
  export interface FormOverride {
3076
- /** Override entity type. */
3581
+ /**
3582
+ * Override entity type.
3583
+ * @immutable
3584
+ */
3077
3585
  entityType?: OverrideEntityType;
3078
- /** Overridden entity id. Either fieldId, or "{fieldIdWithNestedForm}/{nestedFormFieldId}" */
3586
+ /**
3587
+ * Overridden entity id. Either fieldId, or "{fieldIdWithNestedForm}/{nestedFormFieldId}"
3588
+ * @immutable
3589
+ * @maxLength 73
3590
+ */
3079
3591
  entityId?: string | null;
3080
3592
  /** Form entity properties path with new value, that will be changed on condition. */
3081
3593
  valueChanges?: Record<string, any>;
3082
3594
  }
3083
3595
  export interface FormProperties {
3084
- /** Form name. */
3596
+ /**
3597
+ * Form name.
3598
+ * @maxLength 200
3599
+ * @deprecated
3600
+ * @replacedBy wix.forms.v4.Form.name
3601
+ * @targetRemovalDate 2026-01-06
3602
+ */
3085
3603
  name?: string | null;
3086
3604
  /**
3087
3605
  * Identifies if the form is disabled.
@@ -3102,12 +3620,18 @@ export interface PostSubmissionTriggers {
3102
3620
  upsertContact?: UpsertContact;
3103
3621
  }
3104
3622
  export interface UpsertContact {
3105
- /** Fields mapping (target field mapped to corresponding contact field). */
3623
+ /**
3624
+ * Fields mapping (target field mapped to corresponding contact field).
3625
+ * @maxSize 250
3626
+ */
3106
3627
  fieldsMapping?: Record<string, FormFieldContactInfo>;
3107
3628
  /**
3108
3629
  * List of contact label keys.
3109
3630
  * [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
3110
3631
  * help categorize contacts.
3632
+ * @minLength 1
3633
+ * @maxLength 100
3634
+ * @maxSize 20
3111
3635
  */
3112
3636
  labels?: string[];
3113
3637
  }
@@ -3123,7 +3647,11 @@ export interface ExtendedFields {
3123
3647
  namespaces?: Record<string, Record<string, any>>;
3124
3648
  }
3125
3649
  export interface NestedForm {
3126
- /** Targets which have this form. */
3650
+ /**
3651
+ * Targets which have this form.
3652
+ * @maxSize 10
3653
+ * @maxLength 200
3654
+ */
3127
3655
  targets?: string[];
3128
3656
  /** Nested form. */
3129
3657
  form?: Form;
@@ -3190,37 +3718,67 @@ export interface ThankYouMessageOptions {
3190
3718
  richContent?: RichContent;
3191
3719
  }
3192
3720
  export interface RedirectOptions {
3193
- /** The URL to which the user should be redirected after a successful form submission. */
3721
+ /**
3722
+ * The URL to which the user should be redirected after a successful form submission.
3723
+ * @maxLength 2000
3724
+ */
3194
3725
  redirectUrl?: string | null;
3195
3726
  /** How the URL should be opened. */
3196
3727
  target?: Target;
3197
3728
  }
3198
3729
  export interface FieldGroup {
3199
- /** Id of group, on layout */
3730
+ /**
3731
+ * Id of group, on layout
3732
+ * @format GUID
3733
+ */
3200
3734
  _id?: string;
3201
- /** Label of group */
3735
+ /**
3736
+ * Label of group
3737
+ * @maxLength 350
3738
+ */
3202
3739
  label?: string | null;
3203
3740
  }
3204
3741
  export interface PiiFieldsUpdated {
3205
- /** Collection of fields which are marked as PII */
3742
+ /**
3743
+ * Collection of fields which are marked as PII
3744
+ * @maxSize 100
3745
+ * @maxLength 200
3746
+ */
3206
3747
  piiFields?: string[];
3207
- /** Collection of fields which are non PII */
3748
+ /**
3749
+ * Collection of fields which are non PII
3750
+ * @maxSize 100
3751
+ * @maxLength 200
3752
+ */
3208
3753
  nonPiiFields?: string[];
3209
3754
  }
3210
3755
  export interface SubmissionKeysPermanentlyDeleted {
3211
- /** Keys which should be deleted */
3756
+ /**
3757
+ * Keys which should be deleted
3758
+ * @maxSize 200
3759
+ * @maxLength 200
3760
+ */
3212
3761
  keys?: string[] | null;
3213
3762
  }
3214
3763
  export interface FormTranslationChanged {
3215
3764
  /** The form with updated translations */
3216
3765
  form?: Form;
3217
- /** Language of the translation */
3766
+ /**
3767
+ * Language of the translation
3768
+ * @maxLength 20
3769
+ */
3218
3770
  language?: string;
3219
3771
  }
3220
3772
  export interface FormTranslationDeleted {
3221
- /** ID of the form with the deleted translation */
3773
+ /**
3774
+ * ID of the form with the deleted translation
3775
+ * @format GUID
3776
+ */
3222
3777
  formId?: string;
3223
- /** Language of the deleted translation */
3778
+ /**
3779
+ * Language of the deleted translation
3780
+ * @maxLength 20
3781
+ */
3224
3782
  language?: string;
3225
3783
  }
3226
3784
  export interface CreateFormRequest {
@@ -3232,19 +3790,35 @@ export interface CreateFormResponse {
3232
3790
  form?: Form;
3233
3791
  }
3234
3792
  export interface TargetBasedErrorDetails {
3235
- /** Targets which are related to the error. */
3793
+ /**
3794
+ * Targets which are related to the error.
3795
+ * @maxSize 100
3796
+ * @maxLength 200
3797
+ */
3236
3798
  targets?: string[];
3237
3799
  }
3238
3800
  export interface FieldIdBasedErrorDetails {
3239
- /** Field ids which are related to the error. */
3801
+ /**
3802
+ * Field ids which are related to the error.
3803
+ * @maxSize 100
3804
+ * @format GUID
3805
+ */
3240
3806
  ids?: string[];
3241
3807
  }
3242
3808
  export interface StepIdBasedErrorDetails {
3243
- /** Step ids which are related to the error. */
3809
+ /**
3810
+ * Step ids which are related to the error.
3811
+ * @maxSize 100
3812
+ * @format GUID
3813
+ */
3244
3814
  ids?: string[];
3245
3815
  }
3246
3816
  export interface RuleIdBasedErrorDetails {
3247
- /** Rule ids which are related to the error. */
3817
+ /**
3818
+ * Rule ids which are related to the error.
3819
+ * @maxSize 100
3820
+ * @format GUID
3821
+ */
3248
3822
  ids?: string[];
3249
3823
  }
3250
3824
  export interface NonExistingNestedFormsErrorDetails {
@@ -3256,17 +3830,33 @@ export interface NestedFormFieldsMissingErrorDetails {
3256
3830
  targetToNestedFormFieldIds?: Record<string, FieldIdBasedErrorDetails>;
3257
3831
  }
3258
3832
  export interface FormFieldV2ApiValidationErrorDetails {
3259
- /** Field ids which are related to the error. */
3833
+ /**
3834
+ * Field ids which are related to the error.
3835
+ * @maxSize 100
3836
+ * @format GUID
3837
+ */
3260
3838
  ids?: string[];
3261
- /** Violations which are related to the error. */
3839
+ /**
3840
+ * Violations which are related to the error.
3841
+ * @maxSize 100
3842
+ * @maxLength 500
3843
+ */
3262
3844
  violations?: string[];
3263
3845
  }
3264
3846
  export interface ProductIdBasedErrorDetails {
3265
- /** Product ids which are related to the error. */
3847
+ /**
3848
+ * Product ids which are related to the error.
3849
+ * @maxSize 100
3850
+ * @format GUID
3851
+ */
3266
3852
  ids?: string[];
3267
3853
  }
3268
3854
  export interface BulkCreateFormRequest {
3269
- /** Forms to be created. */
3855
+ /**
3856
+ * Forms to be created.
3857
+ * @minSize 1
3858
+ * @maxSize 30
3859
+ */
3270
3860
  forms?: Form[];
3271
3861
  /** When set, items will be returned on successful create */
3272
3862
  returnEntity?: boolean;
@@ -3284,7 +3874,10 @@ export interface BulkFormResult {
3284
3874
  item?: Form;
3285
3875
  }
3286
3876
  export interface ItemMetadata {
3287
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
3877
+ /**
3878
+ * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
3879
+ * @format GUID
3880
+ */
3288
3881
  _id?: string | null;
3289
3882
  /** Index of the item within the request array. Allows for correlation between request and response items. */
3290
3883
  originalIndex?: number;
@@ -3310,7 +3903,10 @@ export interface BulkActionMetadata {
3310
3903
  undetailedFailures?: number;
3311
3904
  }
3312
3905
  export interface CloneFormRequest {
3313
- /** Id of the form to clone. */
3906
+ /**
3907
+ * Id of the form to clone.
3908
+ * @format GUID
3909
+ */
3314
3910
  formId: string;
3315
3911
  }
3316
3912
  export interface CloneFormResponse {
@@ -3318,9 +3914,15 @@ export interface CloneFormResponse {
3318
3914
  form?: Form;
3319
3915
  }
3320
3916
  export interface CloneFormFromTemplateRequest {
3321
- /** Namespace of the vertical owning template */
3917
+ /**
3918
+ * Namespace of the vertical owning template
3919
+ * @maxLength 50
3920
+ */
3322
3921
  namespace?: string;
3323
- /** Template id which can be copied */
3922
+ /**
3923
+ * Template id which can be copied
3924
+ * @format GUID
3925
+ */
3324
3926
  templateId?: string;
3325
3927
  /**
3326
3928
  * When true, will try to create form with same id as template
@@ -3333,12 +3935,16 @@ export interface CloneFormFromTemplateResponse {
3333
3935
  form?: Form;
3334
3936
  }
3335
3937
  export interface GetFormRequest {
3336
- /** Id of the form to retrieve. */
3938
+ /**
3939
+ * Id of the form to retrieve.
3940
+ * @format GUID
3941
+ */
3337
3942
  formId: string;
3338
3943
  /**
3339
3944
  * List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
3340
3945
  * the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
3341
3946
  * only the form’s base fields are returned.
3947
+ * @maxSize 3
3342
3948
  */
3343
3949
  fieldsets?: Fieldset[];
3344
3950
  /** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
@@ -3362,13 +3968,19 @@ export interface UpdateFormResponse {
3362
3968
  form?: Form;
3363
3969
  }
3364
3970
  export interface RemoveFormFromTrashBinRequest {
3365
- /** Id of the form to delete. */
3971
+ /**
3972
+ * Id of the form to delete.
3973
+ * @format GUID
3974
+ */
3366
3975
  formId: string;
3367
3976
  }
3368
3977
  export interface RemoveFormFromTrashBinResponse {
3369
3978
  }
3370
3979
  export interface DeleteFormRequest {
3371
- /** Id of the form to delete. */
3980
+ /**
3981
+ * Id of the form to delete.
3982
+ * @format GUID
3983
+ */
3372
3984
  formId: string;
3373
3985
  /**
3374
3986
  * Delete form bypassing trash-bin.
@@ -3379,7 +3991,10 @@ export interface DeleteFormRequest {
3379
3991
  export interface DeleteFormResponse {
3380
3992
  }
3381
3993
  export interface RestoreFromTrashBinRequest {
3382
- /** Id of the form to restore. */
3994
+ /**
3995
+ * Id of the form to restore.
3996
+ * @format GUID
3997
+ */
3383
3998
  formId: string;
3384
3999
  }
3385
4000
  export interface RestoreFromTrashBinResponse {
@@ -3393,6 +4008,7 @@ export interface QueryFormsRequest {
3393
4008
  * List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
3394
4009
  * the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
3395
4010
  * only the form’s base fields are returned.
4011
+ * @maxSize 3
3396
4012
  */
3397
4013
  fieldsets?: Fieldset[];
3398
4014
  /** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
@@ -3413,6 +4029,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
3413
4029
  /**
3414
4030
  * Sort object in the following format:
3415
4031
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
4032
+ * @maxSize 3
3416
4033
  */
3417
4034
  sort?: Sorting[];
3418
4035
  }
@@ -3422,7 +4039,10 @@ export interface CursorQueryPagingMethodOneOf {
3422
4039
  cursorPaging?: CursorPaging;
3423
4040
  }
3424
4041
  export interface Sorting {
3425
- /** Name of the field to sort by. */
4042
+ /**
4043
+ * Name of the field to sort by.
4044
+ * @maxLength 512
4045
+ */
3426
4046
  fieldName?: string;
3427
4047
  /** Sort order. */
3428
4048
  order?: SortOrder;
@@ -3432,7 +4052,10 @@ export declare enum SortOrder {
3432
4052
  DESC = "DESC"
3433
4053
  }
3434
4054
  export interface CursorPaging {
3435
- /** Number of items to load. */
4055
+ /**
4056
+ * Number of items to load.
4057
+ * @max 100
4058
+ */
3436
4059
  limit?: number | null;
3437
4060
  /**
3438
4061
  * Pointer to the next or previous page in the list of results.
@@ -3440,11 +4063,15 @@ export interface CursorPaging {
3440
4063
  * You can get the relevant cursor token
3441
4064
  * from the `pagingMetadata` object in the previous call's response.
3442
4065
  * Not relevant for the first request.
4066
+ * @maxLength 16000
3443
4067
  */
3444
4068
  cursor?: string | null;
3445
4069
  }
3446
4070
  export interface QueryFormsResponse {
3447
- /** The retrieved forms */
4071
+ /**
4072
+ * The retrieved forms
4073
+ * @maxSize 100
4074
+ */
3448
4075
  forms?: Form[];
3449
4076
  /** Details on the paged set of results returned. */
3450
4077
  metadata?: CursorPagingMetadata;
@@ -3462,15 +4089,28 @@ export interface CursorPagingMetadata {
3462
4089
  hasNext?: boolean | null;
3463
4090
  }
3464
4091
  export interface Cursors {
3465
- /** Cursor pointing to next page in the list of results. */
4092
+ /**
4093
+ * Cursor pointing to next page in the list of results.
4094
+ * @maxLength 16000
4095
+ */
3466
4096
  next?: string | null;
3467
- /** Cursor pointing to previous page in the list of results. */
4097
+ /**
4098
+ * Cursor pointing to previous page in the list of results.
4099
+ * @maxLength 16000
4100
+ */
3468
4101
  prev?: string | null;
3469
4102
  }
3470
4103
  export interface CountFormsRequest {
3471
- /** Namespace name. */
4104
+ /**
4105
+ * Namespace name.
4106
+ * @minLength 10
4107
+ * @maxLength 50
4108
+ */
3472
4109
  namespace: string;
3473
- /** Fieldsets. */
4110
+ /**
4111
+ * Fieldsets.
4112
+ * @maxSize 3
4113
+ */
3474
4114
  fieldsets?: CountFormsFieldset[];
3475
4115
  }
3476
4116
  export declare enum CountFormsFieldset {
@@ -3489,7 +4129,11 @@ export interface CountFormsResponse {
3489
4129
  deletedCount?: number | null;
3490
4130
  }
3491
4131
  export interface ListTemplateExtensionsRequest {
3492
- /** Namespace name. */
4132
+ /**
4133
+ * Namespace name.
4134
+ * @minLength 10
4135
+ * @maxLength 50
4136
+ */
3493
4137
  namespace?: string;
3494
4138
  /** Identifies if the form is disabled. */
3495
4139
  disabled?: boolean | null;
@@ -3512,15 +4156,25 @@ export interface ListTemplateExtensionsRequest {
3512
4156
  * List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
3513
4157
  * the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
3514
4158
  * only the form’s base fields are returned.
4159
+ * @maxSize 3
3515
4160
  */
3516
4161
  fieldsets?: Fieldset[];
3517
- /** Form ids. */
4162
+ /**
4163
+ * Form ids.
4164
+ * @maxSize 10
4165
+ * @format GUID
4166
+ */
3518
4167
  formIds?: string[];
3519
4168
  /** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
3520
4169
  additionalMetadata?: Record<string, any> | null;
3521
4170
  /** Filter by name */
3522
4171
  nameFilter?: NameFilter;
3523
- /** List of templates id, which extensions expected */
4172
+ /**
4173
+ * List of templates id, which extensions expected
4174
+ * @minSize 1
4175
+ * @maxSize 100
4176
+ * @format GUID
4177
+ */
3524
4178
  templateIds?: string[];
3525
4179
  }
3526
4180
  export declare enum ListFormsOrder {
@@ -3540,7 +4194,10 @@ export declare enum ListFormsOrder {
3540
4194
  export interface NameFilter {
3541
4195
  /** Type of filter */
3542
4196
  filterType?: FilterType;
3543
- /** Expected name */
4197
+ /**
4198
+ * Expected name
4199
+ * @maxLength 200
4200
+ */
3544
4201
  name?: string;
3545
4202
  }
3546
4203
  export declare enum FilterType {
@@ -3548,13 +4205,20 @@ export declare enum FilterType {
3548
4205
  STARTS_WITH = "STARTS_WITH"
3549
4206
  }
3550
4207
  export interface ListTemplateExtensionsResponse {
3551
- /** The retrieved forms. */
4208
+ /**
4209
+ * The retrieved forms.
4210
+ * @maxSize 100
4211
+ */
3552
4212
  forms?: Form[];
3553
4213
  /** Details on the paged set of results returned. */
3554
4214
  pagingMetadata?: CursorPagingMetadata;
3555
4215
  }
3556
4216
  export interface ListFormsRequest {
3557
- /** Namespace name. */
4217
+ /**
4218
+ * Namespace name.
4219
+ * @minLength 10
4220
+ * @maxLength 50
4221
+ */
3558
4222
  namespace: string;
3559
4223
  /**
3560
4224
  * Identifies if the form is disabled.
@@ -3582,9 +4246,14 @@ export interface ListFormsRequest {
3582
4246
  * List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
3583
4247
  * the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
3584
4248
  * only the form’s base fields are returned.
4249
+ * @maxSize 3
3585
4250
  */
3586
4251
  fieldsets?: Fieldset[];
3587
- /** Form ids. */
4252
+ /**
4253
+ * Form ids.
4254
+ * @maxSize 10
4255
+ * @format GUID
4256
+ */
3588
4257
  formIds?: string[];
3589
4258
  /** Identifies if the form is a payment form */
3590
4259
  paymentForm?: boolean | null;
@@ -3613,13 +4282,19 @@ export declare enum ListFormsRequestListFormsOrder {
3613
4282
  NAME_DESC = "NAME_DESC"
3614
4283
  }
3615
4284
  export interface ListFormsResponse {
3616
- /** The retrieved forms. */
4285
+ /**
4286
+ * The retrieved forms.
4287
+ * @maxSize 100
4288
+ */
3617
4289
  forms?: Form[];
3618
4290
  /** Details on the paged set of results returned. */
3619
4291
  pagingMetadata?: CursorPagingMetadata;
3620
4292
  }
3621
4293
  export interface GetDeletedFormRequest {
3622
- /** Id of the Form to retrieve */
4294
+ /**
4295
+ * Id of the Form to retrieve
4296
+ * @format GUID
4297
+ */
3623
4298
  formId: string;
3624
4299
  }
3625
4300
  export interface GetDeletedFormResponse {
@@ -3631,17 +4306,28 @@ export interface QueryDeletedFormsRequest {
3631
4306
  query: CursorQuery;
3632
4307
  }
3633
4308
  export interface QueryDeletedFormsResponse {
3634
- /** The retrieved Forms */
4309
+ /**
4310
+ * The retrieved Forms
4311
+ * @maxSize 100
4312
+ */
3635
4313
  forms?: Form[];
3636
4314
  /** Details on the paged set of results returned. */
3637
4315
  metadata?: CursorPagingMetadata;
3638
4316
  }
3639
4317
  export interface ListDeletedFormsRequest {
3640
- /** Namespace name. */
4318
+ /**
4319
+ * Namespace name.
4320
+ * @minLength 10
4321
+ * @maxLength 50
4322
+ */
3641
4323
  namespace: string;
3642
4324
  /** Identifies if the form is disabled. */
3643
4325
  disabled?: boolean | null;
3644
- /** Form ids. */
4326
+ /**
4327
+ * Form ids.
4328
+ * @maxSize 100
4329
+ * @format GUID
4330
+ */
3645
4331
  formIds?: string[];
3646
4332
  /**
3647
4333
  * Ordering options.
@@ -3670,15 +4356,25 @@ export declare enum ListDeletedFormsOrder {
3670
4356
  NAME_ASC = "NAME_ASC"
3671
4357
  }
3672
4358
  export interface ListDeletedFormsResponse {
3673
- /** The retrieved forms. */
4359
+ /**
4360
+ * The retrieved forms.
4361
+ * @maxSize 100
4362
+ */
3674
4363
  forms?: Form[];
3675
4364
  /** Details on the paged set of results returned. */
3676
4365
  pagingMetadata?: CursorPagingMetadata;
3677
4366
  }
3678
4367
  export interface BulkRemoveDeletedFieldRequest {
3679
- /** Id of the form to delete. */
4368
+ /**
4369
+ * Id of the form to delete.
4370
+ * @format GUID
4371
+ */
3680
4372
  formId: string;
3681
- /** Ids of the deleted fields to remove. */
4373
+ /**
4374
+ * Ids of the deleted fields to remove.
4375
+ * @maxSize 100
4376
+ * @format GUID
4377
+ */
3682
4378
  fieldsIds?: string[];
3683
4379
  }
3684
4380
  export interface BulkRemoveDeletedFieldResponse {
@@ -3694,7 +4390,11 @@ export interface UpdateExtendedFieldsRequest {
3694
4390
  namespaceData: Record<string, any> | null;
3695
4391
  }
3696
4392
  export interface UpdateExtendedFieldsResponse {
3697
- /** namespace that was updated */
4393
+ /**
4394
+ * namespace that was updated
4395
+ * @minLength 10
4396
+ * @maxLength 50
4397
+ */
3698
4398
  namespace?: string;
3699
4399
  /** only data from UpdateExtendedFieldsRequest namespace_data */
3700
4400
  namespaceData?: Record<string, any> | null;
@@ -3702,23 +4402,42 @@ export interface UpdateExtendedFieldsResponse {
3702
4402
  export interface ListFormsProvidersConfigsRequest {
3703
4403
  }
3704
4404
  export interface ListFormsProvidersConfigsResponse {
3705
- /** List of configs set by form providers */
4405
+ /**
4406
+ * List of configs set by form providers
4407
+ * @maxSize 50
4408
+ */
3706
4409
  configs?: FormsSchemaProvidersConfig[];
3707
4410
  }
3708
4411
  export interface FormsSchemaProvidersConfig {
3709
- /** Namespace which can be used to create form */
4412
+ /**
4413
+ * Namespace which can be used to create form
4414
+ * @maxLength 50
4415
+ */
3710
4416
  namespace?: string;
3711
- /** Id of app which provides this config. */
4417
+ /**
4418
+ * Id of app which provides this config.
4419
+ * @maxLength 36
4420
+ */
3712
4421
  appId?: string;
3713
4422
  /** Restrictions associated with this namespace. */
3714
4423
  restrictions?: FormProviderRestrictions;
3715
4424
  }
3716
4425
  export interface FormProviderRestrictions {
3717
- /** Maximum amount of forms allowed per namespace. */
4426
+ /**
4427
+ * Maximum amount of forms allowed per namespace.
4428
+ * @max 15000
4429
+ */
3718
4430
  maxFormsAmount?: number;
3719
- /** Maximum amount of fields allowed per form. */
4431
+ /**
4432
+ * Maximum amount of fields allowed per form.
4433
+ * @max 200
4434
+ */
3720
4435
  maxFieldsAmount?: number;
3721
- /** Maximum amount of deleted forms allowed per namespace. */
4436
+ /**
4437
+ * Maximum amount of deleted forms allowed per namespace.
4438
+ * @min 1000
4439
+ * @max 1000
4440
+ */
3722
4441
  maxDeletedFormsAmount?: number | null;
3723
4442
  }
3724
4443
  export interface DomainEvent extends DomainEventBodyOneOf {
@@ -3794,7 +4513,10 @@ export interface ActionEvent {
3794
4513
  export interface Empty {
3795
4514
  }
3796
4515
  export interface GetFormSummaryRequest {
3797
- /** Id of the form to retrieve. */
4516
+ /**
4517
+ * Id of the form to retrieve.
4518
+ * @format GUID
4519
+ */
3798
4520
  formId: string;
3799
4521
  }
3800
4522
  export interface GetFormSummaryResponse {
@@ -3802,9 +4524,15 @@ export interface GetFormSummaryResponse {
3802
4524
  formSummary?: FormSummary;
3803
4525
  }
3804
4526
  export interface FormSummary {
3805
- /** Form ID. */
4527
+ /**
4528
+ * Form ID.
4529
+ * @format GUID
4530
+ */
3806
4531
  _id?: string;
3807
- /** Summarized form fields. */
4532
+ /**
4533
+ * Summarized form fields.
4534
+ * @maxSize 500
4535
+ */
3808
4536
  fields?: Field[];
3809
4537
  }
3810
4538
  export declare enum FieldInputType {
@@ -3834,32 +4562,57 @@ export declare enum FieldInputType {
3834
4562
  DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
3835
4563
  }
3836
4564
  export interface FieldOption {
3837
- /** Selectable option label */
4565
+ /**
4566
+ * Selectable option label
4567
+ * @maxLength 400
4568
+ */
3838
4569
  label?: string | null;
3839
- /** Selectable option value, which is saved to DB. */
4570
+ /**
4571
+ * Selectable option value, which is saved to DB.
4572
+ * @maxLength 400
4573
+ */
3840
4574
  value?: string | null;
3841
4575
  }
3842
4576
  export interface Field {
3843
- /** Definition of a target where the value of field belongs. */
4577
+ /**
4578
+ * Definition of a target where the value of field belongs.
4579
+ * @maxLength 200
4580
+ * @immutable
4581
+ */
3844
4582
  target?: string | null;
3845
- /** Label of the field */
4583
+ /**
4584
+ * Label of the field
4585
+ * @maxLength 350
4586
+ */
3846
4587
  label?: string | null;
3847
4588
  /** Input type of the field */
3848
4589
  type?: FieldInputType;
3849
- /** List of options to select from */
4590
+ /**
4591
+ * List of options to select from
4592
+ * @maxSize 400
4593
+ */
3850
4594
  options?: FieldOption[];
3851
4595
  /**
3852
4596
  * Flag indicating whether field is deleted.
3853
4597
  * Default: false.
3854
4598
  */
3855
4599
  deleted?: boolean;
3856
- /** Id of the field. */
4600
+ /**
4601
+ * Id of the field.
4602
+ * @format GUID
4603
+ */
3857
4604
  _id?: string;
3858
4605
  }
3859
4606
  export interface MessageEnvelope {
3860
- /** App instance ID. */
4607
+ /**
4608
+ * App instance ID.
4609
+ * @format GUID
4610
+ */
3861
4611
  instanceId?: string | null;
3862
- /** Event type. */
4612
+ /**
4613
+ * Event type.
4614
+ * @maxLength 150
4615
+ */
3863
4616
  eventType?: string;
3864
4617
  /** The identification type and identity data. */
3865
4618
  identity?: IdentificationData;
@@ -3867,26 +4620,50 @@ export interface MessageEnvelope {
3867
4620
  data?: string;
3868
4621
  }
3869
4622
  export interface IdentificationData extends IdentificationDataIdOneOf {
3870
- /** ID of a site visitor that has not logged in to the site. */
4623
+ /**
4624
+ * ID of a site visitor that has not logged in to the site.
4625
+ * @format GUID
4626
+ */
3871
4627
  anonymousVisitorId?: string;
3872
- /** ID of a site visitor that has logged in to the site. */
4628
+ /**
4629
+ * ID of a site visitor that has logged in to the site.
4630
+ * @format GUID
4631
+ */
3873
4632
  memberId?: string;
3874
- /** ID of a Wix user (site owner, contributor, etc.). */
4633
+ /**
4634
+ * ID of a Wix user (site owner, contributor, etc.).
4635
+ * @format GUID
4636
+ */
3875
4637
  wixUserId?: string;
3876
- /** ID of an app. */
4638
+ /**
4639
+ * ID of an app.
4640
+ * @format GUID
4641
+ */
3877
4642
  appId?: string;
3878
4643
  /** @readonly */
3879
4644
  identityType?: WebhookIdentityType;
3880
4645
  }
3881
4646
  /** @oneof */
3882
4647
  export interface IdentificationDataIdOneOf {
3883
- /** ID of a site visitor that has not logged in to the site. */
4648
+ /**
4649
+ * ID of a site visitor that has not logged in to the site.
4650
+ * @format GUID
4651
+ */
3884
4652
  anonymousVisitorId?: string;
3885
- /** ID of a site visitor that has logged in to the site. */
4653
+ /**
4654
+ * ID of a site visitor that has logged in to the site.
4655
+ * @format GUID
4656
+ */
3886
4657
  memberId?: string;
3887
- /** ID of a Wix user (site owner, contributor, etc.). */
4658
+ /**
4659
+ * ID of a Wix user (site owner, contributor, etc.).
4660
+ * @format GUID
4661
+ */
3888
4662
  wixUserId?: string;
3889
- /** ID of an app. */
4663
+ /**
4664
+ * ID of an app.
4665
+ * @format GUID
4666
+ */
3890
4667
  appId?: string;
3891
4668
  }
3892
4669
  export declare enum WebhookIdentityType {
@@ -4658,7 +5435,11 @@ export declare function createForm(form: Form): Promise<Form & FormNonNullableFi
4658
5435
  */
4659
5436
  export declare function bulkCreateForm(options?: BulkCreateFormOptions): Promise<BulkCreateFormResponse & BulkCreateFormResponseNonNullableFields>;
4660
5437
  export interface BulkCreateFormOptions {
4661
- /** Forms to be created. */
5438
+ /**
5439
+ * Forms to be created.
5440
+ * @minSize 1
5441
+ * @maxSize 30
5442
+ */
4662
5443
  forms?: Form[];
4663
5444
  /** When set, items will be returned on successful create */
4664
5445
  returnEntity?: boolean;
@@ -4682,6 +5463,8 @@ export declare function cloneForm(formId: string): Promise<CloneFormResponse & C
4682
5463
  * @permissionId WIX_FORMS.FORM_SCHEMA_READ
4683
5464
  * @permissionScope Manage Submissions
4684
5465
  * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
5466
+ * @permissionScope Set Up Automations
5467
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
4685
5468
  * @applicableIdentity APP
4686
5469
  * @applicableIdentity VISITOR
4687
5470
  * @returns The retrieved form.
@@ -4693,6 +5476,7 @@ export interface GetFormOptions {
4693
5476
  * List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
4694
5477
  * the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
4695
5478
  * only the form’s base fields are returned.
5479
+ * @maxSize 3
4696
5480
  */
4697
5481
  fieldsets?: Fieldset[];
4698
5482
  /** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
@@ -4717,17 +5501,24 @@ export declare function updateForm(_id: string | null, form: UpdateForm): Promis
4717
5501
  export interface UpdateForm {
4718
5502
  /**
4719
5503
  * Form ID.
5504
+ * @format GUID
4720
5505
  * @readonly
4721
5506
  */
4722
5507
  _id?: string | null;
4723
5508
  /**
4724
5509
  * List of form fields that represent input elements.
4725
- * @readonly
5510
+ * @maxSize 500
4726
5511
  */
4727
5512
  fieldsV2?: FormFieldV2[];
4728
- /** Defines the layout for form fields in each submission step. */
5513
+ /**
5514
+ * Defines the layout for form fields in each submission step.
5515
+ * @maxSize 100
5516
+ */
4729
5517
  steps?: Step[];
4730
- /** Form rules, can be applied to layout and items properties. */
5518
+ /**
5519
+ * Form rules, can be applied to layout and items properties.
5520
+ * @maxSize 100
5521
+ */
4731
5522
  rules?: FormRule[];
4732
5523
  /**
4733
5524
  * Represents the current state of an item. Each time the item is modified, its `revision` changes. For an update operation to succeed, you MUST pass the latest revision.
@@ -4748,20 +5539,28 @@ export interface UpdateForm {
4748
5539
  properties?: FormProperties;
4749
5540
  /**
4750
5541
  * Fields which were soft deleted.
5542
+ * @maxSize 150
4751
5543
  * @readonly
4752
5544
  */
4753
5545
  deletedFields?: FormField[];
4754
5546
  /**
4755
5547
  * List of form fields that represent input elements.
5548
+ * @maxSize 150
4756
5549
  * @readonly
4757
5550
  */
4758
5551
  deletedFieldsV2?: FormFieldV2[];
4759
5552
  /** Data extensions ExtendedFields. */
4760
5553
  extendedFields?: ExtendedFields;
4761
- /** Identifies the namespace that the form belongs to. */
5554
+ /**
5555
+ * Identifies the namespace that the form belongs to.
5556
+ * @minLength 10
5557
+ * @maxLength 50
5558
+ * @immutable
5559
+ */
4762
5560
  namespace?: string;
4763
5561
  /**
4764
5562
  * Media folder ID.
5563
+ * @maxLength 100
4765
5564
  * @readonly
4766
5565
  */
4767
5566
  mediaFolderId?: string | null;
@@ -4776,15 +5575,23 @@ export interface UpdateForm {
4776
5575
  requiredIndicatorProperties?: RequiredIndicatorProperties;
4777
5576
  /** Settings for actions to be taken after form submission. */
4778
5577
  submitSettings?: SubmitSettings;
4779
- /** Settings for field groups */
5578
+ /**
5579
+ * Settings for field groups
5580
+ * @maxSize 50
5581
+ */
4780
5582
  fieldGroups?: FieldGroup[];
4781
5583
  /** Message shown when the form is disabled */
4782
5584
  disabledFormMessage?: RichContent;
4783
5585
  /**
4784
- * Identifies if the form is disabled.
5586
+ * Identifies if the form is enabled.
4785
5587
  * Default true
4786
5588
  */
4787
5589
  enabled?: boolean | null;
5590
+ /**
5591
+ * Form name.
5592
+ * @maxLength 200
5593
+ */
5594
+ name?: string | null;
4788
5595
  }
4789
5596
  /**
4790
5597
  * Deletes a form. It is stored in trash for 90 days.
@@ -4831,6 +5638,8 @@ export declare function restoreFromTrashBin(formId: string): Promise<RestoreFrom
4831
5638
  * @documentationMaturity preview
4832
5639
  * @permissionScope Manage Submissions
4833
5640
  * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
5641
+ * @permissionScope Set Up Automations
5642
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
4834
5643
  * @permissionId WIX_FORMS.FORM_SCHEMA_READ
4835
5644
  * @applicableIdentity APP
4836
5645
  * @applicableIdentity VISITOR
@@ -4842,6 +5651,7 @@ export interface QueryFormsOptions {
4842
5651
  * List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
4843
5652
  * the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
4844
5653
  * only the form’s base fields are returned.
5654
+ * @maxSize 3
4845
5655
  */
4846
5656
  fieldsets?: Fieldset[] | undefined;
4847
5657
  /** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
@@ -4926,13 +5736,18 @@ export interface FormsQueryBuilder {
4926
5736
  * @permissionId WIX_FORMS.FORM_SCHEMA_READ
4927
5737
  * @permissionScope Manage Submissions
4928
5738
  * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
5739
+ * @permissionScope Set Up Automations
5740
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
4929
5741
  * @applicableIdentity APP
4930
5742
  * @applicableIdentity VISITOR
4931
5743
  * @fqn wix.forms.v4.FormSchemaService.CountForms
4932
5744
  */
4933
5745
  export declare function countForms(namespace: string, options?: CountFormsOptions): Promise<CountFormsResponse & CountFormsResponseNonNullableFields>;
4934
5746
  export interface CountFormsOptions {
4935
- /** Fieldsets. */
5747
+ /**
5748
+ * Fieldsets.
5749
+ * @maxSize 3
5750
+ */
4936
5751
  fieldsets?: CountFormsFieldset[];
4937
5752
  }
4938
5753
  /**
@@ -4945,6 +5760,8 @@ export interface CountFormsOptions {
4945
5760
  * @permissionId WIX_FORMS.FORM_SCHEMA_READ
4946
5761
  * @permissionScope Manage Submissions
4947
5762
  * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
5763
+ * @permissionScope Set Up Automations
5764
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
4948
5765
  * @applicableIdentity APP
4949
5766
  * @applicableIdentity VISITOR
4950
5767
  * @fqn wix.forms.v4.FormSchemaService.ListForms
@@ -4977,9 +5794,14 @@ export interface ListFormsOptions {
4977
5794
  * List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
4978
5795
  * the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
4979
5796
  * only the form’s base fields are returned.
5797
+ * @maxSize 3
4980
5798
  */
4981
5799
  fieldsets?: Fieldset[];
4982
- /** Form ids. */
5800
+ /**
5801
+ * Form ids.
5802
+ * @maxSize 10
5803
+ * @format GUID
5804
+ */
4983
5805
  formIds?: string[];
4984
5806
  /** Identifies if the form is a payment form */
4985
5807
  paymentForm?: boolean | null;
@@ -5002,6 +5824,8 @@ export interface ListFormsOptions {
5002
5824
  * @permissionId WIX_FORMS.FORM_SCHEMA_READ
5003
5825
  * @permissionScope Manage Submissions
5004
5826
  * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
5827
+ * @permissionScope Set Up Automations
5828
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
5005
5829
  * @applicableIdentity APP
5006
5830
  * @applicableIdentity VISITOR
5007
5831
  * @fqn wix.forms.v4.FormSchemaService.GetDeletedForm
@@ -5016,6 +5840,8 @@ export declare function getDeletedForm(formId: string): Promise<GetDeletedFormRe
5016
5840
  * @permissionId WIX_FORMS.FORM_SCHEMA_READ
5017
5841
  * @permissionScope Manage Submissions
5018
5842
  * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
5843
+ * @permissionScope Set Up Automations
5844
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
5019
5845
  * @applicableIdentity APP
5020
5846
  * @applicableIdentity VISITOR
5021
5847
  * @fqn wix.forms.v4.FormSchemaService.QueryDeletedForms
@@ -5030,6 +5856,8 @@ export declare function queryDeletedForms(query: CursorQuery): Promise<QueryDele
5030
5856
  * @permissionId WIX_FORMS.FORM_SCHEMA_READ
5031
5857
  * @permissionScope Manage Submissions
5032
5858
  * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
5859
+ * @permissionScope Set Up Automations
5860
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
5033
5861
  * @applicableIdentity APP
5034
5862
  * @applicableIdentity VISITOR
5035
5863
  * @fqn wix.forms.v4.FormSchemaService.ListDeletedForms
@@ -5038,7 +5866,11 @@ export declare function listDeletedForms(namespace: string, options?: ListDelete
5038
5866
  export interface ListDeletedFormsOptions {
5039
5867
  /** Identifies if the form is disabled. */
5040
5868
  disabled?: boolean | null;
5041
- /** Form ids. */
5869
+ /**
5870
+ * Form ids.
5871
+ * @maxSize 100
5872
+ * @format GUID
5873
+ */
5042
5874
  formIds?: string[];
5043
5875
  /**
5044
5876
  * Ordering options.
@@ -5067,7 +5899,11 @@ export interface ListDeletedFormsOptions {
5067
5899
  */
5068
5900
  export declare function bulkRemoveDeletedField(formId: string, options?: BulkRemoveDeletedFieldOptions): Promise<BulkRemoveDeletedFieldResponse & BulkRemoveDeletedFieldResponseNonNullableFields>;
5069
5901
  export interface BulkRemoveDeletedFieldOptions {
5070
- /** Ids of the deleted fields to remove. */
5902
+ /**
5903
+ * Ids of the deleted fields to remove.
5904
+ * @maxSize 100
5905
+ * @format GUID
5906
+ */
5071
5907
  fieldsIds?: string[];
5072
5908
  }
5073
5909
  /**
@@ -5105,6 +5941,8 @@ export declare function listFormsProvidersConfigs(): Promise<ListFormsProvidersC
5105
5941
  * @permissionId WIX_FORMS.FORM_SCHEMA_READ
5106
5942
  * @permissionScope Manage Submissions
5107
5943
  * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
5944
+ * @permissionScope Set Up Automations
5945
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
5108
5946
  * @applicableIdentity APP
5109
5947
  * @applicableIdentity VISITOR
5110
5948
  * @fqn wix.forms.v4.FormSchemaService.GetFormSummary