@wix/auto_sdk_forms_submissions 1.0.3 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/forms-v4-submission-submissions.context.d.ts +5 -4
- package/build/cjs/src/forms-v4-submission-submissions.context.js +4 -5
- package/build/cjs/src/forms-v4-submission-submissions.context.js.map +1 -1
- package/build/cjs/src/forms-v4-submission-submissions.http.d.ts +2 -2
- package/build/cjs/src/forms-v4-submission-submissions.http.js +54 -54
- 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 +20 -10
- package/build/cjs/src/forms-v4-submission-submissions.public.js +7 -8
- package/build/cjs/src/forms-v4-submission-submissions.public.js.map +1 -1
- package/build/cjs/src/forms-v4-submission-submissions.types.d.ts +1214 -305
- 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 +1303 -331
- 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 +5 -4
- package/build/es/src/forms-v4-submission-submissions.context.js +3 -4
- package/build/es/src/forms-v4-submission-submissions.context.js.map +1 -1
- package/build/es/src/forms-v4-submission-submissions.http.d.ts +2 -2
- package/build/es/src/forms-v4-submission-submissions.http.js +52 -52
- 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 +20 -10
- package/build/es/src/forms-v4-submission-submissions.public.js +5 -6
- package/build/es/src/forms-v4-submission-submissions.public.js.map +1 -1
- package/build/es/src/forms-v4-submission-submissions.types.d.ts +1214 -305
- 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 +1303 -331
- 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 -5
- package/build/internal/cjs/src/forms-v4-submission-submissions.context.js +4 -5
- 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 +2 -2
- package/build/internal/cjs/src/forms-v4-submission-submissions.http.js +54 -54
- 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 -10
- package/build/internal/cjs/src/forms-v4-submission-submissions.public.js +7 -8
- 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 +1214 -305
- 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 +1283 -332
- 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 -5
- package/build/internal/es/src/forms-v4-submission-submissions.context.js +3 -4
- 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 +2 -2
- package/build/internal/es/src/forms-v4-submission-submissions.http.js +52 -52
- 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 -10
- package/build/internal/es/src/forms-v4-submission-submissions.public.js +5 -6
- 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 +1214 -305
- 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 +1283 -332
- 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 {
|
|
@@ -1457,6 +1691,25 @@ export interface ImageData {
|
|
|
1457
1691
|
caption?: string | null;
|
|
1458
1692
|
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
|
1459
1693
|
disableDownload?: boolean | null;
|
|
1694
|
+
/** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
|
|
1695
|
+
decorative?: boolean | null;
|
|
1696
|
+
/** Styling for the image. */
|
|
1697
|
+
styles?: ImageDataStyles;
|
|
1698
|
+
}
|
|
1699
|
+
export interface StylesBorder {
|
|
1700
|
+
/** Border width in pixels. */
|
|
1701
|
+
width?: number | null;
|
|
1702
|
+
/**
|
|
1703
|
+
* Border color as a hexadecimal value.
|
|
1704
|
+
* @format COLOR_HEX
|
|
1705
|
+
*/
|
|
1706
|
+
color?: string | null;
|
|
1707
|
+
/** Border radius in pixels. */
|
|
1708
|
+
radius?: number | null;
|
|
1709
|
+
}
|
|
1710
|
+
export interface ImageDataStyles {
|
|
1711
|
+
/** Border attributes. */
|
|
1712
|
+
border?: StylesBorder;
|
|
1460
1713
|
}
|
|
1461
1714
|
export interface LinkPreviewData {
|
|
1462
1715
|
/** Styling for the link preview's container. */
|
|
@@ -1603,13 +1856,22 @@ export declare enum BackgroundType {
|
|
|
1603
1856
|
export interface Gradient {
|
|
1604
1857
|
/** The gradient angle in degrees. */
|
|
1605
1858
|
angle?: number | null;
|
|
1606
|
-
/**
|
|
1859
|
+
/**
|
|
1860
|
+
* The start color as a hexademical value.
|
|
1861
|
+
* @format COLOR_HEX
|
|
1862
|
+
*/
|
|
1607
1863
|
startColor?: string | null;
|
|
1608
|
-
/**
|
|
1864
|
+
/**
|
|
1865
|
+
* The end color as a hexademical value.
|
|
1866
|
+
* @format COLOR_HEX
|
|
1867
|
+
*/
|
|
1609
1868
|
lastColor?: string | null;
|
|
1610
1869
|
}
|
|
1611
1870
|
export interface Background extends BackgroundBackgroundOneOf {
|
|
1612
|
-
/**
|
|
1871
|
+
/**
|
|
1872
|
+
* The background color as a hexademical value.
|
|
1873
|
+
* @format COLOR_HEX
|
|
1874
|
+
*/
|
|
1613
1875
|
color?: string | null;
|
|
1614
1876
|
/** An image to use for the background. */
|
|
1615
1877
|
image?: Media;
|
|
@@ -1620,7 +1882,10 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1620
1882
|
}
|
|
1621
1883
|
/** @oneof */
|
|
1622
1884
|
export interface BackgroundBackgroundOneOf {
|
|
1623
|
-
/**
|
|
1885
|
+
/**
|
|
1886
|
+
* The background color as a hexademical value.
|
|
1887
|
+
* @format COLOR_HEX
|
|
1888
|
+
*/
|
|
1624
1889
|
color?: string | null;
|
|
1625
1890
|
/** An image to use for the background. */
|
|
1626
1891
|
image?: Media;
|
|
@@ -1932,17 +2197,32 @@ export declare enum VerticalAlignment {
|
|
|
1932
2197
|
export interface CellStyle {
|
|
1933
2198
|
/** Vertical alignment for the cell's text. */
|
|
1934
2199
|
verticalAlignment?: VerticalAlignment;
|
|
1935
|
-
/**
|
|
2200
|
+
/**
|
|
2201
|
+
* Cell background color as a hexadecimal value.
|
|
2202
|
+
* @format COLOR_HEX
|
|
2203
|
+
*/
|
|
1936
2204
|
backgroundColor?: string | null;
|
|
1937
2205
|
}
|
|
1938
2206
|
export interface BorderColors {
|
|
1939
|
-
/**
|
|
2207
|
+
/**
|
|
2208
|
+
* Left border color as a hexadecimal value.
|
|
2209
|
+
* @format COLOR_HEX
|
|
2210
|
+
*/
|
|
1940
2211
|
left?: string | null;
|
|
1941
|
-
/**
|
|
2212
|
+
/**
|
|
2213
|
+
* Right border color as a hexadecimal value.
|
|
2214
|
+
* @format COLOR_HEX
|
|
2215
|
+
*/
|
|
1942
2216
|
right?: string | null;
|
|
1943
|
-
/**
|
|
2217
|
+
/**
|
|
2218
|
+
* Top border color as a hexadecimal value.
|
|
2219
|
+
* @format COLOR_HEX
|
|
2220
|
+
*/
|
|
1944
2221
|
top?: string | null;
|
|
1945
|
-
/**
|
|
2222
|
+
/**
|
|
2223
|
+
* Bottom border color as a hexadecimal value.
|
|
2224
|
+
* @format COLOR_HEX
|
|
2225
|
+
*/
|
|
1946
2226
|
bottom?: string | null;
|
|
1947
2227
|
}
|
|
1948
2228
|
/**
|
|
@@ -2051,13 +2331,17 @@ export interface TextNodeStyle {
|
|
|
2051
2331
|
lineHeight?: string | null;
|
|
2052
2332
|
}
|
|
2053
2333
|
export interface RadioGroup {
|
|
2054
|
-
/**
|
|
2334
|
+
/**
|
|
2335
|
+
* Label of the field
|
|
2336
|
+
* @maxLength 350
|
|
2337
|
+
*/
|
|
2055
2338
|
label?: string | null;
|
|
2056
2339
|
/** Description of the field */
|
|
2057
2340
|
description?: RichContent;
|
|
2058
2341
|
/**
|
|
2059
2342
|
* Flag identifying to show option allowing input custom value
|
|
2060
2343
|
* List of options to select from
|
|
2344
|
+
* @maxSize 400
|
|
2061
2345
|
*/
|
|
2062
2346
|
options?: RadioGroupOption[];
|
|
2063
2347
|
/**
|
|
@@ -2074,19 +2358,35 @@ export interface RadioGroup {
|
|
|
2074
2358
|
numberOfColumns?: NumberOfColumns;
|
|
2075
2359
|
}
|
|
2076
2360
|
export interface RadioGroupOption {
|
|
2077
|
-
/**
|
|
2361
|
+
/**
|
|
2362
|
+
* Selectable option label
|
|
2363
|
+
* @maxLength 400
|
|
2364
|
+
*/
|
|
2078
2365
|
label?: string | null;
|
|
2079
|
-
/**
|
|
2366
|
+
/**
|
|
2367
|
+
* Selectable option value, which is saved to DB.
|
|
2368
|
+
* @maxLength 20000
|
|
2369
|
+
*/
|
|
2080
2370
|
value?: string | null;
|
|
2081
2371
|
/** Flag identifying that option should be selected by default */
|
|
2082
2372
|
default?: boolean;
|
|
2083
|
-
/**
|
|
2373
|
+
/**
|
|
2374
|
+
* Option id. Used as binding for translations
|
|
2375
|
+
* @format GUID
|
|
2376
|
+
* @immutable
|
|
2377
|
+
*/
|
|
2084
2378
|
id?: string;
|
|
2085
2379
|
}
|
|
2086
2380
|
export interface RadioGroupCustomOption {
|
|
2087
|
-
/**
|
|
2381
|
+
/**
|
|
2382
|
+
* Label of custom option input
|
|
2383
|
+
* @maxLength 350
|
|
2384
|
+
*/
|
|
2088
2385
|
label?: string | null;
|
|
2089
|
-
/**
|
|
2386
|
+
/**
|
|
2387
|
+
* Placeholder of custom option input
|
|
2388
|
+
* @maxLength 100
|
|
2389
|
+
*/
|
|
2090
2390
|
placeholder?: string | null;
|
|
2091
2391
|
}
|
|
2092
2392
|
export declare enum NumberOfColumns {
|
|
@@ -2102,11 +2402,17 @@ export declare enum NumberOfColumns {
|
|
|
2102
2402
|
THREE = "THREE"
|
|
2103
2403
|
}
|
|
2104
2404
|
export interface Dropdown {
|
|
2105
|
-
/**
|
|
2405
|
+
/**
|
|
2406
|
+
* Label of the field
|
|
2407
|
+
* @maxLength 350
|
|
2408
|
+
*/
|
|
2106
2409
|
label?: string | null;
|
|
2107
2410
|
/** Description of the field */
|
|
2108
2411
|
description?: RichContent;
|
|
2109
|
-
/**
|
|
2412
|
+
/**
|
|
2413
|
+
* List of options to select from
|
|
2414
|
+
* @maxSize 400
|
|
2415
|
+
*/
|
|
2110
2416
|
options?: DropdownOption[];
|
|
2111
2417
|
/**
|
|
2112
2418
|
* Flag identifying to hide or not label
|
|
@@ -2115,27 +2421,49 @@ export interface Dropdown {
|
|
|
2115
2421
|
showLabel?: boolean | null;
|
|
2116
2422
|
/** Option which can be specified by UoU, enabled when this object is specified. */
|
|
2117
2423
|
customOption?: DropdownCustomOption;
|
|
2118
|
-
/**
|
|
2424
|
+
/**
|
|
2425
|
+
* Placeholder of dropdown input
|
|
2426
|
+
* @maxLength 100
|
|
2427
|
+
*/
|
|
2119
2428
|
placeholder?: string | null;
|
|
2120
2429
|
}
|
|
2121
2430
|
export interface DropdownOption {
|
|
2122
|
-
/**
|
|
2431
|
+
/**
|
|
2432
|
+
* Selectable option label
|
|
2433
|
+
* @maxLength 400
|
|
2434
|
+
*/
|
|
2123
2435
|
label?: string | null;
|
|
2124
|
-
/**
|
|
2436
|
+
/**
|
|
2437
|
+
* Selectable option value, which is saved to DB.
|
|
2438
|
+
* @maxLength 20000
|
|
2439
|
+
*/
|
|
2125
2440
|
value?: string | null;
|
|
2126
2441
|
/** Flag identifying that option should be selected by default */
|
|
2127
2442
|
default?: boolean;
|
|
2128
|
-
/**
|
|
2443
|
+
/**
|
|
2444
|
+
* Option id. Used as binding for translations
|
|
2445
|
+
* @format GUID
|
|
2446
|
+
* @immutable
|
|
2447
|
+
*/
|
|
2129
2448
|
id?: string;
|
|
2130
2449
|
}
|
|
2131
2450
|
export interface DropdownCustomOption {
|
|
2132
|
-
/**
|
|
2451
|
+
/**
|
|
2452
|
+
* Label of custom option input
|
|
2453
|
+
* @maxLength 350
|
|
2454
|
+
*/
|
|
2133
2455
|
label?: string | null;
|
|
2134
|
-
/**
|
|
2456
|
+
/**
|
|
2457
|
+
* Placeholder of custom option input
|
|
2458
|
+
* @maxLength 100
|
|
2459
|
+
*/
|
|
2135
2460
|
placeholder?: string | null;
|
|
2136
2461
|
}
|
|
2137
2462
|
export interface DateTimeInput {
|
|
2138
|
-
/**
|
|
2463
|
+
/**
|
|
2464
|
+
* Label of the field. Displayed text for the date/time input.
|
|
2465
|
+
* @maxLength 350
|
|
2466
|
+
*/
|
|
2139
2467
|
label?: string | null;
|
|
2140
2468
|
/** Description of the field. Additional information about the date/time input. */
|
|
2141
2469
|
description?: RichContent;
|
|
@@ -2154,22 +2482,35 @@ export interface DateTimeInput {
|
|
|
2154
2482
|
* Default: false.
|
|
2155
2483
|
*/
|
|
2156
2484
|
use24HourFormat?: boolean;
|
|
2157
|
-
/**
|
|
2485
|
+
/**
|
|
2486
|
+
* Default value for the date time input.
|
|
2487
|
+
* @format LOCAL_DATE_TIME
|
|
2488
|
+
*/
|
|
2158
2489
|
default?: string | null;
|
|
2159
2490
|
}
|
|
2160
2491
|
export interface PhoneInput {
|
|
2161
|
-
/**
|
|
2492
|
+
/**
|
|
2493
|
+
* Label of the field
|
|
2494
|
+
* @maxLength 350
|
|
2495
|
+
*/
|
|
2162
2496
|
label?: string | null;
|
|
2163
2497
|
/** Description of the field */
|
|
2164
2498
|
description?: RichContent;
|
|
2165
|
-
/**
|
|
2499
|
+
/**
|
|
2500
|
+
* Placeholder for the value input
|
|
2501
|
+
* @maxLength 100
|
|
2502
|
+
*/
|
|
2166
2503
|
placeholder?: string | null;
|
|
2167
2504
|
/**
|
|
2168
2505
|
* Flag identifying to show label or not
|
|
2169
2506
|
* Default: true
|
|
2170
2507
|
*/
|
|
2171
2508
|
showLabel?: boolean | null;
|
|
2172
|
-
/**
|
|
2509
|
+
/**
|
|
2510
|
+
* Default value of the country code
|
|
2511
|
+
* @minLength 1
|
|
2512
|
+
* @maxLength 5
|
|
2513
|
+
*/
|
|
2173
2514
|
defaultCountryCode?: string | null;
|
|
2174
2515
|
/**
|
|
2175
2516
|
* Flag identifying to show country flag or not
|
|
@@ -2178,7 +2519,10 @@ export interface PhoneInput {
|
|
|
2178
2519
|
showCountryFlag?: boolean;
|
|
2179
2520
|
}
|
|
2180
2521
|
export interface DateInput {
|
|
2181
|
-
/**
|
|
2522
|
+
/**
|
|
2523
|
+
* Label of the field. Displayed text for the date/time input.
|
|
2524
|
+
* @maxLength 350
|
|
2525
|
+
*/
|
|
2182
2526
|
label?: string | null;
|
|
2183
2527
|
/** Description of the field. Additional information about the date/time input. */
|
|
2184
2528
|
description?: RichContent;
|
|
@@ -2192,11 +2536,17 @@ export interface DateInput {
|
|
|
2192
2536
|
* Default: true
|
|
2193
2537
|
*/
|
|
2194
2538
|
showPlaceholder?: boolean | null;
|
|
2195
|
-
/**
|
|
2539
|
+
/**
|
|
2540
|
+
* Default value for the date input.
|
|
2541
|
+
* @format LOCAL_DATE
|
|
2542
|
+
*/
|
|
2196
2543
|
default?: string | null;
|
|
2197
2544
|
}
|
|
2198
2545
|
export interface TimeInput {
|
|
2199
|
-
/**
|
|
2546
|
+
/**
|
|
2547
|
+
* Label of the field. Displayed text for the date/time input.
|
|
2548
|
+
* @maxLength 350
|
|
2549
|
+
*/
|
|
2200
2550
|
label?: string | null;
|
|
2201
2551
|
/** Description of the field. Additional information about the date/time input. */
|
|
2202
2552
|
description?: RichContent;
|
|
@@ -2215,11 +2565,17 @@ export interface TimeInput {
|
|
|
2215
2565
|
* Default: false.
|
|
2216
2566
|
*/
|
|
2217
2567
|
use24HourFormat?: boolean;
|
|
2218
|
-
/**
|
|
2568
|
+
/**
|
|
2569
|
+
* Default value for the time input.
|
|
2570
|
+
* @format LOCAL_TIME
|
|
2571
|
+
*/
|
|
2219
2572
|
default?: string | null;
|
|
2220
2573
|
}
|
|
2221
2574
|
export interface DatePicker {
|
|
2222
|
-
/**
|
|
2575
|
+
/**
|
|
2576
|
+
* Label of the field. Displayed text for the date/time input.
|
|
2577
|
+
* @maxLength 350
|
|
2578
|
+
*/
|
|
2223
2579
|
label?: string | null;
|
|
2224
2580
|
/** Description of the field. Additional information about the date/time input. */
|
|
2225
2581
|
description?: RichContent;
|
|
@@ -2228,11 +2584,17 @@ export interface DatePicker {
|
|
|
2228
2584
|
* Default: true
|
|
2229
2585
|
*/
|
|
2230
2586
|
showLabel?: boolean | null;
|
|
2231
|
-
/**
|
|
2587
|
+
/**
|
|
2588
|
+
* Placeholder of date picker input
|
|
2589
|
+
* @maxLength 100
|
|
2590
|
+
*/
|
|
2232
2591
|
placeholder?: string | null;
|
|
2233
2592
|
/** First day of the week displayed on date picker. */
|
|
2234
2593
|
firstDayOfWeek?: FirstDayOfWeek;
|
|
2235
|
-
/**
|
|
2594
|
+
/**
|
|
2595
|
+
* Default value for the date picker.
|
|
2596
|
+
* @format LOCAL_DATE
|
|
2597
|
+
*/
|
|
2236
2598
|
default?: string | null;
|
|
2237
2599
|
}
|
|
2238
2600
|
export declare enum FirstDayOfWeek {
|
|
@@ -2250,11 +2612,17 @@ export interface InputFieldNumberType {
|
|
|
2250
2612
|
multipleOf?: number | null;
|
|
2251
2613
|
/** Custom error message when validation fails. */
|
|
2252
2614
|
errorMessages?: InputFieldNumberErrorMessages;
|
|
2253
|
-
/**
|
|
2615
|
+
/**
|
|
2616
|
+
* List of allowed values.
|
|
2617
|
+
* @maxSize 500
|
|
2618
|
+
*/
|
|
2254
2619
|
enum?: number[] | null;
|
|
2255
2620
|
}
|
|
2256
2621
|
export interface InputFieldNumberErrorMessages {
|
|
2257
|
-
/**
|
|
2622
|
+
/**
|
|
2623
|
+
* Default error message on invalid validation.
|
|
2624
|
+
* @maxLength 200
|
|
2625
|
+
*/
|
|
2258
2626
|
default?: string | null;
|
|
2259
2627
|
}
|
|
2260
2628
|
export declare enum NumberComponentType {
|
|
@@ -2263,11 +2631,17 @@ export declare enum NumberComponentType {
|
|
|
2263
2631
|
RATING_INPUT = "RATING_INPUT"
|
|
2264
2632
|
}
|
|
2265
2633
|
export interface NumberInput {
|
|
2266
|
-
/**
|
|
2634
|
+
/**
|
|
2635
|
+
* Label of the field
|
|
2636
|
+
* @maxLength 350
|
|
2637
|
+
*/
|
|
2267
2638
|
label?: string | null;
|
|
2268
2639
|
/** Description of the field */
|
|
2269
2640
|
description?: RichContent;
|
|
2270
|
-
/**
|
|
2641
|
+
/**
|
|
2642
|
+
* Placeholder for the value input
|
|
2643
|
+
* @maxLength 100
|
|
2644
|
+
*/
|
|
2271
2645
|
placeholder?: string | null;
|
|
2272
2646
|
/**
|
|
2273
2647
|
* Flag identifying to hide or not label
|
|
@@ -2278,7 +2652,10 @@ export interface NumberInput {
|
|
|
2278
2652
|
default?: number | null;
|
|
2279
2653
|
}
|
|
2280
2654
|
export interface RatingInput {
|
|
2281
|
-
/**
|
|
2655
|
+
/**
|
|
2656
|
+
* Label of the field
|
|
2657
|
+
* @maxLength 350
|
|
2658
|
+
*/
|
|
2282
2659
|
label?: string | null;
|
|
2283
2660
|
/** Description of the field */
|
|
2284
2661
|
description?: RichContent;
|
|
@@ -2287,17 +2664,27 @@ export interface RatingInput {
|
|
|
2287
2664
|
* Default: true
|
|
2288
2665
|
*/
|
|
2289
2666
|
showLabel?: boolean | null;
|
|
2290
|
-
/**
|
|
2667
|
+
/**
|
|
2668
|
+
* Default rating
|
|
2669
|
+
* @min 1
|
|
2670
|
+
* @max 5
|
|
2671
|
+
*/
|
|
2291
2672
|
defaultValue?: number | null;
|
|
2292
2673
|
}
|
|
2293
2674
|
export interface InputFieldBooleanType {
|
|
2294
2675
|
/** Custom error message when validation fails. */
|
|
2295
2676
|
errorMessages?: InputFieldBooleanErrorMessages;
|
|
2296
|
-
/**
|
|
2677
|
+
/**
|
|
2678
|
+
* List of allowed values.
|
|
2679
|
+
* @maxSize 2
|
|
2680
|
+
*/
|
|
2297
2681
|
enum?: boolean[];
|
|
2298
2682
|
}
|
|
2299
2683
|
export interface InputFieldBooleanErrorMessages {
|
|
2300
|
-
/**
|
|
2684
|
+
/**
|
|
2685
|
+
* Default error message on invalid validation.
|
|
2686
|
+
* @maxLength 200
|
|
2687
|
+
*/
|
|
2301
2688
|
default?: string | null;
|
|
2302
2689
|
}
|
|
2303
2690
|
export declare enum BooleanComponentType {
|
|
@@ -2314,9 +2701,15 @@ export interface Checkbox {
|
|
|
2314
2701
|
checked?: boolean;
|
|
2315
2702
|
}
|
|
2316
2703
|
export interface InputFieldArrayType {
|
|
2317
|
-
/**
|
|
2704
|
+
/**
|
|
2705
|
+
* Maximum amount of array elements.
|
|
2706
|
+
* @max 1000
|
|
2707
|
+
*/
|
|
2318
2708
|
maxItems?: number | null;
|
|
2319
|
-
/**
|
|
2709
|
+
/**
|
|
2710
|
+
* Minimum amount of array elements.
|
|
2711
|
+
* @max 1000
|
|
2712
|
+
*/
|
|
2320
2713
|
minItems?: number | null;
|
|
2321
2714
|
/** Type of items allowed in array. */
|
|
2322
2715
|
items?: ArrayTypeArrayItems;
|
|
@@ -2340,7 +2733,10 @@ export interface InputFieldIntegerType {
|
|
|
2340
2733
|
multipleOf?: number | null;
|
|
2341
2734
|
/** Custom error message when validation fails. */
|
|
2342
2735
|
errorMessages?: InputFieldNumberErrorMessages;
|
|
2343
|
-
/**
|
|
2736
|
+
/**
|
|
2737
|
+
* List of allowed values.
|
|
2738
|
+
* @maxSize 500
|
|
2739
|
+
*/
|
|
2344
2740
|
enum?: number[] | null;
|
|
2345
2741
|
}
|
|
2346
2742
|
export interface InputFieldObjectType {
|
|
@@ -2390,7 +2786,10 @@ export interface ObjectTypePropertiesTypePropertiesTypeOptionsOneOf {
|
|
|
2390
2786
|
arrayOptions?: InputFieldArrayType;
|
|
2391
2787
|
}
|
|
2392
2788
|
export interface InputFieldObjectErrorMessages {
|
|
2393
|
-
/**
|
|
2789
|
+
/**
|
|
2790
|
+
* Default error message on invalid validation.
|
|
2791
|
+
* @maxLength 200
|
|
2792
|
+
*/
|
|
2394
2793
|
default?: string | null;
|
|
2395
2794
|
}
|
|
2396
2795
|
export interface ArrayTypeArrayItems extends ArrayTypeArrayItemsItemTypeOptionsOneOf {
|
|
@@ -2424,7 +2823,10 @@ export interface ArrayTypeArrayItemsItemTypeOptionsOneOf {
|
|
|
2424
2823
|
objectOptions?: InputFieldObjectType;
|
|
2425
2824
|
}
|
|
2426
2825
|
export interface InputFieldArrayErrorMessages {
|
|
2427
|
-
/**
|
|
2826
|
+
/**
|
|
2827
|
+
* Default error message on invalid validation.
|
|
2828
|
+
* @maxLength 200
|
|
2829
|
+
*/
|
|
2428
2830
|
default?: string | null;
|
|
2429
2831
|
}
|
|
2430
2832
|
export declare enum ComponentType {
|
|
@@ -2433,11 +2835,17 @@ export declare enum ComponentType {
|
|
|
2433
2835
|
TAGS = "TAGS"
|
|
2434
2836
|
}
|
|
2435
2837
|
export interface CheckboxGroup {
|
|
2436
|
-
/**
|
|
2838
|
+
/**
|
|
2839
|
+
* Label of the field
|
|
2840
|
+
* @maxLength 350
|
|
2841
|
+
*/
|
|
2437
2842
|
label?: string | null;
|
|
2438
2843
|
/** Description of the field */
|
|
2439
2844
|
description?: RichContent;
|
|
2440
|
-
/**
|
|
2845
|
+
/**
|
|
2846
|
+
* List of options to select from
|
|
2847
|
+
* @maxSize 400
|
|
2848
|
+
*/
|
|
2441
2849
|
options?: Option[];
|
|
2442
2850
|
/**
|
|
2443
2851
|
* Flag identifying to hide or not label
|
|
@@ -2462,9 +2870,15 @@ export interface MediaItemMediaOneOf {
|
|
|
2462
2870
|
image?: Image;
|
|
2463
2871
|
}
|
|
2464
2872
|
export interface Image {
|
|
2465
|
-
/**
|
|
2873
|
+
/**
|
|
2874
|
+
* WixMedia image ID.
|
|
2875
|
+
* @maxLength 100
|
|
2876
|
+
*/
|
|
2466
2877
|
id?: string;
|
|
2467
|
-
/**
|
|
2878
|
+
/**
|
|
2879
|
+
* Image URL.
|
|
2880
|
+
* @maxLength 2000
|
|
2881
|
+
*/
|
|
2468
2882
|
url?: string;
|
|
2469
2883
|
/**
|
|
2470
2884
|
* Original image height.
|
|
@@ -2476,38 +2890,61 @@ export interface Image {
|
|
|
2476
2890
|
* @readonly
|
|
2477
2891
|
*/
|
|
2478
2892
|
width?: number;
|
|
2479
|
-
/**
|
|
2893
|
+
/**
|
|
2894
|
+
* Image alt text.
|
|
2895
|
+
* @maxLength 1000
|
|
2896
|
+
*/
|
|
2480
2897
|
altText?: string | null;
|
|
2481
2898
|
/**
|
|
2482
2899
|
* Image filename.
|
|
2483
2900
|
* @readonly
|
|
2901
|
+
* @maxLength 1000
|
|
2484
2902
|
*/
|
|
2485
2903
|
filename?: string | null;
|
|
2486
2904
|
}
|
|
2487
2905
|
export interface Option {
|
|
2488
|
-
/**
|
|
2906
|
+
/**
|
|
2907
|
+
* Selectable option label
|
|
2908
|
+
* @maxLength 400
|
|
2909
|
+
*/
|
|
2489
2910
|
label?: string | null;
|
|
2490
2911
|
/** Selectable option value, which is saved to DB. */
|
|
2491
2912
|
value?: any;
|
|
2492
2913
|
/** Flag identifying that option should be selected by default */
|
|
2493
2914
|
default?: boolean;
|
|
2494
|
-
/**
|
|
2915
|
+
/**
|
|
2916
|
+
* Option id. Used as binding for translations
|
|
2917
|
+
* @format GUID
|
|
2918
|
+
* @immutable
|
|
2919
|
+
*/
|
|
2495
2920
|
id?: string;
|
|
2496
2921
|
/** Media item. Media, associated with option, like image. */
|
|
2497
2922
|
media?: MediaItem;
|
|
2498
2923
|
}
|
|
2499
2924
|
export interface CustomOption {
|
|
2500
|
-
/**
|
|
2925
|
+
/**
|
|
2926
|
+
* Label of custom option input
|
|
2927
|
+
* @maxLength 350
|
|
2928
|
+
*/
|
|
2501
2929
|
label?: string | null;
|
|
2502
|
-
/**
|
|
2930
|
+
/**
|
|
2931
|
+
* Placeholder of custom option input
|
|
2932
|
+
* @maxLength 100
|
|
2933
|
+
*/
|
|
2503
2934
|
placeholder?: string | null;
|
|
2504
2935
|
}
|
|
2505
2936
|
export interface Tags {
|
|
2506
|
-
/**
|
|
2937
|
+
/**
|
|
2938
|
+
* Label of the field
|
|
2939
|
+
* @maxLength 350
|
|
2940
|
+
*/
|
|
2507
2941
|
label?: string | null;
|
|
2508
2942
|
/** Description of the field */
|
|
2509
2943
|
description?: RichContent;
|
|
2510
|
-
/**
|
|
2944
|
+
/**
|
|
2945
|
+
* List of options to select from
|
|
2946
|
+
* @maxSize 400
|
|
2947
|
+
*/
|
|
2511
2948
|
options?: TagsOption[];
|
|
2512
2949
|
/**
|
|
2513
2950
|
* Flag identifying to hide or not label
|
|
@@ -2523,21 +2960,34 @@ export interface Tags {
|
|
|
2523
2960
|
numberOfColumns?: NumberOfColumns;
|
|
2524
2961
|
}
|
|
2525
2962
|
export interface TagsOption {
|
|
2526
|
-
/**
|
|
2963
|
+
/**
|
|
2964
|
+
* Selectable option label
|
|
2965
|
+
* @maxLength 400
|
|
2966
|
+
*/
|
|
2527
2967
|
label?: string | null;
|
|
2528
2968
|
/** Selectable option value, which is saved to DB. */
|
|
2529
2969
|
value?: any;
|
|
2530
2970
|
/** Flag identifying that option should be selected by default */
|
|
2531
2971
|
default?: boolean;
|
|
2532
|
-
/**
|
|
2972
|
+
/**
|
|
2973
|
+
* Option id. Used as binding for translations
|
|
2974
|
+
* @format GUID
|
|
2975
|
+
* @immutable
|
|
2976
|
+
*/
|
|
2533
2977
|
id?: string;
|
|
2534
2978
|
/** Media item. Media, associated with option, like image. */
|
|
2535
2979
|
media?: MediaItem;
|
|
2536
2980
|
}
|
|
2537
2981
|
export interface CommonCustomOption {
|
|
2538
|
-
/**
|
|
2982
|
+
/**
|
|
2983
|
+
* Label of custom option input
|
|
2984
|
+
* @maxLength 350
|
|
2985
|
+
*/
|
|
2539
2986
|
label?: string | null;
|
|
2540
|
-
/**
|
|
2987
|
+
/**
|
|
2988
|
+
* Placeholder of custom option input
|
|
2989
|
+
* @maxLength 100
|
|
2990
|
+
*/
|
|
2541
2991
|
placeholder?: string | null;
|
|
2542
2992
|
}
|
|
2543
2993
|
export declare enum WixFileComponentType {
|
|
@@ -2546,7 +2996,10 @@ export declare enum WixFileComponentType {
|
|
|
2546
2996
|
SIGNATURE = "SIGNATURE"
|
|
2547
2997
|
}
|
|
2548
2998
|
export interface FileUpload {
|
|
2549
|
-
/**
|
|
2999
|
+
/**
|
|
3000
|
+
* Selectable option label
|
|
3001
|
+
* @maxLength 350
|
|
3002
|
+
*/
|
|
2550
3003
|
label?: string | null;
|
|
2551
3004
|
/** Description of the field */
|
|
2552
3005
|
description?: RichContent;
|
|
@@ -2555,13 +3008,26 @@ export interface FileUpload {
|
|
|
2555
3008
|
* Default: true
|
|
2556
3009
|
*/
|
|
2557
3010
|
showLabel?: boolean | null;
|
|
2558
|
-
/**
|
|
3011
|
+
/**
|
|
3012
|
+
* Text on upload button
|
|
3013
|
+
* @maxLength 500
|
|
3014
|
+
*/
|
|
2559
3015
|
buttonText?: string | null;
|
|
2560
|
-
/**
|
|
3016
|
+
/**
|
|
3017
|
+
* Amount of files allowed to upload
|
|
3018
|
+
* @min 1
|
|
3019
|
+
* @max 30
|
|
3020
|
+
*/
|
|
2561
3021
|
fileLimit?: number;
|
|
2562
|
-
/**
|
|
3022
|
+
/**
|
|
3023
|
+
* Supported file formats for upload
|
|
3024
|
+
* @maxSize 5
|
|
3025
|
+
*/
|
|
2563
3026
|
uploadFileFormats?: UploadFileFormat[];
|
|
2564
|
-
/**
|
|
3027
|
+
/**
|
|
3028
|
+
* Custom text which appears when file is uploaded, if missing file name will be shown
|
|
3029
|
+
* @maxLength 255
|
|
3030
|
+
*/
|
|
2565
3031
|
explanationText?: string | null;
|
|
2566
3032
|
}
|
|
2567
3033
|
export declare enum UploadFileFormat {
|
|
@@ -2579,7 +3045,10 @@ export declare enum UploadFileFormat {
|
|
|
2579
3045
|
ARCHIVE = "ARCHIVE"
|
|
2580
3046
|
}
|
|
2581
3047
|
export interface Signature {
|
|
2582
|
-
/**
|
|
3048
|
+
/**
|
|
3049
|
+
* Selectable option label
|
|
3050
|
+
* @maxLength 350
|
|
3051
|
+
*/
|
|
2583
3052
|
label?: string | null;
|
|
2584
3053
|
/**
|
|
2585
3054
|
* Flag identifying to hide label or not
|
|
@@ -2599,11 +3068,17 @@ export declare enum PaymentComponentType {
|
|
|
2599
3068
|
FIXED_PAYMENT = "FIXED_PAYMENT"
|
|
2600
3069
|
}
|
|
2601
3070
|
export interface ProductCheckboxGroup {
|
|
2602
|
-
/**
|
|
3071
|
+
/**
|
|
3072
|
+
* Label of the field.
|
|
3073
|
+
* @maxLength 350
|
|
3074
|
+
*/
|
|
2603
3075
|
label?: string | null;
|
|
2604
3076
|
/** Description of the field. */
|
|
2605
3077
|
description?: RichContent;
|
|
2606
|
-
/**
|
|
3078
|
+
/**
|
|
3079
|
+
* List of options to select from.
|
|
3080
|
+
* @maxSize 400
|
|
3081
|
+
*/
|
|
2607
3082
|
options?: ProductCheckboxGroupOption[];
|
|
2608
3083
|
/**
|
|
2609
3084
|
* Flag identifying to hide or not label
|
|
@@ -2617,11 +3092,18 @@ export interface ProductCheckboxGroup {
|
|
|
2617
3092
|
imageFit?: ImageFit;
|
|
2618
3093
|
}
|
|
2619
3094
|
export interface ProductCheckboxGroupOption {
|
|
2620
|
-
/**
|
|
3095
|
+
/**
|
|
3096
|
+
* Selectable option label.
|
|
3097
|
+
* @maxLength 400
|
|
3098
|
+
*/
|
|
2621
3099
|
label?: string | null;
|
|
2622
3100
|
/** Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list. */
|
|
2623
3101
|
value?: any;
|
|
2624
|
-
/**
|
|
3102
|
+
/**
|
|
3103
|
+
* Option id. Used as binding for translations.
|
|
3104
|
+
* @format GUID
|
|
3105
|
+
* @immutable
|
|
3106
|
+
*/
|
|
2625
3107
|
id?: string;
|
|
2626
3108
|
/** Media item. Media, associated with option, like image. */
|
|
2627
3109
|
media?: MediaItem;
|
|
@@ -2636,11 +3118,17 @@ export declare enum ImageFit {
|
|
|
2636
3118
|
CONTAIN = "CONTAIN"
|
|
2637
3119
|
}
|
|
2638
3120
|
export interface DonationInput {
|
|
2639
|
-
/**
|
|
3121
|
+
/**
|
|
3122
|
+
* Label of the field.
|
|
3123
|
+
* @maxLength 350
|
|
3124
|
+
*/
|
|
2640
3125
|
label?: string | null;
|
|
2641
3126
|
/** Description of the field. */
|
|
2642
3127
|
description?: RichContent;
|
|
2643
|
-
/**
|
|
3128
|
+
/**
|
|
3129
|
+
* List of options to select from.
|
|
3130
|
+
* @maxSize 400
|
|
3131
|
+
*/
|
|
2644
3132
|
options?: DonationInputOption[];
|
|
2645
3133
|
/** Option which can be specified by UoU, enabled when this object is specified. */
|
|
2646
3134
|
customOption?: CommonCustomOption;
|
|
@@ -2656,13 +3144,19 @@ export interface DonationInput {
|
|
|
2656
3144
|
showLabel?: boolean | null;
|
|
2657
3145
|
}
|
|
2658
3146
|
export interface DonationInputOption {
|
|
2659
|
-
/**
|
|
3147
|
+
/**
|
|
3148
|
+
* Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list.
|
|
3149
|
+
* @format GUID
|
|
3150
|
+
*/
|
|
2660
3151
|
value?: string;
|
|
2661
3152
|
/** Flag identifying that option should be selected by default */
|
|
2662
3153
|
default?: boolean;
|
|
2663
3154
|
}
|
|
2664
3155
|
export interface PaymentInput {
|
|
2665
|
-
/**
|
|
3156
|
+
/**
|
|
3157
|
+
* Label of the field.
|
|
3158
|
+
* @maxLength 350
|
|
3159
|
+
*/
|
|
2666
3160
|
label?: string | null;
|
|
2667
3161
|
/** Description of the field. */
|
|
2668
3162
|
description?: RichContent;
|
|
@@ -2671,13 +3165,19 @@ export interface PaymentInput {
|
|
|
2671
3165
|
* Default: true
|
|
2672
3166
|
*/
|
|
2673
3167
|
showLabel?: boolean | null;
|
|
2674
|
-
/**
|
|
3168
|
+
/**
|
|
3169
|
+
* Placeholder of custom option input
|
|
3170
|
+
* @maxLength 100
|
|
3171
|
+
*/
|
|
2675
3172
|
placeholder?: string | null;
|
|
2676
3173
|
/** Default value for the payment input */
|
|
2677
3174
|
default?: number | null;
|
|
2678
3175
|
}
|
|
2679
3176
|
export interface FixedPayment {
|
|
2680
|
-
/**
|
|
3177
|
+
/**
|
|
3178
|
+
* Label of the field.
|
|
3179
|
+
* @maxLength 350
|
|
3180
|
+
*/
|
|
2681
3181
|
label?: string | null;
|
|
2682
3182
|
/** Description of the field. */
|
|
2683
3183
|
description?: RichContent;
|
|
@@ -2698,15 +3198,30 @@ export interface Appointment extends AppointmentFormatInfoOneOf {
|
|
|
2698
3198
|
videoConferenceOptions?: VideoConferenceOptions;
|
|
2699
3199
|
/** Phone options for the appointment */
|
|
2700
3200
|
phoneOptions?: PhoneOptions;
|
|
2701
|
-
/**
|
|
3201
|
+
/**
|
|
3202
|
+
* Label of the field
|
|
3203
|
+
* @maxLength 255
|
|
3204
|
+
*/
|
|
2702
3205
|
label?: string | null;
|
|
2703
|
-
/**
|
|
3206
|
+
/**
|
|
3207
|
+
* Name of the appointment
|
|
3208
|
+
* @minLength 1
|
|
3209
|
+
* @maxLength 400
|
|
3210
|
+
*/
|
|
2704
3211
|
name?: string | null;
|
|
2705
|
-
/**
|
|
3212
|
+
/**
|
|
3213
|
+
* Duration of the appointment in minutes
|
|
3214
|
+
* @min 1
|
|
3215
|
+
* @max 44639
|
|
3216
|
+
*/
|
|
2706
3217
|
durationInMinutes?: number | null;
|
|
2707
3218
|
/** Indicates whether manual approval is required for the appointment */
|
|
2708
3219
|
manualApprovalRequired?: boolean | null;
|
|
2709
|
-
/**
|
|
3220
|
+
/**
|
|
3221
|
+
* ID of the staff members providing the appointment
|
|
3222
|
+
* @maxSize 220
|
|
3223
|
+
* @format GUID
|
|
3224
|
+
*/
|
|
2710
3225
|
staffIds?: string[] | null;
|
|
2711
3226
|
/** The format of the appointment */
|
|
2712
3227
|
format?: Format;
|
|
@@ -2721,16 +3236,28 @@ export interface AppointmentFormatInfoOneOf {
|
|
|
2721
3236
|
phoneOptions?: PhoneOptions;
|
|
2722
3237
|
}
|
|
2723
3238
|
export interface Location extends LocationLocationInfoOneOf {
|
|
2724
|
-
/**
|
|
3239
|
+
/**
|
|
3240
|
+
* Custom address details
|
|
3241
|
+
* @maxLength 512
|
|
3242
|
+
*/
|
|
2725
3243
|
customAddress?: string | null;
|
|
2726
|
-
/**
|
|
3244
|
+
/**
|
|
3245
|
+
* ID of a business location
|
|
3246
|
+
* @format GUID
|
|
3247
|
+
*/
|
|
2727
3248
|
businessLocationId?: string | null;
|
|
2728
3249
|
}
|
|
2729
3250
|
/** @oneof */
|
|
2730
3251
|
export interface LocationLocationInfoOneOf {
|
|
2731
|
-
/**
|
|
3252
|
+
/**
|
|
3253
|
+
* Custom address details
|
|
3254
|
+
* @maxLength 512
|
|
3255
|
+
*/
|
|
2732
3256
|
customAddress?: string | null;
|
|
2733
|
-
/**
|
|
3257
|
+
/**
|
|
3258
|
+
* ID of a business location
|
|
3259
|
+
* @format GUID
|
|
3260
|
+
*/
|
|
2734
3261
|
businessLocationId?: string | null;
|
|
2735
3262
|
}
|
|
2736
3263
|
export declare enum Format {
|
|
@@ -2740,15 +3267,25 @@ export declare enum Format {
|
|
|
2740
3267
|
PHONE = "PHONE"
|
|
2741
3268
|
}
|
|
2742
3269
|
export interface InPersonOptions {
|
|
2743
|
-
/**
|
|
3270
|
+
/**
|
|
3271
|
+
* The locations details
|
|
3272
|
+
* @minSize 1
|
|
3273
|
+
* @maxSize 500
|
|
3274
|
+
*/
|
|
2744
3275
|
locations?: Location[];
|
|
2745
3276
|
}
|
|
2746
3277
|
export interface VideoConferenceOptions {
|
|
2747
|
-
/**
|
|
3278
|
+
/**
|
|
3279
|
+
* Description or instructions for the online video conference
|
|
3280
|
+
* @maxLength 512
|
|
3281
|
+
*/
|
|
2748
3282
|
description?: string | null;
|
|
2749
3283
|
}
|
|
2750
3284
|
export interface PhoneOptions {
|
|
2751
|
-
/**
|
|
3285
|
+
/**
|
|
3286
|
+
* Description or instructions for the phone appointment
|
|
3287
|
+
* @maxLength 512
|
|
3288
|
+
*/
|
|
2752
3289
|
description?: string | null;
|
|
2753
3290
|
}
|
|
2754
3291
|
export declare enum MultilineAddressComponentType {
|
|
@@ -2756,7 +3293,10 @@ export declare enum MultilineAddressComponentType {
|
|
|
2756
3293
|
MULTILINE_ADDRESS = "MULTILINE_ADDRESS"
|
|
2757
3294
|
}
|
|
2758
3295
|
export interface MultilineAddress {
|
|
2759
|
-
/**
|
|
3296
|
+
/**
|
|
3297
|
+
* Label of the field.
|
|
3298
|
+
* @maxLength 350
|
|
3299
|
+
*/
|
|
2760
3300
|
label?: string | null;
|
|
2761
3301
|
/** Description of the field. */
|
|
2762
3302
|
description?: RichContent;
|
|
@@ -2782,14 +3322,20 @@ export interface AddressLine2 {
|
|
|
2782
3322
|
show?: boolean;
|
|
2783
3323
|
}
|
|
2784
3324
|
export interface DefaultCountryConfig extends DefaultCountryConfigOptionsOneOf {
|
|
2785
|
-
/**
|
|
3325
|
+
/**
|
|
3326
|
+
* Country.
|
|
3327
|
+
* @format COUNTRY
|
|
3328
|
+
*/
|
|
2786
3329
|
countryOptions?: string;
|
|
2787
3330
|
/** Default country type. */
|
|
2788
3331
|
type?: Type;
|
|
2789
3332
|
}
|
|
2790
3333
|
/** @oneof */
|
|
2791
3334
|
export interface DefaultCountryConfigOptionsOneOf {
|
|
2792
|
-
/**
|
|
3335
|
+
/**
|
|
3336
|
+
* Country.
|
|
3337
|
+
* @format COUNTRY
|
|
3338
|
+
*/
|
|
2793
3339
|
countryOptions?: string;
|
|
2794
3340
|
}
|
|
2795
3341
|
export interface FieldsSettings {
|
|
@@ -2879,7 +3425,11 @@ export interface AddressInfo {
|
|
|
2879
3425
|
tag?: Tag;
|
|
2880
3426
|
}
|
|
2881
3427
|
export interface CustomFieldInfo {
|
|
2882
|
-
/**
|
|
3428
|
+
/**
|
|
3429
|
+
* Custom field key.
|
|
3430
|
+
* @minLength 1
|
|
3431
|
+
* @maxLength 500
|
|
3432
|
+
*/
|
|
2883
3433
|
key?: string;
|
|
2884
3434
|
}
|
|
2885
3435
|
export interface SubscriptionInfo {
|
|
@@ -3098,7 +3648,12 @@ export interface InputField extends InputFieldInputTypeOptionsOneOf {
|
|
|
3098
3648
|
multilineAddressOptions?: InputFieldMultilineAddress;
|
|
3099
3649
|
/** Input returns scheduling as value. */
|
|
3100
3650
|
schedulingOptions?: Scheduling;
|
|
3101
|
-
/**
|
|
3651
|
+
/**
|
|
3652
|
+
* Definition of a target where the value of field belongs.
|
|
3653
|
+
* @minLength 1
|
|
3654
|
+
* @maxLength 200
|
|
3655
|
+
* @immutable
|
|
3656
|
+
*/
|
|
3102
3657
|
target?: string | null;
|
|
3103
3658
|
/**
|
|
3104
3659
|
* Mark the field as containing personal information. This will encrypt user data when storing it.
|
|
@@ -3170,17 +3725,33 @@ export interface RichContentOptions {
|
|
|
3170
3725
|
richContent?: RichContent;
|
|
3171
3726
|
}
|
|
3172
3727
|
export interface PageNavigationOptions {
|
|
3173
|
-
/**
|
|
3728
|
+
/**
|
|
3729
|
+
* When button is not on last page it behaves as switch between pages page, text of label to go to next page.
|
|
3730
|
+
* @maxLength 65
|
|
3731
|
+
*/
|
|
3174
3732
|
nextPageText?: string | null;
|
|
3175
|
-
/**
|
|
3733
|
+
/**
|
|
3734
|
+
* When button is not on last page it behaves as switch between pages page, text of label to go to previous page.
|
|
3735
|
+
* @maxLength 65
|
|
3736
|
+
*/
|
|
3176
3737
|
previousPageText?: string | null;
|
|
3177
|
-
/**
|
|
3738
|
+
/**
|
|
3739
|
+
* Text on the button when button is submitting a form
|
|
3740
|
+
* @maxLength 65
|
|
3741
|
+
*/
|
|
3178
3742
|
submitText?: string | null;
|
|
3179
3743
|
}
|
|
3180
3744
|
export interface Step {
|
|
3181
|
-
/**
|
|
3745
|
+
/**
|
|
3746
|
+
* Step ID.
|
|
3747
|
+
* @format GUID
|
|
3748
|
+
* @immutable
|
|
3749
|
+
*/
|
|
3182
3750
|
id?: string;
|
|
3183
|
-
/**
|
|
3751
|
+
/**
|
|
3752
|
+
* Name of the step.
|
|
3753
|
+
* @maxLength 200
|
|
3754
|
+
*/
|
|
3184
3755
|
name?: string | null;
|
|
3185
3756
|
/** Is step hidden */
|
|
3186
3757
|
hidden?: boolean;
|
|
@@ -3196,7 +3767,10 @@ export interface FormLayout {
|
|
|
3196
3767
|
small?: BreakPoint;
|
|
3197
3768
|
}
|
|
3198
3769
|
export interface BreakPoint {
|
|
3199
|
-
/**
|
|
3770
|
+
/**
|
|
3771
|
+
* Description of layouts for items.
|
|
3772
|
+
* @maxSize 500
|
|
3773
|
+
*/
|
|
3200
3774
|
items?: ItemLayout[];
|
|
3201
3775
|
/** Amount of columns of layout grid. */
|
|
3202
3776
|
columns?: number | null;
|
|
@@ -3206,11 +3780,17 @@ export interface BreakPoint {
|
|
|
3206
3780
|
margin?: Margin;
|
|
3207
3781
|
/** Description of elements paddings. */
|
|
3208
3782
|
padding?: Margin;
|
|
3209
|
-
/**
|
|
3783
|
+
/**
|
|
3784
|
+
* Sections of the layout, which allow manage fields
|
|
3785
|
+
* @maxSize 100
|
|
3786
|
+
*/
|
|
3210
3787
|
sections?: Section[];
|
|
3211
3788
|
}
|
|
3212
3789
|
export interface ItemLayout extends ItemLayoutItemOneOf {
|
|
3213
|
-
/**
|
|
3790
|
+
/**
|
|
3791
|
+
* Form field reference id.
|
|
3792
|
+
* @format GUID
|
|
3793
|
+
*/
|
|
3214
3794
|
fieldId?: string;
|
|
3215
3795
|
/** Group info, defining that this item is a group of multiple fields */
|
|
3216
3796
|
group?: Group;
|
|
@@ -3225,15 +3805,25 @@ export interface ItemLayout extends ItemLayoutItemOneOf {
|
|
|
3225
3805
|
}
|
|
3226
3806
|
/** @oneof */
|
|
3227
3807
|
export interface ItemLayoutItemOneOf {
|
|
3228
|
-
/**
|
|
3808
|
+
/**
|
|
3809
|
+
* Form field reference id.
|
|
3810
|
+
* @format GUID
|
|
3811
|
+
*/
|
|
3229
3812
|
fieldId?: string;
|
|
3230
3813
|
/** Group info, defining that this item is a group of multiple fields */
|
|
3231
3814
|
group?: Group;
|
|
3232
3815
|
}
|
|
3233
3816
|
export interface Group {
|
|
3234
|
-
/**
|
|
3817
|
+
/**
|
|
3818
|
+
* Field group reference id.
|
|
3819
|
+
* @format GUID
|
|
3820
|
+
*/
|
|
3235
3821
|
groupId?: string;
|
|
3236
|
-
/**
|
|
3822
|
+
/**
|
|
3823
|
+
* Description of layouts for items.
|
|
3824
|
+
* @minSize 1
|
|
3825
|
+
* @maxSize 500
|
|
3826
|
+
*/
|
|
3237
3827
|
items?: ItemLayout[];
|
|
3238
3828
|
}
|
|
3239
3829
|
export interface Margin {
|
|
@@ -3243,7 +3833,11 @@ export interface Margin {
|
|
|
3243
3833
|
vertical?: number | null;
|
|
3244
3834
|
}
|
|
3245
3835
|
export interface Section {
|
|
3246
|
-
/**
|
|
3836
|
+
/**
|
|
3837
|
+
* Id of the section
|
|
3838
|
+
* @format GUID
|
|
3839
|
+
* @minLength 1
|
|
3840
|
+
*/
|
|
3247
3841
|
id?: string;
|
|
3248
3842
|
/** Horizontal coordinate in the grid. */
|
|
3249
3843
|
row?: number | null;
|
|
@@ -3253,20 +3847,30 @@ export interface Section {
|
|
|
3253
3847
|
* If the section encounters the $new key within the list,
|
|
3254
3848
|
* it allows the inclusion of fields not explicitly listed,
|
|
3255
3849
|
* enabling dynamic addition of new fields.
|
|
3850
|
+
* @maxSize 100
|
|
3851
|
+
* @maxLength 100
|
|
3256
3852
|
*/
|
|
3257
3853
|
allowedFieldIds?: string[];
|
|
3258
3854
|
}
|
|
3259
3855
|
export interface FormRule {
|
|
3260
|
-
/**
|
|
3856
|
+
/**
|
|
3857
|
+
* Id of the rule
|
|
3858
|
+
* @format GUID
|
|
3859
|
+
* @immutable
|
|
3860
|
+
*/
|
|
3261
3861
|
id?: string;
|
|
3262
3862
|
/** Rule on which item properties or layouts will be changed. */
|
|
3263
3863
|
condition?: Record<string, any> | null;
|
|
3264
3864
|
/**
|
|
3265
3865
|
* Form items with defined properties that will be
|
|
3266
3866
|
* changed when given condition is resolved to true.
|
|
3867
|
+
* @maxSize 500
|
|
3267
3868
|
*/
|
|
3268
3869
|
overrides?: FormOverride[];
|
|
3269
|
-
/**
|
|
3870
|
+
/**
|
|
3871
|
+
* Name of the rule
|
|
3872
|
+
* @maxLength 200
|
|
3873
|
+
*/
|
|
3270
3874
|
name?: string | null;
|
|
3271
3875
|
}
|
|
3272
3876
|
export declare enum OverrideEntityType {
|
|
@@ -3274,15 +3878,28 @@ export declare enum OverrideEntityType {
|
|
|
3274
3878
|
FIELD = "FIELD"
|
|
3275
3879
|
}
|
|
3276
3880
|
export interface FormOverride {
|
|
3277
|
-
/**
|
|
3881
|
+
/**
|
|
3882
|
+
* Override entity type.
|
|
3883
|
+
* @immutable
|
|
3884
|
+
*/
|
|
3278
3885
|
entityType?: OverrideEntityType;
|
|
3279
|
-
/**
|
|
3886
|
+
/**
|
|
3887
|
+
* Overridden entity id. Either fieldId, or "{fieldIdWithNestedForm}/{nestedFormFieldId}"
|
|
3888
|
+
* @immutable
|
|
3889
|
+
* @maxLength 73
|
|
3890
|
+
*/
|
|
3280
3891
|
entityId?: string | null;
|
|
3281
3892
|
/** Form entity properties path with new value, that will be changed on condition. */
|
|
3282
3893
|
valueChanges?: Record<string, any>;
|
|
3283
3894
|
}
|
|
3284
3895
|
export interface FormProperties {
|
|
3285
|
-
/**
|
|
3896
|
+
/**
|
|
3897
|
+
* Form name.
|
|
3898
|
+
* @maxLength 200
|
|
3899
|
+
* @deprecated
|
|
3900
|
+
* @replacedBy wix.forms.v4.Form.name
|
|
3901
|
+
* @targetRemovalDate 2026-01-06
|
|
3902
|
+
*/
|
|
3286
3903
|
name?: string | null;
|
|
3287
3904
|
/**
|
|
3288
3905
|
* Identifies if the form is disabled.
|
|
@@ -3303,17 +3920,27 @@ export interface PostSubmissionTriggers {
|
|
|
3303
3920
|
upsertContact?: UpsertContact;
|
|
3304
3921
|
}
|
|
3305
3922
|
export interface UpsertContact {
|
|
3306
|
-
/**
|
|
3923
|
+
/**
|
|
3924
|
+
* Fields mapping (target field mapped to corresponding contact field).
|
|
3925
|
+
* @maxSize 250
|
|
3926
|
+
*/
|
|
3307
3927
|
fieldsMapping?: Record<string, FormFieldContactInfo>;
|
|
3308
3928
|
/**
|
|
3309
3929
|
* List of contact label keys.
|
|
3310
3930
|
* [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
|
|
3311
3931
|
* help categorize contacts.
|
|
3932
|
+
* @minLength 1
|
|
3933
|
+
* @maxLength 100
|
|
3934
|
+
* @maxSize 20
|
|
3312
3935
|
*/
|
|
3313
3936
|
labels?: string[];
|
|
3314
3937
|
}
|
|
3315
3938
|
export interface NestedForm {
|
|
3316
|
-
/**
|
|
3939
|
+
/**
|
|
3940
|
+
* Targets which have this form.
|
|
3941
|
+
* @maxSize 10
|
|
3942
|
+
* @maxLength 200
|
|
3943
|
+
*/
|
|
3317
3944
|
targets?: string[];
|
|
3318
3945
|
/** Nested form. */
|
|
3319
3946
|
form?: Form;
|
|
@@ -3380,28 +4007,44 @@ export interface ThankYouMessageOptions {
|
|
|
3380
4007
|
richContent?: RichContent;
|
|
3381
4008
|
}
|
|
3382
4009
|
export interface RedirectOptions {
|
|
3383
|
-
/**
|
|
4010
|
+
/**
|
|
4011
|
+
* The URL to which the user should be redirected after a successful form submission.
|
|
4012
|
+
* @maxLength 2000
|
|
4013
|
+
*/
|
|
3384
4014
|
redirectUrl?: string | null;
|
|
3385
4015
|
/** How the URL should be opened. */
|
|
3386
4016
|
target?: Target;
|
|
3387
4017
|
}
|
|
3388
4018
|
export interface FieldGroup {
|
|
3389
|
-
/**
|
|
4019
|
+
/**
|
|
4020
|
+
* Id of group, on layout
|
|
4021
|
+
* @format GUID
|
|
4022
|
+
*/
|
|
3390
4023
|
id?: string;
|
|
3391
|
-
/**
|
|
4024
|
+
/**
|
|
4025
|
+
* Label of group
|
|
4026
|
+
* @maxLength 350
|
|
4027
|
+
*/
|
|
3392
4028
|
label?: string | null;
|
|
3393
4029
|
}
|
|
3394
4030
|
export interface CreateCheckoutFromSubmissionResponse {
|
|
3395
|
-
/**
|
|
4031
|
+
/**
|
|
4032
|
+
* Checkout ID (applicable for form involving payments).
|
|
4033
|
+
* @format GUID
|
|
4034
|
+
*/
|
|
3396
4035
|
checkoutId?: string | null;
|
|
3397
4036
|
/** Checkout (applicable for form involving payments). */
|
|
3398
4037
|
checkout?: Checkout;
|
|
3399
4038
|
}
|
|
3400
4039
|
export interface Checkout {
|
|
3401
|
-
/**
|
|
4040
|
+
/**
|
|
4041
|
+
* Checkout ID.
|
|
4042
|
+
* @format GUID
|
|
4043
|
+
*/
|
|
3402
4044
|
id?: string;
|
|
3403
4045
|
/**
|
|
3404
4046
|
* The currency used when submitting the order.
|
|
4047
|
+
* @format CURRENCY
|
|
3405
4048
|
* @readonly
|
|
3406
4049
|
*/
|
|
3407
4050
|
currency?: string;
|
|
@@ -3485,9 +4128,15 @@ export interface ActionEvent {
|
|
|
3485
4128
|
export interface Empty {
|
|
3486
4129
|
}
|
|
3487
4130
|
export interface MessageEnvelope {
|
|
3488
|
-
/**
|
|
4131
|
+
/**
|
|
4132
|
+
* App instance ID.
|
|
4133
|
+
* @format GUID
|
|
4134
|
+
*/
|
|
3489
4135
|
instanceId?: string | null;
|
|
3490
|
-
/**
|
|
4136
|
+
/**
|
|
4137
|
+
* Event type.
|
|
4138
|
+
* @maxLength 150
|
|
4139
|
+
*/
|
|
3491
4140
|
eventType?: string;
|
|
3492
4141
|
/** The identification type and identity data. */
|
|
3493
4142
|
identity?: IdentificationData;
|
|
@@ -3495,26 +4144,50 @@ export interface MessageEnvelope {
|
|
|
3495
4144
|
data?: string;
|
|
3496
4145
|
}
|
|
3497
4146
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3498
|
-
/**
|
|
4147
|
+
/**
|
|
4148
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4149
|
+
* @format GUID
|
|
4150
|
+
*/
|
|
3499
4151
|
anonymousVisitorId?: string;
|
|
3500
|
-
/**
|
|
4152
|
+
/**
|
|
4153
|
+
* ID of a site visitor that has logged in to the site.
|
|
4154
|
+
* @format GUID
|
|
4155
|
+
*/
|
|
3501
4156
|
memberId?: string;
|
|
3502
|
-
/**
|
|
4157
|
+
/**
|
|
4158
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4159
|
+
* @format GUID
|
|
4160
|
+
*/
|
|
3503
4161
|
wixUserId?: string;
|
|
3504
|
-
/**
|
|
4162
|
+
/**
|
|
4163
|
+
* ID of an app.
|
|
4164
|
+
* @format GUID
|
|
4165
|
+
*/
|
|
3505
4166
|
appId?: string;
|
|
3506
4167
|
/** @readonly */
|
|
3507
4168
|
identityType?: WebhookIdentityType;
|
|
3508
4169
|
}
|
|
3509
4170
|
/** @oneof */
|
|
3510
4171
|
export interface IdentificationDataIdOneOf {
|
|
3511
|
-
/**
|
|
4172
|
+
/**
|
|
4173
|
+
* ID of a site visitor that has not logged in to the site.
|
|
4174
|
+
* @format GUID
|
|
4175
|
+
*/
|
|
3512
4176
|
anonymousVisitorId?: string;
|
|
3513
|
-
/**
|
|
4177
|
+
/**
|
|
4178
|
+
* ID of a site visitor that has logged in to the site.
|
|
4179
|
+
* @format GUID
|
|
4180
|
+
*/
|
|
3514
4181
|
memberId?: string;
|
|
3515
|
-
/**
|
|
4182
|
+
/**
|
|
4183
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
4184
|
+
* @format GUID
|
|
4185
|
+
*/
|
|
3516
4186
|
wixUserId?: string;
|
|
3517
|
-
/**
|
|
4187
|
+
/**
|
|
4188
|
+
* ID of an app.
|
|
4189
|
+
* @format GUID
|
|
4190
|
+
*/
|
|
3518
4191
|
appId?: string;
|
|
3519
4192
|
}
|
|
3520
4193
|
export declare enum WebhookIdentityType {
|
|
@@ -3524,10 +4197,63 @@ export declare enum WebhookIdentityType {
|
|
|
3524
4197
|
WIX_USER = "WIX_USER",
|
|
3525
4198
|
APP = "APP"
|
|
3526
4199
|
}
|
|
4200
|
+
export interface UpsertContactFromSubmissionRequest {
|
|
4201
|
+
/**
|
|
4202
|
+
* Submission from which contact needs to be upserted.
|
|
4203
|
+
* @format GUID
|
|
4204
|
+
*/
|
|
4205
|
+
submissionId: string;
|
|
4206
|
+
/**
|
|
4207
|
+
* Optional contact id to which submission should be mapped.
|
|
4208
|
+
* @format GUID
|
|
4209
|
+
*/
|
|
4210
|
+
contactId?: string | null;
|
|
4211
|
+
/** Indicates contact has verified primary email. */
|
|
4212
|
+
emailVerified?: boolean;
|
|
4213
|
+
}
|
|
4214
|
+
export interface UpsertContactFromSubmissionResponse {
|
|
4215
|
+
/** Submit contact response. */
|
|
4216
|
+
submitContactResponse?: SubmitContactResponse;
|
|
4217
|
+
}
|
|
4218
|
+
export interface SubmitContactResponse {
|
|
4219
|
+
/**
|
|
4220
|
+
* ID of the contact that was found or created.
|
|
4221
|
+
* @format GUID
|
|
4222
|
+
*/
|
|
4223
|
+
contactId?: string;
|
|
4224
|
+
/**
|
|
4225
|
+
* Identity type of the returned contact.
|
|
4226
|
+
*
|
|
4227
|
+
* - `CONTACT`: The returned contact ID belongs to a new or existing contact.
|
|
4228
|
+
* - `MEMBER`: The returned contact ID belongs to the currently logged-in site member.
|
|
4229
|
+
* - `NOT_AUTHENTICATED_MEMBER`: The returned contact ID belongs to a site member who is not currently logged in.
|
|
4230
|
+
*/
|
|
4231
|
+
identityType?: IdentityType;
|
|
4232
|
+
/**
|
|
4233
|
+
* Indicates whether the contact was just created or already existed.
|
|
4234
|
+
*
|
|
4235
|
+
* If the contact was just created, returns `true`.
|
|
4236
|
+
* If it already existed, returns `false`.
|
|
4237
|
+
*/
|
|
4238
|
+
newContact?: boolean;
|
|
4239
|
+
}
|
|
4240
|
+
export declare enum IdentityType {
|
|
4241
|
+
UNKNOWN = "UNKNOWN",
|
|
4242
|
+
/** Existing or new contact */
|
|
4243
|
+
CONTACT = "CONTACT",
|
|
4244
|
+
/** Member is logged in, matching logic skipped */
|
|
4245
|
+
MEMBER = "MEMBER",
|
|
4246
|
+
/** Matching contact is a member, Merge logic won't be applied */
|
|
4247
|
+
NOT_AUTHENTICATED_MEMBER = "NOT_AUTHENTICATED_MEMBER"
|
|
4248
|
+
}
|
|
3527
4249
|
export interface CreateSubmissionRequest {
|
|
3528
4250
|
/** Submission to create. */
|
|
3529
4251
|
submission: FormSubmission;
|
|
3530
|
-
/**
|
|
4252
|
+
/**
|
|
4253
|
+
* Captcha token.
|
|
4254
|
+
* @minLength 1
|
|
4255
|
+
* @maxLength 3000
|
|
4256
|
+
*/
|
|
3531
4257
|
captchaToken?: string | null;
|
|
3532
4258
|
}
|
|
3533
4259
|
export interface CreateSubmissionResponse {
|
|
@@ -3535,15 +4261,24 @@ export interface CreateSubmissionResponse {
|
|
|
3535
4261
|
submission?: FormSubmission;
|
|
3536
4262
|
}
|
|
3537
4263
|
export interface SubmissionValidationErrorsDetails {
|
|
3538
|
-
/**
|
|
4264
|
+
/**
|
|
4265
|
+
* Submission validation errors details.
|
|
4266
|
+
* @maxSize 100
|
|
4267
|
+
*/
|
|
3539
4268
|
errors?: ValidationError[];
|
|
3540
4269
|
}
|
|
3541
4270
|
export interface ValidationError {
|
|
3542
|
-
/**
|
|
4271
|
+
/**
|
|
4272
|
+
* Path indicating the source of the error, such as `submission.submissions.email``
|
|
4273
|
+
* @maxLength 1000
|
|
4274
|
+
*/
|
|
3543
4275
|
errorPath?: string;
|
|
3544
4276
|
/** Error type. */
|
|
3545
4277
|
errorType?: ErrorType;
|
|
3546
|
-
/**
|
|
4278
|
+
/**
|
|
4279
|
+
* Error message.
|
|
4280
|
+
* @maxLength 1000
|
|
4281
|
+
*/
|
|
3547
4282
|
errorMessage?: string;
|
|
3548
4283
|
/** Additional error parameters, to help identify additional info. */
|
|
3549
4284
|
params?: Record<string, any> | null;
|
|
@@ -3617,16 +4352,23 @@ export interface CreateSubmissionBySubmitterResponse {
|
|
|
3617
4352
|
submission?: FormSubmission;
|
|
3618
4353
|
}
|
|
3619
4354
|
export interface BulkCreateSubmissionBySubmitterRequest {
|
|
3620
|
-
/**
|
|
4355
|
+
/**
|
|
4356
|
+
* Form id. Restricts submissions creation for a single form.
|
|
4357
|
+
* @format GUID
|
|
4358
|
+
*/
|
|
3621
4359
|
formId: string;
|
|
3622
4360
|
/**
|
|
3623
4361
|
* Submissions to create.
|
|
3624
4362
|
* Deprecated
|
|
4363
|
+
* @maxSize 100
|
|
3625
4364
|
*/
|
|
3626
4365
|
submissions?: FormSubmission[];
|
|
3627
4366
|
/** When set, items will be returned on successful create. */
|
|
3628
4367
|
returnEntity?: boolean;
|
|
3629
|
-
/**
|
|
4368
|
+
/**
|
|
4369
|
+
* Submissions data to create.
|
|
4370
|
+
* @maxSize 100
|
|
4371
|
+
*/
|
|
3630
4372
|
submissionsV2?: BulkCreateSubmissionBySubmitterData[];
|
|
3631
4373
|
/** Validation will be mode is more forgiving, for example "required" won't be validated. */
|
|
3632
4374
|
lenientValidation?: boolean;
|
|
@@ -3650,7 +4392,10 @@ export interface BulkSubmissionResult {
|
|
|
3650
4392
|
item?: FormSubmission;
|
|
3651
4393
|
}
|
|
3652
4394
|
export interface ItemMetadata {
|
|
3653
|
-
/**
|
|
4395
|
+
/**
|
|
4396
|
+
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
4397
|
+
* @format GUID
|
|
4398
|
+
*/
|
|
3654
4399
|
id?: string | null;
|
|
3655
4400
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
3656
4401
|
originalIndex?: number;
|
|
@@ -3676,7 +4421,10 @@ export interface BulkActionMetadata {
|
|
|
3676
4421
|
undetailedFailures?: number;
|
|
3677
4422
|
}
|
|
3678
4423
|
export interface GetSubmissionRequest {
|
|
3679
|
-
/**
|
|
4424
|
+
/**
|
|
4425
|
+
* ID of the submission to retrieve.
|
|
4426
|
+
* @format GUID
|
|
4427
|
+
*/
|
|
3680
4428
|
submissionId: string;
|
|
3681
4429
|
}
|
|
3682
4430
|
export interface GetSubmissionResponse {
|
|
@@ -3684,7 +4432,10 @@ export interface GetSubmissionResponse {
|
|
|
3684
4432
|
submission?: FormSubmission;
|
|
3685
4433
|
}
|
|
3686
4434
|
export interface GetSubmissionByCheckoutIdRequest {
|
|
3687
|
-
/**
|
|
4435
|
+
/**
|
|
4436
|
+
* Checkout ID of the submission to retrieve.
|
|
4437
|
+
* @format GUID
|
|
4438
|
+
*/
|
|
3688
4439
|
checkoutId?: string;
|
|
3689
4440
|
}
|
|
3690
4441
|
export interface GetSubmissionByCheckoutIdResponse {
|
|
@@ -3700,7 +4451,10 @@ export interface UpdateSubmissionResponse {
|
|
|
3700
4451
|
submission?: FormSubmission;
|
|
3701
4452
|
}
|
|
3702
4453
|
export interface ConfirmSubmissionRequest {
|
|
3703
|
-
/**
|
|
4454
|
+
/**
|
|
4455
|
+
* Submission ID to confirm.
|
|
4456
|
+
* @format GUID
|
|
4457
|
+
*/
|
|
3704
4458
|
submissionId: string;
|
|
3705
4459
|
}
|
|
3706
4460
|
export interface ConfirmSubmissionResponse {
|
|
@@ -3708,7 +4462,10 @@ export interface ConfirmSubmissionResponse {
|
|
|
3708
4462
|
submission?: FormSubmission;
|
|
3709
4463
|
}
|
|
3710
4464
|
export interface DeleteSubmissionRequest {
|
|
3711
|
-
/**
|
|
4465
|
+
/**
|
|
4466
|
+
* ID of the submission to delete.
|
|
4467
|
+
* @format GUID
|
|
4468
|
+
*/
|
|
3712
4469
|
submissionId: string;
|
|
3713
4470
|
/**
|
|
3714
4471
|
* Whether to permanently delete a submission bypassing the trash bin.
|
|
@@ -3722,9 +4479,17 @@ export interface DeleteSubmissionRequest {
|
|
|
3722
4479
|
export interface DeleteSubmissionResponse {
|
|
3723
4480
|
}
|
|
3724
4481
|
export interface BulkDeleteSubmissionRequest {
|
|
3725
|
-
/**
|
|
4482
|
+
/**
|
|
4483
|
+
* Form ID.
|
|
4484
|
+
* @format GUID
|
|
4485
|
+
*/
|
|
3726
4486
|
formId: string;
|
|
3727
|
-
/**
|
|
4487
|
+
/**
|
|
4488
|
+
* Submission ids.
|
|
4489
|
+
* @minSize 1
|
|
4490
|
+
* @maxSize 100
|
|
4491
|
+
* @format GUID
|
|
4492
|
+
*/
|
|
3728
4493
|
submissionIds?: string[];
|
|
3729
4494
|
/**
|
|
3730
4495
|
* Delete submission bypassing trash-bin
|
|
@@ -3735,7 +4500,11 @@ export interface BulkDeleteSubmissionRequest {
|
|
|
3735
4500
|
preserveFiles?: boolean;
|
|
3736
4501
|
}
|
|
3737
4502
|
export interface BulkDeleteSubmissionResponse {
|
|
3738
|
-
/**
|
|
4503
|
+
/**
|
|
4504
|
+
* Results of bulk submission delete
|
|
4505
|
+
* @minSize 1
|
|
4506
|
+
* @maxSize 100
|
|
4507
|
+
*/
|
|
3739
4508
|
results?: BulkDeleteSubmissionResult[];
|
|
3740
4509
|
/** Metadata of request */
|
|
3741
4510
|
bulkActionMetadata?: BulkActionMetadata;
|
|
@@ -3745,7 +4514,10 @@ export interface BulkDeleteSubmissionResult {
|
|
|
3745
4514
|
itemMetadata?: ItemMetadata;
|
|
3746
4515
|
}
|
|
3747
4516
|
export interface RestoreSubmissionFromTrashBinRequest {
|
|
3748
|
-
/**
|
|
4517
|
+
/**
|
|
4518
|
+
* ID of the submission to restore.
|
|
4519
|
+
* @format GUID
|
|
4520
|
+
*/
|
|
3749
4521
|
submissionId: string;
|
|
3750
4522
|
}
|
|
3751
4523
|
export interface RestoreSubmissionFromTrashBinResponse {
|
|
@@ -3753,19 +4525,33 @@ export interface RestoreSubmissionFromTrashBinResponse {
|
|
|
3753
4525
|
submission?: FormSubmission;
|
|
3754
4526
|
}
|
|
3755
4527
|
export interface RemoveSubmissionFromTrashBinRequest {
|
|
3756
|
-
/**
|
|
4528
|
+
/**
|
|
4529
|
+
* ID of the submission to restore.
|
|
4530
|
+
* @format GUID
|
|
4531
|
+
*/
|
|
3757
4532
|
submissionId: string;
|
|
3758
4533
|
}
|
|
3759
4534
|
export interface RemoveSubmissionFromTrashBinResponse {
|
|
3760
4535
|
}
|
|
3761
4536
|
export interface BulkRemoveSubmissionFromTrashBinRequest {
|
|
3762
|
-
/**
|
|
4537
|
+
/**
|
|
4538
|
+
* Form ID.
|
|
4539
|
+
* @format GUID
|
|
4540
|
+
*/
|
|
3763
4541
|
formId: string;
|
|
3764
|
-
/**
|
|
4542
|
+
/**
|
|
4543
|
+
* Submission ids.
|
|
4544
|
+
* @minSize 1
|
|
4545
|
+
* @maxSize 100
|
|
4546
|
+
* @format GUID
|
|
4547
|
+
*/
|
|
3765
4548
|
submissionIds?: string[];
|
|
3766
4549
|
}
|
|
3767
4550
|
export interface BulkRemoveSubmissionFromTrashBinResponse {
|
|
3768
|
-
/**
|
|
4551
|
+
/**
|
|
4552
|
+
* Results of bulk submission removal from trash
|
|
4553
|
+
* @maxSize 100
|
|
4554
|
+
*/
|
|
3769
4555
|
results?: BulkRemoveSubmissionFromTrashBinResult[];
|
|
3770
4556
|
/** Metadata of request */
|
|
3771
4557
|
bulkActionMetadata?: BulkActionMetadata;
|
|
@@ -3775,20 +4561,31 @@ export interface BulkRemoveSubmissionFromTrashBinResult {
|
|
|
3775
4561
|
itemMetadata?: ItemMetadata;
|
|
3776
4562
|
}
|
|
3777
4563
|
export interface ListDeletedSubmissionsRequest {
|
|
3778
|
-
/**
|
|
4564
|
+
/**
|
|
4565
|
+
* Form ID.
|
|
4566
|
+
* @format GUID
|
|
4567
|
+
*/
|
|
3779
4568
|
formId: string;
|
|
3780
|
-
/**
|
|
4569
|
+
/**
|
|
4570
|
+
* Submission ids.
|
|
4571
|
+
* @maxSize 10
|
|
4572
|
+
* @format GUID
|
|
4573
|
+
*/
|
|
3781
4574
|
submissionIds?: string[];
|
|
3782
4575
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not filter or `order`. */
|
|
3783
4576
|
paging?: CursorPaging;
|
|
3784
4577
|
/**
|
|
3785
4578
|
* List of statuses of submissions which should be returned
|
|
3786
4579
|
* Default: CONFIRMED
|
|
4580
|
+
* @maxSize 4
|
|
3787
4581
|
*/
|
|
3788
4582
|
statuses?: SubmissionStatus[];
|
|
3789
4583
|
}
|
|
3790
4584
|
export interface CursorPaging {
|
|
3791
|
-
/**
|
|
4585
|
+
/**
|
|
4586
|
+
* Number of items to load.
|
|
4587
|
+
* @max 100
|
|
4588
|
+
*/
|
|
3792
4589
|
limit?: number | null;
|
|
3793
4590
|
/**
|
|
3794
4591
|
* Pointer to the next or previous page in the list of results.
|
|
@@ -3796,6 +4593,7 @@ export interface CursorPaging {
|
|
|
3796
4593
|
* You can get the relevant cursor token
|
|
3797
4594
|
* from the `pagingMetadata` object in the previous call's response.
|
|
3798
4595
|
* Not relevant for the first request.
|
|
4596
|
+
* @maxLength 16000
|
|
3799
4597
|
*/
|
|
3800
4598
|
cursor?: string | null;
|
|
3801
4599
|
}
|
|
@@ -3818,13 +4616,22 @@ export interface CursorPagingMetadata {
|
|
|
3818
4616
|
hasNext?: boolean | null;
|
|
3819
4617
|
}
|
|
3820
4618
|
export interface Cursors {
|
|
3821
|
-
/**
|
|
4619
|
+
/**
|
|
4620
|
+
* Cursor pointing to next page in the list of results.
|
|
4621
|
+
* @maxLength 16000
|
|
4622
|
+
*/
|
|
3822
4623
|
next?: string | null;
|
|
3823
|
-
/**
|
|
4624
|
+
/**
|
|
4625
|
+
* Cursor pointing to previous page in the list of results.
|
|
4626
|
+
* @maxLength 16000
|
|
4627
|
+
*/
|
|
3824
4628
|
prev?: string | null;
|
|
3825
4629
|
}
|
|
3826
4630
|
export interface GetDeletedSubmissionRequest {
|
|
3827
|
-
/**
|
|
4631
|
+
/**
|
|
4632
|
+
* Submission id.
|
|
4633
|
+
* @format GUID
|
|
4634
|
+
*/
|
|
3828
4635
|
submissionId: string;
|
|
3829
4636
|
}
|
|
3830
4637
|
export interface GetDeletedSubmissionResponse {
|
|
@@ -3852,6 +4659,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
3852
4659
|
/**
|
|
3853
4660
|
* Sort object in the following format:
|
|
3854
4661
|
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
4662
|
+
* @maxSize 3
|
|
3855
4663
|
*/
|
|
3856
4664
|
sort?: Sorting[];
|
|
3857
4665
|
}
|
|
@@ -3861,7 +4669,10 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
3861
4669
|
cursorPaging?: CursorPaging;
|
|
3862
4670
|
}
|
|
3863
4671
|
export interface Sorting {
|
|
3864
|
-
/**
|
|
4672
|
+
/**
|
|
4673
|
+
* Name of the field to sort by.
|
|
4674
|
+
* @maxLength 512
|
|
4675
|
+
*/
|
|
3865
4676
|
fieldName?: string;
|
|
3866
4677
|
/** Sort order. */
|
|
3867
4678
|
order?: SortOrder;
|
|
@@ -3888,7 +4699,10 @@ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
3888
4699
|
cursorPaging?: CursorPaging;
|
|
3889
4700
|
/** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
|
|
3890
4701
|
filter?: Record<string, any> | null;
|
|
3891
|
-
/**
|
|
4702
|
+
/**
|
|
4703
|
+
* Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
|
|
4704
|
+
* @maxSize 10
|
|
4705
|
+
*/
|
|
3892
4706
|
sort?: Sorting[];
|
|
3893
4707
|
/** Free text to match in searchable fields */
|
|
3894
4708
|
search?: SearchDetails;
|
|
@@ -3904,7 +4718,10 @@ export interface CursorSearchPagingMethodOneOf {
|
|
|
3904
4718
|
export interface SearchDetails {
|
|
3905
4719
|
/** Defines how separate search terms in `expression` are combined */
|
|
3906
4720
|
mode?: Mode;
|
|
3907
|
-
/**
|
|
4721
|
+
/**
|
|
4722
|
+
* Search term or expression
|
|
4723
|
+
* @maxLength 100
|
|
4724
|
+
*/
|
|
3908
4725
|
expression?: string | null;
|
|
3909
4726
|
/** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
|
|
3910
4727
|
fuzzy?: boolean;
|
|
@@ -3964,7 +4781,10 @@ export interface CountSubmissionsByFilterResponse {
|
|
|
3964
4781
|
formsSubmissionsCount?: FormSubmissionsCount[];
|
|
3965
4782
|
}
|
|
3966
4783
|
export interface FormSubmissionsCount {
|
|
3967
|
-
/**
|
|
4784
|
+
/**
|
|
4785
|
+
* Form ID.
|
|
4786
|
+
* @format GUID
|
|
4787
|
+
*/
|
|
3968
4788
|
formId?: string;
|
|
3969
4789
|
/** Total number of submissions. */
|
|
3970
4790
|
totalCount?: number;
|
|
@@ -3972,13 +4792,23 @@ export interface FormSubmissionsCount {
|
|
|
3972
4792
|
unseenCount?: number;
|
|
3973
4793
|
}
|
|
3974
4794
|
export interface CountSubmissionsRequest {
|
|
3975
|
-
/**
|
|
4795
|
+
/**
|
|
4796
|
+
* Form IDs.
|
|
4797
|
+
* @format GUID
|
|
4798
|
+
* @minSize 1
|
|
4799
|
+
* @maxSize 100
|
|
4800
|
+
*/
|
|
3976
4801
|
formIds: string[];
|
|
3977
|
-
/**
|
|
4802
|
+
/**
|
|
4803
|
+
* Identifies the app which the form submissions belong to. For example, the namespace for the Wix Forms App is `"wix.form_app.form"`. The namespace of a submission can be retrieved using the Get Submission endpoint.
|
|
4804
|
+
* @minLength 10
|
|
4805
|
+
* @maxLength 50
|
|
4806
|
+
*/
|
|
3978
4807
|
namespace: string;
|
|
3979
4808
|
/**
|
|
3980
4809
|
* List of statuses of submissions which should be taken into count
|
|
3981
4810
|
* Default: CONFIRMED, PAYMENT_WAITING, PAYMENT_CANCELED
|
|
4811
|
+
* @maxSize 4
|
|
3982
4812
|
*/
|
|
3983
4813
|
statuses?: SubmissionStatus[];
|
|
3984
4814
|
}
|
|
@@ -3987,13 +4817,23 @@ export interface CountSubmissionsResponse {
|
|
|
3987
4817
|
formsSubmissionsCount?: FormSubmissionsCount[];
|
|
3988
4818
|
}
|
|
3989
4819
|
export interface CountDeletedSubmissionsRequest {
|
|
3990
|
-
/**
|
|
4820
|
+
/**
|
|
4821
|
+
* Form IDs.
|
|
4822
|
+
* @format GUID
|
|
4823
|
+
* @minSize 1
|
|
4824
|
+
* @maxSize 100
|
|
4825
|
+
*/
|
|
3991
4826
|
formIds: string[];
|
|
3992
|
-
/**
|
|
4827
|
+
/**
|
|
4828
|
+
* Identifies the app which the form submissions belong to. For example, the namespace for the Wix Forms App is `"wix.form_app.form"`. The namespace of a submission can be retrieved using the Get Submission endpoint.
|
|
4829
|
+
* @minLength 10
|
|
4830
|
+
* @maxLength 50
|
|
4831
|
+
*/
|
|
3993
4832
|
namespace: string;
|
|
3994
4833
|
/**
|
|
3995
4834
|
* List of statuses of submissions which should be taken into count
|
|
3996
4835
|
* Default: CONFIRMED, PAYMENT_WAITING, PAYMENT_CANCELED
|
|
4836
|
+
* @maxSize 4
|
|
3997
4837
|
*/
|
|
3998
4838
|
statuses?: SubmissionStatus[];
|
|
3999
4839
|
}
|
|
@@ -4002,37 +4842,61 @@ export interface CountDeletedSubmissionsResponse {
|
|
|
4002
4842
|
formsDeletedSubmissionsCount?: FormDeletedSubmissionsCount[];
|
|
4003
4843
|
}
|
|
4004
4844
|
export interface FormDeletedSubmissionsCount {
|
|
4005
|
-
/**
|
|
4845
|
+
/**
|
|
4846
|
+
* Form ID.
|
|
4847
|
+
* @format GUID
|
|
4848
|
+
*/
|
|
4006
4849
|
formId?: string;
|
|
4007
4850
|
/** Total number of submissions. */
|
|
4008
4851
|
totalCount?: number;
|
|
4009
4852
|
}
|
|
4010
4853
|
export interface GetMediaUploadURLRequest {
|
|
4011
|
-
/**
|
|
4854
|
+
/**
|
|
4855
|
+
* Form ID.
|
|
4856
|
+
* @format GUID
|
|
4857
|
+
*/
|
|
4012
4858
|
formId: string;
|
|
4013
|
-
/**
|
|
4859
|
+
/**
|
|
4860
|
+
* Name of file to upload.
|
|
4861
|
+
* @maxLength 300
|
|
4862
|
+
*/
|
|
4014
4863
|
filename: string;
|
|
4015
4864
|
/**
|
|
4016
4865
|
* [Mime type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#) of file to upload.
|
|
4017
4866
|
*
|
|
4018
4867
|
* For example, `'image/png'`
|
|
4868
|
+
* @maxLength 100
|
|
4019
4869
|
*/
|
|
4020
4870
|
mimeType: string;
|
|
4021
4871
|
}
|
|
4022
4872
|
export interface GetMediaUploadURLResponse {
|
|
4023
|
-
/**
|
|
4873
|
+
/**
|
|
4874
|
+
* Url to upload file.
|
|
4875
|
+
* @maxLength 500
|
|
4876
|
+
*/
|
|
4024
4877
|
uploadUrl?: string;
|
|
4025
4878
|
}
|
|
4026
4879
|
export interface BulkMarkSubmissionsAsSeenRequest {
|
|
4027
|
-
/**
|
|
4880
|
+
/**
|
|
4881
|
+
* Submission IDs to mark as seen.
|
|
4882
|
+
* @format GUID
|
|
4883
|
+
* @minSize 1
|
|
4884
|
+
* @maxSize 100
|
|
4885
|
+
*/
|
|
4028
4886
|
ids: string[];
|
|
4029
|
-
/**
|
|
4887
|
+
/**
|
|
4888
|
+
* ID of the form which the submissions belongs to.
|
|
4889
|
+
* @format GUID
|
|
4890
|
+
*/
|
|
4030
4891
|
formId: string;
|
|
4031
4892
|
}
|
|
4032
4893
|
export interface BulkMarkSubmissionsAsSeenResponse {
|
|
4033
4894
|
}
|
|
4034
4895
|
export interface GetSubmissionDownloadUrlRequest {
|
|
4035
|
-
/**
|
|
4896
|
+
/**
|
|
4897
|
+
* Submission ID.
|
|
4898
|
+
* @format GUID
|
|
4899
|
+
*/
|
|
4036
4900
|
submissionId: string;
|
|
4037
4901
|
}
|
|
4038
4902
|
export interface GetSubmissionDownloadUrlResponse {
|
|
@@ -4045,6 +4909,7 @@ export interface SubmissionDocument extends SubmissionDocumentDocumentOneOf {
|
|
|
4045
4909
|
/**
|
|
4046
4910
|
* Document ID.
|
|
4047
4911
|
* @readonly
|
|
4912
|
+
* @maxLength 50
|
|
4048
4913
|
*/
|
|
4049
4914
|
id?: string | null;
|
|
4050
4915
|
/** Document status. */
|
|
@@ -4065,45 +4930,89 @@ export interface DocumentReady {
|
|
|
4065
4930
|
/**
|
|
4066
4931
|
* Document download URL.
|
|
4067
4932
|
* @readonly
|
|
4933
|
+
* @maxLength 300
|
|
4068
4934
|
*/
|
|
4069
4935
|
downloadUrl?: string;
|
|
4070
4936
|
}
|
|
4071
4937
|
export interface GetFormattedSubmissionRequest {
|
|
4072
|
-
/**
|
|
4938
|
+
/**
|
|
4939
|
+
* Submission ID.
|
|
4940
|
+
* @format GUID
|
|
4941
|
+
*/
|
|
4073
4942
|
submissionId?: string;
|
|
4074
4943
|
}
|
|
4075
4944
|
export interface GetFormattedSubmissionResponse {
|
|
4076
|
-
/**
|
|
4945
|
+
/**
|
|
4946
|
+
* Submission ID.
|
|
4947
|
+
* @format GUID
|
|
4948
|
+
*/
|
|
4077
4949
|
submissionId?: string;
|
|
4078
|
-
/**
|
|
4950
|
+
/**
|
|
4951
|
+
* Ordered by form layout list of field submissions.
|
|
4952
|
+
* @maxSize 100
|
|
4953
|
+
*/
|
|
4079
4954
|
submissions?: FormattedSubmission[];
|
|
4080
4955
|
}
|
|
4081
4956
|
export interface FormattedSubmission {
|
|
4082
|
-
/**
|
|
4957
|
+
/**
|
|
4958
|
+
* Label of form field
|
|
4959
|
+
* @maxLength 500
|
|
4960
|
+
*/
|
|
4083
4961
|
label?: string | null;
|
|
4084
|
-
/**
|
|
4962
|
+
/**
|
|
4963
|
+
* Key of the submission, and target of a form field
|
|
4964
|
+
* @maxLength 200
|
|
4965
|
+
*/
|
|
4085
4966
|
key?: string;
|
|
4086
|
-
/**
|
|
4967
|
+
/**
|
|
4968
|
+
* Value of the submission, formatted as a string
|
|
4969
|
+
* @maxLength 500
|
|
4970
|
+
*/
|
|
4087
4971
|
value?: string;
|
|
4088
|
-
/**
|
|
4972
|
+
/**
|
|
4973
|
+
* Id of the form field
|
|
4974
|
+
* @format GUID
|
|
4975
|
+
*/
|
|
4089
4976
|
fieldId?: string;
|
|
4090
4977
|
}
|
|
4091
4978
|
export interface ListFormattedSubmissionsRequest {
|
|
4092
|
-
/**
|
|
4979
|
+
/**
|
|
4980
|
+
* Namespace.
|
|
4981
|
+
* @minLength 10
|
|
4982
|
+
* @maxLength 50
|
|
4983
|
+
*/
|
|
4093
4984
|
namespace?: string;
|
|
4094
|
-
/**
|
|
4985
|
+
/**
|
|
4986
|
+
* Submission IDs.
|
|
4987
|
+
* @format GUID
|
|
4988
|
+
* @minSize 1
|
|
4989
|
+
* @maxSize 100
|
|
4990
|
+
*/
|
|
4095
4991
|
submissionIds?: string[];
|
|
4096
|
-
/**
|
|
4992
|
+
/**
|
|
4993
|
+
* Optional additional filter of form IDs.
|
|
4994
|
+
* @format GUID
|
|
4995
|
+
* @maxSize 100
|
|
4996
|
+
*/
|
|
4097
4997
|
formIds?: string[];
|
|
4098
4998
|
}
|
|
4099
4999
|
export interface ListFormattedSubmissionsResponse {
|
|
4100
|
-
/**
|
|
5000
|
+
/**
|
|
5001
|
+
* List of formatted submissions
|
|
5002
|
+
* @maxSize 100
|
|
5003
|
+
*/
|
|
4101
5004
|
formattedFormSubmissions?: FormattedFormSubmission[];
|
|
4102
5005
|
}
|
|
4103
5006
|
export interface FormattedFormSubmission {
|
|
4104
|
-
/**
|
|
5007
|
+
/**
|
|
5008
|
+
* Submission ID.
|
|
5009
|
+
* @format GUID
|
|
5010
|
+
*/
|
|
4105
5011
|
submissionId?: string;
|
|
4106
|
-
/**
|
|
5012
|
+
/**
|
|
5013
|
+
* Ordered by form layout list of field submissions.
|
|
5014
|
+
* @maxSize 100
|
|
5015
|
+
*/
|
|
4107
5016
|
submissions?: FormattedSubmission[];
|
|
4108
5017
|
}
|
|
4109
5018
|
export interface UpdateExtendedFieldsRequest {
|
|
@@ -4115,13 +5024,22 @@ export interface UpdateExtendedFieldsRequest {
|
|
|
4115
5024
|
namespaceData: Record<string, any> | null;
|
|
4116
5025
|
}
|
|
4117
5026
|
export interface UpdateExtendedFieldsResponse {
|
|
4118
|
-
/**
|
|
5027
|
+
/**
|
|
5028
|
+
* namespace that was updated
|
|
5029
|
+
* @minLength 10
|
|
5030
|
+
* @maxLength 50
|
|
5031
|
+
*/
|
|
4119
5032
|
namespace?: string;
|
|
4120
5033
|
/** only data from UpdateExtendedFieldsRequest namespace_data */
|
|
4121
5034
|
namespaceData?: Record<string, any> | null;
|
|
4122
5035
|
}
|
|
4123
5036
|
export interface BulkUpdateFormSubmissionTagsRequest {
|
|
4124
|
-
/**
|
|
5037
|
+
/**
|
|
5038
|
+
* Submission IDs to update tags for.
|
|
5039
|
+
* @format GUID
|
|
5040
|
+
* @minSize 1
|
|
5041
|
+
* @maxSize 100
|
|
5042
|
+
*/
|
|
4125
5043
|
submissionIds: string[];
|
|
4126
5044
|
/** Tags to be added to submissions */
|
|
4127
5045
|
assignTags?: PublicTags;
|
|
@@ -4129,7 +5047,11 @@ export interface BulkUpdateFormSubmissionTagsRequest {
|
|
|
4129
5047
|
unassignTags?: PublicTags;
|
|
4130
5048
|
}
|
|
4131
5049
|
export interface BulkUpdateFormSubmissionTagsResponse {
|
|
4132
|
-
/**
|
|
5050
|
+
/**
|
|
5051
|
+
* Updated submissions with results
|
|
5052
|
+
* @minSize 1
|
|
5053
|
+
* @maxSize 100
|
|
5054
|
+
*/
|
|
4133
5055
|
results?: BulkUpdateFormSubmissionTagsResult[];
|
|
4134
5056
|
/** Metadata of request */
|
|
4135
5057
|
bulkActionMetadata?: BulkActionMetadata;
|
|
@@ -4147,7 +5069,10 @@ export interface BulkUpdateFormSubmissionTagsByFilterRequest {
|
|
|
4147
5069
|
unassignTags?: PublicTags;
|
|
4148
5070
|
}
|
|
4149
5071
|
export interface BulkUpdateFormSubmissionTagsByFilterResponse {
|
|
4150
|
-
/**
|
|
5072
|
+
/**
|
|
5073
|
+
* Job id for the bulk update operation
|
|
5074
|
+
* @format GUID
|
|
5075
|
+
*/
|
|
4151
5076
|
jobId?: string;
|
|
4152
5077
|
}
|
|
4153
5078
|
export interface ValidateFormSubmissionRequest {
|
|
@@ -4162,17 +5087,29 @@ export interface ValidateFormSubmissionResponse {
|
|
|
4162
5087
|
* Default: true
|
|
4163
5088
|
*/
|
|
4164
5089
|
valid?: boolean | null;
|
|
4165
|
-
/**
|
|
5090
|
+
/**
|
|
5091
|
+
* Submission validation violations
|
|
5092
|
+
* @maxSize 100
|
|
5093
|
+
*/
|
|
4166
5094
|
violationErrors?: FieldViolation[];
|
|
4167
5095
|
}
|
|
4168
5096
|
export interface FieldViolation extends FieldViolationErrorDataOneOf {
|
|
4169
5097
|
/** Validation errors */
|
|
4170
5098
|
submissionValidationErrors?: SubmissionValidationErrors;
|
|
4171
|
-
/**
|
|
5099
|
+
/**
|
|
5100
|
+
* Name of violated entity
|
|
5101
|
+
* @maxLength 50
|
|
5102
|
+
*/
|
|
4172
5103
|
name?: string;
|
|
4173
|
-
/**
|
|
5104
|
+
/**
|
|
5105
|
+
* Description of the error
|
|
5106
|
+
* @maxLength 512
|
|
5107
|
+
*/
|
|
4174
5108
|
description?: string;
|
|
4175
|
-
/**
|
|
5109
|
+
/**
|
|
5110
|
+
* Rule name
|
|
5111
|
+
* @maxLength 50
|
|
5112
|
+
*/
|
|
4176
5113
|
ruleName?: string;
|
|
4177
5114
|
}
|
|
4178
5115
|
/** @oneof */
|
|
@@ -4181,15 +5118,24 @@ export interface FieldViolationErrorDataOneOf {
|
|
|
4181
5118
|
submissionValidationErrors?: SubmissionValidationErrors;
|
|
4182
5119
|
}
|
|
4183
5120
|
export interface SubmissionValidationErrors {
|
|
4184
|
-
/**
|
|
5121
|
+
/**
|
|
5122
|
+
* Submission validation errors.
|
|
5123
|
+
* @maxSize 100
|
|
5124
|
+
*/
|
|
4185
5125
|
errors?: SubmissionValidationError[];
|
|
4186
5126
|
}
|
|
4187
5127
|
export interface SubmissionValidationError extends SubmissionValidationErrorErrorMessageOneOf {
|
|
4188
5128
|
/** Predefined error type. */
|
|
4189
5129
|
errorType?: SubmissionErrorType;
|
|
4190
|
-
/**
|
|
5130
|
+
/**
|
|
5131
|
+
* Custom error message. The message is displayed instead of an error type.
|
|
5132
|
+
* @maxLength 500
|
|
5133
|
+
*/
|
|
4191
5134
|
customErrorMessage?: string;
|
|
4192
|
-
/**
|
|
5135
|
+
/**
|
|
5136
|
+
* Path indicating the source of the error, such as `form.fields.target`.
|
|
5137
|
+
* @maxLength 500
|
|
5138
|
+
*/
|
|
4193
5139
|
errorPath?: string;
|
|
4194
5140
|
/** Additional error parameters. */
|
|
4195
5141
|
params?: Record<string, any> | null;
|
|
@@ -4198,7 +5144,10 @@ export interface SubmissionValidationError extends SubmissionValidationErrorErro
|
|
|
4198
5144
|
export interface SubmissionValidationErrorErrorMessageOneOf {
|
|
4199
5145
|
/** Predefined error type. */
|
|
4200
5146
|
errorType?: SubmissionErrorType;
|
|
4201
|
-
/**
|
|
5147
|
+
/**
|
|
5148
|
+
* Custom error message. The message is displayed instead of an error type.
|
|
5149
|
+
* @maxLength 500
|
|
5150
|
+
*/
|
|
4202
5151
|
customErrorMessage?: string;
|
|
4203
5152
|
}
|
|
4204
5153
|
export declare enum SubmissionErrorType {
|
|
@@ -4233,45 +5182,13 @@ export declare enum SubmissionErrorType {
|
|
|
4233
5182
|
/** Submitted form is disabled. */
|
|
4234
5183
|
DISABLED_FORM_ERROR = "DISABLED_FORM_ERROR"
|
|
4235
5184
|
}
|
|
4236
|
-
|
|
4237
|
-
|
|
4238
|
-
|
|
4239
|
-
|
|
4240
|
-
contactId?: string | null;
|
|
4241
|
-
/** Indicates contact has verified primary email. */
|
|
4242
|
-
emailVerified?: boolean;
|
|
4243
|
-
}
|
|
4244
|
-
export interface UpsertContactFromSubmissionResponse {
|
|
4245
|
-
/** Submit contact response. */
|
|
4246
|
-
submitContactResponse?: SubmitContactResponse;
|
|
4247
|
-
}
|
|
4248
|
-
export interface SubmitContactResponse {
|
|
4249
|
-
/** ID of the contact that was found or created. */
|
|
4250
|
-
contactId?: string;
|
|
4251
|
-
/**
|
|
4252
|
-
* Identity type of the returned contact.
|
|
4253
|
-
*
|
|
4254
|
-
* - `CONTACT`: The returned contact ID belongs to a new or existing contact.
|
|
4255
|
-
* - `MEMBER`: The returned contact ID belongs to the currently logged-in site member.
|
|
4256
|
-
* - `NOT_AUTHENTICATED_MEMBER`: The returned contact ID belongs to a site member who is not currently logged in.
|
|
4257
|
-
*/
|
|
4258
|
-
identityType?: IdentityType;
|
|
4259
|
-
/**
|
|
4260
|
-
* Indicates whether the contact was just created or already existed.
|
|
4261
|
-
*
|
|
4262
|
-
* If the contact was just created, returns `true`.
|
|
4263
|
-
* If it already existed, returns `false`.
|
|
4264
|
-
*/
|
|
4265
|
-
newContact?: boolean;
|
|
5185
|
+
interface SubmitContactResponseNonNullableFields {
|
|
5186
|
+
contactId: string;
|
|
5187
|
+
identityType: IdentityType;
|
|
5188
|
+
newContact: boolean;
|
|
4266
5189
|
}
|
|
4267
|
-
export
|
|
4268
|
-
|
|
4269
|
-
/** Existing or new contact */
|
|
4270
|
-
CONTACT = "CONTACT",
|
|
4271
|
-
/** Member is logged in, matching logic skipped */
|
|
4272
|
-
MEMBER = "MEMBER",
|
|
4273
|
-
/** Matching contact is a member, Merge logic won't be applied */
|
|
4274
|
-
NOT_AUTHENTICATED_MEMBER = "NOT_AUTHENTICATED_MEMBER"
|
|
5190
|
+
export interface UpsertContactFromSubmissionResponseNonNullableFields {
|
|
5191
|
+
submitContactResponse?: SubmitContactResponseNonNullableFields;
|
|
4275
5192
|
}
|
|
4276
5193
|
interface OrderDetailsNonNullableFields {
|
|
4277
5194
|
itemSubtotal: string;
|
|
@@ -4419,12 +5336,4 @@ interface FieldViolationNonNullableFields {
|
|
|
4419
5336
|
export interface ValidateFormSubmissionResponseNonNullableFields {
|
|
4420
5337
|
violationErrors: FieldViolationNonNullableFields[];
|
|
4421
5338
|
}
|
|
4422
|
-
interface SubmitContactResponseNonNullableFields {
|
|
4423
|
-
contactId: string;
|
|
4424
|
-
identityType: IdentityType;
|
|
4425
|
-
newContact: boolean;
|
|
4426
|
-
}
|
|
4427
|
-
export interface UpsertContactFromSubmissionResponseNonNullableFields {
|
|
4428
|
-
submitContactResponse?: SubmitContactResponseNonNullableFields;
|
|
4429
|
-
}
|
|
4430
5339
|
export {};
|