@wix/auto_sdk_forms_submissions 1.0.0

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