@wix/auto_sdk_forms_submissions 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.
Files changed (73) hide show
  1. package/build/cjs/src/forms-v4-submission-submissions.context.d.ts +4 -4
  2. package/build/cjs/src/forms-v4-submission-submissions.context.js +4 -4
  3. package/build/cjs/src/forms-v4-submission-submissions.context.js.map +1 -1
  4. package/build/cjs/src/forms-v4-submission-submissions.http.d.ts +3 -3
  5. package/build/cjs/src/forms-v4-submission-submissions.http.js +55 -55
  6. package/build/cjs/src/forms-v4-submission-submissions.http.js.map +1 -1
  7. package/build/cjs/src/forms-v4-submission-submissions.meta.d.ts +1 -1
  8. package/build/cjs/src/forms-v4-submission-submissions.meta.js +20 -20
  9. package/build/cjs/src/forms-v4-submission-submissions.meta.js.map +1 -1
  10. package/build/cjs/src/forms-v4-submission-submissions.public.d.ts +9 -9
  11. package/build/cjs/src/forms-v4-submission-submissions.public.js +7 -7
  12. package/build/cjs/src/forms-v4-submission-submissions.public.js.map +1 -1
  13. package/build/cjs/src/forms-v4-submission-submissions.types.d.ts +1199 -306
  14. package/build/cjs/src/forms-v4-submission-submissions.types.js +11 -11
  15. package/build/cjs/src/forms-v4-submission-submissions.types.js.map +1 -1
  16. package/build/cjs/src/forms-v4-submission-submissions.universal.d.ts +1268 -333
  17. package/build/cjs/src/forms-v4-submission-submissions.universal.js +51 -51
  18. package/build/cjs/src/forms-v4-submission-submissions.universal.js.map +1 -1
  19. package/build/es/src/forms-v4-submission-submissions.context.d.ts +4 -4
  20. package/build/es/src/forms-v4-submission-submissions.context.js +3 -3
  21. package/build/es/src/forms-v4-submission-submissions.context.js.map +1 -1
  22. package/build/es/src/forms-v4-submission-submissions.http.d.ts +3 -3
  23. package/build/es/src/forms-v4-submission-submissions.http.js +53 -53
  24. package/build/es/src/forms-v4-submission-submissions.http.js.map +1 -1
  25. package/build/es/src/forms-v4-submission-submissions.meta.d.ts +1 -1
  26. package/build/es/src/forms-v4-submission-submissions.meta.js +18 -18
  27. package/build/es/src/forms-v4-submission-submissions.meta.js.map +1 -1
  28. package/build/es/src/forms-v4-submission-submissions.public.d.ts +9 -9
  29. package/build/es/src/forms-v4-submission-submissions.public.js +5 -5
  30. package/build/es/src/forms-v4-submission-submissions.public.js.map +1 -1
  31. package/build/es/src/forms-v4-submission-submissions.types.d.ts +1199 -306
  32. package/build/es/src/forms-v4-submission-submissions.types.js +10 -10
  33. package/build/es/src/forms-v4-submission-submissions.types.js.map +1 -1
  34. package/build/es/src/forms-v4-submission-submissions.universal.d.ts +1268 -333
  35. package/build/es/src/forms-v4-submission-submissions.universal.js +49 -49
  36. package/build/es/src/forms-v4-submission-submissions.universal.js.map +1 -1
  37. package/build/internal/cjs/src/forms-v4-submission-submissions.context.d.ts +4 -4
  38. package/build/internal/cjs/src/forms-v4-submission-submissions.context.js +4 -4
  39. package/build/internal/cjs/src/forms-v4-submission-submissions.context.js.map +1 -1
  40. package/build/internal/cjs/src/forms-v4-submission-submissions.http.d.ts +3 -3
  41. package/build/internal/cjs/src/forms-v4-submission-submissions.http.js +55 -55
  42. package/build/internal/cjs/src/forms-v4-submission-submissions.http.js.map +1 -1
  43. package/build/internal/cjs/src/forms-v4-submission-submissions.meta.d.ts +1 -1
  44. package/build/internal/cjs/src/forms-v4-submission-submissions.meta.js +20 -20
  45. package/build/internal/cjs/src/forms-v4-submission-submissions.meta.js.map +1 -1
  46. package/build/internal/cjs/src/forms-v4-submission-submissions.public.d.ts +9 -9
  47. package/build/internal/cjs/src/forms-v4-submission-submissions.public.js +7 -7
  48. package/build/internal/cjs/src/forms-v4-submission-submissions.public.js.map +1 -1
  49. package/build/internal/cjs/src/forms-v4-submission-submissions.types.d.ts +1199 -306
  50. package/build/internal/cjs/src/forms-v4-submission-submissions.types.js +11 -11
  51. package/build/internal/cjs/src/forms-v4-submission-submissions.types.js.map +1 -1
  52. package/build/internal/cjs/src/forms-v4-submission-submissions.universal.d.ts +1268 -333
  53. package/build/internal/cjs/src/forms-v4-submission-submissions.universal.js +51 -51
  54. package/build/internal/cjs/src/forms-v4-submission-submissions.universal.js.map +1 -1
  55. package/build/internal/es/src/forms-v4-submission-submissions.context.d.ts +4 -4
  56. package/build/internal/es/src/forms-v4-submission-submissions.context.js +3 -3
  57. package/build/internal/es/src/forms-v4-submission-submissions.context.js.map +1 -1
  58. package/build/internal/es/src/forms-v4-submission-submissions.http.d.ts +3 -3
  59. package/build/internal/es/src/forms-v4-submission-submissions.http.js +53 -53
  60. package/build/internal/es/src/forms-v4-submission-submissions.http.js.map +1 -1
  61. package/build/internal/es/src/forms-v4-submission-submissions.meta.d.ts +1 -1
  62. package/build/internal/es/src/forms-v4-submission-submissions.meta.js +18 -18
  63. package/build/internal/es/src/forms-v4-submission-submissions.meta.js.map +1 -1
  64. package/build/internal/es/src/forms-v4-submission-submissions.public.d.ts +9 -9
  65. package/build/internal/es/src/forms-v4-submission-submissions.public.js +5 -5
  66. package/build/internal/es/src/forms-v4-submission-submissions.public.js.map +1 -1
  67. package/build/internal/es/src/forms-v4-submission-submissions.types.d.ts +1199 -306
  68. package/build/internal/es/src/forms-v4-submission-submissions.types.js +10 -10
  69. package/build/internal/es/src/forms-v4-submission-submissions.types.js.map +1 -1
  70. package/build/internal/es/src/forms-v4-submission-submissions.universal.d.ts +1268 -333
  71. package/build/internal/es/src/forms-v4-submission-submissions.universal.js +49 -49
  72. package/build/internal/es/src/forms-v4-submission-submissions.universal.js.map +1 -1
  73. package/package.json +2 -2
