@wix/forms 1.0.30 → 1.0.32

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 (31) hide show
  1. package/build/cjs/src/forms-v4-submission.http.d.ts +5 -1
  2. package/build/cjs/src/forms-v4-submission.http.js +57 -1
  3. package/build/cjs/src/forms-v4-submission.http.js.map +1 -1
  4. package/build/cjs/src/forms-v4-submission.meta.d.ts +4 -0
  5. package/build/cjs/src/forms-v4-submission.meta.js +39 -1
  6. package/build/cjs/src/forms-v4-submission.meta.js.map +1 -1
  7. package/build/cjs/src/forms-v4-submission.public.d.ts +5 -3
  8. package/build/cjs/src/forms-v4-submission.public.js +64 -1
  9. package/build/cjs/src/forms-v4-submission.public.js.map +1 -1
  10. package/build/cjs/src/forms-v4-submission.types.d.ts +2444 -53
  11. package/build/cjs/src/forms-v4-submission.types.js +469 -1
  12. package/build/cjs/src/forms-v4-submission.types.js.map +1 -1
  13. package/build/cjs/src/forms-v4-submission.universal.d.ts +2447 -53
  14. package/build/cjs/src/forms-v4-submission.universal.js +584 -1
  15. package/build/cjs/src/forms-v4-submission.universal.js.map +1 -1
  16. package/build/es/src/forms-v4-submission.http.d.ts +5 -1
  17. package/build/es/src/forms-v4-submission.http.js +54 -0
  18. package/build/es/src/forms-v4-submission.http.js.map +1 -1
  19. package/build/es/src/forms-v4-submission.meta.d.ts +4 -0
  20. package/build/es/src/forms-v4-submission.meta.js +36 -0
  21. package/build/es/src/forms-v4-submission.meta.js.map +1 -1
  22. package/build/es/src/forms-v4-submission.public.d.ts +5 -3
  23. package/build/es/src/forms-v4-submission.public.js +12 -2
  24. package/build/es/src/forms-v4-submission.public.js.map +1 -1
  25. package/build/es/src/forms-v4-submission.types.d.ts +2444 -53
  26. package/build/es/src/forms-v4-submission.types.js +467 -0
  27. package/build/es/src/forms-v4-submission.types.js.map +1 -1
  28. package/build/es/src/forms-v4-submission.universal.d.ts +2447 -53
  29. package/build/es/src/forms-v4-submission.universal.js +580 -0
  30. package/build/es/src/forms-v4-submission.universal.js.map +1 -1
  31. package/package.json +2 -2
@@ -59,11 +59,9 @@ export interface Owner extends OwnerOwnerOneOf {
59
59
  /** Visitor ID. */
60
60
  visitorId?: string | null;
61
61
  /** Service ID. */
62
- serviceId?: string | null;
62
+ applicationId?: string | null;
63
63
  /** User ID. */
64
64
  userId?: string | null;
65
- /** External app id */
66
- externalAppId?: string | null;
67
65
  }
68
66
  /** @oneof */
