@wix/forms 1.0.66 → 1.0.67

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. package/build/cjs/context.d.ts +2 -0
  2. package/build/cjs/{index.typings.js → context.js} +4 -3
  3. package/build/cjs/context.js.map +1 -0
  4. package/build/cjs/index.d.ts +2 -1
  5. package/build/cjs/index.js +3 -2
  6. package/build/cjs/index.js.map +1 -1
  7. package/build/cjs/meta.d.ts +2 -1
  8. package/build/cjs/meta.js +3 -2
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/context.d.ts +2 -0
  11. package/build/es/context.js +3 -0
  12. package/build/es/context.js.map +1 -0
  13. package/build/es/index.d.ts +2 -1
  14. package/build/es/index.js +2 -1
  15. package/build/es/index.js.map +1 -1
  16. package/build/es/meta.d.ts +2 -1
  17. package/build/es/meta.js +2 -1
  18. package/build/es/meta.js.map +1 -1
  19. package/context/package.json +6 -0
  20. package/package.json +13 -8
  21. package/build/cjs/index.typings.d.ts +0 -1
  22. package/build/cjs/index.typings.js.map +0 -1
  23. package/build/cjs/src/forms-v4-submission.http.d.ts +0 -96
  24. package/build/cjs/src/forms-v4-submission.http.js +0 -525
  25. package/build/cjs/src/forms-v4-submission.http.js.map +0 -1
  26. package/build/cjs/src/forms-v4-submission.meta.d.ts +0 -42
  27. package/build/cjs/src/forms-v4-submission.meta.js +0 -332
  28. package/build/cjs/src/forms-v4-submission.meta.js.map +0 -1
  29. package/build/cjs/src/forms-v4-submission.public.d.ts +0 -32
  30. package/build/cjs/src/forms-v4-submission.public.js +0 -160
  31. package/build/cjs/src/forms-v4-submission.public.js.map +0 -1
  32. package/build/cjs/src/forms-v4-submission.types.d.ts +0 -3352
  33. package/build/cjs/src/forms-v4-submission.types.js +0 -520
  34. package/build/cjs/src/forms-v4-submission.types.js.map +0 -1
  35. package/build/cjs/src/forms-v4-submission.universal.d.ts +0 -3750
  36. package/build/cjs/src/forms-v4-submission.universal.js +0 -1631
  37. package/build/cjs/src/forms-v4-submission.universal.js.map +0 -1
  38. package/build/es/index.typings.d.ts +0 -1
  39. package/build/es/index.typings.js +0 -2
  40. package/build/es/index.typings.js.map +0 -1
  41. package/build/es/src/forms-v4-submission.http.d.ts +0 -96
  42. package/build/es/src/forms-v4-submission.http.js +0 -506
  43. package/build/es/src/forms-v4-submission.http.js.map +0 -1
  44. package/build/es/src/forms-v4-submission.meta.d.ts +0 -42
  45. package/build/es/src/forms-v4-submission.meta.js +0 -290
  46. package/build/es/src/forms-v4-submission.meta.js.map +0 -1
  47. package/build/es/src/forms-v4-submission.public.d.ts +0 -32
  48. package/build/es/src/forms-v4-submission.public.js +0 -84
  49. package/build/es/src/forms-v4-submission.public.js.map +0 -1
  50. package/build/es/src/forms-v4-submission.types.d.ts +0 -3352
  51. package/build/es/src/forms-v4-submission.types.js +0 -516
  52. package/build/es/src/forms-v4-submission.types.js.map +0 -1
  53. package/build/es/src/forms-v4-submission.universal.d.ts +0 -3750
  54. package/build/es/src/forms-v4-submission.universal.js +0 -1588
  55. package/build/es/src/forms-v4-submission.universal.js.map +0 -1
