@wix/auto_sdk_forms_submissions 1.0.4 → 1.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/forms-v4-submission-submissions.context.d.ts +4 -4
- package/build/cjs/src/forms-v4-submission-submissions.context.js +4 -4
- package/build/cjs/src/forms-v4-submission-submissions.context.js.map +1 -1
- package/build/cjs/src/forms-v4-submission-submissions.http.d.ts +3 -3
- package/build/cjs/src/forms-v4-submission-submissions.http.js +55 -55
- package/build/cjs/src/forms-v4-submission-submissions.http.js.map +1 -1
- package/build/cjs/src/forms-v4-submission-submissions.meta.d.ts +1 -1
- package/build/cjs/src/forms-v4-submission-submissions.meta.js +20 -20
- package/build/cjs/src/forms-v4-submission-submissions.meta.js.map +1 -1
- package/build/cjs/src/forms-v4-submission-submissions.public.d.ts +9 -9
- package/build/cjs/src/forms-v4-submission-submissions.public.js +7 -7
- package/build/cjs/src/forms-v4-submission-submissions.public.js.map +1 -1
- package/build/cjs/src/forms-v4-submission-submissions.types.d.ts +1199 -306
- package/build/cjs/src/forms-v4-submission-submissions.types.js +11 -11
- package/build/cjs/src/forms-v4-submission-submissions.types.js.map +1 -1
- package/build/cjs/src/forms-v4-submission-submissions.universal.d.ts +1268 -333
- package/build/cjs/src/forms-v4-submission-submissions.universal.js +51 -51
- package/build/cjs/src/forms-v4-submission-submissions.universal.js.map +1 -1
- package/build/es/src/forms-v4-submission-submissions.context.d.ts +4 -4
- package/build/es/src/forms-v4-submission-submissions.context.js +3 -3
- package/build/es/src/forms-v4-submission-submissions.context.js.map +1 -1
- package/build/es/src/forms-v4-submission-submissions.http.d.ts +3 -3
- package/build/es/src/forms-v4-submission-submissions.http.js +53 -53
- package/build/es/src/forms-v4-submission-submissions.http.js.map +1 -1
- package/build/es/src/forms-v4-submission-submissions.meta.d.ts +1 -1
- package/build/es/src/forms-v4-submission-submissions.meta.js +18 -18
- package/build/es/src/forms-v4-submission-submissions.meta.js.map +1 -1
- package/build/es/src/forms-v4-submission-submissions.public.d.ts +9 -9
- package/build/es/src/forms-v4-submission-submissions.public.js +5 -5
- package/build/es/src/forms-v4-submission-submissions.public.js.map +1 -1
- package/build/es/src/forms-v4-submission-submissions.types.d.ts +1199 -306
- package/build/es/src/forms-v4-submission-submissions.types.js +10 -10
- package/build/es/src/forms-v4-submission-submissions.types.js.map +1 -1
- package/build/es/src/forms-v4-submission-submissions.universal.d.ts +1268 -333
- package/build/es/src/forms-v4-submission-submissions.universal.js +49 -49
- package/build/es/src/forms-v4-submission-submissions.universal.js.map +1 -1
- package/build/internal/cjs/src/forms-v4-submission-submissions.context.d.ts +4 -4
- package/build/internal/cjs/src/forms-v4-submission-submissions.context.js +4 -4
- package/build/internal/cjs/src/forms-v4-submission-submissions.context.js.map +1 -1
- package/build/internal/cjs/src/forms-v4-submission-submissions.http.d.ts +3 -3
- package/build/internal/cjs/src/forms-v4-submission-submissions.http.js +55 -55
- package/build/internal/cjs/src/forms-v4-submission-submissions.http.js.map +1 -1
- package/build/internal/cjs/src/forms-v4-submission-submissions.meta.d.ts +1 -1
- package/build/internal/cjs/src/forms-v4-submission-submissions.meta.js +20 -20
- package/build/internal/cjs/src/forms-v4-submission-submissions.meta.js.map +1 -1
- package/build/internal/cjs/src/forms-v4-submission-submissions.public.d.ts +9 -9
- package/build/internal/cjs/src/forms-v4-submission-submissions.public.js +7 -7
- package/build/internal/cjs/src/forms-v4-submission-submissions.public.js.map +1 -1
- package/build/internal/cjs/src/forms-v4-submission-submissions.types.d.ts +1199 -306
- package/build/internal/cjs/src/forms-v4-submission-submissions.types.js +11 -11
- package/build/internal/cjs/src/forms-v4-submission-submissions.types.js.map +1 -1
- package/build/internal/cjs/src/forms-v4-submission-submissions.universal.d.ts +1268 -333
- package/build/internal/cjs/src/forms-v4-submission-submissions.universal.js +51 -51
- package/build/internal/cjs/src/forms-v4-submission-submissions.universal.js.map +1 -1
- package/build/internal/es/src/forms-v4-submission-submissions.context.d.ts +4 -4
- package/build/internal/es/src/forms-v4-submission-submissions.context.js +3 -3
- package/build/internal/es/src/forms-v4-submission-submissions.context.js.map +1 -1
- package/build/internal/es/src/forms-v4-submission-submissions.http.d.ts +3 -3
- package/build/internal/es/src/forms-v4-submission-submissions.http.js +53 -53
- package/build/internal/es/src/forms-v4-submission-submissions.http.js.map +1 -1
- package/build/internal/es/src/forms-v4-submission-submissions.meta.d.ts +1 -1
- package/build/internal/es/src/forms-v4-submission-submissions.meta.js +18 -18
- package/build/internal/es/src/forms-v4-submission-submissions.meta.js.map +1 -1
- package/build/internal/es/src/forms-v4-submission-submissions.public.d.ts +9 -9
- package/build/internal/es/src/forms-v4-submission-submissions.public.js +5 -5
- package/build/internal/es/src/forms-v4-submission-submissions.public.js.map +1 -1
- package/build/internal/es/src/forms-v4-submission-submissions.types.d.ts +1199 -306
- package/build/internal/es/src/forms-v4-submission-submissions.types.js +10 -10
- package/build/internal/es/src/forms-v4-submission-submissions.types.js.map +1 -1
- package/build/internal/es/src/forms-v4-submission-submissions.universal.d.ts +1268 -333
- package/build/internal/es/src/forms-v4-submission-submissions.universal.js +49 -49
- package/build/internal/es/src/forms-v4-submission-submissions.universal.js.map +1 -1
- 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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
|
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
|
-
/**
|
|
55
|
+
/**
|
|
56
|
+
* Contact ID of a site visitor who created the submission.
|
|
57
|
+
* @format GUID
|
|
58
|
+
* @immutable
|
|
59
|
+
*/
|
|
46
60
|
contactId?: string | null;
|
|
47
|
-
/**
|
|
61
|
+
/**
|
|
62
|
+
* Authorized viewer ID.
|
|
63
|
+
* @format GUID
|
|
64
|
+
* @immutable
|
|
65
|
+
*/
|
|
48
66
|
accessRestriction?: string | null;
|
|
49
|
-
/** Tag
|
|
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
|
-
/**
|
|
82
|
+
/**
|
|
83
|
+
* Member ID.
|
|
84
|
+
* @format GUID
|
|
85
|
+
*/
|
|
65
86
|
memberId?: string | null;
|
|
66
|
-
/**
|
|
87
|
+
/**
|
|
88
|
+
* Visitor ID.
|
|
89
|
+
* @format GUID
|
|
90
|
+
*/
|
|
67
91
|
visitorId?: string | null;
|
|
68
|
-
/**
|
|
92
|
+
/**
|
|
93
|
+
* Application ID.
|
|
94
|
+
* @maxLength 36
|
|
95
|
+
*/
|
|
69
96
|
applicationId?: string | null;
|
|
70
|
-
/**
|
|
97
|
+
/**
|
|
98
|
+
* User ID.
|
|
99
|
+
* @format GUID
|
|
100
|
+
*/
|
|
71
101
|
userId?: string | null;
|
|
72
102
|
}
|
|
73
103
|
/** @oneof */
|
|
74
104
|
export interface SubmitterSubmitterOneOf {
|
|
75
|
-
/**
|
|
105
|
+
/**
|
|
106
|
+
* Member ID.
|
|
107
|
+
* @format GUID
|
|
108
|
+
*/
|
|
76
109
|
memberId?: string | null;
|
|
77
|
-
/**
|
|
110
|
+
/**
|
|
111
|
+
* Visitor ID.
|
|
112
|
+
* @format GUID
|
|
113
|
+
*/
|
|
78
114
|
visitorId?: string | null;
|
|
79
|
-
/**
|
|
115
|
+
/**
|
|
116
|
+
* Application ID.
|
|
117
|
+
* @maxLength 36
|
|
118
|
+
*/
|
|
80
119
|
applicationId?: string | null;
|
|
81
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
208
|
+
/**
|
|
209
|
+
* Form id which was submitted
|
|
210
|
+
* @format GUID
|
|
211
|
+
*/
|
|
153
212
|
formId?: string;
|
|
154
|
-
/**
|
|
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
|
-
/**
|
|
237
|
+
/**
|
|
238
|
+
* Form Id.
|
|
239
|
+
* @format GUID
|
|
240
|
+
*/
|
|
175
241
|
formId?: string;
|
|
176
|
-
/**
|
|
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
|
-
/**
|
|
280
|
+
/**
|
|
281
|
+
* Defines the layout for form fields in each submission step.
|
|
282
|
+
* @maxSize 100
|
|
283
|
+
*/
|
|
207
284
|
steps?: Step[];
|
|
208
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
|
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
|
-
/**
|
|
382
|
+
/**
|
|
383
|
+
* Item ID.
|
|
384
|
+
* @format GUID
|
|
385
|
+
* @immutable
|
|
386
|
+
*/
|
|
287
387
|
_id?: string;
|
|
288
|
-
/**
|
|
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
|
-
/**
|
|
421
|
+
/**
|
|
422
|
+
* Minimum length.
|
|
423
|
+
* @max 20000
|
|
424
|
+
*/
|
|
318
425
|
minLength?: number | null;
|
|
319
|
-
/**
|
|
426
|
+
/**
|
|
427
|
+
* Maximum length.
|
|
428
|
+
* @max 20000
|
|
429
|
+
*/
|
|
320
430
|
maxLength?: number | null;
|
|
321
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
518
|
+
/**
|
|
519
|
+
* List of allowed values.
|
|
520
|
+
* @maxSize 500
|
|
521
|
+
*/
|
|
393
522
|
enum?: number[] | null;
|
|
394
523
|
}
|
|
395
524
|
export interface NumberErrorMessages {
|
|
396
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
549
|
+
/**
|
|
550
|
+
* List of allowed values.
|
|
551
|
+
* @maxSize 2
|
|
552
|
+
*/
|
|
415
553
|
enum?: boolean[];
|
|
416
554
|
}
|
|
417
555
|
export interface BooleanErrorMessages {
|
|
418
|
-
/**
|
|
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
|
-
/**
|
|
563
|
+
/**
|
|
564
|
+
* Maximum amount of array elements.
|
|
565
|
+
* @max 1000
|
|
566
|
+
*/
|
|
423
567
|
maxItems?: number | null;
|
|
424
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
677
|
+
/**
|
|
678
|
+
* Field mapped to products.
|
|
679
|
+
* @minSize 1
|
|
680
|
+
* @maxSize 100
|
|
681
|
+
*/
|
|
525
682
|
products?: Product[];
|
|
526
|
-
/**
|
|
683
|
+
/**
|
|
684
|
+
* Minimum amount of different products.
|
|
685
|
+
* @max 100
|
|
686
|
+
*/
|
|
527
687
|
minItems?: number | null;
|
|
528
|
-
/**
|
|
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
|
-
/**
|
|
711
|
+
/**
|
|
712
|
+
* Minimum quantity.
|
|
713
|
+
* @min 1
|
|
714
|
+
* @max 100000
|
|
715
|
+
*/
|
|
549
716
|
minimum?: number | null;
|
|
550
|
-
/**
|
|
717
|
+
/**
|
|
718
|
+
* Maximum quantity.
|
|
719
|
+
* @min 1
|
|
720
|
+
* @max 100000
|
|
721
|
+
*/
|
|
551
722
|
maximum?: number | null;
|
|
552
723
|
}
|
|
553
724
|
export interface FixedPriceOptions {
|
|
554
|
-
/**
|
|
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
|
-
/**
|
|
732
|
+
/**
|
|
733
|
+
* Minimal price monetary amount.
|
|
734
|
+
* @decimalValue options { gte:0.00, maxScale:2 }
|
|
735
|
+
*/
|
|
559
736
|
minPrice?: string;
|
|
560
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
894
|
+
/**
|
|
895
|
+
* Minimum length.
|
|
896
|
+
* @max 20000
|
|
897
|
+
*/
|
|
701
898
|
minLength?: number | null;
|
|
702
|
-
/**
|
|
899
|
+
/**
|
|
900
|
+
* Maximum length.
|
|
901
|
+
* @max 20000
|
|
902
|
+
*/
|
|
703
903
|
maxLength?: number | null;
|
|
704
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
1615
|
+
/**
|
|
1616
|
+
* GIF format URL.
|
|
1617
|
+
* @format WEB_URL
|
|
1618
|
+
*/
|
|
1391
1619
|
gif?: string | null;
|
|
1392
|
-
/**
|
|
1620
|
+
/**
|
|
1621
|
+
* MP4 format URL.
|
|
1622
|
+
* @format WEB_URL
|
|
1623
|
+
*/
|
|
1393
1624
|
mp4?: string | null;
|
|
1394
|
-
/**
|
|
1625
|
+
/**
|
|
1626
|
+
* Thumbnail URL.
|
|
1627
|
+
* @format WEB_URL
|
|
1628
|
+
*/
|
|
1395
1629
|
still?: string | null;
|
|
1396
1630
|
}
|
|
1397
1631
|
export declare enum GIFType {
|
|
@@ -1465,7 +1699,10 @@ export interface ImageData {
|
|
|
1465
1699
|
export interface StylesBorder {
|
|
1466
1700
|
/** Border width in pixels. */
|
|
1467
1701
|
width?: number | null;
|
|
1468
|
-
/**
|
|
1702
|
+
/**
|
|
1703
|
+
* Border color as a hexadecimal value.
|
|
1704
|
+
* @format COLOR_HEX
|
|
1705
|
+
*/
|
|
1469
1706
|
color?: string | null;
|
|
1470
1707
|
/** Border radius in pixels. */
|
|
1471
1708
|
radius?: number | null;
|
|
@@ -1619,13 +1856,22 @@ export declare enum BackgroundType {
|
|
|
1619
1856
|
export interface Gradient {
|
|
1620
1857
|
/** The gradient angle in degrees. */
|
|
1621
1858
|
angle?: number | null;
|
|
1622
|
-
/**
|
|
1859
|
+
/**
|
|
1860
|
+
* The start color as a hexademical value.
|
|
1861
|
+
* @format COLOR_HEX
|
|
1862
|
+
*/
|
|
1623
1863
|
startColor?: string | null;
|
|
1624
|
-
/**
|
|
1864
|
+
/**
|
|
1865
|
+
* The end color as a hexademical value.
|
|
1866
|
+
* @format COLOR_HEX
|
|
1867
|
+
*/
|
|
1625
1868
|
lastColor?: string | null;
|
|
1626
1869
|
}
|
|
1627
1870
|
export interface Background extends BackgroundBackgroundOneOf {
|
|
1628
|
-
/**
|
|
1871
|
+
/**
|
|
1872
|
+
* The background color as a hexademical value.
|
|
1873
|
+
* @format COLOR_HEX
|
|
1874
|
+
*/
|
|
1629
1875
|
color?: string | null;
|
|
1630
1876
|
/** An image to use for the background. */
|
|
1631
1877
|
image?: Media;
|
|
@@ -1636,7 +1882,10 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1636
1882
|
}
|
|
1637
1883
|
/** @oneof */
|
|
1638
1884
|
export interface BackgroundBackgroundOneOf {
|
|
1639
|
-
/**
|
|
1885
|
+
/**
|
|
1886
|
+
* The background color as a hexademical value.
|
|
1887
|
+
* @format COLOR_HEX
|
|
1888
|
+
*/
|
|
1640
1889
|
color?: string | null;
|
|
1641
1890
|
/** An image to use for the background. */
|
|
1642
1891
|
image?: Media;
|
|
@@ -1948,17 +2197,32 @@ export declare enum VerticalAlignment {
|
|
|
1948
2197
|
export interface CellStyle {
|
|
1949
2198
|
/** Vertical alignment for the cell's text. */
|
|
1950
2199
|
verticalAlignment?: VerticalAlignment;
|
|
1951
|
-
/**
|
|
2200
|
+
/**
|
|
2201
|
+
* Cell background color as a hexadecimal value.
|
|
2202
|
+
* @format COLOR_HEX
|
|
2203
|
+
*/
|
|
1952
2204
|
backgroundColor?: string | null;
|
|
1953
2205
|
}
|
|
1954
2206
|
export interface BorderColors {
|
|
1955
|
-
/**
|
|
2207
|
+
/**
|
|
2208
|
+
* Left border color as a hexadecimal value.
|
|
2209
|
+
* @format COLOR_HEX
|
|
2210
|
+
*/
|
|
1956
2211
|
left?: string | null;
|
|
1957
|
-
/**
|
|
2212
|
+
/**
|
|
2213
|
+
* Right border color as a hexadecimal value.
|
|
2214
|
+
* @format COLOR_HEX
|
|
2215
|
+
*/
|
|
1958
2216
|
right?: string | null;
|
|
1959
|
-
/**
|
|
2217
|
+
/**
|
|
2218
|
+
* Top border color as a hexadecimal value.
|
|
2219
|
+
* @format COLOR_HEX
|
|
2220
|
+
*/
|
|
1960
2221
|
top?: string | null;
|
|
1961
|
-
/**
|
|
2222
|
+
/**
|
|
2223
|
+
* Bottom border color as a hexadecimal value.
|
|
2224
|
+
* @format COLOR_HEX
|
|
2225
|
+
*/
|
|
1962
2226
|
bottom?: string | null;
|
|
1963
2227
|
}
|
|
1964
2228
|
/**
|
|
@@ -2067,13 +2331,17 @@ export interface TextNodeStyle {
|
|
|
2067
2331
|
lineHeight?: string | null;
|
|
2068
2332
|
}
|
|
2069
2333
|
export interface RadioGroup {
|
|
2070
|
-
/**
|
|
2334
|
+
/**
|
|
2335
|
+
* Label of the field
|
|
2336
|
+
* @maxLength 350
|
|
2337
|
+
*/
|
|
2071
2338
|
label?: string | null;
|
|
2072
2339
|
/** Description of the field */
|
|
2073
2340
|
description?: RichContent;
|
|
2074
2341
|
/**
|
|
2075
2342
|
* Flag identifying to show option allowing input custom value
|
|
2076
2343
|
* List of options to select from
|
|
2344
|
+
* @maxSize 400
|
|
2077
2345
|
*/
|
|
2078
2346
|
options?: RadioGroupOption[];
|
|
2079
2347
|
/**
|
|
@@ -2090,19 +2358,35 @@ export interface RadioGroup {
|
|
|
2090
2358
|
numberOfColumns?: NumberOfColumns;
|
|
2091
2359
|
}
|
|
2092
2360
|
export interface RadioGroupOption {
|
|
2093
|
-
/**
|
|
2361
|
+
/**
|
|
2362
|
+
* Selectable option label
|
|
2363
|
+
* @maxLength 400
|
|
2364
|
+
*/
|
|
2094
2365
|
label?: string | null;
|
|
2095
|
-
/**
|
|
2366
|
+
/**
|
|
2367
|
+
* Selectable option value, which is saved to DB.
|
|
2368
|
+
* @maxLength 20000
|
|
2369
|
+
*/
|
|
2096
2370
|
value?: string | null;
|
|
2097
2371
|
/** Flag identifying that option should be selected by default */
|
|
2098
2372
|
default?: boolean;
|
|
2099
|
-
/**
|
|
2373
|
+
/**
|
|
2374
|
+
* Option id. Used as binding for translations
|
|
2375
|
+
* @format GUID
|
|
2376
|
+
* @immutable
|
|
2377
|
+
*/
|
|
2100
2378
|
_id?: string;
|
|
2101
2379
|
}
|
|
2102
2380
|
export interface RadioGroupCustomOption {
|
|
2103
|
-
/**
|
|
2381
|
+
/**
|
|
2382
|
+
* Label of custom option input
|
|
2383
|
+
* @maxLength 350
|
|
2384
|
+
*/
|
|
2104
2385
|
label?: string | null;
|
|
2105
|
-
/**
|
|
2386
|
+
/**
|
|
2387
|
+
* Placeholder of custom option input
|
|
2388
|
+
* @maxLength 100
|
|
2389
|
+
*/
|
|
2106
2390
|
placeholder?: string | null;
|
|
2107
2391
|
}
|
|
2108
2392
|
export declare enum NumberOfColumns {
|
|
@@ -2118,11 +2402,17 @@ export declare enum NumberOfColumns {
|
|
|
2118
2402
|
THREE = "THREE"
|
|
2119
2403
|
}
|
|
2120
2404
|
export interface Dropdown {
|
|
2121
|
-
/**
|
|
2405
|
+
/**
|
|
2406
|
+
* Label of the field
|
|
2407
|
+
* @maxLength 350
|
|
2408
|
+
*/
|
|
2122
2409
|
label?: string | null;
|
|
2123
2410
|
/** Description of the field */
|
|
2124
2411
|
description?: RichContent;
|
|
2125
|
-
/**
|
|
2412
|
+
/**
|
|
2413
|
+
* List of options to select from
|
|
2414
|
+
* @maxSize 400
|
|
2415
|
+
*/
|
|
2126
2416
|
options?: DropdownOption[];
|
|
2127
2417
|
/**
|
|
2128
2418
|
* Flag identifying to hide or not label
|
|
@@ -2131,27 +2421,49 @@ export interface Dropdown {
|
|
|
2131
2421
|
showLabel?: boolean | null;
|
|
2132
2422
|
/** Option which can be specified by UoU, enabled when this object is specified. */
|
|
2133
2423
|
customOption?: DropdownCustomOption;
|
|
2134
|
-
/**
|
|
2424
|
+
/**
|
|
2425
|
+
* Placeholder of dropdown input
|
|
2426
|
+
* @maxLength 100
|
|
2427
|
+
*/
|
|
2135
2428
|
placeholder?: string | null;
|
|
2136
2429
|
}
|
|
2137
2430
|
export interface DropdownOption {
|
|
2138
|
-
/**
|
|
2431
|
+
/**
|
|
2432
|
+
* Selectable option label
|
|
2433
|
+
* @maxLength 400
|
|
2434
|
+
*/
|
|
2139
2435
|
label?: string | null;
|
|
2140
|
-
/**
|
|
2436
|
+
/**
|
|
2437
|
+
* Selectable option value, which is saved to DB.
|
|
2438
|
+
* @maxLength 20000
|
|
2439
|
+
*/
|
|
2141
2440
|
value?: string | null;
|
|
2142
2441
|
/** Flag identifying that option should be selected by default */
|
|
2143
2442
|
default?: boolean;
|
|
2144
|
-
/**
|
|
2443
|
+
/**
|
|
2444
|
+
* Option id. Used as binding for translations
|
|
2445
|
+
* @format GUID
|
|
2446
|
+
* @immutable
|
|
2447
|
+
*/
|
|
2145
2448
|
_id?: string;
|
|
2146
2449
|
}
|
|
2147
2450
|
export interface DropdownCustomOption {
|
|
2148
|
-
/**
|
|
2451
|
+
/**
|
|
2452
|
+
* Label of custom option input
|
|
2453
|
+
* @maxLength 350
|
|
2454
|
+
*/
|
|
2149
2455
|
label?: string | null;
|
|
2150
|
-
/**
|
|
2456
|
+
/**
|
|
2457
|
+
* Placeholder of custom option input
|
|
2458
|
+
* @maxLength 100
|
|
2459
|
+
*/
|
|
2151
2460
|
placeholder?: string | null;
|
|
2152
2461
|
}
|
|
2153
2462
|
export interface DateTimeInput {
|
|
2154
|
-
/**
|
|
2463
|
+
/**
|
|
2464
|
+
* Label of the field. Displayed text for the date/time input.
|
|
2465
|
+
* @maxLength 350
|
|
2466
|
+
*/
|
|
2155
2467
|
label?: string | null;
|
|
2156
2468
|
/** Description of the field. Additional information about the date/time input. */
|
|
2157
2469
|
description?: RichContent;
|
|
@@ -2170,22 +2482,35 @@ export interface DateTimeInput {
|
|
|
2170
2482
|
* Default: false.
|
|
2171
2483
|
*/
|
|
2172
2484
|
use24HourFormat?: boolean;
|
|
2173
|
-
/**
|
|
2485
|
+
/**
|
|
2486
|
+
* Default value for the date time input.
|
|
2487
|
+
* @format LOCAL_DATE_TIME
|
|
2488
|
+
*/
|
|
2174
2489
|
default?: string | null;
|
|
2175
2490
|
}
|
|
2176
2491
|
export interface PhoneInput {
|
|
2177
|
-
/**
|
|
2492
|
+
/**
|
|
2493
|
+
* Label of the field
|
|
2494
|
+
* @maxLength 350
|
|
2495
|
+
*/
|
|
2178
2496
|
label?: string | null;
|
|
2179
2497
|
/** Description of the field */
|
|
2180
2498
|
description?: RichContent;
|
|
2181
|
-
/**
|
|
2499
|
+
/**
|
|
2500
|
+
* Placeholder for the value input
|
|
2501
|
+
* @maxLength 100
|
|
2502
|
+
*/
|
|
2182
2503
|
placeholder?: string | null;
|
|
2183
2504
|
/**
|
|
2184
2505
|
* Flag identifying to show label or not
|
|
2185
2506
|
* Default: true
|
|
2186
2507
|
*/
|
|
2187
2508
|
showLabel?: boolean | null;
|
|
2188
|
-
/**
|
|
2509
|
+
/**
|
|
2510
|
+
* Default value of the country code
|
|
2511
|
+
* @minLength 1
|
|
2512
|
+
* @maxLength 5
|
|
2513
|
+
*/
|
|
2189
2514
|
defaultCountryCode?: string | null;
|
|
2190
2515
|
/**
|
|
2191
2516
|
* Flag identifying to show country flag or not
|
|
@@ -2194,7 +2519,10 @@ export interface PhoneInput {
|
|
|
2194
2519
|
showCountryFlag?: boolean;
|
|
2195
2520
|
}
|
|
2196
2521
|
export interface DateInput {
|
|
2197
|
-
/**
|
|
2522
|
+
/**
|
|
2523
|
+
* Label of the field. Displayed text for the date/time input.
|
|
2524
|
+
* @maxLength 350
|
|
2525
|
+
*/
|
|
2198
2526
|
label?: string | null;
|
|
2199
2527
|
/** Description of the field. Additional information about the date/time input. */
|
|
2200
2528
|
description?: RichContent;
|
|
@@ -2208,11 +2536,17 @@ export interface DateInput {
|
|
|
2208
2536
|
* Default: true
|
|
2209
2537
|
*/
|
|
2210
2538
|
showPlaceholder?: boolean | null;
|
|
2211
|
-
/**
|
|
2539
|
+
/**
|
|
2540
|
+
* Default value for the date input.
|
|
2541
|
+
* @format LOCAL_DATE
|
|
2542
|
+
*/
|
|
2212
2543
|
default?: string | null;
|
|
2213
2544
|
}
|
|
2214
2545
|
export interface TimeInput {
|
|
2215
|
-
/**
|
|
2546
|
+
/**
|
|
2547
|
+
* Label of the field. Displayed text for the date/time input.
|
|
2548
|
+
* @maxLength 350
|
|
2549
|
+
*/
|
|
2216
2550
|
label?: string | null;
|
|
2217
2551
|
/** Description of the field. Additional information about the date/time input. */
|
|
2218
2552
|
description?: RichContent;
|
|
@@ -2231,11 +2565,17 @@ export interface TimeInput {
|
|
|
2231
2565
|
* Default: false.
|
|
2232
2566
|
*/
|
|
2233
2567
|
use24HourFormat?: boolean;
|
|
2234
|
-
/**
|
|
2568
|
+
/**
|
|
2569
|
+
* Default value for the time input.
|
|
2570
|
+
* @format LOCAL_TIME
|
|
2571
|
+
*/
|
|
2235
2572
|
default?: string | null;
|
|
2236
2573
|
}
|
|
2237
2574
|
export interface DatePicker {
|
|
2238
|
-
/**
|
|
2575
|
+
/**
|
|
2576
|
+
* Label of the field. Displayed text for the date/time input.
|
|
2577
|
+
* @maxLength 350
|
|
2578
|
+
*/
|
|
2239
2579
|
label?: string | null;
|
|
2240
2580
|
/** Description of the field. Additional information about the date/time input. */
|
|
2241
2581
|
description?: RichContent;
|
|
@@ -2244,11 +2584,17 @@ export interface DatePicker {
|
|
|
2244
2584
|
* Default: true
|
|
2245
2585
|
*/
|
|
2246
2586
|
showLabel?: boolean | null;
|
|
2247
|
-
/**
|
|
2587
|
+
/**
|
|
2588
|
+
* Placeholder of date picker input
|
|
2589
|
+
* @maxLength 100
|
|
2590
|
+
*/
|
|
2248
2591
|
placeholder?: string | null;
|
|
2249
2592
|
/** First day of the week displayed on date picker. */
|
|
2250
2593
|
firstDayOfWeek?: FirstDayOfWeek;
|
|
2251
|
-
/**
|
|
2594
|
+
/**
|
|
2595
|
+
* Default value for the date picker.
|
|
2596
|
+
* @format LOCAL_DATE
|
|
2597
|
+
*/
|
|
2252
2598
|
default?: string | null;
|
|
2253
2599
|
}
|
|
2254
2600
|
export declare enum FirstDayOfWeek {
|
|
@@ -2266,11 +2612,17 @@ export interface InputFieldNumberType {
|
|
|
2266
2612
|
multipleOf?: number | null;
|
|
2267
2613
|
/** Custom error message when validation fails. */
|
|
2268
2614
|
errorMessages?: InputFieldNumberErrorMessages;
|
|
2269
|
-
/**
|
|
2615
|
+
/**
|
|
2616
|
+
* List of allowed values.
|
|
2617
|
+
* @maxSize 500
|
|
2618
|
+
*/
|
|
2270
2619
|
enum?: number[] | null;
|
|
2271
2620
|
}
|
|
2272
2621
|
export interface InputFieldNumberErrorMessages {
|
|
2273
|
-
/**
|
|
2622
|
+
/**
|
|
2623
|
+
* Default error message on invalid validation.
|
|
2624
|
+
* @maxLength 200
|
|
2625
|
+
*/
|
|
2274
2626
|
default?: string | null;
|
|
2275
2627
|
}
|
|
2276
2628
|
export declare enum NumberComponentType {
|
|
@@ -2279,11 +2631,17 @@ export declare enum NumberComponentType {
|
|
|
2279
2631
|
RATING_INPUT = "RATING_INPUT"
|
|
2280
2632
|
}
|
|
2281
2633
|
export interface NumberInput {
|
|
2282
|
-
/**
|
|
2634
|
+
/**
|
|
2635
|
+
* Label of the field
|
|
2636
|
+
* @maxLength 350
|
|
2637
|
+
*/
|
|
2283
2638
|
label?: string | null;
|
|
2284
2639
|
/** Description of the field */
|
|
2285
2640
|
description?: RichContent;
|
|
2286
|
-
/**
|
|
2641
|
+
/**
|
|
2642
|
+
* Placeholder for the value input
|
|
2643
|
+
* @maxLength 100
|
|
2644
|
+
*/
|
|
2287
2645
|
placeholder?: string | null;
|
|
2288
2646
|
/**
|
|
2289
2647
|
* Flag identifying to hide or not label
|
|
@@ -2294,7 +2652,10 @@ export interface NumberInput {
|
|
|
2294
2652
|
default?: number | null;
|
|
2295
2653
|
}
|
|
2296
2654
|
export interface RatingInput {
|
|
2297
|
-
/**
|
|
2655
|
+
/**
|
|
2656
|
+
* Label of the field
|
|
2657
|
+
* @maxLength 350
|
|
2658
|
+
*/
|
|
2298
2659
|
label?: string | null;
|
|
2299
2660
|
/** Description of the field */
|
|
2300
2661
|
description?: RichContent;
|
|
@@ -2303,17 +2664,27 @@ export interface RatingInput {
|
|
|
2303
2664
|
* Default: true
|
|
2304
2665
|
*/
|
|
2305
2666
|
showLabel?: boolean | null;
|
|
2306
|
-
/**
|
|
2667
|
+
/**
|
|
2668
|
+
* Default rating
|
|
2669
|
+
* @min 1
|
|
2670
|
+
* @max 5
|
|
2671
|
+
*/
|
|
2307
2672
|
defaultValue?: number | null;
|
|
2308
2673
|
}
|
|
2309
2674
|
export interface InputFieldBooleanType {
|
|
2310
2675
|
/** Custom error message when validation fails. */
|
|
2311
2676
|
errorMessages?: InputFieldBooleanErrorMessages;
|
|
2312
|
-
/**
|
|
2677
|
+
/**
|
|
2678
|
+
* List of allowed values.
|
|
2679
|
+
* @maxSize 2
|
|
2680
|
+
*/
|
|
2313
2681
|
enum?: boolean[];
|
|
2314
2682
|
}
|
|
2315
2683
|
export interface InputFieldBooleanErrorMessages {
|
|
2316
|
-
/**
|
|
2684
|
+
/**
|
|
2685
|
+
* Default error message on invalid validation.
|
|
2686
|
+
* @maxLength 200
|
|
2687
|
+
*/
|
|
2317
2688
|
default?: string | null;
|
|
2318
2689
|
}
|
|
2319
2690
|
export declare enum BooleanComponentType {
|
|
@@ -2330,9 +2701,15 @@ export interface Checkbox {
|
|
|
2330
2701
|
checked?: boolean;
|
|
2331
2702
|
}
|
|
2332
2703
|
export interface InputFieldArrayType {
|
|
2333
|
-
/**
|
|
2704
|
+
/**
|
|
2705
|
+
* Maximum amount of array elements.
|
|
2706
|
+
* @max 1000
|
|
2707
|
+
*/
|
|
2334
2708
|
maxItems?: number | null;
|
|
2335
|
-
/**
|
|
2709
|
+
/**
|
|
2710
|
+
* Minimum amount of array elements.
|
|
2711
|
+
* @max 1000
|
|
2712
|
+
*/
|
|
2336
2713
|
minItems?: number | null;
|
|
2337
2714
|
/** Type of items allowed in array. */
|
|
2338
2715
|
items?: ArrayTypeArrayItems;
|
|
@@ -2356,7 +2733,10 @@ export interface InputFieldIntegerType {
|
|
|
2356
2733
|
multipleOf?: number | null;
|
|
2357
2734
|
/** Custom error message when validation fails. */
|
|
2358
2735
|
errorMessages?: InputFieldNumberErrorMessages;
|
|
2359
|
-
/**
|
|
2736
|
+
/**
|
|
2737
|
+
* List of allowed values.
|
|
2738
|
+
* @maxSize 500
|
|
2739
|
+
*/
|
|
2360
2740
|
enum?: number[] | null;
|
|
2361
2741
|
}
|
|
2362
2742
|
export interface InputFieldObjectType {
|
|
@@ -2406,7 +2786,10 @@ export interface ObjectTypePropertiesTypePropertiesTypeOptionsOneOf {
|
|
|
2406
2786
|
arrayOptions?: InputFieldArrayType;
|
|
2407
2787
|
}
|
|
2408
2788
|
export interface InputFieldObjectErrorMessages {
|
|
2409
|
-
/**
|
|
2789
|
+
/**
|
|
2790
|
+
* Default error message on invalid validation.
|
|
2791
|
+
* @maxLength 200
|
|
2792
|
+
*/
|
|
2410
2793
|
default?: string | null;
|
|
2411
2794
|
}
|
|
2412
2795
|
export interface ArrayTypeArrayItems extends ArrayTypeArrayItemsItemTypeOptionsOneOf {
|
|
@@ -2440,7 +2823,10 @@ export interface ArrayTypeArrayItemsItemTypeOptionsOneOf {
|
|
|
2440
2823
|
objectOptions?: InputFieldObjectType;
|
|
2441
2824
|
}
|
|
2442
2825
|
export interface InputFieldArrayErrorMessages {
|
|
2443
|
-
/**
|
|
2826
|
+
/**
|
|
2827
|
+
* Default error message on invalid validation.
|
|
2828
|
+
* @maxLength 200
|
|
2829
|
+
*/
|
|
2444
2830
|
default?: string | null;
|
|
2445
2831
|
}
|
|
2446
2832
|
export declare enum ComponentType {
|
|
@@ -2449,11 +2835,17 @@ export declare enum ComponentType {
|
|
|
2449
2835
|
TAGS = "TAGS"
|
|
2450
2836
|
}
|
|
2451
2837
|
export interface CheckboxGroup {
|
|
2452
|
-
/**
|
|
2838
|
+
/**
|
|
2839
|
+
* Label of the field
|
|
2840
|
+
* @maxLength 350
|
|
2841
|
+
*/
|
|
2453
2842
|
label?: string | null;
|
|
2454
2843
|
/** Description of the field */
|
|
2455
2844
|
description?: RichContent;
|
|
2456
|
-
/**
|
|
2845
|
+
/**
|
|
2846
|
+
* List of options to select from
|
|
2847
|
+
* @maxSize 400
|
|
2848
|
+
*/
|
|
2457
2849
|
options?: Option[];
|
|
2458
2850
|
/**
|
|
2459
2851
|
* Flag identifying to hide or not label
|
|
@@ -2478,29 +2870,48 @@ export interface MediaItemMediaOneOf {
|
|
|
2478
2870
|
image?: string;
|
|
2479
2871
|
}
|
|
2480
2872
|
export interface Option {
|
|
2481
|
-
/**
|
|
2873
|
+
/**
|
|
2874
|
+
* Selectable option label
|
|
2875
|
+
* @maxLength 400
|
|
2876
|
+
*/
|
|
2482
2877
|
label?: string | null;
|
|
2483
2878
|
/** Selectable option value, which is saved to DB. */
|
|
2484
2879
|
value?: any;
|
|
2485
2880
|
/** Flag identifying that option should be selected by default */
|
|
2486
2881
|
default?: boolean;
|
|
2487
|
-
/**
|
|
2882
|
+
/**
|
|
2883
|
+
* Option id. Used as binding for translations
|
|
2884
|
+
* @format GUID
|
|
2885
|
+
* @immutable
|
|
2886
|
+
*/
|
|
2488
2887
|
_id?: string;
|
|
2489
2888
|
/** Media item. Media, associated with option, like image. */
|
|
2490
2889
|
media?: MediaItem;
|
|
2491
2890
|
}
|
|
2492
2891
|
export interface CustomOption {
|
|
2493
|
-
/**
|
|
2892
|
+
/**
|
|
2893
|
+
* Label of custom option input
|
|
2894
|
+
* @maxLength 350
|
|
2895
|
+
*/
|
|
2494
2896
|
label?: string | null;
|
|
2495
|
-
/**
|
|
2897
|
+
/**
|
|
2898
|
+
* Placeholder of custom option input
|
|
2899
|
+
* @maxLength 100
|
|
2900
|
+
*/
|
|
2496
2901
|
placeholder?: string | null;
|
|
2497
2902
|
}
|
|
2498
2903
|
export interface Tags {
|
|
2499
|
-
/**
|
|
2904
|
+
/**
|
|
2905
|
+
* Label of the field
|
|
2906
|
+
* @maxLength 350
|
|
2907
|
+
*/
|
|
2500
2908
|
label?: string | null;
|
|
2501
2909
|
/** Description of the field */
|
|
2502
2910
|
description?: RichContent;
|
|
2503
|
-
/**
|
|
2911
|
+
/**
|
|
2912
|
+
* List of options to select from
|
|
2913
|
+
* @maxSize 400
|
|
2914
|
+
*/
|
|
2504
2915
|
options?: TagsOption[];
|
|
2505
2916
|
/**
|
|
2506
2917
|
* Flag identifying to hide or not label
|
|
@@ -2516,21 +2927,34 @@ export interface Tags {
|
|
|
2516
2927
|
numberOfColumns?: NumberOfColumns;
|
|
2517
2928
|
}
|
|
2518
2929
|
export interface TagsOption {
|
|
2519
|
-
/**
|
|
2930
|
+
/**
|
|
2931
|
+
* Selectable option label
|
|
2932
|
+
* @maxLength 400
|
|
2933
|
+
*/
|
|
2520
2934
|
label?: string | null;
|
|
2521
2935
|
/** Selectable option value, which is saved to DB. */
|
|
2522
2936
|
value?: any;
|
|
2523
2937
|
/** Flag identifying that option should be selected by default */
|
|
2524
2938
|
default?: boolean;
|
|
2525
|
-
/**
|
|
2939
|
+
/**
|
|
2940
|
+
* Option id. Used as binding for translations
|
|
2941
|
+
* @format GUID
|
|
2942
|
+
* @immutable
|
|
2943
|
+
*/
|
|
2526
2944
|
_id?: string;
|
|
2527
2945
|
/** Media item. Media, associated with option, like image. */
|
|
2528
2946
|
media?: MediaItem;
|
|
2529
2947
|
}
|
|
2530
2948
|
export interface CommonCustomOption {
|
|
2531
|
-
/**
|
|
2949
|
+
/**
|
|
2950
|
+
* Label of custom option input
|
|
2951
|
+
* @maxLength 350
|
|
2952
|
+
*/
|
|
2532
2953
|
label?: string | null;
|
|
2533
|
-
/**
|
|
2954
|
+
/**
|
|
2955
|
+
* Placeholder of custom option input
|
|
2956
|
+
* @maxLength 100
|
|
2957
|
+
*/
|
|
2534
2958
|
placeholder?: string | null;
|
|
2535
2959
|
}
|
|
2536
2960
|
export declare enum WixFileComponentType {
|
|
@@ -2539,7 +2963,10 @@ export declare enum WixFileComponentType {
|
|
|
2539
2963
|
SIGNATURE = "SIGNATURE"
|
|
2540
2964
|
}
|
|
2541
2965
|
export interface FileUpload {
|
|
2542
|
-
/**
|
|
2966
|
+
/**
|
|
2967
|
+
* Selectable option label
|
|
2968
|
+
* @maxLength 350
|
|
2969
|
+
*/
|
|
2543
2970
|
label?: string | null;
|
|
2544
2971
|
/** Description of the field */
|
|
2545
2972
|
description?: RichContent;
|
|
@@ -2548,13 +2975,26 @@ export interface FileUpload {
|
|
|
2548
2975
|
* Default: true
|
|
2549
2976
|
*/
|
|
2550
2977
|
showLabel?: boolean | null;
|
|
2551
|
-
/**
|
|
2978
|
+
/**
|
|
2979
|
+
* Text on upload button
|
|
2980
|
+
* @maxLength 500
|
|
2981
|
+
*/
|
|
2552
2982
|
buttonText?: string | null;
|
|
2553
|
-
/**
|
|
2983
|
+
/**
|
|
2984
|
+
* Amount of files allowed to upload
|
|
2985
|
+
* @min 1
|
|
2986
|
+
* @max 30
|
|
2987
|
+
*/
|
|
2554
2988
|
fileLimit?: number;
|
|
2555
|
-
/**
|
|
2989
|
+
/**
|
|
2990
|
+
* Supported file formats for upload
|
|
2991
|
+
* @maxSize 5
|
|
2992
|
+
*/
|
|
2556
2993
|
uploadFileFormats?: UploadFileFormat[];
|
|
2557
|
-
/**
|
|
2994
|
+
/**
|
|
2995
|
+
* Custom text which appears when file is uploaded, if missing file name will be shown
|
|
2996
|
+
* @maxLength 255
|
|
2997
|
+
*/
|
|
2558
2998
|
explanationText?: string | null;
|
|
2559
2999
|
}
|
|
2560
3000
|
export declare enum UploadFileFormat {
|
|
@@ -2572,7 +3012,10 @@ export declare enum UploadFileFormat {
|
|
|
2572
3012
|
ARCHIVE = "ARCHIVE"
|
|
2573
3013
|
}
|
|
2574
3014
|
export interface Signature {
|
|
2575
|
-
/**
|
|
3015
|
+
/**
|
|
3016
|
+
* Selectable option label
|
|
3017
|
+
* @maxLength 350
|
|
3018
|
+
*/
|
|
2576
3019
|
label?: string | null;
|
|
2577
3020
|
/**
|
|
2578
3021
|
* Flag identifying to hide label or not
|
|
@@ -2592,11 +3035,17 @@ export declare enum PaymentComponentType {
|
|
|
2592
3035
|
FIXED_PAYMENT = "FIXED_PAYMENT"
|
|
2593
3036
|
}
|
|
2594
3037
|
export interface ProductCheckboxGroup {
|
|
2595
|
-
/**
|
|
3038
|
+
/**
|
|
3039
|
+
* Label of the field.
|
|
3040
|
+
* @maxLength 350
|
|
3041
|
+
*/
|
|
2596
3042
|
label?: string | null;
|
|
2597
3043
|
/** Description of the field. */
|
|
2598
3044
|
description?: RichContent;
|
|
2599
|
-
/**
|
|
3045
|
+
/**
|
|
3046
|
+
* List of options to select from.
|
|
3047
|
+
* @maxSize 400
|
|
3048
|
+
*/
|
|
2600
3049
|
options?: ProductCheckboxGroupOption[];
|
|
2601
3050
|
/**
|
|
2602
3051
|
* Flag identifying to hide or not label
|
|
@@ -2610,11 +3059,18 @@ export interface ProductCheckboxGroup {
|
|
|
2610
3059
|
imageFit?: ImageFit;
|
|
2611
3060
|
}
|
|
2612
3061
|
export interface ProductCheckboxGroupOption {
|
|
2613
|
-
/**
|
|
3062
|
+
/**
|
|
3063
|
+
* Selectable option label.
|
|
3064
|
+
* @maxLength 400
|
|
3065
|
+
*/
|
|
2614
3066
|
label?: string | null;
|
|
2615
3067
|
/** Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list. */
|
|
2616
3068
|
value?: any;
|
|
2617
|
-
/**
|
|
3069
|
+
/**
|
|
3070
|
+
* Option id. Used as binding for translations.
|
|
3071
|
+
* @format GUID
|
|
3072
|
+
* @immutable
|
|
3073
|
+
*/
|
|
2618
3074
|
_id?: string;
|
|
2619
3075
|
/** Media item. Media, associated with option, like image. */
|
|
2620
3076
|
media?: MediaItem;
|
|
@@ -2629,11 +3085,17 @@ export declare enum ImageFit {
|
|
|
2629
3085
|
CONTAIN = "CONTAIN"
|
|
2630
3086
|
}
|
|
2631
3087
|
export interface DonationInput {
|
|
2632
|
-
/**
|
|
3088
|
+
/**
|
|
3089
|
+
* Label of the field.
|
|
3090
|
+
* @maxLength 350
|
|
3091
|
+
*/
|
|
2633
3092
|
label?: string | null;
|
|
2634
3093
|
/** Description of the field. */
|
|
2635
3094
|
description?: RichContent;
|
|
2636
|
-
/**
|
|
3095
|
+
/**
|
|
3096
|
+
* List of options to select from.
|
|
3097
|
+
* @maxSize 400
|
|
3098
|
+
*/
|
|
2637
3099
|
options?: DonationInputOption[];
|
|
2638
3100
|
/** Option which can be specified by UoU, enabled when this object is specified. */
|
|
2639
3101
|
customOption?: CommonCustomOption;
|
|
@@ -2649,13 +3111,19 @@ export interface DonationInput {
|
|
|
2649
3111
|
showLabel?: boolean | null;
|
|
2650
3112
|
}
|
|
2651
3113
|
export interface DonationInputOption {
|
|
2652
|
-
/**
|
|
3114
|
+
/**
|
|
3115
|
+
* Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list.
|
|
3116
|
+
* @format GUID
|
|
3117
|
+
*/
|
|
2653
3118
|
value?: string;
|
|
2654
3119
|
/** Flag identifying that option should be selected by default */
|
|
2655
3120
|
default?: boolean;
|
|
2656
3121
|
}
|
|
2657
3122
|
export interface PaymentInput {
|
|
2658
|
-
/**
|
|
3123
|
+
/**
|
|
3124
|
+
* Label of the field.
|
|
3125
|
+
* @maxLength 350
|
|
3126
|
+
*/
|
|
2659
3127
|
label?: string | null;
|
|
2660
3128
|
/** Description of the field. */
|
|
2661
3129
|
description?: RichContent;
|
|
@@ -2664,13 +3132,19 @@ export interface PaymentInput {
|
|
|
2664
3132
|
* Default: true
|
|
2665
3133
|
*/
|
|
2666
3134
|
showLabel?: boolean | null;
|
|
2667
|
-
/**
|
|
3135
|
+
/**
|
|
3136
|
+
* Placeholder of custom option input
|
|
3137
|
+
* @maxLength 100
|
|
3138
|
+
*/
|
|
2668
3139
|
placeholder?: string | null;
|
|
2669
3140
|
/** Default value for the payment input */
|
|
2670
3141
|
default?: number | null;
|
|
2671
3142
|
}
|
|
2672
3143
|
export interface FixedPayment {
|
|
2673
|
-
/**
|
|
3144
|
+
/**
|
|
3145
|
+
* Label of the field.
|
|
3146
|
+
* @maxLength 350
|
|
3147
|
+
*/
|
|
2674
3148
|
label?: string | null;
|
|
2675
3149
|
/** Description of the field. */
|
|
2676
3150
|
description?: RichContent;
|
|
@@ -2691,15 +3165,30 @@ export interface Appointment extends AppointmentFormatInfoOneOf {
|
|
|
2691
3165
|
videoConferenceOptions?: VideoConferenceOptions;
|
|
2692
3166
|
/** Phone options for the appointment */
|
|
2693
3167
|
phoneOptions?: PhoneOptions;
|
|
2694
|
-
/**
|
|
3168
|
+
/**
|
|
3169
|
+
* Label of the field
|
|
3170
|
+
* @maxLength 255
|
|
3171
|
+
*/
|
|
2695
3172
|
label?: string | null;
|
|
2696
|
-
/**
|
|
3173
|
+
/**
|
|
3174
|
+
* Name of the appointment
|
|
3175
|
+
* @minLength 1
|
|
3176
|
+
* @maxLength 400
|
|
3177
|
+
*/
|
|
2697
3178
|
name?: string | null;
|
|
2698
|
-
/**
|
|
3179
|
+
/**
|
|
3180
|
+
* Duration of the appointment in minutes
|
|
3181
|
+
* @min 1
|
|
3182
|
+
* @max 44639
|
|
3183
|
+
*/
|
|
2699
3184
|
durationInMinutes?: number | null;
|
|
2700
3185
|
/** Indicates whether manual approval is required for the appointment */
|
|
2701
3186
|
manualApprovalRequired?: boolean | null;
|
|
2702
|
-
/**
|
|
3187
|
+
/**
|
|
3188
|
+
* ID of the staff members providing the appointment
|
|
3189
|
+
* @maxSize 220
|
|
3190
|
+
* @format GUID
|
|
3191
|
+
*/
|
|
2703
3192
|
staffIds?: string[] | null;
|
|
2704
3193
|
/** The format of the appointment */
|
|
2705
3194
|
format?: Format;
|
|
@@ -2714,16 +3203,28 @@ export interface AppointmentFormatInfoOneOf {
|
|
|
2714
3203
|
phoneOptions?: PhoneOptions;
|
|
2715
3204
|
}
|
|
2716
3205
|
export interface Location extends LocationLocationInfoOneOf {
|
|
2717
|
-
/**
|
|
3206
|
+
/**
|
|
3207
|
+
* Custom address details
|
|
3208
|
+
* @maxLength 512
|
|
3209
|
+
*/
|
|
2718
3210
|
customAddress?: string | null;
|
|
2719
|
-
/**
|
|
3211
|
+
/**
|
|
3212
|
+
* ID of a business location
|
|
3213
|
+
* @format GUID
|
|
3214
|
+
*/
|
|
2720
3215
|
businessLocationId?: string | null;
|
|
2721
3216
|
}
|
|
2722
3217
|
/** @oneof */
|
|
2723
3218
|
export interface LocationLocationInfoOneOf {
|
|
2724
|
-
/**
|
|
3219
|
+
/**
|
|
3220
|
+
* Custom address details
|
|
3221
|
+
* @maxLength 512
|
|
3222
|
+
*/
|
|
2725
3223
|
customAddress?: string | null;
|
|
2726
|
-
/**
|
|
3224
|
+
/**
|
|
3225
|
+
* ID of a business location
|
|
3226
|
+
* @format GUID
|
|
3227
|
+
*/
|
|
2727
3228
|
businessLocationId?: string | null;
|
|
2728
3229
|
}
|
|
2729
3230
|
export declare enum Format {
|
|
@@ -2733,15 +3234,25 @@ export declare enum Format {
|
|
|
2733
3234
|
PHONE = "PHONE"
|
|
2734
3235
|
}
|
|
2735
3236
|
export interface InPersonOptions {
|
|
2736
|
-
/**
|
|
3237
|
+
/**
|
|
3238
|
+
* The locations details
|
|
3239
|
+
* @minSize 1
|
|
3240
|
+
* @maxSize 500
|
|
3241
|
+
*/
|
|
2737
3242
|
locations?: Location[];
|
|
2738
3243
|
}
|
|
2739
3244
|
export interface VideoConferenceOptions {
|
|
2740
|
-
/**
|
|
3245
|
+
/**
|
|
3246
|
+
* Description or instructions for the online video conference
|
|
3247
|
+
* @maxLength 512
|
|
3248
|
+
*/
|
|
2741
3249
|
description?: string | null;
|
|
2742
3250
|
}
|
|
2743
3251
|
export interface PhoneOptions {
|
|
2744
|
-
/**
|
|
3252
|
+
/**
|
|
3253
|
+
* Description or instructions for the phone appointment
|
|
3254
|
+
* @maxLength 512
|
|
3255
|
+
*/
|
|
2745
3256
|
description?: string | null;
|
|
2746
3257
|
}
|
|
2747
3258
|
export declare enum MultilineAddressComponentType {
|
|
@@ -2749,7 +3260,10 @@ export declare enum MultilineAddressComponentType {
|
|
|
2749
3260
|
MULTILINE_ADDRESS = "MULTILINE_ADDRESS"
|
|
2750
3261
|
}
|
|
2751
3262
|
export interface MultilineAddress {
|
|
2752
|
-
/**
|
|
3263
|
+
/**
|
|
3264
|
+
* Label of the field.
|
|
3265
|
+
* @maxLength 350
|
|
3266
|
+
*/
|
|
2753
3267
|
label?: string | null;
|
|
2754
3268
|
/** Description of the field. */
|
|
2755
3269
|
description?: RichContent;
|
|
@@ -2775,14 +3289,20 @@ export interface AddressLine2 {
|
|
|
2775
3289
|
show?: boolean;
|
|
2776
3290
|
}
|
|
2777
3291
|
export interface DefaultCountryConfig extends DefaultCountryConfigOptionsOneOf {
|
|
2778
|
-
/**
|
|
3292
|
+
/**
|
|
3293
|
+
* Country.
|
|
3294
|
+
* @format COUNTRY
|
|
3295
|
+
*/
|
|
2779
3296
|
countryOptions?: string;
|
|
2780
3297
|
/** Default country type. */
|
|
2781
3298
|
type?: Type;
|
|
2782
3299
|
}
|
|
2783
3300
|
/** @oneof */
|
|
2784
3301
|
export interface DefaultCountryConfigOptionsOneOf {
|
|
2785
|
-
/**
|
|
3302
|
+
/**
|
|
3303
|
+
* Country.
|
|
3304
|
+
* @format COUNTRY
|
|
3305
|
+
*/
|
|
2786
3306
|
countryOptions?: string;
|
|
2787
3307
|
}
|
|
2788
3308
|
export interface FieldsSettings {
|
|
@@ -2872,7 +3392,11 @@ export interface AddressInfo {
|
|
|
2872
3392
|
tag?: Tag;
|
|
2873
3393
|
}
|
|
2874
3394
|
export interface CustomFieldInfo {
|
|
2875
|
-
/**
|
|
3395
|
+
/**
|
|
3396
|
+
* Custom field key.
|
|
3397
|
+
* @minLength 1
|
|
3398
|
+
* @maxLength 500
|
|
3399
|
+
*/
|
|
2876
3400
|
key?: string;
|
|
2877
3401
|
}
|
|
2878
3402
|
export interface SubscriptionInfo {
|
|
@@ -3091,7 +3615,12 @@ export interface InputField extends InputFieldInputTypeOptionsOneOf {
|
|
|
3091
3615
|
multilineAddressOptions?: InputFieldMultilineAddress;
|
|
3092
3616
|
/** Input returns scheduling as value. */
|
|
3093
3617
|
schedulingOptions?: Scheduling;
|
|
3094
|
-
/**
|
|
3618
|
+
/**
|
|
3619
|
+
* Definition of a target where the value of field belongs.
|
|
3620
|
+
* @minLength 1
|
|
3621
|
+
* @maxLength 200
|
|
3622
|
+
* @immutable
|
|
3623
|
+
*/
|
|
3095
3624
|
target?: string | null;
|
|
3096
3625
|
/**
|
|
3097
3626
|
* Mark the field as containing personal information. This will encrypt user data when storing it.
|
|
@@ -3163,17 +3692,33 @@ export interface RichContentOptions {
|
|
|
3163
3692
|
richContent?: RichContent;
|
|
3164
3693
|
}
|
|
3165
3694
|
export interface PageNavigationOptions {
|
|
3166
|
-
/**
|
|
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
|
+
*/
|
|
3167
3699
|
nextPageText?: string | null;
|
|
3168
|
-
/**
|
|
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
|
+
*/
|
|
3169
3704
|
previousPageText?: string | null;
|
|
3170
|
-
/**
|
|
3705
|
+
/**
|
|
3706
|
+
* Text on the button when button is submitting a form
|
|
3707
|
+
* @maxLength 65
|
|
3708
|
+
*/
|
|
3171
3709
|
submitText?: string | null;
|
|
3172
3710
|
}
|
|
3173
3711
|
export interface Step {
|
|
3174
|
-
/**
|
|
3712
|
+
/**
|
|
3713
|
+
* Step ID.
|
|
3714
|
+
* @format GUID
|
|
3715
|
+
* @immutable
|
|
3716
|
+
*/
|
|
3175
3717
|
_id?: string;
|
|
3176
|
-
/**
|
|
3718
|
+
/**
|
|
3719
|
+
* Name of the step.
|
|
3720
|
+
* @maxLength 200
|
|
3721
|
+
*/
|
|
3177
3722
|
name?: string | null;
|
|
3178
3723
|
/** Is step hidden */
|
|
3179
3724
|
hidden?: boolean;
|
|
@@ -3189,7 +3734,10 @@ export interface FormLayout {
|
|
|
3189
3734
|
small?: BreakPoint;
|
|
3190
3735
|
}
|
|
3191
3736
|
export interface BreakPoint {
|
|
3192
|
-
/**
|
|
3737
|
+
/**
|
|
3738
|
+
* Description of layouts for items.
|
|
3739
|
+
* @maxSize 500
|
|
3740
|
+
*/
|
|
3193
3741
|
items?: ItemLayout[];
|
|
3194
3742
|
/** Amount of columns of layout grid. */
|
|
3195
3743
|
columns?: number | null;
|
|
@@ -3199,11 +3747,17 @@ export interface BreakPoint {
|
|
|
3199
3747
|
margin?: Margin;
|
|
3200
3748
|
/** Description of elements paddings. */
|
|
3201
3749
|
padding?: Margin;
|
|
3202
|
-
/**
|
|
3750
|
+
/**
|
|
3751
|
+
* Sections of the layout, which allow manage fields
|
|
3752
|
+
* @maxSize 100
|
|
3753
|
+
*/
|
|
3203
3754
|
sections?: Section[];
|
|
3204
3755
|
}
|
|
3205
3756
|
export interface ItemLayout extends ItemLayoutItemOneOf {
|
|
3206
|
-
/**
|
|
3757
|
+
/**
|
|
3758
|
+
* Form field reference id.
|
|
3759
|
+
* @format GUID
|
|
3760
|
+
*/
|
|
3207
3761
|
fieldId?: string;
|
|
3208
3762
|
/** Group info, defining that this item is a group of multiple fields */
|
|
3209
3763
|
group?: Group;
|
|
@@ -3218,15 +3772,25 @@ export interface ItemLayout extends ItemLayoutItemOneOf {
|
|
|
3218
3772
|
}
|
|
3219
3773
|
/** @oneof */
|
|
3220
3774
|
export interface ItemLayoutItemOneOf {
|
|
3221
|
-
/**
|
|
3775
|
+
/**
|
|
3776
|
+
* Form field reference id.
|
|
3777
|
+
* @format GUID
|
|
3778
|
+
*/
|
|
3222
3779
|
fieldId?: string;
|
|
3223
3780
|
/** Group info, defining that this item is a group of multiple fields */
|
|
3224
3781
|
group?: Group;
|
|
3225
3782
|
}
|
|
3226
3783
|
export interface Group {
|
|
3227
|
-
/**
|
|
3784
|
+
/**
|
|
3785
|
+
* Field group reference id.
|
|
3786
|
+
* @format GUID
|
|
3787
|
+
*/
|
|
3228
3788
|
groupId?: string;
|
|
3229
|
-
/**
|
|
3789
|
+
/**
|
|
3790
|
+
* Description of layouts for items.
|
|
3791
|
+
* @minSize 1
|
|
3792
|
+
* @maxSize 500
|
|
3793
|
+
*/
|
|
3230
3794
|
items?: ItemLayout[];
|
|
3231
3795
|
}
|
|
3232
3796
|
export interface Margin {
|
|
@@ -3236,7 +3800,11 @@ export interface Margin {
|
|
|
3236
3800
|
vertical?: number | null;
|
|
3237
3801
|
}
|
|
3238
3802
|
export interface Section {
|
|
3239
|
-
/**
|
|
3803
|
+
/**
|
|
3804
|
+
* Id of the section
|
|
3805
|
+
* @format GUID
|
|
3806
|
+
* @minLength 1
|
|
3807
|
+
*/
|
|
3240
3808
|
_id?: string;
|
|
3241
3809
|
/** Horizontal coordinate in the grid. */
|
|
3242
3810
|
row?: number | null;
|
|
@@ -3246,20 +3814,30 @@ export interface Section {
|
|
|
3246
3814
|
* If the section encounters the $new key within the list,
|
|
3247
3815
|
* it allows the inclusion of fields not explicitly listed,
|
|
3248
3816
|
* enabling dynamic addition of new fields.
|
|
3817
|
+
* @maxSize 100
|
|
3818
|
+
* @maxLength 100
|
|
3249
3819
|
*/
|
|
3250
3820
|
allowedFieldIds?: string[];
|
|
3251
3821
|
}
|
|
3252
3822
|
export interface FormRule {
|
|
3253
|
-
/**
|
|
3823
|
+
/**
|
|
3824
|
+
* Id of the rule
|
|
3825
|
+
* @format GUID
|
|
3826
|
+
* @immutable
|
|
3827
|
+
*/
|
|
3254
3828
|
_id?: string;
|
|
3255
3829
|
/** Rule on which item properties or layouts will be changed. */
|
|
3256
3830
|
condition?: Record<string, any> | null;
|
|
3257
3831
|
/**
|
|
3258
3832
|
* Form items with defined properties that will be
|
|
3259
3833
|
* changed when given condition is resolved to true.
|
|
3834
|
+
* @maxSize 500
|
|
3260
3835
|
*/
|
|
3261
3836
|
overrides?: FormOverride[];
|
|
3262
|
-
/**
|
|
3837
|
+
/**
|
|
3838
|
+
* Name of the rule
|
|
3839
|
+
* @maxLength 200
|
|
3840
|
+
*/
|
|
3263
3841
|
name?: string | null;
|
|
3264
3842
|
}
|
|
3265
3843
|
export declare enum OverrideEntityType {
|
|
@@ -3267,15 +3845,28 @@ export declare enum OverrideEntityType {
|
|
|
3267
3845
|
FIELD = "FIELD"
|
|
3268
3846
|
}
|
|
3269
3847
|
export interface FormOverride {
|
|
3270
|
-
/**
|
|
3848
|
+
/**
|
|
3849
|
+
* Override entity type.
|
|
3850
|
+
* @immutable
|
|
3851
|
+
*/
|
|
3271
3852
|
entityType?: OverrideEntityType;
|
|
3272
|
-
/**
|
|
3853
|
+
/**
|
|
3854
|
+
* Overridden entity id. Either fieldId, or "{fieldIdWithNestedForm}/{nestedFormFieldId}"
|
|
3855
|
+
* @immutable
|
|
3856
|
+
* @maxLength 73
|
|
3857
|
+
*/
|
|
3273
3858
|
entityId?: string | null;
|
|
3274
3859
|
/** Form entity properties path with new value, that will be changed on condition. */
|
|
3275
3860
|
valueChanges?: Record<string, any>;
|
|
3276
3861
|
}
|
|
3277
3862
|
export interface FormProperties {
|
|
3278
|
-
/**
|
|
3863
|
+
/**
|
|
3864
|
+
* Form name.
|
|
3865
|
+
* @maxLength 200
|
|
3866
|
+
* @deprecated
|
|
3867
|
+
* @replacedBy wix.forms.v4.Form.name
|
|
3868
|
+
* @targetRemovalDate 2026-01-06
|
|
3869
|
+
*/
|
|
3279
3870
|
name?: string | null;
|
|
3280
3871
|
/**
|
|
3281
3872
|
* Identifies if the form is disabled.
|
|
@@ -3296,17 +3887,27 @@ export interface PostSubmissionTriggers {
|
|
|
3296
3887
|
upsertContact?: UpsertContact;
|
|
3297
3888
|
}
|
|
3298
3889
|
export interface UpsertContact {
|
|
3299
|
-
/**
|
|
3890
|
+
/**
|
|
3891
|
+
* Fields mapping (target field mapped to corresponding contact field).
|
|
3892
|
+
* @maxSize 250
|
|
3893
|
+
*/
|
|
3300
3894
|
fieldsMapping?: Record<string, FormFieldContactInfo>;
|
|
3301
3895
|
/**
|
|
3302
3896
|
* List of contact label keys.
|
|
3303
3897
|
* [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
|
|
3304
3898
|
* help categorize contacts.
|
|
3899
|
+
* @minLength 1
|
|
3900
|
+
* @maxLength 100
|
|
3901
|
+
* @maxSize 20
|
|
3305
3902
|
*/
|
|
3306
3903
|
labels?: string[];
|
|
3307
3904
|
}
|
|
3308
3905
|
export interface NestedForm {
|
|
3309
|
-
/**
|
|
3906
|
+
/**
|
|
3907
|
+
* Targets which have this form.
|
|
3908
|
+
* @maxSize 10
|
|
3909
|
+
* @maxLength 200
|
|
3910
|
+
*/
|
|
3310
3911
|
targets?: string[];
|
|
3311
3912
|
/** Nested form. */
|
|
3312
3913
|
form?: Form;
|
|
@@ -3373,28 +3974,44 @@ export interface ThankYouMessageOptions {
|
|
|
3373
3974
|
richContent?: RichContent;
|
|
3374
3975
|
}
|
|
3375
3976
|
export interface RedirectOptions {
|
|
3376
|
-
/**
|
|
3977
|
+
/**
|
|
3978
|
+
* The URL to which the user should be redirected after a successful form submission.
|
|
3979
|
+
* @maxLength 2000
|
|
3980
|
+
*/
|
|
3377
3981
|
redirectUrl?: string | null;
|
|
3378
3982
|
/** How the URL should be opened. */
|
|
3379
3983
|
target?: Target;
|
|
3380
3984
|
}
|
|
3381
3985
|
export interface FieldGroup {
|
|
3382
|
-
/**
|
|
3986
|
+
/**
|
|
3987
|
+
* Id of group, on layout
|
|
3988
|
+
* @format GUID
|
|
3989
|
+
*/
|
|
3383
3990
|
_id?: string;
|
|
3384
|
-
/**
|
|
3991
|
+
/**
|
|
3992
|
+
* Label of group
|
|
3993
|
+
* @maxLength 350
|
|
3994
|
+
*/
|
|
3385
3995
|
label?: string | null;
|
|
3386
3996
|
}
|
|
3387
3997
|
export interface CreateCheckoutFromSubmissionResponse {
|
|
3388
|
-
/**
|
|
3998
|
+
/**
|
|
3999
|
+
* Checkout ID (applicable for form involving payments).
|
|
4000
|
+
* @format GUID
|
|
4001
|
+
*/
|
|
3389
4002
|
checkoutId?: string | null;
|
|
3390
4003
|
/** Checkout (applicable for form involving payments). */
|
|
3391
4004
|
checkout?: Checkout;
|
|
3392
4005
|
}
|
|
3393
4006
|
export interface Checkout {
|
|
3394
|
-
/**
|
|
4007
|
+
/**
|
|
4008
|
+
* Checkout ID.
|
|
4009
|
+
* @format GUID
|
|
4010
|
+
*/
|
|
3395
4011
|
_id?: string;
|
|
3396
4012
|
/**
|
|
3397
4013
|
* The currency used when submitting the order.
|
|
4014
|
+
* @format CURRENCY
|
|
3398
4015
|
* @readonly
|
|
3399
4016
|
*/
|
|
3400
4017
|
currency?: string;
|
|
@@ -3476,9 +4093,15 @@ export interface ActionEvent {
|
|
|
3476
4093
|
export interface Empty {
|
|
3477
4094
|
}
|
|
3478
4095
|
export interface MessageEnvelope {
|
|
3479
|
-
/**
|
|
4096
|
+
/**
|
|
4097
|
+
* App instance ID.
|
|
4098
|
+
* @format GUID
|
|
4099
|
+
*/
|
|
3480
4100
|
instanceId?: string | null;
|
|
3481
|
-
/**
|
|
4101
|
+
/**
|
|
4102
|
+
* Event type.
|
|
4103
|
+
* @maxLength 150
|
|
4104
|
+
*/
|
|
3482
4105
|
eventType?: string;
|
|
3483
4106
|
/** The identification type and identity data. */
|
|
3484
4107
|
identity?: IdentificationData;
|
|
@@ -3486,26 +4109,50 @@ export interface MessageEnvelope {
|
|
|
3486
4109
|
data?: string;
|
|
3487
4110
|
}
|
|
3488
4111
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3489
|
-
/**
|
|
4112
|
+
/**
|
|
4113
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4114
|
+
* @format GUID
|
|
4115
|
+
*/
|
|
3490
4116
|
anonymousVisitorId?: string;
|
|
3491
|
-
/**
|
|
4117
|
+
/**
|
|
4118
|
+
* ID of a site visitor that has logged in to the site.
|
|
4119
|
+
* @format GUID
|
|
4120
|
+
*/
|
|
3492
4121
|
memberId?: string;
|
|
3493
|
-
/**
|
|
4122
|
+
/**
|
|
4123
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4124
|
+
* @format GUID
|
|
4125
|
+
*/
|
|
3494
4126
|
wixUserId?: string;
|
|
3495
|
-
/**
|
|
4127
|
+
/**
|
|
4128
|
+
* ID of an app.
|
|
4129
|
+
* @format GUID
|
|
4130
|
+
*/
|
|
3496
4131
|
appId?: string;
|
|
3497
4132
|
/** @readonly */
|
|
3498
4133
|
identityType?: WebhookIdentityType;
|
|
3499
4134
|
}
|
|
3500
4135
|
/** @oneof */
|
|
3501
4136
|
export interface IdentificationDataIdOneOf {
|
|
3502
|
-
/**
|
|
4137
|
+
/**
|
|
4138
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4139
|
+
* @format GUID
|
|
4140
|
+
*/
|
|
3503
4141
|
anonymousVisitorId?: string;
|
|
3504
|
-
/**
|
|
4142
|
+
/**
|
|
4143
|
+
* ID of a site visitor that has logged in to the site.
|
|
4144
|
+
* @format GUID
|
|
4145
|
+
*/
|
|
3505
4146
|
memberId?: string;
|
|
3506
|
-
/**
|
|
4147
|
+
/**
|
|
4148
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4149
|
+
* @format GUID
|
|
4150
|
+
*/
|
|
3507
4151
|
wixUserId?: string;
|
|
3508
|
-
/**
|
|
4152
|
+
/**
|
|
4153
|
+
* ID of an app.
|
|
4154
|
+
* @format GUID
|
|
4155
|
+
*/
|
|
3509
4156
|
appId?: string;
|
|
3510
4157
|
}
|
|
3511
4158
|
export declare enum WebhookIdentityType {
|
|
@@ -3515,10 +4162,63 @@ export declare enum WebhookIdentityType {
|
|
|
3515
4162
|
WIX_USER = "WIX_USER",
|
|
3516
4163
|
APP = "APP"
|
|
3517
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
|
+
}
|
|
3518
4214
|
export interface CreateSubmissionRequest {
|
|
3519
4215
|
/** Submission to create. */
|
|
3520
4216
|
submission: FormSubmission;
|
|
3521
|
-
/**
|
|
4217
|
+
/**
|
|
4218
|
+
* Captcha token.
|
|
4219
|
+
* @minLength 1
|
|
4220
|
+
* @maxLength 3000
|
|
4221
|
+
*/
|
|
3522
4222
|
captchaToken?: string | null;
|
|
3523
4223
|
}
|
|
3524
4224
|
export interface CreateSubmissionResponse {
|
|
@@ -3526,15 +4226,24 @@ export interface CreateSubmissionResponse {
|
|
|
3526
4226
|
submission?: FormSubmission;
|
|
3527
4227
|
}
|
|
3528
4228
|
export interface SubmissionValidationErrorsDetails {
|
|
3529
|
-
/**
|
|
4229
|
+
/**
|
|
4230
|
+
* Submission validation errors details.
|
|
4231
|
+
* @maxSize 100
|
|
4232
|
+
*/
|
|
3530
4233
|
errors?: ValidationError[];
|
|
3531
4234
|
}
|
|
3532
4235
|
export interface ValidationError {
|
|
3533
|
-
/**
|
|
4236
|
+
/**
|
|
4237
|
+
* Path indicating the source of the error, such as `submission.submissions.email``
|
|
4238
|
+
* @maxLength 1000
|
|
4239
|
+
*/
|
|
3534
4240
|
errorPath?: string;
|
|
3535
4241
|
/** Error type. */
|
|
3536
4242
|
errorType?: ErrorType;
|
|
3537
|
-
/**
|
|
4243
|
+
/**
|
|
4244
|
+
* Error message.
|
|
4245
|
+
* @maxLength 1000
|
|
4246
|
+
*/
|
|
3538
4247
|
errorMessage?: string;
|
|
3539
4248
|
/** Additional error parameters, to help identify additional info. */
|
|
3540
4249
|
params?: Record<string, any> | null;
|
|
@@ -3608,16 +4317,23 @@ export interface CreateSubmissionBySubmitterResponse {
|
|
|
3608
4317
|
submission?: FormSubmission;
|
|
3609
4318
|
}
|
|
3610
4319
|
export interface BulkCreateSubmissionBySubmitterRequest {
|
|
3611
|
-
/**
|
|
4320
|
+
/**
|
|
4321
|
+
* Form id. Restricts submissions creation for a single form.
|
|
4322
|
+
* @format GUID
|
|
4323
|
+
*/
|
|
3612
4324
|
formId: string;
|
|
3613
4325
|
/**
|
|
3614
4326
|
* Submissions to create.
|
|
3615
4327
|
* Deprecated
|
|
4328
|
+
* @maxSize 100
|
|
3616
4329
|
*/
|
|
3617
4330
|
submissions?: FormSubmission[];
|
|
3618
4331
|
/** When set, items will be returned on successful create. */
|
|
3619
4332
|
returnEntity?: boolean;
|
|
3620
|
-
/**
|
|
4333
|
+
/**
|
|
4334
|
+
* Submissions data to create.
|
|
4335
|
+
* @maxSize 100
|
|
4336
|
+
*/
|
|
3621
4337
|
submissionsV2?: BulkCreateSubmissionBySubmitterData[];
|
|
3622
4338
|
/** Validation will be mode is more forgiving, for example "required" won't be validated. */
|
|
3623
4339
|
lenientValidation?: boolean;
|
|
@@ -3641,7 +4357,10 @@ export interface BulkSubmissionResult {
|
|
|
3641
4357
|
item?: FormSubmission;
|
|
3642
4358
|
}
|
|
3643
4359
|
export interface ItemMetadata {
|
|
3644
|
-
/**
|
|
4360
|
+
/**
|
|
4361
|
+
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
4362
|
+
* @format GUID
|
|
4363
|
+
*/
|
|
3645
4364
|
_id?: string | null;
|
|
3646
4365
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
3647
4366
|
originalIndex?: number;
|
|
@@ -3667,7 +4386,10 @@ export interface BulkActionMetadata {
|
|
|
3667
4386
|
undetailedFailures?: number;
|
|
3668
4387
|
}
|
|
3669
4388
|
export interface GetSubmissionRequest {
|
|
3670
|
-
/**
|
|
4389
|
+
/**
|
|
4390
|
+
* ID of the submission to retrieve.
|
|
4391
|
+
* @format GUID
|
|
4392
|
+
*/
|
|
3671
4393
|
submissionId: string;
|
|
3672
4394
|
}
|
|
3673
4395
|
export interface GetSubmissionResponse {
|
|
@@ -3675,7 +4397,10 @@ export interface GetSubmissionResponse {
|
|
|
3675
4397
|
submission?: FormSubmission;
|
|
3676
4398
|
}
|
|
3677
4399
|
export interface GetSubmissionByCheckoutIdRequest {
|
|
3678
|
-
/**
|
|
4400
|
+
/**
|
|
4401
|
+
* Checkout ID of the submission to retrieve.
|
|
4402
|
+
* @format GUID
|
|
4403
|
+
*/
|
|
3679
4404
|
checkoutId?: string;
|
|
3680
4405
|
}
|
|
3681
4406
|
export interface GetSubmissionByCheckoutIdResponse {
|
|
@@ -3691,7 +4416,10 @@ export interface UpdateSubmissionResponse {
|
|
|
3691
4416
|
submission?: FormSubmission;
|
|
3692
4417
|
}
|
|
3693
4418
|
export interface ConfirmSubmissionRequest {
|
|
3694
|
-
/**
|
|
4419
|
+
/**
|
|
4420
|
+
* Submission ID to confirm.
|
|
4421
|
+
* @format GUID
|
|
4422
|
+
*/
|
|
3695
4423
|
submissionId: string;
|
|
3696
4424
|
}
|
|
3697
4425
|
export interface ConfirmSubmissionResponse {
|
|
@@ -3699,7 +4427,10 @@ export interface ConfirmSubmissionResponse {
|
|
|
3699
4427
|
submission?: FormSubmission;
|
|
3700
4428
|
}
|
|
3701
4429
|
export interface DeleteSubmissionRequest {
|
|
3702
|
-
/**
|
|
4430
|
+
/**
|
|
4431
|
+
* ID of the submission to delete.
|
|
4432
|
+
* @format GUID
|
|
4433
|
+
*/
|
|
3703
4434
|
submissionId: string;
|
|
3704
4435
|
/**
|
|
3705
4436
|
* Delete the submission, bypassing the trash bin. This means that the submission is permanently deleted and cannot be restored.
|
|
@@ -3714,9 +4445,17 @@ export interface DeleteSubmissionRequest {
|
|
|
3714
4445
|
export interface DeleteSubmissionResponse {
|
|
3715
4446
|
}
|
|
3716
4447
|
export interface BulkDeleteSubmissionRequest {
|
|
3717
|
-
/**
|
|
4448
|
+
/**
|
|
4449
|
+
* Form ID.
|
|
4450
|
+
* @format GUID
|
|
4451
|
+
*/
|
|
3718
4452
|
formId: string;
|
|
3719
|
-
/**
|
|
4453
|
+
/**
|
|
4454
|
+
* Submission ids.
|
|
4455
|
+
* @minSize 1
|
|
4456
|
+
* @maxSize 100
|
|
4457
|
+
* @format GUID
|
|
4458
|
+
*/
|
|
3720
4459
|
submissionIds?: string[];
|
|
3721
4460
|
/**
|
|
3722
4461
|
* Delete submission bypassing trash-bin
|
|
@@ -3727,7 +4466,11 @@ export interface BulkDeleteSubmissionRequest {
|
|
|
3727
4466
|
preserveFiles?: boolean;
|
|
3728
4467
|
}
|
|
3729
4468
|
export interface BulkDeleteSubmissionResponse {
|
|
3730
|
-
/**
|
|
4469
|
+
/**
|
|
4470
|
+
* Results of bulk submission delete
|
|
4471
|
+
* @minSize 1
|
|
4472
|
+
* @maxSize 100
|
|
4473
|
+
*/
|
|
3731
4474
|
results?: BulkDeleteSubmissionResult[];
|
|
3732
4475
|
/** Metadata of request */
|
|
3733
4476
|
bulkActionMetadata?: BulkActionMetadata;
|
|
@@ -3737,7 +4480,10 @@ export interface BulkDeleteSubmissionResult {
|
|
|
3737
4480
|
itemMetadata?: ItemMetadata;
|
|
3738
4481
|
}
|
|
3739
4482
|
export interface RestoreSubmissionFromTrashBinRequest {
|
|
3740
|
-
/**
|
|
4483
|
+
/**
|
|
4484
|
+
* ID of the submission to restore.
|
|
4485
|
+
* @format GUID
|
|
4486
|
+
*/
|
|
3741
4487
|
submissionId: string;
|
|
3742
4488
|
}
|
|
3743
4489
|
export interface RestoreSubmissionFromTrashBinResponse {
|
|
@@ -3745,19 +4491,33 @@ export interface RestoreSubmissionFromTrashBinResponse {
|
|
|
3745
4491
|
submission?: FormSubmission;
|
|
3746
4492
|
}
|
|
3747
4493
|
export interface RemoveSubmissionFromTrashBinRequest {
|
|
3748
|
-
/**
|
|
4494
|
+
/**
|
|
4495
|
+
* ID of the submission to restore.
|
|
4496
|
+
* @format GUID
|
|
4497
|
+
*/
|
|
3749
4498
|
submissionId: string;
|
|
3750
4499
|
}
|
|
3751
4500
|
export interface RemoveSubmissionFromTrashBinResponse {
|
|
3752
4501
|
}
|
|
3753
4502
|
export interface BulkRemoveSubmissionFromTrashBinRequest {
|
|
3754
|
-
/**
|
|
4503
|
+
/**
|
|
4504
|
+
* Form ID.
|
|
4505
|
+
* @format GUID
|
|
4506
|
+
*/
|
|
3755
4507
|
formId: string;
|
|
3756
|
-
/**
|
|
4508
|
+
/**
|
|
4509
|
+
* Submission ids.
|
|
4510
|
+
* @minSize 1
|
|
4511
|
+
* @maxSize 100
|
|
4512
|
+
* @format GUID
|
|
4513
|
+
*/
|
|
3757
4514
|
submissionIds?: string[];
|
|
3758
4515
|
}
|
|
3759
4516
|
export interface BulkRemoveSubmissionFromTrashBinResponse {
|
|
3760
|
-
/**
|
|
4517
|
+
/**
|
|
4518
|
+
* Results of bulk submission removal from trash
|
|
4519
|
+
* @maxSize 100
|
|
4520
|
+
*/
|
|
3761
4521
|
results?: BulkRemoveSubmissionFromTrashBinResult[];
|
|
3762
4522
|
/** Metadata of request */
|
|
3763
4523
|
bulkActionMetadata?: BulkActionMetadata;
|
|
@@ -3767,20 +4527,31 @@ export interface BulkRemoveSubmissionFromTrashBinResult {
|
|
|
3767
4527
|
itemMetadata?: ItemMetadata;
|
|
3768
4528
|
}
|
|
3769
4529
|
export interface ListDeletedSubmissionsRequest {
|
|
3770
|
-
/**
|
|
4530
|
+
/**
|
|
4531
|
+
* Form ID.
|
|
4532
|
+
* @format GUID
|
|
4533
|
+
*/
|
|
3771
4534
|
formId: string;
|
|
3772
|
-
/**
|
|
4535
|
+
/**
|
|
4536
|
+
* Submission ids.
|
|
4537
|
+
* @maxSize 10
|
|
4538
|
+
* @format GUID
|
|
4539
|
+
*/
|
|
3773
4540
|
submissionIds?: string[];
|
|
3774
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`. */
|
|
3775
4542
|
paging?: CursorPaging;
|
|
3776
4543
|
/**
|
|
3777
4544
|
* List of statuses of submissions which should be returned
|
|
3778
4545
|
* Default: CONFIRMED
|
|
4546
|
+
* @maxSize 4
|
|
3779
4547
|
*/
|
|
3780
4548
|
statuses?: SubmissionStatus[];
|
|
3781
4549
|
}
|
|
3782
4550
|
export interface CursorPaging {
|
|
3783
|
-
/**
|
|
4551
|
+
/**
|
|
4552
|
+
* Number of items to load.
|
|
4553
|
+
* @max 100
|
|
4554
|
+
*/
|
|
3784
4555
|
limit?: number | null;
|
|
3785
4556
|
/**
|
|
3786
4557
|
* Pointer to the next or previous page in the list of results.
|
|
@@ -3788,6 +4559,7 @@ export interface CursorPaging {
|
|
|
3788
4559
|
* You can get the relevant cursor token
|
|
3789
4560
|
* from the `pagingMetadata` object in the previous call's response.
|
|
3790
4561
|
* Not relevant for the first request.
|
|
4562
|
+
* @maxLength 16000
|
|
3791
4563
|
*/
|
|
3792
4564
|
cursor?: string | null;
|
|
3793
4565
|
}
|
|
@@ -3810,13 +4582,22 @@ export interface CursorPagingMetadata {
|
|
|
3810
4582
|
hasNext?: boolean | null;
|
|
3811
4583
|
}
|
|
3812
4584
|
export interface Cursors {
|
|
3813
|
-
/**
|
|
4585
|
+
/**
|
|
4586
|
+
* Cursor pointing to next page in the list of results.
|
|
4587
|
+
* @maxLength 16000
|
|
4588
|
+
*/
|
|
3814
4589
|
next?: string | null;
|
|
3815
|
-
/**
|
|
4590
|
+
/**
|
|
4591
|
+
* Cursor pointing to previous page in the list of results.
|
|
4592
|
+
* @maxLength 16000
|
|
4593
|
+
*/
|
|
3816
4594
|
prev?: string | null;
|
|
3817
4595
|
}
|
|
3818
4596
|
export interface GetDeletedSubmissionRequest {
|
|
3819
|
-
/**
|
|
4597
|
+
/**
|
|
4598
|
+
* Submission id.
|
|
4599
|
+
* @format GUID
|
|
4600
|
+
*/
|
|
3820
4601
|
submissionId: string;
|
|
3821
4602
|
}
|
|
3822
4603
|
export interface GetDeletedSubmissionResponse {
|
|
@@ -3844,6 +4625,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
3844
4625
|
/**
|
|
3845
4626
|
* Sort object in the following format:
|
|
3846
4627
|
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
4628
|
+
* @maxSize 3
|
|
3847
4629
|
*/
|
|
3848
4630
|
sort?: Sorting[];
|
|
3849
4631
|
}
|
|
@@ -3853,7 +4635,10 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
3853
4635
|
cursorPaging?: CursorPaging;
|
|
3854
4636
|
}
|
|
3855
4637
|
export interface Sorting {
|
|
3856
|
-
/**
|
|
4638
|
+
/**
|
|
4639
|
+
* Name of the field to sort by.
|
|
4640
|
+
* @maxLength 512
|
|
4641
|
+
*/
|
|
3857
4642
|
fieldName?: string;
|
|
3858
4643
|
/** Sort order. */
|
|
3859
4644
|
order?: SortOrder;
|
|
@@ -3880,7 +4665,10 @@ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
3880
4665
|
cursorPaging?: CursorPaging;
|
|
3881
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) */
|
|
3882
4667
|
filter?: Record<string, any> | null;
|
|
3883
|
-
/**
|
|
4668
|
+
/**
|
|
4669
|
+
* Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
|
|
4670
|
+
* @maxSize 10
|
|
4671
|
+
*/
|
|
3884
4672
|
sort?: Sorting[];
|
|
3885
4673
|
/** Free text to match in searchable fields */
|
|
3886
4674
|
search?: SearchDetails;
|
|
@@ -3896,7 +4684,10 @@ export interface CursorSearchPagingMethodOneOf {
|
|
|
3896
4684
|
export interface SearchDetails {
|
|
3897
4685
|
/** Defines how separate search terms in `expression` are combined */
|
|
3898
4686
|
mode?: Mode;
|
|
3899
|
-
/**
|
|
4687
|
+
/**
|
|
4688
|
+
* Search term or expression
|
|
4689
|
+
* @maxLength 100
|
|
4690
|
+
*/
|
|
3900
4691
|
expression?: string | null;
|
|
3901
4692
|
/** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
|
|
3902
4693
|
fuzzy?: boolean;
|
|
@@ -3956,7 +4747,10 @@ export interface CountSubmissionsByFilterResponse {
|
|
|
3956
4747
|
formsSubmissionsCount?: FormSubmissionsCount[];
|
|
3957
4748
|
}
|
|
3958
4749
|
export interface FormSubmissionsCount {
|
|
3959
|
-
/**
|
|
4750
|
+
/**
|
|
4751
|
+
* Form ID.
|
|
4752
|
+
* @format GUID
|
|
4753
|
+
*/
|
|
3960
4754
|
formId?: string;
|
|
3961
4755
|
/** Total number of submissions. */
|
|
3962
4756
|
totalCount?: number;
|
|
@@ -3964,9 +4758,18 @@ export interface FormSubmissionsCount {
|
|
|
3964
4758
|
unseenCount?: number;
|
|
3965
4759
|
}
|
|
3966
4760
|
export interface CountSubmissionsRequest {
|
|
3967
|
-
/**
|
|
4761
|
+
/**
|
|
4762
|
+
* Form IDs which submissions should be counted.
|
|
4763
|
+
* @format GUID
|
|
4764
|
+
* @minSize 1
|
|
4765
|
+
* @maxSize 100
|
|
4766
|
+
*/
|
|
3968
4767
|
formIds: string[];
|
|
3969
|
-
/**
|
|
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
|
+
*/
|
|
3970
4773
|
namespace: string;
|
|
3971
4774
|
/**
|
|
3972
4775
|
* Status of the submission.
|
|
@@ -3974,6 +4777,7 @@ export interface CountSubmissionsRequest {
|
|
|
3974
4777
|
* - `PAYMENT_WAITING`: A form submission requiring payment is created.
|
|
3975
4778
|
* - `PAYMENT_CANCELED`: An order of a form submission is canceled.
|
|
3976
4779
|
* - `CONFIRMED`: A submission is recorded in the Wix Forms collection.
|
|
4780
|
+
* @maxSize 4
|
|
3977
4781
|
*/
|
|
3978
4782
|
statuses?: SubmissionStatus[];
|
|
3979
4783
|
}
|
|
@@ -3982,13 +4786,23 @@ export interface CountSubmissionsResponse {
|
|
|
3982
4786
|
formsSubmissionsCount?: FormSubmissionsCount[];
|
|
3983
4787
|
}
|
|
3984
4788
|
export interface CountDeletedSubmissionsRequest {
|
|
3985
|
-
/**
|
|
4789
|
+
/**
|
|
4790
|
+
* Form IDs.
|
|
4791
|
+
* @format GUID
|
|
4792
|
+
* @minSize 1
|
|
4793
|
+
* @maxSize 100
|
|
4794
|
+
*/
|
|
3986
4795
|
formIds: string[];
|
|
3987
|
-
/**
|
|
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
|
+
*/
|
|
3988
4801
|
namespace: string;
|
|
3989
4802
|
/**
|
|
3990
4803
|
* List of statuses of submissions which should be taken into count
|
|
3991
4804
|
* Default: CONFIRMED, PAYMENT_WAITING, PAYMENT_CANCELED
|
|
4805
|
+
* @maxSize 4
|
|
3992
4806
|
*/
|
|
3993
4807
|
statuses?: SubmissionStatus[];
|
|
3994
4808
|
}
|
|
@@ -3997,37 +4811,61 @@ export interface CountDeletedSubmissionsResponse {
|
|
|
3997
4811
|
formsDeletedSubmissionsCount?: FormDeletedSubmissionsCount[];
|
|
3998
4812
|
}
|
|
3999
4813
|
export interface FormDeletedSubmissionsCount {
|
|
4000
|
-
/**
|
|
4814
|
+
/**
|
|
4815
|
+
* Form ID.
|
|
4816
|
+
* @format GUID
|
|
4817
|
+
*/
|
|
4001
4818
|
formId?: string;
|
|
4002
4819
|
/** Total number of submissions. */
|
|
4003
4820
|
totalCount?: number;
|
|
4004
4821
|
}
|
|
4005
4822
|
export interface GetMediaUploadURLRequest {
|
|
4006
|
-
/**
|
|
4823
|
+
/**
|
|
4824
|
+
* Form ID.
|
|
4825
|
+
* @format GUID
|
|
4826
|
+
*/
|
|
4007
4827
|
formId: string;
|
|
4008
|
-
/**
|
|
4828
|
+
/**
|
|
4829
|
+
* Name of file to upload.
|
|
4830
|
+
* @maxLength 300
|
|
4831
|
+
*/
|
|
4009
4832
|
filename: string;
|
|
4010
4833
|
/**
|
|
4011
4834
|
* [Mime type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#) of file to upload.
|
|
4012
4835
|
*
|
|
4013
4836
|
* For example, `'image/png'`
|
|
4837
|
+
* @maxLength 100
|
|
4014
4838
|
*/
|
|
4015
4839
|
mimeType: string;
|
|
4016
4840
|
}
|
|
4017
4841
|
export interface GetMediaUploadURLResponse {
|
|
4018
|
-
/**
|
|
4842
|
+
/**
|
|
4843
|
+
* Url to upload file.
|
|
4844
|
+
* @maxLength 500
|
|
4845
|
+
*/
|
|
4019
4846
|
uploadUrl?: string;
|
|
4020
4847
|
}
|
|
4021
4848
|
export interface BulkMarkSubmissionsAsSeenRequest {
|
|
4022
|
-
/**
|
|
4849
|
+
/**
|
|
4850
|
+
* Submission IDs to mark as seen.
|
|
4851
|
+
* @format GUID
|
|
4852
|
+
* @minSize 1
|
|
4853
|
+
* @maxSize 100
|
|
4854
|
+
*/
|
|
4023
4855
|
ids: string[];
|
|
4024
|
-
/**
|
|
4856
|
+
/**
|
|
4857
|
+
* ID of the form which the submissions belong to.
|
|
4858
|
+
* @format GUID
|
|
4859
|
+
*/
|
|
4025
4860
|
formId: string;
|
|
4026
4861
|
}
|
|
4027
4862
|
export interface BulkMarkSubmissionsAsSeenResponse {
|
|
4028
4863
|
}
|
|
4029
4864
|
export interface GetSubmissionDownloadUrlRequest {
|
|
4030
|
-
/**
|
|
4865
|
+
/**
|
|
4866
|
+
* Submission ID.
|
|
4867
|
+
* @format GUID
|
|
4868
|
+
*/
|
|
4031
4869
|
submissionId: string;
|
|
4032
4870
|
}
|
|
4033
4871
|
export interface GetSubmissionDownloadUrlResponse {
|
|
@@ -4040,6 +4878,7 @@ export interface SubmissionDocument extends SubmissionDocumentDocumentOneOf {
|
|
|
4040
4878
|
/**
|
|
4041
4879
|
* Document ID.
|
|
4042
4880
|
* @readonly
|
|
4881
|
+
* @maxLength 50
|
|
4043
4882
|
*/
|
|
4044
4883
|
_id?: string | null;
|
|
4045
4884
|
/** Document status. */
|
|
@@ -4060,45 +4899,89 @@ export interface DocumentReady {
|
|
|
4060
4899
|
/**
|
|
4061
4900
|
* Document download URL.
|
|
4062
4901
|
* @readonly
|
|
4902
|
+
* @maxLength 300
|
|
4063
4903
|
*/
|
|
4064
4904
|
downloadUrl?: string;
|
|
4065
4905
|
}
|
|
4066
4906
|
export interface GetFormattedSubmissionRequest {
|
|
4067
|
-
/**
|
|
4907
|
+
/**
|
|
4908
|
+
* Submission ID.
|
|
4909
|
+
* @format GUID
|
|
4910
|
+
*/
|
|
4068
4911
|
submissionId?: string;
|
|
4069
4912
|
}
|
|
4070
4913
|
export interface GetFormattedSubmissionResponse {
|
|
4071
|
-
/**
|
|
4914
|
+
/**
|
|
4915
|
+
* Submission ID.
|
|
4916
|
+
* @format GUID
|
|
4917
|
+
*/
|
|
4072
4918
|
submissionId?: string;
|
|
4073
|
-
/**
|
|
4919
|
+
/**
|
|
4920
|
+
* Ordered by form layout list of field submissions.
|
|
4921
|
+
* @maxSize 100
|
|
4922
|
+
*/
|
|
4074
4923
|
submissions?: FormattedSubmission[];
|
|
4075
4924
|
}
|
|
4076
4925
|
export interface FormattedSubmission {
|
|
4077
|
-
/**
|
|
4926
|
+
/**
|
|
4927
|
+
* Label of form field
|
|
4928
|
+
* @maxLength 500
|
|
4929
|
+
*/
|
|
4078
4930
|
label?: string | null;
|
|
4079
|
-
/**
|
|
4931
|
+
/**
|
|
4932
|
+
* Key of the submission, and target of a form field
|
|
4933
|
+
* @maxLength 200
|
|
4934
|
+
*/
|
|
4080
4935
|
key?: string;
|
|
4081
|
-
/**
|
|
4936
|
+
/**
|
|
4937
|
+
* Value of the submission, formatted as a string
|
|
4938
|
+
* @maxLength 500
|
|
4939
|
+
*/
|
|
4082
4940
|
value?: string;
|
|
4083
|
-
/**
|
|
4941
|
+
/**
|
|
4942
|
+
* Id of the form field
|
|
4943
|
+
* @format GUID
|
|
4944
|
+
*/
|
|
4084
4945
|
fieldId?: string;
|
|
4085
4946
|
}
|
|
4086
4947
|
export interface ListFormattedSubmissionsRequest {
|
|
4087
|
-
/**
|
|
4948
|
+
/**
|
|
4949
|
+
* Namespace.
|
|
4950
|
+
* @minLength 10
|
|
4951
|
+
* @maxLength 50
|
|
4952
|
+
*/
|
|
4088
4953
|
namespace?: string;
|
|
4089
|
-
/**
|
|
4954
|
+
/**
|
|
4955
|
+
* Submission IDs.
|
|
4956
|
+
* @format GUID
|
|
4957
|
+
* @minSize 1
|
|
4958
|
+
* @maxSize 100
|
|
4959
|
+
*/
|
|
4090
4960
|
submissionIds?: string[];
|
|
4091
|
-
/**
|
|
4961
|
+
/**
|
|
4962
|
+
* Optional additional filter of form IDs.
|
|
4963
|
+
* @format GUID
|
|
4964
|
+
* @maxSize 100
|
|
4965
|
+
*/
|
|
4092
4966
|
formIds?: string[];
|
|
4093
4967
|
}
|
|
4094
4968
|
export interface ListFormattedSubmissionsResponse {
|
|
4095
|
-
/**
|
|
4969
|
+
/**
|
|
4970
|
+
* List of formatted submissions
|
|
4971
|
+
* @maxSize 100
|
|
4972
|
+
*/
|
|
4096
4973
|
formattedFormSubmissions?: FormattedFormSubmission[];
|
|
4097
4974
|
}
|
|
4098
4975
|
export interface FormattedFormSubmission {
|
|
4099
|
-
/**
|
|
4976
|
+
/**
|
|
4977
|
+
* Submission ID.
|
|
4978
|
+
* @format GUID
|
|
4979
|
+
*/
|
|
4100
4980
|
submissionId?: string;
|
|
4101
|
-
/**
|
|
4981
|
+
/**
|
|
4982
|
+
* Ordered by form layout list of field submissions.
|
|
4983
|
+
* @maxSize 100
|
|
4984
|
+
*/
|
|
4102
4985
|
submissions?: FormattedSubmission[];
|
|
4103
4986
|
}
|
|
4104
4987
|
export interface UpdateExtendedFieldsRequest {
|
|
@@ -4110,13 +4993,22 @@ export interface UpdateExtendedFieldsRequest {
|
|
|
4110
4993
|
namespaceData: Record<string, any> | null;
|
|
4111
4994
|
}
|
|
4112
4995
|
export interface UpdateExtendedFieldsResponse {
|
|
4113
|
-
/**
|
|
4996
|
+
/**
|
|
4997
|
+
* namespace that was updated
|
|
4998
|
+
* @minLength 10
|
|
4999
|
+
* @maxLength 50
|
|
5000
|
+
*/
|
|
4114
5001
|
namespace?: string;
|
|
4115
5002
|
/** only data from UpdateExtendedFieldsRequest namespace_data */
|
|
4116
5003
|
namespaceData?: Record<string, any> | null;
|
|
4117
5004
|
}
|
|
4118
5005
|
export interface BulkUpdateFormSubmissionTagsRequest {
|
|
4119
|
-
/**
|
|
5006
|
+
/**
|
|
5007
|
+
* Submission IDs to update tags for.
|
|
5008
|
+
* @format GUID
|
|
5009
|
+
* @minSize 1
|
|
5010
|
+
* @maxSize 100
|
|
5011
|
+
*/
|
|
4120
5012
|
submissionIds: string[];
|
|
4121
5013
|
/** Tags to be added to submissions */
|
|
4122
5014
|
assignTags?: PublicTags;
|
|
@@ -4124,7 +5016,11 @@ export interface BulkUpdateFormSubmissionTagsRequest {
|
|
|
4124
5016
|
unassignTags?: PublicTags;
|
|
4125
5017
|
}
|
|
4126
5018
|
export interface BulkUpdateFormSubmissionTagsResponse {
|
|
4127
|
-
/**
|
|
5019
|
+
/**
|
|
5020
|
+
* Updated submissions with results
|
|
5021
|
+
* @minSize 1
|
|
5022
|
+
* @maxSize 100
|
|
5023
|
+
*/
|
|
4128
5024
|
results?: BulkUpdateFormSubmissionTagsResult[];
|
|
4129
5025
|
/** Metadata of request */
|
|
4130
5026
|
bulkActionMetadata?: BulkActionMetadata;
|
|
@@ -4142,7 +5038,10 @@ export interface BulkUpdateFormSubmissionTagsByFilterRequest {
|
|
|
4142
5038
|
unassignTags?: PublicTags;
|
|
4143
5039
|
}
|
|
4144
5040
|
export interface BulkUpdateFormSubmissionTagsByFilterResponse {
|
|
4145
|
-
/**
|
|
5041
|
+
/**
|
|
5042
|
+
* Job id for the bulk update operation
|
|
5043
|
+
* @format GUID
|
|
5044
|
+
*/
|
|
4146
5045
|
jobId?: string;
|
|
4147
5046
|
}
|
|
4148
5047
|
export interface ValidateFormSubmissionRequest {
|
|
@@ -4157,17 +5056,29 @@ export interface ValidateFormSubmissionResponse {
|
|
|
4157
5056
|
* Default: true
|
|
4158
5057
|
*/
|
|
4159
5058
|
valid?: boolean | null;
|
|
4160
|
-
/**
|
|
5059
|
+
/**
|
|
5060
|
+
* Submission validation violations
|
|
5061
|
+
* @maxSize 100
|
|
5062
|
+
*/
|
|
4161
5063
|
violationErrors?: FieldViolation[];
|
|
4162
5064
|
}
|
|
4163
5065
|
export interface FieldViolation extends FieldViolationErrorDataOneOf {
|
|
4164
5066
|
/** Validation errors */
|
|
4165
5067
|
submissionValidationErrors?: SubmissionValidationErrors;
|
|
4166
|
-
/**
|
|
5068
|
+
/**
|
|
5069
|
+
* Name of violated entity
|
|
5070
|
+
* @maxLength 50
|
|
5071
|
+
*/
|
|
4167
5072
|
name?: string;
|
|
4168
|
-
/**
|
|
5073
|
+
/**
|
|
5074
|
+
* Description of the error
|
|
5075
|
+
* @maxLength 512
|
|
5076
|
+
*/
|
|
4169
5077
|
description?: string;
|
|
4170
|
-
/**
|
|
5078
|
+
/**
|
|
5079
|
+
* Rule name
|
|
5080
|
+
* @maxLength 50
|
|
5081
|
+
*/
|
|
4171
5082
|
ruleName?: string;
|
|
4172
5083
|
}
|
|
4173
5084
|
/** @oneof */
|
|
@@ -4176,15 +5087,24 @@ export interface FieldViolationErrorDataOneOf {
|
|
|
4176
5087
|
submissionValidationErrors?: SubmissionValidationErrors;
|
|
4177
5088
|
}
|
|
4178
5089
|
export interface SubmissionValidationErrors {
|
|
4179
|
-
/**
|
|
5090
|
+
/**
|
|
5091
|
+
* Submission validation errors.
|
|
5092
|
+
* @maxSize 100
|
|
5093
|
+
*/
|
|
4180
5094
|
errors?: SubmissionValidationError[];
|
|
4181
5095
|
}
|
|
4182
5096
|
export interface SubmissionValidationError extends SubmissionValidationErrorErrorMessageOneOf {
|
|
4183
5097
|
/** Predefined error type. */
|
|
4184
5098
|
errorType?: SubmissionErrorType;
|
|
4185
|
-
/**
|
|
5099
|
+
/**
|
|
5100
|
+
* Custom error message. The message is displayed instead of an error type.
|
|
5101
|
+
* @maxLength 500
|
|
5102
|
+
*/
|
|
4186
5103
|
customErrorMessage?: string;
|
|
4187
|
-
/**
|
|
5104
|
+
/**
|
|
5105
|
+
* Path indicating the source of the error, such as `form.fields.target`.
|
|
5106
|
+
* @maxLength 500
|
|
5107
|
+
*/
|
|
4188
5108
|
errorPath?: string;
|
|
4189
5109
|
/** Additional error parameters. */
|
|
4190
5110
|
params?: Record<string, any> | null;
|
|
@@ -4193,7 +5113,10 @@ export interface SubmissionValidationError extends SubmissionValidationErrorErro
|
|
|
4193
5113
|
export interface SubmissionValidationErrorErrorMessageOneOf {
|
|
4194
5114
|
/** Predefined error type. */
|
|
4195
5115
|
errorType?: SubmissionErrorType;
|
|
4196
|
-
/**
|
|
5116
|
+
/**
|
|
5117
|
+
* Custom error message. The message is displayed instead of an error type.
|
|
5118
|
+
* @maxLength 500
|
|
5119
|
+
*/
|
|
4197
5120
|
customErrorMessage?: string;
|
|
4198
5121
|
}
|
|
4199
5122
|
export declare enum SubmissionErrorType {
|
|
@@ -4228,45 +5151,13 @@ export declare enum SubmissionErrorType {
|
|
|
4228
5151
|
/** Submitted form is disabled. */
|
|
4229
5152
|
DISABLED_FORM_ERROR = "DISABLED_FORM_ERROR"
|
|
4230
5153
|
}
|
|
4231
|
-
|
|
4232
|
-
|
|
4233
|
-
|
|
4234
|
-
|
|
4235
|
-
contactId?: string | null;
|
|
4236
|
-
/** Indicates contact has verified primary email. */
|
|
4237
|
-
emailVerified?: boolean;
|
|
4238
|
-
}
|
|
4239
|
-
export interface UpsertContactFromSubmissionResponse {
|
|
4240
|
-
/** Submit contact response. */
|
|
4241
|
-
submitContactResponse?: SubmitContactResponse;
|
|
4242
|
-
}
|
|
4243
|
-
export interface SubmitContactResponse {
|
|
4244
|
-
/** ID of the contact that was found or created. */
|
|
4245
|
-
contactId?: string;
|
|
4246
|
-
/**
|
|
4247
|
-
* Identity type of the returned contact.
|
|
4248
|
-
*
|
|
4249
|
-
* - `CONTACT`: The returned contact ID belongs to a new or existing contact.
|
|
4250
|
-
* - `MEMBER`: The returned contact ID belongs to the currently logged-in site member.
|
|
4251
|
-
* - `NOT_AUTHENTICATED_MEMBER`: The returned contact ID belongs to a site member who is not currently logged in.
|
|
4252
|
-
*/
|
|
4253
|
-
identityType?: IdentityType;
|
|
4254
|
-
/**
|
|
4255
|
-
* Indicates whether the contact was just created or already existed.
|
|
4256
|
-
*
|
|
4257
|
-
* If the contact was just created, returns `true`.
|
|
4258
|
-
* If it already existed, returns `false`.
|
|
4259
|
-
*/
|
|
4260
|
-
newContact?: boolean;
|
|
5154
|
+
interface SubmitContactResponseNonNullableFields {
|
|
5155
|
+
contactId: string;
|
|
5156
|
+
identityType: IdentityType;
|
|
5157
|
+
newContact: boolean;
|
|
4261
5158
|
}
|
|
4262
|
-
export
|
|
4263
|
-
|
|
4264
|
-
/** Existing or new contact */
|
|
4265
|
-
CONTACT = "CONTACT",
|
|
4266
|
-
/** Member is logged in, matching logic skipped */
|
|
4267
|
-
MEMBER = "MEMBER",
|
|
4268
|
-
/** Matching contact is a member, Merge logic won't be applied */
|
|
4269
|
-
NOT_AUTHENTICATED_MEMBER = "NOT_AUTHENTICATED_MEMBER"
|
|
5159
|
+
export interface UpsertContactFromSubmissionResponseNonNullableFields {
|
|
5160
|
+
submitContactResponse?: SubmitContactResponseNonNullableFields;
|
|
4270
5161
|
}
|
|
4271
5162
|
interface OrderDetailsNonNullableFields {
|
|
4272
5163
|
itemSubtotal: string;
|
|
@@ -4414,18 +5305,16 @@ interface FieldViolationNonNullableFields {
|
|
|
4414
5305
|
export interface ValidateFormSubmissionResponseNonNullableFields {
|
|
4415
5306
|
violationErrors: FieldViolationNonNullableFields[];
|
|
4416
5307
|
}
|
|
4417
|
-
interface SubmitContactResponseNonNullableFields {
|
|
4418
|
-
contactId: string;
|
|
4419
|
-
identityType: IdentityType;
|
|
4420
|
-
newContact: boolean;
|
|
4421
|
-
}
|
|
4422
|
-
export interface UpsertContactFromSubmissionResponseNonNullableFields {
|
|
4423
|
-
submitContactResponse?: SubmitContactResponseNonNullableFields;
|
|
4424
|
-
}
|
|
4425
5308
|
export interface BaseEventMetadata {
|
|
4426
|
-
/**
|
|
5309
|
+
/**
|
|
5310
|
+
* App instance ID.
|
|
5311
|
+
* @format GUID
|
|
5312
|
+
*/
|
|
4427
5313
|
instanceId?: string | null;
|
|
4428
|
-
/**
|
|
5314
|
+
/**
|
|
5315
|
+
* Event type.
|
|
5316
|
+
* @maxLength 150
|
|
5317
|
+
*/
|
|
4429
5318
|
eventType?: string;
|
|
4430
5319
|
/** The identification type and identity data. */
|
|
4431
5320
|
identity?: IdentificationData;
|
|
@@ -4616,6 +5505,25 @@ export interface SubmissionUpdatedEnvelope {
|
|
|
4616
5505
|
* @documentationMaturity preview
|
|
4617
5506
|
*/
|
|
4618
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
|
+
}
|
|
4619
5527
|
/**
|
|
4620
5528
|
* Creates a submission.
|
|
4621
5529
|
*
|
|
@@ -4636,7 +5544,11 @@ export declare function onSubmissionUpdated(handler: (event: SubmissionUpdatedEn
|
|
|
4636
5544
|
*/
|
|
4637
5545
|
export declare function createSubmission(submission: FormSubmission, options?: CreateSubmissionOptions): Promise<FormSubmission & FormSubmissionNonNullableFields>;
|
|
4638
5546
|
export interface CreateSubmissionOptions {
|
|
4639
|
-
/**
|
|
5547
|
+
/**
|
|
5548
|
+
* Captcha token.
|
|
5549
|
+
* @minLength 1
|
|
5550
|
+
* @maxLength 3000
|
|
5551
|
+
*/
|
|
4640
5552
|
captchaToken?: string | null;
|
|
4641
5553
|
}
|
|
4642
5554
|
/**
|
|
@@ -4656,11 +5568,15 @@ export interface BulkCreateSubmissionBySubmitterOptions {
|
|
|
4656
5568
|
/**
|
|
4657
5569
|
* Submissions to create.
|
|
4658
5570
|
* Deprecated
|
|
5571
|
+
* @maxSize 100
|
|
4659
5572
|
*/
|
|
4660
5573
|
submissions?: FormSubmission[];
|
|
4661
5574
|
/** When set, items will be returned on successful create. */
|
|
4662
5575
|
returnEntity?: boolean;
|
|
4663
|
-
/**
|
|
5576
|
+
/**
|
|
5577
|
+
* Submissions data to create.
|
|
5578
|
+
* @maxSize 100
|
|
5579
|
+
*/
|
|
4664
5580
|
submissionsV2?: BulkCreateSubmissionBySubmitterData[];
|
|
4665
5581
|
/** Validation will be mode is more forgiving, for example "required" won't be validated. */
|
|
4666
5582
|
lenientValidation?: boolean;
|
|
@@ -4707,13 +5623,20 @@ export declare function updateSubmission(_id: string | null, submission: UpdateS
|
|
|
4707
5623
|
export interface UpdateSubmission {
|
|
4708
5624
|
/**
|
|
4709
5625
|
* Submission ID.
|
|
5626
|
+
* @format GUID
|
|
4710
5627
|
* @readonly
|
|
4711
5628
|
*/
|
|
4712
5629
|
_id?: string | null;
|
|
4713
|
-
/**
|
|
5630
|
+
/**
|
|
5631
|
+
* ID of the form which the submission belongs to.
|
|
5632
|
+
* @format GUID
|
|
5633
|
+
* @immutable
|
|
5634
|
+
*/
|
|
4714
5635
|
formId?: string;
|
|
4715
5636
|
/**
|
|
4716
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
|
|
4717
5640
|
* @readonly
|
|
4718
5641
|
*/
|
|
4719
5642
|
namespace?: string;
|
|
@@ -4721,7 +5644,10 @@ export interface UpdateSubmission {
|
|
|
4721
5644
|
status?: SubmissionStatus;
|
|
4722
5645
|
/** Submission values where `key` is the form field and `value` is the data submitted for the given field. */
|
|
4723
5646
|
submissions?: Record<string, any>;
|
|
4724
|
-
/**
|
|
5647
|
+
/**
|
|
5648
|
+
* Date and time the form submission was created.
|
|
5649
|
+
* @immutable
|
|
5650
|
+
*/
|
|
4725
5651
|
_createdDate?: Date | null;
|
|
4726
5652
|
/**
|
|
4727
5653
|
* Date and time the form submission was updated.
|
|
@@ -4744,14 +5670,22 @@ export interface UpdateSubmission {
|
|
|
4744
5670
|
extendedFields?: ExtendedFields;
|
|
4745
5671
|
/**
|
|
4746
5672
|
* Order details. <br>
|
|
4747
|
-
* <b>Note</b>: This object is only applicable when
|
|
5673
|
+
* <b>Note</b>: This object is only applicable when submitting a form in the Wix Payments app.
|
|
4748
5674
|
*/
|
|
4749
5675
|
orderDetails?: OrderDetails;
|
|
4750
|
-
/**
|
|
5676
|
+
/**
|
|
5677
|
+
* Contact ID of a site visitor who created the submission.
|
|
5678
|
+
* @format GUID
|
|
5679
|
+
* @immutable
|
|
5680
|
+
*/
|
|
4751
5681
|
contactId?: string | null;
|
|
4752
|
-
/**
|
|
5682
|
+
/**
|
|
5683
|
+
* Authorized viewer ID.
|
|
5684
|
+
* @format GUID
|
|
5685
|
+
* @immutable
|
|
5686
|
+
*/
|
|
4753
5687
|
accessRestriction?: string | null;
|
|
4754
|
-
/** Tag
|
|
5688
|
+
/** Tag IDs collections associated with the current entity. */
|
|
4755
5689
|
tags?: PublicTags;
|
|
4756
5690
|
}
|
|
4757
5691
|
/**
|
|
@@ -4812,7 +5746,12 @@ export interface DeleteSubmissionOptions {
|
|
|
4812
5746
|
*/
|
|
4813
5747
|
export declare function bulkDeleteSubmission(formId: string, options?: BulkDeleteSubmissionOptions): Promise<BulkDeleteSubmissionResponse & BulkDeleteSubmissionResponseNonNullableFields>;
|
|
4814
5748
|
export interface BulkDeleteSubmissionOptions {
|
|
4815
|
-
/**
|
|
5749
|
+
/**
|
|
5750
|
+
* Submission ids.
|
|
5751
|
+
* @minSize 1
|
|
5752
|
+
* @maxSize 100
|
|
5753
|
+
* @format GUID
|
|
5754
|
+
*/
|
|
4816
5755
|
submissionIds?: string[];
|
|
4817
5756
|
/**
|
|
4818
5757
|
* Delete submission bypassing trash-bin
|
|
@@ -4862,7 +5801,12 @@ export declare function removeSubmissionFromTrashBin(submissionId: string): Prom
|
|
|
4862
5801
|
*/
|
|
4863
5802
|
export declare function bulkRemoveSubmissionFromTrashBin(formId: string, options?: BulkRemoveSubmissionFromTrashBinOptions): Promise<BulkRemoveSubmissionFromTrashBinResponse & BulkRemoveSubmissionFromTrashBinResponseNonNullableFields>;
|
|
4864
5803
|
export interface BulkRemoveSubmissionFromTrashBinOptions {
|
|
4865
|
-
/**
|
|
5804
|
+
/**
|
|
5805
|
+
* Submission ids.
|
|
5806
|
+
* @minSize 1
|
|
5807
|
+
* @maxSize 100
|
|
5808
|
+
* @format GUID
|
|
5809
|
+
*/
|
|
4866
5810
|
submissionIds?: string[];
|
|
4867
5811
|
}
|
|
4868
5812
|
/**
|
|
@@ -4885,13 +5829,18 @@ export interface BulkRemoveSubmissionFromTrashBinOptions {
|
|
|
4885
5829
|
*/
|
|
4886
5830
|
export declare function listDeletedSubmissions(formId: string, options?: ListDeletedSubmissionsOptions): Promise<ListDeletedSubmissionsResponse & ListDeletedSubmissionsResponseNonNullableFields>;
|
|
4887
5831
|
export interface ListDeletedSubmissionsOptions {
|
|
4888
|
-
/**
|
|
5832
|
+
/**
|
|
5833
|
+
* Submission ids.
|
|
5834
|
+
* @maxSize 10
|
|
5835
|
+
* @format GUID
|
|
5836
|
+
*/
|
|
4889
5837
|
submissionIds?: string[];
|
|
4890
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`. */
|
|
4891
5839
|
paging?: CursorPaging;
|
|
4892
5840
|
/**
|
|
4893
5841
|
* List of statuses of submissions which should be returned
|
|
4894
5842
|
* Default: CONFIRMED
|
|
5843
|
+
* @maxSize 4
|
|
4895
5844
|
*/
|
|
4896
5845
|
statuses?: SubmissionStatus[];
|
|
4897
5846
|
}
|
|
@@ -4948,7 +5897,7 @@ export interface QuerySubmissionOptions {
|
|
|
4948
5897
|
*
|
|
4949
5898
|
* You can only query submissions from a specified namespace. Use the query filter on the `namespace` field, otherwise you will receive an error.
|
|
4950
5899
|
*
|
|
4951
|
-
* For field support for filters and sorting, see [Form Submissions: Supported Filters and Sorting](https://dev.wix.com/docs/rest/
|
|
5900
|
+
* For field support for filters and sorting, see [Form Submissions: Supported Filters and Sorting](https://dev.wix.com/docs/rest/crm/forms/form-submissions/filter-and-sort).option
|
|
4952
5901
|
*
|
|
4953
5902
|
* To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
4954
5903
|
* @param search - Query options.
|
|
@@ -5103,6 +6052,7 @@ export interface CountSubmissionsOptions {
|
|
|
5103
6052
|
* - `PAYMENT_WAITING`: A form submission requiring payment is created.
|
|
5104
6053
|
* - `PAYMENT_CANCELED`: An order of a form submission is canceled.
|
|
5105
6054
|
* - `CONFIRMED`: A submission is recorded in the Wix Forms collection.
|
|
6055
|
+
* @maxSize 4
|
|
5106
6056
|
*/
|
|
5107
6057
|
statuses?: SubmissionStatus[];
|
|
5108
6058
|
}
|
|
@@ -5134,6 +6084,7 @@ export interface CountDeletedSubmissionsOptions {
|
|
|
5134
6084
|
/**
|
|
5135
6085
|
* List of statuses of submissions which should be taken into count
|
|
5136
6086
|
* Default: CONFIRMED, PAYMENT_WAITING, PAYMENT_CANCELED
|
|
6087
|
+
* @maxSize 4
|
|
5137
6088
|
*/
|
|
5138
6089
|
statuses?: SubmissionStatus[];
|
|
5139
6090
|
}
|
|
@@ -5233,20 +6184,4 @@ export interface ValidateFormSubmissionOptions {
|
|
|
5233
6184
|
/** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
|
|
5234
6185
|
additionalMetadata?: Record<string, any> | null;
|
|
5235
6186
|
}
|
|
5236
|
-
/**
|
|
5237
|
-
* Upserts contact from submission.
|
|
5238
|
-
* @param submissionId - Submission from which contact needs to be upserted.
|
|
5239
|
-
* @public
|
|
5240
|
-
* @documentationMaturity preview
|
|
5241
|
-
* @requiredField submissionId
|
|
5242
|
-
* @permissionId WIX_FORMS.SUBMISSION_CONTACT_UPSERT
|
|
5243
|
-
* @fqn wix.forms.v4.FormSubmissionContactUpsertService.UpsertContactFromSubmission
|
|
5244
|
-
*/
|
|
5245
|
-
export declare function upsertContactFromSubmission(submissionId: string, options?: UpsertContactFromSubmissionOptions): Promise<UpsertContactFromSubmissionResponse & UpsertContactFromSubmissionResponseNonNullableFields>;
|
|
5246
|
-
export interface UpsertContactFromSubmissionOptions {
|
|
5247
|
-
/** Optional contact id to which submission should be mapped. */
|
|
5248
|
-
contactId?: string | null;
|
|
5249
|
-
/** Indicates contact has verified primary email. */
|
|
5250
|
-
emailVerified?: boolean;
|
|
5251
|
-
}
|
|
5252
6187
|
export {};
|