69
67
  export interface OwnerOwnerOneOf {
@@ -72,23 +70,19 @@ export interface OwnerOwnerOneOf {
72
70
  /** Visitor ID. */
73
71
  visitorId?: string | null;
74
72
  /** Service ID. */
75
- serviceId?: string | null;
73
+ applicationId?: string | null;
76
74
  /** User ID. */
77
75
  userId?: string | null;
78
- /** External app id */
79
- externalAppId?: string | null;
80
76
  }
81
77
  export interface Submitter extends SubmitterSubmitterOneOf {
82
78
  /** Member ID. */
83
79
  memberId?: string | null;
84
80
  /** Visitor ID. */
85
81
  visitorId?: string | null;
86
- /** Service ID. */
87
- serviceId?: string | null;
82
+ /** Application ID. */
83
+ applicationId?: string | null;
88
84
  /** User ID. */
89
85
  userId?: string | null;
90
- /** App ID. */
91
- externalAppId?: string | null;
92
86
  }
93
87
  /** @oneof */
94
88
  export interface SubmitterSubmitterOneOf {
@@ -96,19 +90,2376 @@ export interface SubmitterSubmitterOneOf {
96
90
  memberId?: string | null;
97
91
  /** Visitor ID. */
98
92
  visitorId?: string | null;
99
- /** Service ID. */
100
- serviceId?: string | null;
93
+ /** Application ID. */
94
+ applicationId?: string | null;
101
95
  /** User ID. */
102
96
  userId?: string | null;
103
- /** App ID. */
104
- externalAppId?: string | null;
97
+ }
98
+ export interface CreateCheckoutFromSubmissionRequest extends CreateCheckoutFromSubmissionRequestFormSchemaIdentifierOneOf {
99
+ /** Submission's form. */
100
+ form?: Form;
101
+ /** Submission to create checkout from. */
102
+ submission?: FormSubmission;
103
+ }
104
+ /** @oneof */
105
+ export interface CreateCheckoutFromSubmissionRequestFormSchemaIdentifierOneOf {
106
+ /** Submission's form. */
107
+ form?: Form;
108
+ }
109
+ export interface Form {
110
+ /**
111
+ * Form ID.
112
+ * @readonly
113
+ */
114
+ id?: string | null;
115
+ /** List of form fields that represent input elements. */
116
+ fields?: FormField[];
117
+ /**
118
+ * List of form fields that represent input elements.
119
+ * @readonly
120
+ */
121
+ fieldsV2?: FormFieldV2[];
122
+ /** Defines the layout for form fields in each submission step. */
123
+ steps?: Step[];
124
+ /** Form rules, can be applied to layout and items properties. */
125
+ rules?: FormRule[];
126
+ /**
127
+ * 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.
128
+ * @readonly
129
+ */
130
+ revision?: string | null;
131
+ /**
132
+ * Date of creation.
133
+ * @readonly
134
+ */
135
+ createdDate?: Date;
136
+ /**
137
+ * Date of last update.
138
+ * @readonly
139
+ */
140
+ updatedDate?: Date;
141
+ /** Properties of the form. */
142
+ properties?: FormProperties;
143
+ /**
144
+ * Fields which were soft deleted.
145
+ * @readonly
146
+ */
147
+ deletedFields?: FormField[];
148
+ /**
149
+ * List of form fields that represent input elements.
150
+ * @readonly
151
+ */
152
+ deletedFieldsV2?: FormFieldV2[];
153
+ /**
154
+ * Regular forms can be freely modified.
155
+ * Extensions are copied from templates and might have restrictions.
156
+ * @readonly
157
+ */
158
+ kind?: Kind;
159
+ /**
160
+ * Defines triggers that will be executed after the submission, for the submissions based on this schema.
161
+ * Forms provide a set of predefined triggers that allow it to assign specific business cases to created forms.
162
+ */
163
+ postSubmissionTriggers?: PostSubmissionTriggers;
164
+ /** Data extensions ExtendedFields. */
165
+ extendedFields?: ExtendedFields;
166
+ /** Identifies the namespace that the form belongs to. */
167
+ namespace?: string;
168
+ /**
169
+ * Media folder ID.
170
+ * @readonly
171
+ */
172
+ mediaFolderId?: string | null;
173
+ }
174
+ export interface FormField {
175
+ /** Item ID. */
176
+ id?: string;
177
+ /** Definition of a target where the value of field belongs. */
178
+ target?: string | null;
179
+ /** Validation of field output value. */
180
+ validation?: Validation;
181
+ /** Mark the field as containing personal information. This will encrypt user data when storing it. */
182
+ pii?: boolean;
183
+ /** Whether the field is hidden. */
184
+ hidden?: boolean;
185
+ /** Field view properties. */
186
+ view?: Record<string, any> | null;
187
+ }
188
+ export interface StringType {
189
+ /** Minimum length. */
190
+ minLength?: number | null;
191
+ /** Maximum length. */
192
+ maxLength?: number | null;
193
+ /** Pattern for a regular expression match. */
194
+ pattern?: string | null;
195
+ /** Format of a string. */
196
+ format?: Format;
197
+ /** Custom error messages when validation fails. */
198
+ errorMessages?: StringErrorMessages;
199
+ /** List of allowed values. */
200
+ enum?: string[] | null;
201
+ }
202
+ export declare enum Format {
203
+ UNDEFINED = "UNDEFINED",
204
+ DATE = "DATE",
205
+ TIME = "TIME",
206
+ DATE_TIME = "DATE_TIME",
207
+ EMAIL = "EMAIL",
208
+ URL = "URL",
209
+ UUID = "UUID",
210
+ PHONE = "PHONE",
211
+ URI = "URI",
212
+ HOSTNAME = "HOSTNAME",
213
+ COLOR_HEX = "COLOR_HEX",
214
+ CURRENCY = "CURRENCY",
215
+ LANGUAGE = "LANGUAGE"
216
+ }
217
+ export interface StringErrorMessages {
218
+ /** Default error message on invalid validation. */
219
+ default?: string | null;
220
+ }
221
+ export interface NumberType {
222
+ /** Inclusive maximum value. */
223
+ maximum?: number | null;
224
+ /** Inclusive minimum value. */
225
+ minimum?: number | null;
226
+ /** Multiple of value. */
227
+ multipleOf?: number | null;
228
+ /** Custom error message when validation fails. */
229
+ errorMessages?: NumberErrorMessages;
230
+ /** List of allowed values. */
231
+ enum?: number[] | null;
232
+ }
233
+ export interface NumberErrorMessages {
234
+ /** Default error message on invalid validation. */
235
+ default?: string | null;
236
+ }
237
+ export interface IntegerType {
238
+ /** Minimum value. */
239
+ maximum?: number | null;
240
+ /** Maximum value. */
241
+ minimum?: number | null;
242
+ /** Multiple of value. */
243
+ multipleOf?: number | null;
244
+ /** Custom error message when validation fails. */
245
+ errorMessages?: NumberErrorMessages;
246
+ /** List of allowed values. */
247
+ enum?: number[] | null;
248
+ }
249
+ export interface BooleanType {
250
+ /** Custom error message when validation fails. */
251
+ errorMessages?: BooleanErrorMessages;
252
+ /** List of allowed values. */
253
+ enum?: boolean[];
254
+ }
255
+ export interface BooleanErrorMessages {
256
+ /** Default error message on invalid validation. */
257
+ default?: string | null;
258
+ }
259
+ export interface ArrayType {
260
+ /** Maximum amount of array elements. */
261
+ maxItems?: number | null;
262
+ /** Minimum amount of array elements. */
263
+ minItems?: number | null;
264
+ /** Type of items allowed in array. */
265
+ items?: ArrayItems;
266
+ /** Custom error message when validation fails. */
267
+ errorMessages?: ArrayErrorMessages;
268
+ }
269
+ export interface ObjectType {
270
+ /** Description of object properties. */
271
+ properties?: Record<string, PropertiesType>;
272
+ /** Custom error message when validation fails. */
273
+ errorMessages?: ObjectErrorMessages;
274
+ }
275
+ export interface PropertiesType extends PropertiesTypePropertiesTypeOneOf {
276
+ /** String type validation for property. */
277
+ string?: StringType;
278
+ /** Number type validation for property. */
279
+ number?: NumberType;
280
+ /** Boolean type validation for property. */
281
+ boolean?: BooleanType;
282
+ /** Integer type validation for property. */
283
+ integer?: IntegerType;
284
+ /** Array type validation for property. */
285
+ array?: ArrayType;
286
+ /** Whether the property is required. */
287
+ required?: boolean;
288
+ }
289
+ /** @oneof */
290
+ export interface PropertiesTypePropertiesTypeOneOf {
291
+ /** String type validation for property. */
292
+ string?: StringType;
293
+ /** Number type validation for property. */
294
+ number?: NumberType;
295
+ /** Boolean type validation for property. */
296
+ boolean?: BooleanType;
297
+ /** Integer type validation for property. */
298
+ integer?: IntegerType;
299
+ /** Array type validation for property. */
300
+ array?: ArrayType;
301
+ }
302
+ export interface ObjectErrorMessages {
303
+ /** Default error message on invalid validation. */
304
+ default?: string | null;
305
+ }
306
+ export interface ArrayItems extends ArrayItemsItemsOneOf {
307
+ /** String type validation for items. */
308
+ string?: StringType;
309
+ /** Number type validation for items. */
310
+ number?: NumberType;
311
+ /** Boolean type validation for items. */
312
+ boolean?: BooleanType;
313
+ /** Integer type validation for items. */
314
+ integer?: IntegerType;
315
+ /** Object type validation for items */
316
+ object?: ObjectType;
317
+ }
318
+ /** @oneof */
319
+ export interface ArrayItemsItemsOneOf {
320
+ /** String type validation for items. */
321
+ string?: StringType;
322
+ /** Number type validation for items. */
323
+ number?: NumberType;
324
+ /** Boolean type validation for items. */
325
+ boolean?: BooleanType;
326
+ /** Integer type validation for items. */
327
+ integer?: IntegerType;
328
+ /** Object type validation for items */
329
+ object?: ObjectType;
330
+ }
331
+ export interface ArrayErrorMessages {
332
+ /** Default error message on invalid validation. */
333
+ default?: string | null;
334
+ }
335
+ export interface PredefinedValidation {
336
+ /** Format of predefined validation. */
337
+ format?: ValidationFormat;
338
+ }
339
+ export declare enum ValidationFormat {
340
+ UNDEFINED = "UNDEFINED",
341
+ /** File upload validation. */
342
+ WIX_FILE = "WIX_FILE",
343
+ /** Payment validation (described in payment trigger). */
344
+ PAYMENT = "PAYMENT"
345
+ }
346
+ export interface NestedFormFieldOverrides {
347
+ /** Whether the field is required. Leave blank for no override. */
348
+ required?: boolean | null;
349
+ /** Whether the field is hidden. Leave blank for no override. */
350
+ hidden?: boolean | null;
351
+ }
352
+ export interface Validation extends ValidationValidationOneOf {
353
+ /** Validation of string type. */
354
+ string?: StringType;
355
+ /** Validation of number type. */
356
+ number?: NumberType;
357
+ /** Validation of integer type. */
358
+ integer?: IntegerType;
359
+ /** Validation of boolean type. */
360
+ boolean?: BooleanType;
361
+ /** Validation of array type. */
362
+ array?: ArrayType;
363
+ /** Validation of object type. */
364
+ object?: ObjectType;
365
+ /** Predefined validation of specific format */
366
+ predefined?: PredefinedValidation;
367
+ /** Whether the field is required. */
368
+ required?: boolean;
369
+ }
370
+ /** @oneof */
371
+ export interface ValidationValidationOneOf {
372
+ /** Validation of string type. */
373
+ string?: StringType;
374
+ /** Validation of number type. */
375
+ number?: NumberType;
376
+ /** Validation of integer type. */
377
+ integer?: IntegerType;
378
+ /** Validation of boolean type. */
379
+ boolean?: BooleanType;
380
+ /** Validation of array type. */
381
+ array?: ArrayType;
382
+ /** Validation of object type. */
383
+ object?: ObjectType;
384
+ /** Predefined validation of specific format */
385
+ predefined?: PredefinedValidation;
386
+ }
387
+ export interface NestedFormOverrides {
388
+ /** Field overrides by field ID */
389
+ fieldOverrides?: Record<string, NestedFormFieldOverrides>;
390
+ }
391
+ export interface FormFieldV2 extends FormFieldV2FieldTypeOptionsOneOf {
392
+ /** Field accept input of data */
393
+ inputOptions?: InputField;
394
+ /** Field for displaying information */
395
+ displayOptions?: DisplayField;
396
+ /** Submit button of the form */
397
+ submitOptions?: SubmitButton;
398
+ /** Field id. */
399
+ id?: string;
400
+ /**
401
+ * Whether the field is hidden.
402
+ * Default: false
403
+ */
404
+ hidden?: boolean;
405
+ /** Custom identification of field, can be used to specify exceptional behaviour of client for specific field */
406
+ identifier?: string | null;
407
+ /**
408
+ * Type of the field
409
+ * @readonly
410
+ */
411
+ fieldType?: FieldType;
412
+ }
413
+ /** @oneof */
414
+ export interface FormFieldV2FieldTypeOptionsOneOf {
415
+ /** Field accept input of data */
416
+ inputOptions?: InputField;
417
+ /** Field for displaying information */
418
+ displayOptions?: DisplayField;
419
+ /** Submit button of the form */
420
+ submitOptions?: SubmitButton;
421
+ }
422
+ export interface RichContent {
423
+ /** Node objects representing a rich content document. */
424
+ nodes?: Node[];
425
+ /** Object metadata. */
426
+ metadata?: Metadata;
427
+ /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
428
+ documentStyle?: DocumentStyle;
429
+ }
430
+ export interface Node extends NodeDataOneOf {
431
+ /** Data for a button node. */
432
+ buttonData?: ButtonData;
433
+ /** Data for a code block node. */
434
+ codeBlockData?: CodeBlockData;
435
+ /** Data for a divider node. */
436
+ dividerData?: DividerData;
437
+ /** Data for a file node. */
438
+ fileData?: FileData;
439
+ /** Data for a gallery node. */
440
+ galleryData?: GalleryData;
441
+ /** Data for a GIF node. */
442
+ gifData?: GIFData;
443
+ /** Data for a heading node. */
444
+ headingData?: HeadingData;
445
+ /** Data for an embedded HTML node. */
446
+ htmlData?: HTMLData;
447
+ /** Data for an image node. */
448
+ imageData?: ImageData;
449
+ /** Data for a link preview node. */
450
+ linkPreviewData?: LinkPreviewData;
451
+ /** Data for a map node. */
452
+ mapData?: MapData;
453
+ /** Data for a paragraph node. */
454
+ paragraphData?: ParagraphData;
455
+ /** Data for a poll node. */
456
+ pollData?: PollData;
457
+ /** Data for a text node. Used to apply decorations to text. */
458
+ textData?: TextData;
459
+ /** Data for an app embed node. */
460
+ appEmbedData?: AppEmbedData;
461
+ /** Data for a video node. */
462
+ videoData?: VideoData;
463
+ /** Data for an oEmbed node. */
464
+ embedData?: EmbedData;
465
+ /** Data for a collapsible list node. */
466
+ collapsibleListData?: CollapsibleListData;
467
+ /** Data for a table node. */
468
+ tableData?: TableData;
469
+ /** Data for a table cell node. */
470
+ tableCellData?: TableCellData;
471
+ /** Data for a custon external node. */
472
+ externalData?: Record<string, any> | null;
473
+ /** Data for an audio node. */
474
+ audioData?: AudioData;
475
+ /** Data for an ordered list node. */
476
+ orderedListData?: OrderedListData;
477
+ /** Data for a bulleted list node. */
478
+ bulletedListData?: BulletedListData;
479
+ /** Data for a block quote node. */
480
+ blockquoteData?: BlockquoteData;
481
+ /** 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. */
482
+ type?: NodeType;
483
+ /** Node ID. */
484
+ id?: string;
485
+ /** A list of child nodes. */
486
+ nodes?: Node[];
487
+ /** Padding and background color styling for the node. */
488
+ style?: NodeStyle;
489
+ }
490
+ /** @oneof */
491
+ export interface NodeDataOneOf {
492
+ /** Data for a button node. */
493
+ buttonData?: ButtonData;
494
+ /** Data for a code block node. */
495
+ codeBlockData?: CodeBlockData;
496
+ /** Data for a divider node. */
497
+ dividerData?: DividerData;
498
+ /** Data for a file node. */
499
+ fileData?: FileData;
500
+ /** Data for a gallery node. */
501
+ galleryData?: GalleryData;
502
+ /** Data for a GIF node. */
503
+ gifData?: GIFData;
504
+ /** Data for a heading node. */
505
+ headingData?: HeadingData;
506
+ /** Data for an embedded HTML node. */
507
+ htmlData?: HTMLData;
508
+ /** Data for an image node. */
509
+ imageData?: ImageData;
510
+ /** Data for a link preview node. */
511
+ linkPreviewData?: LinkPreviewData;
512
+ /** Data for a map node. */
513
+ mapData?: MapData;
514
+ /** Data for a paragraph node. */
515
+ paragraphData?: ParagraphData;
516
+ /** Data for a poll node. */
517
+ pollData?: PollData;
518
+ /** Data for a text node. Used to apply decorations to text. */
519
+ textData?: TextData;
520
+ /** Data for an app embed node. */
521
+ appEmbedData?: AppEmbedData;
522
+ /** Data for a video node. */
523
+ videoData?: VideoData;
524
+ /** Data for an oEmbed node. */
525
+ embedData?: EmbedData;
526
+ /** Data for a collapsible list node. */
527
+ collapsibleListData?: CollapsibleListData;
528
+ /** Data for a table node. */
529
+ tableData?: TableData;
530
+ /** Data for a table cell node. */
531
+ tableCellData?: TableCellData;
532
+ /** Data for a custon external node. */
533
+ externalData?: Record<string, any> | null;
534
+ /** Data for an audio node. */
535
+ audioData?: AudioData;
536
+ /** Data for an ordered list node. */
537
+ orderedListData?: OrderedListData;
538
+ /** Data for a bulleted list node. */
539
+ bulletedListData?: BulletedListData;
540
+ /** Data for a block quote node. */
541
+ blockquoteData?: BlockquoteData;
542
+ }
543
+ export declare enum NodeType {
544
+ PARAGRAPH = "PARAGRAPH",
545
+ TEXT = "TEXT",
546
+ HEADING = "HEADING",
547
+ BULLETED_LIST = "BULLETED_LIST",
548
+ ORDERED_LIST = "ORDERED_LIST",
549
+ LIST_ITEM = "LIST_ITEM",
550
+ BLOCKQUOTE = "BLOCKQUOTE",
551
+ CODE_BLOCK = "CODE_BLOCK",
552
+ VIDEO = "VIDEO",
553
+ DIVIDER = "DIVIDER",
554
+ FILE = "FILE",
555
+ GALLERY = "GALLERY",
556
+ GIF = "GIF",
557
+ HTML = "HTML",
558
+ IMAGE = "IMAGE",
559
+ LINK_PREVIEW = "LINK_PREVIEW",
560
+ MAP = "MAP",
561
+ POLL = "POLL",
562
+ APP_EMBED = "APP_EMBED",
563
+ BUTTON = "BUTTON",
564
+ COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
565
+ TABLE = "TABLE",
566
+ EMBED = "EMBED",
567
+ COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
568
+ COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
569
+ COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
570
+ TABLE_CELL = "TABLE_CELL",
571
+ TABLE_ROW = "TABLE_ROW",
572
+ EXTERNAL = "EXTERNAL",
573
+ AUDIO = "AUDIO"
574
+ }
575
+ export interface NodeStyle {
576
+ /** The top padding value in pixels. */
577
+ paddingTop?: string | null;
578
+ /** The bottom padding value in pixels. */
579
+ paddingBottom?: string | null;
580
+ /** The background color as a hexadecimal value. */
581
+ backgroundColor?: string | null;
582
+ }
583
+ export interface ButtonData {
584
+ /** Styling for the button's container. */
585
+ containerData?: PluginContainerData;
586
+ /** The button type. */
587
+ type?: Type;
588
+ /** Styling for the button. */
589
+ styles?: Styles;
590
+ /** The text to display on the button. */
591
+ text?: string | null;
592
+ /** Button link details. */
593
+ link?: Link;
594
+ }
595
+ export interface Border {
596
+ /** Border width in pixels. */
597
+ width?: number | null;
598
+ /** Border radius in pixels. */
599
+ radius?: number | null;
600
+ }
601
+ export interface Colors {
602
+ /** The text color as a hexadecimal value. */
603
+ text?: string | null;
604
+ /** The border color as a hexadecimal value. */
605
+ border?: string | null;
606
+ /** The background color as a hexadecimal value. */
607
+ background?: string | null;
608
+ }
609
+ export interface PluginContainerData {
610
+ /** The width of the node when it's displayed. */
611
+ width?: PluginContainerDataWidth;
612
+ /** The node's alignment within its container. */
613
+ alignment?: PluginContainerDataAlignment;
614
+ /** Spoiler cover settings for the node. */
615
+ spoiler?: Spoiler;
616
+ /** The height of the node when it's displayed. */
617
+ height?: Height;
618
+ /** 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. */
619
+ textWrap?: boolean | null;
620
+ }
621
+ export declare enum WidthType {
622
+ /** Width matches the content width */
623
+ CONTENT = "CONTENT",
624
+ /** Small Width */
625
+ SMALL = "SMALL",
626
+ /** Width will match the original asset width */
627
+ ORIGINAL = "ORIGINAL",
628
+ /** coast-to-coast display */
629
+ FULL_WIDTH = "FULL_WIDTH"
630
+ }
631
+ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
632
+ /**
633
+ * One of the following predefined width options:
634
+ * `CONTENT`: The width of the container matches the content width.
635
+ * `SMALL`: Small width.
636
+ * `ORIGINAL`: The width of the container matches the original asset width.
637
+ * `FULL_WIDTH`: Full width.
638
+ */
639
+ size?: WidthType;
640
+ /** A custom width value in pixels. */
641
+ custom?: string | null;
642
+ }
643
+ /** @oneof */
644
+ export interface PluginContainerDataWidthDataOneOf {
645
+ /**
646
+ * One of the following predefined width options:
647
+ * `CONTENT`: The width of the container matches the content width.
648
+ * `SMALL`: Small width.
649
+ * `ORIGINAL`: The width of the container matches the original asset width.
650
+ * `FULL_WIDTH`: Full width.
651
+ */
652
+ size?: WidthType;
653
+ /** A custom width value in pixels. */
654
+ custom?: string | null;
655
+ }
656
+ export declare enum PluginContainerDataAlignment {
657
+ /** Center Alignment */
658
+ CENTER = "CENTER",
659
+ /** Left Alignment */
660
+ LEFT = "LEFT",
661
+ /** Right Alignment */
662
+ RIGHT = "RIGHT"
663
+ }
664
+ export interface Spoiler {
665
+ /** Sets whether the spoiler cover is enabled for this node. */
666
+ enabled?: boolean | null;
667
+ /** The description displayed on top of the spoiler cover. */
668
+ description?: string | null;
669
+ /** The text for the button used to remove the spoiler cover. */
670
+ buttonText?: string | null;
671
+ }
672
+ export interface Height {
673
+ /** A custom height value in pixels. */
674
+ custom?: string | null;
675
+ }
676
+ export declare enum Type {
677
+ /** Regular link button */
678
+ LINK = "LINK",
679
+ /** Triggers custom action that is defined in plugin configuration by the consumer */
680
+ ACTION = "ACTION"
681
+ }
682
+ export interface Styles {
683
+ /** Border attributes. */
684
+ border?: Border;
685
+ /** Color attributes. */
686
+ colors?: Colors;
687
+ }
688
+ export interface Link extends LinkDataOneOf {
689
+ /** The absolute URL for the linked document. */
690
+ url?: string;
691
+ /** The target node's ID. Used for linking to another node in this object. */
692
+ anchor?: string;
693
+ /**
694
+ * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
695
+ * `SELF` - Default. Opens the linked document in the same frame as the link.
696
+ * `BLANK` - Opens the linked document in a new browser tab or window.
697
+ * `PARENT` - Opens the linked document in the link's parent frame.
698
+ * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
699
+ */
700
+ target?: LinkTarget;
701
+ /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
702
+ rel?: Rel;
703
+ /** A serialized object used for a custom or external link panel. */
704
+ customData?: string | null;
705
+ }
706
+ /** @oneof */
707
+ export interface LinkDataOneOf {
708
+ /** The absolute URL for the linked document. */
709
+ url?: string;
710
+ /** The target node's ID. Used for linking to another node in this object. */
711
+ anchor?: string;
712
+ }
713
+ export declare enum LinkTarget {
714
+ /** Opens the linked document in the same frame as it was clicked (this is default) */
715
+ SELF = "SELF",
716
+ /** Opens the linked document in a new window or tab */
717
+ BLANK = "BLANK",
718
+ /** Opens the linked document in the parent frame */
719
+ PARENT = "PARENT",
720
+ /** Opens the linked document in the full body of the window */
721
+ TOP = "TOP"
722
+ }
723
+ export interface Rel {
724
+ /** Indicates to search engine crawlers not to follow the link. */
725
+ nofollow?: boolean | null;
726
+ /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. */
727
+ sponsored?: boolean | null;
728
+ /** 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. */
729
+ ugc?: boolean | null;
730
+ /** Indicates that this link protect referral information from being passed to the target website. */
731
+ noreferrer?: boolean | null;
732
+ }
733
+ export interface CodeBlockData {
734
+ /** Styling for the code block's text. */
735
+ textStyle?: TextStyle;
736
+ }
737
+ export interface TextStyle {
738
+ /** Text alignment. Defaults to `AUTO`. */
739
+ textAlignment?: TextAlignment;
740
+ /** A CSS `line-height` value for the text as a unitless ratio. */
741
+ lineHeight?: string | null;
742
+ }
743
+ export declare enum TextAlignment {
744
+ /** browser default, eqivalent to `initial` */
745
+ AUTO = "AUTO",
746
+ /** Left align */
747
+ LEFT = "LEFT",
748
+ /** Right align */
749
+ RIGHT = "RIGHT",
750
+ /** Center align */
751
+ CENTER = "CENTER",
752
+ /** 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. */
753
+ JUSTIFY = "JUSTIFY"
754
+ }
755
+ export interface DividerData {
756
+ /** Styling for the divider's container. */
757
+ containerData?: PluginContainerData;
758
+ /** Divider line style. */
759
+ lineStyle?: LineStyle;
760
+ /** Divider width. */
761
+ width?: Width;
762
+ /** Divider alignment. */
763
+ alignment?: Alignment;
764
+ }
765
+ export declare enum LineStyle {
766
+ /** Single Line */
767
+ SINGLE = "SINGLE",
768
+ /** Double Line */
769
+ DOUBLE = "DOUBLE",
770
+ /** Dashed Line */
771
+ DASHED = "DASHED",
772
+ /** Dotted Line */
773
+ DOTTED = "DOTTED"
774
+ }
775
+ export declare enum Width {
776
+ /** Large line */
777
+ LARGE = "LARGE",
778
+ /** Medium line */
779
+ MEDIUM = "MEDIUM",
780
+ /** Small line */
781
+ SMALL = "SMALL"
782
+ }
783
+ export declare enum Alignment {
784
+ /** Center alignment */
785
+ CENTER = "CENTER",
786
+ /** Left alignment */
787
+ LEFT = "LEFT",
788
+ /** Right alignment */
789
+ RIGHT = "RIGHT"
790
+ }
791
+ export interface FileData {
792
+ /** Styling for the file's container. */
793
+ containerData?: PluginContainerData;
794
+ /** The source for the file's data. */
795
+ src?: FileSource;
796
+ /** File name. */
797
+ name?: string | null;
798
+ /** File type. */
799
+ type?: string | null;
800
+ /** File size in KB. */
801
+ size?: number | null;
802
+ /** Settings for PDF files. */
803
+ pdfSettings?: PDFSettings;
804
+ /** File MIME type. */
805
+ mimeType?: string | null;
806
+ /** File path. */
807
+ path?: string | null;
808
+ }
809
+ export declare enum ViewMode {
810
+ /** No PDF view */
811
+ NONE = "NONE",
812
+ /** Full PDF view */
813
+ FULL = "FULL",
814
+ /** Mini PDF view */
815
+ MINI = "MINI"
816
+ }
817
+ export interface FileSource extends FileSourceDataOneOf {
818
+ /** The absolute URL for the file's source. */
819
+ url?: string | null;
820
+ /** Custom ID. Use `id` instead. */
821
+ custom?: string | null;
822
+ /** An ID that's resolved to a URL by a resolver function. */
823
+ id?: string | null;
824
+ /** Indicates whether the file's source is private. */
825
+ private?: boolean | null;
826
+ }
827
+ /** @oneof */
828
+ export interface FileSourceDataOneOf {
829
+ /** The absolute URL for the file's source. */
830
+ url?: string | null;
831
+ /** Custom ID. Use `id` instead. */
832
+ custom?: string | null;
833
+ /** An ID that's resolved to a URL by a resolver function. */
834
+ id?: string | null;
835
+ }
836
+ export interface PDFSettings {
837
+ /**
838
+ * PDF view mode. One of the following:
839
+ * `NONE` : The PDF isn't displayed.
840
+ * `FULL` : A full page view of the PDF is displayed.
841
+ * `MINI` : A mini view of the PDF is displayed.
842
+ */
843
+ viewMode?: ViewMode;
844
+ /** Sets whether the PDF download button is disabled. */
845
+ disableDownload?: boolean | null;
846
+ /** Sets whether the PDF print button is disabled. */
847
+ disablePrint?: boolean | null;
848
+ }
849
+ export interface GalleryData {
850
+ /** Styling for the gallery's container. */
851
+ containerData?: PluginContainerData;
852
+ /** The items in the gallery. */
853
+ items?: Item[];
854
+ /** Options for defining the gallery's appearance. */
855
+ options?: GalleryOptions;
856
+ /** Sets whether the gallery's expand button is disabled. */
857
+ disableExpand?: boolean | null;
858
+ /** Sets whether the gallery's download button is disabled. */
859
+ disableDownload?: boolean | null;
860
+ }
861
+ export interface Media {
862
+ /** The source for the media's data. */
863
+ src?: FileSource;
864
+ /** Media width in pixels. */
865
+ width?: number | null;
866
+ /** Media height in pixels. */
867
+ height?: number | null;
868
+ /** Media duration in seconds. Only relevant for audio and video files. */
869
+ duration?: number | null;
870
+ }
871
+ export interface ItemImage {
872
+ /** Image file details. */
873
+ media?: Media;
874
+ /** Link details for images that are links. */
875
+ link?: Link;
876
+ }
877
+ export interface Video {
878
+ /** Video file details. */
879
+ media?: Media;
880
+ /** Video thumbnail file details. */
881
+ thumbnail?: Media;
882
+ }
883
+ export interface Item extends ItemDataOneOf {
884
+ /** An image item. */
885
+ image?: ItemImage;
886
+ /** A video item. */
887
+ video?: Video;
888
+ /** Item title. */
889
+ title?: string | null;
890
+ /** Item's alternative text. */
891
+ altText?: string | null;
892
+ }
893
+ /** @oneof */
894
+ export interface ItemDataOneOf {
895
+ /** An image item. */
896
+ image?: ItemImage;
897
+ /** A video item. */
898
+ video?: Video;
899
+ }
900
+ export interface GalleryOptions {
901
+ /** Gallery layout. */
902
+ layout?: Layout;
903
+ /** Styling for gallery items. */
904
+ item?: ItemStyle;
905
+ /** Styling for gallery thumbnail images. */
906
+ thumbnails?: Thumbnails;
907
+ }
908
+ export declare enum LayoutType {
909
+ /** Collage type */
910
+ COLLAGE = "COLLAGE",
911
+ /** Masonry type */
912
+ MASONRY = "MASONRY",
913
+ /** Grid type */
914
+ GRID = "GRID",
915
+ /** Thumbnail type */
916
+ THUMBNAIL = "THUMBNAIL",
917
+ /** Slider type */
918
+ SLIDER = "SLIDER",
919
+ /** Slideshow type */
920
+ SLIDESHOW = "SLIDESHOW",
921
+ /** Panorama type */
922
+ PANORAMA = "PANORAMA",
923
+ /** Column type */
924
+ COLUMN = "COLUMN",
925
+ /** Magic type */
926
+ MAGIC = "MAGIC",
927
+ /** Fullsize images type */
928
+ FULLSIZE = "FULLSIZE"
929
+ }
930
+ export declare enum Orientation {
931
+ /** Rows Orientation */
932
+ ROWS = "ROWS",
933
+ /** Columns Orientation */
934
+ COLUMNS = "COLUMNS"
935
+ }
936
+ export declare enum Crop {
937
+ /** Crop to fill */
938
+ FILL = "FILL",
939
+ /** Crop to fit */
940
+ FIT = "FIT"
941
+ }
942
+ export declare enum ThumbnailsAlignment {
943
+ /** Top alignment */
944
+ TOP = "TOP",
945
+ /** Right alignment */
946
+ RIGHT = "RIGHT",
947
+ /** Bottom alignment */
948
+ BOTTOM = "BOTTOM",
949
+ /** Left alignment */
950
+ LEFT = "LEFT",
951
+ /** No thumbnail */
952
+ NONE = "NONE"
953
+ }
954
+ export interface Layout {
955
+ /** Gallery layout type. */
956
+ type?: LayoutType;
957
+ /** Sets whether horizontal scroll is enabled. */
958
+ horizontalScroll?: boolean | null;
959
+ /** Gallery orientation. */
960
+ orientation?: Orientation;
961
+ /** The number of columns to display on full size screens. */
962
+ numberOfColumns?: number | null;
963
+ /** The number of columns to display on mobile screens. */
964
+ mobileNumberOfColumns?: number | null;
965
+ }
966
+ export interface ItemStyle {
967
+ /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
968
+ targetSize?: number | null;
969
+ /** Item ratio */
970
+ ratio?: number | null;
971
+ /** Sets how item images are cropped. */
972
+ crop?: Crop;
973
+ /** The spacing between items in pixels. */
974
+ spacing?: number | null;
975
+ }
976
+ export interface Thumbnails {
977
+ /** Thumbnail alignment. */
978
+ placement?: ThumbnailsAlignment;
979
+ /** Spacing between thumbnails in pixels. */
980
+ spacing?: number | null;
981
+ }
982
+ export interface GIFData {
983
+ /** Styling for the GIF's container. */
984
+ containerData?: PluginContainerData;
985
+ /** The source of the full size GIF. */
986
+ original?: GIF;
987
+ /** The source of the downsized GIF. */
988
+ downsized?: GIF;
989
+ /** Height in pixels. */
990
+ height?: number;
991
+ /** Width in pixels. */
992
+ width?: number;
993
+ }
994
+ export interface GIF {
995
+ /** GIF format URL. */
996
+ gif?: string | null;
997
+ /** MP4 format URL. */
998
+ mp4?: string | null;
999
+ /** Thumbnail URL. */
1000
+ still?: string | null;
1001
+ }
1002
+ export interface HeadingData {
1003
+ /** Heading level from 1-6. */
1004
+ level?: number;
1005
+ /** Styling for the heading text. */
1006
+ textStyle?: TextStyle;
1007
+ /** Indentation level from 1-6. */
1008
+ indentation?: number | null;
1009
+ }
1010
+ export interface HTMLData extends HTMLDataDataOneOf {
1011
+ /** The URL for the HTML code for the node. */
1012
+ url?: string;
1013
+ /** The HTML code for the node. */
1014
+ html?: string;
1015
+ /** Whether this is an AdSense element. Use `source` instead. */
1016
+ isAdsense?: boolean | null;
1017
+ /** Styling for the HTML node's container. */
1018
+ containerData?: PluginContainerData;
1019
+ /** The type of HTML code. */
1020
+ source?: Source;
1021
+ }
1022
+ /** @oneof */
1023
+ export interface HTMLDataDataOneOf {
1024
+ /** The URL for the HTML code for the node. */
1025
+ url?: string;
1026
+ /** The HTML code for the node. */
1027
+ html?: string;
1028
+ /** Whether this is an AdSense element. Use `source` instead. */
1029
+ isAdsense?: boolean | null;
1030
+ }
1031
+ export declare enum Source {
1032
+ HTML = "HTML",
1033
+ ADSENSE = "ADSENSE"
1034
+ }
1035
+ export interface ImageData {
1036
+ /** Styling for the image's container. */
1037
+ containerData?: PluginContainerData;
1038
+ /** Image file details. */
1039
+ image?: Media;
1040
+ /** Link details for images that are links. */
1041
+ link?: Link;
1042
+ /** Sets whether the image expands to full screen when clicked. */
1043
+ disableExpand?: boolean | null;
1044
+ /** Image's alternative text. */
1045
+ altText?: string | null;
1046
+ /** Image caption. */
1047
+ caption?: string | null;
1048
+ /** Sets whether the image's download button is disabled. */
1049
+ disableDownload?: boolean | null;
1050
+ }
1051
+ export interface LinkPreviewData {
1052
+ /** Styling for the link preview's container. */
1053
+ containerData?: PluginContainerData;
1054
+ /** Link details. */
1055
+ link?: Link;
1056
+ /** Preview title. */
1057
+ title?: string | null;
1058
+ /** Preview thumbnail URL. */
1059
+ thumbnailUrl?: string | null;
1060
+ /** Preview description. */
1061
+ description?: string | null;
1062
+ /** The preview content as HTML. */
1063
+ html?: string | null;
1064
+ }
1065
+ export interface MapData {
1066
+ /** Styling for the map's container. */
1067
+ containerData?: PluginContainerData;
1068
+ /** Map settings. */
1069
+ mapSettings?: MapSettings;
1070
+ }
1071
+ export interface MapSettings {
1072
+ /** The address to display on the map. */
1073
+ address?: string | null;
1074
+ /** Sets whether the map is draggable. */
1075
+ draggable?: boolean | null;
1076
+ /** Sets whether the location marker is visible. */
1077
+ marker?: boolean | null;
1078
+ /** Sets whether street view control is enabled. */
1079
+ streetViewControl?: boolean | null;
1080
+ /** Sets whether zoom control is enabled. */
1081
+ zoomControl?: boolean | null;
1082
+ /** Location latitude. */
1083
+ lat?: number | null;
1084
+ /** Location longitude. */
1085
+ lng?: number | null;
1086
+ /** Location name. */
1087
+ locationName?: string | null;
1088
+ /** Sets whether view mode control is enabled. */
1089
+ viewModeControl?: boolean | null;
1090
+ /** Initial zoom value. */
1091
+ initialZoom?: number | null;
1092
+ /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
1093
+ mapType?: MapType;
1094
+ }
1095
+ export declare enum MapType {
1096
+ /** Roadmap map type */
1097
+ ROADMAP = "ROADMAP",
1098
+ /** Satellite map type */
1099
+ SATELITE = "SATELITE",
1100
+ /** Hybrid map type */
1101
+ HYBRID = "HYBRID",
1102
+ /** Terrain map type */
1103
+ TERRAIN = "TERRAIN"
1104
+ }
1105
+ export interface ParagraphData {
1106
+ /** Styling for the paragraph text. */
1107
+ textStyle?: TextStyle;
1108
+ /** Indentation level from 1-6. */
1109
+ indentation?: number | null;
1110
+ }
1111
+ export interface PollData {
1112
+ /** Styling for the poll's container. */
1113
+ containerData?: PluginContainerData;
1114
+ /** Poll data. */
1115
+ poll?: Poll;
1116
+ /** Layout settings for the poll and voting options. */
1117
+ layout?: PollDataLayout;
1118
+ /** Styling for the poll and voting options. */
1119
+ design?: Design;
1120
+ }
1121
+ export declare enum ViewRole {
1122
+ /** Only Poll creator can view the results */
1123
+ CREATOR = "CREATOR",
1124
+ /** Anyone who voted can see the results */
1125
+ VOTERS = "VOTERS",
1126
+ /** Anyone can see the results, even if one didn't vote */
1127
+ EVERYONE = "EVERYONE"
1128
+ }
1129
+ export declare enum VoteRole {
1130
+ /** Logged in member */
1131
+ SITE_MEMBERS = "SITE_MEMBERS",
1132
+ /** Anyone */
1133
+ ALL = "ALL"
1134
+ }
1135
+ export interface Permissions {
1136
+ /** Sets who can view the poll results. */
1137
+ view?: ViewRole;
1138
+ /** Sets who can vote. */
1139
+ vote?: VoteRole;
1140
+ /** Sets whether one voter can vote multiple times. */
1141
+ allowMultipleVotes?: boolean | null;
1142
+ }
1143
+ export interface PollOption {
1144
+ /** Option ID. */
1145
+ id?: string | null;
1146
+ /** Option title. */
1147
+ title?: string | null;
1148
+ /** The image displayed with the option. */
1149
+ image?: Media;
1150
+ }
1151
+ export interface Settings {
1152
+ /** Permissions settings for voting. */
1153
+ permissions?: Permissions;
1154
+ /** Sets whether voters are displayed in the vote results. */
1155
+ showVoters?: boolean | null;
1156
+ /** Sets whether the vote count is displayed. */
1157
+ showVotesCount?: boolean | null;
1158
+ }
1159
+ export declare enum PollLayoutType {
1160
+ /** List */
1161
+ LIST = "LIST",
1162
+ /** Grid */
1163
+ GRID = "GRID"
1164
+ }
1165
+ export declare enum PollLayoutDirection {
1166
+ /** Left-to-right */
1167
+ LTR = "LTR",
1168
+ /** Right-to-left */
1169
+ RTL = "RTL"
1170
+ }
1171
+ export interface PollLayout {
1172
+ /** The layout for displaying the voting options. */
1173
+ type?: PollLayoutType;
1174
+ /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
1175
+ direction?: PollLayoutDirection;
1176
+ /** Sets whether to display the main poll image. */
1177
+ enableImage?: boolean | null;
1178
+ }
1179
+ export interface OptionLayout {
1180
+ /** Sets whether to display option images. */
1181
+ enableImage?: boolean | null;
1182
+ }
1183
+ export declare enum BackgroundType {
1184
+ /** Color background type */
1185
+ COLOR = "COLOR",
1186
+ /** Image background type */
1187
+ IMAGE = "IMAGE",
1188
+ /** Gradiant background type */
1189
+ GRADIENT = "GRADIENT"
1190
+ }
1191
+ export interface Gradient {
1192
+ /** The gradient angle in degrees. */
1193
+ angle?: number | null;
1194
+ /** The start color as a hexademical value. */
1195
+ startColor?: string | null;
1196
+ /** The end color as a hexademical value. */
1197
+ lastColor?: string | null;
1198
+ }
1199
+ export interface Background extends BackgroundBackgroundOneOf {
1200
+ /** The background color as a hexademical value. */
1201
+ color?: string | null;
1202
+ /** An image to use for the background. */
1203
+ image?: Media;
1204
+ /** Details for a gradient background. */
1205
+ gradient?: Gradient;
1206
+ /** Background type. For each option, include the relevant details. */
1207
+ type?: BackgroundType;
1208
+ }
1209
+ /** @oneof */
1210
+ export interface BackgroundBackgroundOneOf {
1211
+ /** The background color as a hexademical value. */
1212
+ color?: string | null;
1213
+ /** An image to use for the background. */
1214
+ image?: Media;
1215
+ /** Details for a gradient background. */
1216
+ gradient?: Gradient;
1217
+ }
1218
+ export interface PollDesign {
1219
+ /** Background styling. */
1220
+ background?: Background;
1221
+ /** Border radius in pixels. */
1222
+ borderRadius?: number | null;
1223
+ }
1224
+ export interface OptionDesign {
1225
+ /** Border radius in pixels. */
1226
+ borderRadius?: number | null;
1227
+ }
1228
+ export interface Poll {
1229
+ /** Poll ID. */
1230
+ id?: string | null;
1231
+ /** Poll title. */
1232
+ title?: string | null;
1233
+ /** Poll creator ID. */
1234
+ creatorId?: string | null;
1235
+ /** Main poll image. */
1236
+ image?: Media;
1237
+ /** Voting options. */
1238
+ options?: PollOption[];
1239
+ /** The poll's permissions and display settings. */
1240
+ settings?: Settings;
1241
+ }
1242
+ export interface PollDataLayout {
1243
+ /** Poll layout settings. */
1244
+ poll?: PollLayout;
1245
+ /** Voting otpions layout settings. */
1246
+ options?: OptionLayout;
1247
+ }
1248
+ export interface Design {
1249
+ /** Styling for the poll. */
1250
+ poll?: PollDesign;
1251
+ /** Styling for voting options. */
1252
+ options?: OptionDesign;
1253
+ }
1254
+ export interface TextData {
1255
+ /** The text to apply decorations to. */
1256
+ text?: string;
1257
+ /** The decorations to apply. */
1258
+ decorations?: Decoration[];
1259
+ }
1260
+ /** Adds appearence changes to text */
1261
+ export interface Decoration extends DecorationDataOneOf {
1262
+ /** Data for an anchor link decoration. */
1263
+ anchorData?: AnchorData;
1264
+ /** Data for a color decoration. */
1265
+ colorData?: ColorData;
1266
+ /** Data for an external link decoration. */
1267
+ linkData?: LinkData;
1268
+ /** Data for a mention decoration. */
1269
+ mentionData?: MentionData;
1270
+ /** Data for a font size decoration. */
1271
+ fontSizeData?: FontSizeData;
1272
+ /** Font weight for a bold decoration. */
1273
+ fontWeightValue?: number | null;
1274
+ /** Data for an italic decoration. */
1275
+ italicData?: boolean | null;
1276
+ /** Data for an underline decoration. */
1277
+ underlineData?: boolean | null;
1278
+ /** The type of decoration to apply. */
1279
+ type?: DecorationType;
1280
+ }
1281
+ /** @oneof */
1282
+ export interface DecorationDataOneOf {
1283
+ /** Data for an anchor link decoration. */
1284
+ anchorData?: AnchorData;
1285
+ /** Data for a color decoration. */
1286
+ colorData?: ColorData;
1287
+ /** Data for an external link decoration. */
1288
+ linkData?: LinkData;
1289
+ /** Data for a mention decoration. */
1290
+ mentionData?: MentionData;
1291
+ /** Data for a font size decoration. */
1292
+ fontSizeData?: FontSizeData;
1293
+ /** Font weight for a bold decoration. */
1294
+ fontWeightValue?: number | null;
1295
+ /** Data for an italic decoration. */
1296
+ italicData?: boolean | null;
1297
+ /** Data for an underline decoration. */
1298
+ underlineData?: boolean | null;
1299
+ }
1300
+ export declare enum DecorationType {
1301
+ BOLD = "BOLD",
1302
+ ITALIC = "ITALIC",
1303
+ UNDERLINE = "UNDERLINE",
1304
+ SPOILER = "SPOILER",
1305
+ ANCHOR = "ANCHOR",
1306
+ MENTION = "MENTION",
1307
+ LINK = "LINK",
1308
+ COLOR = "COLOR",
1309
+ FONT_SIZE = "FONT_SIZE",
1310
+ EXTERNAL = "EXTERNAL"
1311
+ }
1312
+ export interface AnchorData {
1313
+ /** The target node's ID. */
1314
+ anchor?: string;
1315
+ }
1316
+ export interface ColorData {
1317
+ /** The text's background color as a hexadecimal value. */
1318
+ background?: string | null;
1319
+ /** The text's foreground color as a hexadecimal value. */
1320
+ foreground?: string | null;
1321
+ }
1322
+ export interface LinkData {
1323
+ /** Link details. */
1324
+ link?: Link;
1325
+ }
1326
+ export interface MentionData {
1327
+ /** The mentioned user's name. */
1328
+ name?: string;
1329
+ /** The version of the user's name that appears after the `@` character in the mention. */
1330
+ slug?: string;
1331
+ /** Mentioned user's ID. */
1332
+ id?: string | null;
1333
+ }
1334
+ export interface FontSizeData {
1335
+ /** The units used for the font size. */
1336
+ unit?: FontType;
1337
+ /** Font size value. */
1338
+ value?: number | null;
1339
+ }
1340
+ export declare enum FontType {
1341
+ PX = "PX",
1342
+ EM = "EM"
1343
+ }
1344
+ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1345
+ /** Data for embedded Wix Bookings content. */
1346
+ bookingData?: BookingData;
1347
+ /** Data for embedded Wix Events content. */
1348
+ eventData?: EventData;
1349
+ /** The type of Wix App content being embedded. */
1350
+ type?: AppType;
1351
+ /** The ID of the embedded content. */
1352
+ itemId?: string | null;
1353
+ /** The name of the embedded content. */
1354
+ name?: string | null;
1355
+ /** Deprecated: Use `image` instead. */
1356
+ imageSrc?: string | null;
1357
+ /** The URL for the embedded content. */
1358
+ url?: string | null;
1359
+ /** An image for the embedded content. */
1360
+ image?: Media;
1361
+ }
1362
+ /** @oneof */
1363
+ export interface AppEmbedDataAppDataOneOf {
1364
+ /** Data for embedded Wix Bookings content. */
1365
+ bookingData?: BookingData;
1366
+ /** Data for embedded Wix Events content. */
1367
+ eventData?: EventData;
1368
+ }
1369
+ export declare enum AppType {
1370
+ PRODUCT = "PRODUCT",
1371
+ EVENT = "EVENT",
1372
+ BOOKING = "BOOKING"
1373
+ }
1374
+ export interface BookingData {
1375
+ /** Booking duration in minutes. */
1376
+ durations?: string | null;
1377
+ }
1378
+ export interface EventData {
1379
+ /** Event schedule. */
1380
+ scheduling?: string | null;
1381
+ /** Event location. */
1382
+ location?: string | null;
1383
+ }
1384
+ export interface VideoData {
1385
+ /** Styling for the video's container. */
1386
+ containerData?: PluginContainerData;
1387
+ /** Video details. */
1388
+ video?: Media;
1389
+ /** Video thumbnail details. */
1390
+ thumbnail?: Media;
1391
+ /** Sets whether the video's download button is disabled. */
1392
+ disableDownload?: boolean | null;
1393
+ /** Video title. */
1394
+ title?: string | null;
1395
+ /** Video options. */
1396
+ options?: PlaybackOptions;
1397
+ }
1398
+ export interface PlaybackOptions {
1399
+ /** Sets whether the media will automatically start playing. */
1400
+ autoPlay?: boolean | null;
1401
+ /** Sets whether media's will be looped. */
1402
+ playInLoop?: boolean | null;
1403
+ /** Sets whether media's controls will be shown. */
1404
+ showControls?: boolean | null;
1405
+ }
1406
+ export interface EmbedData {
1407
+ /** Styling for the oEmbed node's container. */
1408
+ containerData?: PluginContainerData;
1409
+ /** An [oEmbed](https://www.oembed.com) object. */
1410
+ oembed?: Oembed;
1411
+ /** Origin asset source. */
1412
+ src?: string | null;
1413
+ }
1414
+ export interface Oembed {
1415
+ /** The resource type. */
1416
+ type?: string | null;
1417
+ /** The width of the resource specified in the `url` property in pixels. */
1418
+ width?: number | null;
1419
+ /** The height of the resource specified in the `url` property in pixels. */
1420
+ height?: number | null;
1421
+ /** Resource title. */
1422
+ title?: string | null;
1423
+ /** The source URL for the resource. */
1424
+ url?: string | null;
1425
+ /** HTML for embedding a video player. The HTML should have no padding or margins. */
1426
+ html?: string | null;
1427
+ /** The name of the author or owner of the resource. */
1428
+ authorName?: string | null;
1429
+ /** The URL for the author or owner of the resource. */
1430
+ authorUrl?: string | null;
1431
+ /** The name of the resource provider. */
1432
+ providerName?: string | null;
1433
+ /** The URL for the resource provider. */
1434
+ providerUrl?: string | null;
1435
+ /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
1436
+ thumbnailUrl?: string | null;
1437
+ /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
1438
+ thumbnailWidth?: string | null;
1439
+ /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
1440
+ thumbnailHeight?: string | null;
1441
+ /** The URL for an embedded viedo. */
1442
+ videoUrl?: string | null;
1443
+ /** The oEmbed version number. This value must be `1.0`. */
1444
+ version?: string | null;
1445
+ }
1446
+ export interface CollapsibleListData {
1447
+ /** Styling for the collapsible list's container. */
1448
+ containerData?: PluginContainerData;
1449
+ /** If `true`, only one item can be expanded at a time. */
1450
+ expandOnlyOne?: boolean | null;
1451
+ /** Sets which items are expanded when the page loads. */
1452
+ initialExpandedItems?: InitialExpandedItems;
1453
+ /** The direction of the text in the list. Either left-to-right or right-to-left. */
1454
+ direction?: Direction;
1455
+ /** If `true`, The collapsible item will appear in search results as an FAQ. */
1456
+ isQapageData?: boolean | null;
1457
+ }
1458
+ export declare enum InitialExpandedItems {
1459
+ /** First item will be expended initally */
1460
+ FIRST = "FIRST",
1461
+ /** All items will expended initally */
1462
+ ALL = "ALL",
1463
+ /** All items collapsed initally */
1464
+ NONE = "NONE"
1465
+ }
1466
+ export declare enum Direction {
1467
+ /** Left-to-right */
1468
+ LTR = "LTR",
1469
+ /** Right-to-left */
1470
+ RTL = "RTL"
1471
+ }
1472
+ export interface TableData {
1473
+ /** Styling for the table's container. */
1474
+ containerData?: PluginContainerData;
1475
+ /** The table's dimensions. */
1476
+ dimensions?: Dimensions;
1477
+ /** Deprecated: Use `rowHeader` and `columnHeader` instead. */
1478
+ header?: boolean | null;
1479
+ /** Sets whether the table's first row is a header. */
1480
+ rowHeader?: boolean | null;
1481
+ /** Sets whether the table's first column is a header. */
1482
+ columnHeader?: boolean | null;
1483
+ }
1484
+ export interface Dimensions {
1485
+ /** An array representing relative width of each column in relation to the other columns. */
1486
+ colsWidthRatio?: number[];
1487
+ /** An array representing the height of each row in pixels. */
1488
+ rowsHeight?: number[];
1489
+ /** An array representing the minimum width of each column in pixels. */
1490
+ colsMinWidth?: number[];
1491
+ }
1492
+ export interface TableCellData {
1493
+ /** Styling for the cell's background color and text alignment. */
1494
+ cellStyle?: CellStyle;
1495
+ /** The cell's border colors. */
1496
+ borderColors?: BorderColors;
1497
+ }
1498
+ export declare enum VerticalAlignment {
1499
+ /** Top alignment */
1500
+ TOP = "TOP",
1501
+ /** Middle alignment */
1502
+ MIDDLE = "MIDDLE",
1503
+ /** Bottom alignment */
1504
+ BOTTOM = "BOTTOM"
1505
+ }
1506
+ export interface CellStyle {
1507
+ /** Vertical alignment for the cell's text. */
1508
+ verticalAlignment?: VerticalAlignment;
1509
+ /** Cell background color as a hexadecimal value. */
1510
+ backgroundColor?: string | null;
1511
+ }
1512
+ export interface BorderColors {
1513
+ /** Left border color as a hexadecimal value. */
1514
+ left?: string | null;
1515
+ /** Right border color as a hexadecimal value. */
1516
+ right?: string | null;
1517
+ /** Top border color as a hexadecimal value. */
1518
+ top?: string | null;
1519
+ /** Bottom border color as a hexadecimal value. */
1520
+ bottom?: string | null;
1521
+ }
1522
+ /**
1523
+ * `NullValue` is a singleton enumeration to represent the null value for the
1524
+ * `Value` type union.
1525
+ *
1526
+ * The JSON representation for `NullValue` is JSON `null`.
1527
+ */
1528
+ export declare enum NullValue {
1529
+ /** Null value. */
1530
+ NULL_VALUE = "NULL_VALUE"
1531
+ }
1532
+ /**
1533
+ * `ListValue` is a wrapper around a repeated field of values.
1534
+ *
1535
+ * The JSON representation for `ListValue` is JSON array.
1536
+ */
1537
+ export interface ListValue {
1538
+ /** Repeated field of dynamically typed values. */
1539
+ values?: any[];
1540
+ }
1541
+ export interface AudioData {
1542
+ /** Styling for the audio node's container. */
1543
+ containerData?: PluginContainerData;
1544
+ /** Audio file details. */
1545
+ audio?: Media;
1546
+ /** Sets whether the audio node's download button is disabled. */
1547
+ disableDownload?: boolean | null;
1548
+ /** Cover image. */
1549
+ coverImage?: Media;
1550
+ /** Track name. */
1551
+ name?: string | null;
1552
+ /** Author name. */
1553
+ authorName?: string | null;
1554
+ /** An HTML version of the audio node. */
1555
+ html?: string | null;
1556
+ }
1557
+ export interface OrderedListData {
1558
+ /** Indentation level. */
1559
+ indentation?: number;
1560
+ }
1561
+ export interface BulletedListData {
1562
+ /** Indentation level. */
1563
+ indentation?: number;
1564
+ }
1565
+ export interface BlockquoteData {
1566
+ /** Indentation level. */
1567
+ indentation?: number;
1568
+ }
1569
+ export interface Metadata {
1570
+ /** Schema version. */
1571
+ version?: number;
1572
+ /**
1573
+ * When the object was created.
1574
+ * @readonly
1575
+ */
1576
+ createdTimestamp?: Date;
1577
+ /** When the object was most recently updated. */
1578
+ updatedTimestamp?: Date;
1579
+ /** Object ID. */
1580
+ id?: string | null;
1581
+ }
1582
+ export interface DocumentStyle {
1583
+ /** Styling for H1 nodes. */
1584
+ headerOne?: TextNodeStyle;
1585
+ /** Styling for H2 nodes. */
1586
+ headerTwo?: TextNodeStyle;
1587
+ /** Styling for H3 nodes. */
1588
+ headerThree?: TextNodeStyle;
1589
+ /** Styling for H4 nodes. */
1590
+ headerFour?: TextNodeStyle;
1591
+ /** Styling for H5 nodes. */
1592
+ headerFive?: TextNodeStyle;
1593
+ /** Styling for H6 nodes. */
1594
+ headerSix?: TextNodeStyle;
1595
+ /** Styling for paragraph nodes. */
1596
+ paragraph?: TextNodeStyle;
1597
+ /** Styling for block quote nodes. */
1598
+ blockquote?: TextNodeStyle;
1599
+ /** Styling for code block nodes. */
1600
+ codeBlock?: TextNodeStyle;
1601
+ }
1602
+ export interface TextNodeStyle {
1603
+ /** The decorations to apply to the node. */
1604
+ decorations?: Decoration[];
1605
+ /** Padding and background color for the node. */
1606
+ nodeStyle?: NodeStyle;
1607
+ /** Line height for text in the node. */
1608
+ lineHeight?: string | null;
1609
+ }
1610
+ export interface RadioGroupOption {
1611
+ /** Selectable option label */
1612
+ label?: string | null;
1613
+ /** Selectable option value, which is saved to DB. */
1614
+ value?: string | null;
1615
+ /** Flag identifying that option should be selected by default */
1616
+ default?: boolean;
1617
+ /** Option id. Used as binding for translations */
1618
+ id?: string;
1619
+ }
1620
+ export interface RadioGroupCustomOption {
1621
+ /** Label of custom option input */
1622
+ label?: string | null;
1623
+ /** Placeholder of custom option input */
1624
+ placeholder?: string | null;
1625
+ }
1626
+ export interface DropdownOption {
1627
+ /** Selectable option label */
1628
+ label?: string | null;
1629
+ /** Selectable option value, which is saved to DB. */
1630
+ value?: string | null;
1631
+ /** Flag identifying that option should be selected by default */
1632
+ default?: boolean;
1633
+ /** Option id. Used as binding for translations */
1634
+ id?: string;
1635
+ }
1636
+ export interface DropdownCustomOption {
1637
+ /** Label of custom option input */
1638
+ label?: string | null;
1639
+ /** Placeholder of custom option input */
1640
+ placeholder?: string | null;
1641
+ }
1642
+ export interface InputFieldStringType {
1643
+ /** Minimum length. */
1644
+ minLength?: number | null;
1645
+ /** Maximum length. */
1646
+ maxLength?: number | null;
1647
+ /** Pattern for a regular expression match. */
1648
+ pattern?: string | null;
1649
+ /** Format of a string. */
1650
+ format?: FormatEnumFormat;
1651
+ /** Custom error messages when validation fails. */
1652
+ errorMessages?: InputFieldStringErrorMessages;
1653
+ /** List of allowed values. */
1654
+ enum?: string[] | null;
1655
+ }
1656
+ export declare enum FormatEnumFormat {
1657
+ UNDEFINED = "UNDEFINED",
1658
+ DATE = "DATE",
1659
+ TIME = "TIME",
1660
+ DATE_TIME = "DATE_TIME",
1661
+ EMAIL = "EMAIL",
1662
+ URL = "URL",
1663
+ UUID = "UUID",
1664
+ PHONE = "PHONE",
1665
+ URI = "URI",
1666
+ HOSTNAME = "HOSTNAME",
1667
+ COLOR_HEX = "COLOR_HEX",
1668
+ CURRENCY = "CURRENCY",
1669
+ LANGUAGE = "LANGUAGE"
1670
+ }
1671
+ export interface InputFieldStringErrorMessages {
1672
+ /** Default error message on invalid validation. */
1673
+ default?: string | null;
1674
+ }
1675
+ export declare enum StringComponentType {
1676
+ UNKNOWN = "UNKNOWN",
1677
+ TEXT_INPUT = "TEXT_INPUT",
1678
+ RADIO_GROUP = "RADIO_GROUP",
1679
+ DROPDOWN = "DROPDOWN"
1680
+ }
1681
+ export interface TextInput {
1682
+ /** Label of the field */
1683
+ label?: string | null;
1684
+ /** Description of the field */
1685
+ description?: RichContent;
1686
+ /** Placeholder for the value input */
1687
+ placeholder?: string | null;
1688
+ /**
1689
+ * Flag identifying to hide or not label
1690
+ * Default: true
1691
+ */
1692
+ showLabel?: boolean | null;
1693
+ }
1694
+ export interface RadioGroup {
1695
+ /** Label of the field */
1696
+ label?: string | null;
1697
+ /** Description of the field */
1698
+ description?: RichContent;
1699
+ /**
1700
+ * Flag identifying to show option allowing input custom value
1701
+ * List of options to select from
1702
+ */
1703
+ options?: RadioGroupOption[];
1704
+ /**
1705
+ * Flag identifying to hide or not label
1706
+ * Default: true
1707
+ */
1708
+ showLabel?: boolean | null;
1709
+ /** Option which can be specified by UoU, enabled when this object is specified. */
1710
+ customOption?: RadioGroupCustomOption;
1711
+ }
1712
+ export interface Dropdown {
1713
+ /** Label of the field */
1714
+ label?: string | null;
1715
+ /** Description of the field */
1716
+ description?: RichContent;
1717
+ /** List of options to select from */
1718
+ options?: DropdownOption[];
1719
+ /**
1720
+ * Flag identifying to hide or not label
1721
+ * Default: true
1722
+ */
1723
+ showLabel?: boolean | null;
1724
+ /** Option which can be specified by UoU, enabled when this object is specified. */
1725
+ customOption?: DropdownCustomOption;
1726
+ /** Placeholder of dropdown input */
1727
+ placeholder?: string | null;
1728
+ }
1729
+ export interface InputFieldNumberType {
1730
+ /** Inclusive maximum value. */
1731
+ maximum?: number | null;
1732
+ /** Inclusive minimum value. */
1733
+ minimum?: number | null;
1734
+ /** Multiple of value. */
1735
+ multipleOf?: number | null;
1736
+ /** Custom error message when validation fails. */
1737
+ errorMessages?: InputFieldNumberErrorMessages;
1738
+ /** List of allowed values. */
1739
+ enum?: number[] | null;
1740
+ }
1741
+ export interface InputFieldNumberErrorMessages {
1742
+ /** Default error message on invalid validation. */
1743
+ default?: string | null;
1744
+ }
1745
+ export declare enum NumberComponentType {
1746
+ UNKNOWN = "UNKNOWN",
1747
+ NUMBER_INPUT = "NUMBER_INPUT"
1748
+ }
1749
+ export interface NumberInput {
1750
+ /** Label of the field */
1751
+ label?: string | null;
1752
+ /** Description of the field */
1753
+ description?: RichContent;
1754
+ /** Placeholder for the value input */
1755
+ placeholder?: string | null;
1756
+ /**
1757
+ * Flag identifying to hide or not label
1758
+ * Default: true
1759
+ */
1760
+ showLabel?: boolean | null;
1761
+ }
1762
+ export interface InputFieldBooleanType {
1763
+ /** Custom error message when validation fails. */
1764
+ errorMessages?: InputFieldBooleanErrorMessages;
1765
+ /** List of allowed values. */
1766
+ enum?: boolean[];
1767
+ }
1768
+ export interface InputFieldBooleanErrorMessages {
1769
+ /** Default error message on invalid validation. */
1770
+ default?: string | null;
1771
+ }
1772
+ export declare enum BooleanComponentType {
1773
+ UNKNOWN = "UNKNOWN",
1774
+ CHECKBOX = "CHECKBOX"
1775
+ }
1776
+ export interface Checkbox {
1777
+ /** Label of the field */
1778
+ label?: RichContent;
1779
+ }
1780
+ export interface MediaItem extends MediaItemMediaOneOf {
1781
+ /** WixMedia image. */
1782
+ image?: Image;
1783
+ }
1784
+ /** @oneof */
1785
+ export interface MediaItemMediaOneOf {
1786
+ /** WixMedia image. */
1787
+ image?: Image;
1788
+ }
1789
+ export interface Image {
1790
+ /** WixMedia image ID. */
1791
+ id?: string;
1792
+ /** Image URL. */
1793
+ url?: string;
1794
+ /**
1795
+ * Original image height.
1796
+ * @readonly
1797
+ */
1798
+ height?: number;
1799
+ /**
1800
+ * Original image width.
1801
+ * @readonly
1802
+ */
1803
+ width?: number;
1804
+ /** Image alt text. */
1805
+ altText?: string | null;
1806
+ /**
1807
+ * Image filename.
1808
+ * @readonly
1809
+ */
1810
+ filename?: string | null;
1811
+ }
1812
+ export interface Option {
1813
+ /** Selectable option label */
1814
+ label?: string | null;
1815
+ /** Selectable option value, which is saved to DB. */
1816
+ value?: any;
1817
+ /** Flag identifying that option should be selected by default */
1818
+ default?: boolean;
1819
+ /** Option id. Used as binding for translations */
1820
+ id?: string;
1821
+ /** Media item. Media, associated with option, like image. */
1822
+ media?: MediaItem;
1823
+ }
1824
+ export interface CustomOption {
1825
+ /** Label of custom option input */
1826
+ label?: string | null;
1827
+ /** Placeholder of custom option input */
1828
+ placeholder?: string | null;
1829
+ }
1830
+ export interface InputFieldArrayType {
1831
+ /** Maximum amount of array elements. */
1832
+ maxItems?: number | null;
1833
+ /** Minimum amount of array elements. */
1834
+ minItems?: number | null;
1835
+ /** Type of items allowed in array. */
1836
+ items?: ArrayTypeArrayItems;
1837
+ /** Custom error message when validation fails. */
1838
+ errorMessages?: InputFieldArrayErrorMessages;
1839
+ }
1840
+ export declare enum ItemType {
1841
+ UNKNOWN = "UNKNOWN",
1842
+ STRING = "STRING",
1843
+ NUMBER = "NUMBER",
1844
+ BOOLEAN = "BOOLEAN",
1845
+ INTEGER = "INTEGER",
1846
+ OBJECT = "OBJECT"
1847
+ }
1848
+ export interface InputFieldIntegerType {
1849
+ /** Minimum value. */
1850
+ maximum?: number | null;
1851
+ /** Maximum value. */
1852
+ minimum?: number | null;
1853
+ /** Multiple of value. */
1854
+ multipleOf?: number | null;
1855
+ /** Custom error message when validation fails. */
1856
+ errorMessages?: InputFieldNumberErrorMessages;
1857
+ /** List of allowed values. */
1858
+ enum?: number[] | null;
1859
+ }
1860
+ export interface InputFieldObjectType {
1861
+ /** Description of object properties. */
1862
+ properties?: Record<string, ObjectTypePropertiesType>;
1863
+ /** Custom error message when validation fails. */
1864
+ errorMessages?: InputFieldObjectErrorMessages;
1865
+ }
1866
+ export declare enum PropertiesTypePropertiesType {
1867
+ UNKNOWN = "UNKNOWN",
1868
+ STRING = "STRING",
1869
+ NUMBER = "NUMBER",
1870
+ BOOLEAN = "BOOLEAN",
1871
+ INTEGER = "INTEGER",
1872
+ ARRAY = "ARRAY"
1873
+ }
1874
+ export interface ObjectTypePropertiesType extends ObjectTypePropertiesTypePropertiesTypeOptionsOneOf {
1875
+ /** String type validation for property. */
1876
+ stringOptions?: InputFieldStringType;
1877
+ /** Number type validation for property. */
1878
+ numberOptions?: InputFieldNumberType;
1879
+ /** Boolean type validation for property. */
1880
+ booleanOptions?: InputFieldBooleanType;
1881
+ /** Integer type validation for property. */
1882
+ integerOptions?: InputFieldIntegerType;
1883
+ /** Array type validation for property. */
1884
+ arrayOptions?: InputFieldArrayType;
1885
+ /**
1886
+ * Type of object properties
1887
+ * @readonly
1888
+ */
1889
+ propertiesType?: PropertiesTypePropertiesType;
1890
+ /** Whether the property is required. */
1891
+ required?: boolean;
1892
+ }
1893
+ /** @oneof */
1894
+ export interface ObjectTypePropertiesTypePropertiesTypeOptionsOneOf {
1895
+ /** String type validation for property. */
1896
+ stringOptions?: InputFieldStringType;
1897
+ /** Number type validation for property. */
1898
+ numberOptions?: InputFieldNumberType;
1899
+ /** Boolean type validation for property. */
1900
+ booleanOptions?: InputFieldBooleanType;
1901
+ /** Integer type validation for property. */
1902
+ integerOptions?: InputFieldIntegerType;
1903
+ /** Array type validation for property. */
1904
+ arrayOptions?: InputFieldArrayType;
1905
+ }
1906
+ export interface InputFieldObjectErrorMessages {
1907
+ /** Default error message on invalid validation. */
1908
+ default?: string | null;
1909
+ }
1910
+ export interface ArrayTypeArrayItems extends ArrayTypeArrayItemsItemTypeOptionsOneOf {
1911
+ /** String type validation for items. */
1912
+ stringOptions?: InputFieldStringType;
1913
+ /** Number type validation for items. */
1914
+ numberOptions?: InputFieldNumberType;
1915
+ /** Boolean type validation for items. */
1916
+ booleanOptions?: InputFieldBooleanType;
1917
+ /** Integer type validation for items. */
1918
+ integerOptions?: InputFieldIntegerType;
1919
+ /** Object type validation for items */
1920
+ objectOptions?: InputFieldObjectType;
1921
+ /**
1922
+ * Type of array items
1923
+ * @readonly
1924
+ */
1925
+ itemType?: ItemType;
1926
+ }
1927
+ /** @oneof */
1928
+ export interface ArrayTypeArrayItemsItemTypeOptionsOneOf {
1929
+ /** String type validation for items. */
1930
+ stringOptions?: InputFieldStringType;
1931
+ /** Number type validation for items. */
1932
+ numberOptions?: InputFieldNumberType;
1933
+ /** Boolean type validation for items. */
1934
+ booleanOptions?: InputFieldBooleanType;
1935
+ /** Integer type validation for items. */
1936
+ integerOptions?: InputFieldIntegerType;
1937
+ /** Object type validation for items */
1938
+ objectOptions?: InputFieldObjectType;
1939
+ }
1940
+ export interface InputFieldArrayErrorMessages {
1941
+ /** Default error message on invalid validation. */
1942
+ default?: string | null;
1943
+ }
1944
+ export declare enum ComponentType {
1945
+ UNKNOWN = "UNKNOWN",
1946
+ CHECKBOX_GROUP = "CHECKBOX_GROUP"
1947
+ }
1948
+ export interface CheckboxGroup {
1949
+ /** Label of the field */
1950
+ label?: string | null;
1951
+ /** Description of the field */
1952
+ description?: RichContent;
1953
+ /** List of options to select from */
1954
+ options?: Option[];
1955
+ /**
1956
+ * Flag identifying to hide or not label
1957
+ * Default: true
1958
+ */
1959
+ showLabel?: boolean | null;
1960
+ /** Option which can be specified by UoU, enabled when this object is specified. */
1961
+ customOption?: CustomOption;
1962
+ }
1963
+ export declare enum UploadFileFormat {
1964
+ UNDEFINED = "UNDEFINED",
1965
+ /** Video files */
1966
+ VIDEO = "VIDEO",
1967
+ /** Image files */
1968
+ IMAGE = "IMAGE",
1969
+ /** Audio files */
1970
+ AUDIO = "AUDIO",
1971
+ /** Document files */
1972
+ DOCUMENT = "DOCUMENT"
1973
+ }
1974
+ export declare enum WixFileComponentType {
1975
+ UNKNOWN = "UNKNOWN",
1976
+ FILE_UPLOAD = "FILE_UPLOAD"
1977
+ }
1978
+ export interface FileUpload {
1979
+ /** Selectable option label */
1980
+ label?: string | null;
1981
+ /** Description of the field */
1982
+ description?: RichContent;
1983
+ /**
1984
+ * Flag identifying to hide or not label
1985
+ * Default: true
1986
+ */
1987
+ showLabel?: boolean | null;
1988
+ /** Text on upload button */
1989
+ buttonText?: string | null;
1990
+ /** Amount of files allowed to upload */
1991
+ fileLimit?: number;
1992
+ /** Supported file formats for upload */
1993
+ uploadFileFormats?: UploadFileFormat[];
1994
+ /** Custom text which appears when file is uploaded, if missing file name will be shown */
1995
+ explanationText?: string | null;
1996
+ }
1997
+ export declare enum InputType {
1998
+ UNKNOWN = "UNKNOWN",
1999
+ STRING = "STRING",
2000
+ NUMBER = "NUMBER",
2001
+ BOOLEAN = "BOOLEAN",
2002
+ ARRAY = "ARRAY",
2003
+ OBJECT = "OBJECT",
2004
+ WIX_FILE = "WIX_FILE"
2005
+ }
2006
+ export interface _String extends _StringComponentTypeOptionsOneOf {
2007
+ /** Text input field */
2008
+ textInputOptions?: TextInput;
2009
+ /** Selection field as radio group */
2010
+ radioGroupOptions?: RadioGroup;
2011
+ /** Selection field as drop down */
2012
+ dropdownOptions?: Dropdown;
2013
+ /** Validation of field output value. */
2014
+ validation?: InputFieldStringType;
2015
+ /**
2016
+ * Component type of the string input field
2017
+ * @readonly
2018
+ */
2019
+ componentType?: StringComponentType;
2020
+ }
2021
+ /** @oneof */
2022
+ export interface _StringComponentTypeOptionsOneOf {
2023
+ /** Text input field */
2024
+ textInputOptions?: TextInput;
2025
+ /** Selection field as radio group */
2026
+ radioGroupOptions?: RadioGroup;
2027
+ /** Selection field as drop down */
2028
+ dropdownOptions?: Dropdown;
2029
+ }
2030
+ export interface _Number extends _NumberComponentTypeOptionsOneOf {
2031
+ /** Number value input field */
2032
+ numberInputOptions?: NumberInput;
2033
+ /** Validation of field output value. */
2034
+ validation?: InputFieldNumberType;
2035
+ /**
2036
+ * Component type of the number input field
2037
+ * @readonly
2038
+ */
2039
+ componentType?: NumberComponentType;
2040
+ }
2041
+ /** @oneof */
2042
+ export interface _NumberComponentTypeOptionsOneOf {
2043
+ /** Number value input field */
2044
+ numberInputOptions?: NumberInput;
2045
+ }
2046
+ export interface _Boolean extends _BooleanComponentTypeOptionsOneOf {
2047
+ /** Checkbox input field */
2048
+ checkboxOptions?: Checkbox;
2049
+ /** Validation of field output value. */
2050
+ validation?: InputFieldBooleanType;
2051
+ /**
2052
+ * Component type of the boolean input field
2053
+ * @readonly
2054
+ */
2055
+ componentType?: BooleanComponentType;
2056
+ }
2057
+ /** @oneof */
2058
+ export interface _BooleanComponentTypeOptionsOneOf {
2059
+ /** Checkbox input field */
2060
+ checkboxOptions?: Checkbox;
2061
+ }
2062
+ export interface _Array extends _ArrayComponentTypeOptionsOneOf {
2063
+ /** Checkbox group input field */
2064
+ checkboxGroupOptions?: CheckboxGroup;
2065
+ /** Validation of array type. */
2066
+ validation?: InputFieldArrayType;
2067
+ /**
2068
+ * Component type of the array input field
2069
+ * @readonly
2070
+ */
2071
+ componentType?: ComponentType;
2072
+ }
2073
+ /** @oneof */
2074
+ export interface _ArrayComponentTypeOptionsOneOf {
2075
+ /** Checkbox group input field */
2076
+ checkboxGroupOptions?: CheckboxGroup;
2077
+ }
2078
+ export interface _Object extends _ObjectValidationOneOf {
2079
+ /** Validation of object type. */
2080
+ object?: InputFieldObjectType;
2081
+ }
2082
+ /** @oneof */
2083
+ export interface _ObjectValidationOneOf {
2084
+ /** Validation of object type. */
2085
+ object?: InputFieldObjectType;
2086
+ }
2087
+ export interface WixFile extends WixFileComponentTypeOptionsOneOf {
2088
+ /** File upload input field */
2089
+ fileUploadOptions?: FileUpload;
2090
+ /**
2091
+ * Component type of the array input field
2092
+ * @readonly
2093
+ */
2094
+ componentType?: WixFileComponentType;
2095
+ }
2096
+ /** @oneof */
2097
+ export interface WixFileComponentTypeOptionsOneOf {
2098
+ /** File upload input field */
2099
+ fileUploadOptions?: FileUpload;
2100
+ }
2101
+ export interface Header {
2102
+ /** Content of the header */
2103
+ content?: RichContent;
2104
+ }
2105
+ export interface RichText {
2106
+ /** Content of the rich text field */
2107
+ content?: RichContent;
2108
+ }
2109
+ export declare enum Target {
2110
+ UNDEFINED = "UNDEFINED",
2111
+ /** Opened in same browser tab */
2112
+ SELF = "SELF",
2113
+ /** Url open in new tab */
2114
+ BLANK = "BLANK"
2115
+ }
2116
+ export interface ThankYouMessage {
2117
+ /** Message show after form submission */
2118
+ text?: RichContent;
2119
+ /**
2120
+ * Duration after how much second it should disappear. If 0, will stay forever.
2121
+ * Default: false
2122
+ */
2123
+ duration?: number | null;
2124
+ }
2125
+ export interface Redirect {
2126
+ /** Url to which UoU should be redirected after successful submit of form */
2127
+ url?: string | null;
2128
+ /** How should url be opened */
2129
+ target?: Target;
2130
+ }
2131
+ export declare enum FieldType {
2132
+ UNKNOWN = "UNKNOWN",
2133
+ INPUT = "INPUT",
2134
+ DISPLAY = "DISPLAY",
2135
+ SUBMIT = "SUBMIT"
2136
+ }
2137
+ export interface InputField extends InputFieldInputTypeOptionsOneOf {
2138
+ /** Input return string as value */
2139
+ stringOptions?: _String;
2140
+ /** Input return number as value */
2141
+ numberOptions?: _Number;
2142
+ /** Input return boolean as value */
2143
+ booleanOptions?: _Boolean;
2144
+ /** Input return array as value */
2145
+ arrayOptions?: _Array;
2146
+ /** Input return object as value */
2147
+ objectOptions?: _Object;
2148
+ /** Input return "Wix file" as value */
2149
+ wixFileOptions?: WixFile;
2150
+ /** Definition of a target where the value of field belongs. */
2151
+ target?: string | null;
2152
+ /**
2153
+ * Mark the field as containing personal information. This will encrypt user data when storing it.
2154
+ * Default: false
2155
+ */
2156
+ pii?: boolean;
2157
+ /**
2158
+ * Whether the field is required.
2159
+ * Default: false
2160
+ */
2161
+ required?: boolean;
2162
+ /**
2163
+ * Type of the input field
2164
+ * @readonly
2165
+ */
2166
+ inputType?: InputType;
2167
+ }
2168
+ /** @oneof */
2169
+ export interface InputFieldInputTypeOptionsOneOf {
2170
+ /** Input return string as value */
2171
+ stringOptions?: _String;
2172
+ /** Input return number as value */
2173
+ numberOptions?: _Number;
2174
+ /** Input return boolean as value */
2175
+ booleanOptions?: _Boolean;
2176
+ /** Input return array as value */
2177
+ arrayOptions?: _Array;
2178
+ /** Input return object as value */
2179
+ objectOptions?: _Object;
2180
+ /** Input return "Wix file" as value */
2181
+ wixFileOptions?: WixFile;
2182
+ }
2183
+ export interface DisplayField extends DisplayFieldComponentTypeOneOf {
2184
+ /** Header field */
2185
+ header?: Header;
2186
+ /** Rich text field */
2187
+ richText?: RichText;
2188
+ }
2189
+ /** @oneof */
2190
+ export interface DisplayFieldComponentTypeOneOf {
2191
+ /** Header field */
2192
+ header?: Header;
2193
+ /** Rich text field */
2194
+ richText?: RichText;
2195
+ }
2196
+ export interface SubmitButton extends SubmitButtonSubmitActionOneOf {
2197
+ /** Submit action effect is to show message */
2198
+ thankYouMessage?: ThankYouMessage;
2199
+ /** Submit action effect is to redirect to */
2200
+ redirect?: Redirect;
2201
+ /** When button is not on last page it behaves as switch between pages page, text of label to go to next page. */
2202
+ nextText?: string | null;
2203
+ /** When button is not on last page it behaves as switch between pages page, text of label to go to previous page. */
2204
+ previousText?: string | null;
2205
+ /** Text on the button when button is submitting a form */
2206
+ submitText?: string | null;
2207
+ }
2208
+ /** @oneof */
2209
+ export interface SubmitButtonSubmitActionOneOf {
2210
+ /** Submit action effect is to show message */
2211
+ thankYouMessage?: ThankYouMessage;
2212
+ /** Submit action effect is to redirect to */
2213
+ redirect?: Redirect;
2214
+ }
2215
+ export interface Step {
2216
+ /** Step ID. */
2217
+ id?: string;
2218
+ /** Name of the step. */
2219
+ name?: string | null;
2220
+ /** Is step hidden */
2221
+ hidden?: boolean;
2222
+ /** Form step properties */
2223
+ layout?: FormLayout;
2224
+ }
2225
+ export interface FormLayout {
2226
+ /** Layout for large break point. */
2227
+ large?: BreakPoint;
2228
+ /** Layout for medium break point. */
2229
+ medium?: BreakPoint;
2230
+ /** Layout for small break point. */
2231
+ small?: BreakPoint;
2232
+ }
2233
+ export interface BreakPoint {
2234
+ /** Description of layouts for items. */
2235
+ items?: ItemLayout[];
2236
+ /** Amount of columns of layout grid. */
2237
+ columns?: number | null;
2238
+ /** Row height of layout grid. */
2239
+ rowHeight?: number | null;
2240
+ /** Description of elements margins. */
2241
+ margin?: Margin;
2242
+ /** Description of elements paddings. */
2243
+ padding?: Margin;
2244
+ }
2245
+ export interface ItemLayout {
2246
+ /** Form field reference id. */
2247
+ fieldId?: string;
2248
+ /** Horizontal coordinate in the grid. */
2249
+ row?: number | null;
2250
+ /** Vertical coordinate in the grid. */
2251
+ column?: number | null;
2252
+ /** Height. */
2253
+ width?: number | null;
2254
+ /** Width. */
2255
+ height?: number | null;
2256
+ }
2257
+ export interface Margin {
2258
+ /** Horizontal value. */
2259
+ horizontal?: number | null;
2260
+ /** Vertical value. */
2261
+ vertical?: number | null;
2262
+ }
2263
+ export interface FormRule {
2264
+ /** Id of the rule */
2265
+ id?: string;
2266
+ /** Rule on which item properties or layouts will be changed. */
2267
+ condition?: Record<string, any> | null;
2268
+ /**
2269
+ * Form items with defined properties that will be
2270
+ * changed when given condition is resolved to true.
2271
+ */
2272
+ overrides?: FormOverride[];
2273
+ /** Name of the rule */
2274
+ name?: string | null;
2275
+ }
2276
+ export declare enum OverrideEntityType {
2277
+ UNKNOWN = "UNKNOWN",
2278
+ FIELD = "FIELD",
2279
+ FORM = "FORM",
2280
+ NESTED_FORM_FIELD = "NESTED_FORM_FIELD"
2281
+ }
2282
+ export interface FormOverride {
2283
+ /** Override entity type. */
2284
+ entityType?: OverrideEntityType;
2285
+ /** Overridden entity id. Either fieldId, or "{fieldIdWithNestedForm}/{nestedFormFieldId}" */
2286
+ entityId?: string | null;
2287
+ /** Form entity properties path with new value, that will be changed on condition. */
2288
+ valueChanges?: Record<string, any>;
2289
+ }
2290
+ export interface FormProperties {
2291
+ /** Form name. */
2292
+ name?: string | null;
2293
+ /** Identifies if the form is disabled. */
2294
+ disabled?: boolean;
2295
+ }
2296
+ export declare enum Kind {
2297
+ REGULAR = "REGULAR",
2298
+ EXTENSION = "EXTENSION"
2299
+ }
2300
+ export interface PostSubmissionTriggers {
2301
+ /** Upserts a contact from the submission data. */
2302
+ upsertContact?: UpsertContact;
2303
+ /** Payment trigger. */
2304
+ paymentTrigger?: PaymentTrigger;
2305
+ }
2306
+ export interface UpsertContact {
2307
+ /** Fields mapping (target field mapped to corresponding contact field). */
2308
+ fieldsMapping?: Record<string, FormFieldContactInfo>;
2309
+ /**
2310
+ * List of contact label keys.
2311
+ * [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
2312
+ * help categorize contacts.
2313
+ */
2314
+ labels?: string[];
2315
+ }
2316
+ export interface FormFieldContactInfo extends FormFieldContactInfoAdditionalInfoOneOf {
2317
+ /** Email info. */
2318
+ emailInfo?: EmailInfo;
2319
+ /** Phone info. */
2320
+ phoneInfo?: PhoneInfo;
2321
+ /** Address info. */
2322
+ addressInfo?: AddressInfo;
2323
+ /** Custom field info. */
2324
+ customFieldInfo?: CustomFieldInfo;
2325
+ /** Field mapped to contacts. */
2326
+ contactField?: ContactField;
2327
+ }
2328
+ /** @oneof */
2329
+ export interface FormFieldContactInfoAdditionalInfoOneOf {
2330
+ /** Email info. */
2331
+ emailInfo?: EmailInfo;
2332
+ /** Phone info. */
2333
+ phoneInfo?: PhoneInfo;
2334
+ /** Address info. */
2335
+ addressInfo?: AddressInfo;
2336
+ /** Custom field info. */
2337
+ customFieldInfo?: CustomFieldInfo;
2338
+ }
2339
+ export declare enum EmailInfoTag {
2340
+ UNTAGGED = "UNTAGGED",
2341
+ MAIN = "MAIN"
2342
+ }
2343
+ export declare enum PhoneInfoTag {
2344
+ UNTAGGED = "UNTAGGED",
2345
+ MAIN = "MAIN"
2346
+ }
2347
+ export declare enum Tag {
2348
+ UNTAGGED = "UNTAGGED",
2349
+ HOME = "HOME"
2350
+ }
2351
+ export declare enum ContactField {
2352
+ UNDEFINED = "UNDEFINED",
2353
+ FIRST_NAME = "FIRST_NAME",
2354
+ LAST_NAME = "LAST_NAME",
2355
+ COMPANY = "COMPANY",
2356
+ POSITION = "POSITION",
2357
+ EMAIL = "EMAIL",
2358
+ PHONE = "PHONE",
2359
+ ADDRESS = "ADDRESS",
2360
+ BIRTHDATE = "BIRTHDATE",
2361
+ CUSTOM_FIELD = "CUSTOM_FIELD",
2362
+ SUBSCRIPTION = "SUBSCRIPTION",
2363
+ VAT_ID = "VAT_ID"
2364
+ }
2365
+ export interface EmailInfo {
2366
+ /** Email tag. */
2367
+ tag?: EmailInfoTag;
2368
+ }
2369
+ export interface PhoneInfo {
2370
+ /** Phone tag. */
2371
+ tag?: PhoneInfoTag;
2372
+ }
2373
+ export interface AddressInfo {
2374
+ /** Address tag. */
2375
+ tag?: Tag;
2376
+ }
2377
+ export interface CustomFieldInfo {
2378
+ /** Custom field key. */
2379
+ key?: string;
2380
+ }
2381
+ export interface PaymentTrigger {
2382
+ /** Fields mapping (target field mapped to corresponding payment field). */
2383
+ fieldsMapping?: Record<string, FormFieldPaymentInfo>;
2384
+ }
2385
+ export interface FormFieldPaymentInfo {
2386
+ /** Field mapped to products. */
2387
+ products?: Product[];
2388
+ }
2389
+ export declare enum ProductType {
2390
+ UNKNOWN = "UNKNOWN",
2391
+ /** Shippable (physical). */
2392
+ SHIPPABLE = "SHIPPABLE",
2393
+ /** Digital. */
2394
+ DIGITAL = "DIGITAL"
2395
+ }
2396
+ export declare enum PriceType {
2397
+ UNKNOWN = "UNKNOWN",
2398
+ /** Fixed price. */
2399
+ FIXED_PRICE = "FIXED_PRICE",
2400
+ /** Dynamic price from price range. */
2401
+ DYNAMIC_PRICE = "DYNAMIC_PRICE"
2402
+ }
2403
+ export interface FixedPriceOptions {
2404
+ /** Fixed price monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). */
2405
+ price?: string;
2406
+ }
2407
+ export interface DynamicPriceOptions {
2408
+ /** Minimal price monetary amount. */
2409
+ minPrice?: string;
2410
+ /** Maximal price monetary amount. */
2411
+ maxPrice?: string | null;
2412
+ }
2413
+ export interface Product extends ProductPriceOptionsOneOf {
2414
+ /** Fixed price options. */
2415
+ fixedPriceOptions?: FixedPriceOptions;
2416
+ /** Dynamic price options. */
2417
+ dynamicPriceOptions?: DynamicPriceOptions;
2418
+ /**
2419
+ * Product ID.
2420
+ * @readonly
2421
+ */
2422
+ id?: string;
2423
+ /** Product type. */
2424
+ productType?: ProductType;
2425
+ /** Price type. */
2426
+ priceType?: PriceType;
2427
+ }
2428
+ /** @oneof */
2429
+ export interface ProductPriceOptionsOneOf {
2430
+ /** Fixed price options. */
2431
+ fixedPriceOptions?: FixedPriceOptions;
2432
+ /** Dynamic price options. */
2433
+ dynamicPriceOptions?: DynamicPriceOptions;
2434
+ }
2435
+ export interface ExtendedFields {
2436
+ /**
2437
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
2438
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
2439
+ *
2440
+ * You can only access fields for which you have the appropriate permissions.
2441
+ */
2442
+ namespaces?: Record<string, Record<string, any>>;
2443
+ }
2444
+ export interface NestedForm {
2445
+ /** Targets which have this form. */
2446
+ targets?: string[];
2447
+ /** Nested form. */
2448
+ form?: Form;
2449
+ }
2450
+ export interface CreateCheckoutFromSubmissionResponse {
2451
+ /** Checkout ID (applicable for form involving payments). */
2452
+ checkoutId?: string | null;
105
2453
  }
