@wix/auto_sdk_forms_submissions 1.0.3 → 1.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. package/build/cjs/src/forms-v4-submission-submissions.context.d.ts +5 -4
  2. package/build/cjs/src/forms-v4-submission-submissions.context.js +4 -5
  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 +2 -2
  5. package/build/cjs/src/forms-v4-submission-submissions.http.js +54 -54
  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 +20 -10
  11. package/build/cjs/src/forms-v4-submission-submissions.public.js +7 -8
  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 +1214 -305
  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 +1303 -331
  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 +5 -4
  20. package/build/es/src/forms-v4-submission-submissions.context.js +3 -4
  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 +2 -2
  23. package/build/es/src/forms-v4-submission-submissions.http.js +52 -52
  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 +20 -10
  29. package/build/es/src/forms-v4-submission-submissions.public.js +5 -6
  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 +1214 -305
  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 +1303 -331
  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 -5
  38. package/build/internal/cjs/src/forms-v4-submission-submissions.context.js +4 -5
  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 +2 -2
  41. package/build/internal/cjs/src/forms-v4-submission-submissions.http.js +54 -54
  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 -10
  47. package/build/internal/cjs/src/forms-v4-submission-submissions.public.js +7 -8
  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 +1214 -305
  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 +1283 -332
  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 -5
  56. package/build/internal/es/src/forms-v4-submission-submissions.context.js +3 -4
  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 +2 -2
  59. package/build/internal/es/src/forms-v4-submission-submissions.http.js +52 -52
  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 -10
  65. package/build/internal/es/src/forms-v4-submission-submissions.public.js +5 -6
  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 +1214 -305
  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 +1283 -332
  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 {
@@ -1457,6 +1691,25 @@ export interface ImageData {
1457
1691
  caption?: string | null;
1458
1692
  /** Sets whether the image's download button is disabled. Defaults to `false`. */
1459
1693
  disableDownload?: boolean | null;
1694
+ /** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
1695
+ decorative?: boolean | null;
1696
+ /** Styling for the image. */
1697
+ styles?: ImageDataStyles;
1698
+ }
1699
+ export interface StylesBorder {
1700
+ /** Border width in pixels. */
1701
+ width?: number | null;
1702
+ /**
1703
+ * Border color as a hexadecimal value.
1704
+ * @format COLOR_HEX
1705
+ */
1706
+ color?: string | null;
1707
+ /** Border radius in pixels. */
1708
+ radius?: number | null;
1709
+ }
1710
+ export interface ImageDataStyles {
1711
+ /** Border attributes. */
1712
+ border?: StylesBorder;
1460
1713
  }
1461
1714
  export interface LinkPreviewData {
1462
1715
  /** Styling for the link preview's container. */
@@ -1603,13 +1856,22 @@ export declare enum BackgroundType {
1603
1856
  export interface Gradient {
1604
1857
  /** The gradient angle in degrees. */
1605
1858
  angle?: number | null;
1606
- /** The start color as a hexademical value. */
1859
+ /**
1860
+ * The start color as a hexademical value.
1861
+ * @format COLOR_HEX
1862
+ */
1607
1863
  startColor?: string | null;
1608
- /** The end color as a hexademical value. */
1864
+ /**
1865
+ * The end color as a hexademical value.
1866
+ * @format COLOR_HEX
1867
+ */
1609
1868
  lastColor?: string | null;
1610
1869
  }
1611
1870
  export interface Background extends BackgroundBackgroundOneOf {
1612
- /** The background color as a hexademical value. */
1871
+ /**
1872
+ * The background color as a hexademical value.
1873
+ * @format COLOR_HEX
1874
+ */
1613
1875
  color?: string | null;
1614
1876
  /** An image to use for the background. */
1615
1877
  image?: Media;
@@ -1620,7 +1882,10 @@ export interface Background extends BackgroundBackgroundOneOf {
1620
1882
  }
1621
1883
  /** @oneof */
1622
1884
  export interface BackgroundBackgroundOneOf {
1623
- /** The background color as a hexademical value. */
1885
+ /**
1886
+ * The background color as a hexademical value.
1887
+ * @format COLOR_HEX
1888
+ */
1624
1889
  color?: string | null;
1625
1890
  /** An image to use for the background. */
1626
1891
  image?: Media;
@@ -1932,17 +2197,32 @@ export declare enum VerticalAlignment {
1932
2197
  export interface CellStyle {
1933
2198
  /** Vertical alignment for the cell's text. */
1934
2199
  verticalAlignment?: VerticalAlignment;
1935
- /** Cell background color as a hexadecimal value. */
2200
+ /**
2201
+ * Cell background color as a hexadecimal value.
2202
+ * @format COLOR_HEX
2203
+ */
1936
2204
  backgroundColor?: string | null;
1937
2205
  }
1938
2206
  export interface BorderColors {
1939
- /** Left border color as a hexadecimal value. */
2207
+ /**
2208
+ * Left border color as a hexadecimal value.
2209
+ * @format COLOR_HEX
2210
+ */
1940
2211
  left?: string | null;
1941
- /** Right border color as a hexadecimal value. */
2212
+ /**
2213
+ * Right border color as a hexadecimal value.
2214
+ * @format COLOR_HEX
2215
+ */
1942
2216
  right?: string | null;
1943
- /** Top border color as a hexadecimal value. */
2217
+ /**
2218
+ * Top border color as a hexadecimal value.
2219
+ * @format COLOR_HEX
2220
+ */
1944
2221
  top?: string | null;
1945
- /** Bottom border color as a hexadecimal value. */
2222
+ /**
2223
+ * Bottom border color as a hexadecimal value.
2224
+ * @format COLOR_HEX
2225
+ */
1946
2226
  bottom?: string | null;
1947
2227
  }
1948
2228
  /**
@@ -2051,13 +2331,17 @@ export interface TextNodeStyle {
2051
2331
  lineHeight?: string | null;
2052
2332
  }
2053
2333
  export interface RadioGroup {
2054
- /** Label of the field */
2334
+ /**
2335
+ * Label of the field
2336
+ * @maxLength 350
2337
+ */
2055
2338
  label?: string | null;
2056
2339
  /** Description of the field */
2057
2340
  description?: RichContent;
2058
2341
  /**
2059
2342
  * Flag identifying to show option allowing input custom value
2060
2343
  * List of options to select from
2344
+ * @maxSize 400
2061
2345
  */
2062
2346
  options?: RadioGroupOption[];
2063
2347
  /**
@@ -2074,19 +2358,35 @@ export interface RadioGroup {
2074
2358
  numberOfColumns?: NumberOfColumns;
2075
2359
  }
2076
2360
  export interface RadioGroupOption {
2077
- /** Selectable option label */
2361
+ /**
2362
+ * Selectable option label
2363
+ * @maxLength 400
2364
+ */
2078
2365
  label?: string | null;
2079
- /** Selectable option value, which is saved to DB. */
2366
+ /**
2367
+ * Selectable option value, which is saved to DB.
2368
+ * @maxLength 20000
2369
+ */
2080
2370
  value?: string | null;
2081
2371
  /** Flag identifying that option should be selected by default */
2082
2372
  default?: boolean;
2083
- /** Option id. Used as binding for translations */
2373
+ /**
2374
+ * Option id. Used as binding for translations
2375
+ * @format GUID
2376
+ * @immutable
2377
+ */
2084
2378
  _id?: string;
2085
2379
  }
2086
2380
  export interface RadioGroupCustomOption {
2087
- /** Label of custom option input */
2381
+ /**
2382
+ * Label of custom option input
2383
+ * @maxLength 350
2384
+ */
2088
2385
  label?: string | null;
2089
- /** Placeholder of custom option input */
2386
+ /**
2387
+ * Placeholder of custom option input
2388
+ * @maxLength 100
2389
+ */
2090
2390
  placeholder?: string | null;
2091
2391
  }
2092
2392
  export declare enum NumberOfColumns {
@@ -2102,11 +2402,17 @@ export declare enum NumberOfColumns {
2102
2402
  THREE = "THREE"
2103
2403
  }
2104
2404
  export interface Dropdown {
2105
- /** Label of the field */
2405
+ /**
2406
+ * Label of the field
2407
+ * @maxLength 350
2408
+ */
2106
2409
  label?: string | null;
2107
2410
  /** Description of the field */
2108
2411
  description?: RichContent;
2109
- /** List of options to select from */
2412
+ /**
2413
+ * List of options to select from
2414
+ * @maxSize 400
2415
+ */
2110
2416
  options?: DropdownOption[];
2111
2417
  /**
2112
2418
  * Flag identifying to hide or not label
@@ -2115,27 +2421,49 @@ export interface Dropdown {
2115
2421
  showLabel?: boolean | null;
2116
2422
  /** Option which can be specified by UoU, enabled when this object is specified. */
2117
2423
  customOption?: DropdownCustomOption;
2118
- /** Placeholder of dropdown input */
2424
+ /**
2425
+ * Placeholder of dropdown input
2426
+ * @maxLength 100
2427
+ */
2119
2428
  placeholder?: string | null;
2120
2429
  }
2121
2430
  export interface DropdownOption {
2122
- /** Selectable option label */
2431
+ /**
2432
+ * Selectable option label
2433
+ * @maxLength 400
2434
+ */
2123
2435
  label?: string | null;
2124
- /** Selectable option value, which is saved to DB. */
2436
+ /**
2437
+ * Selectable option value, which is saved to DB.
2438
+ * @maxLength 20000
2439
+ */
2125
2440
  value?: string | null;
2126
2441
  /** Flag identifying that option should be selected by default */
2127
2442
  default?: boolean;
2128
- /** Option id. Used as binding for translations */
2443
+ /**
2444
+ * Option id. Used as binding for translations
2445
+ * @format GUID
2446
+ * @immutable
2447
+ */
2129
2448
  _id?: string;
2130
2449
  }
2131
2450
  export interface DropdownCustomOption {
2132
- /** Label of custom option input */
2451
+ /**
2452
+ * Label of custom option input
2453
+ * @maxLength 350
2454
+ */
2133
2455
  label?: string | null;
2134
- /** Placeholder of custom option input */
2456
+ /**
2457
+ * Placeholder of custom option input
2458
+ * @maxLength 100
2459
+ */
2135
2460
  placeholder?: string | null;
2136
2461
  }
2137
2462
  export interface DateTimeInput {
2138
- /** 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
+ */
2139
2467
  label?: string | null;
2140
2468
  /** Description of the field. Additional information about the date/time input. */
2141
2469
  description?: RichContent;
@@ -2154,22 +2482,35 @@ export interface DateTimeInput {
2154
2482
  * Default: false.
2155
2483
  */
2156
2484
  use24HourFormat?: boolean;
2157
- /** Default value for the date time input. */
2485
+ /**
2486
+ * Default value for the date time input.
2487
+ * @format LOCAL_DATE_TIME
2488
+ */
2158
2489
  default?: string | null;
2159
2490
  }
2160
2491
  export interface PhoneInput {
2161
- /** Label of the field */
2492
+ /**
2493
+ * Label of the field
2494
+ * @maxLength 350
2495
+ */
2162
2496
  label?: string | null;
2163
2497
  /** Description of the field */
2164
2498
  description?: RichContent;
2165
- /** Placeholder for the value input */
2499
+ /**
2500
+ * Placeholder for the value input
2501
+ * @maxLength 100
2502
+ */
2166
2503
  placeholder?: string | null;
2167
2504
  /**
2168
2505
  * Flag identifying to show label or not
2169
2506
  * Default: true
2170
2507
  */
2171
2508
  showLabel?: boolean | null;
2172
- /** Default value of the country code */
2509
+ /**
2510
+ * Default value of the country code
2511
+ * @minLength 1
2512
+ * @maxLength 5
2513
+ */
2173
2514
  defaultCountryCode?: string | null;
2174
2515
  /**
2175
2516
  * Flag identifying to show country flag or not
@@ -2178,7 +2519,10 @@ export interface PhoneInput {
2178
2519
  showCountryFlag?: boolean;
2179
2520
  }
2180
2521
  export interface DateInput {
2181
- /** 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
+ */
2182
2526
  label?: string | null;
2183
2527
  /** Description of the field. Additional information about the date/time input. */
2184
2528
  description?: RichContent;
@@ -2192,11 +2536,17 @@ export interface DateInput {
2192
2536
  * Default: true
2193
2537
  */
2194
2538
  showPlaceholder?: boolean | null;
2195
- /** Default value for the date input. */
2539
+ /**
2540
+ * Default value for the date input.
2541
+ * @format LOCAL_DATE
2542
+ */
2196
2543
  default?: string | null;
2197
2544
  }
2198
2545
  export interface TimeInput {
2199
- /** 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
+ */
2200
2550
  label?: string | null;
2201
2551
  /** Description of the field. Additional information about the date/time input. */
2202
2552
  description?: RichContent;
@@ -2215,11 +2565,17 @@ export interface TimeInput {
2215
2565
  * Default: false.
2216
2566
  */
2217
2567
  use24HourFormat?: boolean;
2218
- /** Default value for the time input. */
2568
+ /**
2569
+ * Default value for the time input.
2570
+ * @format LOCAL_TIME
2571
+ */
2219
2572
  default?: string | null;
2220
2573
  }
2221
2574
  export interface DatePicker {
2222
- /** 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
+ */
2223
2579
  label?: string | null;
2224
2580
  /** Description of the field. Additional information about the date/time input. */
2225
2581
  description?: RichContent;
@@ -2228,11 +2584,17 @@ export interface DatePicker {
2228
2584
  * Default: true
2229
2585
  */
2230
2586
  showLabel?: boolean | null;
2231
- /** Placeholder of date picker input */
2587
+ /**
2588
+ * Placeholder of date picker input
2589
+ * @maxLength 100
2590
+ */
2232
2591
  placeholder?: string | null;
2233
2592
  /** First day of the week displayed on date picker. */
2234
2593
  firstDayOfWeek?: FirstDayOfWeek;
2235
- /** Default value for the date picker. */
2594
+ /**
2595
+ * Default value for the date picker.
2596
+ * @format LOCAL_DATE
2597
+ */
2236
2598
  default?: string | null;
2237
2599
  }
2238
2600
  export declare enum FirstDayOfWeek {
@@ -2250,11 +2612,17 @@ export interface InputFieldNumberType {
2250
2612
  multipleOf?: number | null;
2251
2613
  /** Custom error message when validation fails. */
2252
2614
  errorMessages?: InputFieldNumberErrorMessages;
2253
- /** List of allowed values. */
2615
+ /**
2616
+ * List of allowed values.
2617
+ * @maxSize 500
2618
+ */
2254
2619
  enum?: number[] | null;
2255
2620
  }
2256
2621
  export interface InputFieldNumberErrorMessages {
2257
- /** Default error message on invalid validation. */
2622
+ /**
2623
+ * Default error message on invalid validation.
2624
+ * @maxLength 200
2625
+ */
2258
2626
  default?: string | null;
2259
2627
  }
2260
2628
  export declare enum NumberComponentType {
@@ -2263,11 +2631,17 @@ export declare enum NumberComponentType {
2263
2631
  RATING_INPUT = "RATING_INPUT"
2264
2632
  }
2265
2633
  export interface NumberInput {
2266
- /** Label of the field */
2634
+ /**
2635
+ * Label of the field
2636
+ * @maxLength 350
2637
+ */
2267
2638
  label?: string | null;
2268
2639
  /** Description of the field */
2269
2640
  description?: RichContent;
2270
- /** Placeholder for the value input */
2641
+ /**
2642
+ * Placeholder for the value input
2643
+ * @maxLength 100
2644
+ */
2271
2645
  placeholder?: string | null;
2272
2646
  /**
2273
2647
  * Flag identifying to hide or not label
@@ -2278,7 +2652,10 @@ export interface NumberInput {
2278
2652
  default?: number | null;
2279
2653
  }
2280
2654
  export interface RatingInput {
2281
- /** Label of the field */
2655
+ /**
2656
+ * Label of the field
2657
+ * @maxLength 350
2658
+ */
2282
2659
  label?: string | null;
2283
2660
  /** Description of the field */
2284
2661
  description?: RichContent;
@@ -2287,17 +2664,27 @@ export interface RatingInput {
2287
2664
  * Default: true
2288
2665
  */
2289
2666
  showLabel?: boolean | null;
2290
- /** Default rating */
2667
+ /**
2668
+ * Default rating
2669
+ * @min 1
2670
+ * @max 5
2671
+ */
2291
2672
  defaultValue?: number | null;
2292
2673
  }
2293
2674
  export interface InputFieldBooleanType {
2294
2675
  /** Custom error message when validation fails. */
2295
2676
  errorMessages?: InputFieldBooleanErrorMessages;
2296
- /** List of allowed values. */
2677
+ /**
2678
+ * List of allowed values.
2679
+ * @maxSize 2
2680
+ */
2297
2681
  enum?: boolean[];
2298
2682
  }
2299
2683
  export interface InputFieldBooleanErrorMessages {
2300
- /** Default error message on invalid validation. */
2684
+ /**
2685
+ * Default error message on invalid validation.
2686
+ * @maxLength 200
2687
+ */
2301
2688
  default?: string | null;
2302
2689
  }
2303
2690
  export declare enum BooleanComponentType {
@@ -2314,9 +2701,15 @@ export interface Checkbox {
2314
2701
  checked?: boolean;
2315
2702
  }
2316
2703
  export interface InputFieldArrayType {
2317
- /** Maximum amount of array elements. */
2704
+ /**
2705
+ * Maximum amount of array elements.
2706
+ * @max 1000
2707
+ */
2318
2708
  maxItems?: number | null;
2319
- /** Minimum amount of array elements. */
2709
+ /**
2710
+ * Minimum amount of array elements.
2711
+ * @max 1000
2712
+ */
2320
2713
  minItems?: number | null;
2321
2714
  /** Type of items allowed in array. */
2322
2715
  items?: ArrayTypeArrayItems;
@@ -2340,7 +2733,10 @@ export interface InputFieldIntegerType {
2340
2733
  multipleOf?: number | null;
2341
2734
  /** Custom error message when validation fails. */
2342
2735
  errorMessages?: InputFieldNumberErrorMessages;
2343
- /** List of allowed values. */
2736
+ /**
2737
+ * List of allowed values.
2738
+ * @maxSize 500
2739
+ */
2344
2740
  enum?: number[] | null;
2345
2741
  }
2346
2742
  export interface InputFieldObjectType {
@@ -2390,7 +2786,10 @@ export interface ObjectTypePropertiesTypePropertiesTypeOptionsOneOf {
2390
2786
  arrayOptions?: InputFieldArrayType;
2391
2787
  }
2392
2788
  export interface InputFieldObjectErrorMessages {
2393
- /** Default error message on invalid validation. */
2789
+ /**
2790
+ * Default error message on invalid validation.
2791
+ * @maxLength 200
2792
+ */
2394
2793
  default?: string | null;
2395
2794
  }
2396
2795
  export interface ArrayTypeArrayItems extends ArrayTypeArrayItemsItemTypeOptionsOneOf {
@@ -2424,7 +2823,10 @@ export interface ArrayTypeArrayItemsItemTypeOptionsOneOf {
2424
2823
  objectOptions?: InputFieldObjectType;
2425
2824
  }
2426
2825
  export interface InputFieldArrayErrorMessages {
2427
- /** Default error message on invalid validation. */
2826
+ /**
2827
+ * Default error message on invalid validation.
2828
+ * @maxLength 200
2829
+ */
2428
2830
  default?: string | null;
2429
2831
  }
2430
2832
  export declare enum ComponentType {
@@ -2433,11 +2835,17 @@ export declare enum ComponentType {
2433
2835
  TAGS = "TAGS"
2434
2836
  }
2435
2837
  export interface CheckboxGroup {
2436
- /** Label of the field */
2838
+ /**
2839
+ * Label of the field
2840
+ * @maxLength 350
2841
+ */
2437
2842
  label?: string | null;
2438
2843
  /** Description of the field */
2439
2844
  description?: RichContent;
2440
- /** List of options to select from */
2845
+ /**
2846
+ * List of options to select from
2847
+ * @maxSize 400
2848
+ */
2441
2849
  options?: Option[];
2442
2850
  /**
2443
2851
  * Flag identifying to hide or not label
@@ -2462,29 +2870,48 @@ export interface MediaItemMediaOneOf {
2462
2870
  image?: string;
2463
2871
  }
2464
2872
  export interface Option {
2465
- /** Selectable option label */
2873
+ /**
2874
+ * Selectable option label
2875
+ * @maxLength 400
2876
+ */
2466
2877
  label?: string | null;
2467
2878
  /** Selectable option value, which is saved to DB. */
2468
2879
  value?: any;
2469
2880
  /** Flag identifying that option should be selected by default */
2470
2881
  default?: boolean;
2471
- /** Option id. Used as binding for translations */
2882
+ /**
2883
+ * Option id. Used as binding for translations
2884
+ * @format GUID
2885
+ * @immutable
2886
+ */
2472
2887
  _id?: string;
2473
2888
  /** Media item. Media, associated with option, like image. */
2474
2889
  media?: MediaItem;
2475
2890
  }
2476
2891
  export interface CustomOption {
2477
- /** Label of custom option input */
2892
+ /**
2893
+ * Label of custom option input
2894
+ * @maxLength 350
2895
+ */
2478
2896
  label?: string | null;
2479
- /** Placeholder of custom option input */
2897
+ /**
2898
+ * Placeholder of custom option input
2899
+ * @maxLength 100
2900
+ */
2480
2901
  placeholder?: string | null;
2481
2902
  }
2482
2903
  export interface Tags {
2483
- /** Label of the field */
2904
+ /**
2905
+ * Label of the field
2906
+ * @maxLength 350
2907
+ */
2484
2908
  label?: string | null;
2485
2909
  /** Description of the field */
2486
2910
  description?: RichContent;
2487
- /** List of options to select from */
2911
+ /**
2912
+ * List of options to select from
2913
+ * @maxSize 400
2914
+ */
2488
2915
  options?: TagsOption[];
2489
2916
  /**
2490
2917
  * Flag identifying to hide or not label
@@ -2500,21 +2927,34 @@ export interface Tags {
2500
2927
  numberOfColumns?: NumberOfColumns;
2501
2928
  }
2502
2929
  export interface TagsOption {
2503
- /** Selectable option label */
2930
+ /**
2931
+ * Selectable option label
2932
+ * @maxLength 400
2933
+ */
2504
2934
  label?: string | null;
2505
2935
  /** Selectable option value, which is saved to DB. */
2506
2936
  value?: any;
2507
2937
  /** Flag identifying that option should be selected by default */
2508
2938
  default?: boolean;
2509
- /** Option id. Used as binding for translations */
2939
+ /**
2940
+ * Option id. Used as binding for translations
2941
+ * @format GUID
2942
+ * @immutable
2943
+ */
2510
2944
  _id?: string;
2511
2945
  /** Media item. Media, associated with option, like image. */
2512
2946
  media?: MediaItem;
2513
2947
  }
2514
2948
  export interface CommonCustomOption {
2515
- /** Label of custom option input */
2949
+ /**
2950
+ * Label of custom option input
2951
+ * @maxLength 350
2952
+ */
2516
2953
  label?: string | null;
2517
- /** Placeholder of custom option input */
2954
+ /**
2955
+ * Placeholder of custom option input
2956
+ * @maxLength 100
2957
+ */
2518
2958
  placeholder?: string | null;
2519
2959
  }
2520
2960
  export declare enum WixFileComponentType {
@@ -2523,7 +2963,10 @@ export declare enum WixFileComponentType {
2523
2963
  SIGNATURE = "SIGNATURE"
2524
2964
  }
2525
2965
  export interface FileUpload {
2526
- /** Selectable option label */
2966
+ /**
2967
+ * Selectable option label
2968
+ * @maxLength 350
2969
+ */
2527
2970
  label?: string | null;
2528
2971
  /** Description of the field */
2529
2972
  description?: RichContent;
@@ -2532,13 +2975,26 @@ export interface FileUpload {
2532
2975
  * Default: true
2533
2976
  */
2534
2977
  showLabel?: boolean | null;
2535
- /** Text on upload button */
2978
+ /**
2979
+ * Text on upload button
2980
+ * @maxLength 500
2981
+ */
2536
2982
  buttonText?: string | null;
2537
- /** Amount of files allowed to upload */
2983
+ /**
2984
+ * Amount of files allowed to upload
2985
+ * @min 1
2986
+ * @max 30
2987
+ */
2538
2988
  fileLimit?: number;
2539
- /** Supported file formats for upload */
2989
+ /**
2990
+ * Supported file formats for upload
2991
+ * @maxSize 5
2992
+ */
2540
2993
  uploadFileFormats?: UploadFileFormat[];
2541
- /** Custom text which appears when file is uploaded, if missing file name will be shown */
2994
+ /**
2995
+ * Custom text which appears when file is uploaded, if missing file name will be shown
2996
+ * @maxLength 255
2997
+ */
2542
2998
  explanationText?: string | null;
2543
2999
  }
2544
3000
  export declare enum UploadFileFormat {
@@ -2556,7 +3012,10 @@ export declare enum UploadFileFormat {
2556
3012
  ARCHIVE = "ARCHIVE"
2557
3013
  }
2558
3014
  export interface Signature {
2559
- /** Selectable option label */
3015
+ /**
3016
+ * Selectable option label
3017
+ * @maxLength 350
3018
+ */
2560
3019
  label?: string | null;
2561
3020
  /**
2562
3021
  * Flag identifying to hide label or not
@@ -2576,11 +3035,17 @@ export declare enum PaymentComponentType {
2576
3035
  FIXED_PAYMENT = "FIXED_PAYMENT"
2577
3036
  }
2578
3037
  export interface ProductCheckboxGroup {
2579
- /** Label of the field. */
3038
+ /**
3039
+ * Label of the field.
3040
+ * @maxLength 350
3041
+ */
2580
3042
  label?: string | null;
2581
3043
  /** Description of the field. */
2582
3044
  description?: RichContent;
2583
- /** List of options to select from. */
3045
+ /**
3046
+ * List of options to select from.
3047
+ * @maxSize 400
3048
+ */
2584
3049
  options?: ProductCheckboxGroupOption[];
2585
3050
  /**
2586
3051
  * Flag identifying to hide or not label
@@ -2594,11 +3059,18 @@ export interface ProductCheckboxGroup {
2594
3059
  imageFit?: ImageFit;
2595
3060
  }
2596
3061
  export interface ProductCheckboxGroupOption {
2597
- /** Selectable option label. */
3062
+ /**
3063
+ * Selectable option label.
3064
+ * @maxLength 400
3065
+ */
2598
3066
  label?: string | null;
2599
3067
  /** Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list. */
2600
3068
  value?: any;
2601
- /** Option id. Used as binding for translations. */
3069
+ /**
3070
+ * Option id. Used as binding for translations.
3071
+ * @format GUID
3072
+ * @immutable
3073
+ */
2602
3074
  _id?: string;
2603
3075
  /** Media item. Media, associated with option, like image. */
2604
3076
  media?: MediaItem;
@@ -2613,11 +3085,17 @@ export declare enum ImageFit {
2613
3085
  CONTAIN = "CONTAIN"
2614
3086
  }
2615
3087
  export interface DonationInput {
2616
- /** Label of the field. */
3088
+ /**
3089
+ * Label of the field.
3090
+ * @maxLength 350
3091
+ */
2617
3092
  label?: string | null;
2618
3093
  /** Description of the field. */
2619
3094
  description?: RichContent;
2620
- /** List of options to select from. */
3095
+ /**
3096
+ * List of options to select from.
3097
+ * @maxSize 400
3098
+ */
2621
3099
  options?: DonationInputOption[];
2622
3100
  /** Option which can be specified by UoU, enabled when this object is specified. */
2623
3101
  customOption?: CommonCustomOption;
@@ -2633,13 +3111,19 @@ export interface DonationInput {
2633
3111
  showLabel?: boolean | null;
2634
3112
  }
2635
3113
  export interface DonationInputOption {
2636
- /** Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list. */
3114
+ /**
3115
+ * Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list.
3116
+ * @format GUID
3117
+ */
2637
3118
  value?: string;
2638
3119
  /** Flag identifying that option should be selected by default */
2639
3120
  default?: boolean;
2640
3121
  }
2641
3122
  export interface PaymentInput {
2642
- /** Label of the field. */
3123
+ /**
3124
+ * Label of the field.
3125
+ * @maxLength 350
3126
+ */
2643
3127
  label?: string | null;
2644
3128
  /** Description of the field. */
2645
3129
  description?: RichContent;
@@ -2648,13 +3132,19 @@ export interface PaymentInput {
2648
3132
  * Default: true
2649
3133
  */
2650
3134
  showLabel?: boolean | null;
2651
- /** Placeholder of custom option input */
3135
+ /**
3136
+ * Placeholder of custom option input
3137
+ * @maxLength 100
3138
+ */
2652
3139
  placeholder?: string | null;
2653
3140
  /** Default value for the payment input */
2654
3141
  default?: number | null;
2655
3142
  }
2656
3143
  export interface FixedPayment {
2657
- /** Label of the field. */
3144
+ /**
3145
+ * Label of the field.
3146
+ * @maxLength 350
3147
+ */
2658
3148
  label?: string | null;
2659
3149
  /** Description of the field. */
2660
3150
  description?: RichContent;
@@ -2675,15 +3165,30 @@ export interface Appointment extends AppointmentFormatInfoOneOf {
2675
3165
  videoConferenceOptions?: VideoConferenceOptions;
2676
3166
  /** Phone options for the appointment */
2677
3167
  phoneOptions?: PhoneOptions;
2678
- /** Label of the field */
3168
+ /**
3169
+ * Label of the field
3170
+ * @maxLength 255
3171
+ */
2679
3172
  label?: string | null;
2680
- /** Name of the appointment */
3173
+ /**
3174
+ * Name of the appointment
3175
+ * @minLength 1
3176
+ * @maxLength 400
3177
+ */
2681
3178
  name?: string | null;
2682
- /** Duration of the appointment in minutes */
3179
+ /**
3180
+ * Duration of the appointment in minutes
3181
+ * @min 1
3182
+ * @max 44639
3183
+ */
2683
3184
  durationInMinutes?: number | null;
2684
3185
  /** Indicates whether manual approval is required for the appointment */
2685
3186
  manualApprovalRequired?: boolean | null;
2686
- /** ID of the staff members providing the appointment */
3187
+ /**
3188
+ * ID of the staff members providing the appointment
3189
+ * @maxSize 220
3190
+ * @format GUID
3191
+ */
2687
3192
  staffIds?: string[] | null;
2688
3193
  /** The format of the appointment */
2689
3194
  format?: Format;
@@ -2698,16 +3203,28 @@ export interface AppointmentFormatInfoOneOf {
2698
3203
  phoneOptions?: PhoneOptions;
2699
3204
  }
2700
3205
  export interface Location extends LocationLocationInfoOneOf {
2701
- /** Custom address details */
3206
+ /**
3207
+ * Custom address details
3208
+ * @maxLength 512
3209
+ */
2702
3210
  customAddress?: string | null;
2703
- /** ID of a business location */
3211
+ /**
3212
+ * ID of a business location
3213
+ * @format GUID
3214
+ */
2704
3215
  businessLocationId?: string | null;
2705
3216
  }
2706
3217
  /** @oneof */
2707
3218
  export interface LocationLocationInfoOneOf {
2708
- /** Custom address details */
3219
+ /**
3220
+ * Custom address details
3221
+ * @maxLength 512
3222
+ */
2709
3223
  customAddress?: string | null;
2710
- /** ID of a business location */
3224
+ /**
3225
+ * ID of a business location
3226
+ * @format GUID
3227
+ */
2711
3228
  businessLocationId?: string | null;
2712
3229
  }
2713
3230
  export declare enum Format {
@@ -2717,15 +3234,25 @@ export declare enum Format {
2717
3234
  PHONE = "PHONE"
2718
3235
  }
2719
3236
  export interface InPersonOptions {
2720
- /** The locations details */
3237
+ /**
3238
+ * The locations details
3239
+ * @minSize 1
3240
+ * @maxSize 500
3241
+ */
2721
3242
  locations?: Location[];
2722
3243
  }
2723
3244
  export interface VideoConferenceOptions {
2724
- /** Description or instructions for the online video conference */
3245
+ /**
3246
+ * Description or instructions for the online video conference
3247
+ * @maxLength 512
3248
+ */
2725
3249
  description?: string | null;
2726
3250
  }
2727
3251
  export interface PhoneOptions {
2728
- /** Description or instructions for the phone appointment */
3252
+ /**
3253
+ * Description or instructions for the phone appointment
3254
+ * @maxLength 512
3255
+ */
2729
3256
  description?: string | null;
2730
3257
  }
2731
3258
  export declare enum MultilineAddressComponentType {
@@ -2733,7 +3260,10 @@ export declare enum MultilineAddressComponentType {
2733
3260
  MULTILINE_ADDRESS = "MULTILINE_ADDRESS"
2734
3261
  }
2735
3262
  export interface MultilineAddress {
2736
- /** Label of the field. */
3263
+ /**
3264
+ * Label of the field.
3265
+ * @maxLength 350
3266
+ */
2737
3267
  label?: string | null;
2738
3268
  /** Description of the field. */
2739
3269
  description?: RichContent;
@@ -2759,14 +3289,20 @@ export interface AddressLine2 {
2759
3289
  show?: boolean;
2760
3290
  }
2761
3291
  export interface DefaultCountryConfig extends DefaultCountryConfigOptionsOneOf {
2762
- /** Country. */
3292
+ /**
3293
+ * Country.
3294
+ * @format COUNTRY
3295
+ */
2763
3296
  countryOptions?: string;
2764
3297
  /** Default country type. */
2765
3298
  type?: Type;
2766
3299
  }
2767
3300
  /** @oneof */
2768
3301
  export interface DefaultCountryConfigOptionsOneOf {
2769
- /** Country. */
3302
+ /**
3303
+ * Country.
3304
+ * @format COUNTRY
3305
+ */
2770
3306
  countryOptions?: string;
2771
3307
  }
2772
3308
  export interface FieldsSettings {
@@ -2856,7 +3392,11 @@ export interface AddressInfo {
2856
3392
  tag?: Tag;
2857
3393
  }
2858
3394
  export interface CustomFieldInfo {
2859
- /** Custom field key. */
3395
+ /**
3396
+ * Custom field key.
3397
+ * @minLength 1
3398
+ * @maxLength 500
3399
+ */
2860
3400
  key?: string;
2861
3401
  }
2862
3402
  export interface SubscriptionInfo {
@@ -3075,7 +3615,12 @@ export interface InputField extends InputFieldInputTypeOptionsOneOf {
3075
3615
  multilineAddressOptions?: InputFieldMultilineAddress;
3076
3616
  /** Input returns scheduling as value. */
3077
3617
  schedulingOptions?: Scheduling;
3078
- /** Definition of a target where the value of field belongs. */
3618
+ /**
3619
+ * Definition of a target where the value of field belongs.
3620
+ * @minLength 1
3621
+ * @maxLength 200
3622
+ * @immutable
3623
+ */
3079
3624
  target?: string | null;
3080
3625
  /**
3081
3626
  * Mark the field as containing personal information. This will encrypt user data when storing it.
@@ -3147,17 +3692,33 @@ export interface RichContentOptions {
3147
3692
  richContent?: RichContent;
3148
3693
  }
3149
3694
  export interface PageNavigationOptions {
3150
- /** When button is not on last page it behaves as switch between pages page, text of label to go to next page. */
3695
+ /**
3696
+ * When button is not on last page it behaves as switch between pages page, text of label to go to next page.
3697
+ * @maxLength 65
3698
+ */
3151
3699
  nextPageText?: string | null;
3152
- /** When button is not on last page it behaves as switch between pages page, text of label to go to previous page. */
3700
+ /**
3701
+ * When button is not on last page it behaves as switch between pages page, text of label to go to previous page.
3702
+ * @maxLength 65
3703
+ */
3153
3704
  previousPageText?: string | null;
3154
- /** Text on the button when button is submitting a form */
3705
+ /**
3706
+ * Text on the button when button is submitting a form
3707
+ * @maxLength 65
3708
+ */
3155
3709
  submitText?: string | null;
3156
3710
  }
3157
3711
  export interface Step {
3158
- /** Step ID. */
3712
+ /**
3713
+ * Step ID.
3714
+ * @format GUID
3715
+ * @immutable
3716
+ */
3159
3717
  _id?: string;
3160
- /** Name of the step. */
3718
+ /**
3719
+ * Name of the step.
3720
+ * @maxLength 200
3721
+ */
3161
3722
  name?: string | null;
3162
3723
  /** Is step hidden */
3163
3724
  hidden?: boolean;
@@ -3173,7 +3734,10 @@ export interface FormLayout {
3173
3734
  small?: BreakPoint;
3174
3735
  }
3175
3736
  export interface BreakPoint {
3176
- /** Description of layouts for items. */
3737
+ /**
3738
+ * Description of layouts for items.
3739
+ * @maxSize 500
3740
+ */
3177
3741
  items?: ItemLayout[];
3178
3742
  /** Amount of columns of layout grid. */
3179
3743
  columns?: number | null;
@@ -3183,11 +3747,17 @@ export interface BreakPoint {
3183
3747
  margin?: Margin;
3184
3748
  /** Description of elements paddings. */
3185
3749
  padding?: Margin;
3186
- /** Sections of the layout, which allow manage fields */
3750
+ /**
3751
+ * Sections of the layout, which allow manage fields
3752
+ * @maxSize 100
3753
+ */
3187
3754
  sections?: Section[];
3188
3755
  }
3189
3756
  export interface ItemLayout extends ItemLayoutItemOneOf {
3190
- /** Form field reference id. */
3757
+ /**
3758
+ * Form field reference id.
3759
+ * @format GUID
3760
+ */
3191
3761
  fieldId?: string;
3192
3762
  /** Group info, defining that this item is a group of multiple fields */
3193
3763
  group?: Group;
@@ -3202,15 +3772,25 @@ export interface ItemLayout extends ItemLayoutItemOneOf {
3202
3772
  }
3203
3773
  /** @oneof */
3204
3774
  export interface ItemLayoutItemOneOf {
3205
- /** Form field reference id. */
3775
+ /**
3776
+ * Form field reference id.
3777
+ * @format GUID
3778
+ */
3206
3779
  fieldId?: string;
3207
3780
  /** Group info, defining that this item is a group of multiple fields */
3208
3781
  group?: Group;
3209
3782
  }
3210
3783
  export interface Group {
3211
- /** Field group reference id. */
3784
+ /**
3785
+ * Field group reference id.
3786
+ * @format GUID
3787
+ */
3212
3788
  groupId?: string;
3213
- /** Description of layouts for items. */
3789
+ /**
3790
+ * Description of layouts for items.
3791
+ * @minSize 1
3792
+ * @maxSize 500
3793
+ */
3214
3794
  items?: ItemLayout[];
3215
3795
  }
3216
3796
  export interface Margin {
@@ -3220,7 +3800,11 @@ export interface Margin {
3220
3800
  vertical?: number | null;
3221
3801
  }
3222
3802
  export interface Section {
3223
- /** Id of the section */
3803
+ /**
3804
+ * Id of the section
3805
+ * @format GUID
3806
+ * @minLength 1
3807
+ */
3224
3808
  _id?: string;
3225
3809
  /** Horizontal coordinate in the grid. */
3226
3810
  row?: number | null;
@@ -3230,20 +3814,30 @@ export interface Section {
3230
3814
  * If the section encounters the $new key within the list,
3231
3815
  * it allows the inclusion of fields not explicitly listed,
3232
3816
  * enabling dynamic addition of new fields.
3817
+ * @maxSize 100
3818
+ * @maxLength 100
3233
3819
  */
3234
3820
  allowedFieldIds?: string[];
3235
3821
  }
3236
3822
  export interface FormRule {
3237
- /** Id of the rule */
3823
+ /**
3824
+ * Id of the rule
3825
+ * @format GUID
3826
+ * @immutable
3827
+ */
3238
3828
  _id?: string;
3239
3829
  /** Rule on which item properties or layouts will be changed. */
3240
3830
  condition?: Record<string, any> | null;
3241
3831
  /**
3242
3832
  * Form items with defined properties that will be
3243
3833
  * changed when given condition is resolved to true.
3834
+ * @maxSize 500
3244
3835
  */
3245
3836
  overrides?: FormOverride[];
3246
- /** Name of the rule */
3837
+ /**
3838
+ * Name of the rule
3839
+ * @maxLength 200
3840
+ */
3247
3841
  name?: string | null;
3248
3842
  }
3249
3843
  export declare enum OverrideEntityType {
@@ -3251,15 +3845,28 @@ export declare enum OverrideEntityType {
3251
3845
  FIELD = "FIELD"
3252
3846
  }
3253
3847
  export interface FormOverride {
3254
- /** Override entity type. */
3848
+ /**
3849
+ * Override entity type.
3850
+ * @immutable
3851
+ */
3255
3852
  entityType?: OverrideEntityType;
3256
- /** Overridden entity id. Either fieldId, or "{fieldIdWithNestedForm}/{nestedFormFieldId}" */
3853
+ /**
3854
+ * Overridden entity id. Either fieldId, or "{fieldIdWithNestedForm}/{nestedFormFieldId}"
3855
+ * @immutable
3856
+ * @maxLength 73
3857
+ */
3257
3858
  entityId?: string | null;
3258
3859
  /** Form entity properties path with new value, that will be changed on condition. */
3259
3860
  valueChanges?: Record<string, any>;
3260
3861
  }
3261
3862
  export interface FormProperties {
3262
- /** Form name. */
3863
+ /**
3864
+ * Form name.
3865
+ * @maxLength 200
3866
+ * @deprecated
3867
+ * @replacedBy wix.forms.v4.Form.name
3868
+ * @targetRemovalDate 2026-01-06
3869
+ */
3263
3870
  name?: string | null;
3264
3871
  /**
3265
3872
  * Identifies if the form is disabled.
@@ -3280,17 +3887,27 @@ export interface PostSubmissionTriggers {
3280
3887
  upsertContact?: UpsertContact;
3281
3888
  }
3282
3889
  export interface UpsertContact {
3283
- /** Fields mapping (target field mapped to corresponding contact field). */
3890
+ /**
3891
+ * Fields mapping (target field mapped to corresponding contact field).
3892
+ * @maxSize 250
3893
+ */
3284
3894
  fieldsMapping?: Record<string, FormFieldContactInfo>;
3285
3895
  /**
3286
3896
  * List of contact label keys.
3287
3897
  * [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
3288
3898
  * help categorize contacts.
3899
+ * @minLength 1
3900
+ * @maxLength 100
3901
+ * @maxSize 20
3289
3902
  */
3290
3903
  labels?: string[];
3291
3904
  }
3292
3905
  export interface NestedForm {
3293
- /** Targets which have this form. */
3906
+ /**
3907
+ * Targets which have this form.
3908
+ * @maxSize 10
3909
+ * @maxLength 200
3910
+ */
3294
3911
  targets?: string[];
3295
3912
  /** Nested form. */
3296
3913
  form?: Form;
@@ -3357,28 +3974,44 @@ export interface ThankYouMessageOptions {
3357
3974
  richContent?: RichContent;
3358
3975
  }
3359
3976
  export interface RedirectOptions {
3360
- /** The URL to which the user should be redirected after a successful form submission. */
3977
+ /**
3978
+ * The URL to which the user should be redirected after a successful form submission.
3979
+ * @maxLength 2000
3980
+ */
3361
3981
  redirectUrl?: string | null;
3362
3982
  /** How the URL should be opened. */
3363
3983
  target?: Target;
3364
3984
  }
3365
3985
  export interface FieldGroup {
3366
- /** Id of group, on layout */
3986
+ /**
3987
+ * Id of group, on layout
3988
+ * @format GUID
3989
+ */
3367
3990
  _id?: string;
3368
- /** Label of group */
3991
+ /**
3992
+ * Label of group
3993
+ * @maxLength 350
3994
+ */
3369
3995
  label?: string | null;
3370
3996
  }
3371
3997
  export interface CreateCheckoutFromSubmissionResponse {
3372
- /** Checkout ID (applicable for form involving payments). */
3998
+ /**
3999
+ * Checkout ID (applicable for form involving payments).
4000
+ * @format GUID
4001
+ */
3373
4002
  checkoutId?: string | null;
3374
4003
  /** Checkout (applicable for form involving payments). */
3375
4004
  checkout?: Checkout;
3376
4005
  }
3377
4006
  export interface Checkout {
3378
- /** Checkout ID. */
4007
+ /**
4008
+ * Checkout ID.
4009
+ * @format GUID
4010
+ */
3379
4011
  _id?: string;
3380
4012
  /**
3381
4013
  * The currency used when submitting the order.
4014
+ * @format CURRENCY
3382
4015
  * @readonly
3383
4016
  */
3384
4017
  currency?: string;
@@ -3460,9 +4093,15 @@ export interface ActionEvent {
3460
4093
  export interface Empty {
3461
4094
  }
3462
4095
  export interface MessageEnvelope {
3463
- /** App instance ID. */
4096
+ /**
4097
+ * App instance ID.
4098
+ * @format GUID
4099
+ */
3464
4100
  instanceId?: string | null;
3465
- /** Event type. */
4101
+ /**
4102
+ * Event type.
4103
+ * @maxLength 150
4104
+ */
3466
4105
  eventType?: string;
3467
4106
  /** The identification type and identity data. */
3468
4107
  identity?: IdentificationData;
@@ -3470,26 +4109,50 @@ export interface MessageEnvelope {
3470
4109
  data?: string;
3471
4110
  }
3472
4111
  export interface IdentificationData extends IdentificationDataIdOneOf {
3473
- /** ID of a site visitor that has not logged in to the site. */
4112
+ /**
4113
+ * ID of a site visitor that has not logged in to the site.
4114
+ * @format GUID
4115
+ */
3474
4116
  anonymousVisitorId?: string;
3475
- /** ID of a site visitor that has logged in to the site. */
4117
+ /**
4118
+ * ID of a site visitor that has logged in to the site.
4119
+ * @format GUID
4120
+ */
3476
4121
  memberId?: string;
3477
- /** ID of a Wix user (site owner, contributor, etc.). */
4122
+ /**
4123
+ * ID of a Wix user (site owner, contributor, etc.).
4124
+ * @format GUID
4125
+ */
3478
4126
  wixUserId?: string;
3479
- /** ID of an app. */
4127
+ /**
4128
+ * ID of an app.
4129
+ * @format GUID
4130
+ */
3480
4131
  appId?: string;
3481
4132
  /** @readonly */
3482
4133
  identityType?: WebhookIdentityType;
3483
4134
  }
3484
4135
  /** @oneof */
3485
4136
  export interface IdentificationDataIdOneOf {
3486
- /** ID of a site visitor that has not logged in to the site. */
4137
+ /**
4138
+ * ID of a site visitor that has not logged in to the site.
4139
+ * @format GUID
4140
+ */
3487
4141
  anonymousVisitorId?: string;
3488
- /** ID of a site visitor that has logged in to the site. */
4142
+ /**
4143
+ * ID of a site visitor that has logged in to the site.
4144
+ * @format GUID
4145
+ */
3489
4146
  memberId?: string;
3490
- /** ID of a Wix user (site owner, contributor, etc.). */
4147
+ /**
4148
+ * ID of a Wix user (site owner, contributor, etc.).
4149
+ * @format GUID
4150
+ */
3491
4151
  wixUserId?: string;
3492
- /** ID of an app. */
4152
+ /**
4153
+ * ID of an app.
4154
+ * @format GUID
4155
+ */
3493
4156
  appId?: string;
3494
4157
  }
3495
4158
  export declare enum WebhookIdentityType {
@@ -3499,10 +4162,63 @@ export declare enum WebhookIdentityType {
3499
4162
  WIX_USER = "WIX_USER",
3500
4163
  APP = "APP"
3501
4164
  }
4165
+ export interface UpsertContactFromSubmissionRequest {
4166
+ /**
4167
+ * Submission from which contact needs to be upserted.
4168
+ * @format GUID
4169
+ */
4170
+ submissionId: string;
4171
+ /**
4172
+ * Optional contact id to which submission should be mapped.
4173
+ * @format GUID
4174
+ */
4175
+ contactId?: string | null;
4176
+ /** Indicates contact has verified primary email. */
4177
+ emailVerified?: boolean;
4178
+ }
4179
+ export interface UpsertContactFromSubmissionResponse {
4180
+ /** Submit contact response. */
4181
+ submitContactResponse?: SubmitContactResponse;
4182
+ }
4183
+ export interface SubmitContactResponse {
4184
+ /**
4185
+ * ID of the contact that was found or created.
4186
+ * @format GUID
4187
+ */
4188
+ contactId?: string;
4189
+ /**
4190
+ * Identity type of the returned contact.
4191
+ *
4192
+ * - `CONTACT`: The returned contact ID belongs to a new or existing contact.
4193
+ * - `MEMBER`: The returned contact ID belongs to the currently logged-in site member.
4194
+ * - `NOT_AUTHENTICATED_MEMBER`: The returned contact ID belongs to a site member who is not currently logged in.
4195
+ */
4196
+ identityType?: IdentityType;
4197
+ /**
4198
+ * Indicates whether the contact was just created or already existed.
4199
+ *
4200
+ * If the contact was just created, returns `true`.
4201
+ * If it already existed, returns `false`.
4202
+ */
4203
+ newContact?: boolean;
4204
+ }
4205
+ export declare enum IdentityType {
4206
+ UNKNOWN = "UNKNOWN",
4207
+ /** Existing or new contact */
4208
+ CONTACT = "CONTACT",
4209
+ /** Member is logged in, matching logic skipped */
4210
+ MEMBER = "MEMBER",
4211
+ /** Matching contact is a member, Merge logic won't be applied */
4212
+ NOT_AUTHENTICATED_MEMBER = "NOT_AUTHENTICATED_MEMBER"
4213
+ }
3502
4214
  export interface CreateSubmissionRequest {
3503
4215
  /** Submission to create. */
3504
4216
  submission: FormSubmission;
3505
- /** Captcha token. */
4217
+ /**
4218
+ * Captcha token.
4219
+ * @minLength 1
4220
+ * @maxLength 3000
4221
+ */
3506
4222
  captchaToken?: string | null;
3507
4223
  }
3508
4224
  export interface CreateSubmissionResponse {
@@ -3510,15 +4226,24 @@ export interface CreateSubmissionResponse {
3510
4226
  submission?: FormSubmission;
3511
4227
  }
3512
4228
  export interface SubmissionValidationErrorsDetails {
3513
- /** Submission validation errors details. */
4229
+ /**
4230
+ * Submission validation errors details.
4231
+ * @maxSize 100
4232
+ */
3514
4233
  errors?: ValidationError[];
3515
4234
  }
3516
4235
  export interface ValidationError {
3517
- /** Path indicating the source of the error, such as `submission.submissions.email`` */
4236
+ /**
4237
+ * Path indicating the source of the error, such as `submission.submissions.email``
4238
+ * @maxLength 1000
4239
+ */
3518
4240
  errorPath?: string;
3519
4241
  /** Error type. */
3520
4242
  errorType?: ErrorType;
3521
- /** Error message. */
4243
+ /**
4244
+ * Error message.
4245
+ * @maxLength 1000
4246
+ */
3522
4247
  errorMessage?: string;
3523
4248
  /** Additional error parameters, to help identify additional info. */
3524
4249
  params?: Record<string, any> | null;
@@ -3592,16 +4317,23 @@ export interface CreateSubmissionBySubmitterResponse {
3592
4317
  submission?: FormSubmission;
3593
4318
  }
3594
4319
  export interface BulkCreateSubmissionBySubmitterRequest {
3595
- /** Form id. Restricts submissions creation for a single form. */
4320
+ /**
4321
+ * Form id. Restricts submissions creation for a single form.
4322
+ * @format GUID
4323
+ */
3596
4324
  formId: string;
3597
4325
  /**
3598
4326
  * Submissions to create.
3599
4327
  * Deprecated
4328
+ * @maxSize 100
3600
4329
  */
3601
4330
  submissions?: FormSubmission[];
3602
4331
  /** When set, items will be returned on successful create. */
3603
4332
  returnEntity?: boolean;
3604
- /** Submissions data to create. */
4333
+ /**
4334
+ * Submissions data to create.
4335
+ * @maxSize 100
4336
+ */
3605
4337
  submissionsV2?: BulkCreateSubmissionBySubmitterData[];
3606
4338
  /** Validation will be mode is more forgiving, for example "required" won't be validated. */
3607
4339
  lenientValidation?: boolean;
@@ -3625,7 +4357,10 @@ export interface BulkSubmissionResult {
3625
4357
  item?: FormSubmission;
3626
4358
  }
3627
4359
  export interface ItemMetadata {
3628
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4360
+ /**
4361
+ * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
4362
+ * @format GUID
4363
+ */
3629
4364
  _id?: string | null;
3630
4365
  /** Index of the item within the request array. Allows for correlation between request and response items. */
3631
4366
  originalIndex?: number;
@@ -3651,7 +4386,10 @@ export interface BulkActionMetadata {
3651
4386
  undetailedFailures?: number;
3652
4387
  }
3653
4388
  export interface GetSubmissionRequest {
3654
- /** ID of the submission to retrieve. */
4389
+ /**
4390
+ * ID of the submission to retrieve.
4391
+ * @format GUID
4392
+ */
3655
4393
  submissionId: string;
3656
4394
  }
3657
4395
  export interface GetSubmissionResponse {
@@ -3659,7 +4397,10 @@ export interface GetSubmissionResponse {
3659
4397
  submission?: FormSubmission;
3660
4398
  }
3661
4399
  export interface GetSubmissionByCheckoutIdRequest {
3662
- /** Checkout ID of the submission to retrieve. */
4400
+ /**
4401
+ * Checkout ID of the submission to retrieve.
4402
+ * @format GUID
4403
+ */
3663
4404
  checkoutId?: string;
3664
4405
  }
3665
4406
  export interface GetSubmissionByCheckoutIdResponse {
@@ -3675,7 +4416,10 @@ export interface UpdateSubmissionResponse {
3675
4416
  submission?: FormSubmission;
3676
4417
  }
3677
4418
  export interface ConfirmSubmissionRequest {
3678
- /** Submission ID to confirm. */
4419
+ /**
4420
+ * Submission ID to confirm.
4421
+ * @format GUID
4422
+ */
3679
4423
  submissionId: string;
3680
4424
  }
3681
4425
  export interface ConfirmSubmissionResponse {
@@ -3683,7 +4427,10 @@ export interface ConfirmSubmissionResponse {
3683
4427
  submission?: FormSubmission;
3684
4428
  }
3685
4429
  export interface DeleteSubmissionRequest {
3686
- /** ID of the submission to delete. */
4430
+ /**
4431
+ * ID of the submission to delete.
4432
+ * @format GUID
4433
+ */
3687
4434
  submissionId: string;
3688
4435
  /**
3689
4436
  * Delete the submission, bypassing the trash bin. This means that the submission is permanently deleted and cannot be restored.
@@ -3698,9 +4445,17 @@ export interface DeleteSubmissionRequest {
3698
4445
  export interface DeleteSubmissionResponse {
3699
4446
  }
3700
4447
  export interface BulkDeleteSubmissionRequest {
3701
- /** Form ID. */
4448
+ /**
4449
+ * Form ID.
4450
+ * @format GUID
4451
+ */
3702
4452
  formId: string;
3703
- /** Submission ids. */
4453
+ /**
4454
+ * Submission ids.
4455
+ * @minSize 1
4456
+ * @maxSize 100
4457
+ * @format GUID
4458
+ */
3704
4459
  submissionIds?: string[];
3705
4460
  /**
3706
4461
  * Delete submission bypassing trash-bin
@@ -3711,7 +4466,11 @@ export interface BulkDeleteSubmissionRequest {
3711
4466
  preserveFiles?: boolean;
3712
4467
  }
3713
4468
  export interface BulkDeleteSubmissionResponse {
3714
- /** Results of bulk submission delete */
4469
+ /**
4470
+ * Results of bulk submission delete
4471
+ * @minSize 1
4472
+ * @maxSize 100
4473
+ */
3715
4474
  results?: BulkDeleteSubmissionResult[];
3716
4475
  /** Metadata of request */
3717
4476
  bulkActionMetadata?: BulkActionMetadata;
@@ -3721,7 +4480,10 @@ export interface BulkDeleteSubmissionResult {
3721
4480
  itemMetadata?: ItemMetadata;
3722
4481
  }
3723
4482
  export interface RestoreSubmissionFromTrashBinRequest {
3724
- /** ID of the submission to restore. */
4483
+ /**
4484
+ * ID of the submission to restore.
4485
+ * @format GUID
4486
+ */
3725
4487
  submissionId: string;
3726
4488
  }
3727
4489
  export interface RestoreSubmissionFromTrashBinResponse {
@@ -3729,19 +4491,33 @@ export interface RestoreSubmissionFromTrashBinResponse {
3729
4491
  submission?: FormSubmission;
3730
4492
  }
3731
4493
  export interface RemoveSubmissionFromTrashBinRequest {
3732
- /** ID of the submission to restore. */
4494
+ /**
4495
+ * ID of the submission to restore.
4496
+ * @format GUID
4497
+ */
3733
4498
  submissionId: string;
3734
4499
  }
3735
4500
  export interface RemoveSubmissionFromTrashBinResponse {
3736
4501
  }
3737
4502
  export interface BulkRemoveSubmissionFromTrashBinRequest {
3738
- /** Form ID. */
4503
+ /**
4504
+ * Form ID.
4505
+ * @format GUID
4506
+ */
3739
4507
  formId: string;
3740
- /** Submission ids. */
4508
+ /**
4509
+ * Submission ids.
4510
+ * @minSize 1
4511
+ * @maxSize 100
4512
+ * @format GUID
4513
+ */
3741
4514
  submissionIds?: string[];
3742
4515
  }
3743
4516
  export interface BulkRemoveSubmissionFromTrashBinResponse {
3744
- /** Results of bulk submission removal from trash */
4517
+ /**
4518
+ * Results of bulk submission removal from trash
4519
+ * @maxSize 100
4520
+ */
3745
4521
  results?: BulkRemoveSubmissionFromTrashBinResult[];
3746
4522
  /** Metadata of request */
3747
4523
  bulkActionMetadata?: BulkActionMetadata;
@@ -3751,20 +4527,31 @@ export interface BulkRemoveSubmissionFromTrashBinResult {
3751
4527
  itemMetadata?: ItemMetadata;
3752
4528
  }
3753
4529
  export interface ListDeletedSubmissionsRequest {
3754
- /** Form ID. */
4530
+ /**
4531
+ * Form ID.
4532
+ * @format GUID
4533
+ */
3755
4534
  formId: string;
3756
- /** Submission ids. */
4535
+ /**
4536
+ * Submission ids.
4537
+ * @maxSize 10
4538
+ * @format GUID
4539
+ */
3757
4540
  submissionIds?: string[];
3758
4541
  /** 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`. */
3759
4542
  paging?: CursorPaging;
3760
4543
  /**
3761
4544
  * List of statuses of submissions which should be returned
3762
4545
  * Default: CONFIRMED
4546
+ * @maxSize 4
3763
4547
  */
3764
4548
  statuses?: SubmissionStatus[];
3765
4549
  }
3766
4550
  export interface CursorPaging {
3767
- /** Number of items to load. */
4551
+ /**
4552
+ * Number of items to load.
4553
+ * @max 100
4554
+ */
3768
4555
  limit?: number | null;
3769
4556
  /**
3770
4557
  * Pointer to the next or previous page in the list of results.
@@ -3772,6 +4559,7 @@ export interface CursorPaging {
3772
4559
  * You can get the relevant cursor token
3773
4560
  * from the `pagingMetadata` object in the previous call's response.
3774
4561
  * Not relevant for the first request.
4562
+ * @maxLength 16000
3775
4563
  */
3776
4564
  cursor?: string | null;
3777
4565
  }
@@ -3794,13 +4582,22 @@ export interface CursorPagingMetadata {
3794
4582
  hasNext?: boolean | null;
3795
4583
  }
3796
4584
  export interface Cursors {
3797
- /** Cursor pointing to next page in the list of results. */
4585
+ /**
4586
+ * Cursor pointing to next page in the list of results.
4587
+ * @maxLength 16000
4588
+ */
3798
4589
  next?: string | null;
3799
- /** Cursor pointing to previous page in the list of results. */
4590
+ /**
4591
+ * Cursor pointing to previous page in the list of results.
4592
+ * @maxLength 16000
4593
+ */
3800
4594
  prev?: string | null;
3801
4595
  }
3802
4596
  export interface GetDeletedSubmissionRequest {
3803
- /** Submission id. */
4597
+ /**
4598
+ * Submission id.
4599
+ * @format GUID
4600
+ */
3804
4601
  submissionId: string;
3805
4602
  }
3806
4603
  export interface GetDeletedSubmissionResponse {
@@ -3828,6 +4625,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
3828
4625
  /**
3829
4626
  * Sort object in the following format:
3830
4627
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
4628
+ * @maxSize 3
3831
4629
  */
3832
4630
  sort?: Sorting[];
3833
4631
  }
@@ -3837,7 +4635,10 @@ export interface CursorQueryPagingMethodOneOf {
3837
4635
  cursorPaging?: CursorPaging;
3838
4636
  }
3839
4637
  export interface Sorting {
3840
- /** Name of the field to sort by. */
4638
+ /**
4639
+ * Name of the field to sort by.
4640
+ * @maxLength 512
4641
+ */
3841
4642
  fieldName?: string;
3842
4643
  /** Sort order. */
3843
4644
  order?: SortOrder;
@@ -3864,7 +4665,10 @@ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
3864
4665
  cursorPaging?: CursorPaging;
3865
4666
  /** 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) */
3866
4667
  filter?: Record<string, any> | null;
3867
- /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
4668
+ /**
4669
+ * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
4670
+ * @maxSize 10
4671
+ */
3868
4672
  sort?: Sorting[];
3869
4673
  /** Free text to match in searchable fields */
3870
4674
  search?: SearchDetails;
@@ -3880,7 +4684,10 @@ export interface CursorSearchPagingMethodOneOf {
3880
4684
  export interface SearchDetails {
3881
4685
  /** Defines how separate search terms in `expression` are combined */
3882
4686
  mode?: Mode;
3883
- /** Search term or expression */
4687
+ /**
4688
+ * Search term or expression
4689
+ * @maxLength 100
4690
+ */
3884
4691
  expression?: string | null;
3885
4692
  /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
3886
4693
  fuzzy?: boolean;
@@ -3940,7 +4747,10 @@ export interface CountSubmissionsByFilterResponse {
3940
4747
  formsSubmissionsCount?: FormSubmissionsCount[];
3941
4748
  }
3942
4749
  export interface FormSubmissionsCount {
3943
- /** Form ID. */
4750
+ /**
4751
+ * Form ID.
4752
+ * @format GUID
4753
+ */
3944
4754
  formId?: string;
3945
4755
  /** Total number of submissions. */
3946
4756
  totalCount?: number;
@@ -3948,9 +4758,18 @@ export interface FormSubmissionsCount {
3948
4758
  unseenCount?: number;
3949
4759
  }
3950
4760
  export interface CountSubmissionsRequest {
3951
- /** Form IDs which submissions should be counted. */
4761
+ /**
4762
+ * Form IDs which submissions should be counted.
4763
+ * @format GUID
4764
+ * @minSize 1
4765
+ * @maxSize 100
4766
+ */
3952
4767
  formIds: string[];
3953
- /** The app which the form submissions belong to. For example, the namespace for the Wix Forms app is `wix.form_app.form`. Call `getSubmission()` to retrieve the namespace. */
4768
+ /**
4769
+ * The app which the form submissions belong to. For example, the namespace for the Wix Forms app is `wix.form_app.form`. Call `getSubmission()` to retrieve the namespace.
4770
+ * @minLength 10
4771
+ * @maxLength 50
4772
+ */
3954
4773
  namespace: string;
3955
4774
  /**
3956
4775
  * Status of the submission.
@@ -3958,6 +4777,7 @@ export interface CountSubmissionsRequest {
3958
4777
  * - `PAYMENT_WAITING`: A form submission requiring payment is created.
3959
4778
  * - `PAYMENT_CANCELED`: An order of a form submission is canceled.
3960
4779
  * - `CONFIRMED`: A submission is recorded in the Wix Forms collection.
4780
+ * @maxSize 4
3961
4781
  */
3962
4782
  statuses?: SubmissionStatus[];
3963
4783
  }
@@ -3966,13 +4786,23 @@ export interface CountSubmissionsResponse {
3966
4786
  formsSubmissionsCount?: FormSubmissionsCount[];
3967
4787
  }
3968
4788
  export interface CountDeletedSubmissionsRequest {
3969
- /** Form IDs. */
4789
+ /**
4790
+ * Form IDs.
4791
+ * @format GUID
4792
+ * @minSize 1
4793
+ * @maxSize 100
4794
+ */
3970
4795
  formIds: string[];
3971
- /** 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. */
4796
+ /**
4797
+ * 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.
4798
+ * @minLength 10
4799
+ * @maxLength 50
4800
+ */
3972
4801
  namespace: string;
3973
4802
  /**
3974
4803
  * List of statuses of submissions which should be taken into count
3975
4804
  * Default: CONFIRMED, PAYMENT_WAITING, PAYMENT_CANCELED
4805
+ * @maxSize 4
3976
4806
  */
3977
4807
  statuses?: SubmissionStatus[];
3978
4808
  }
@@ -3981,37 +4811,61 @@ export interface CountDeletedSubmissionsResponse {
3981
4811
  formsDeletedSubmissionsCount?: FormDeletedSubmissionsCount[];
3982
4812
  }
3983
4813
  export interface FormDeletedSubmissionsCount {
3984
- /** Form ID. */
4814
+ /**
4815
+ * Form ID.
4816
+ * @format GUID
4817
+ */
3985
4818
  formId?: string;
3986
4819
  /** Total number of submissions. */
3987
4820
  totalCount?: number;
3988
4821
  }
3989
4822
  export interface GetMediaUploadURLRequest {
3990
- /** Form ID. */
4823
+ /**
4824
+ * Form ID.
4825
+ * @format GUID
4826
+ */
3991
4827
  formId: string;
3992
- /** Name of file to upload. */
4828
+ /**
4829
+ * Name of file to upload.
4830
+ * @maxLength 300
4831
+ */
3993
4832
  filename: string;
3994
4833
  /**
3995
4834
  * [Mime type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#) of file to upload.
3996
4835
  *
3997
4836
  * For example, `'image/png'`
4837
+ * @maxLength 100
3998
4838
  */
3999
4839
  mimeType: string;
4000
4840
  }
4001
4841
  export interface GetMediaUploadURLResponse {
4002
- /** Url to upload file. */
4842
+ /**
4843
+ * Url to upload file.
4844
+ * @maxLength 500
4845
+ */
4003
4846
  uploadUrl?: string;
4004
4847
  }
4005
4848
  export interface BulkMarkSubmissionsAsSeenRequest {
4006
- /** Submission IDs to mark as seen. */
4849
+ /**
4850
+ * Submission IDs to mark as seen.
4851
+ * @format GUID
4852
+ * @minSize 1
4853
+ * @maxSize 100
4854
+ */
4007
4855
  ids: string[];
4008
- /** ID of the form which the submissions belong to. */
4856
+ /**
4857
+ * ID of the form which the submissions belong to.
4858
+ * @format GUID
4859
+ */
4009
4860
  formId: string;
4010
4861
  }
4011
4862
  export interface BulkMarkSubmissionsAsSeenResponse {
4012
4863
  }
4013
4864
  export interface GetSubmissionDownloadUrlRequest {
4014
- /** Submission ID. */
4865
+ /**
4866
+ * Submission ID.
4867
+ * @format GUID
4868
+ */
4015
4869
  submissionId: string;
4016
4870
  }
4017
4871
  export interface GetSubmissionDownloadUrlResponse {
@@ -4024,6 +4878,7 @@ export interface SubmissionDocument extends SubmissionDocumentDocumentOneOf {
4024
4878
  /**
4025
4879
  * Document ID.
4026
4880
  * @readonly
4881
+ * @maxLength 50
4027
4882
  */
4028
4883
  _id?: string | null;
4029
4884
  /** Document status. */
@@ -4044,45 +4899,89 @@ export interface DocumentReady {
4044
4899
  /**
4045
4900
  * Document download URL.
4046
4901
  * @readonly
4902
+ * @maxLength 300
4047
4903
  */
4048
4904
  downloadUrl?: string;
4049
4905
  }
4050
4906
  export interface GetFormattedSubmissionRequest {
4051
- /** Submission ID. */
4907
+ /**
4908
+ * Submission ID.
4909
+ * @format GUID
4910
+ */
4052
4911
  submissionId?: string;
4053
4912
  }
4054
4913
  export interface GetFormattedSubmissionResponse {
4055
- /** Submission ID. */
4914
+ /**
4915
+ * Submission ID.
4916
+ * @format GUID
4917
+ */
4056
4918
  submissionId?: string;
4057
- /** Ordered by form layout list of field submissions. */
4919
+ /**
4920
+ * Ordered by form layout list of field submissions.
4921
+ * @maxSize 100
4922
+ */
4058
4923
  submissions?: FormattedSubmission[];
4059
4924
  }
4060
4925
  export interface FormattedSubmission {
4061
- /** Label of form field */
4926
+ /**
4927
+ * Label of form field
4928
+ * @maxLength 500
4929
+ */
4062
4930
  label?: string | null;
4063
- /** Key of the submission, and target of a form field */
4931
+ /**
4932
+ * Key of the submission, and target of a form field
4933
+ * @maxLength 200
4934
+ */
4064
4935
  key?: string;
4065
- /** Value of the submission, formatted as a string */
4936
+ /**
4937
+ * Value of the submission, formatted as a string
4938
+ * @maxLength 500
4939
+ */
4066
4940
  value?: string;
4067
- /** Id of the form field */
4941
+ /**
4942
+ * Id of the form field
4943
+ * @format GUID
4944
+ */
4068
4945
  fieldId?: string;
4069
4946
  }
4070
4947
  export interface ListFormattedSubmissionsRequest {
4071
- /** Namespace. */
4948
+ /**
4949
+ * Namespace.
4950
+ * @minLength 10
4951
+ * @maxLength 50
4952
+ */
4072
4953
  namespace?: string;
4073
- /** Submission IDs. */
4954
+ /**
4955
+ * Submission IDs.
4956
+ * @format GUID
4957
+ * @minSize 1
4958
+ * @maxSize 100
4959
+ */
4074
4960
  submissionIds?: string[];
4075
- /** Optional additional filter of form IDs. */
4961
+ /**
4962
+ * Optional additional filter of form IDs.
4963
+ * @format GUID
4964
+ * @maxSize 100
4965
+ */
4076
4966
  formIds?: string[];
4077
4967
  }
4078
4968
  export interface ListFormattedSubmissionsResponse {
4079
- /** List of formatted submissions */
4969
+ /**
4970
+ * List of formatted submissions
4971
+ * @maxSize 100
4972
+ */
4080
4973
  formattedFormSubmissions?: FormattedFormSubmission[];
4081
4974
  }
4082
4975
  export interface FormattedFormSubmission {
4083
- /** Submission ID. */
4976
+ /**
4977
+ * Submission ID.
4978
+ * @format GUID
4979
+ */
4084
4980
  submissionId?: string;
4085
- /** Ordered by form layout list of field submissions. */
4981
+ /**
4982
+ * Ordered by form layout list of field submissions.
4983
+ * @maxSize 100
4984
+ */
4086
4985
  submissions?: FormattedSubmission[];
4087
4986
  }
4088
4987
  export interface UpdateExtendedFieldsRequest {
@@ -4094,13 +4993,22 @@ export interface UpdateExtendedFieldsRequest {
4094
4993
  namespaceData: Record<string, any> | null;
4095
4994
  }
4096
4995
  export interface UpdateExtendedFieldsResponse {
4097
- /** namespace that was updated */
4996
+ /**
4997
+ * namespace that was updated
4998
+ * @minLength 10
4999
+ * @maxLength 50
5000
+ */
4098
5001
  namespace?: string;
4099
5002
  /** only data from UpdateExtendedFieldsRequest namespace_data */
4100
5003
  namespaceData?: Record<string, any> | null;
4101
5004
  }
4102
5005
  export interface BulkUpdateFormSubmissionTagsRequest {
4103
- /** Submission IDs to update tags for. */
5006
+ /**
5007
+ * Submission IDs to update tags for.
5008
+ * @format GUID
5009
+ * @minSize 1
5010
+ * @maxSize 100
5011
+ */
4104
5012
  submissionIds: string[];
4105
5013
  /** Tags to be added to submissions */
4106
5014
  assignTags?: PublicTags;
@@ -4108,7 +5016,11 @@ export interface BulkUpdateFormSubmissionTagsRequest {
4108
5016
  unassignTags?: PublicTags;
4109
5017
  }
4110
5018
  export interface BulkUpdateFormSubmissionTagsResponse {
4111
- /** Updated submissions with results */
5019
+ /**
5020
+ * Updated submissions with results
5021
+ * @minSize 1
5022
+ * @maxSize 100
5023
+ */
4112
5024
  results?: BulkUpdateFormSubmissionTagsResult[];
4113
5025
  /** Metadata of request */
4114
5026
  bulkActionMetadata?: BulkActionMetadata;
@@ -4126,7 +5038,10 @@ export interface BulkUpdateFormSubmissionTagsByFilterRequest {
4126
5038
  unassignTags?: PublicTags;
4127
5039
  }
4128
5040
  export interface BulkUpdateFormSubmissionTagsByFilterResponse {
4129
- /** Job id for the bulk update operation */
5041
+ /**
5042
+ * Job id for the bulk update operation
5043
+ * @format GUID
5044
+ */
4130
5045
  jobId?: string;
4131
5046
  }
4132
5047
  export interface ValidateFormSubmissionRequest {
@@ -4141,17 +5056,29 @@ export interface ValidateFormSubmissionResponse {
4141
5056
  * Default: true
4142
5057
  */
4143
5058
  valid?: boolean | null;
4144
- /** Submission validation violations */
5059
+ /**
5060
+ * Submission validation violations
5061
+ * @maxSize 100
5062
+ */
4145
5063
  violationErrors?: FieldViolation[];
4146
5064
  }
4147
5065
  export interface FieldViolation extends FieldViolationErrorDataOneOf {
4148
5066
  /** Validation errors */
4149
5067
  submissionValidationErrors?: SubmissionValidationErrors;
4150
- /** Name of violated entity */
5068
+ /**
5069
+ * Name of violated entity
5070
+ * @maxLength 50
5071
+ */
4151
5072
  name?: string;
4152
- /** Description of the error */
5073
+ /**
5074
+ * Description of the error
5075
+ * @maxLength 512
5076
+ */
4153
5077
  description?: string;
4154
- /** Rule name */
5078
+ /**
5079
+ * Rule name
5080
+ * @maxLength 50
5081
+ */
4155
5082
  ruleName?: string;
4156
5083
  }
4157
5084
  /** @oneof */
@@ -4160,15 +5087,24 @@ export interface FieldViolationErrorDataOneOf {
4160
5087
  submissionValidationErrors?: SubmissionValidationErrors;
4161
5088
  }
4162
5089
  export interface SubmissionValidationErrors {
4163
- /** Submission validation errors. */
5090
+ /**
5091
+ * Submission validation errors.
5092
+ * @maxSize 100
5093
+ */
4164
5094
  errors?: SubmissionValidationError[];
4165
5095
  }
4166
5096
  export interface SubmissionValidationError extends SubmissionValidationErrorErrorMessageOneOf {
4167
5097
  /** Predefined error type. */
4168
5098
  errorType?: SubmissionErrorType;
4169
- /** Custom error message. The message is displayed instead of an error type. */
5099
+ /**
5100
+ * Custom error message. The message is displayed instead of an error type.
5101
+ * @maxLength 500
5102
+ */
4170
5103
  customErrorMessage?: string;
4171
- /** Path indicating the source of the error, such as `form.fields.target`. */
5104
+ /**
5105
+ * Path indicating the source of the error, such as `form.fields.target`.
5106
+ * @maxLength 500
5107
+ */
4172
5108
  errorPath?: string;
4173
5109
  /** Additional error parameters. */
4174
5110
  params?: Record<string, any> | null;
@@ -4177,7 +5113,10 @@ export interface SubmissionValidationError extends SubmissionValidationErrorErro
4177
5113
  export interface SubmissionValidationErrorErrorMessageOneOf {
4178
5114
  /** Predefined error type. */
4179
5115
  errorType?: SubmissionErrorType;
4180
- /** Custom error message. The message is displayed instead of an error type. */
5116
+ /**
5117
+ * Custom error message. The message is displayed instead of an error type.
5118
+ * @maxLength 500
5119
+ */
4181
5120
  customErrorMessage?: string;
4182
5121
  }
4183
5122
  export declare enum SubmissionErrorType {
@@ -4212,45 +5151,13 @@ export declare enum SubmissionErrorType {
4212
5151
  /** Submitted form is disabled. */
4213
5152
  DISABLED_FORM_ERROR = "DISABLED_FORM_ERROR"
4214
5153
  }
4215
- export interface UpsertContactFromSubmissionRequest {
4216
- /** Submission from which contact needs to be upserted. */
4217
- submissionId: string;
4218
- /** Optional contact id to which submission should be mapped. */
4219
- contactId?: string | null;
4220
- /** Indicates contact has verified primary email. */
4221
- emailVerified?: boolean;
4222
- }
4223
- export interface UpsertContactFromSubmissionResponse {
4224
- /** Submit contact response. */
4225
- submitContactResponse?: SubmitContactResponse;
4226
- }
4227
- export interface SubmitContactResponse {
4228
- /** ID of the contact that was found or created. */
4229
- contactId?: string;
4230
- /**
4231
- * Identity type of the returned contact.
4232
- *
4233
- * - `CONTACT`: The returned contact ID belongs to a new or existing contact.
4234
- * - `MEMBER`: The returned contact ID belongs to the currently logged-in site member.
4235
- * - `NOT_AUTHENTICATED_MEMBER`: The returned contact ID belongs to a site member who is not currently logged in.
4236
- */
4237
- identityType?: IdentityType;
4238
- /**
4239
- * Indicates whether the contact was just created or already existed.
4240
- *
4241
- * If the contact was just created, returns `true`.
4242
- * If it already existed, returns `false`.
4243
- */
4244
- newContact?: boolean;
5154
+ interface SubmitContactResponseNonNullableFields {
5155
+ contactId: string;
5156
+ identityType: IdentityType;
5157
+ newContact: boolean;
4245
5158
  }
4246
- export declare enum IdentityType {
4247
- UNKNOWN = "UNKNOWN",
4248
- /** Existing or new contact */
4249
- CONTACT = "CONTACT",
4250
- /** Member is logged in, matching logic skipped */
4251
- MEMBER = "MEMBER",
4252
- /** Matching contact is a member, Merge logic won't be applied */
4253
- NOT_AUTHENTICATED_MEMBER = "NOT_AUTHENTICATED_MEMBER"
5159
+ export interface UpsertContactFromSubmissionResponseNonNullableFields {
5160
+ submitContactResponse?: SubmitContactResponseNonNullableFields;
4254
5161
  }
4255
5162
  interface OrderDetailsNonNullableFields {
4256
5163
  itemSubtotal: string;
@@ -4398,18 +5305,16 @@ interface FieldViolationNonNullableFields {
4398
5305
  export interface ValidateFormSubmissionResponseNonNullableFields {
4399
5306
  violationErrors: FieldViolationNonNullableFields[];
4400
5307
  }
4401
- interface SubmitContactResponseNonNullableFields {
4402
- contactId: string;
4403
- identityType: IdentityType;
4404
- newContact: boolean;
4405
- }
4406
- export interface UpsertContactFromSubmissionResponseNonNullableFields {
4407
- submitContactResponse?: SubmitContactResponseNonNullableFields;
4408
- }
4409
5308
  export interface BaseEventMetadata {
4410
- /** App instance ID. */
5309
+ /**
5310
+ * App instance ID.
5311
+ * @format GUID
5312
+ */
4411
5313
  instanceId?: string | null;
4412
- /** Event type. */
5314
+ /**
5315
+ * Event type.
5316
+ * @maxLength 150
5317
+ */
4413
5318
  eventType?: string;
4414
5319
  /** The identification type and identity data. */
4415
5320
  identity?: IdentificationData;
@@ -4600,6 +5505,25 @@ export interface SubmissionUpdatedEnvelope {
4600
5505
  * @documentationMaturity preview
4601
5506
  */
4602
5507
  export declare function onSubmissionUpdated(handler: (event: SubmissionUpdatedEnvelope) => void | Promise<void>): void;
5508
+ /**
5509
+ * Upserts contact from submission.
5510
+ * @param submissionId - Submission from which contact needs to be upserted.
5511
+ * @public
5512
+ * @documentationMaturity preview
5513
+ * @requiredField submissionId
5514
+ * @permissionId WIX_FORMS.SUBMISSION_CONTACT_UPSERT
5515
+ * @fqn wix.forms.v4.FormSubmissionContactUpsertService.UpsertContactFromSubmission
5516
+ */
5517
+ export declare function upsertContactFromSubmission(submissionId: string, options?: UpsertContactFromSubmissionOptions): Promise<UpsertContactFromSubmissionResponse & UpsertContactFromSubmissionResponseNonNullableFields>;
5518
+ export interface UpsertContactFromSubmissionOptions {
5519
+ /**
5520
+ * Optional contact id to which submission should be mapped.
5521
+ * @format GUID
5522
+ */
5523
+ contactId?: string | null;
5524
+ /** Indicates contact has verified primary email. */
5525
+ emailVerified?: boolean;
5526
+ }
4603
5527
  /**
4604
5528
  * Creates a submission.
4605
5529
  *
@@ -4620,7 +5544,11 @@ export declare function onSubmissionUpdated(handler: (event: SubmissionUpdatedEn
4620
5544
  */
4621
5545
  export declare function createSubmission(submission: FormSubmission, options?: CreateSubmissionOptions): Promise<FormSubmission & FormSubmissionNonNullableFields>;
4622
5546
  export interface CreateSubmissionOptions {
4623
- /** Captcha token. */
5547
+ /**
5548
+ * Captcha token.
5549
+ * @minLength 1
5550
+ * @maxLength 3000
5551
+ */
4624
5552
  captchaToken?: string | null;
4625
5553
  }
4626
5554
  /**
@@ -4640,11 +5568,15 @@ export interface BulkCreateSubmissionBySubmitterOptions {
4640
5568
  /**
4641
5569
  * Submissions to create.
4642
5570
  * Deprecated
5571
+ * @maxSize 100
4643
5572
  */
4644
5573
  submissions?: FormSubmission[];
4645
5574
  /** When set, items will be returned on successful create. */
4646
5575
  returnEntity?: boolean;
4647
- /** Submissions data to create. */
5576
+ /**
5577
+ * Submissions data to create.
5578
+ * @maxSize 100
5579
+ */
4648
5580
  submissionsV2?: BulkCreateSubmissionBySubmitterData[];
4649
5581
  /** Validation will be mode is more forgiving, for example "required" won't be validated. */
4650
5582
  lenientValidation?: boolean;
@@ -4691,13 +5623,20 @@ export declare function updateSubmission(_id: string | null, submission: UpdateS
4691
5623
  export interface UpdateSubmission {
4692
5624
  /**
4693
5625
  * Submission ID.
5626
+ * @format GUID
4694
5627
  * @readonly
4695
5628
  */
4696
5629
  _id?: string | null;
4697
- /** ID of the form which the submission belongs to. */
5630
+ /**
5631
+ * ID of the form which the submission belongs to.
5632
+ * @format GUID
5633
+ * @immutable
5634
+ */
4698
5635
  formId?: string;
4699
5636
  /**
4700
5637
  * 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.
5638
+ * @minLength 10
5639
+ * @maxLength 50
4701
5640
  * @readonly
4702
5641
  */
4703
5642
  namespace?: string;
@@ -4705,7 +5644,10 @@ export interface UpdateSubmission {
4705
5644
  status?: SubmissionStatus;
4706
5645
  /** Submission values where `key` is the form field and `value` is the data submitted for the given field. */
4707
5646
  submissions?: Record<string, any>;
4708
- /** Date and time the form submission was created. */
5647
+ /**
5648
+ * Date and time the form submission was created.
5649
+ * @immutable
5650
+ */
4709
5651
  _createdDate?: Date | null;
4710
5652
  /**
4711
5653
  * Date and time the form submission was updated.
@@ -4728,14 +5670,22 @@ export interface UpdateSubmission {
4728
5670
  extendedFields?: ExtendedFields;
4729
5671
  /**
4730
5672
  * Order details. <br>
4731
- * <b>Note</b>: This object is only applicable when submittng a form in the Wix Payments app.
5673
+ * <b>Note</b>: This object is only applicable when submitting a form in the Wix Payments app.
4732
5674
  */
4733
5675
  orderDetails?: OrderDetails;
4734
- /** Contact ID of a site visitor who created the submission. */
5676
+ /**
5677
+ * Contact ID of a site visitor who created the submission.
5678
+ * @format GUID
5679
+ * @immutable
5680
+ */
4735
5681
  contactId?: string | null;
4736
- /** authorized viewer user id */
5682
+ /**
5683
+ * Authorized viewer ID.
5684
+ * @format GUID
5685
+ * @immutable
5686
+ */
4737
5687
  accessRestriction?: string | null;
4738
- /** Tag ids collections associated with current entity. */
5688
+ /** Tag IDs collections associated with the current entity. */
4739
5689
  tags?: PublicTags;
4740
5690
  }
4741
5691
  /**
@@ -4796,7 +5746,12 @@ export interface DeleteSubmissionOptions {
4796
5746
  */
4797
5747
  export declare function bulkDeleteSubmission(formId: string, options?: BulkDeleteSubmissionOptions): Promise<BulkDeleteSubmissionResponse & BulkDeleteSubmissionResponseNonNullableFields>;
4798
5748
  export interface BulkDeleteSubmissionOptions {
4799
- /** Submission ids. */
5749
+ /**
5750
+ * Submission ids.
5751
+ * @minSize 1
5752
+ * @maxSize 100
5753
+ * @format GUID
5754
+ */
4800
5755
  submissionIds?: string[];
4801
5756
  /**
4802
5757
  * Delete submission bypassing trash-bin
@@ -4846,7 +5801,12 @@ export declare function removeSubmissionFromTrashBin(submissionId: string): Prom
4846
5801
  */
4847
5802
  export declare function bulkRemoveSubmissionFromTrashBin(formId: string, options?: BulkRemoveSubmissionFromTrashBinOptions): Promise<BulkRemoveSubmissionFromTrashBinResponse & BulkRemoveSubmissionFromTrashBinResponseNonNullableFields>;
4848
5803
  export interface BulkRemoveSubmissionFromTrashBinOptions {
4849
- /** Submission ids. */
5804
+ /**
5805
+ * Submission ids.
5806
+ * @minSize 1
5807
+ * @maxSize 100
5808
+ * @format GUID
5809
+ */
4850
5810
  submissionIds?: string[];
4851
5811
  }
4852
5812
  /**
@@ -4869,13 +5829,18 @@ export interface BulkRemoveSubmissionFromTrashBinOptions {
4869
5829
  */
4870
5830
  export declare function listDeletedSubmissions(formId: string, options?: ListDeletedSubmissionsOptions): Promise<ListDeletedSubmissionsResponse & ListDeletedSubmissionsResponseNonNullableFields>;
4871
5831
  export interface ListDeletedSubmissionsOptions {
4872
- /** Submission ids. */
5832
+ /**
5833
+ * Submission ids.
5834
+ * @maxSize 10
5835
+ * @format GUID
5836
+ */
4873
5837
  submissionIds?: string[];
4874
5838
  /** 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`. */
4875
5839
  paging?: CursorPaging;
4876
5840
  /**
4877
5841
  * List of statuses of submissions which should be returned
4878
5842
  * Default: CONFIRMED
5843
+ * @maxSize 4
4879
5844
  */
4880
5845
  statuses?: SubmissionStatus[];
4881
5846
  }
@@ -5032,6 +5997,27 @@ export interface SubmissionsQueryBuilder {
5032
5997
  skipTo: (cursor: string) => SubmissionsQueryBuilder;
5033
5998
  find: () => Promise<SubmissionsQueryResult>;
5034
5999
  }
6000
+ /**
6001
+ * > **Note:** The Form Submission API only works with the Wix Forms app. Call [GetAppInstance](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/get-app-instance) to confirm that the app named `wix_forms` is installed on the site.
6002
+ * <br>
6003
+ * Counts the number of submissions belonging to forms that were filtered and contain a provided expression.
6004
+ * @param filter - A filter object. Must filter by namespace.
6005
+ * @public
6006
+ * @documentationMaturity preview
6007
+ * @requiredField filter
6008
+ * @permissionId WIX_FORMS.SUBMISSION_READ_ANY
6009
+ * @permissionScope Manage Submissions
6010
+ * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
6011
+ * @permissionScope Manage Orders
6012
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
6013
+ * @permissionScope Read Orders
6014
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
6015
+ * @permissionScope Read Submissions
6016
+ * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS
6017
+ * @applicableIdentity APP
6018
+ * @fqn wix.forms.v4.FormSubmissionService.CountSubmissionsByFilter
6019
+ */
6020
+ export declare function countSubmissionsByFilter(filter: Record<string, any> | null, options?: CountSubmissionsByFilterOptions): Promise<CountSubmissionsByFilterResponse & CountSubmissionsByFilterResponseNonNullableFields>;
5035
6021
  export interface CountSubmissionsByFilterOptions {
5036
6022
  /** Free text to match in searchable fields. */
5037
6023
  search?: SearchDetails;
@@ -5066,6 +6052,7 @@ export interface CountSubmissionsOptions {
5066
6052
  * - `PAYMENT_WAITING`: A form submission requiring payment is created.
5067
6053
  * - `PAYMENT_CANCELED`: An order of a form submission is canceled.
5068
6054
  * - `CONFIRMED`: A submission is recorded in the Wix Forms collection.
6055
+ * @maxSize 4
5069
6056
  */
5070
6057
  statuses?: SubmissionStatus[];
5071
6058
  }
@@ -5097,6 +6084,7 @@ export interface CountDeletedSubmissionsOptions {
5097
6084
  /**
5098
6085
  * List of statuses of submissions which should be taken into count
5099
6086
  * Default: CONFIRMED, PAYMENT_WAITING, PAYMENT_CANCELED
6087
+ * @maxSize 4
5100
6088
  */
5101
6089
  statuses?: SubmissionStatus[];
5102
6090
  }
@@ -5196,20 +6184,4 @@ export interface ValidateFormSubmissionOptions {
5196
6184
  /** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
5197
6185
  additionalMetadata?: Record<string, any> | null;
5198
6186
  }
5199
- /**
5200
- * Upserts contact from submission.
5201
- * @param submissionId - Submission from which contact needs to be upserted.
5202
- * @public
5203
- * @documentationMaturity preview
5204
- * @requiredField submissionId
5205
- * @permissionId WIX_FORMS.SUBMISSION_CONTACT_UPSERT
5206
- * @fqn wix.forms.v4.FormSubmissionContactUpsertService.UpsertContactFromSubmission
5207
- */
5208
- export declare function upsertContactFromSubmission(submissionId: string, options?: UpsertContactFromSubmissionOptions): Promise<UpsertContactFromSubmissionResponse & UpsertContactFromSubmissionResponseNonNullableFields>;
5209
- export interface UpsertContactFromSubmissionOptions {
5210
- /** Optional contact id to which submission should be mapped. */
5211
- contactId?: string | null;
5212
- /** Indicates contact has verified primary email. */
5213
- emailVerified?: boolean;
5214
- }
5215
6187
  export {};