@@ -2,13 +2,20 @@
2
2
  export interface FormSubmission {
3
3
  /**
4
4
  * Submission ID.
5
+ * @format GUID
5
6
  * @readonly
6
7
  */
7
8
  id?: string | null;
8
- /** ID of the form which the submission belongs to. */
9
+ /**
10
+ * ID of the form which the submission belongs to.
11
+ * @format GUID
12
+ * @immutable
13
+ */
9
14
  formId?: string;
10
15
  /**
11
16
  * The app which the form submissions belong to. For example, the namespace for the Wix Forms app is `wix.form_app.form`. Call `Get Submission` to retrieve the namespace.
17
+ * @minLength 10
18
+ * @maxLength 50
12
19
  * @readonly
13
20
  */
14
21
  namespace?: string;
@@ -16,7 +23,10 @@ export interface FormSubmission {
16
23
  status?: SubmissionStatus;
17
24
  /** Submission values where `key` is the form field and `value` is the data submitted for the given field. */
18
25
  submissions?: Record<string, any>;
19
- /** Date and time the form submission was created. */
26
+ /**
27
+ * Date and time the form submission was created.
28
+ * @immutable
29
+ */
20
30
  createdDate?: Date | null;
21
31
  /**
22
32
  * Date and time the form submission was updated.
@@ -39,14 +49,22 @@ export interface FormSubmission {
39
49
  extendedFields?: ExtendedFields;
40
50
  /**
41
51
  * Order details. <br>
42
- * <b>Note</b>: This object is only applicable when submittng a form in the Wix Payments app.
52
+ * <b>Note</b>: This object is only applicable when submitting a form in the Wix Payments app.
43
53
  */
44
54
  orderDetails?: OrderDetails;
45
- /** Contact ID of a site visitor who created the submission. */
55
+ /**
56
+ * Contact ID of a site visitor who created the submission.
57
+ * @format GUID
58
+ * @immutable
59
+ */
46
60
  contactId?: string | null;
47
- /** authorized viewer user id */
61
+ /**
62
+ * Authorized viewer ID.
63
+ * @format GUID
64
+ * @immutable
65
+ */
48
66
  accessRestriction?: string | null;
49
- /** Tag ids collections associated with current entity. */
67
+ /** Tag IDs collections associated with the current entity. */
50
68
  tags?: PublicTags;
51
69
  }
52
70
  export declare enum SubmissionStatus {
@@ -61,24 +79,48 @@ export declare enum SubmissionStatus {
61
79
  PAYMENT_CANCELED = "PAYMENT_CANCELED"
62
80
  }
63
81
  export interface Submitter extends SubmitterSubmitterOneOf {
64
- /** Member ID. */
82
+ /**
83
+ * Member ID.
84
+ * @format GUID
85
+ */
65
86
  memberId?: string | null;
66
- /** Visitor ID. */
87
+ /**
88
+ * Visitor ID.
89
+ * @format GUID
90
+ */
67
91
  visitorId?: string | null;
68
- /** Application ID. */
92
+ /**
93
+ * Application ID.
94
+ * @maxLength 36
95
+ */
69
96
  applicationId?: string | null;
70
- /** User ID. */
97
+ /**
98
+ * User ID.
99
+ * @format GUID
100
+ */
71
101
  userId?: string | null;
72
102
  }
73
103
  /** @oneof */
74
104
  export interface SubmitterSubmitterOneOf {
75
- /** Member ID. */
105
+ /**
106
+ * Member ID.
107
+ * @format GUID
108
+ */
76
109
  memberId?: string | null;
77
- /** Visitor ID. */
110
+ /**
111
+ * Visitor ID.
112
+ * @format GUID
113
+ */
78
114
  visitorId?: string | null;
79
- /** Application ID. */
115
+ /**
116
+ * Application ID.
117
+ * @maxLength 36
118
+ */
80
119
  applicationId?: string | null;
81
- /** User ID. */
120
+ /**
121
+ * User ID.
122
+ * @format GUID
123
+ */
82
124
  userId?: string | null;
83
125
  }
84
126
  export interface ExtendedFields {
@@ -95,6 +137,7 @@ export interface ExtendedFields {
95
137
  export interface OrderDetails {
96
138
  /**
97
139
  * ID of the order related to submission (only applicable if a form has payments).
140
+ * @format GUID
98
141
  * @readonly
99
142
  */
100
143
  orderId?: string | null;
@@ -105,16 +148,19 @@ export interface OrderDetails {
105
148
  number?: string | null;
106
149
  /**
107
150
  * Currency.
151
+ * @format CURRENCY
108
152
  * @readonly
109
153
  */
110
154
  currency?: string | null;
111
155
  /**
112
156
  * Item subtotal.
157
+ * @decimalValue options { gte:0.00, maxScale:2 }
113
158
  * @readonly
114
159
  */
115
160
  itemSubtotal?: string;
116
161
  /**
117
162
  * ID of the checkout related to submission (only applicable if a form has payments).
163
+ * @format GUID
118
164
  * @readonly
119
165
  */
120
166
  checkoutId?: string;
@@ -124,7 +170,11 @@ export interface PublicTags {
124
170
  tags?: TagList;
125
171
  }
126
172
  export interface TagList {
127
- /** List of tag IDs */
173
+ /**
174
+ * List of tag IDs
175
+ * @maxSize 100
176
+ * @maxLength 5
177
+ */
128
178
  tagIds?: string[];
129
179
  }
130
180
  export interface FormSubmissionStatusUpdatedEvent {
@@ -140,18 +190,31 @@ export interface RemovedSubmissionFromTrash {
140
190
  export interface SubmissionContactMapped {
141
191
  /**
142
192
  * Mapped upserted contact ID.
193
+ * @format GUID
143
194
  * @readonly
144
195
  */
145
196
  contactId?: string;
146
- /** Identifies the namespace that the submission's form belongs to. */
197
+ /**
198
+ * Identifies the namespace that the submission's form belongs to.
199
+ * @minLength 10
200
+ * @maxLength 50
201
+ * @immutable
202
+ */
147
203
  namespace?: string;
148
204
  /** Marketing subscription details */
149
205
  marketingSubscriptionDetails?: MarketingSubscriptionDetails;
150
206
  }
151
207
  export interface MarketingSubscriptionDetails {
152
- /** Form id which was submitted */
208
+ /**
209
+ * Form id which was submitted
210
+ * @format GUID
211
+ */
153
212
  formId?: string;
154
- /** Mapped contact emails. */
213
+ /**
214
+ * Mapped contact emails.
215
+ * @format EMAIL
216
+ * @maxSize 100
217
+ */
155
218
  emails?: string[];
156
219
  /**
157
220
  * Date and time the form submission was created.
@@ -171,12 +234,21 @@ export declare enum OptInLevel {
171
234
  DOUBLE_CONFIRMATION = "DOUBLE_CONFIRMATION"
172
235
  }
173
236
  export interface SubmissionContactMappingSkipped {
174
- /** Form Id. */
237
+ /**
238
+ * Form Id.
239
+ * @format GUID
240
+ */
175
241
  formId?: string;
176
- /** Identifies the namespace that the submission's form belongs to. */
242
+ /**
243
+ * Identifies the namespace that the submission's form belongs to.
244
+ * @minLength 10
245
+ * @maxLength 50
246
+ * @immutable
247
+ */
177
248
  namespace?: string;
178
249
  /**
179
250
  * Contact ID resolved from the submission context.
251
+ * @format GUID
180
252
  * @readonly
181
253
  */
182
254
  contactId?: string | null;
@@ -195,17 +267,25 @@ export interface CreateCheckoutFromSubmissionRequestFormSchemaIdentifierOneOf {
195
267
  export interface Form {
196
268
  /**
197
269
  * Form ID.
270
+ * @format GUID
198
271
  * @readonly
199
272
  */
200
273
  id?: string | null;
201
274
  /**
202
275
  * List of form fields that represent input elements.
276
+ * @maxSize 500
203
277
  * @readonly
204
278
  */
205
279
  fieldsV2?: FormFieldV2[];
206
- /** Defines the layout for form fields in each submission step. */
280
+ /**
281
+ * Defines the layout for form fields in each submission step.
282
+ * @maxSize 100
283
+ */
207
284
  steps?: Step[];
208
- /** Form rules, can be applied to layout and items properties. */
285
+ /**
286
+ * Form rules, can be applied to layout and items properties.
287
+ * @maxSize 100
288
+ */
209
289
  rules?: FormRule[];
210
290
  /**
211
291
  * 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.
@@ -226,20 +306,28 @@ export interface Form {
226
306
  properties?: FormProperties;
227
307
  /**
228
308
  * Fields which were soft deleted.
309
+ * @maxSize 150
229
310
  * @readonly
230
311
  */
231
312
  deletedFields?: FormField[];
232
313
  /**
233
314
  * List of form fields that represent input elements.
315
+ * @maxSize 150
234
316
  * @readonly
235
317
  */
236
318
  deletedFieldsV2?: FormFieldV2[];
237
319
  /** Data extensions ExtendedFields. */
238
320
  extendedFields?: ExtendedFields;
239
- /** Identifies the namespace that the form belongs to. */
321
+ /**
322
+ * Identifies the namespace that the form belongs to.
323
+ * @minLength 10
324
+ * @maxLength 50
325
+ * @immutable
326
+ */
240
327
  namespace?: string;
241
328
  /**
242
329
  * Media folder ID.
330
+ * @maxLength 100
243
331
  * @readonly
244
332
  */
245
333
  mediaFolderId?: string | null;
@@ -254,15 +342,23 @@ export interface Form {
254
342
  requiredIndicatorProperties?: RequiredIndicatorProperties;
255
343
  /** Settings for actions to be taken after form submission. */
256
344
  submitSettings?: SubmitSettings;
257
- /** Settings for field groups */
345
+ /**
346
+ * Settings for field groups
347
+ * @maxSize 50
348
+ */
258
349
  fieldGroups?: FieldGroup[];
259
350
  /** Message shown when the form is disabled */
260
351
  disabledFormMessage?: RichContent;
261
352
  /**
262
- * Identifies if the form is disabled.
353
+ * Identifies if the form is enabled.
263
354
  * Default true
264
355
  */
265
356
  enabled?: boolean | null;
357
+ /**
358
+ * Form name.
359
+ * @maxLength 200
360
+ */
361
+ name?: string | null;
266
362
  }
267
363
  export declare enum RequiredIndicator {
268
364
  /** Unknown required indicator. */
@@ -283,9 +379,17 @@ export declare enum RequiredIndicatorPlacement {
283
379
  BEFORE_FIELD_TITLE = "BEFORE_FIELD_TITLE"
284
380
  }
285
381
  export interface FormField {
286
- /** Item ID. */
382
+ /**
383
+ * Item ID.
384
+ * @format GUID
385
+ * @immutable
386
+ */
287
387
  id?: string;
288
- /** Definition of a target where the value of field belongs. */
388
+ /**
389
+ * Definition of a target where the value of field belongs.
390
+ * @maxLength 200
391
+ * @immutable
392
+ */
289
393
  target?: string | null;
290
394
  /** Validation of field output value. */
291
395
  validation?: Validation;
@@ -314,17 +418,30 @@ export interface StringType extends StringTypeFormatOptionsOneOf {
314
418
  dateOptionalTimeOptions?: DateTimeConstraints;
315
419
  /** PHONE format options */
316
420
  phoneOptions?: PhoneConstraints;
317
- /** Minimum length. */
421
+ /**
422
+ * Minimum length.
423
+ * @max 20000
424
+ */
318
425
  minLength?: number | null;
319
- /** Maximum length. */
426
+ /**
427
+ * Maximum length.
428
+ * @max 20000
429
+ */
320
430
  maxLength?: number | null;
321
- /** Pattern for a regular expression match. */
431
+ /**
432
+ * Pattern for a regular expression match.
433
+ * @maxLength 500
434
+ */
322
435
  pattern?: string | null;
323
436
  /** Format of a string. */
324
437
  format?: FormatEnumFormat;
325
438
  /** Custom error messages when validation fails. */
326
439
  errorMessages?: StringErrorMessages;
327
- /** List of allowed values. */
440
+ /**
441
+ * List of allowed values.
442
+ * @maxSize 500
443
+ * @maxLength 20000
444
+ */
328
445
  enum?: string[] | null;
329
446
  }
330
447
  /** @oneof */
@@ -357,7 +474,10 @@ export declare enum FormatEnumFormat {
357
474
  DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
358
475
  }
359
476
  export interface StringErrorMessages {
360
- /** Default error message on invalid validation. */
477
+ /**
478
+ * Default error message on invalid validation.
479
+ * @maxLength 200
480
+ */
361
481
  default?: string | null;
362
482
  }
363
483
  export interface DateTimeConstraints {
@@ -366,6 +486,7 @@ export interface DateTimeConstraints {
366
486
  * dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
367
487
  * The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
368
488
  * The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
489
+ * @maxLength 50
369
490
  */
370
491
  minimum?: string | null;
371
492
  /**
@@ -373,11 +494,16 @@ export interface DateTimeConstraints {
373
494
  * dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
374
495
  * The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
375
496
  * The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
497
+ * @maxLength 50
376
498
  */
377
499
  maximum?: string | null;
378
500
  }
379
501
  export interface PhoneConstraints {
380
- /** Country codes for phone number that are allowed */
502
+ /**
503
+ * Country codes for phone number that are allowed
504
+ * @maxSize 250
505
+ * @maxLength 2
506
+ */
381
507
  allowedCountryCodes?: string[];
382
508
  }
383
509
  export interface NumberType {
@@ -389,11 +515,17 @@ export interface NumberType {
389
515
  multipleOf?: number | null;
390
516
  /** Custom error message when validation fails. */
391
517
  errorMessages?: NumberErrorMessages;
392
- /** List of allowed values. */
518
+ /**
519
+ * List of allowed values.
520
+ * @maxSize 500
521
+ */
393
522
  enum?: number[] | null;
394
523
  }
395
524
  export interface NumberErrorMessages {
396
- /** Default error message on invalid validation. */
525
+ /**
526
+ * Default error message on invalid validation.
527
+ * @maxLength 200
528
+ */
397
529
  default?: string | null;
398
530
  }
399
531
  export interface IntegerType {
@@ -405,23 +537,38 @@ export interface IntegerType {
405
537
  multipleOf?: number | null;
406
538
  /** Custom error message when validation fails. */
407
539
  errorMessages?: NumberErrorMessages;
408
- /** List of allowed values. */
540
+ /**
541
+ * List of allowed values.
542
+ * @maxSize 500
543
+ */
409
544
  enum?: number[] | null;
410
545
  }
411
546
  export interface BooleanType {
412
547
  /** Custom error message when validation fails. */
413
548
  errorMessages?: BooleanErrorMessages;
414
- /** List of allowed values. */
549
+ /**
550
+ * List of allowed values.
551
+ * @maxSize 2
552
+ */
415
553
  enum?: boolean[];
416
554
  }
417
555
  export interface BooleanErrorMessages {
418
- /** Default error message on invalid validation. */
556
+ /**
557
+ * Default error message on invalid validation.
558
+ * @maxLength 200
559
+ */
419
560
  default?: string | null;
420
561
  }
421
562
  export interface ArrayType {
422
- /** Maximum amount of array elements. */
563
+ /**
564
+ * Maximum amount of array elements.
565
+ * @max 1000
566
+ */
423
567
  maxItems?: number | null;
424
- /** Minimum amount of array elements. */
568
+ /**
569
+ * Minimum amount of array elements.
570
+ * @max 1000
571
+ */
425
572
  minItems?: number | null;
426
573
  /** Type of items allowed in array. */
427
574
  items?: ArrayItems;
@@ -462,7 +609,10 @@ export interface PropertiesTypePropertiesTypeOneOf {
462
609
  array?: ArrayType;
463
610
  }
464
611
  export interface ObjectErrorMessages {
465
- /** Default error message on invalid validation. */
612
+ /**
613
+ * Default error message on invalid validation.
614
+ * @maxLength 200
615
+ */
466
616
  default?: string | null;
467
617
  }
468
618
  export interface ArrayItems extends ArrayItemsItemsOneOf {
@@ -491,7 +641,10 @@ export interface ArrayItemsItemsOneOf {
491
641
  object?: ObjectType;
492
642
  }
493
643
  export interface ArrayErrorMessages {
494
- /** Default error message on invalid validation. */
644
+ /**
645
+ * Default error message on invalid validation.
646
+ * @maxLength 200
647
+ */
495
648
  default?: string | null;
496
649
  }
497
650
  export interface PredefinedValidation extends PredefinedValidationFormatOptionsOneOf {
@@ -521,11 +674,21 @@ export declare enum ValidationFormat {
521
674
  SCHEDULING = "SCHEDULING"
522
675
  }
523
676
  export interface PaymentType {
524
- /** Field mapped to products. */
677
+ /**
678
+ * Field mapped to products.
679
+ * @minSize 1
680
+ * @maxSize 100
681
+ */
525
682
  products?: Product[];
526
- /** Minimum amount of different products. */
683
+ /**
684
+ * Minimum amount of different products.
685
+ * @max 100
686
+ */
527
687
  minItems?: number | null;
528
- /** Maximum amount of different products. */
688
+ /**
689
+ * Maximum amount of different products.
690
+ * @max 100
691
+ */
529
692
  maxItems?: number | null;
530
693
  }
531
694
  export declare enum ProductType {
@@ -545,19 +708,36 @@ export declare enum PriceType {
545
708
  DYNAMIC_PRICE = "DYNAMIC_PRICE"
546
709
  }
547
710
  export interface QuantityLimit {
548
- /** Minimum quantity. */
711
+ /**
712
+ * Minimum quantity.
713
+ * @min 1
714
+ * @max 100000
715
+ */
549
716
  minimum?: number | null;
550
- /** Maximum quantity. */
717
+ /**
718
+ * Maximum quantity.
719
+ * @min 1
720
+ * @max 100000
721
+ */
551
722
  maximum?: number | null;
552
723
  }
553
724
  export interface FixedPriceOptions {
554
- /** Fixed price monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). */
725
+ /**
726
+ * Fixed price monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99).
727
+ * @decimalValue options { gte:0.00, maxScale:2 }
728
+ */
555
729
  price?: string;
556
730
  }
557
731
  export interface DynamicPriceOptions {
558
- /** Minimal price monetary amount. */
732
+ /**
733
+ * Minimal price monetary amount.
734
+ * @decimalValue options { gte:0.00, maxScale:2 }
735
+ */
559
736
  minPrice?: string;
560
- /** Maximal price monetary amount. */
737
+ /**
738
+ * Maximal price monetary amount.
739
+ * @decimalValue options { gte:0.00, maxScale:2 }
740
+ */
561
741
  maxPrice?: string | null;
562
742
  }
563
743
  export interface Product extends ProductPriceOptionsOneOf {
@@ -567,6 +747,7 @@ export interface Product extends ProductPriceOptionsOneOf {
567
747
  dynamicPriceOptions?: DynamicPriceOptions;
568
748
  /**
569
749
  * Product ID.
750
+ * @format GUID
570
751
  * @readonly
571
752
  */
572
753
  id?: string;
@@ -585,7 +766,11 @@ export interface ProductPriceOptionsOneOf {
585
766
  dynamicPriceOptions?: DynamicPriceOptions;
586
767
  }
587
768
  export interface MultilineAddressValidation {
588
- /** Allowed countries. No countries treated as all. */
769
+ /**
770
+ * Allowed countries. No countries treated as all.
771
+ * @format COUNTRY
772
+ * @maxSize 200
773
+ */
589
774
  allowedCountries?: string[];
590
775
  /** Fields overrides. */
591
776
  fields?: FieldsOverrides;
@@ -654,7 +839,12 @@ export interface ValidationValidationOneOf {
654
839
  predefined?: PredefinedValidation;
655
840
  }
656
841
  export interface DataExtensionsDetails {
657
- /** FQDNS which can be extended with this field */
842
+ /**
843
+ * FQDNS which can be extended with this field
844
+ * @maxSize 10
845
+ * @maxLength 100
846
+ * @immutable
847
+ */
658
848
  fqdns?: string[];
659
849
  }
660
850
  export interface NestedFormOverrides {
@@ -666,7 +856,11 @@ export interface FormFieldV2 extends FormFieldV2FieldTypeOptionsOneOf {
666
856
  inputOptions?: InputField;
667
857
  /** Field for displaying information such as header or text paragraph */
668
858
  displayOptions?: DisplayField;
669
- /** Field id. */
859
+ /**
860
+ * Field id.
861
+ * @format GUID
862
+ * @immutable
863
+ */
670
864
  id?: string;
671
865
  /**
672
866
  * Whether the field is hidden.
@@ -697,17 +891,30 @@ export interface InputFieldStringType extends InputFieldStringTypeFormatOptionsO
697
891
  dateOptionalTimeOptions?: StringTypeDateTimeConstraints;
698
892
  /** PHONE format options */
699
893
  phoneOptions?: StringTypePhoneConstraints;
700
- /** Minimum length. */
894
+ /**
895
+ * Minimum length.
896
+ * @max 20000
897
+ */
701
898
  minLength?: number | null;
702
- /** Maximum length. */
899
+ /**
900
+ * Maximum length.
901
+ * @max 20000
902
+ */
703
903
  maxLength?: number | null;
704
- /** Pattern for a regular expression match. */
904
+ /**
905
+ * Pattern for a regular expression match.
906
+ * @maxLength 500
907
+ */
705
908
  pattern?: string | null;
706
909
  /** Format of a string. */
707
910
  format?: StringTypeFormatEnumFormat;
708
911
  /** Custom error messages when validation fails. */
709
912
  errorMessages?: InputFieldStringErrorMessages;
710
- /** List of allowed values. */
913
+ /**
914
+ * List of allowed values.
915
+ * @maxSize 500
916
+ * @maxLength 20000
917
+ */
711
918
  enum?: string[] | null;
712
919
  }
713
920
  /** @oneof */
@@ -740,7 +947,10 @@ export declare enum StringTypeFormatEnumFormat {
740
947
  DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
741
948
  }
742
949
  export interface InputFieldStringErrorMessages {
743
- /** Default error message on invalid validation. */
950
+ /**
951
+ * Default error message on invalid validation.
952
+ * @maxLength 200
953
+ */
744
954
  default?: string | null;
745
955
  }
746
956
  export interface StringTypeDateTimeConstraints {
@@ -749,6 +959,7 @@ export interface StringTypeDateTimeConstraints {
749
959
  * dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
750
960
  * The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
751
961
  * The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
962
+ * @maxLength 50
752
963
  */
753
964
  minimum?: string | null;
754
965
  /**
@@ -756,11 +967,16 @@ export interface StringTypeDateTimeConstraints {
756
967
  * dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
757
968
  * The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
758
969
  * The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
970
+ * @maxLength 50
759
971
  */
760
972
  maximum?: string | null;
761
973
  }
762
974
  export interface StringTypePhoneConstraints {
763
- /** Country codes for phone number that are allowed */
975
+ /**
976
+ * Country codes for phone number that are allowed
977
+ * @maxSize 250
978
+ * @maxLength 2
979
+ */
764
980
  allowedCountryCodes?: string[];
765
981
  }
766
982
  export declare enum StringComponentType {
@@ -775,18 +991,27 @@ export declare enum StringComponentType {
775
991
  DATE_PICKER = "DATE_PICKER"
776
992
  }
777
993
  export interface TextInput {
778
- /** Label of the field */
994
+ /**
995
+ * Label of the field
996
+ * @maxLength 350
997
+ */
779
998
  label?: string | null;
780
999
  /** Description of the field */
781
1000
  description?: RichContent;
782
- /** Placeholder for the value input */
1001
+ /**
1002
+ * Placeholder for the value input
1003
+ * @maxLength 100
1004
+ */
783
1005
  placeholder?: string | null;
784
1006
  /**
785
1007
  * Flag identifying to hide or not label
786
1008
  * Default: true
787
1009
  */
788
1010
  showLabel?: boolean | null;
789
- /** Default value for the text input */
1011
+ /**
1012
+ * Default value for the text input
1013
+ * @maxLength 20000
1014
+ */
790
1015
  default?: string | null;
791
1016
  }
792
1017
  export interface RichContent {
@@ -1387,11 +1612,20 @@ export interface GIFData {
1387
1612
  gifType?: GIFType;
1388
1613
  }
1389
1614
  export interface GIF {
1390
- /** GIF format URL. */
1615
+ /**
1616
+ * GIF format URL.
1617
+ * @format WEB_URL
1618
+ */
1391
1619
  gif?: string | null;
1392
- /** MP4 format URL. */
1620
+ /**
1621
+ * MP4 format URL.
1622
+ * @format WEB_URL
1623
+ */
1393
1624
  mp4?: string | null;
1394
- /** Thumbnail URL. */
1625
+ /**
1626
+ * Thumbnail URL.
1627
+ * @format WEB_URL
1628
+ */
1395
1629
  still?: string | null;
1396
1630
  }
1397
1631
  export declare enum GIFType {
@@ -1465,7 +1699,10 @@ export interface ImageData {
1465
1699
  export interface StylesBorder {
1466
1700
  /** Border width in pixels. */
1467
1701
  width?: number | null;
1468
- /** Border color. */
1702
+ /**
1703
+ * Border color as a hexadecimal value.
1704
+ * @format COLOR_HEX
1705
+ */
1469
1706
  color?: string | null;
1470
1707
  /** Border radius in pixels. */
1471
1708
  radius?: number | null;
@@ -1619,13 +1856,22 @@ export declare enum BackgroundType {
1619
1856
  export interface Gradient {
1620
1857
  /** The gradient angle in degrees. */
1621
1858
  angle?: number | null;
1622
- /** The start color as a hexademical value. */
1859
+ /**
1860
+ * The start color as a hexademical value.
1861
+ * @format COLOR_HEX
1862
+ */
1623
1863
  startColor?: string | null;
1624
- /** The end color as a hexademical value. */
1864
+ /**
1865
+ * The end color as a hexademical value.
1866
+ * @format COLOR_HEX
1867
+ */
1625
1868
  lastColor?: string | null;
1626
1869
  }
1627
1870
  export interface Background extends BackgroundBackgroundOneOf {
1628
- /** The background color as a hexademical value. */
1871
+ /**
1872
+ * The background color as a hexademical value.
1873
+ * @format COLOR_HEX
1874
+ */
1629
1875
  color?: string | null;
1630
1876
  /** An image to use for the background. */
1631
1877
  image?: Media;
@@ -1636,7 +1882,10 @@ export interface Background extends BackgroundBackgroundOneOf {
1636
1882
  }
1637
1883
  /** @oneof */
1638
1884
  export interface BackgroundBackgroundOneOf {
1639
- /** The background color as a hexademical value. */
1885
+ /**
1886
+ * The background color as a hexademical value.
1887
+ * @format COLOR_HEX
1888
+ */
1640
1889
  color?: string | null;
1641
1890
  /** An image to use for the background. */
1642
1891
  image?: Media;
@@ -1948,17 +2197,32 @@ export declare enum VerticalAlignment {
1948
2197
  export interface CellStyle {
1949
2198
  /** Vertical alignment for the cell's text. */
1950
2199
  verticalAlignment?: VerticalAlignment;
1951
- /** Cell background color as a hexadecimal value. */
2200
+ /**
2201
+ * Cell background color as a hexadecimal value.
2202
+ * @format COLOR_HEX
2203
+ */
1952
2204
  backgroundColor?: string | null;
1953
2205
  }
1954
2206
  export interface BorderColors {
1955
- /** Left border color as a hexadecimal value. */
2207
+ /**
2208
+ * Left border color as a hexadecimal value.
2209
+ * @format COLOR_HEX
2210
+ */
1956
2211
  left?: string | null;
1957
- /** Right border color as a hexadecimal value. */
2212
+ /**
2213
+ * Right border color as a hexadecimal value.
2214
+ * @format COLOR_HEX
2215
+ */
1958
2216
  right?: string | null;
1959
- /** Top border color as a hexadecimal value. */
2217
+ /**
2218
+ * Top border color as a hexadecimal value.
2219
+ * @format COLOR_HEX
2220
+ */
1960
2221
  top?: string | null;
1961
- /** Bottom border color as a hexadecimal value. */
2222
+ /**
2223
+ * Bottom border color as a hexadecimal value.
2224
+ * @format COLOR_HEX
2225
+ */
1962
2226
  bottom?: string | null;
1963
2227
  }
1964
2228
  /**
@@ -2067,13 +2331,17 @@ export interface TextNodeStyle {
2067
2331
  lineHeight?: string | null;
2068
2332
  }
2069
2333
  export interface RadioGroup {
2070
- /** Label of the field */
2334
+ /**
2335
+ * Label of the field
2336
+ * @maxLength 350
2337
+ */
2071
2338
  label?: string | null;
2072
2339
  /** Description of the field */
2073
2340
  description?: RichContent;
2074
2341
  /**
2075
2342
  * Flag identifying to show option allowing input custom value
2076
2343
  * List of options to select from
2344
+ * @maxSize 400
2077
2345
  */
2078
2346
  options?: RadioGroupOption[];
2079
2347
  /**
@@ -2090,19 +2358,35 @@ export interface RadioGroup {
2090
2358
  numberOfColumns?: NumberOfColumns;
2091
2359
  }
2092
2360
  export interface RadioGroupOption {
2093
- /** Selectable option label */
2361
+ /**
2362
+ * Selectable option label
2363
+ * @maxLength 400
2364
+ */
2094
2365
  label?: string | null;
2095
- /** Selectable option value, which is saved to DB. */
2366
+ /**
2367
+ * Selectable option value, which is saved to DB.
2368
+ * @maxLength 20000
2369
+ */
2096
2370
  value?: string | null;
2097
2371
  /** Flag identifying that option should be selected by default */
2098
2372
  default?: boolean;
2099
- /** Option id. Used as binding for translations */
2373
+ /**
2374
+ * Option id. Used as binding for translations
2375
+ * @format GUID
2376
+ * @immutable
2377
+ */
2100
2378
  id?: string;
2101
2379
  }
2102
2380
  export interface RadioGroupCustomOption {
2103
- /** Label of custom option input */
2381
+ /**
2382
+ * Label of custom option input
2383
+ * @maxLength 350
2384
+ */
2104
2385
  label?: string | null;
2105
- /** Placeholder of custom option input */
2386
+ /**
2387
+ * Placeholder of custom option input
2388
+ * @maxLength 100
2389
+ */
2106
2390
  placeholder?: string | null;
2107
2391
  }
2108
2392
  export declare enum NumberOfColumns {
@@ -2118,11 +2402,17 @@ export declare enum NumberOfColumns {
2118
2402
  THREE = "THREE"
2119
2403
  }
2120
2404
  export interface Dropdown {
2121
- /** Label of the field */
2405
+ /**
2406
+ * Label of the field
2407
+ * @maxLength 350
2408
+ */
2122
2409
  label?: string | null;
2123
2410
  /** Description of the field */
2124
2411
  description?: RichContent;
2125
- /** List of options to select from */
2412
+ /**
2413
+ * List of options to select from
2414
+ * @maxSize 400
2415
+ */
2126
2416
  options?: DropdownOption[];
2127
2417
  /**
2128
2418
  * Flag identifying to hide or not label
@@ -2131,27 +2421,49 @@ export interface Dropdown {
2131
2421
  showLabel?: boolean | null;
2132
2422
  /** Option which can be specified by UoU, enabled when this object is specified. */
2133
2423
  customOption?: DropdownCustomOption;
2134
- /** Placeholder of dropdown input */
2424
+ /**
2425
+ * Placeholder of dropdown input
2426
+ * @maxLength 100
2427
+ */
2135
2428
  placeholder?: string | null;
2136
2429
  }
2137
2430
  export interface DropdownOption {
2138
- /** Selectable option label */
2431
+ /**
2432
+ * Selectable option label
2433
+ * @maxLength 400
2434
+ */
2139
2435
  label?: string | null;
2140
- /** Selectable option value, which is saved to DB. */
2436
+ /**
2437
+ * Selectable option value, which is saved to DB.
2438
+ * @maxLength 20000
2439
+ */
2141
2440
  value?: string | null;
2142
2441
  /** Flag identifying that option should be selected by default */
2143
2442
  default?: boolean;
2144
- /** Option id. Used as binding for translations */
2443
+ /**
2444
+ * Option id. Used as binding for translations
2445
+ * @format GUID
2446
+ * @immutable
2447
+ */
2145
2448
  id?: string;
2146
2449
  }
2147
2450
  export interface DropdownCustomOption {
2148
- /** Label of custom option input */
2451
+ /**
2452
+ * Label of custom option input
2453
+ * @maxLength 350
2454
+ */
2149
2455
  label?: string | null;
2150
- /** Placeholder of custom option input */
2456
+ /**
2457
+ * Placeholder of custom option input
2458
+ * @maxLength 100
2459
+ */
2151
2460
  placeholder?: string | null;
2152
2461
  }
2153
2462
  export interface DateTimeInput {
2154
- /** Label of the field. Displayed text for the date/time input. */
2463
+ /**
2464
+ * Label of the field. Displayed text for the date/time input.
2465
+ * @maxLength 350
2466
+ */
2155
2467
  label?: string | null;
2156
2468
  /** Description of the field. Additional information about the date/time input. */
2157
2469
  description?: RichContent;
@@ -2170,22 +2482,35 @@ export interface DateTimeInput {
2170
2482
  * Default: false.
2171
2483
  */
2172
2484
  use24HourFormat?: boolean;
2173
- /** Default value for the date time input. */
2485
+ /**
2486
+ * Default value for the date time input.
2487
+ * @format LOCAL_DATE_TIME
2488
+ */
2174
2489
  default?: string | null;
2175
2490
  }
2176
2491
  export interface PhoneInput {
2177
- /** Label of the field */
2492
+ /**
2493
+ * Label of the field
2494
+ * @maxLength 350
2495
+ */
2178
2496
  label?: string | null;
2179
2497
  /** Description of the field */
2180
2498
  description?: RichContent;
2181
- /** Placeholder for the value input */
2499
+ /**
2500
+ * Placeholder for the value input
2501
+ * @maxLength 100
2502
+ */
2182
2503
  placeholder?: string | null;
2183
2504
  /**
2184
2505
  * Flag identifying to show label or not
2185
2506
  * Default: true
2186
2507
  */
2187
2508
  showLabel?: boolean | null;
2188
- /** Default value of the country code */
2509
+ /**
2510
+ * Default value of the country code
2511
+ * @minLength 1
2512
+ * @maxLength 5
2513
+ */
2189
2514
  defaultCountryCode?: string | null;
2190
2515
  /**
2191
2516
  * Flag identifying to show country flag or not
@@ -2194,7 +2519,10 @@ export interface PhoneInput {
2194
2519
  showCountryFlag?: boolean;
2195
2520
  }
2196
2521
  export interface DateInput {
2197
- /** Label of the field. Displayed text for the date/time input. */
2522
+ /**
2523
+ * Label of the field. Displayed text for the date/time input.
2524
+ * @maxLength 350
2525
+ */
2198
2526
  label?: string | null;
2199
2527
  /** Description of the field. Additional information about the date/time input. */
2200
2528
  description?: RichContent;
@@ -2208,11 +2536,17 @@ export interface DateInput {
2208
2536
  * Default: true
2209
2537
  */
2210
2538
  showPlaceholder?: boolean | null;
2211
- /** Default value for the date input. */
2539
+ /**
2540
+ * Default value for the date input.
2541
+ * @format LOCAL_DATE
2542
+ */
2212
2543
  default?: string | null;
2213
2544
  }
2214
2545
  export interface TimeInput {
2215
- /** Label of the field. Displayed text for the date/time input. */
2546
+ /**
2547
+ * Label of the field. Displayed text for the date/time input.
2548
+ * @maxLength 350
2549
+ */
2216
2550
  label?: string | null;
2217
2551
  /** Description of the field. Additional information about the date/time input. */
2218
2552
  description?: RichContent;
@@ -2231,11 +2565,17 @@ export interface TimeInput {
2231
2565
  * Default: false.
2232
2566
  */
2233
2567
  use24HourFormat?: boolean;
2234
- /** Default value for the time input. */
2568
+ /**
2569
+ * Default value for the time input.
2570
+ * @format LOCAL_TIME
2571
+ */
2235
2572
  default?: string | null;
2236
2573
  }
2237
2574
  export interface DatePicker {
2238
- /** Label of the field. Displayed text for the date/time input. */
2575
+ /**
2576
+ * Label of the field. Displayed text for the date/time input.
2577
+ * @maxLength 350
2578
+ */
2239
2579
  label?: string | null;
2240
2580
  /** Description of the field. Additional information about the date/time input. */
2241
2581
  description?: RichContent;
@@ -2244,11 +2584,17 @@ export interface DatePicker {
2244
2584
  * Default: true
2245
2585
  */
2246
2586
  showLabel?: boolean | null;
2247
- /** Placeholder of date picker input */
2587
+ /**
2588
+ * Placeholder of date picker input
2589
+ * @maxLength 100
2590
+ */
2248
2591
  placeholder?: string | null;
2249
2592
  /** First day of the week displayed on date picker. */
2250
2593
  firstDayOfWeek?: FirstDayOfWeek;
2251
- /** Default value for the date picker. */
2594
+ /**
2595
+ * Default value for the date picker.
2596
+ * @format LOCAL_DATE
2597
+ */
2252
2598
  default?: string | null;
2253
2599
  }
2254
2600
  export declare enum FirstDayOfWeek {
@@ -2266,11 +2612,17 @@ export interface InputFieldNumberType {
2266
2612
  multipleOf?: number | null;
2267
2613
  /** Custom error message when validation fails. */
2268
2614
  errorMessages?: InputFieldNumberErrorMessages;
2269
- /** List of allowed values. */
2615
+ /**
2616
+ * List of allowed values.
2617
+ * @maxSize 500
2618
+ */
2270
2619
  enum?: number[] | null;
2271
2620
  }
2272
2621
  export interface InputFieldNumberErrorMessages {
2273
- /** Default error message on invalid validation. */
2622
+ /**
2623
+ * Default error message on invalid validation.
2624
+ * @maxLength 200
2625
+ */
2274
2626
  default?: string | null;
2275
2627
  }
2276
2628
  export declare enum NumberComponentType {
@@ -2279,11 +2631,17 @@ export declare enum NumberComponentType {
2279
2631
  RATING_INPUT = "RATING_INPUT"
2280
2632
  }
2281
2633
  export interface NumberInput {
2282
- /** Label of the field */
2634
+ /**
2635
+ * Label of the field
2636
+ * @maxLength 350
2637
+ */
2283
2638
  label?: string | null;
2284
2639
  /** Description of the field */
2285
2640
  description?: RichContent;
2286
- /** Placeholder for the value input */
2641
+ /**
2642
+ * Placeholder for the value input
2643
+ * @maxLength 100
2644
+ */
2287
2645
  placeholder?: string | null;
2288
2646
  /**
2289
2647
  * Flag identifying to hide or not label
@@ -2294,7 +2652,10 @@ export interface NumberInput {
2294
2652
  default?: number | null;
2295
2653
  }
2296
2654
  export interface RatingInput {
2297
- /** Label of the field */
2655
+ /**
2656
+ * Label of the field
2657
+ * @maxLength 350
2658
+ */
2298
2659
  label?: string | null;
2299
2660
  /** Description of the field */
2300
2661
  description?: RichContent;
@@ -2303,17 +2664,27 @@ export interface RatingInput {
2303
2664
  * Default: true
2304
2665
  */
2305
2666
  showLabel?: boolean | null;
2306
- /** Default rating */
2667
+ /**
2668
+ * Default rating
2669
+ * @min 1
2670
+ * @max 5
2671
+ */
2307
2672
  defaultValue?: number | null;
2308
2673
  }
2309
2674
  export interface InputFieldBooleanType {
2310
2675
  /** Custom error message when validation fails. */
2311
2676
  errorMessages?: InputFieldBooleanErrorMessages;
2312
- /** List of allowed values. */
2677
+ /**
2678
+ * List of allowed values.
2679
+ * @maxSize 2
2680
+ */
2313
2681
  enum?: boolean[];
2314
2682
  }
2315
2683
  export interface InputFieldBooleanErrorMessages {
2316
- /** Default error message on invalid validation. */
2684
+ /**
2685
+ * Default error message on invalid validation.
2686
+ * @maxLength 200
2687
+ */
2317
2688
  default?: string | null;
2318
2689
  }
2319
2690
  export declare enum BooleanComponentType {
@@ -2330,9 +2701,15 @@ export interface Checkbox {
2330
2701
  checked?: boolean;
2331
2702
  }
2332
2703
  export interface InputFieldArrayType {
2333
- /** Maximum amount of array elements. */
2704
+ /**
2705
+ * Maximum amount of array elements.
2706
+ * @max 1000
2707
+ */
2334
2708
  maxItems?: number | null;
2335
- /** Minimum amount of array elements. */
2709
+ /**
2710
+ * Minimum amount of array elements.
2711
+ * @max 1000
2712
+ */
2336
2713
  minItems?: number | null;
2337
2714
  /** Type of items allowed in array. */
2338
2715
  items?: ArrayTypeArrayItems;
@@ -2356,7 +2733,10 @@ export interface InputFieldIntegerType {
2356
2733
  multipleOf?: number | null;
2357
2734
  /** Custom error message when validation fails. */
2358
2735
  errorMessages?: InputFieldNumberErrorMessages;
2359
- /** List of allowed values. */
2736
+ /**
2737
+ * List of allowed values.
2738
+ * @maxSize 500
2739
+ */
2360
2740
  enum?: number[] | null;
2361
2741
  }
2362
2742
  export interface InputFieldObjectType {
@@ -2406,7 +2786,10 @@ export interface ObjectTypePropertiesTypePropertiesTypeOptionsOneOf {
2406
2786
  arrayOptions?: InputFieldArrayType;
2407
2787
  }
2408
2788
  export interface InputFieldObjectErrorMessages {
2409
- /** Default error message on invalid validation. */
2789
+ /**
2790
+ * Default error message on invalid validation.
2791
+ * @maxLength 200
2792
+ */
2410
2793
  default?: string | null;
2411
2794
  }
2412
2795
  export interface ArrayTypeArrayItems extends ArrayTypeArrayItemsItemTypeOptionsOneOf {
@@ -2440,7 +2823,10 @@ export interface ArrayTypeArrayItemsItemTypeOptionsOneOf {
2440
2823
  objectOptions?: InputFieldObjectType;
2441
2824
  }
2442
2825
  export interface InputFieldArrayErrorMessages {
2443
- /** Default error message on invalid validation. */
2826
+ /**
2827
+ * Default error message on invalid validation.
2828
+ * @maxLength 200
2829
+ */
2444
2830
  default?: string | null;
2445
2831
  }
2446
2832
  export declare enum ComponentType {
@@ -2449,11 +2835,17 @@ export declare enum ComponentType {
2449
2835
  TAGS = "TAGS"
2450
2836
  }
2451
2837
  export interface CheckboxGroup {
2452
- /** Label of the field */
2838
+ /**
2839
+ * Label of the field
2840
+ * @maxLength 350
2841
+ */
2453
2842
  label?: string | null;
2454
2843
  /** Description of the field */
2455
2844
  description?: RichContent;
2456
- /** List of options to select from */
2845
+ /**
2846
+ * List of options to select from
2847
+ * @maxSize 400
2848
+ */
2457
2849
  options?: Option[];
2458
2850
  /**
2459
2851
  * Flag identifying to hide or not label
@@ -2478,9 +2870,15 @@ export interface MediaItemMediaOneOf {
2478
2870
  image?: Image;
2479
2871
  }
2480
2872
  export interface Image {
2481
- /** WixMedia image ID. */
2873
+ /**
2874
+ * WixMedia image ID.
2875
+ * @maxLength 100
2876
+ */
2482
2877
  id?: string;
2483
- /** Image URL. */
2878
+ /**
2879
+ * Image URL.
2880
+ * @maxLength 2000
2881
+ */
2484
2882
  url?: string;
2485
2883
  /**
2486
2884
  * Original image height.
@@ -2492,38 +2890,61 @@ export interface Image {
2492
2890
  * @readonly
2493
2891
  */
2494
2892
  width?: number;
2495
- /** Image alt text. */
2893
+ /**
2894
+ * Image alt text.
2895
+ * @maxLength 1000
2896
+ */
2496
2897
  altText?: string | null;
2497
2898
  /**
2498
2899
  * Image filename.
2499
2900
  * @readonly
2901
+ * @maxLength 1000
2500
2902
  */
2501
2903
  filename?: string | null;
2502
2904
  }
2503
2905
  export interface Option {
2504
- /** Selectable option label */
2906
+ /**
2907
+ * Selectable option label
2908
+ * @maxLength 400
2909
+ */
2505
2910
  label?: string | null;
2506
2911
  /** Selectable option value, which is saved to DB. */
2507
2912
  value?: any;
2508
2913
  /** Flag identifying that option should be selected by default */
2509
2914
  default?: boolean;
2510
- /** Option id. Used as binding for translations */
2915
+ /**
2916
+ * Option id. Used as binding for translations
2917
+ * @format GUID
2918
+ * @immutable
2919
+ */
2511
2920
  id?: string;
2512
2921
  /** Media item. Media, associated with option, like image. */
2513
2922
  media?: MediaItem;
2514
2923
  }
2515
2924
  export interface CustomOption {
2516
- /** Label of custom option input */
2925
+ /**
2926
+ * Label of custom option input
2927
+ * @maxLength 350
2928
+ */
2517
2929
  label?: string | null;
2518
- /** Placeholder of custom option input */
2930
+ /**
2931
+ * Placeholder of custom option input
2932
+ * @maxLength 100
2933
+ */
2519
2934
  placeholder?: string | null;
2520
2935
  }
2521
2936
  export interface Tags {
2522
- /** Label of the field */
2937
+ /**
2938
+ * Label of the field
2939
+ * @maxLength 350
2940
+ */
2523
2941
  label?: string | null;
2524
2942
  /** Description of the field */
2525
2943
  description?: RichContent;
2526
- /** List of options to select from */
2944
+ /**
2945
+ * List of options to select from
2946
+ * @maxSize 400
2947
+ */
2527
2948
  options?: TagsOption[];
2528
2949
  /**
2529
2950
  * Flag identifying to hide or not label
@@ -2539,21 +2960,34 @@ export interface Tags {
2539
2960
  numberOfColumns?: NumberOfColumns;
2540
2961
  }
2541
2962
  export interface TagsOption {
2542
- /** Selectable option label */
2963
+ /**
2964
+ * Selectable option label
2965
+ * @maxLength 400
2966
+ */
2543
2967
  label?: string | null;
2544
2968
  /** Selectable option value, which is saved to DB. */
2545
2969
  value?: any;
2546
2970
  /** Flag identifying that option should be selected by default */
2547
2971
  default?: boolean;
2548
- /** Option id. Used as binding for translations */
2972
+ /**
2973
+ * Option id. Used as binding for translations
2974
+ * @format GUID
2975
+ * @immutable
2976
+ */
2549
2977
  id?: string;
2550
2978
  /** Media item. Media, associated with option, like image. */
2551
2979
  media?: MediaItem;
2552
2980
  }
2553
2981
  export interface CommonCustomOption {
2554
- /** Label of custom option input */
2982
+ /**
2983
+ * Label of custom option input
2984
+ * @maxLength 350
2985
+ */
2555
2986
  label?: string | null;
2556
- /** Placeholder of custom option input */
2987
+ /**
2988
+ * Placeholder of custom option input
2989
+ * @maxLength 100
2990
+ */
2557
2991
  placeholder?: string | null;
2558
2992
  }
2559
2993
  export declare enum WixFileComponentType {
@@ -2562,7 +2996,10 @@ export declare enum WixFileComponentType {
2562
2996
  SIGNATURE = "SIGNATURE"
2563
2997
  }
2564
2998
  export interface FileUpload {
2565
- /** Selectable option label */
2999
+ /**
3000
+ * Selectable option label
3001
+ * @maxLength 350
3002
+ */
2566
3003
  label?: string | null;
2567
3004
  /** Description of the field */
2568
3005
  description?: RichContent;
@@ -2571,13 +3008,26 @@ export interface FileUpload {
2571
3008
  * Default: true
2572
3009
  */
2573
3010
  showLabel?: boolean | null;
2574
- /** Text on upload button */
3011
+ /**
3012
+ * Text on upload button
3013
+ * @maxLength 500
3014
+ */
2575
3015
  buttonText?: string | null;
2576
- /** Amount of files allowed to upload */
3016
+ /**
3017
+ * Amount of files allowed to upload
3018
+ * @min 1
3019
+ * @max 30
3020
+ */
2577
3021
  fileLimit?: number;
2578
- /** Supported file formats for upload */
3022
+ /**
3023
+ * Supported file formats for upload
3024
+ * @maxSize 5
3025
+ */
2579
3026
  uploadFileFormats?: UploadFileFormat[];
2580
- /** Custom text which appears when file is uploaded, if missing file name will be shown */
3027
+ /**
3028
+ * Custom text which appears when file is uploaded, if missing file name will be shown
3029
+ * @maxLength 255
3030
+ */
2581
3031
  explanationText?: string | null;
2582
3032
  }
2583
3033
  export declare enum UploadFileFormat {
@@ -2595,7 +3045,10 @@ export declare enum UploadFileFormat {
2595
3045
  ARCHIVE = "ARCHIVE"
2596
3046
  }
2597
3047
  export interface Signature {
2598
- /** Selectable option label */
3048
+ /**
3049
+ * Selectable option label
3050
+ * @maxLength 350
3051
+ */
2599
3052
  label?: string | null;
2600
3053
  /**
2601
3054
  * Flag identifying to hide label or not
@@ -2615,11 +3068,17 @@ export declare enum PaymentComponentType {
2615
3068
  FIXED_PAYMENT = "FIXED_PAYMENT"
2616
3069
  }
2617
3070
  export interface ProductCheckboxGroup {
2618
- /** Label of the field. */
3071
+ /**
3072
+ * Label of the field.
3073
+ * @maxLength 350
3074
+ */
2619
3075
  label?: string | null;
2620
3076
  /** Description of the field. */
2621
3077
  description?: RichContent;
2622
- /** List of options to select from. */
3078
+ /**
3079
+ * List of options to select from.
3080
+ * @maxSize 400
3081
+ */
2623
3082
  options?: ProductCheckboxGroupOption[];
2624
3083
  /**
2625
3084
  * Flag identifying to hide or not label
@@ -2633,11 +3092,18 @@ export interface ProductCheckboxGroup {
2633
3092
  imageFit?: ImageFit;
2634
3093
  }
2635
3094
  export interface ProductCheckboxGroupOption {
2636
- /** Selectable option label. */
3095
+ /**
3096
+ * Selectable option label.
3097
+ * @maxLength 400
3098
+ */
2637
3099
  label?: string | null;
2638
3100
  /** Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list. */
2639
3101
  value?: any;
2640
- /** Option id. Used as binding for translations. */
3102
+ /**
3103
+ * Option id. Used as binding for translations.
3104
+ * @format GUID
3105
+ * @immutable
3106
+ */
2641
3107
  id?: string;
2642
3108
  /** Media item. Media, associated with option, like image. */
2643
3109
  media?: MediaItem;
@@ -2652,11 +3118,17 @@ export declare enum ImageFit {
2652
3118
  CONTAIN = "CONTAIN"
2653
3119
  }
2654
3120
  export interface DonationInput {
2655
- /** Label of the field. */
3121
+ /**
3122
+ * Label of the field.
3123
+ * @maxLength 350
3124
+ */
2656
3125
  label?: string | null;
2657
3126
  /** Description of the field. */
2658
3127
  description?: RichContent;
2659
- /** List of options to select from. */
3128
+ /**
3129
+ * List of options to select from.
3130
+ * @maxSize 400
3131
+ */
2660
3132
  options?: DonationInputOption[];
2661
3133
  /** Option which can be specified by UoU, enabled when this object is specified. */
2662
3134
  customOption?: CommonCustomOption;
@@ -2672,13 +3144,19 @@ export interface DonationInput {
2672
3144
  showLabel?: boolean | null;
2673
3145
  }
2674
3146
  export interface DonationInputOption {
2675
- /** Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list. */
3147
+ /**
3148
+ * Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list.
3149
+ * @format GUID
3150
+ */
2676
3151
  value?: string;
2677
3152
  /** Flag identifying that option should be selected by default */
2678
3153
  default?: boolean;
2679
3154
  }
2680
3155
  export interface PaymentInput {
2681
- /** Label of the field. */
3156
+ /**
3157
+ * Label of the field.
3158
+ * @maxLength 350
3159
+ */
2682
3160
  label?: string | null;
2683
3161
  /** Description of the field. */
2684
3162
  description?: RichContent;
@@ -2687,13 +3165,19 @@ export interface PaymentInput {
2687
3165
  * Default: true
2688
3166
  */
2689
3167
  showLabel?: boolean | null;
2690
- /** Placeholder of custom option input */
3168
+ /**
3169
+ * Placeholder of custom option input
3170
+ * @maxLength 100
3171
+ */
2691
3172
  placeholder?: string | null;
2692
3173
  /** Default value for the payment input */
2693
3174
  default?: number | null;
2694
3175
  }
2695
3176
  export interface FixedPayment {
2696
- /** Label of the field. */
3177
+ /**
3178
+ * Label of the field.
3179
+ * @maxLength 350
3180
+ */
2697
3181
  label?: string | null;
2698
3182
  /** Description of the field. */
2699
3183
  description?: RichContent;
@@ -2714,15 +3198,30 @@ export interface Appointment extends AppointmentFormatInfoOneOf {
2714
3198
  videoConferenceOptions?: VideoConferenceOptions;
2715
3199
  /** Phone options for the appointment */
2716
3200
  phoneOptions?: PhoneOptions;
2717
- /** Label of the field */
3201
+ /**
3202
+ * Label of the field
3203
+ * @maxLength 255
3204
+ */
2718
3205
  label?: string | null;
2719
- /** Name of the appointment */
3206
+ /**
3207
+ * Name of the appointment
3208
+ * @minLength 1
3209
+ * @maxLength 400
3210
+ */
2720
3211
  name?: string | null;
2721
- /** Duration of the appointment in minutes */
3212
+ /**
3213
+ * Duration of the appointment in minutes
3214
+ * @min 1
3215
+ * @max 44639
3216
+ */
2722
3217
  durationInMinutes?: number | null;
2723
3218
  /** Indicates whether manual approval is required for the appointment */
2724
3219
  manualApprovalRequired?: boolean | null;
2725
- /** ID of the staff members providing the appointment */
3220
+ /**
3221
+ * ID of the staff members providing the appointment
3222
+ * @maxSize 220
3223
+ * @format GUID
3224
+ */
2726
3225
  staffIds?: string[] | null;
2727
3226
  /** The format of the appointment */
2728
3227
  format?: Format;
@@ -2737,16 +3236,28 @@ export interface AppointmentFormatInfoOneOf {
2737
3236
  phoneOptions?: PhoneOptions;
2738
3237
  }
2739
3238
  export interface Location extends LocationLocationInfoOneOf {
2740
- /** Custom address details */
3239
+ /**
3240
+ * Custom address details
3241
+ * @maxLength 512
3242
+ */
2741
3243
  customAddress?: string | null;
2742
- /** ID of a business location */
3244
+ /**
3245
+ * ID of a business location
3246
+ * @format GUID
3247
+ */
2743
3248
  businessLocationId?: string | null;
2744
3249
  }
2745
3250
  /** @oneof */
2746
3251
  export interface LocationLocationInfoOneOf {
2747
- /** Custom address details */
3252
+ /**
3253
+ * Custom address details
3254
+ * @maxLength 512
3255
+ */
2748
3256
  customAddress?: string | null;
2749
- /** ID of a business location */
3257
+ /**
3258
+ * ID of a business location
3259
+ * @format GUID
3260
+ */
2750
3261
  businessLocationId?: string | null;
2751
3262
  }
2752
3263
  export declare enum Format {
@@ -2756,15 +3267,25 @@ export declare enum Format {
2756
3267
  PHONE = "PHONE"
2757
3268
  }
2758
3269
  export interface InPersonOptions {
2759
- /** The locations details */
3270
+ /**
3271
+ * The locations details
3272
+ * @minSize 1
3273
+ * @maxSize 500
3274
+ */
2760
3275
  locations?: Location[];
2761
3276
  }
2762
3277
  export interface VideoConferenceOptions {
2763
- /** Description or instructions for the online video conference */
3278
+ /**
3279
+ * Description or instructions for the online video conference
3280
+ * @maxLength 512
3281
+ */
2764
3282
  description?: string | null;
2765
3283
  }
2766
3284
  export interface PhoneOptions {
2767
- /** Description or instructions for the phone appointment */
3285
+ /**
3286
+ * Description or instructions for the phone appointment
3287
+ * @maxLength 512
3288
+ */
2768
3289
  description?: string | null;
2769
3290
  }
2770
3291
  export declare enum MultilineAddressComponentType {
@@ -2772,7 +3293,10 @@ export declare enum MultilineAddressComponentType {
2772
3293
  MULTILINE_ADDRESS = "MULTILINE_ADDRESS"
2773
3294
  }
2774
3295
  export interface MultilineAddress {
2775
- /** Label of the field. */
3296
+ /**
3297
+ * Label of the field.
3298
+ * @maxLength 350
3299
+ */
2776
3300
  label?: string | null;
2777
3301
  /** Description of the field. */
2778
3302
  description?: RichContent;
@@ -2798,14 +3322,20 @@ export interface AddressLine2 {
2798
3322
  show?: boolean;
2799
3323
  }
2800
3324
  export interface DefaultCountryConfig extends DefaultCountryConfigOptionsOneOf {
2801
- /** Country. */
3325
+ /**
3326
+ * Country.
3327
+ * @format COUNTRY
3328
+ */
2802
3329
  countryOptions?: string;
2803
3330
  /** Default country type. */
2804
3331
  type?: Type;
2805
3332
  }
2806
3333
  /** @oneof */
2807
3334
  export interface DefaultCountryConfigOptionsOneOf {
2808
- /** Country. */
3335
+ /**
3336
+ * Country.
3337
+ * @format COUNTRY
3338
+ */
2809
3339
  countryOptions?: string;
2810
3340
  }
2811
3341
  export interface FieldsSettings {
@@ -2895,7 +3425,11 @@ export interface AddressInfo {
2895
3425
  tag?: Tag;
2896
3426
  }
2897
3427
  export interface CustomFieldInfo {
2898
- /** Custom field key. */
3428
+ /**
3429
+ * Custom field key.
3430
+ * @minLength 1
3431
+ * @maxLength 500
3432
+ */
2899
3433
  key?: string;
2900
3434
  }
2901
3435
  export interface SubscriptionInfo {
@@ -3114,7 +3648,12 @@ export interface InputField extends InputFieldInputTypeOptionsOneOf {
3114
3648
  multilineAddressOptions?: InputFieldMultilineAddress;
3115
3649
  /** Input returns scheduling as value. */
3116
3650
  schedulingOptions?: Scheduling;
3117
- /** Definition of a target where the value of field belongs. */
3651
+ /**
3652
+ * Definition of a target where the value of field belongs.
3653
+ * @minLength 1
3654
+ * @maxLength 200
3655
+ * @immutable
3656
+ */
3118
3657
  target?: string | null;
3119
3658
  /**
3120
3659
  * Mark the field as containing personal information. This will encrypt user data when storing it.
@@ -3186,17 +3725,33 @@ export interface RichContentOptions {
3186
3725
  richContent?: RichContent;
3187
3726
  }
3188
3727
  export interface PageNavigationOptions {
3189
- /** When button is not on last page it behaves as switch between pages page, text of label to go to next page. */
3728
+ /**
3729
+ * When button is not on last page it behaves as switch between pages page, text of label to go to next page.
3730
+ * @maxLength 65
3731
+ */
3190
3732
  nextPageText?: string | null;
3191
- /** When button is not on last page it behaves as switch between pages page, text of label to go to previous page. */
3733
+ /**
3734
+ * When button is not on last page it behaves as switch between pages page, text of label to go to previous page.
3735
+ * @maxLength 65
3736
+ */
3192
3737
  previousPageText?: string | null;
3193
- /** Text on the button when button is submitting a form */
3738
+ /**
3739
+ * Text on the button when button is submitting a form
3740
+ * @maxLength 65
3741
+ */
3194
3742
  submitText?: string | null;
3195
3743
  }
3196
3744
  export interface Step {
3197
- /** Step ID. */
3745
+ /**
3746
+ * Step ID.
3747
+ * @format GUID
3748
+ * @immutable
3749
+ */
3198
3750
  id?: string;
3199
- /** Name of the step. */
3751
+ /**
3752
+ * Name of the step.
3753
+ * @maxLength 200
3754
+ */
3200
3755
  name?: string | null;
3201
3756
  /** Is step hidden */
3202
3757
  hidden?: boolean;
@@ -3212,7 +3767,10 @@ export interface FormLayout {
3212
3767
  small?: BreakPoint;
3213
3768
  }
3214
3769
  export interface BreakPoint {
3215
- /** Description of layouts for items. */
3770
+ /**
3771
+ * Description of layouts for items.
3772
+ * @maxSize 500
3773
+ */
3216
3774
  items?: ItemLayout[];
3217
3775
  /** Amount of columns of layout grid. */
3218
3776
  columns?: number | null;
@@ -3222,11 +3780,17 @@ export interface BreakPoint {
3222
3780
  margin?: Margin;
3223
3781
  /** Description of elements paddings. */
3224
3782
  padding?: Margin;
3225
- /** Sections of the layout, which allow manage fields */
3783
+ /**
3784
+ * Sections of the layout, which allow manage fields
3785
+ * @maxSize 100
3786
+ */
3226
3787
  sections?: Section[];
3227
3788
  }
3228
3789
  export interface ItemLayout extends ItemLayoutItemOneOf {
3229
- /** Form field reference id. */
3790
+ /**
3791
+ * Form field reference id.
3792
+ * @format GUID
3793
+ */
3230
3794
  fieldId?: string;
3231
3795
  /** Group info, defining that this item is a group of multiple fields */
3232
3796
  group?: Group;
@@ -3241,15 +3805,25 @@ export interface ItemLayout extends ItemLayoutItemOneOf {
3241
3805
  }
3242
3806
  /** @oneof */
3243
3807
  export interface ItemLayoutItemOneOf {
3244
- /** Form field reference id. */
3808
+ /**
3809
+ * Form field reference id.
3810
+ * @format GUID
3811
+ */
3245
3812
  fieldId?: string;
3246
3813
  /** Group info, defining that this item is a group of multiple fields */
3247
3814
  group?: Group;
3248
3815
  }
3249
3816
  export interface Group {
3250
- /** Field group reference id. */
3817
+ /**
3818
+ * Field group reference id.
3819
+ * @format GUID
3820
+ */
3251
3821
  groupId?: string;
3252
- /** Description of layouts for items. */
3822
+ /**
3823
+ * Description of layouts for items.
3824
+ * @minSize 1
3825
+ * @maxSize 500
3826
+ */
3253
3827
  items?: ItemLayout[];
3254
3828
  }
3255
3829
  export interface Margin {
@@ -3259,7 +3833,11 @@ export interface Margin {
3259
3833
  vertical?: number | null;
3260
3834
  }
3261
3835
  export interface Section {
3262
- /** Id of the section */
3836
+ /**
3837
+ * Id of the section
3838
+ * @format GUID
3839
+ * @minLength 1
3840
+ */
3263
3841
  id?: string;
3264
3842
  /** Horizontal coordinate in the grid. */
3265
3843
  row?: number | null;
@@ -3269,20 +3847,30 @@ export interface Section {
3269
3847
  * If the section encounters the $new key within the list,
3270
3848
  * it allows the inclusion of fields not explicitly listed,
3271
3849
  * enabling dynamic addition of new fields.
3850
+ * @maxSize 100
3851
+ * @maxLength 100
3272
3852
  */
3273
3853
  allowedFieldIds?: string[];
3274
3854
  }
3275
3855
  export interface FormRule {
3276
- /** Id of the rule */
3856
+ /**
3857
+ * Id of the rule
3858
+ * @format GUID
3859
+ * @immutable
3860
+ */
3277
3861
  id?: string;
3278
3862
  /** Rule on which item properties or layouts will be changed. */
3279
3863
  condition?: Record<string, any> | null;
3280
3864
  /**
3281
3865
  * Form items with defined properties that will be
3282
3866
  * changed when given condition is resolved to true.
3867
+ * @maxSize 500
3283
3868
  */
3284
3869
  overrides?: FormOverride[];
3285
- /** Name of the rule */
3870
+ /**
3871
+ * Name of the rule
3872
+ * @maxLength 200
3873
+ */
3286
3874
  name?: string | null;
3287
3875
  }
3288
3876
  export declare enum OverrideEntityType {
@@ -3290,15 +3878,28 @@ export declare enum OverrideEntityType {
3290
3878
  FIELD = "FIELD"
3291
3879
  }
3292
3880
  export interface FormOverride {
3293
- /** Override entity type. */
3881
+ /**
3882
+ * Override entity type.
3883
+ * @immutable
3884
+ */
3294
3885
  entityType?: OverrideEntityType;
3295
- /** Overridden entity id. Either fieldId, or "{fieldIdWithNestedForm}/{nestedFormFieldId}" */
3886
+ /**
3887
+ * Overridden entity id. Either fieldId, or "{fieldIdWithNestedForm}/{nestedFormFieldId}"
3888
+ * @immutable
3889
+ * @maxLength 73
3890
+ */
3296
3891
  entityId?: string | null;
3297
3892
  /** Form entity properties path with new value, that will be changed on condition. */
3298
3893
  valueChanges?: Record<string, any>;
3299
3894
  }
3300
3895
  export interface FormProperties {
3301
- /** Form name. */
3896
+ /**
3897
+ * Form name.
3898
+ * @maxLength 200
3899
+ * @deprecated
3900
+ * @replacedBy wix.forms.v4.Form.name
3901
+ * @targetRemovalDate 2026-01-06
3902
+ */
3302
3903
  name?: string | null;
3303
3904
  /**
3304
3905
  * Identifies if the form is disabled.
@@ -3319,17 +3920,27 @@ export interface PostSubmissionTriggers {
3319
3920
  upsertContact?: UpsertContact;
3320
3921
  }
3321
3922
  export interface UpsertContact {
3322
- /** Fields mapping (target field mapped to corresponding contact field). */
3923
+ /**
3924
+ * Fields mapping (target field mapped to corresponding contact field).
3925
+ * @maxSize 250
3926
+ */
3323
3927
  fieldsMapping?: Record<string, FormFieldContactInfo>;
3324
3928
  /**
3325
3929
  * List of contact label keys.
3326
3930
  * [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
3327
3931
  * help categorize contacts.
3932
+ * @minLength 1
3933
+ * @maxLength 100
3934
+ * @maxSize 20
3328
3935
  */
3329
3936
  labels?: string[];
3330
3937
  }
3331
3938
  export interface NestedForm {
3332
- /** Targets which have this form. */
3939
+ /**
3940
+ * Targets which have this form.
3941
+ * @maxSize 10
3942
+ * @maxLength 200
3943
+ */
3333
3944
  targets?: string[];
3334
3945
  /** Nested form. */
3335
3946
  form?: Form;
@@ -3396,28 +4007,44 @@ export interface ThankYouMessageOptions {
3396
4007
  richContent?: RichContent;
3397
4008
  }
3398
4009
  export interface RedirectOptions {
3399
- /** The URL to which the user should be redirected after a successful form submission. */
4010
+ /**
4011
+ * The URL to which the user should be redirected after a successful form submission.
4012
+ * @maxLength 2000
4013
+ */
3400
4014
  redirectUrl?: string | null;
3401
4015
  /** How the URL should be opened. */
3402
4016
  target?: Target;
3403
4017
  }
3404
4018
  export interface FieldGroup {
3405
- /** Id of group, on layout */
4019
+ /**
4020
+ * Id of group, on layout
4021
+ * @format GUID
4022
+ */
3406
4023
  id?: string;
3407
- /** Label of group */
4024
+ /**
4025
+ * Label of group
4026
+ * @maxLength 350
4027
+ */
3408
4028
  label?: string | null;
3409
4029
  }
3410
4030
  export interface CreateCheckoutFromSubmissionResponse {
3411
- /** Checkout ID (applicable for form involving payments). */
4031
+ /**
4032
+ * Checkout ID (applicable for form involving payments).
4033
+ * @format GUID
4034
+ */
3412
4035
  checkoutId?: string | null;
3413
4036
  /** Checkout (applicable for form involving payments). */
3414
4037
  checkout?: Checkout;
3415
4038
  }
3416
4039
  export interface Checkout {
3417
- /** Checkout ID. */
4040
+ /**
4041
+ * Checkout ID.
4042
+ * @format GUID
4043
+ */
3418
4044
  id?: string;
3419
4045
  /**
3420
4046
  * The currency used when submitting the order.
4047
+ * @format CURRENCY
3421
4048
  * @readonly
3422
4049
  */
3423
4050
  currency?: string;
@@ -3501,9 +4128,15 @@ export interface ActionEvent {
3501
4128
  export interface Empty {
3502
4129
  }
3503
4130
  export interface MessageEnvelope {
3504
- /** App instance ID. */
4131
+ /**
4132
+ * App instance ID.
4133
+ * @format GUID
4134
+ */
3505
4135
  instanceId?: string | null;
3506
- /** Event type. */
4136
+ /**
4137
+ * Event type.
4138
+ * @maxLength 150
4139
+ */
3507
4140
  eventType?: string;
3508
4141
  /** The identification type and identity data. */
3509
4142
  identity?: IdentificationData;
@@ -3511,26 +4144,50 @@ export interface MessageEnvelope {
3511
4144
  data?: string;
3512
4145
  }
3513
4146
  export interface IdentificationData extends IdentificationDataIdOneOf {
3514
- /** ID of a site visitor that has not logged in to the site. */
4147
+ /**
4148
+ * ID of a site visitor that has not logged in to the site.
4149
+ * @format GUID
4150
+ */
3515
4151
  anonymousVisitorId?: string;
3516
- /** ID of a site visitor that has logged in to the site. */
4152
+ /**
4153
+ * ID of a site visitor that has logged in to the site.
4154
+ * @format GUID
4155
+ */
3517
4156
  memberId?: string;
3518
- /** ID of a Wix user (site owner, contributor, etc.). */
4157
+ /**
4158
+ * ID of a Wix user (site owner, contributor, etc.).
4159
+ * @format GUID
4160
+ */
3519
4161
  wixUserId?: string;
3520
- /** ID of an app. */
4162
+ /**
4163
+ * ID of an app.
4164
+ * @format GUID
4165
+ */
3521
4166
  appId?: string;
3522
4167
  /** @readonly */
3523
4168
  identityType?: WebhookIdentityType;
3524
4169
  }
3525
4170
  /** @oneof */
3526
4171
  export interface IdentificationDataIdOneOf {
3527
- /** ID of a site visitor that has not logged in to the site. */
4172
+ /**
4173
+ * ID of a site visitor that has not logged in to the site.
4174
+ * @format GUID
4175
+ */
3528
4176
  anonymousVisitorId?: string;
3529
- /** ID of a site visitor that has logged in to the site. */
4177
+ /**
4178
+ * ID of a site visitor that has logged in to the site.
4179
+ * @format GUID
4180
+ */
3530
4181
  memberId?: string;
3531
- /** ID of a Wix user (site owner, contributor, etc.). */
4182
+ /**
4183
+ * ID of a Wix user (site owner, contributor, etc.).
4184
+ * @format GUID
4185
+ */
3532
4186
  wixUserId?: string;
3533
- /** ID of an app. */
4187
+ /**
4188
+ * ID of an app.
4189
+ * @format GUID
4190
+ */
3534
4191
  appId?: string;
3535
4192
  }
3536
4193
  export declare enum WebhookIdentityType {
@@ -3540,10 +4197,63 @@ export declare enum WebhookIdentityType {
3540
4197
  WIX_USER = "WIX_USER",
3541
4198
  APP = "APP"
3542
4199
  }
4200
+ export interface UpsertContactFromSubmissionRequest {
4201
+ /**
4202
+ * Submission from which contact needs to be upserted.
4203
+ * @format GUID
4204
+ */
4205
+ submissionId: string;
4206
+ /**
4207
+ * Optional contact id to which submission should be mapped.
4208
+ * @format GUID
4209
+ */
4210
+ contactId?: string | null;
4211
+ /** Indicates contact has verified primary email. */
4212
+ emailVerified?: boolean;
4213
+ }
4214
+ export interface UpsertContactFromSubmissionResponse {
4215
+ /** Submit contact response. */
4216
+ submitContactResponse?: SubmitContactResponse;
4217
+ }
4218
+ export interface SubmitContactResponse {
4219
+ /**
4220
+ * ID of the contact that was found or created.
4221
+ * @format GUID
4222
+ */
4223
+ contactId?: string;
4224
+ /**
4225
+ * Identity type of the returned contact.
4226
+ *
4227
+ * - `CONTACT`: The returned contact ID belongs to a new or existing contact.
4228
+ * - `MEMBER`: The returned contact ID belongs to the currently logged-in site member.
4229
+ * - `NOT_AUTHENTICATED_MEMBER`: The returned contact ID belongs to a site member who is not currently logged in.
4230
+ */
4231
+ identityType?: IdentityType;
4232
+ /**
4233
+ * Indicates whether the contact was just created or already existed.
4234
+ *
4235
+ * If the contact was just created, returns `true`.
4236
+ * If it already existed, returns `false`.
4237
+ */
4238
+ newContact?: boolean;
4239
+ }
4240
+ export declare enum IdentityType {
4241
+ UNKNOWN = "UNKNOWN",
4242
+ /** Existing or new contact */
4243
+ CONTACT = "CONTACT",
4244
+ /** Member is logged in, matching logic skipped */
4245
+ MEMBER = "MEMBER",
4246
+ /** Matching contact is a member, Merge logic won't be applied */
4247
+ NOT_AUTHENTICATED_MEMBER = "NOT_AUTHENTICATED_MEMBER"
4248
+ }
3543
4249
  export interface CreateSubmissionRequest {
3544
4250
  /** Submission to create. */
3545
4251
  submission: FormSubmission;
3546
- /** Captcha token. */
4252
+ /**
4253
+ * Captcha token.
4254
+ * @minLength 1
4255
+ * @maxLength 3000
4256
+ */
3547
4257
  captchaToken?: string | null;
3548
4258
  }
3549
4259
  export interface CreateSubmissionResponse {
@@ -3551,15 +4261,24 @@ export interface CreateSubmissionResponse {
3551
4261
  submission?: FormSubmission;
3552
4262
  }
3553
4263
  export interface SubmissionValidationErrorsDetails {
3554
- /** Submission validation errors details. */
4264
+ /**
4265
+ * Submission validation errors details.
4266
+ * @maxSize 100
4267
+ */
3555
4268
  errors?: ValidationError[];
3556
4269
  }
3557
4270
  export interface ValidationError {
3558
- /** Path indicating the source of the error, such as `submission.submissions.email`` */
4271
+ /**
4272
+ * Path indicating the source of the error, such as `submission.submissions.email``
4273
+ * @maxLength 1000
4274
+ */
3559
4275
  errorPath?: string;
3560
4276
  /** Error type. */
3561
4277
  errorType?: ErrorType;
3562
- /** Error message. */
4278
+ /**
4279
+ * Error message.
4280
+ * @maxLength 1000
4281
+ */
3563
4282
  errorMessage?: string;
3564
4283
  /** Additional error parameters, to help identify additional info. */
3565
4284
  params?: Record<string, any> | null;
@@ -3633,16 +4352,23 @@ export interface CreateSubmissionBySubmitterResponse {
3633
4352
  submission?: FormSubmission;
3634
4353
  }
3635
4354
  export interface BulkCreateSubmissionBySubmitterRequest {
3636
- /** Form id. Restricts submissions creation for a single form. */
4355
+ /**
4356
+ * Form id. Restricts submissions creation for a single form.
4357
+ * @format GUID
4358
+ */
3637
4359
  formId: string;
3638
4360
  /**
3639
4361
  * Submissions to create.
3640
4362
  * Deprecated
4363
+ * @maxSize 100
3641
4364
  */
3642
4365
  submissions?: FormSubmission[];
3643
4366
  /** When set, items will be returned on successful create. */
3644
4367
  returnEntity?: boolean;
3645
- /** Submissions data to create. */
4368
+ /**
4369
+ * Submissions data to create.
4370
+ * @maxSize 100
4371
+ */
3646
4372
  submissionsV2?: BulkCreateSubmissionBySubmitterData[];
3647
4373
  /** Validation will be mode is more forgiving, for example "required" won't be validated. */
3648
4374
  lenientValidation?: boolean;
@@ -3666,7 +4392,10 @@ export interface BulkSubmissionResult {
3666
4392
  item?: FormSubmission;
3667
4393
  }
3668
4394
  export interface ItemMetadata {
3669
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4395
+ /**
4396
+ * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
4397
+ * @format GUID
4398
+ */
3670
4399
  id?: string | null;
3671
4400
  /** Index of the item within the request array. Allows for correlation between request and response items. */
3672
4401
  originalIndex?: number;
@@ -3692,7 +4421,10 @@ export interface BulkActionMetadata {
3692
4421
  undetailedFailures?: number;
3693
4422
  }
3694
4423
  export interface GetSubmissionRequest {
3695
- /** ID of the submission to retrieve. */
4424
+ /**
4425
+ * ID of the submission to retrieve.
4426
+ * @format GUID
4427
+ */
3696
4428
  submissionId: string;
3697
4429
  }
3698
4430
  export interface GetSubmissionResponse {
@@ -3700,7 +4432,10 @@ export interface GetSubmissionResponse {
3700
4432
  submission?: FormSubmission;
3701
4433
  }
3702
4434
  export interface GetSubmissionByCheckoutIdRequest {
3703
- /** Checkout ID of the submission to retrieve. */
4435
+ /**
4436
+ * Checkout ID of the submission to retrieve.
4437
+ * @format GUID
4438
+ */
3704
4439
  checkoutId?: string;
3705
4440
  }
3706
4441
  export interface GetSubmissionByCheckoutIdResponse {
@@ -3716,7 +4451,10 @@ export interface UpdateSubmissionResponse {
3716
4451
  submission?: FormSubmission;
3717
4452
  }
3718
4453
  export interface ConfirmSubmissionRequest {
3719
- /** Submission ID to confirm. */
4454
+ /**
4455
+ * Submission ID to confirm.
4456
+ * @format GUID
4457
+ */
3720
4458
  submissionId: string;
3721
4459
  }
3722
4460
  export interface ConfirmSubmissionResponse {
@@ -3724,7 +4462,10 @@ export interface ConfirmSubmissionResponse {
3724
4462
  submission?: FormSubmission;
3725
4463
  }
3726
4464
  export interface DeleteSubmissionRequest {
3727
- /** ID of the submission to delete. */
4465
+ /**
4466
+ * ID of the submission to delete.
4467
+ * @format GUID
4468
+ */
3728
4469
  submissionId: string;
3729
4470
  /**
3730
4471
  * Whether to permanently delete a submission bypassing the trash bin.
@@ -3738,9 +4479,17 @@ export interface DeleteSubmissionRequest {
3738
4479
  export interface DeleteSubmissionResponse {
3739
4480
  }
3740
4481
  export interface BulkDeleteSubmissionRequest {
3741
- /** Form ID. */
4482
+ /**
4483
+ * Form ID.
4484
+ * @format GUID
4485
+ */
3742
4486
  formId: string;
3743
- /** Submission ids. */
4487
+ /**
4488
+ * Submission ids.
4489
+ * @minSize 1
4490
+ * @maxSize 100
4491
+ * @format GUID
4492
+ */
3744
4493
  submissionIds?: string[];
3745
4494
  /**
3746
4495
  * Delete submission bypassing trash-bin
@@ -3751,7 +4500,11 @@ export interface BulkDeleteSubmissionRequest {
3751
4500
  preserveFiles?: boolean;
3752
4501
  }
3753
4502
  export interface BulkDeleteSubmissionResponse {
3754
- /** Results of bulk submission delete */
4503
+ /**
4504
+ * Results of bulk submission delete
4505
+ * @minSize 1
4506
+ * @maxSize 100
4507
+ */
3755
4508
  results?: BulkDeleteSubmissionResult[];
3756
4509
  /** Metadata of request */
3757
4510
  bulkActionMetadata?: BulkActionMetadata;
@@ -3761,7 +4514,10 @@ export interface BulkDeleteSubmissionResult {
3761
4514
  itemMetadata?: ItemMetadata;
3762
4515
  }
3763
4516
  export interface RestoreSubmissionFromTrashBinRequest {
3764
- /** ID of the submission to restore. */
4517
+ /**
4518
+ * ID of the submission to restore.
4519
+ * @format GUID
4520
+ */
3765
4521
  submissionId: string;
3766
4522
  }
3767
4523
  export interface RestoreSubmissionFromTrashBinResponse {
@@ -3769,19 +4525,33 @@ export interface RestoreSubmissionFromTrashBinResponse {
3769
4525
  submission?: FormSubmission;
3770
4526
  }
3771
4527
  export interface RemoveSubmissionFromTrashBinRequest {
3772
- /** ID of the submission to restore. */
4528
+ /**
4529
+ * ID of the submission to restore.
4530
+ * @format GUID
4531
+ */
3773
4532
  submissionId: string;
3774
4533
  }
3775
4534
  export interface RemoveSubmissionFromTrashBinResponse {
3776
4535
  }
3777
4536
  export interface BulkRemoveSubmissionFromTrashBinRequest {
3778
- /** Form ID. */
4537
+ /**
4538
+ * Form ID.
4539
+ * @format GUID
4540
+ */
3779
4541
  formId: string;
3780
- /** Submission ids. */
4542
+ /**
4543
+ * Submission ids.
4544
+ * @minSize 1
4545
+ * @maxSize 100
4546
+ * @format GUID
4547
+ */
3781
4548
  submissionIds?: string[];
3782
4549
  }
3783
4550
  export interface BulkRemoveSubmissionFromTrashBinResponse {
3784
- /** Results of bulk submission removal from trash */
4551
+ /**
4552
+ * Results of bulk submission removal from trash
4553
+ * @maxSize 100
4554
+ */
3785
4555
  results?: BulkRemoveSubmissionFromTrashBinResult[];
3786
4556
  /** Metadata of request */
3787
4557
  bulkActionMetadata?: BulkActionMetadata;
@@ -3791,20 +4561,31 @@ export interface BulkRemoveSubmissionFromTrashBinResult {
3791
4561
  itemMetadata?: ItemMetadata;
3792
4562
  }
3793
4563
  export interface ListDeletedSubmissionsRequest {
3794
- /** Form ID. */
4564
+ /**
4565
+ * Form ID.
4566
+ * @format GUID
4567
+ */
3795
4568
  formId: string;
3796
- /** Submission ids. */
4569
+ /**
4570
+ * Submission ids.
4571
+ * @maxSize 10
4572
+ * @format GUID
4573
+ */
3797
4574
  submissionIds?: string[];
3798
4575
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not filter or `order`. */
3799
4576
  paging?: CursorPaging;
3800
4577
  /**
3801
4578
  * List of statuses of submissions which should be returned
3802
4579
  * Default: CONFIRMED
4580
+ * @maxSize 4
3803
4581
  */
3804
4582
  statuses?: SubmissionStatus[];
3805
4583
  }
3806
4584
  export interface CursorPaging {
3807
- /** Number of items to load. */
4585
+ /**
4586
+ * Number of items to load.
4587
+ * @max 100
4588
+ */
3808
4589
  limit?: number | null;
3809
4590
  /**
3810
4591
  * Pointer to the next or previous page in the list of results.
@@ -3812,6 +4593,7 @@ export interface CursorPaging {
3812
4593
  * You can get the relevant cursor token
3813
4594
  * from the `pagingMetadata` object in the previous call's response.
3814
4595
  * Not relevant for the first request.
4596
+ * @maxLength 16000
3815
4597
  */
3816
4598
  cursor?: string | null;
3817
4599
  }
@@ -3834,13 +4616,22 @@ export interface CursorPagingMetadata {
3834
4616
  hasNext?: boolean | null;
3835
4617
  }
3836
4618
  export interface Cursors {
3837
- /** Cursor pointing to next page in the list of results. */
4619
+ /**
4620
+ * Cursor pointing to next page in the list of results.
4621
+ * @maxLength 16000
4622
+ */
3838
4623
  next?: string | null;
3839
- /** Cursor pointing to previous page in the list of results. */
4624
+ /**
4625
+ * Cursor pointing to previous page in the list of results.
4626
+ * @maxLength 16000
4627
+ */
3840
4628
  prev?: string | null;
3841
4629
  }
3842
4630
  export interface GetDeletedSubmissionRequest {
3843
- /** Submission id. */
4631
+ /**
4632
+ * Submission id.
4633
+ * @format GUID
4634
+ */
3844
4635
  submissionId: string;
3845
4636
  }
3846
4637
  export interface GetDeletedSubmissionResponse {
@@ -3868,6 +4659,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
3868
4659
  /**
3869
4660
  * Sort object in the following format:
3870
4661
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
4662
+ * @maxSize 3
3871
4663
  */
3872
4664
  sort?: Sorting[];
3873
4665
  }
@@ -3877,7 +4669,10 @@ export interface CursorQueryPagingMethodOneOf {
3877
4669
  cursorPaging?: CursorPaging;
3878
4670
  }
3879
4671
  export interface Sorting {
3880
- /** Name of the field to sort by. */
4672
+ /**
4673
+ * Name of the field to sort by.
4674
+ * @maxLength 512
4675
+ */
3881
4676
  fieldName?: string;
3882
4677
  /** Sort order. */
3883
4678
  order?: SortOrder;
@@ -3904,7 +4699,10 @@ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
3904
4699
  cursorPaging?: CursorPaging;
3905
4700
  /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
3906
4701
  filter?: Record<string, any> | null;
3907
- /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
4702
+ /**
4703
+ * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
4704
+ * @maxSize 10
4705
+ */
3908
4706
  sort?: Sorting[];
3909
4707
  /** Free text to match in searchable fields */
3910
4708
  search?: SearchDetails;
@@ -3920,7 +4718,10 @@ export interface CursorSearchPagingMethodOneOf {
3920
4718
  export interface SearchDetails {
3921
4719
  /** Defines how separate search terms in `expression` are combined */
3922
4720
  mode?: Mode;
3923
- /** Search term or expression */
4721
+ /**
4722
+ * Search term or expression
4723
+ * @maxLength 100
4724
+ */
3924
4725
  expression?: string | null;
3925
4726
  /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
3926
4727
  fuzzy?: boolean;
@@ -3980,7 +4781,10 @@ export interface CountSubmissionsByFilterResponse {
3980
4781
  formsSubmissionsCount?: FormSubmissionsCount[];
3981
4782
  }
3982
4783
  export interface FormSubmissionsCount {
3983
- /** Form ID. */
4784
+ /**
4785
+ * Form ID.
4786
+ * @format GUID
4787
+ */
3984
4788
  formId?: string;
3985
4789
  /** Total number of submissions. */
3986
4790
  totalCount?: number;
@@ -3988,13 +4792,23 @@ export interface FormSubmissionsCount {
3988
4792
  unseenCount?: number;
3989
4793
  }
3990
4794
  export interface CountSubmissionsRequest {
3991
- /** Form IDs. */
4795
+ /**
4796
+ * Form IDs.
4797
+ * @format GUID
4798
+ * @minSize 1
4799
+ * @maxSize 100
4800
+ */
3992
4801
  formIds: string[];
3993
- /** Identifies the app which the form submissions belong to. For example, the namespace for the Wix Forms App is `"wix.form_app.form"`. The namespace of a submission can be retrieved using the Get Submission endpoint. */
4802
+ /**
4803
+ * Identifies the app which the form submissions belong to. For example, the namespace for the Wix Forms App is `"wix.form_app.form"`. The namespace of a submission can be retrieved using the Get Submission endpoint.
4804
+ * @minLength 10
4805
+ * @maxLength 50
4806
+ */
3994
4807
  namespace: string;
3995
4808
  /**
3996
4809
  * List of statuses of submissions which should be taken into count
3997
4810
  * Default: CONFIRMED, PAYMENT_WAITING, PAYMENT_CANCELED
4811
+ * @maxSize 4
3998
4812
  */
3999
4813
  statuses?: SubmissionStatus[];
4000
4814
  }
@@ -4003,13 +4817,23 @@ export interface CountSubmissionsResponse {
4003
4817
  formsSubmissionsCount?: FormSubmissionsCount[];
4004
4818
  }
4005
4819
  export interface CountDeletedSubmissionsRequest {
4006
- /** Form IDs. */
4820
+ /**
4821
+ * Form IDs.
4822
+ * @format GUID
4823
+ * @minSize 1
4824
+ * @maxSize 100
4825
+ */
4007
4826
  formIds: string[];
4008
- /** Identifies the app which the form submissions belong to. For example, the namespace for the Wix Forms App is `"wix.form_app.form"`. The namespace of a submission can be retrieved using the Get Submission endpoint. */
4827
+ /**
4828
+ * Identifies the app which the form submissions belong to. For example, the namespace for the Wix Forms App is `"wix.form_app.form"`. The namespace of a submission can be retrieved using the Get Submission endpoint.
4829
+ * @minLength 10
4830
+ * @maxLength 50
4831
+ */
4009
4832
  namespace: string;
4010
4833
  /**
4011
4834
  * List of statuses of submissions which should be taken into count
4012
4835
  * Default: CONFIRMED, PAYMENT_WAITING, PAYMENT_CANCELED
4836
+ * @maxSize 4
4013
4837
  */
4014
4838
  statuses?: SubmissionStatus[];
4015
4839
  }
@@ -4018,37 +4842,61 @@ export interface CountDeletedSubmissionsResponse {
4018
4842
  formsDeletedSubmissionsCount?: FormDeletedSubmissionsCount[];
4019
4843
  }
4020
4844
  export interface FormDeletedSubmissionsCount {
4021
- /** Form ID. */
4845
+ /**
4846
+ * Form ID.
4847
+ * @format GUID
4848
+ */
4022
4849
  formId?: string;
4023
4850
  /** Total number of submissions. */
4024
4851
  totalCount?: number;
4025
4852
  }
4026
4853
  export interface GetMediaUploadURLRequest {
4027
- /** Form ID. */
4854
+ /**
4855
+ * Form ID.
4856
+ * @format GUID
4857
+ */
4028
4858
  formId: string;
4029
- /** Name of file to upload. */
4859
+ /**
4860
+ * Name of file to upload.
4861
+ * @maxLength 300
4862
+ */
4030
4863
  filename: string;
4031
4864
  /**
4032
4865
  * [Mime type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#) of file to upload.
4033
4866
  *
4034
4867
  * For example, `'image/png'`
4868
+ * @maxLength 100
4035
4869
  */
4036
4870
  mimeType: string;
4037
4871
  }
4038
4872
  export interface GetMediaUploadURLResponse {
4039
- /** Url to upload file. */
4873
+ /**
4874
+ * Url to upload file.
4875
+ * @maxLength 500
4876
+ */
4040
4877
  uploadUrl?: string;
4041
4878
  }
4042
4879
  export interface BulkMarkSubmissionsAsSeenRequest {
4043
- /** Submission IDs to mark as seen. */
4880
+ /**
4881
+ * Submission IDs to mark as seen.
4882
+ * @format GUID
4883
+ * @minSize 1
4884
+ * @maxSize 100
4885
+ */
4044
4886
  ids: string[];
4045
- /** ID of the form which the submissions belongs to. */
4887
+ /**
4888
+ * ID of the form which the submissions belongs to.
4889
+ * @format GUID
4890
+ */
4046
4891
  formId: string;
4047
4892
  }
4048
4893
  export interface BulkMarkSubmissionsAsSeenResponse {
4049
4894
  }
4050
4895
  export interface GetSubmissionDownloadUrlRequest {
4051
- /** Submission ID. */
4896
+ /**
4897
+ * Submission ID.
4898
+ * @format GUID
4899
+ */
4052
4900
  submissionId: string;
4053
4901
  }
4054
4902
  export interface GetSubmissionDownloadUrlResponse {
@@ -4061,6 +4909,7 @@ export interface SubmissionDocument extends SubmissionDocumentDocumentOneOf {
4061
4909
  /**
4062
4910
  * Document ID.
4063
4911
  * @readonly
4912
+ * @maxLength 50
4064
4913
  */
4065
4914
  id?: string | null;
4066
4915
  /** Document status. */
@@ -4081,45 +4930,89 @@ export interface DocumentReady {
4081
4930
  /**
4082
4931
  * Document download URL.
4083
4932
  * @readonly
4933
+ * @maxLength 300
4084
4934
  */
4085
4935
  downloadUrl?: string;
4086
4936
  }
4087
4937
  export interface GetFormattedSubmissionRequest {
4088
- /** Submission ID. */
4938
+ /**
4939
+ * Submission ID.
4940
+ * @format GUID
4941
+ */
4089
4942
  submissionId?: string;
4090
4943
  }
4091
4944
  export interface GetFormattedSubmissionResponse {
4092
- /** Submission ID. */
4945
+ /**
4946
+ * Submission ID.
4947
+ * @format GUID
4948
+ */
4093
4949
  submissionId?: string;
4094
- /** Ordered by form layout list of field submissions. */
4950
+ /**
4951
+ * Ordered by form layout list of field submissions.
4952
+ * @maxSize 100
4953
+ */
4095
4954
  submissions?: FormattedSubmission[];
4096
4955
  }
4097
4956
  export interface FormattedSubmission {
4098
- /** Label of form field */
4957
+ /**
4958
+ * Label of form field
4959
+ * @maxLength 500
4960
+ */
4099
4961
  label?: string | null;
4100
- /** Key of the submission, and target of a form field */
4962
+ /**
4963
+ * Key of the submission, and target of a form field
4964
+ * @maxLength 200
4965
+ */
4101
4966
  key?: string;
4102
- /** Value of the submission, formatted as a string */
4967
+ /**
4968
+ * Value of the submission, formatted as a string
4969
+ * @maxLength 500
4970
+ */
4103
4971
  value?: string;
4104
- /** Id of the form field */
4972
+ /**
4973
+ * Id of the form field
4974
+ * @format GUID
4975
+ */
4105
4976
  fieldId?: string;
4106
4977
  }
4107
4978
  export interface ListFormattedSubmissionsRequest {
4108
- /** Namespace. */
4979
+ /**
4980
+ * Namespace.
4981
+ * @minLength 10
4982
+ * @maxLength 50
4983
+ */
4109
4984
  namespace?: string;
4110
- /** Submission IDs. */
4985
+ /**
4986
+ * Submission IDs.
4987
+ * @format GUID
4988
+ * @minSize 1
4989
+ * @maxSize 100
4990
+ */
4111
4991
  submissionIds?: string[];
4112
- /** Optional additional filter of form IDs. */
4992
+ /**
4993
+ * Optional additional filter of form IDs.
4994
+ * @format GUID
4995
+ * @maxSize 100
4996
+ */
4113
4997
  formIds?: string[];
4114
4998
  }
4115
4999
  export interface ListFormattedSubmissionsResponse {
4116
- /** List of formatted submissions */
5000
+ /**
5001
+ * List of formatted submissions
5002
+ * @maxSize 100
5003
+ */
4117
5004
  formattedFormSubmissions?: FormattedFormSubmission[];
4118
5005
  }
4119
5006
  export interface FormattedFormSubmission {
4120
- /** Submission ID. */
5007
+ /**
5008
+ * Submission ID.
5009
+ * @format GUID
5010
+ */
4121
5011
  submissionId?: string;
4122
- /** Ordered by form layout list of field submissions. */
5012
+ /**
5013
+ * Ordered by form layout list of field submissions.
5014
+ * @maxSize 100
5015
+ */
4123
5016
  submissions?: FormattedSubmission[];
4124
5017
  }
4125
5018
  export interface UpdateExtendedFieldsRequest {
@@ -4131,13 +5024,22 @@ export interface UpdateExtendedFieldsRequest {
4131
5024
  namespaceData: Record<string, any> | null;
4132
5025
  }
4133
5026
  export interface UpdateExtendedFieldsResponse {
4134
- /** namespace that was updated */
5027
+ /**
5028
+ * namespace that was updated
5029
+ * @minLength 10
5030
+ * @maxLength 50
5031
+ */
4135
5032
  namespace?: string;
4136
5033
  /** only data from UpdateExtendedFieldsRequest namespace_data */
4137
5034
  namespaceData?: Record<string, any> | null;
4138
5035
  }
4139
5036
  export interface BulkUpdateFormSubmissionTagsRequest {
4140
- /** Submission IDs to update tags for. */
5037
+ /**
5038
+ * Submission IDs to update tags for.
5039
+ * @format GUID
5040
+ * @minSize 1
5041
+ * @maxSize 100
5042
+ */
4141
5043
  submissionIds: string[];
4142
5044
  /** Tags to be added to submissions */
4143
5045
  assignTags?: PublicTags;
@@ -4145,7 +5047,11 @@ export interface BulkUpdateFormSubmissionTagsRequest {
4145
5047
  unassignTags?: PublicTags;
4146
5048
  }
4147
5049
  export interface BulkUpdateFormSubmissionTagsResponse {
4148
- /** Updated submissions with results */
5050
+ /**
5051
+ * Updated submissions with results
5052
+ * @minSize 1
5053
+ * @maxSize 100
5054
+ */
4149
5055
  results?: BulkUpdateFormSubmissionTagsResult[];
4150
5056
  /** Metadata of request */
4151
5057
  bulkActionMetadata?: BulkActionMetadata;
@@ -4163,7 +5069,10 @@ export interface BulkUpdateFormSubmissionTagsByFilterRequest {
4163
5069
  unassignTags?: PublicTags;
4164
5070
  }
4165
5071
  export interface BulkUpdateFormSubmissionTagsByFilterResponse {
4166
- /** Job id for the bulk update operation */
5072
+ /**
5073
+ * Job id for the bulk update operation
5074
+ * @format GUID
5075
+ */
4167
5076
  jobId?: string;
4168
5077
  }
4169
5078
  export interface ValidateFormSubmissionRequest {
@@ -4178,17 +5087,29 @@ export interface ValidateFormSubmissionResponse {
4178
5087
  * Default: true
4179
5088
  */
4180
5089
  valid?: boolean | null;
4181
- /** Submission validation violations */
5090
+ /**
5091
+ * Submission validation violations
5092
+ * @maxSize 100
5093
+ */
4182
5094
  violationErrors?: FieldViolation[];
4183
5095
  }
4184
5096
  export interface FieldViolation extends FieldViolationErrorDataOneOf {
4185
5097
  /** Validation errors */
4186
5098
  submissionValidationErrors?: SubmissionValidationErrors;
4187
- /** Name of violated entity */
5099
+ /**
5100
+ * Name of violated entity
5101
+ * @maxLength 50
5102
+ */
4188
5103
  name?: string;
4189
- /** Description of the error */
5104
+ /**
5105
+ * Description of the error
5106
+ * @maxLength 512
5107
+ */
4190
5108
  description?: string;
4191
- /** Rule name */
5109
+ /**
5110
+ * Rule name
5111
+ * @maxLength 50
5112
+ */
4192
5113
  ruleName?: string;
4193
5114
  }
4194
5115
  /** @oneof */
@@ -4197,15 +5118,24 @@ export interface FieldViolationErrorDataOneOf {
4197
5118
  submissionValidationErrors?: SubmissionValidationErrors;
4198
5119
  }
4199
5120
  export interface SubmissionValidationErrors {
4200
- /** Submission validation errors. */
5121
+ /**
5122
+ * Submission validation errors.
5123
+ * @maxSize 100
5124
+ */
4201
5125
  errors?: SubmissionValidationError[];
4202
5126
  }
4203
5127
  export interface SubmissionValidationError extends SubmissionValidationErrorErrorMessageOneOf {
4204
5128
  /** Predefined error type. */
4205
5129
  errorType?: SubmissionErrorType;
4206
- /** Custom error message. The message is displayed instead of an error type. */
5130
+ /**
5131
+ * Custom error message. The message is displayed instead of an error type.
5132
+ * @maxLength 500
5133
+ */
4207
5134
  customErrorMessage?: string;
4208
- /** Path indicating the source of the error, such as `form.fields.target`. */
5135
+ /**
5136
+ * Path indicating the source of the error, such as `form.fields.target`.
5137
+ * @maxLength 500
5138
+ */
4209
5139
  errorPath?: string;
4210
5140
  /** Additional error parameters. */
4211
5141
  params?: Record<string, any> | null;
@@ -4214,7 +5144,10 @@ export interface SubmissionValidationError extends SubmissionValidationErrorErro
4214
5144
  export interface SubmissionValidationErrorErrorMessageOneOf {
4215
5145
  /** Predefined error type. */
4216
5146
  errorType?: SubmissionErrorType;
4217
- /** Custom error message. The message is displayed instead of an error type. */
5147
+ /**
5148
+ * Custom error message. The message is displayed instead of an error type.
5149
+ * @maxLength 500
5150
+ */
4218
5151
  customErrorMessage?: string;
4219
5152
  }
4220
5153
  export declare enum SubmissionErrorType {
@@ -4249,45 +5182,13 @@ export declare enum SubmissionErrorType {
4249
5182
  /** Submitted form is disabled. */
4250
5183
  DISABLED_FORM_ERROR = "DISABLED_FORM_ERROR"
4251
5184
  }
4252
- export interface UpsertContactFromSubmissionRequest {
4253
- /** Submission from which contact needs to be upserted. */
4254
- submissionId: string;
4255
- /** Optional contact id to which submission should be mapped. */
4256
- contactId?: string | null;
4257
- /** Indicates contact has verified primary email. */
4258
- emailVerified?: boolean;
4259
- }
4260
- export interface UpsertContactFromSubmissionResponse {
4261
- /** Submit contact response. */
4262
- submitContactResponse?: SubmitContactResponse;
4263
- }
4264
- export interface SubmitContactResponse {
4265
- /** ID of the contact that was found or created. */
4266
- contactId?: string;
4267
- /**
4268
- * Identity type of the returned contact.
4269
- *
4270
- * - `CONTACT`: The returned contact ID belongs to a new or existing contact.
4271
- * - `MEMBER`: The returned contact ID belongs to the currently logged-in site member.
4272
- * - `NOT_AUTHENTICATED_MEMBER`: The returned contact ID belongs to a site member who is not currently logged in.
4273
- */
4274
- identityType?: IdentityType;
4275
- /**
4276
- * Indicates whether the contact was just created or already existed.
4277
- *
4278
- * If the contact was just created, returns `true`.
4279
- * If it already existed, returns `false`.
4280
- */
4281
- newContact?: boolean;
5185
+ interface SubmitContactResponseNonNullableFields {
5186
+ contactId: string;
5187
+ identityType: IdentityType;
5188
+ newContact: boolean;
4282
5189
  }
4283
- export declare enum IdentityType {
4284
- UNKNOWN = "UNKNOWN",
4285
- /** Existing or new contact */
4286
- CONTACT = "CONTACT",
4287
- /** Member is logged in, matching logic skipped */
4288
- MEMBER = "MEMBER",
4289
- /** Matching contact is a member, Merge logic won't be applied */
4290
- NOT_AUTHENTICATED_MEMBER = "NOT_AUTHENTICATED_MEMBER"
5190
+ export interface UpsertContactFromSubmissionResponseNonNullableFields {
5191
+ submitContactResponse?: SubmitContactResponseNonNullableFields;
4291
5192
  }
4292
5193
  interface OrderDetailsNonNullableFields {
4293
5194
  itemSubtotal: string;
@@ -4435,12 +5336,4 @@ interface FieldViolationNonNullableFields {
4435
5336
  export interface ValidateFormSubmissionResponseNonNullableFields {
4436
5337
  violationErrors: FieldViolationNonNullableFields[];
4437
5338
  }
4438
- interface SubmitContactResponseNonNullableFields {
4439
- contactId: string;
4440
- identityType: IdentityType;
4441
- newContact: boolean;
4442
- }
4443
- export interface UpsertContactFromSubmissionResponseNonNullableFields {
4444
- submitContactResponse?: SubmitContactResponseNonNullableFields;
4445
- }
4446
5339
  export {};