106
2454
  export interface DomainEvent extends DomainEventBodyOneOf {
107
2455
  createdEvent?: EntityCreatedEvent;
108
2456
  updatedEvent?: EntityUpdatedEvent;
109
2457
  deletedEvent?: EntityDeletedEvent;
110
2458
  actionEvent?: ActionEvent;
111
- /** random GUID so clients can tell if event was already handled */
2459
+ /**
2460
+ * Unique event ID.
2461
+ * Allows clients to ignore duplicate webhooks.
2462
+ */
112
2463
  id?: string;
113
2464
  /**
114
2465
  * Assumes actions are also always typed to an entity_type
@@ -121,17 +2472,13 @@ export interface DomainEvent extends DomainEventBodyOneOf {
121
2472
  * Example: created/updated/deleted/started/completed/email_opened
122
2473
  */
123
2474
  slug?: string;
124
- /**
125
- * Assuming that all messages including Actions have id
126
- * Example: The id of the specific order, the id of a specific campaign
127
- */
2475
+ /** ID of the entity associated with the event. */
128
2476
  entityId?: string;
129
- /** The time of the event. Useful if there was a delay in dispatching */
2477
+ /** Event timestamp. */
130
2478
  eventTime?: Date;
131
2479
  /**
132
- * A field that should be set if this event was triggered by an anonymize request.
133
- * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.
134
- * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.
2480
+ * Whether the event was triggered as a result of a privacy regulation application
2481
+ * (for example, GDPR).
135
2482
  */
136
2483
  triggeredByAnonymizeRequest?: boolean | null;
137
2484
  /** If present, indicates the action that triggered the event. */
@@ -225,6 +2572,12 @@ export interface SubmissionContactMapped {
225
2572
  /** Identifies the namespace that the submission's form belongs to. */
226
2573
  namespace?: string;
227
2574
  }
2575
+ export interface SubmissionContactMappingSkipped {
2576
+ /** Form Id. */
2577
+ formId?: string;
2578
+ /** Identifies the namespace that the submission's form belongs to. */
2579
+ namespace?: string;
2580
+ }
228
2581
  export interface CreateSubmissionRequest {
229
2582
  /** Submission to create. */
230
2583
  submission: FormSubmission;
@@ -329,6 +2682,58 @@ export interface DeleteSubmissionRequest {
329
2682
  }
330
2683
  export interface DeleteSubmissionResponse {
331
2684
  }
2685
+ export interface RestoreSubmissionFromTrashBinRequest {
2686
+ /** ID of the submission to restore. */
2687
+ submissionId: string;
2688
+ }
2689
+ export interface RestoreSubmissionFromTrashBinResponse {
2690
+ /** The restored submission. */
2691
+ submission?: FormSubmission;
2692
+ }
2693
+ export interface ListDeletedSubmissionsRequest {
2694
+ /** Form ID. */
2695
+ formId: string;
2696
+ /** Submission ids. */
2697
+ submissionIds?: string[];
2698
+ /** 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`. */
2699
+ paging?: CursorPaging;
2700
+ }
2701
+ export interface CursorPaging {
2702
+ /** Number of items to load. */
2703
+ limit?: number | null;
2704
+ /**
2705
+ * Pointer to the next or previous page in the list of results.
2706
+ *
2707
+ * You can get the relevant cursor token
2708
+ * from the `pagingMetadata` object in the previous call's response.
2709
+ * Not relevant for the first request.
2710
+ */
2711
+ cursor?: string | null;
2712
+ }
2713
+ export interface ListDeletedSubmissionsResponse {
2714
+ /** The retrieved Submissions. */
2715
+ submissions?: FormSubmission[];
2716
+ /** Paging metadata. */
2717
+ pagingMetadata?: CursorPagingMetadata;
2718
+ }
2719
+ export interface CursorPagingMetadata {
2720
+ /** Number of items returned in the response. */
2721
+ count?: number | null;
2722
+ /** Offset that was requested. */
2723
+ cursors?: Cursors;
2724
+ /**
2725
+ * Indicates if there are more results after the current page.
2726
+ * If `true`, another page of results can be retrieved.
2727
+ * If `false`, this is the last page.
2728
+ */
2729
+ hasNext?: boolean | null;
2730
+ }
2731
+ export interface Cursors {
2732
+ /** Cursor pointing to next page in the list of results. */
2733
+ next?: string | null;
2734
+ /** Cursor pointing to previous page in the list of results. */
2735
+ prev?: string | null;
2736
+ }
332
2737
  export interface QuerySubmissionRequest {
333
2738
  /** Query options. */
334
2739
  query?: CursorQuery;
@@ -362,42 +2767,12 @@ export declare enum SortOrder {
362
2767
  ASC = "ASC",
363
2768
  DESC = "DESC"
364
2769
  }
365
- export interface CursorPaging {
366
- /** Number of items to load. */
367
- limit?: number | null;
368
- /**
369
- * Pointer to the next or previous page in the list of results.
370
- *
371
- * You can get the relevant cursor token
372
- * from the `pagingMetadata` object in the previous call's response.
373
- * Not relevant for the first request.
374
- */
375
- cursor?: string | null;
376
- }
377
2770
  export interface QuerySubmissionResponse {
378
2771
  /** The retrieved submissions. */
379
2772
  submissions?: FormSubmission[];
380
2773
  /** Paging metadata. */
381
2774
  metadata?: CursorPagingMetadata;
382
2775
  }
383
- export interface CursorPagingMetadata {
384
- /** Number of items returned in the response. */
385
- count?: number | null;
386
- /** Offset that was requested. */
387
- cursors?: Cursors;
388
- /**
389
- * Indicates if there are more results after the current page.
390
- * If `true`, another page of results can be retrieved.
391
- * If `false`, this is the last page.
392
- */
393
- hasNext?: boolean | null;
394
- }
395
- export interface Cursors {
396
- /** Cursor pointing to next page in the list of results. */
397
- next?: string | null;
398
- /** Cursor pointing to previous page in the list of results. */
399
- prev?: string | null;
400
- }
401
2776
  export interface QuerySubmissionsByNamespaceRequest {
402
2777
  /** Query options. */
403
2778
  query: CursorQuery;
@@ -513,6 +2888,22 @@ export interface ConfirmSubmissionResponseNonNullableFields {
513
2888
  seen: boolean;
514
2889
  };
515
2890
  }
2891
+ export interface RestoreSubmissionFromTrashBinResponseNonNullableFields {
2892
+ submission?: {
2893
+ formId: string;
2894
+ namespace: string;
2895
+ status: SubmissionStatus;
2896
+ seen: boolean;
2897
+ };
2898
+ }
2899
+ export interface ListDeletedSubmissionsResponseNonNullableFields {
2900
+ submissions: {
2901
+ formId: string;
2902
+ namespace: string;
2903
+ status: SubmissionStatus;
2904
+ seen: boolean;
2905
+ }[];
2906
+ }
516
2907
  export interface QuerySubmissionsByNamespaceResponseNonNullableFields {
517
2908
  submissions: {
518
2909
  formId: string;