@@ -1,3750 +0,0 @@
1
- export declare const __debug: {
2
- verboseLogging: {
3
- on: () => boolean;
4
- off: () => boolean;
5
- };
6
- };
7
- /** Form submission that was created or retrieved. */
8
- export interface FormSubmission {
9
- /**
10
- * Submission ID.
11
- * @readonly
12
- */
13
- _id?: string | null;
14
- /** ID of the form which the submission belongs to. */
15
- formId?: string;
16
- /**
17
- * 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.
18
- * @readonly
19
- */
20
- namespace?: string;
21
- /**
22
- * Status of the submission.
23
- * - `PENDING`: A submission is created, but has not yet been recorded in the Wix Forms collection.
24
- * - `PAYMENT_WAITING`: A form submission requiring payment is created.
25
- * - `PAYMENT_CANCELED`: An order of a form submission is canceled.
26
- * - `CONFIRMED`: A submission is recorded in the Wix Forms collection.
27
- */
28
- status?: SubmissionStatus;
29
- /** Submission values where `key` is the form field and `value` is the data submitted for the given field. */
30
- submissions?: Record<string, any>;
31
- /**
32
- * Date and time the form submission was created.
33
- * @readonly
34
- */
35
- _createdDate?: Date;
36
- /**
37
- * Date and time the form submission was updated.
38
- * @readonly
39
- */
40
- _updatedDate?: Date;
41
- /**
42
- * Revision number, which increments by 1 each time the form submission is updated. To prevent conflicting changes, the existing revision must be used when updating a form submission.
43
- * @readonly
44
- */
45
- revision?: string | null;
46
- /**
47
- * ID of the visitor that submitted the form.
48
- * @readonly
49
- */
50
- submitter?: Submitter;
51
- /** Whether a site owner marked a submission as "seen". */
52
- seen?: boolean;
53
- /** Data extension object that holds users' and apps' fields. */
54
- extendedFields?: ExtendedFields;
55
- /**
56
- * Order details.
57
- * *Note**: This object is only applicable when submittng a form in the Wix Payments app.
58
- */
59
- orderDetails?: OrderDetails;
60
- }
61
- export declare enum SubmissionStatus {
62
- UNDEFINED = "UNDEFINED",
63
- PENDING = "PENDING",
64
- CONFIRMED = "CONFIRMED",
65
- PAYMENT_WAITING = "PAYMENT_WAITING",
66
- PAYMENT_CANCELED = "PAYMENT_CANCELED"
67
- }
68
- export interface Owner extends OwnerOwnerOneOf {
69
- /** Member ID. */
70
- memberId?: string | null;
71
- /** Visitor ID. */
72
- visitorId?: string | null;
73
- /** Service ID. */
74
- applicationId?: string | null;
75
- /** User ID. */
76
- userId?: string | null;
77
- }
78
- /** @oneof */
79
- export interface OwnerOwnerOneOf {
80
- /** Member ID. */
81
- memberId?: string | null;
82
- /** Visitor ID. */
83
- visitorId?: string | null;
84
- /** Service ID. */
85
- applicationId?: string | null;
86
- /** User ID. */
87
- userId?: string | null;
88
- }
89
- export interface Submitter extends SubmitterSubmitterOneOf {
90
- /** Member ID. */
91
- memberId?: string | null;
92
- /** Visitor ID. */
93
- visitorId?: string | null;
94
- /** Application ID. */
95
- applicationId?: string | null;
96
- /** User ID. */
97
- userId?: string | null;
98
- }
99
- /** @oneof */
100
- export interface SubmitterSubmitterOneOf {
101
- /** Member ID. */
102
- memberId?: string | null;
103
- /** Visitor ID. */
104
- visitorId?: string | null;
105
- /** Application ID. */
106
- applicationId?: string | null;
107
- /** User ID. */
108
- userId?: string | null;
109
- }
110
- export interface ExtendedFields {
111
- /**
112
- * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
113
- * The value of each key is structured according to the schema defined when the extended fields were configured.
114
- *
115
- * You can only access fields for which you have the appropriate permissions.
116
- *
117
- * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
118
- */
119
- namespaces?: Record<string, Record<string, any>>;
120
- }
121
- export interface OrderDetails {
122
- /**
123
- * ID of the order related to submission (applicable if form has payments added).
124
- * @readonly
125
- */
126
- orderId?: string | null;
127
- /**
128
- * Order number.
129
- * @readonly
130
- */
131
- number?: string | null;
132
- /**
133
- * Currency.
134
- * @readonly
135
- */
136
- currency?: string | null;
137
- /**
138
- * Item subtotal.
139
- * @readonly
140
- */
141
- itemSubtotal?: string;
142
- /**
143
- * ID of the checkout related to submission (applicable if form has payments added).
144
- * @readonly
145
- */
146
- checkoutId?: string;
147
- }
148
- export interface CreateCheckoutFromSubmissionRequest extends CreateCheckoutFromSubmissionRequestFormSchemaIdentifierOneOf {
149
- /** Submission's form. */
150
- form?: Form;
151
- /** Submission to create checkout from. */
152
- submission?: FormSubmission;
153
- }
154
- /** @oneof */
155
- export interface CreateCheckoutFromSubmissionRequestFormSchemaIdentifierOneOf {
156
- /** Submission's form. */
157
- form?: Form;
158
- }
159
- export interface Form {
160
- /**
161
- * Form ID.
162
- * @readonly
163
- */
164
- _id?: string | null;
165
- /** List of form fields that represent input elements. */
166
- fields?: FormField[];
167
- /**
168
- * List of form fields that represent input elements.
169
- * @readonly
170
- */
171
- fieldsV2?: FormFieldV2[];
172
- /** Defines the layout for form fields in each submission step. */
173
- steps?: Step[];
174
- /** Form rules, can be applied to layout and items properties. */
175
- rules?: FormRule[];
176
- /**
177
- * 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.
178
- * @readonly
179
- */
180
- revision?: string | null;
181
- /**
182
- * Date of creation.
183
- * @readonly
184
- */
185
- _createdDate?: Date;
186
- /**
187
- * Date of last update.
188
- * @readonly
189
- */
190
- _updatedDate?: Date;
191
- /** Properties of the form. */
192
- properties?: FormProperties;
193
- /**
194
- * Fields which were soft deleted.
195
- * @readonly
196
- */
197
- deletedFields?: FormField[];
198
- /**
199
- * List of form fields that represent input elements.
200
- * @readonly
201
- */
202
- deletedFieldsV2?: FormFieldV2[];
203
- /**
204
- * Regular forms can be freely modified.
205
- * Extensions are copied from templates and might have restrictions.
206
- * @readonly
207
- */
208
- kind?: Kind;
209
- /**
210
- * Defines triggers that will be executed after the submission, for the submissions based on this schema.
211
- * Forms provide a set of predefined triggers that allow it to assign specific business cases to created forms.
212
- */
213
- postSubmissionTriggers?: PostSubmissionTriggers;
214
- /** Data extensions ExtendedFields. */
215
- extendedFields?: ExtendedFields;
216
- /** Identifies the namespace that the form belongs to. */
217
- namespace?: string;
218
- /**
219
- * Media folder ID.
220
- * @readonly
221
- */
222
- mediaFolderId?: string | null;
223
- /** Rules that limit submissions on this form. */
224
- limitationRule?: LimitationRule;
225
- }
226
- export interface FormField {
227
- /** Item ID. */
228
- _id?: string;
229
- /** Definition of a target where the value of field belongs. */
230
- target?: string | null;
231
- /** Validation of field output value. */
232
- validation?: Validation;
233
- /** Mark the field as containing personal information. This will encrypt user data when storing it. */
234
- pii?: boolean;
235
- /** Whether the field is hidden. */
236
- hidden?: boolean;
237
- /** Field view properties. */
238
- view?: Record<string, any> | null;
239
- /** Details identifying field, which is extension of other entity */
240
- dataExtensionsDetails?: DataExtensionsDetails;
241
- }
242
- export interface StringType extends StringTypeFormatOptionsOneOf {
243
- /** DATE format options */
244
- dateOptions?: DateTimeConstraints;
245
- /** DATE_TIME format options */
246
- dateTimeOptions?: DateTimeConstraints;
247
- /** TIME format options */
248
- timeOptions?: DateTimeConstraints;
249
- /** DATE_OPTIONAL_TIME format options */
250
- dateOptionalTimeOptions?: DateTimeConstraints;
251
- /** Minimum length. */
252
- minLength?: number | null;
253
- /** Maximum length. */
254
- maxLength?: number | null;
255
- /** Pattern for a regular expression match. */
256
- pattern?: string | null;
257
- /** Format of a string. */
258
- format?: Format;
259
- /** Custom error messages when validation fails. */
260
- errorMessages?: StringErrorMessages;
261
- /** List of allowed values. */
262
- enum?: string[] | null;
263
- }
264
- /** @oneof */
265
- export interface StringTypeFormatOptionsOneOf {
266
- /** DATE format options */
267
- dateOptions?: DateTimeConstraints;
268
- /** DATE_TIME format options */
269
- dateTimeOptions?: DateTimeConstraints;
270
- /** TIME format options */
271
- timeOptions?: DateTimeConstraints;
272
- /** DATE_OPTIONAL_TIME format options */
273
- dateOptionalTimeOptions?: DateTimeConstraints;
274
- }
275
- export declare enum Format {
276
- UNDEFINED = "UNDEFINED",
277
- DATE = "DATE",
278
- TIME = "TIME",
279
- DATE_TIME = "DATE_TIME",
280
- EMAIL = "EMAIL",
281
- URL = "URL",
282
- UUID = "UUID",
283
- PHONE = "PHONE",
284
- URI = "URI",
285
- HOSTNAME = "HOSTNAME",
286
- COLOR_HEX = "COLOR_HEX",
287
- CURRENCY = "CURRENCY",
288
- LANGUAGE = "LANGUAGE",
289
- DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
290
- }
291
- export interface StringErrorMessages {
292
- /** Default error message on invalid validation. */
293
- default?: string | null;
294
- }
295
- export interface DateTimeConstraints {
296
- /**
297
- * Support static constrains defined as ISO date/time format, as well as
298
- * dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
299
- * The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
300
- * The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
301
- */
302
- minimum?: string | null;
303
- /**
304
- * Support static constrains defined as ISO date/time format, as well as
305
- * dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
306
- * The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
307
- * The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
308
- */
309
- maximum?: string | null;
310
- }
311
- export interface NumberType {
312
- /** Inclusive maximum value. */
313
- maximum?: number | null;
314
- /** Inclusive minimum value. */
315
- minimum?: number | null;
316
- /** Multiple of value. */
317
- multipleOf?: number | null;
318
- /** Custom error message when validation fails. */
319
- errorMessages?: NumberErrorMessages;
320
- /** List of allowed values. */
321
- enum?: number[] | null;
322
- }
323
- export interface NumberErrorMessages {
324
- /** Default error message on invalid validation. */
325
- default?: string | null;
326
- }
327
- export interface IntegerType {
328
- /** Minimum value. */
329
- maximum?: number | null;
330
- /** Maximum value. */
331
- minimum?: number | null;
332
- /** Multiple of value. */
333
- multipleOf?: number | null;
334
- /** Custom error message when validation fails. */
335
- errorMessages?: NumberErrorMessages;
336
- /** List of allowed values. */
337
- enum?: number[] | null;
338
- }
339
- export interface BooleanType {
340
- /** Custom error message when validation fails. */
341
- errorMessages?: BooleanErrorMessages;
342
- /** List of allowed values. */
343
- enum?: boolean[];
344
- }
345
- export interface BooleanErrorMessages {
346
- /** Default error message on invalid validation. */
347
- default?: string | null;
348
- }
349
- export interface ArrayType {
350
- /** Maximum amount of array elements. */
351
- maxItems?: number | null;
352
- /** Minimum amount of array elements. */
353
- minItems?: number | null;
354
- /** Type of items allowed in array. */
355
- items?: ArrayItems;
356
- /** Custom error message when validation fails. */
357
- errorMessages?: ArrayErrorMessages;
358
- }
359
- export interface ObjectType {
360
- /** Description of object properties. */
361
- properties?: Record<string, PropertiesType>;
362
- /** Custom error message when validation fails. */
363
- errorMessages?: ObjectErrorMessages;
364
- }
365
- export interface PropertiesType extends PropertiesTypePropertiesTypeOneOf {
366
- /** String type validation for property. */
367
- string?: StringType;
368
- /** Number type validation for property. */
369
- number?: NumberType;
370
- /** Boolean type validation for property. */
371
- boolean?: BooleanType;
372
- /** Integer type validation for property. */
373
- integer?: IntegerType;
374
- /** Array type validation for property. */
375
- array?: ArrayType;
376
- /** Whether the property is required. */
377
- required?: boolean;
378
- }
379
- /** @oneof */
380
- export interface PropertiesTypePropertiesTypeOneOf {
381
- /** String type validation for property. */
382
- string?: StringType;
383
- /** Number type validation for property. */
384
- number?: NumberType;
385
- /** Boolean type validation for property. */
386
- boolean?: BooleanType;
387
- /** Integer type validation for property. */
388
- integer?: IntegerType;
389
- /** Array type validation for property. */
390
- array?: ArrayType;
391
- }
392
- export interface ObjectErrorMessages {
393
- /** Default error message on invalid validation. */
394
- default?: string | null;
395
- }
396
- export interface ArrayItems extends ArrayItemsItemsOneOf {
397
- /** String type validation for items. */
398
- string?: StringType;
399
- /** Number type validation for items. */
400
- number?: NumberType;
401
- /** Boolean type validation for items. */
402
- boolean?: BooleanType;
403
- /** Integer type validation for items. */
404
- integer?: IntegerType;
405
- /** Object type validation for items */
406
- object?: ObjectType;
407
- }
408
- /** @oneof */
409
- export interface ArrayItemsItemsOneOf {
410
- /** String type validation for items. */
411
- string?: StringType;
412
- /** Number type validation for items. */
413
- number?: NumberType;
414
- /** Boolean type validation for items. */
415
- boolean?: BooleanType;
416
- /** Integer type validation for items. */
417
- integer?: IntegerType;
418
- /** Object type validation for items */
419
- object?: ObjectType;
420
- }
421
- export interface ArrayErrorMessages {
422
- /** Default error message on invalid validation. */
423
- default?: string | null;
424
- }
425
- export interface PredefinedValidation extends PredefinedValidationFormatOptionsOneOf {
426
- /** Payment input field. */
427
- paymentOptions?: PaymentType;
428
- /** Format of predefined validation. */
429
- format?: ValidationFormat;
430
- }
431
- /** @oneof */
432
- export interface PredefinedValidationFormatOptionsOneOf {
433
- /** Payment input field. */
434
- paymentOptions?: PaymentType;
435
- }
436
- export declare enum ValidationFormat {
437
- UNDEFINED = "UNDEFINED",
438
- /** File upload validation. */
439
- WIX_FILE = "WIX_FILE",
440
- /** Payment validation. */
441
- PAYMENT = "PAYMENT"
442
- }
443
- export interface PaymentType {
444
- /** Field mapped to products. */
445
- products?: Product[];
446
- /** Minimum amount of different products. */
447
- minItems?: number | null;
448
- /** Maximum amount of different products. */
449
- maxItems?: number | null;
450
- }
451
- export declare enum ProductType {
452
- UNKNOWN = "UNKNOWN",
453
- /** Shippable (physical). */
454
- SHIPPABLE = "SHIPPABLE",
455
- /** Digital. */
456
- DIGITAL = "DIGITAL"
457
- }
458
- export declare enum PriceType {
459
- UNKNOWN = "UNKNOWN",
460
- /** Fixed price. */
461
- FIXED_PRICE = "FIXED_PRICE",
462
- /** Dynamic price from price range. */
463
- DYNAMIC_PRICE = "DYNAMIC_PRICE"
464
- }
465
- export interface QuantityLimit {
466
- /** Minimum quantity. */
467
- minimum?: number | null;
468
- /** Maximum quantity. */
469
- maximum?: number | null;
470
- }
471
- export interface FixedPriceOptions {
472
- /** Fixed price monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). */
473
- price?: string;
474
- }
475
- export interface DynamicPriceOptions {
476
- /** Minimal price monetary amount. */
477
- minPrice?: string;
478
- /** Maximal price monetary amount. */
479
- maxPrice?: string | null;
480
- }
481
- export interface Product extends ProductPriceOptionsOneOf {
482
- /** Fixed price options. */
483
- fixedPriceOptions?: FixedPriceOptions;
484
- /** Dynamic price options. */
485
- dynamicPriceOptions?: DynamicPriceOptions;
486
- /**
487
- * Product ID.
488
- * @readonly
489
- */
490
- _id?: string;
491
- /** Product type. */
492
- productType?: ProductType;
493
- /** Price type. */
494
- priceType?: PriceType;
495
- /** Quantity limit. */
496
- quantityLimit?: QuantityLimit;
497
- }
498
- /** @oneof */
499
- export interface ProductPriceOptionsOneOf {
500
- /** Fixed price options. */
501
- fixedPriceOptions?: FixedPriceOptions;
502
- /** Dynamic price options. */
503
- dynamicPriceOptions?: DynamicPriceOptions;
504
- }
505
- export interface NestedFormFieldOverrides {
506
- /** Whether the field is required. Leave blank for no override. */
507
- required?: boolean | null;
508
- /** Whether the field is hidden. Leave blank for no override. */
509
- hidden?: boolean | null;
510
- }
511
- export interface Validation extends ValidationValidationOneOf {
512
- /** Validation of string type. */
513
- string?: StringType;
514
- /** Validation of number type. */
515
- number?: NumberType;
516
- /** Validation of integer type. */
517
- integer?: IntegerType;
518
- /** Validation of boolean type. */
519
- boolean?: BooleanType;
520
- /** Validation of array type. */
521
- array?: ArrayType;
522
- /** Validation of object type. */
523
- object?: ObjectType;
524
- /** Predefined validation of specific format */
525
- predefined?: PredefinedValidation;
526
- /** Whether the field is required. */
527
- required?: boolean;
528
- }
529
- /** @oneof */
530
- export interface ValidationValidationOneOf {
531
- /** Validation of string type. */
532
- string?: StringType;
533
- /** Validation of number type. */
534
- number?: NumberType;
535
- /** Validation of integer type. */
536
- integer?: IntegerType;
537
- /** Validation of boolean type. */
538
- boolean?: BooleanType;
539
- /** Validation of array type. */
540
- array?: ArrayType;
541
- /** Validation of object type. */
542
- object?: ObjectType;
543
- /** Predefined validation of specific format */
544
- predefined?: PredefinedValidation;
545
- }
546
- export interface DataExtensionsDetails {
547
- /** FQDNS which can be extended with this field */
548
- fqdns?: string[];
549
- }
550
- export interface NestedFormOverrides {
551
- /** Field overrides by field ID */
552
- fieldOverrides?: Record<string, NestedFormFieldOverrides>;
553
- }
554
- export interface FormFieldV2 extends FormFieldV2FieldTypeOptionsOneOf {
555
- /** Field accept input of data */
556
- inputOptions?: InputField;
557
- /** Field for displaying information such as header or text paragraph */
558
- displayOptions?: DisplayField;
559
- /** Submit button of the form */
560
- submitOptions?: SubmitButton;
561
- /** Field id. */
562
- _id?: string;
563
- /**
564
- * Whether the field is hidden.
565
- * Default: false
566
- */
567
- hidden?: boolean;
568
- /** Custom identification of field, can be used to specify exceptional behaviour of client for specific field */
569
- identifier?: string | null;
570
- /**
571
- * Type of the field
572
- * @readonly
573
- */
574
- fieldType?: FieldType;
575
- }
576
- /** @oneof */
577
- export interface FormFieldV2FieldTypeOptionsOneOf {
578
- /** Field accept input of data */
579
- inputOptions?: InputField;
580
- /** Field for displaying information such as header or text paragraph */
581
- displayOptions?: DisplayField;
582
- /** Submit button of the form */
583
- submitOptions?: SubmitButton;
584
- }
585
- export interface InputFieldStringType {
586
- /** Minimum length. */
587
- minLength?: number | null;
588
- /** Maximum length. */
589
- maxLength?: number | null;
590
- /** Pattern for a regular expression match. */
591
- pattern?: string | null;
592
- /** Format of a string. */
593
- format?: FormatEnumFormat;
594
- /** Custom error messages when validation fails. */
595
- errorMessages?: InputFieldStringErrorMessages;
596
- /** List of allowed values. */
597
- enum?: string[] | null;
598
- }
599
- export declare enum FormatEnumFormat {
600
- UNDEFINED = "UNDEFINED",
601
- DATE = "DATE",
602
- TIME = "TIME",
603
- DATE_TIME = "DATE_TIME",
604
- EMAIL = "EMAIL",
605
- URL = "URL",
606
- UUID = "UUID",
607
- PHONE = "PHONE",
608
- URI = "URI",
609
- HOSTNAME = "HOSTNAME",
610
- COLOR_HEX = "COLOR_HEX",
611
- CURRENCY = "CURRENCY",
612
- LANGUAGE = "LANGUAGE",
613
- DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
614
- }
615
- export interface InputFieldStringErrorMessages {
616
- /** Default error message on invalid validation. */
617
- default?: string | null;
618
- }
619
- export declare enum StringComponentType {
620
- UNKNOWN = "UNKNOWN",
621
- TEXT_INPUT = "TEXT_INPUT",
622
- RADIO_GROUP = "RADIO_GROUP",
623
- DROPDOWN = "DROPDOWN",
624
- DATE_TIME = "DATE_TIME"
625
- }
626
- export interface TextInput {
627
- /** Label of the field */
628
- label?: string | null;
629
- /** Description of the field */
630
- description?: RichContent;
631
- /** Placeholder for the value input */
632
- placeholder?: string | null;
633
- /**
634
- * Flag identifying to hide or not label
635
- * Default: true
636
- */
637
- showLabel?: boolean | null;
638
- }
639
- export interface RichContent {
640
- /** Node objects representing a rich content document. */
641
- nodes?: Node[];
642
- /** Object metadata. */
643
- metadata?: Metadata;
644
- /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
645
- documentStyle?: DocumentStyle;
646
- }
647
- export interface Node extends NodeDataOneOf {
648
- /** Data for a button node. */
649
- buttonData?: ButtonData;
650
- /** Data for a code block node. */
651
- codeBlockData?: CodeBlockData;
652
- /** Data for a divider node. */
653
- dividerData?: DividerData;
654
- /** Data for a file node. */
655
- fileData?: FileData;
656
- /** Data for a gallery node. */
657
- galleryData?: GalleryData;
658
- /** Data for a GIF node. */
659
- gifData?: GIFData;
660
- /** Data for a heading node. */
661
- headingData?: HeadingData;
662
- /** Data for an embedded HTML node. */
663
- htmlData?: HTMLData;
664
- /** Data for an image node. */
665
- imageData?: ImageData;
666
- /** Data for a link preview node. */
667
- linkPreviewData?: LinkPreviewData;
668
- /** Data for a map node. */
669
- mapData?: MapData;
670
- /** Data for a paragraph node. */
671
- paragraphData?: ParagraphData;
672
- /** Data for a poll node. */
673
- pollData?: PollData;
674
- /** Data for a text node. Used to apply decorations to text. */
675
- textData?: TextData;
676
- /** Data for an app embed node. */
677
- appEmbedData?: AppEmbedData;
678
- /** Data for a video node. */
679
- videoData?: VideoData;
680
- /** Data for an oEmbed node. */
681
- embedData?: EmbedData;
682
- /** Data for a collapsible list node. */
683
- collapsibleListData?: CollapsibleListData;
684
- /** Data for a table node. */
685
- tableData?: TableData;
686
- /** Data for a table cell node. */
687
- tableCellData?: TableCellData;
688
- /** Data for a custon external node. */
689
- externalData?: Record<string, any> | null;
690
- /** Data for an audio node. */
691
- audioData?: AudioData;
692
- /** Data for an ordered list node. */
693
- orderedListData?: OrderedListData;
694
- /** Data for a bulleted list node. */
695
- bulletedListData?: BulletedListData;
696
- /** Data for a block quote node. */
697
- blockquoteData?: BlockquoteData;
698
- /** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
699
- type?: NodeType;
700
- /** Node ID. */
701
- _id?: string;
702
- /** A list of child nodes. */
703
- nodes?: Node[];
704
- /** Padding and background color styling for the node. */
705
- style?: NodeStyle;
706
- }
707
- /** @oneof */
708
- export interface NodeDataOneOf {
709
- /** Data for a button node. */
710
- buttonData?: ButtonData;
711
- /** Data for a code block node. */
712
- codeBlockData?: CodeBlockData;
713
- /** Data for a divider node. */
714
- dividerData?: DividerData;
715
- /** Data for a file node. */
716
- fileData?: FileData;
717
- /** Data for a gallery node. */
718
- galleryData?: GalleryData;
719
- /** Data for a GIF node. */
720
- gifData?: GIFData;
721
- /** Data for a heading node. */
722
- headingData?: HeadingData;
723
- /** Data for an embedded HTML node. */
724
- htmlData?: HTMLData;
725
- /** Data for an image node. */
726
- imageData?: ImageData;
727
- /** Data for a link preview node. */
728
- linkPreviewData?: LinkPreviewData;
729
- /** Data for a map node. */
730
- mapData?: MapData;
731
- /** Data for a paragraph node. */
732
- paragraphData?: ParagraphData;
733
- /** Data for a poll node. */
734
- pollData?: PollData;
735
- /** Data for a text node. Used to apply decorations to text. */
736
- textData?: TextData;
737
- /** Data for an app embed node. */
738
- appEmbedData?: AppEmbedData;
739
- /** Data for a video node. */
740
- videoData?: VideoData;
741
- /** Data for an oEmbed node. */
742
- embedData?: EmbedData;
743
- /** Data for a collapsible list node. */
744
- collapsibleListData?: CollapsibleListData;
745
- /** Data for a table node. */
746
- tableData?: TableData;
747
- /** Data for a table cell node. */
748
- tableCellData?: TableCellData;
749
- /** Data for a custon external node. */
750
- externalData?: Record<string, any> | null;
751
- /** Data for an audio node. */
752
- audioData?: AudioData;
753
- /** Data for an ordered list node. */
754
- orderedListData?: OrderedListData;
755
- /** Data for a bulleted list node. */
756
- bulletedListData?: BulletedListData;
757
- /** Data for a block quote node. */
758
- blockquoteData?: BlockquoteData;
759
- }
760
- export declare enum NodeType {
761
- PARAGRAPH = "PARAGRAPH",
762
- TEXT = "TEXT",
763
- HEADING = "HEADING",
764
- BULLETED_LIST = "BULLETED_LIST",
765
- ORDERED_LIST = "ORDERED_LIST",
766
- LIST_ITEM = "LIST_ITEM",
767
- BLOCKQUOTE = "BLOCKQUOTE",
768
- CODE_BLOCK = "CODE_BLOCK",
769
- VIDEO = "VIDEO",
770
- DIVIDER = "DIVIDER",
771
- FILE = "FILE",
772
- GALLERY = "GALLERY",
773
- GIF = "GIF",
774
- HTML = "HTML",
775
- IMAGE = "IMAGE",
776
- LINK_PREVIEW = "LINK_PREVIEW",
777
- MAP = "MAP",
778
- POLL = "POLL",
779
- APP_EMBED = "APP_EMBED",
780
- BUTTON = "BUTTON",
781
- COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
782
- TABLE = "TABLE",
783
- EMBED = "EMBED",
784
- COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
785
- COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
786
- COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
787
- TABLE_CELL = "TABLE_CELL",
788
- TABLE_ROW = "TABLE_ROW",
789
- EXTERNAL = "EXTERNAL",
790
- AUDIO = "AUDIO"
791
- }
792
- export interface NodeStyle {
793
- /** The top padding value in pixels. */
794
- paddingTop?: string | null;
795
- /** The bottom padding value in pixels. */
796
- paddingBottom?: string | null;
797
- /** The background color as a hexadecimal value. */
798
- backgroundColor?: string | null;
799
- }
800
- export interface ButtonData {
801
- /** Styling for the button's container. */
802
- containerData?: PluginContainerData;
803
- /** The button type. */
804
- type?: Type;
805
- /** Styling for the button. */
806
- styles?: Styles;
807
- /** The text to display on the button. */
808
- text?: string | null;
809
- /** Button link details. */
810
- link?: Link;
811
- }
812
- export interface Border {
813
- /** Border width in pixels. */
814
- width?: number | null;
815
- /** Border radius in pixels. */
816
- radius?: number | null;
817
- }
818
- export interface Colors {
819
- /** The text color as a hexadecimal value. */
820
- text?: string | null;
821
- /** The border color as a hexadecimal value. */
822
- border?: string | null;
823
- /** The background color as a hexadecimal value. */
824
- background?: string | null;
825
- }
826
- export interface PluginContainerData {
827
- /** The width of the node when it's displayed. */
828
- width?: PluginContainerDataWidth;
829
- /** The node's alignment within its container. */
830
- alignment?: PluginContainerDataAlignment;
831
- /** Spoiler cover settings for the node. */
832
- spoiler?: Spoiler;
833
- /** The height of the node when it's displayed. */
834
- height?: Height;
835
- /** Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. */
836
- textWrap?: boolean | null;
837
- }
838
- export declare enum WidthType {
839
- /** Width matches the content width */
840
- CONTENT = "CONTENT",
841
- /** Small Width */
842
- SMALL = "SMALL",
843
- /** Width will match the original asset width */
844
- ORIGINAL = "ORIGINAL",
845
- /** coast-to-coast display */
846
- FULL_WIDTH = "FULL_WIDTH"
847
- }
848
- export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
849
- /**
850
- * One of the following predefined width options:
851
- * `CONTENT`: The width of the container matches the content width.
852
- * `SMALL`: Small width.
853
- * `ORIGINAL`: The width of the container matches the original asset width.
854
- * `FULL_WIDTH`: Full width.
855
- */
856
- size?: WidthType;
857
- /** A custom width value in pixels. */
858
- custom?: string | null;
859
- }
860
- /** @oneof */
861
- export interface PluginContainerDataWidthDataOneOf {
862
- /**
863
- * One of the following predefined width options:
864
- * `CONTENT`: The width of the container matches the content width.
865
- * `SMALL`: Small width.
866
- * `ORIGINAL`: The width of the container matches the original asset width.
867
- * `FULL_WIDTH`: Full width.
868
- */
869
- size?: WidthType;
870
- /** A custom width value in pixels. */
871
- custom?: string | null;
872
- }
873
- export declare enum PluginContainerDataAlignment {
874
- /** Center Alignment */
875
- CENTER = "CENTER",
876
- /** Left Alignment */
877
- LEFT = "LEFT",
878
- /** Right Alignment */
879
- RIGHT = "RIGHT"
880
- }
881
- export interface Spoiler {
882
- /** Sets whether the spoiler cover is enabled for this node. */
883
- enabled?: boolean | null;
884
- /** The description displayed on top of the spoiler cover. */
885
- description?: string | null;
886
- /** The text for the button used to remove the spoiler cover. */
887
- buttonText?: string | null;
888
- }
889
- export interface Height {
890
- /** A custom height value in pixels. */
891
- custom?: string | null;
892
- }
893
- export declare enum Type {
894
- /** Regular link button */
895
- LINK = "LINK",
896
- /** Triggers custom action that is defined in plugin configuration by the consumer */
897
- ACTION = "ACTION"
898
- }
899
- export interface Styles {
900
- /** Border attributes. */
901
- border?: Border;
902
- /** Color attributes. */
903
- colors?: Colors;
904
- }
905
- export interface Link extends LinkDataOneOf {
906
- /** The absolute URL for the linked document. */
907
- url?: string;
908
- /** The target node's ID. Used for linking to another node in this object. */
909
- anchor?: string;
910
- /**
911
- * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
912
- * `SELF` - Default. Opens the linked document in the same frame as the link.
913
- * `BLANK` - Opens the linked document in a new browser tab or window.
914
- * `PARENT` - Opens the linked document in the link's parent frame.
915
- * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
916
- */
917
- target?: LinkTarget;
918
- /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
919
- rel?: Rel;
920
- /** A serialized object used for a custom or external link panel. */
921
- customData?: string | null;
922
- }
923
- /** @oneof */
924
- export interface LinkDataOneOf {
925
- /** The absolute URL for the linked document. */
926
- url?: string;
927
- /** The target node's ID. Used for linking to another node in this object. */
928
- anchor?: string;
929
- }
930
- export declare enum LinkTarget {
931
- /** Opens the linked document in the same frame as it was clicked (this is default) */
932
- SELF = "SELF",
933
- /** Opens the linked document in a new window or tab */
934
- BLANK = "BLANK",
935
- /** Opens the linked document in the parent frame */
936
- PARENT = "PARENT",
937
- /** Opens the linked document in the full body of the window */
938
- TOP = "TOP"
939
- }
940
- export interface Rel {
941
- /** Indicates to search engine crawlers not to follow the link. */
942
- nofollow?: boolean | null;
943
- /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. */
944
- sponsored?: boolean | null;
945
- /** Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. */
946
- ugc?: boolean | null;
947
- /** Indicates that this link protect referral information from being passed to the target website. */
948
- noreferrer?: boolean | null;
949
- }
950
- export interface CodeBlockData {
951
- /** Styling for the code block's text. */
952
- textStyle?: TextStyle;
953
- }
954
- export interface TextStyle {
955
- /** Text alignment. Defaults to `AUTO`. */
956
- textAlignment?: TextAlignment;
957
- /** A CSS `line-height` value for the text as a unitless ratio. */
958
- lineHeight?: string | null;
959
- }
960
- export declare enum TextAlignment {
961
- /** browser default, eqivalent to `initial` */
962
- AUTO = "AUTO",
963
- /** Left align */
964
- LEFT = "LEFT",
965
- /** Right align */
966
- RIGHT = "RIGHT",
967
- /** Center align */
968
- CENTER = "CENTER",
969
- /** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line. */
970
- JUSTIFY = "JUSTIFY"
971
- }
972
- export interface DividerData {
973
- /** Styling for the divider's container. */
974
- containerData?: PluginContainerData;
975
- /** Divider line style. */
976
- lineStyle?: LineStyle;
977
- /** Divider width. */
978
- width?: Width;
979
- /** Divider alignment. */
980
- alignment?: Alignment;
981
- }
982
- export declare enum LineStyle {
983
- /** Single Line */
984
- SINGLE = "SINGLE",
985
- /** Double Line */
986
- DOUBLE = "DOUBLE",
987
- /** Dashed Line */
988
- DASHED = "DASHED",
989
- /** Dotted Line */
990
- DOTTED = "DOTTED"
991
- }
992
- export declare enum Width {
993
- /** Large line */
994
- LARGE = "LARGE",
995
- /** Medium line */
996
- MEDIUM = "MEDIUM",
997
- /** Small line */
998
- SMALL = "SMALL"
999
- }
1000
- export declare enum Alignment {
1001
- /** Center alignment */
1002
- CENTER = "CENTER",
1003
- /** Left alignment */
1004
- LEFT = "LEFT",
1005
- /** Right alignment */
1006
- RIGHT = "RIGHT"
1007
- }
1008
- export interface FileData {
1009
- /** Styling for the file's container. */
1010
- containerData?: PluginContainerData;
1011
- /** The source for the file's data. */
1012
- src?: FileSource;
1013
- /** File name. */
1014
- name?: string | null;
1015
- /** File type. */
1016
- type?: string | null;
1017
- /** File size in KB. */
1018
- size?: number | null;
1019
- /** Settings for PDF files. */
1020
- pdfSettings?: PDFSettings;
1021
- /** File MIME type. */
1022
- mimeType?: string | null;
1023
- /** File path. */
1024
- path?: string | null;
1025
- }
1026
- export declare enum ViewMode {
1027
- /** No PDF view */
1028
- NONE = "NONE",
1029
- /** Full PDF view */
1030
- FULL = "FULL",
1031
- /** Mini PDF view */
1032
- MINI = "MINI"
1033
- }
1034
- export interface FileSource extends FileSourceDataOneOf {
1035
- /** The absolute URL for the file's source. */
1036
- url?: string | null;
1037
- /** Custom ID. Use `id` instead. */
1038
- custom?: string | null;
1039
- /** An ID that's resolved to a URL by a resolver function. */
1040
- _id?: string | null;
1041
- /** Indicates whether the file's source is private. */
1042
- private?: boolean | null;
1043
- }
1044
- /** @oneof */
1045
- export interface FileSourceDataOneOf {
1046
- /** The absolute URL for the file's source. */
1047
- url?: string | null;
1048
- /** Custom ID. Use `id` instead. */
1049
- custom?: string | null;
1050
- /** An ID that's resolved to a URL by a resolver function. */
1051
- _id?: string | null;
1052
- }
1053
- export interface PDFSettings {
1054
- /**
1055
- * PDF view mode. One of the following:
1056
- * `NONE` : The PDF isn't displayed.
1057
- * `FULL` : A full page view of the PDF is displayed.
1058
- * `MINI` : A mini view of the PDF is displayed.
1059
- */
1060
- viewMode?: ViewMode;
1061
- /** Sets whether the PDF download button is disabled. */
1062
- disableDownload?: boolean | null;
1063
- /** Sets whether the PDF print button is disabled. */
1064
- disablePrint?: boolean | null;
1065
- }
1066
- export interface GalleryData {
1067
- /** Styling for the gallery's container. */
1068
- containerData?: PluginContainerData;
1069
- /** The items in the gallery. */
1070
- items?: Item[];
1071
- /** Options for defining the gallery's appearance. */
1072
- options?: GalleryOptions;
1073
- /** Sets whether the gallery's expand button is disabled. */
1074
- disableExpand?: boolean | null;
1075
- /** Sets whether the gallery's download button is disabled. */
1076
- disableDownload?: boolean | null;
1077
- }
1078
- export interface Media {
1079
- /** The source for the media's data. */
1080
- src?: FileSource;
1081
- /** Media width in pixels. */
1082
- width?: number | null;
1083
- /** Media height in pixels. */
1084
- height?: number | null;
1085
- /** Media duration in seconds. Only relevant for audio and video files. */
1086
- duration?: number | null;
1087
- }
1088
- export interface Image {
1089
- /** Image file details. */
1090
- media?: Media;
1091
- /** Link details for images that are links. */
1092
- link?: Link;
1093
- }
1094
- export interface Video {
1095
- /** Video file details. */
1096
- media?: Media;
1097
- /** Video thumbnail file details. */
1098
- thumbnail?: Media;
1099
- }
1100
- export interface Item extends ItemDataOneOf {
1101
- /** An image item. */
1102
- image?: Image;
1103
- /** A video item. */
1104
- video?: Video;
1105
- /** Item title. */
1106
- title?: string | null;
1107
- /** Item's alternative text. */
1108
- altText?: string | null;
1109
- }
1110
- /** @oneof */
1111
- export interface ItemDataOneOf {
1112
- /** An image item. */
1113
- image?: Image;
1114
- /** A video item. */
1115
- video?: Video;
1116
- }
1117
- export interface GalleryOptions {
1118
- /** Gallery layout. */
1119
- layout?: Layout;
1120
- /** Styling for gallery items. */
1121
- item?: ItemStyle;
1122
- /** Styling for gallery thumbnail images. */
1123
- thumbnails?: Thumbnails;
1124
- }
1125
- export declare enum LayoutType {
1126
- /** Collage type */
1127
- COLLAGE = "COLLAGE",
1128
- /** Masonry type */
1129
- MASONRY = "MASONRY",
1130
- /** Grid type */
1131
- GRID = "GRID",
1132
- /** Thumbnail type */
1133
- THUMBNAIL = "THUMBNAIL",
1134
- /** Slider type */
1135
- SLIDER = "SLIDER",
1136
- /** Slideshow type */
1137
- SLIDESHOW = "SLIDESHOW",
1138
- /** Panorama type */
1139
- PANORAMA = "PANORAMA",
1140
- /** Column type */
1141
- COLUMN = "COLUMN",
1142
- /** Magic type */
1143
- MAGIC = "MAGIC",
1144
- /** Fullsize images type */
1145
- FULLSIZE = "FULLSIZE"
1146
- }
1147
- export declare enum Orientation {
1148
- /** Rows Orientation */
1149
- ROWS = "ROWS",
1150
- /** Columns Orientation */
1151
- COLUMNS = "COLUMNS"
1152
- }
1153
- export declare enum Crop {
1154
- /** Crop to fill */
1155
- FILL = "FILL",
1156
- /** Crop to fit */
1157
- FIT = "FIT"
1158
- }
1159
- export declare enum ThumbnailsAlignment {
1160
- /** Top alignment */
1161
- TOP = "TOP",
1162
- /** Right alignment */
1163
- RIGHT = "RIGHT",
1164
- /** Bottom alignment */
1165
- BOTTOM = "BOTTOM",
1166
- /** Left alignment */
1167
- LEFT = "LEFT",
1168
- /** No thumbnail */
1169
- NONE = "NONE"
1170
- }
1171
- export interface Layout {
1172
- /** Gallery layout type. */
1173
- type?: LayoutType;
1174
- /** Sets whether horizontal scroll is enabled. */
1175
- horizontalScroll?: boolean | null;
1176
- /** Gallery orientation. */
1177
- orientation?: Orientation;
1178
- /** The number of columns to display on full size screens. */
1179
- numberOfColumns?: number | null;
1180
- /** The number of columns to display on mobile screens. */
1181
- mobileNumberOfColumns?: number | null;
1182
- }
1183
- export interface ItemStyle {
1184
- /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
1185
- targetSize?: number | null;
1186
- /** Item ratio */
1187
- ratio?: number | null;
1188
- /** Sets how item images are cropped. */
1189
- crop?: Crop;
1190
- /** The spacing between items in pixels. */
1191
- spacing?: number | null;
1192
- }
1193
- export interface Thumbnails {
1194
- /** Thumbnail alignment. */
1195
- placement?: ThumbnailsAlignment;
1196
- /** Spacing between thumbnails in pixels. */
1197
- spacing?: number | null;
1198
- }
1199
- export interface GIFData {
1200
- /** Styling for the GIF's container. */
1201
- containerData?: PluginContainerData;
1202
- /** The source of the full size GIF. */
1203
- original?: GIF;
1204
- /** The source of the downsized GIF. */
1205
- downsized?: GIF;
1206
- /** Height in pixels. */
1207
- height?: number;
1208
- /** Width in pixels. */
1209
- width?: number;
1210
- }
1211
- export interface GIF {
1212
- /** GIF format URL. */
1213
- gif?: string | null;
1214
- /** MP4 format URL. */
1215
- mp4?: string | null;
1216
- /** Thumbnail URL. */
1217
- still?: string | null;
1218
- }
1219
- export interface HeadingData {
1220
- /** Heading level from 1-6. */
1221
- level?: number;
1222
- /** Styling for the heading text. */
1223
- textStyle?: TextStyle;
1224
- /** Indentation level from 1-6. */
1225
- indentation?: number | null;
1226
- }
1227
- export interface HTMLData extends HTMLDataDataOneOf {
1228
- /** The URL for the HTML code for the node. */
1229
- url?: string;
1230
- /** The HTML code for the node. */
1231
- html?: string;
1232
- /** Whether this is an AdSense element. Use `source` instead. */
1233
- isAdsense?: boolean | null;
1234
- /** Styling for the HTML node's container. */
1235
- containerData?: PluginContainerData;
1236
- /** The type of HTML code. */
1237
- source?: Source;
1238
- }
1239
- /** @oneof */
1240
- export interface HTMLDataDataOneOf {
1241
- /** The URL for the HTML code for the node. */
1242
- url?: string;
1243
- /** The HTML code for the node. */
1244
- html?: string;
1245
- /** Whether this is an AdSense element. Use `source` instead. */
1246
- isAdsense?: boolean | null;
1247
- }
1248
- export declare enum Source {
1249
- HTML = "HTML",
1250
- ADSENSE = "ADSENSE"
1251
- }
1252
- export interface ImageData {
1253
- /** Styling for the image's container. */
1254
- containerData?: PluginContainerData;
1255
- /** Image file details. */
1256
- image?: Media;
1257
- /** Link details for images that are links. */
1258
- link?: Link;
1259
- /** Sets whether the image expands to full screen when clicked. */
1260
- disableExpand?: boolean | null;
1261
- /** Image's alternative text. */
1262
- altText?: string | null;
1263
- /** Image caption. */
1264
- caption?: string | null;
1265
- /** Sets whether the image's download button is disabled. */
1266
- disableDownload?: boolean | null;
1267
- }
1268
- export interface LinkPreviewData {
1269
- /** Styling for the link preview's container. */
1270
- containerData?: PluginContainerData;
1271
- /** Link details. */
1272
- link?: Link;
1273
- /** Preview title. */
1274
- title?: string | null;
1275
- /** Preview thumbnail URL. */
1276
- thumbnailUrl?: string | null;
1277
- /** Preview description. */
1278
- description?: string | null;
1279
- /** The preview content as HTML. */
1280
- html?: string | null;
1281
- }
1282
- export interface MapData {
1283
- /** Styling for the map's container. */
1284
- containerData?: PluginContainerData;
1285
- /** Map settings. */
1286
- mapSettings?: MapSettings;
1287
- }
1288
- export interface MapSettings {
1289
- /** The address to display on the map. */
1290
- address?: string | null;
1291
- /** Sets whether the map is draggable. */
1292
- draggable?: boolean | null;
1293
- /** Sets whether the location marker is visible. */
1294
- marker?: boolean | null;
1295
- /** Sets whether street view control is enabled. */
1296
- streetViewControl?: boolean | null;
1297
- /** Sets whether zoom control is enabled. */
1298
- zoomControl?: boolean | null;
1299
- /** Location latitude. */
1300
- lat?: number | null;
1301
- /** Location longitude. */
1302
- lng?: number | null;
1303
- /** Location name. */
1304
- locationName?: string | null;
1305
- /** Sets whether view mode control is enabled. */
1306
- viewModeControl?: boolean | null;
1307
- /** Initial zoom value. */
1308
- initialZoom?: number | null;
1309
- /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
1310
- mapType?: MapType;
1311
- }
1312
- export declare enum MapType {
1313
- /** Roadmap map type */
1314
- ROADMAP = "ROADMAP",
1315
- /** Satellite map type */
1316
- SATELITE = "SATELITE",
1317
- /** Hybrid map type */
1318
- HYBRID = "HYBRID",
1319
- /** Terrain map type */
1320
- TERRAIN = "TERRAIN"
1321
- }
1322
- export interface ParagraphData {
1323
- /** Styling for the paragraph text. */
1324
- textStyle?: TextStyle;
1325
- /** Indentation level from 1-6. */
1326
- indentation?: number | null;
1327
- }
1328
- export interface PollData {
1329
- /** Styling for the poll's container. */
1330
- containerData?: PluginContainerData;
1331
- /** Poll data. */
1332
- poll?: Poll;
1333
- /** Layout settings for the poll and voting options. */
1334
- layout?: PollDataLayout;
1335
- /** Styling for the poll and voting options. */
1336
- design?: Design;
1337
- }
1338
- export declare enum ViewRole {
1339
- /** Only Poll creator can view the results */
1340
- CREATOR = "CREATOR",
1341
- /** Anyone who voted can see the results */
1342
- VOTERS = "VOTERS",
1343
- /** Anyone can see the results, even if one didn't vote */
1344
- EVERYONE = "EVERYONE"
1345
- }
1346
- export declare enum VoteRole {
1347
- /** Logged in member */
1348
- SITE_MEMBERS = "SITE_MEMBERS",
1349
- /** Anyone */
1350
- ALL = "ALL"
1351
- }
1352
- export interface Permissions {
1353
- /** Sets who can view the poll results. */
1354
- view?: ViewRole;
1355
- /** Sets who can vote. */
1356
- vote?: VoteRole;
1357
- /** Sets whether one voter can vote multiple times. */
1358
- allowMultipleVotes?: boolean | null;
1359
- }
1360
- export interface PollOption {
1361
- /** Option ID. */
1362
- _id?: string | null;
1363
- /** Option title. */
1364
- title?: string | null;
1365
- /** The image displayed with the option. */
1366
- image?: Media;
1367
- }
1368
- export interface Settings {
1369
- /** Permissions settings for voting. */
1370
- permissions?: Permissions;
1371
- /** Sets whether voters are displayed in the vote results. */
1372
- showVoters?: boolean | null;
1373
- /** Sets whether the vote count is displayed. */
1374
- showVotesCount?: boolean | null;
1375
- }
1376
- export declare enum PollLayoutType {
1377
- /** List */
1378
- LIST = "LIST",
1379
- /** Grid */
1380
- GRID = "GRID"
1381
- }
1382
- export declare enum PollLayoutDirection {
1383
- /** Left-to-right */
1384
- LTR = "LTR",
1385
- /** Right-to-left */
1386
- RTL = "RTL"
1387
- }
1388
- export interface PollLayout {
1389
- /** The layout for displaying the voting options. */
1390
- type?: PollLayoutType;
1391
- /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
1392
- direction?: PollLayoutDirection;
1393
- /** Sets whether to display the main poll image. */
1394
- enableImage?: boolean | null;
1395
- }
1396
- export interface OptionLayout {
1397
- /** Sets whether to display option images. */
1398
- enableImage?: boolean | null;
1399
- }
1400
- export declare enum BackgroundType {
1401
- /** Color background type */
1402
- COLOR = "COLOR",
1403
- /** Image background type */
1404
- IMAGE = "IMAGE",
1405
- /** Gradiant background type */
1406
- GRADIENT = "GRADIENT"
1407
- }
1408
- export interface Gradient {
1409
- /** The gradient angle in degrees. */
1410
- angle?: number | null;
1411
- /** The start color as a hexademical value. */
1412
- startColor?: string | null;
1413
- /** The end color as a hexademical value. */
1414
- lastColor?: string | null;
1415
- }
1416
- export interface Background extends BackgroundBackgroundOneOf {
1417
- /** The background color as a hexademical value. */
1418
- color?: string | null;
1419
- /** An image to use for the background. */
1420
- image?: Media;
1421
- /** Details for a gradient background. */
1422
- gradient?: Gradient;
1423
- /** Background type. For each option, include the relevant details. */
1424
- type?: BackgroundType;
1425
- }
1426
- /** @oneof */
1427
- export interface BackgroundBackgroundOneOf {
1428
- /** The background color as a hexademical value. */
1429
- color?: string | null;
1430
- /** An image to use for the background. */
1431
- image?: Media;
1432
- /** Details for a gradient background. */
1433
- gradient?: Gradient;
1434
- }
1435
- export interface PollDesign {
1436
- /** Background styling. */
1437
- background?: Background;
1438
- /** Border radius in pixels. */
1439
- borderRadius?: number | null;
1440
- }
1441
- export interface OptionDesign {
1442
- /** Border radius in pixels. */
1443
- borderRadius?: number | null;
1444
- }
1445
- export interface Poll {
1446
- /** Poll ID. */
1447
- _id?: string | null;
1448
- /** Poll title. */
1449
- title?: string | null;
1450
- /** Poll creator ID. */
1451
- creatorId?: string | null;
1452
- /** Main poll image. */
1453
- image?: Media;
1454
- /** Voting options. */
1455
- options?: PollOption[];
1456
- /** The poll's permissions and display settings. */
1457
- settings?: Settings;
1458
- }
1459
- export interface PollDataLayout {
1460
- /** Poll layout settings. */
1461
- poll?: PollLayout;
1462
- /** Voting otpions layout settings. */
1463
- options?: OptionLayout;
1464
- }
1465
- export interface Design {
1466
- /** Styling for the poll. */
1467
- poll?: PollDesign;
1468
- /** Styling for voting options. */
1469
- options?: OptionDesign;
1470
- }
1471
- export interface TextData {
1472
- /** The text to apply decorations to. */
1473
- text?: string;
1474
- /** The decorations to apply. */
1475
- decorations?: Decoration[];
1476
- }
1477
- /** Adds appearence changes to text */
1478
- export interface Decoration extends DecorationDataOneOf {
1479
- /** Data for an anchor link decoration. */
1480
- anchorData?: AnchorData;
1481
- /** Data for a color decoration. */
1482
- colorData?: ColorData;
1483
- /** Data for an external link decoration. */
1484
- linkData?: LinkData;
1485
- /** Data for a mention decoration. */
1486
- mentionData?: MentionData;
1487
- /** Data for a font size decoration. */
1488
- fontSizeData?: FontSizeData;
1489
- /** Font weight for a bold decoration. */
1490
- fontWeightValue?: number | null;
1491
- /** Data for an italic decoration. */
1492
- italicData?: boolean | null;
1493
- /** Data for an underline decoration. */
1494
- underlineData?: boolean | null;
1495
- /** The type of decoration to apply. */
1496
- type?: DecorationType;
1497
- }
1498
- /** @oneof */
1499
- export interface DecorationDataOneOf {
1500
- /** Data for an anchor link decoration. */
1501
- anchorData?: AnchorData;
1502
- /** Data for a color decoration. */
1503
- colorData?: ColorData;
1504
- /** Data for an external link decoration. */
1505
- linkData?: LinkData;
1506
- /** Data for a mention decoration. */
1507
- mentionData?: MentionData;
1508
- /** Data for a font size decoration. */
1509
- fontSizeData?: FontSizeData;
1510
- /** Font weight for a bold decoration. */
1511
- fontWeightValue?: number | null;
1512
- /** Data for an italic decoration. */
1513
- italicData?: boolean | null;
1514
- /** Data for an underline decoration. */
1515
- underlineData?: boolean | null;
1516
- }
1517
- export declare enum DecorationType {
1518
- BOLD = "BOLD",
1519
- ITALIC = "ITALIC",
1520
- UNDERLINE = "UNDERLINE",
1521
- SPOILER = "SPOILER",
1522
- ANCHOR = "ANCHOR",
1523
- MENTION = "MENTION",
1524
- LINK = "LINK",
1525
- COLOR = "COLOR",
1526
- FONT_SIZE = "FONT_SIZE",
1527
- EXTERNAL = "EXTERNAL"
1528
- }
1529
- export interface AnchorData {
1530
- /** The target node's ID. */
1531
- anchor?: string;
1532
- }
1533
- export interface ColorData {
1534
- /** The text's background color as a hexadecimal value. */
1535
- background?: string | null;
1536
- /** The text's foreground color as a hexadecimal value. */
1537
- foreground?: string | null;
1538
- }
1539
- export interface LinkData {
1540
- /** Link details. */
1541
- link?: Link;
1542
- }
1543
- export interface MentionData {
1544
- /** The mentioned user's name. */
1545
- name?: string;
1546
- /** The version of the user's name that appears after the `@` character in the mention. */
1547
- slug?: string;
1548
- /** Mentioned user's ID. */
1549
- _id?: string | null;
1550
- }
1551
- export interface FontSizeData {
1552
- /** The units used for the font size. */
1553
- unit?: FontType;
1554
- /** Font size value. */
1555
- value?: number | null;
1556
- }
1557
- export declare enum FontType {
1558
- PX = "PX",
1559
- EM = "EM"
1560
- }
1561
- export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1562
- /** Data for embedded Wix Bookings content. */
1563
- bookingData?: BookingData;
1564
- /** Data for embedded Wix Events content. */
1565
- eventData?: EventData;
1566
- /** The type of Wix App content being embedded. */
1567
- type?: AppType;
1568
- /** The ID of the embedded content. */
1569
- itemId?: string | null;
1570
- /** The name of the embedded content. */
1571
- name?: string | null;
1572
- /** Deprecated: Use `image` instead. */
1573
- imageSrc?: string | null;
1574
- /** The URL for the embedded content. */
1575
- url?: string | null;
1576
- /** An image for the embedded content. */
1577
- image?: Media;
1578
- }
1579
- /** @oneof */
1580
- export interface AppEmbedDataAppDataOneOf {
1581
- /** Data for embedded Wix Bookings content. */
1582
- bookingData?: BookingData;
1583
- /** Data for embedded Wix Events content. */
1584
- eventData?: EventData;
1585
- }
1586
- export declare enum AppType {
1587
- PRODUCT = "PRODUCT",
1588
- EVENT = "EVENT",
1589
- BOOKING = "BOOKING"
1590
- }
1591
- export interface BookingData {
1592
- /** Booking duration in minutes. */
1593
- durations?: string | null;
1594
- }
1595
- export interface EventData {
1596
- /** Event schedule. */
1597
- scheduling?: string | null;
1598
- /** Event location. */
1599
- location?: string | null;
1600
- }
1601
- export interface VideoData {
1602
- /** Styling for the video's container. */
1603
- containerData?: PluginContainerData;
1604
- /** Video details. */
1605
- video?: Media;
1606
- /** Video thumbnail details. */
1607
- thumbnail?: Media;
1608
- /** Sets whether the video's download button is disabled. */
1609
- disableDownload?: boolean | null;
1610
- /** Video title. */
1611
- title?: string | null;
1612
- /** Video options. */
1613
- options?: PlaybackOptions;
1614
- }
1615
- export interface PlaybackOptions {
1616
- /** Sets whether the media will automatically start playing. */
1617
- autoPlay?: boolean | null;
1618
- /** Sets whether media's will be looped. */
1619
- playInLoop?: boolean | null;
1620
- /** Sets whether media's controls will be shown. */
1621
- showControls?: boolean | null;
1622
- }
1623
- export interface EmbedData {
1624
- /** Styling for the oEmbed node's container. */
1625
- containerData?: PluginContainerData;
1626
- /** An [oEmbed](https://www.oembed.com) object. */
1627
- oembed?: Oembed;
1628
- /** Origin asset source. */
1629
- src?: string | null;
1630
- }
1631
- export interface Oembed {
1632
- /** The resource type. */
1633
- type?: string | null;
1634
- /** The width of the resource specified in the `url` property in pixels. */
1635
- width?: number | null;
1636
- /** The height of the resource specified in the `url` property in pixels. */
1637
- height?: number | null;
1638
- /** Resource title. */
1639
- title?: string | null;
1640
- /** The source URL for the resource. */
1641
- url?: string | null;
1642
- /** HTML for embedding a video player. The HTML should have no padding or margins. */
1643
- html?: string | null;
1644
- /** The name of the author or owner of the resource. */
1645
- authorName?: string | null;
1646
- /** The URL for the author or owner of the resource. */
1647
- authorUrl?: string | null;
1648
- /** The name of the resource provider. */
1649
- providerName?: string | null;
1650
- /** The URL for the resource provider. */
1651
- providerUrl?: string | null;
1652
- /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
1653
- thumbnailUrl?: string | null;
1654
- /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
1655
- thumbnailWidth?: string | null;
1656
- /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
1657
- thumbnailHeight?: string | null;
1658
- /** The URL for an embedded viedo. */
1659
- videoUrl?: string | null;
1660
- /** The oEmbed version number. This value must be `1.0`. */
1661
- version?: string | null;
1662
- }
1663
- export interface CollapsibleListData {
1664
- /** Styling for the collapsible list's container. */
1665
- containerData?: PluginContainerData;
1666
- /** If `true`, only one item can be expanded at a time. */
1667
- expandOnlyOne?: boolean | null;
1668
- /** Sets which items are expanded when the page loads. */
1669
- initialExpandedItems?: InitialExpandedItems;
1670
- /** The direction of the text in the list. Either left-to-right or right-to-left. */
1671
- direction?: Direction;
1672
- /** If `true`, The collapsible item will appear in search results as an FAQ. */
1673
- isQapageData?: boolean | null;
1674
- }
1675
- export declare enum InitialExpandedItems {
1676
- /** First item will be expended initally */
1677
- FIRST = "FIRST",
1678
- /** All items will expended initally */
1679
- ALL = "ALL",
1680
- /** All items collapsed initally */
1681
- NONE = "NONE"
1682
- }
1683
- export declare enum Direction {
1684
- /** Left-to-right */
1685
- LTR = "LTR",
1686
- /** Right-to-left */
1687
- RTL = "RTL"
1688
- }
1689
- export interface TableData {
1690
- /** Styling for the table's container. */
1691
- containerData?: PluginContainerData;
1692
- /** The table's dimensions. */
1693
- dimensions?: Dimensions;
1694
- /** Deprecated: Use `rowHeader` and `columnHeader` instead. */
1695
- header?: boolean | null;
1696
- /** Sets whether the table's first row is a header. */
1697
- rowHeader?: boolean | null;
1698
- /** Sets whether the table's first column is a header. */
1699
- columnHeader?: boolean | null;
1700
- }
1701
- export interface Dimensions {
1702
- /** An array representing relative width of each column in relation to the other columns. */
1703
- colsWidthRatio?: number[];
1704
- /** An array representing the height of each row in pixels. */
1705
- rowsHeight?: number[];
1706
- /** An array representing the minimum width of each column in pixels. */
1707
- colsMinWidth?: number[];
1708
- }
1709
- export interface TableCellData {
1710
- /** Styling for the cell's background color and text alignment. */
1711
- cellStyle?: CellStyle;
1712
- /** The cell's border colors. */
1713
- borderColors?: BorderColors;
1714
- }
1715
- export declare enum VerticalAlignment {
1716
- /** Top alignment */
1717
- TOP = "TOP",
1718
- /** Middle alignment */
1719
- MIDDLE = "MIDDLE",
1720
- /** Bottom alignment */
1721
- BOTTOM = "BOTTOM"
1722
- }
1723
- export interface CellStyle {
1724
- /** Vertical alignment for the cell's text. */
1725
- verticalAlignment?: VerticalAlignment;
1726
- /** Cell background color as a hexadecimal value. */
1727
- backgroundColor?: string | null;
1728
- }
1729
- export interface BorderColors {
1730
- /** Left border color as a hexadecimal value. */
1731
- left?: string | null;
1732
- /** Right border color as a hexadecimal value. */
1733
- right?: string | null;
1734
- /** Top border color as a hexadecimal value. */
1735
- top?: string | null;
1736
- /** Bottom border color as a hexadecimal value. */
1737
- bottom?: string | null;
1738
- }
1739
- /**
1740
- * `NullValue` is a singleton enumeration to represent the null value for the
1741
- * `Value` type union.
1742
- *
1743
- * The JSON representation for `NullValue` is JSON `null`.
1744
- */
1745
- export declare enum NullValue {
1746
- /** Null value. */
1747
- NULL_VALUE = "NULL_VALUE"
1748
- }
1749
- /**
1750
- * `ListValue` is a wrapper around a repeated field of values.
1751
- *
1752
- * The JSON representation for `ListValue` is JSON array.
1753
- */
1754
- export interface ListValue {
1755
- /** Repeated field of dynamically typed values. */
1756
- values?: any[];
1757
- }
1758
- export interface AudioData {
1759
- /** Styling for the audio node's container. */
1760
- containerData?: PluginContainerData;
1761
- /** Audio file details. */
1762
- audio?: Media;
1763
- /** Sets whether the audio node's download button is disabled. */
1764
- disableDownload?: boolean | null;
1765
- /** Cover image. */
1766
- coverImage?: Media;
1767
- /** Track name. */
1768
- name?: string | null;
1769
- /** Author name. */
1770
- authorName?: string | null;
1771
- /** An HTML version of the audio node. */
1772
- html?: string | null;
1773
- }
1774
- export interface OrderedListData {
1775
- /** Indentation level. */
1776
- indentation?: number;
1777
- }
1778
- export interface BulletedListData {
1779
- /** Indentation level. */
1780
- indentation?: number;
1781
- }
1782
- export interface BlockquoteData {
1783
- /** Indentation level. */
1784
- indentation?: number;
1785
- }
1786
- export interface Metadata {
1787
- /** Schema version. */
1788
- version?: number;
1789
- /**
1790
- * When the object was created.
1791
- * @readonly
1792
- */
1793
- createdTimestamp?: Date;
1794
- /** When the object was most recently updated. */
1795
- updatedTimestamp?: Date;
1796
- /** Object ID. */
1797
- _id?: string | null;
1798
- }
1799
- export interface DocumentStyle {
1800
- /** Styling for H1 nodes. */
1801
- headerOne?: TextNodeStyle;
1802
- /** Styling for H2 nodes. */
1803
- headerTwo?: TextNodeStyle;
1804
- /** Styling for H3 nodes. */
1805
- headerThree?: TextNodeStyle;
1806
- /** Styling for H4 nodes. */
1807
- headerFour?: TextNodeStyle;
1808
- /** Styling for H5 nodes. */
1809
- headerFive?: TextNodeStyle;
1810
- /** Styling for H6 nodes. */
1811
- headerSix?: TextNodeStyle;
1812
- /** Styling for paragraph nodes. */
1813
- paragraph?: TextNodeStyle;
1814
- /** Styling for block quote nodes. */
1815
- blockquote?: TextNodeStyle;
1816
- /** Styling for code block nodes. */
1817
- codeBlock?: TextNodeStyle;
1818
- }
1819
- export interface TextNodeStyle {
1820
- /** The decorations to apply to the node. */
1821
- decorations?: Decoration[];
1822
- /** Padding and background color for the node. */
1823
- nodeStyle?: NodeStyle;
1824
- /** Line height for text in the node. */
1825
- lineHeight?: string | null;
1826
- }
1827
- export interface RadioGroup {
1828
- /** Label of the field */
1829
- label?: string | null;
1830
- /** Description of the field */
1831
- description?: RichContent;
1832
- /**
1833
- * Flag identifying to show option allowing input custom value
1834
- * List of options to select from
1835
- */
1836
- options?: RadioGroupOption[];
1837
- /**
1838
- * Flag identifying to hide or not label
1839
- * Default: true
1840
- */
1841
- showLabel?: boolean | null;
1842
- /** Option which can be specified by UoU, enabled when this object is specified. */
1843
- customOption?: RadioGroupCustomOption;
1844
- }
1845
- export interface RadioGroupOption {
1846
- /** Selectable option label */
1847
- label?: string | null;
1848
- /** Selectable option value, which is saved to DB. */
1849
- value?: string | null;
1850
- /** Flag identifying that option should be selected by default */
1851
- default?: boolean;
1852
- /** Option id. Used as binding for translations */
1853
- _id?: string;
1854
- }
1855
- export interface RadioGroupCustomOption {
1856
- /** Label of custom option input */
1857
- label?: string | null;
1858
- /** Placeholder of custom option input */
1859
- placeholder?: string | null;
1860
- }
1861
- export interface Dropdown {
1862
- /** Label of the field */
1863
- label?: string | null;
1864
- /** Description of the field */
1865
- description?: RichContent;
1866
- /** List of options to select from */
1867
- options?: DropdownOption[];
1868
- /**
1869
- * Flag identifying to hide or not label
1870
- * Default: true
1871
- */
1872
- showLabel?: boolean | null;
1873
- /** Option which can be specified by UoU, enabled when this object is specified. */
1874
- customOption?: DropdownCustomOption;
1875
- /** Placeholder of dropdown input */
1876
- placeholder?: string | null;
1877
- }
1878
- export interface DropdownOption {
1879
- /** Selectable option label */
1880
- label?: string | null;
1881
- /** Selectable option value, which is saved to DB. */
1882
- value?: string | null;
1883
- /** Flag identifying that option should be selected by default */
1884
- default?: boolean;
1885
- /** Option id. Used as binding for translations */
1886
- _id?: string;
1887
- }
1888
- export interface DropdownCustomOption {
1889
- /** Label of custom option input */
1890
- label?: string | null;
1891
- /** Placeholder of custom option input */
1892
- placeholder?: string | null;
1893
- }
1894
- export interface DateTimeInput extends DateTimeInputDateTimeInputTypeOptionsOneOf {
1895
- /** Options specific to the combined Date and Time input type. */
1896
- dateTimeOptions?: DateTimeOptions;
1897
- /** Options specific to the Date-only input type. */
1898
- dateOptions?: DateOptions;
1899
- /** Options specific to the Time-only input type. */
1900
- timeOptions?: TimeOptions;
1901
- /** Label of the field. Displayed text for the date/time input. */
1902
- label?: string | null;
1903
- /** Description of the field. Additional information about the date/time input. */
1904
- description?: RichContent;
1905
- /**
1906
- * Flag identifying whether to show or hide the label.
1907
- * Default: true
1908
- */
1909
- showLabel?: boolean | null;
1910
- /**
1911
- * Flag identifying whether to show or hide the placeholder.
1912
- * Default: true
1913
- */
1914
- showPlaceholder?: boolean | null;
1915
- /**
1916
- * Date and/or time input component type
1917
- * @readonly
1918
- */
1919
- dateTimeInputType?: DateTimeInputType;
1920
- }
1921
- /** @oneof */
1922
- export interface DateTimeInputDateTimeInputTypeOptionsOneOf {
1923
- /** Options specific to the combined Date and Time input type. */
1924
- dateTimeOptions?: DateTimeOptions;
1925
- /** Options specific to the Date-only input type. */
1926
- dateOptions?: DateOptions;
1927
- /** Options specific to the Time-only input type. */
1928
- timeOptions?: TimeOptions;
1929
- }
1930
- export declare enum DateFormatPart {
1931
- YEAR = "YEAR",
1932
- MONTH = "MONTH",
1933
- DAY = "DAY"
1934
- }
1935
- export declare enum DateTimeInputType {
1936
- UNKNOWN = "UNKNOWN",
1937
- /** Show date and time input */
1938
- DATE_TIME = "DATE_TIME",
1939
- /** Show only date input */
1940
- DATE = "DATE",
1941
- /** Show only time input */
1942
- TIME = "TIME"
1943
- }
1944
- export interface DateTimeOptions {
1945
- /** Order of date picking component parts (e.g., YEAR, MONTH, DAY). */
1946
- dateFormatParts?: DateFormatPart[];
1947
- /**
1948
- * Flag indicating whether to use the 24-hour time format.
1949
- * Default: false.
1950
- */
1951
- use24HourFormat?: boolean;
1952
- }
1953
- export interface DateOptions {
1954
- /** Order of date picking component parts (e.g., YEAR, MONTH, DAY). */
1955
- dateFormatParts?: DateFormatPart[];
1956
- }
1957
- export interface TimeOptions {
1958
- /**
1959
- * Flag indicating whether to use the 24-hour time format.
1960
- * Default: false.
1961
- */
1962
- use24HourFormat?: boolean;
1963
- }
1964
- export interface InputFieldNumberType {
1965
- /** Inclusive maximum value. */
1966
- maximum?: number | null;
1967
- /** Inclusive minimum value. */
1968
- minimum?: number | null;
1969
- /** Multiple of value. */
1970
- multipleOf?: number | null;
1971
- /** Custom error message when validation fails. */
1972
- errorMessages?: InputFieldNumberErrorMessages;
1973
- /** List of allowed values. */
1974
- enum?: number[] | null;
1975
- }
1976
- export interface InputFieldNumberErrorMessages {
1977
- /** Default error message on invalid validation. */
1978
- default?: string | null;
1979
- }
1980
- export declare enum NumberComponentType {
1981
- UNKNOWN = "UNKNOWN",
1982
- NUMBER_INPUT = "NUMBER_INPUT"
1983
- }
1984
- export interface NumberInput {
1985
- /** Label of the field */
1986
- label?: string | null;
1987
- /** Description of the field */
1988
- description?: RichContent;
1989
- /** Placeholder for the value input */
1990
- placeholder?: string | null;
1991
- /**
1992
- * Flag identifying to hide or not label
1993
- * Default: true
1994
- */
1995
- showLabel?: boolean | null;
1996
- }
1997
- export interface InputFieldBooleanType {
1998
- /** Custom error message when validation fails. */
1999
- errorMessages?: InputFieldBooleanErrorMessages;
2000
- /** List of allowed values. */
2001
- enum?: boolean[];
2002
- }
2003
- export interface InputFieldBooleanErrorMessages {
2004
- /** Default error message on invalid validation. */
2005
- default?: string | null;
2006
- }
2007
- export declare enum BooleanComponentType {
2008
- UNKNOWN = "UNKNOWN",
2009
- CHECKBOX = "CHECKBOX"
2010
- }
2011
- export interface Checkbox {
2012
- /** Label of the field */
2013
- label?: RichContent;
2014
- }
2015
- export interface InputFieldArrayType {
2016
- /** Maximum amount of array elements. */
2017
- maxItems?: number | null;
2018
- /** Minimum amount of array elements. */
2019
- minItems?: number | null;
2020
- /** Type of items allowed in array. */
2021
- items?: ArrayTypeArrayItems;
2022
- /** Custom error message when validation fails. */
2023
- errorMessages?: InputFieldArrayErrorMessages;
2024
- }
2025
- export declare enum ItemType {
2026
- UNKNOWN = "UNKNOWN",
2027
- STRING = "STRING",
2028
- NUMBER = "NUMBER",
2029
- BOOLEAN = "BOOLEAN",
2030
- INTEGER = "INTEGER",
2031
- OBJECT = "OBJECT"
2032
- }
2033
- export interface InputFieldIntegerType {
2034
- /** Maximum value. */
2035
- maximum?: number | null;
2036
- /** Minimum value. */
2037
- minimum?: number | null;
2038
- /** Multiple of value. */
2039
- multipleOf?: number | null;
2040
- /** Custom error message when validation fails. */
2041
- errorMessages?: InputFieldNumberErrorMessages;
2042
- /** List of allowed values. */
2043
- enum?: number[] | null;
2044
- }
2045
- export interface InputFieldObjectType {
2046
- /** Description of object properties. */
2047
- properties?: Record<string, ObjectTypePropertiesType>;
2048
- /** Custom error message when validation fails. */
2049
- errorMessages?: InputFieldObjectErrorMessages;
2050
- }
2051
- export declare enum PropertiesTypePropertiesType {
2052
- UNKNOWN = "UNKNOWN",
2053
- STRING = "STRING",
2054
- NUMBER = "NUMBER",
2055
- BOOLEAN = "BOOLEAN",
2056
- INTEGER = "INTEGER",
2057
- ARRAY = "ARRAY"
2058
- }
2059
- export interface ObjectTypePropertiesType extends ObjectTypePropertiesTypePropertiesTypeOptionsOneOf {
2060
- /** String type validation for property. */
2061
- stringOptions?: InputFieldStringType;
2062
- /** Number type validation for property. */
2063
- numberOptions?: InputFieldNumberType;
2064
- /** Boolean type validation for property. */
2065
- booleanOptions?: InputFieldBooleanType;
2066
- /** Integer type validation for property. */
2067
- integerOptions?: InputFieldIntegerType;
2068
- /** Array type validation for property. */
2069
- arrayOptions?: InputFieldArrayType;
2070
- /**
2071
- * Type of object properties
2072
- * @readonly
2073
- */
2074
- propertiesType?: PropertiesTypePropertiesType;
2075
- /** Whether the property is required. */
2076
- required?: boolean;
2077
- }
2078
- /** @oneof */
2079
- export interface ObjectTypePropertiesTypePropertiesTypeOptionsOneOf {
2080
- /** String type validation for property. */
2081
- stringOptions?: InputFieldStringType;
2082
- /** Number type validation for property. */
2083
- numberOptions?: InputFieldNumberType;
2084
- /** Boolean type validation for property. */
2085
- booleanOptions?: InputFieldBooleanType;
2086
- /** Integer type validation for property. */
2087
- integerOptions?: InputFieldIntegerType;
2088
- /** Array type validation for property. */
2089
- arrayOptions?: InputFieldArrayType;
2090
- }
2091
- export interface InputFieldObjectErrorMessages {
2092
- /** Default error message on invalid validation. */
2093
- default?: string | null;
2094
- }
2095
- export interface ArrayTypeArrayItems extends ArrayTypeArrayItemsItemTypeOptionsOneOf {
2096
- /** String type validation for items. */
2097
- stringOptions?: InputFieldStringType;
2098
- /** Number type validation for items. */
2099
- numberOptions?: InputFieldNumberType;
2100
- /** Boolean type validation for items. */
2101
- booleanOptions?: InputFieldBooleanType;
2102
- /** Integer type validation for items. */
2103
- integerOptions?: InputFieldIntegerType;
2104
- /** Object type validation for items */
2105
- objectOptions?: InputFieldObjectType;
2106
- /**
2107
- * Type of array items
2108
- * @readonly
2109
- */
2110
- itemType?: ItemType;
2111
- }
2112
- /** @oneof */
2113
- export interface ArrayTypeArrayItemsItemTypeOptionsOneOf {
2114
- /** String type validation for items. */
2115
- stringOptions?: InputFieldStringType;
2116
- /** Number type validation for items. */
2117
- numberOptions?: InputFieldNumberType;
2118
- /** Boolean type validation for items. */
2119
- booleanOptions?: InputFieldBooleanType;
2120
- /** Integer type validation for items. */
2121
- integerOptions?: InputFieldIntegerType;
2122
- /** Object type validation for items */
2123
- objectOptions?: InputFieldObjectType;
2124
- }
2125
- export interface InputFieldArrayErrorMessages {
2126
- /** Default error message on invalid validation. */
2127
- default?: string | null;
2128
- }
2129
- export declare enum ComponentType {
2130
- UNKNOWN = "UNKNOWN",
2131
- CHECKBOX_GROUP = "CHECKBOX_GROUP"
2132
- }
2133
- export interface CheckboxGroup {
2134
- /** Label of the field */
2135
- label?: string | null;
2136
- /** Description of the field */
2137
- description?: RichContent;
2138
- /** List of options to select from */
2139
- options?: Option[];
2140
- /**
2141
- * Flag identifying to hide or not label
2142
- * Default: true
2143
- */
2144
- showLabel?: boolean | null;
2145
- /** Option which can be specified by UoU, enabled when this object is specified. */
2146
- customOption?: CustomOption;
2147
- }
2148
- export interface MediaItem extends MediaItemMediaOneOf {
2149
- /** WixMedia image. */
2150
- image?: string;
2151
- }
2152
- /** @oneof */
2153
- export interface MediaItemMediaOneOf {
2154
- /** WixMedia image. */
2155
- image?: string;
2156
- }
2157
- export interface Option {
2158
- /** Selectable option label */
2159
- label?: string | null;
2160
- /** Selectable option value, which is saved to DB. */
2161
- value?: any;
2162
- /** Flag identifying that option should be selected by default */
2163
- default?: boolean;
2164
- /** Option id. Used as binding for translations */
2165
- _id?: string;
2166
- /** Media item. Media, associated with option, like image. */
2167
- media?: MediaItem;
2168
- }
2169
- export interface CustomOption {
2170
- /** Label of custom option input */
2171
- label?: string | null;
2172
- /** Placeholder of custom option input */
2173
- placeholder?: string | null;
2174
- }
2175
- export declare enum WixFileComponentType {
2176
- UNKNOWN = "UNKNOWN",
2177
- FILE_UPLOAD = "FILE_UPLOAD"
2178
- }
2179
- export interface FileUpload {
2180
- /** Selectable option label */
2181
- label?: string | null;
2182
- /** Description of the field */
2183
- description?: RichContent;
2184
- /**
2185
- * Flag identifying to hide or not label
2186
- * Default: true
2187
- */
2188
- showLabel?: boolean | null;
2189
- /** Text on upload button */
2190
- buttonText?: string | null;
2191
- /** Amount of files allowed to upload */
2192
- fileLimit?: number;
2193
- /** Supported file formats for upload */
2194
- uploadFileFormats?: UploadFileFormat[];
2195
- /** Custom text which appears when file is uploaded, if missing file name will be shown */
2196
- explanationText?: string | null;
2197
- }
2198
- export declare enum UploadFileFormat {
2199
- UNDEFINED = "UNDEFINED",
2200
- /** Video files */
2201
- VIDEO = "VIDEO",
2202
- /** Image files */
2203
- IMAGE = "IMAGE",
2204
- /** Audio files */
2205
- AUDIO = "AUDIO",
2206
- /** Document files */
2207
- DOCUMENT = "DOCUMENT"
2208
- }
2209
- export declare enum PaymentComponentType {
2210
- UNKNOWN = "UNKNOWN",
2211
- CHECKBOX_GROUP = "CHECKBOX_GROUP"
2212
- }
2213
- export interface ProductCheckboxGroup {
2214
- /** Label of the field. */
2215
- label?: string | null;
2216
- /** Description of the field. */
2217
- description?: RichContent;
2218
- /** List of options to select from. */
2219
- options?: ProductCheckboxGroupOption[];
2220
- }
2221
- export interface ProductCheckboxGroupOption {
2222
- /** Selectable option label. */
2223
- label?: string | null;
2224
- /** Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list. */
2225
- value?: any;
2226
- /** Option id. Used as binding for translations. */
2227
- _id?: string;
2228
- /** Media item. Media, associated with option, like image. */
2229
- media?: MediaItem;
2230
- }
2231
- export declare enum InputType {
2232
- UNKNOWN = "UNKNOWN",
2233
- STRING = "STRING",
2234
- NUMBER = "NUMBER",
2235
- BOOLEAN = "BOOLEAN",
2236
- ARRAY = "ARRAY",
2237
- OBJECT = "OBJECT",
2238
- WIX_FILE = "WIX_FILE",
2239
- PAYMENT = "PAYMENT"
2240
- }
2241
- export interface _String extends _StringComponentTypeOptionsOneOf {
2242
- /** Text input field */
2243
- textInputOptions?: TextInput;
2244
- /** Selection field as radio group */
2245
- radioGroupOptions?: RadioGroup;
2246
- /** Selection field as drop down */
2247
- dropdownOptions?: Dropdown;
2248
- /** Field for selecting date and/or time */
2249
- dateTimeOptions?: DateTimeInput;
2250
- /** Validation of field output value. */
2251
- validation?: InputFieldStringType;
2252
- /**
2253
- * Component type of the string input field
2254
- * @readonly
2255
- */
2256
- componentType?: StringComponentType;
2257
- }
2258
- /** @oneof */
2259
- export interface _StringComponentTypeOptionsOneOf {
2260
- /** Text input field */
2261
- textInputOptions?: TextInput;
2262
- /** Selection field as radio group */
2263
- radioGroupOptions?: RadioGroup;
2264
- /** Selection field as drop down */
2265
- dropdownOptions?: Dropdown;
2266
- /** Field for selecting date and/or time */
2267
- dateTimeOptions?: DateTimeInput;
2268
- }
2269
- export interface _Number extends _NumberComponentTypeOptionsOneOf {
2270
- /** Number value input field */
2271
- numberInputOptions?: NumberInput;
2272
- /** Validation of field output value. */
2273
- validation?: InputFieldNumberType;
2274
- /**
2275
- * Component type of the number input field
2276
- * @readonly
2277
- */
2278
- componentType?: NumberComponentType;
2279
- }
2280
- /** @oneof */
2281
- export interface _NumberComponentTypeOptionsOneOf {
2282
- /** Number value input field */
2283
- numberInputOptions?: NumberInput;
2284
- }
2285
- export interface _Boolean extends _BooleanComponentTypeOptionsOneOf {
2286
- /** Checkbox input field */
2287
- checkboxOptions?: Checkbox;
2288
- /** Validation of field output value. */
2289
- validation?: InputFieldBooleanType;
2290
- /**
2291
- * Component type of the boolean input field
2292
- * @readonly
2293
- */
2294
- componentType?: BooleanComponentType;
2295
- }
2296
- /** @oneof */
2297
- export interface _BooleanComponentTypeOptionsOneOf {
2298
- /** Checkbox input field */
2299
- checkboxOptions?: Checkbox;
2300
- }
2301
- export interface _Array extends _ArrayComponentTypeOptionsOneOf {
2302
- /** Checkbox group input field */
2303
- checkboxGroupOptions?: CheckboxGroup;
2304
- /** Validation of array type. */
2305
- validation?: InputFieldArrayType;
2306
- /**
2307
- * Component type of the array input field
2308
- * @readonly
2309
- */
2310
- componentType?: ComponentType;
2311
- }
2312
- /** @oneof */
2313
- export interface _ArrayComponentTypeOptionsOneOf {
2314
- /** Checkbox group input field */
2315
- checkboxGroupOptions?: CheckboxGroup;
2316
- }
2317
- export interface _Object extends _ObjectValidationOneOf {
2318
- /** Validation of object type. */
2319
- object?: InputFieldObjectType;
2320
- }
2321
- /** @oneof */
2322
- export interface _ObjectValidationOneOf {
2323
- /** Validation of object type. */
2324
- object?: InputFieldObjectType;
2325
- }
2326
- export interface WixFile extends WixFileComponentTypeOptionsOneOf {
2327
- /** File upload input field */
2328
- fileUploadOptions?: FileUpload;
2329
- /**
2330
- * Component type of the array input field
2331
- * @readonly
2332
- */
2333
- componentType?: WixFileComponentType;
2334
- }
2335
- /** @oneof */
2336
- export interface WixFileComponentTypeOptionsOneOf {
2337
- /** File upload input field */
2338
- fileUploadOptions?: FileUpload;
2339
- }
2340
- export interface Payment extends PaymentComponentTypeOptionsOneOf {
2341
- /** Checkbox group input field. */
2342
- checkboxGroupOptions?: ProductCheckboxGroup;
2343
- /**
2344
- * Component type of the payment input field.
2345
- * @readonly
2346
- */
2347
- componentType?: PaymentComponentType;
2348
- /** Validation of payment type. */
2349
- validation?: PaymentType;
2350
- }
2351
- /** @oneof */
2352
- export interface PaymentComponentTypeOptionsOneOf {
2353
- /** Checkbox group input field. */
2354
- checkboxGroupOptions?: ProductCheckboxGroup;
2355
- }
2356
- export interface Header {
2357
- /** Content of the header */
2358
- content?: RichContent;
2359
- }
2360
- export interface RichText {
2361
- /** Content of the rich text field */
2362
- content?: RichContent;
2363
- }
2364
- export declare enum Target {
2365
- UNDEFINED = "UNDEFINED",
2366
- /** Opened in same browser tab */
2367
- SELF = "SELF",
2368
- /** Url open in new tab */
2369
- BLANK = "BLANK"
2370
- }
2371
- export interface ThankYouMessage {
2372
- /** Message show after form submission */
2373
- text?: RichContent;
2374
- /**
2375
- * Duration after how much second it should disappear. If 0, will stay forever.
2376
- * Default: false
2377
- */
2378
- duration?: number | null;
2379
- }
2380
- export interface Redirect {
2381
- /** Url to which UoU should be redirected after successful submit of form */
2382
- url?: string | null;
2383
- /** How should url be opened */
2384
- target?: Target;
2385
- }
2386
- export declare enum FieldType {
2387
- UNKNOWN = "UNKNOWN",
2388
- INPUT = "INPUT",
2389
- DISPLAY = "DISPLAY",
2390
- SUBMIT = "SUBMIT"
2391
- }
2392
- export interface InputField extends InputFieldInputTypeOptionsOneOf {
2393
- /** Input return string as value */
2394
- stringOptions?: _String;
2395
- /** Input return number as value */
2396
- numberOptions?: _Number;
2397
- /** Input return boolean as value */
2398
- booleanOptions?: _Boolean;
2399
- /** Input return array as value */
2400
- arrayOptions?: _Array;
2401
- /** Input return object as value */
2402
- objectOptions?: _Object;
2403
- /** Input return "Wix file" as value */
2404
- wixFileOptions?: WixFile;
2405
- /** Input returns selected products as value. */
2406
- paymentOptions?: Payment;
2407
- /** Definition of a target where the value of field belongs. */
2408
- target?: string | null;
2409
- /**
2410
- * Mark the field as containing personal information. This will encrypt user data when storing it.
2411
- * Default: false
2412
- */
2413
- pii?: boolean;
2414
- /**
2415
- * Whether the field is required.
2416
- * Default: false
2417
- */
2418
- required?: boolean;
2419
- /**
2420
- * Type of the input field
2421
- * @readonly
2422
- */
2423
- inputType?: InputType;
2424
- }
2425
- /** @oneof */
2426
- export interface InputFieldInputTypeOptionsOneOf {
2427
- /** Input return string as value */
2428
- stringOptions?: _String;
2429
- /** Input return number as value */
2430
- numberOptions?: _Number;
2431
- /** Input return boolean as value */
2432
- booleanOptions?: _Boolean;
2433
- /** Input return array as value */
2434
- arrayOptions?: _Array;
2435
- /** Input return object as value */
2436
- objectOptions?: _Object;
2437
- /** Input return "Wix file" as value */
2438
- wixFileOptions?: WixFile;
2439
- /** Input returns selected products as value. */
2440
- paymentOptions?: Payment;
2441
- }
2442
- export interface DisplayField extends DisplayFieldComponentTypeOneOf {
2443
- /** Header field */
2444
- header?: Header;
2445
- /** Rich text field */
2446
- richText?: RichText;
2447
- }
2448
- /** @oneof */
2449
- export interface DisplayFieldComponentTypeOneOf {
2450
- /** Header field */
2451
- header?: Header;
2452
- /** Rich text field */
2453
- richText?: RichText;
2454
- }
2455
- export interface SubmitButton extends SubmitButtonSubmitActionOneOf {
2456
- /** Submit action effect is to show message */
2457
- thankYouMessage?: ThankYouMessage;
2458
- /** Submit action effect is to redirect to */
2459
- redirect?: Redirect;
2460
- /** When button is not on last page it behaves as switch between pages page, text of label to go to next page. */
2461
- nextText?: string | null;
2462
- /** When button is not on last page it behaves as switch between pages page, text of label to go to previous page. */
2463
- previousText?: string | null;
2464
- /** Text on the button when button is submitting a form */
2465
- submitText?: string | null;
2466
- }
2467
- /** @oneof */
2468
- export interface SubmitButtonSubmitActionOneOf {
2469
- /** Submit action effect is to show message */
2470
- thankYouMessage?: ThankYouMessage;
2471
- /** Submit action effect is to redirect to */
2472
- redirect?: Redirect;
2473
- }
2474
- export interface Step {
2475
- /** Step ID. */
2476
- _id?: string;
2477
- /** Name of the step. */
2478
- name?: string | null;
2479
- /** Is step hidden */
2480
- hidden?: boolean;
2481
- /** Form step properties */
2482
- layout?: FormLayout;
2483
- }
2484
- export interface FormLayout {
2485
- /** Layout for large break point. */
2486
- large?: BreakPoint;
2487
- /** Layout for medium break point. */
2488
- medium?: BreakPoint;
2489
- /** Layout for small break point. */
2490
- small?: BreakPoint;
2491
- }
2492
- export interface BreakPoint {
2493
- /** Description of layouts for items. */
2494
- items?: ItemLayout[];
2495
- /** Amount of columns of layout grid. */
2496
- columns?: number | null;
2497
- /** Row height of layout grid. */
2498
- rowHeight?: number | null;
2499
- /** Description of elements margins. */
2500
- margin?: Margin;
2501
- /** Description of elements paddings. */
2502
- padding?: Margin;
2503
- /** Sections of the layout, which allow manage fields */
2504
- sections?: Section[];
2505
- }
2506
- export interface ItemLayout {
2507
- /** Form field reference id. */
2508
- fieldId?: string;
2509
- /** Horizontal coordinate in the grid. */
2510
- row?: number | null;
2511
- /** Vertical coordinate in the grid. */
2512
- column?: number | null;
2513
- /** Height. */
2514
- width?: number | null;
2515
- /** Width. */
2516
- height?: number | null;
2517
- }
2518
- export interface Margin {
2519
- /** Horizontal value. */
2520
- horizontal?: number | null;
2521
- /** Vertical value. */
2522
- vertical?: number | null;
2523
- }
2524
- export interface Section {
2525
- /** Id of the section */
2526
- _id?: string;
2527
- /** Horizontal coordinate in the grid. */
2528
- row?: number | null;
2529
- /**
2530
- * A list of field identifiers that are permitted to be placed within a section.
2531
- * The section will only accept fields with IDs specified in this list.
2532
- * If the section encounters the $new key within the list,
2533
- * it allows the inclusion of fields not explicitly listed,
2534
- * enabling dynamic addition of new fields.
2535
- */
2536
- allowedFieldIds?: string[];
2537
- }
2538
- export interface FormRule {
2539
- /** Id of the rule */
2540
- _id?: string;
2541
- /** Rule on which item properties or layouts will be changed. */
2542
- condition?: Record<string, any> | null;
2543
- /**
2544
- * Form items with defined properties that will be
2545
- * changed when given condition is resolved to true.
2546
- */
2547
- overrides?: FormOverride[];
2548
- /** Name of the rule */
2549
- name?: string | null;
2550
- }
2551
- export declare enum OverrideEntityType {
2552
- UNKNOWN = "UNKNOWN",
2553
- FIELD = "FIELD",
2554
- FORM = "FORM",
2555
- NESTED_FORM_FIELD = "NESTED_FORM_FIELD"
2556
- }
2557
- export interface FormOverride {
2558
- /** Override entity type. */
2559
- entityType?: OverrideEntityType;
2560
- /** Overridden entity id. Either fieldId, or "{fieldIdWithNestedForm}/{nestedFormFieldId}" */
2561
- entityId?: string | null;
2562
- /** Form entity properties path with new value, that will be changed on condition. */
2563
- valueChanges?: Record<string, any>;
2564
- }
2565
- export interface FormProperties {
2566
- /** Form name. */
2567
- name?: string | null;
2568
- /** Identifies if the form is disabled. */
2569
- disabled?: boolean;
2570
- }
2571
- export declare enum Kind {
2572
- REGULAR = "REGULAR",
2573
- EXTENSION = "EXTENSION"
2574
- }
2575
- export interface PostSubmissionTriggers {
2576
- /** Upserts a contact from the submission data. */
2577
- upsertContact?: UpsertContact;
2578
- }
2579
- export interface UpsertContact {
2580
- /** Fields mapping (target field mapped to corresponding contact field). */
2581
- fieldsMapping?: Record<string, FormFieldContactInfo>;
2582
- /**
2583
- * List of contact label keys.
2584
- * [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
2585
- * help categorize contacts.
2586
- */
2587
- labels?: string[];
2588
- }
2589
- export interface FormFieldContactInfo extends FormFieldContactInfoAdditionalInfoOneOf {
2590
- /** Email info. */
2591
- emailInfo?: EmailInfo;
2592
- /** Phone info. */
2593
- phoneInfo?: PhoneInfo;
2594
- /** Address info. */
2595
- addressInfo?: AddressInfo;
2596
- /** Custom field info. */
2597
- customFieldInfo?: CustomFieldInfo;
2598
- /** Field mapped to contacts. */
2599
- contactField?: ContactField;
2600
- }
2601
- /** @oneof */
2602
- export interface FormFieldContactInfoAdditionalInfoOneOf {
2603
- /** Email info. */
2604
- emailInfo?: EmailInfo;
2605
- /** Phone info. */
2606
- phoneInfo?: PhoneInfo;
2607
- /** Address info. */
2608
- addressInfo?: AddressInfo;
2609
- /** Custom field info. */
2610
- customFieldInfo?: CustomFieldInfo;
2611
- }
2612
- export declare enum EmailInfoTag {
2613
- UNTAGGED = "UNTAGGED",
2614
- MAIN = "MAIN"
2615
- }
2616
- export declare enum PhoneInfoTag {
2617
- UNTAGGED = "UNTAGGED",
2618
- MAIN = "MAIN"
2619
- }
2620
- export declare enum Tag {
2621
- UNTAGGED = "UNTAGGED",
2622
- HOME = "HOME"
2623
- }
2624
- export declare enum ContactField {
2625
- UNDEFINED = "UNDEFINED",
2626
- FIRST_NAME = "FIRST_NAME",
2627
- LAST_NAME = "LAST_NAME",
2628
- COMPANY = "COMPANY",
2629
- POSITION = "POSITION",
2630
- EMAIL = "EMAIL",
2631
- PHONE = "PHONE",
2632
- ADDRESS = "ADDRESS",
2633
- BIRTHDATE = "BIRTHDATE",
2634
- CUSTOM_FIELD = "CUSTOM_FIELD",
2635
- SUBSCRIPTION = "SUBSCRIPTION",
2636
- VAT_ID = "VAT_ID"
2637
- }
2638
- export interface EmailInfo {
2639
- /** Email tag. */
2640
- tag?: EmailInfoTag;
2641
- }
2642
- export interface PhoneInfo {
2643
- /** Phone tag. */
2644
- tag?: PhoneInfoTag;
2645
- }
2646
- export interface AddressInfo {
2647
- /** Address tag. */
2648
- tag?: Tag;
2649
- }
2650
- export interface CustomFieldInfo {
2651
- /** Custom field key. */
2652
- key?: string;
2653
- }
2654
- export interface NestedForm {
2655
- /** Targets which have this form. */
2656
- targets?: string[];
2657
- /** Nested form. */
2658
- form?: Form;
2659
- }
2660
- export interface LimitationRule {
2661
- /** Limitation by submission count, disables form when a set amount of submissions is reached. */
2662
- maxAllowedSubmissions?: number | null;
2663
- /** Limitation by submission date, disables form when a set date and time is reached. */
2664
- dateTimeDeadline?: Date;
2665
- }
2666
- export interface CreateCheckoutFromSubmissionResponse {
2667
- /** Checkout ID (applicable for form involving payments). */
2668
- checkoutId?: string | null;
2669
- }
2670
- export interface IsFormSubmittableRequest {
2671
- }
2672
- export interface IsFormSubmittableResponse {
2673
- }
2674
- export interface DomainEvent extends DomainEventBodyOneOf {
2675
- createdEvent?: EntityCreatedEvent;
2676
- updatedEvent?: EntityUpdatedEvent;
2677
- deletedEvent?: EntityDeletedEvent;
2678
- actionEvent?: ActionEvent;
2679
- /**
2680
- * Unique event ID.
2681
- * Allows clients to ignore duplicate webhooks.
2682
- */
2683
- _id?: string;
2684
- /**
2685
- * Assumes actions are also always typed to an entity_type
2686
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
2687
- */
2688
- entityFqdn?: string;
2689
- /**
2690
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
2691
- * This is although the created/updated/deleted notion is duplication of the oneof types
2692
- * Example: created/updated/deleted/started/completed/email_opened
2693
- */
2694
- slug?: string;
2695
- /** ID of the entity associated with the event. */
2696
- entityId?: string;
2697
- /** Event timestamp. */
2698
- eventTime?: Date;
2699
- /**
2700
- * Whether the event was triggered as a result of a privacy regulation application
2701
- * (for example, GDPR).
2702
- */
2703
- triggeredByAnonymizeRequest?: boolean | null;
2704
- /** If present, indicates the action that triggered the event. */
2705
- originatedFrom?: string | null;
2706
- /**
2707
- * A sequence number defining the order of updates to the underlying entity.
2708
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
2709
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
2710
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
2711
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
2712
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
2713
- */
2714
- entityEventSequence?: string | null;
2715
- }
2716
- /** @oneof */
2717
- export interface DomainEventBodyOneOf {
2718
- createdEvent?: EntityCreatedEvent;
2719
- updatedEvent?: EntityUpdatedEvent;
2720
- deletedEvent?: EntityDeletedEvent;
2721
- actionEvent?: ActionEvent;
2722
- }
2723
- export interface EntityCreatedEvent {
2724
- entityAsJson?: string;
2725
- }
2726
- export interface EntityUpdatedEvent {
2727
- /**
2728
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2729
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2730
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2731
- */
2732
- currentEntityAsJson?: string;
2733
- }
2734
- export interface EntityDeletedEvent {
2735
- /** Entity that was deleted */
2736
- deletedEntityAsJson?: string | null;
2737
- }
2738
- export interface ActionEvent {
2739
- bodyAsJson?: string;
2740
- }
2741
- export interface Empty {
2742
- }
2743
- export interface UpsertContactFromSubmissionRequest {
2744
- /** Submission from which contact needs to be upserted. */
2745
- submissionId?: string;
2746
- /** Optional contact id to which submission should be mapped. */
2747
- contactId?: string | null;
2748
- /** Indicates contact has verified primary email. */
2749
- emailVerified?: boolean;
2750
- }
2751
- export interface UpsertContactFromSubmissionResponse {
2752
- /** Submit contact response. */
2753
- submitContactResponse?: SubmitContactResponse;
2754
- }
2755
- export interface SubmitContactResponse {
2756
- /** ID of the contact that was found or created. */
2757
- contactId?: string;
2758
- /**
2759
- * Identity type of the returned contact.
2760
- *
2761
- * - `CONTACT`: The returned contact ID belongs to a new or existing contact.
2762
- * - `MEMBER`: The returned contact ID belongs to the currently logged-in site member.
2763
- * - `NOT_AUTHENTICATED_MEMBER`: The returned contact ID belongs to a site member who is not currently logged in.
2764
- */
2765
- identityType?: IdentityType;
2766
- /**
2767
- * Indicates whether the contact was just created or already existed.
2768
- *
2769
- * If the contact was just created, returns `true`.
2770
- * If it already existed, returns `false`.
2771
- */
2772
- newContact?: boolean;
2773
- }
2774
- export declare enum IdentityType {
2775
- UNKNOWN = "UNKNOWN",
2776
- /** Existing or new contact */
2777
- CONTACT = "CONTACT",
2778
- /** Member is logged in, matching logic skipped */
2779
- MEMBER = "MEMBER",
2780
- /** Matching contact is a member, Merge logic won't be applied */
2781
- NOT_AUTHENTICATED_MEMBER = "NOT_AUTHENTICATED_MEMBER"
2782
- }
2783
- export interface SubmissionContactMapped {
2784
- /**
2785
- * Mapped upserted contact ID.
2786
- * @readonly
2787
- */
2788
- contactId?: string;
2789
- /**
2790
- * Mapped contact emails.
2791
- * @readonly
2792
- */
2793
- emails?: string[];
2794
- /** Identifies the namespace that the submission's form belongs to. */
2795
- namespace?: string;
2796
- }
2797
- export interface SubmissionContactMappingSkipped {
2798
- /** Form Id. */
2799
- formId?: string;
2800
- /** Identifies the namespace that the submission's form belongs to. */
2801
- namespace?: string;
2802
- }
2803
- export interface CreateSubmissionRequest {
2804
- /** Submission to create. */
2805
- submission: FormSubmission;
2806
- /** Captcha token. */
2807
- captchaToken?: string | null;
2808
- }
2809
- export interface CreateSubmissionResponse {
2810
- /** The created submission. */
2811
- submission?: FormSubmission;
2812
- }
2813
- export interface CreateSubmissionBySubmitterRequest {
2814
- /** Submission to create. */
2815
- submission?: FormSubmission;
2816
- /** A flag indicating whether this operation is a repeated creation, such as restoring a previously manually reported as spam entity. */
2817
- repeatedCreation?: boolean;
2818
- }
2819
- export interface CreateSubmissionBySubmitterResponse {
2820
- /** The created submission. */
2821
- submission?: FormSubmission;
2822
- }
2823
- export interface BulkCreateSubmissionBySubmitterRequest {
2824
- /** Form id. Restricts submissions creation for a single form. */
2825
- formId?: string;
2826
- /**
2827
- * Submissions to create.
2828
- * Deprecated
2829
- */
2830
- submissions?: FormSubmission[];
2831
- /** When set, items will be returned on successful create. */
2832
- returnEntity?: boolean;
2833
- /** Submissions data to create. */
2834
- submissionsV2?: BulkCreateSubmissionBySubmitterData[];
2835
- }
2836
- export interface BulkCreateSubmissionBySubmitterData {
2837
- /** Submissions to create. */
2838
- submission?: FormSubmission;
2839
- /** A flag indicating whether this operation is a repeated creation, such as restoring a previously manually reported as spam entity. */
2840
- repeatedCreation?: boolean;
2841
- }
2842
- export interface BulkCreateSubmissionBySubmitterResponse {
2843
- /** Created submissions with metadata */
2844
- results?: BulkSubmissionResult[];
2845
- /** Metadata of request */
2846
- bulkActionMetadata?: BulkActionMetadata;
2847
- }
2848
- export interface BulkSubmissionResult {
2849
- /** Created submission metadata */
2850
- itemMetadata?: ItemMetadata;
2851
- /** The created submission. */
2852
- item?: FormSubmission;
2853
- }
2854
- export interface ItemMetadata {
2855
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
2856
- _id?: string | null;
2857
- /** Index of the item within the request array. Allows for correlation between request and response items. */
2858
- originalIndex?: number;
2859
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
2860
- success?: boolean;
2861
- /** Details about the error in case of failure. */
2862
- error?: ApplicationError;
2863
- }
2864
- export interface ApplicationError {
2865
- /** Error code. */
2866
- code?: string;
2867
- /** Description of the error. */
2868
- description?: string;
2869
- /** Data related to the error. */
2870
- data?: Record<string, any> | null;
2871
- }
2872
- export interface BulkActionMetadata {
2873
- /** Number of items that were successfully processed. */
2874
- totalSuccesses?: number;
2875
- /** Number of items that couldn't be processed. */
2876
- totalFailures?: number;
2877
- /** Number of failures without details because detailed failure threshold was exceeded. */
2878
- undetailedFailures?: number;
2879
- }
2880
- export interface GetSubmissionRequest {
2881
- /** ID of the submission to retrieve. */
2882
- submissionId: string;
2883
- }
2884
- export interface GetSubmissionResponse {
2885
- /** The retrieved submission. */
2886
- submission?: FormSubmission;
2887
- }
2888
- export interface GetSubmissionByCheckoutIdRequest {
2889
- /** Checkout ID of the submission to retrieve. */
2890
- checkoutId?: string;
2891
- }
2892
- export interface GetSubmissionByCheckoutIdResponse {
2893
- /** The retrieved submission. */
2894
- submission?: FormSubmission;
2895
- }
2896
- export interface UpdateSubmissionRequest {
2897
- /** Submission to update. */
2898
- submission: FormSubmission;
2899
- }
2900
- export interface UpdateSubmissionResponse {
2901
- /** The updated submission. */
2902
- submission?: FormSubmission;
2903
- }
2904
- export interface ConfirmSubmissionRequest {
2905
- /** Submission ID to confirm. */
2906
- submissionId: string;
2907
- }
2908
- export interface ConfirmSubmissionResponse {
2909
- /** The confirmed submission. */
2910
- submission?: FormSubmission;
2911
- }
2912
- export interface FormSubmissionStatusUpdatedEvent {
2913
- /** Updated submission. */
2914
- submission?: FormSubmission;
2915
- /** Previous status of the submission. */
2916
- previousStatus?: SubmissionStatus;
2917
- }
2918
- export interface DeleteSubmissionRequest {
2919
- /** ID of the submission to delete. */
2920
- submissionId: string;
2921
- /**
2922
- * Delete submission bypassing trash-bin
2923
- * Default: false
2924
- */
2925
- permanent?: boolean;
2926
- }
2927
- export interface DeleteSubmissionResponse {
2928
- }
2929
- export interface BulkDeleteSubmissionRequest {
2930
- /** Form ID. */
2931
- formId: string;
2932
- /** Submission ids. */
2933
- submissionIds?: string[];
2934
- /**
2935
- * Delete submission bypassing trash-bin
2936
- * Default: false
2937
- */
2938
- permanent?: boolean;
2939
- }
2940
- export interface BulkDeleteSubmissionResponse {
2941
- /** Results of bulk submission delete */
2942
- results?: BulkDeleteSubmissionResult[];
2943
- /** Metadata of request */
2944
- bulkActionMetadata?: BulkActionMetadata;
2945
- }
2946
- export interface BulkDeleteSubmissionResult {
2947
- /** Deleted item metadata */
2948
- itemMetadata?: ItemMetadata;
2949
- }
2950
- export interface RestoreSubmissionFromTrashBinRequest {
2951
- /** ID of the submission to restore. */
2952
- submissionId: string;
2953
- }
2954
- export interface RestoreSubmissionFromTrashBinResponse {
2955
- /** The restored submission. */
2956
- submission?: FormSubmission;
2957
- }
2958
- export interface RemoveSubmissionFromTrashBinRequest {
2959
- /** ID of the submission to restore. */
2960
- submissionId: string;
2961
- }
2962
- export interface RemoveSubmissionFromTrashBinResponse {
2963
- }
2964
- export interface RemovedSubmissionFromTrash {
2965
- /** Removed submission. */
2966
- submission?: FormSubmission;
2967
- }
2968
- export interface BulkRemoveSubmissionFromTrashBinRequest {
2969
- /** Form ID. */
2970
- formId: string;
2971
- /** Submission ids. */
2972
- submissionIds?: string[];
2973
- }
2974
- export interface BulkRemoveSubmissionFromTrashBinResponse {
2975
- /** Results of bulk submission removal from trash */
2976
- results?: BulkRemoveSubmissionFromTrashBinResult[];
2977
- /** Metadata of request */
2978
- bulkActionMetadata?: BulkActionMetadata;
2979
- }
2980
- export interface BulkRemoveSubmissionFromTrashBinResult {
2981
- /** Deleted item metadata */
2982
- itemMetadata?: ItemMetadata;
2983
- }
2984
- export interface ListDeletedSubmissionsRequest {
2985
- /** Form ID. */
2986
- formId: string;
2987
- /** Submission ids. */
2988
- submissionIds?: string[];
2989
- /** 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`. */
2990
- paging?: CursorPaging;
2991
- /**
2992
- * List of statuses of submissions which should be returned
2993
- * Default: CONFIRMED
2994
- */
2995
- statuses?: SubmissionStatus[];
2996
- }
2997
- export interface CursorPaging {
2998
- /** Number of items to load. */
2999
- limit?: number | null;
3000
- /**
3001
- * Pointer to the next or previous page in the list of results.
3002
- *
3003
- * You can get the relevant cursor token
3004
- * from the `pagingMetadata` object in the previous call's response.
3005
- * Not relevant for the first request.
3006
- */
3007
- cursor?: string | null;
3008
- }
3009
- export interface ListDeletedSubmissionsResponse {
3010
- /** The retrieved Submissions. */
3011
- submissions?: FormSubmission[];
3012
- /** Paging metadata. */
3013
- pagingMetadata?: CursorPagingMetadata;
3014
- }
3015
- export interface CursorPagingMetadata {
3016
- /** Number of items returned in the response. */
3017
- count?: number | null;
3018
- /** Offset that was requested. */
3019
- cursors?: Cursors;
3020
- /**
3021
- * Indicates if there are more results after the current page.
3022
- * If `true`, another page of results can be retrieved.
3023
- * If `false`, this is the last page.
3024
- */
3025
- hasNext?: boolean | null;
3026
- }
3027
- export interface Cursors {
3028
- /** Cursor pointing to next page in the list of results. */
3029
- next?: string | null;
3030
- /** Cursor pointing to previous page in the list of results. */
3031
- prev?: string | null;
3032
- }
3033
- export interface GetDeletedSubmissionRequest {
3034
- /** Submission id. */
3035
- submissionId: string;
3036
- }
3037
- export interface GetDeletedSubmissionResponse {
3038
- /** The retrieved Submission. */
3039
- submission?: FormSubmission;
3040
- }
3041
- export interface QuerySubmissionRequest {
3042
- /** Query options. */
3043
- query?: CursorQuery;
3044
- /** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */
3045
- onlyYourOwn?: boolean;
3046
- }
3047
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
3048
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
3049
- cursorPaging?: CursorPaging;
3050
- /**
3051
- * Filter object.
3052
- *
3053
- * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.
3054
- */
3055
- filter?: Record<string, any> | null;
3056
- /** Sort object. */
3057
- sort?: Sorting[];
3058
- }
3059
- /** @oneof */
3060
- export interface CursorQueryPagingMethodOneOf {
3061
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
3062
- cursorPaging?: CursorPaging;
3063
- }
3064
- export interface Sorting {
3065
- /** Name of the field to sort by. */
3066
- fieldName?: string;
3067
- /** Sort order. */
3068
- order?: SortOrder;
3069
- }
3070
- export declare enum SortOrder {
3071
- ASC = "ASC",
3072
- DESC = "DESC"
3073
- }
3074
- export interface QuerySubmissionResponse {
3075
- /** The retrieved submissions. */
3076
- submissions?: FormSubmission[];
3077
- /** Paging metadata. */
3078
- metadata?: CursorPagingMetadata;
3079
- }
3080
- export interface QuerySubmissionsByNamespaceRequest {
3081
- /** Query options. */
3082
- query: CursorQuery;
3083
- /** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */
3084
- onlyYourOwn?: boolean;
3085
- }
3086
- export interface QuerySubmissionsByNamespaceResponse {
3087
- /** The retrieved Submissions. */
3088
- submissions?: FormSubmission[];
3089
- /** Paging metadata. */
3090
- metadata?: CursorPagingMetadata;
3091
- }
3092
- export interface CountSubmissionsRequest {
3093
- /** Form IDs. */
3094
- formIds: string[];
3095
- /** 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. */
3096
- namespace: string;
3097
- /**
3098
- * List of statuses of submissions which should be taken into count
3099
- * Default: CONFIRMED, PAYMENT_WAITING, PAYMENT_CANCELED
3100
- */
3101
- statuses?: SubmissionStatus[];
3102
- }
3103
- export interface CountSubmissionsResponse {
3104
- /** Forms submission count. */
3105
- formsSubmissionsCount?: FormSubmissionsCount[];
3106
- }
3107
- export interface FormSubmissionsCount {
3108
- /** Form ID. */
3109
- formId?: string;
3110
- /** Total number of submissions. */
3111
- totalCount?: number;
3112
- /** Number of submissions that haven't yet been seen by site Extensions with manage submission permissions. */
3113
- unseenCount?: number;
3114
- }
3115
- export interface CountDeletedSubmissionsRequest {
3116
- /** Form IDs. */
3117
- formIds: string[];
3118
- /** 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. */
3119
- namespace: string;
3120
- /**
3121
- * List of statuses of submissions which should be taken into count
3122
- * Default: CONFIRMED, PAYMENT_WAITING, PAYMENT_CANCELED
3123
- */
3124
- statuses?: SubmissionStatus[];
3125
- }
3126
- export interface CountDeletedSubmissionsResponse {
3127
- /** Forms submission count. */
3128
- formsDeletedSubmissionsCount?: FormDeletedSubmissionsCount[];
3129
- }
3130
- export interface FormDeletedSubmissionsCount {
3131
- /** Form ID. */
3132
- formId?: string;
3133
- /** Total number of submissions. */
3134
- totalCount?: number;
3135
- }
3136
- export interface GetMediaUploadURLRequest {
3137
- /** Form ID. */
3138
- formId: string;
3139
- /** Name of file to upload. */
3140
- filename: string;
3141
- /**
3142
- * [Mime type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#) of file to upload.
3143
- *
3144
- * For example, `'image/png'`
3145
- */
3146
- mimeType: string;
3147
- }
3148
- export interface GetMediaUploadURLResponse {
3149
- /** Url to upload file. */
3150
- uploadUrl?: string;
3151
- }
3152
- export interface BulkMarkSubmissionsAsSeenRequest {
3153
- /** Submission IDs to mark as seen. */
3154
- ids: string[];
3155
- /** ID of the form which the submissions belongs to. */
3156
- formId: string;
3157
- }
3158
- export interface BulkMarkSubmissionsAsSeenResponse {
3159
- }
3160
- export interface Task {
3161
- key?: TaskKey;
3162
- executeAt?: Date;
3163
- payload?: string | null;
3164
- }
3165
- export interface TaskKey {
3166
- appId?: string;
3167
- instanceId?: string;
3168
- subjectId?: string | null;
3169
- }
3170
- export interface TaskAction extends TaskActionActionOneOf {
3171
- complete?: Complete;
3172
- cancel?: Cancel;
3173
- reschedule?: Reschedule;
3174
- }
3175
- /** @oneof */
3176
- export interface TaskActionActionOneOf {
3177
- complete?: Complete;
3178
- cancel?: Cancel;
3179
- reschedule?: Reschedule;
3180
- }
3181
- export interface Complete {
3182
- }
3183
- export interface Cancel {
3184
- }
3185
- export interface Reschedule {
3186
- executeAt?: Date;
3187
- payload?: string | null;
3188
- }
3189
- export interface CreateSubmissionResponseNonNullableFields {
3190
- submission?: {
3191
- formId: string;
3192
- namespace: string;
3193
- status: SubmissionStatus;
3194
- seen: boolean;
3195
- orderDetails?: {
3196
- itemSubtotal: string;
3197
- checkoutId: string;
3198
- };
3199
- };
3200
- }
3201
- export interface GetSubmissionResponseNonNullableFields {
3202
- submission?: {
3203
- formId: string;
3204
- namespace: string;
3205
- status: SubmissionStatus;
3206
- seen: boolean;
3207
- orderDetails?: {
3208
- itemSubtotal: string;
3209
- checkoutId: string;
3210
- };
3211
- };
3212
- }
3213
- export interface UpdateSubmissionResponseNonNullableFields {
3214
- submission?: {
3215
- formId: string;
3216
- namespace: string;
3217
- status: SubmissionStatus;
3218
- seen: boolean;
3219
- orderDetails?: {
3220
- itemSubtotal: string;
3221
- checkoutId: string;
3222
- };
3223
- };
3224
- }
3225
- export interface ConfirmSubmissionResponseNonNullableFields {
3226
- submission?: {
3227
- formId: string;
3228
- namespace: string;
3229
- status: SubmissionStatus;
3230
- seen: boolean;
3231
- orderDetails?: {
3232
- itemSubtotal: string;
3233
- checkoutId: string;
3234
- };
3235
- };
3236
- }
3237
- export interface BulkDeleteSubmissionResponseNonNullableFields {
3238
- results: {
3239
- itemMetadata?: {
3240
- originalIndex: number;
3241
- success: boolean;
3242
- error?: {
3243
- code: string;
3244
- description: string;
3245
- };
3246
- };
3247
- }[];
3248
- bulkActionMetadata?: {
3249
- totalSuccesses: number;
3250
- totalFailures: number;
3251
- undetailedFailures: number;
3252
- };
3253
- }
3254
- export interface RestoreSubmissionFromTrashBinResponseNonNullableFields {
3255
- submission?: {
3256
- formId: string;
3257
- namespace: string;
3258
- status: SubmissionStatus;
3259
- seen: boolean;
3260
- orderDetails?: {
3261
- itemSubtotal: string;
3262
- checkoutId: string;
3263
- };
3264
- };
3265
- }
3266
- export interface BulkRemoveSubmissionFromTrashBinResponseNonNullableFields {
3267
- results: {
3268
- itemMetadata?: {
3269
- originalIndex: number;
3270
- success: boolean;
3271
- error?: {
3272
- code: string;
3273
- description: string;
3274
- };
3275
- };
3276
- }[];
3277
- bulkActionMetadata?: {
3278
- totalSuccesses: number;
3279
- totalFailures: number;
3280
- undetailedFailures: number;
3281
- };
3282
- }
3283
- export interface ListDeletedSubmissionsResponseNonNullableFields {
3284
- submissions: {
3285
- formId: string;
3286
- namespace: string;
3287
- status: SubmissionStatus;
3288
- seen: boolean;
3289
- orderDetails?: {
3290
- itemSubtotal: string;
3291
- checkoutId: string;
3292
- };
3293
- }[];
3294
- }
3295
- export interface GetDeletedSubmissionResponseNonNullableFields {
3296
- submission?: {
3297
- formId: string;
3298
- namespace: string;
3299
- status: SubmissionStatus;
3300
- seen: boolean;
3301
- orderDetails?: {
3302
- itemSubtotal: string;
3303
- checkoutId: string;
3304
- };
3305
- };
3306
- }
3307
- export interface QuerySubmissionsByNamespaceResponseNonNullableFields {
3308
- submissions: {
3309
- formId: string;
3310
- namespace: string;
3311
- status: SubmissionStatus;
3312
- seen: boolean;
3313
- orderDetails?: {
3314
- itemSubtotal: string;
3315
- checkoutId: string;
3316
- };
3317
- }[];
3318
- }
3319
- export interface CountSubmissionsResponseNonNullableFields {
3320
- formsSubmissionsCount: {
3321
- formId: string;
3322
- totalCount: number;
3323
- unseenCount: number;
3324
- }[];
3325
- }
3326
- export interface CountDeletedSubmissionsResponseNonNullableFields {
3327
- formsDeletedSubmissionsCount: {
3328
- formId: string;
3329
- totalCount: number;
3330
- }[];
3331
- }
3332
- export interface GetMediaUploadURLResponseNonNullableFields {
3333
- uploadUrl: string;
3334
- }
3335
- /**
3336
- * Creates a submission.
3337
- * > **Note**:
3338
- * > The Submissions API is only available in Wix Studio.
3339
- * @param submission - Submission to create.
3340
- * @public
3341
- * @documentationMaturity preview
3342
- * @requiredField submission
3343
- * @requiredField submission.formId
3344
- * @permissionScope Manage Submissions
3345
- * @applicableIdentity APP
3346
- * @applicableIdentity MEMBER
3347
- * @applicableIdentity VISITOR
3348
- */
3349
- export declare function createSubmission(submission: FormSubmission, options?: CreateSubmissionOptions): Promise<CreateSubmissionResponse & CreateSubmissionResponseNonNullableFields>;
3350
- export interface CreateSubmissionOptions {
3351
- /** Captcha token. */
3352
- captchaToken?: string | null;
3353
- }
3354
- /**
3355
- * Retrieves a submission by ID.
3356
- * > **Note:**
3357
- * > The Submissions API is only available in the Wix Studio editor.
3358
- * @param submissionId - ID of the submission to retrieve.
3359
- * @public
3360
- * @documentationMaturity preview
3361
- * @requiredField submissionId
3362
- * @permissionScope Manage Submissions
3363
- * @permissionScope Manage Orders
3364
- * @permissionScope Read Orders
3365
- * @permissionScope Read Submissions
3366
- * @applicableIdentity APP
3367
- */
3368
- export declare function getSubmission(submissionId: string): Promise<GetSubmissionResponse & GetSubmissionResponseNonNullableFields>;
3369
- /**
3370
- * Updates a submission.
3371
- * > **Note**:
3372
- * > The Submissions API is only available in Wix Studio.
3373
- *
3374
- *
3375
- * Each time the submission is updated, `revision` increments by 1. The existing `revision` must be included when updating the submission. This ensures you're working with the latest submission information, and prevents unintended overwrites.
3376
- * @param _id - Submission ID.
3377
- * @public
3378
- * @documentationMaturity preview
3379
- * @requiredField _id
3380
- * @requiredField submission
3381
- * @requiredField submission.formId
3382
- * @requiredField submission.revision
3383
- * @param submission - Submission to update.
3384
- * @permissionScope Manage Submissions
3385
- * @applicableIdentity APP
3386
- * @returns The updated submission.
3387
- */
3388
- export declare function updateSubmission(_id: string | null, submission: UpdateSubmission): Promise<FormSubmission & NonNullable<UpdateSubmissionResponseNonNullableFields>['submission']>;
3389
- export interface UpdateSubmission {
3390
- /**
3391
- * Submission ID.
3392
- * @readonly
3393
- */
3394
- _id?: string | null;
3395
- /** ID of the form which the submission belongs to. */
3396
- formId?: string;
3397
- /**
3398
- * 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.
3399
- * @readonly
3400
- */
3401
- namespace?: string;
3402
- /**
3403
- * Status of the submission.
3404
- * - `PENDING`: A submission is created, but has not yet been recorded in the Wix Forms collection.
3405
- * - `PAYMENT_WAITING`: A form submission requiring payment is created.
3406
- * - `PAYMENT_CANCELED`: An order of a form submission is canceled.
3407
- * - `CONFIRMED`: A submission is recorded in the Wix Forms collection.
3408
- */
3409
- status?: SubmissionStatus;
3410
- /** Submission values where `key` is the form field and `value` is the data submitted for the given field. */
3411
- submissions?: Record<string, any>;
3412
- /**
3413
- * Date and time the form submission was created.
3414
- * @readonly
3415
- */
3416
- _createdDate?: Date;
3417
- /**
3418
- * Date and time the form submission was updated.
3419
- * @readonly
3420
- */
3421
- _updatedDate?: Date;
3422
- /**
3423
- * Revision number, which increments by 1 each time the form submission is updated. To prevent conflicting changes, the existing revision must be used when updating a form submission.
3424
- * @readonly
3425
- */
3426
- revision?: string | null;
3427
- /**
3428
- * ID of the visitor that submitted the form.
3429
- * @readonly
3430
- */
3431
- submitter?: Submitter;
3432
- /** Whether a site owner marked a submission as "seen". */
3433
- seen?: boolean;
3434
- /** Data extension object that holds users' and apps' fields. */
3435
- extendedFields?: ExtendedFields;
3436
- /**
3437
- * Order details.
3438
- * *Note**: This object is only applicable when submittng a form in the Wix Payments app.
3439
- */
3440
- orderDetails?: OrderDetails;
3441
- }
3442
- /**
3443
- * Confirms a submission.
3444
- * > **Note**:
3445
- * > The Submissions API is only available in Wix Studio.
3446
- *
3447
- *
3448
- * You can only confirm a submission that has a `PENDING` status.
3449
- * When using forms from the [Wix Pricing Plans](https://www.wix.com/app-market/paid-plans?referral=collection&appIndex=42&referralTag=made-by-wix&referralSectionName=made-by-wix) app, the default submission status is `PENDING`.
3450
- * When using forms from the [Wix Forms]() app, the default form submission status is `CONFIRMED`. You can change the default status for individual submissions using the `updateSubmission()` method.
3451
- * @param submissionId - Submission ID to confirm.
3452
- * @public
3453
- * @documentationMaturity preview
3454
- * @requiredField submissionId
3455
- * @permissionScope Manage Submissions
3456
- * @applicableIdentity APP
3457
- */
3458
- export declare function confirmSubmission(submissionId: string): Promise<ConfirmSubmissionResponse & ConfirmSubmissionResponseNonNullableFields>;
3459
- /**
3460
- * Deletes a submission.
3461
- * > **Note:**
3462
- * > The Submissions API is only available in Wix Studio.
3463
- * @param submissionId - ID of the submission to delete.
3464
- * @public
3465
- * @documentationMaturity preview
3466
- * @requiredField submissionId
3467
- * @permissionScope Manage Submissions
3468
- * @applicableIdentity APP
3469
- */
3470
- export declare function deleteSubmission(submissionId: string, options?: DeleteSubmissionOptions): Promise<void>;
3471
- export interface DeleteSubmissionOptions {
3472
- /**
3473
- * Delete submission bypassing trash-bin
3474
- * Default: false
3475
- */
3476
- permanent?: boolean;
3477
- }
3478
- /**
3479
- * Deletes submissions by IDS for specific form.
3480
- * @param formId - Form ID.
3481
- * @public
3482
- * @documentationMaturity preview
3483
- * @requiredField formId
3484
- * @permissionScope Manage Submissions
3485
- * @applicableIdentity APP
3486
- */
3487
- export declare function bulkDeleteSubmission(formId: string, options?: BulkDeleteSubmissionOptions): Promise<BulkDeleteSubmissionResponse & BulkDeleteSubmissionResponseNonNullableFields>;
3488
- export interface BulkDeleteSubmissionOptions {
3489
- /** Submission ids. */
3490
- submissionIds?: string[];
3491
- /**
3492
- * Delete submission bypassing trash-bin
3493
- * Default: false
3494
- */
3495
- permanent?: boolean;
3496
- }
3497
- /**
3498
- * Restores deleted submission
3499
- * @param submissionId - ID of the submission to restore.
3500
- * @public
3501
- * @documentationMaturity preview
3502
- * @requiredField submissionId
3503
- * @permissionScope Manage Submissions
3504
- * @applicableIdentity APP
3505
- */
3506
- export declare function restoreSubmissionFromTrashBin(submissionId: string): Promise<RestoreSubmissionFromTrashBinResponse & RestoreSubmissionFromTrashBinResponseNonNullableFields>;
3507
- /**
3508
- * Remove deleted submission
3509
- * @param submissionId - ID of the submission to restore.
3510
- * @public
3511
- * @documentationMaturity preview
3512
- * @requiredField submissionId
3513
- * @permissionScope Manage Submissions
3514
- * @applicableIdentity APP
3515
- */
3516
- export declare function removeSubmissionFromTrashBin(submissionId: string): Promise<void>;
3517
- /**
3518
- * Remove multiple deleted submissions
3519
- * @param formId - Form ID.
3520
- * @public
3521
- * @documentationMaturity preview
3522
- * @requiredField formId
3523
- * @permissionScope Manage Submissions
3524
- * @applicableIdentity APP
3525
- */
3526
- export declare function bulkRemoveSubmissionFromTrashBin(formId: string, options?: BulkRemoveSubmissionFromTrashBinOptions): Promise<BulkRemoveSubmissionFromTrashBinResponse & BulkRemoveSubmissionFromTrashBinResponseNonNullableFields>;
3527
- export interface BulkRemoveSubmissionFromTrashBinOptions {
3528
- /** Submission ids. */
3529
- submissionIds?: string[];
3530
- }
3531
- /**
3532
- * List deleted submissions
3533
- * @param formId - Form ID.
3534
- * @public
3535
- * @documentationMaturity preview
3536
- * @requiredField formId
3537
- * @permissionScope Manage Submissions
3538
- * @permissionScope Manage Orders
3539
- * @permissionScope Read Orders
3540
- * @permissionScope Read Submissions
3541
- * @applicableIdentity APP
3542
- */
3543
- export declare function listDeletedSubmissions(formId: string, options?: ListDeletedSubmissionsOptions): Promise<ListDeletedSubmissionsResponse & ListDeletedSubmissionsResponseNonNullableFields>;
3544
- export interface ListDeletedSubmissionsOptions {
3545
- /** Submission ids. */
3546
- submissionIds?: string[];
3547
- /** 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`. */
3548
- paging?: CursorPaging;
3549
- /**
3550
- * List of statuses of submissions which should be returned
3551
- * Default: CONFIRMED
3552
- */
3553
- statuses?: SubmissionStatus[];
3554
- }
3555
- /**
3556
- * Get deleted submission
3557
- * @param submissionId - Submission id.
3558
- * @public
3559
- * @documentationMaturity preview
3560
- * @requiredField submissionId
3561
- * @permissionScope Manage Submissions
3562
- * @permissionScope Manage Orders
3563
- * @permissionScope Read Orders
3564
- * @permissionScope Read Submissions
3565
- * @applicableIdentity APP
3566
- */
3567
- export declare function getDeletedSubmission(submissionId: string): Promise<GetDeletedSubmissionResponse & GetDeletedSubmissionResponseNonNullableFields>;
3568
- /**
3569
- * Creates a query to retrieve a list of submissions.
3570
- * > **Note:**
3571
- * > The Submissions API is only available in Wix Studio.
3572
- *
3573
- *
3574
- * The `querySubmissionsByNamespace()` method builds a query to retrieve a list of submissions from the specified namespace and returns a [`SubmissionsQueryBuilder`](#submissionsquerybuilder) object.
3575
- * >**Note:** You can only query submissions from a specified namespace. Use the query filter on the `namespace` field, otherwise you will receive an error.
3576
- *
3577
- * The returned object contains the query definition, which is typically used to run the query using the [`find()`](#submissionsquerybuilder/find) method.
3578
- *
3579
- * You can refine the query by chaining `SubmissionsQueryBuilder` methods onto the query. `SubmissionsQueryBuilder` methods enable you to sort, filter, and control the results that `querySubmissionsByNamespace()` returns.
3580
- *
3581
- * The following `SubmissionsQueryBuilder` methods are supported for `querySubmissionsByNamespace()`. For a full description of the Submissions object, see the object returned for the [`items`](#submissionsqueryresult/items) property in [`SubmissionsQueryResult`](#submissionsqueryresult).
3582
- * @public
3583
- * @documentationMaturity preview
3584
- * @param options - Query options.
3585
- * @permissionScope Manage Submissions
3586
- * @permissionScope Manage Orders
3587
- * @permissionScope Read Orders
3588
- * @permissionScope Read Submissions
3589
- * @applicableIdentity APP
3590
- */
3591
- export declare function querySubmissionsByNamespace(options?: QuerySubmissionsByNamespaceOptions): SubmissionsQueryBuilder;
3592
- export interface QuerySubmissionsByNamespaceOptions {
3593
- /** Whether to return only your own submissions. If `false`, returns all submissions based on query filters. */
3594
- onlyYourOwn?: boolean | undefined;
3595
- }
3596
- interface QueryCursorResult {
3597
- cursors: Cursors;
3598
- hasNext: () => boolean;
3599
- hasPrev: () => boolean;
3600
- length: number;
3601
- pageSize: number;
3602
- }
3603
- export interface SubmissionsQueryResult extends QueryCursorResult {
3604
- items: FormSubmission[];
3605
- query: SubmissionsQueryBuilder;
3606
- next: () => Promise<SubmissionsQueryResult>;
3607
- prev: () => Promise<SubmissionsQueryResult>;
3608
- }
3609
- export interface SubmissionsQueryBuilder {
3610
- /** @param propertyName - Property whose value is compared with `value`.
3611
- * @param value - Value to compare against.
3612
- * @documentationMaturity preview
3613
- */
3614
- eq: (propertyName: '_id' | 'formId' | 'namespace' | 'status' | '_createdDate' | '_updatedDate' | 'seen', value: any) => SubmissionsQueryBuilder;
3615
- /** @param propertyName - Property whose value is compared with `value`.
3616
- * @param value - Value to compare against.
3617
- * @documentationMaturity preview
3618
- */
3619
- ne: (propertyName: '_id' | 'formId' | 'namespace' | 'status' | '_createdDate' | '_updatedDate' | 'seen', value: any) => SubmissionsQueryBuilder;
3620
- /** @param propertyName - Property whose value is compared with `value`.
3621
- * @param value - Value to compare against.
3622
- * @documentationMaturity preview
3623
- */
3624
- ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => SubmissionsQueryBuilder;
3625
- /** @param propertyName - Property whose value is compared with `value`.
3626
- * @param value - Value to compare against.
3627
- * @documentationMaturity preview
3628
- */
3629
- gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => SubmissionsQueryBuilder;
3630
- /** @param propertyName - Property whose value is compared with `value`.
3631
- * @param value - Value to compare against.
3632
- * @documentationMaturity preview
3633
- */
3634
- le: (propertyName: '_createdDate' | '_updatedDate', value: any) => SubmissionsQueryBuilder;
3635
- /** @param propertyName - Property whose value is compared with `value`.
3636
- * @param value - Value to compare against.
3637
- * @documentationMaturity preview
3638
- */
3639
- lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => SubmissionsQueryBuilder;
3640
- /** @documentationMaturity preview */
3641
- in: (propertyName: '_id' | 'formId' | 'namespace' | 'status' | '_createdDate' | '_updatedDate', value: any) => SubmissionsQueryBuilder;
3642
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
3643
- * @documentationMaturity preview
3644
- */
3645
- ascending: (...propertyNames: Array<'_id' | 'formId' | 'namespace' | 'status' | '_createdDate' | '_updatedDate' | 'seen'>) => SubmissionsQueryBuilder;
3646
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
3647
- * @documentationMaturity preview
3648
- */
3649
- descending: (...propertyNames: Array<'_id' | 'formId' | 'namespace' | 'status' | '_createdDate' | '_updatedDate' | 'seen'>) => SubmissionsQueryBuilder;
3650
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
3651
- * @documentationMaturity preview
3652
- */
3653
- limit: (limit: number) => SubmissionsQueryBuilder;
3654
- /** @param cursor - A pointer to specific record
3655
- * @documentationMaturity preview
3656
- */
3657
- skipTo: (cursor: string) => SubmissionsQueryBuilder;
3658
- /** @documentationMaturity preview */
3659
- find: () => Promise<SubmissionsQueryResult>;
3660
- }
3661
- /**
3662
- * Counts the number of submissions belonging to the specified forms.
3663
- * > **Note**:
3664
- * > The Submissions API is only available in Wix Studio.
3665
- * @param formIds - Form IDs.
3666
- * @param namespace - 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.
3667
- * @public
3668
- * @documentationMaturity preview
3669
- * @requiredField formIds
3670
- * @requiredField namespace
3671
- * @permissionScope Manage Submissions
3672
- * @permissionScope Manage Orders
3673
- * @permissionScope Read Orders
3674
- * @permissionScope Read Submissions
3675
- * @applicableIdentity APP
3676
- */
3677
- export declare function countSubmissions(formIds: string[], namespace: string, options?: CountSubmissionsOptions): Promise<CountSubmissionsResponse & CountSubmissionsResponseNonNullableFields>;
3678
- export interface CountSubmissionsOptions {
3679
- /**
3680
- * List of statuses of submissions which should be taken into count
3681
- * Default: CONFIRMED, PAYMENT_WAITING, PAYMENT_CANCELED
3682
- */
3683
- statuses?: SubmissionStatus[];
3684
- }
3685
- /**
3686
- * > **Note:**
3687
- * > The Submissions API is only available in the Wix Studio editor.
3688
- *
3689
- * Counts the number of submissions belonging to the specified forms.
3690
- * @param formIds - Form IDs.
3691
- * @param namespace - 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.
3692
- * @public
3693
- * @documentationMaturity preview
3694
- * @requiredField formIds
3695
- * @requiredField namespace
3696
- * @permissionScope Manage Submissions
3697
- * @permissionScope Manage Orders
3698
- * @permissionScope Read Orders
3699
- * @permissionScope Read Submissions
3700
- * @applicableIdentity APP
3701
- */
3702
- export declare function countDeletedSubmissions(formIds: string[], namespace: string, options?: CountDeletedSubmissionsOptions): Promise<CountDeletedSubmissionsResponse & CountDeletedSubmissionsResponseNonNullableFields>;
3703
- export interface CountDeletedSubmissionsOptions {
3704
- /**
3705
- * List of statuses of submissions which should be taken into count
3706
- * Default: CONFIRMED, PAYMENT_WAITING, PAYMENT_CANCELED
3707
- */
3708
- statuses?: SubmissionStatus[];
3709
- }
3710
- /**
3711
- * Retrieves a URL generated by the Media Manager to use when creating a submission that includes a field for uploading files.
3712
- * > **Note:**
3713
- * > The Submissions API is only available in Wix Studio.
3714
- * @param formId - Form ID.
3715
- * @param filename - Name of file to upload.
3716
- * @param mimeType - [Mime type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#) of file to upload.
3717
- *
3718
- * For example, `'image/png'`
3719
- * @public
3720
- * @documentationMaturity preview
3721
- * @requiredField filename
3722
- * @requiredField formId
3723
- * @requiredField mimeType
3724
- * @permissionScope Manage Submissions
3725
- * @applicableIdentity APP
3726
- * @applicableIdentity MEMBER
3727
- * @applicableIdentity VISITOR
3728
- */
3729
- export declare function getMediaUploadUrl(formId: string, filename: string, mimeType: string): Promise<GetMediaUploadURLResponse & GetMediaUploadURLResponseNonNullableFields>;
3730
- /**
3731
- * Marks form submissions as **seen**.
3732
- * > **Note**:
3733
- * > The Submissions API is only available in Wix Studio.
3734
- *
3735
- *
3736
- * Only site collaborators with **Manage Submission** permissions can mark submissions.
3737
- * @param ids - Submission IDs to mark as seen.
3738
- * @param formId - ID of the form which the submissions belongs to.
3739
- * @public
3740
- * @documentationMaturity preview
3741
- * @requiredField formId
3742
- * @requiredField ids
3743
- * @permissionScope Manage Submissions
3744
- * @permissionScope Manage Orders
3745
- * @permissionScope Read Orders
3746
- * @permissionScope Read Submissions
3747
- * @applicableIdentity APP
3748
- */
3749
- export declare function bulkMarkSubmissionsAsSeen(ids: string[], formId: string): Promise<void>;
3750
- export {};