@wix/auto_sdk_rich-content_ricos-conversations 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/build/cjs/index.d.ts +2464 -0
  2. package/build/cjs/index.js +1506 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +1468 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +2438 -0
  8. package/build/cjs/meta.js +1401 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/es/index.d.mts +2464 -0
  11. package/build/es/index.mjs +1433 -0
  12. package/build/es/index.mjs.map +1 -0
  13. package/build/es/index.typings.d.mts +1 -0
  14. package/build/es/index.typings.mjs +1395 -0
  15. package/build/es/index.typings.mjs.map +1 -0
  16. package/build/es/meta.d.mts +2438 -0
  17. package/build/es/meta.mjs +1325 -0
  18. package/build/es/meta.mjs.map +1 -0
  19. package/build/es/package.json +3 -0
  20. package/build/internal/cjs/index.d.ts +72 -0
  21. package/build/internal/cjs/index.js +1506 -0
  22. package/build/internal/cjs/index.js.map +1 -0
  23. package/build/internal/cjs/index.typings.d.ts +2525 -0
  24. package/build/internal/cjs/index.typings.js +1468 -0
  25. package/build/internal/cjs/index.typings.js.map +1 -0
  26. package/build/internal/cjs/meta.d.ts +2438 -0
  27. package/build/internal/cjs/meta.js +1401 -0
  28. package/build/internal/cjs/meta.js.map +1 -0
  29. package/build/internal/es/index.d.mts +72 -0
  30. package/build/internal/es/index.mjs +1433 -0
  31. package/build/internal/es/index.mjs.map +1 -0
  32. package/build/internal/es/index.typings.d.mts +2525 -0
  33. package/build/internal/es/index.typings.mjs +1395 -0
  34. package/build/internal/es/index.typings.mjs.map +1 -0
  35. package/build/internal/es/meta.d.mts +2438 -0
  36. package/build/internal/es/meta.mjs +1325 -0
  37. package/build/internal/es/meta.mjs.map +1 -0
  38. package/meta/package.json +3 -0
  39. package/package.json +54 -0
@@ -0,0 +1,2464 @@
1
+ /**
2
+ * Represents a conversation session between a user and the Ricos AI Assistant
3
+ * Contains the document being edited and the complete message history
4
+ */
5
+ interface RicosConversation extends RicosConversationUserMessageOneOf {
6
+ /**
7
+ * Plain text message
8
+ * @maxLength 10000
9
+ */
10
+ message?: string;
11
+ /** Rich content message */
12
+ messageInRichContent?: RichContent;
13
+ /**
14
+ * Unique identifier for this conversation session.
15
+ * @format GUID
16
+ * @readonly
17
+ */
18
+ _id?: string | null;
19
+ /** The Ricos document being edited in this conversation. */
20
+ document?: RichContent;
21
+ /** The Ricos subset of user selected content */
22
+ documentSelection?: RichContent;
23
+ /**
24
+ * Templates knowledge base id
25
+ * @maxLength 100
26
+ */
27
+ templatesKnowledgeBaseId?: string | null;
28
+ }
29
+ /** @oneof */
30
+ interface RicosConversationUserMessageOneOf {
31
+ /**
32
+ * Plain text message
33
+ * @maxLength 10000
34
+ */
35
+ message?: string;
36
+ /** Rich content message */
37
+ messageInRichContent?: RichContent;
38
+ }
39
+ interface RichContent {
40
+ /** Node objects representing a rich content document. */
41
+ nodes?: Node[];
42
+ /** Object metadata. */
43
+ metadata?: Metadata;
44
+ /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
45
+ documentStyle?: DocumentStyle;
46
+ }
47
+ interface Node extends NodeDataOneOf {
48
+ /** Data for a button node. */
49
+ buttonData?: ButtonData;
50
+ /** Data for a code block node. */
51
+ codeBlockData?: CodeBlockData;
52
+ /** Data for a divider node. */
53
+ dividerData?: DividerData;
54
+ /** Data for a file node. */
55
+ fileData?: FileData;
56
+ /** Data for a gallery node. */
57
+ galleryData?: GalleryData;
58
+ /** Data for a GIF node. */
59
+ gifData?: GIFData;
60
+ /** Data for a heading node. */
61
+ headingData?: HeadingData;
62
+ /** Data for an embedded HTML node. */
63
+ htmlData?: HTMLData;
64
+ /** Data for an image node. */
65
+ imageData?: ImageData;
66
+ /** Data for a link preview node. */
67
+ linkPreviewData?: LinkPreviewData;
68
+ /** @deprecated */
69
+ mapData?: MapData;
70
+ /** Data for a paragraph node. */
71
+ paragraphData?: ParagraphData;
72
+ /** Data for a poll node. */
73
+ pollData?: PollData;
74
+ /** Data for a text node. Used to apply decorations to text. */
75
+ textData?: TextData;
76
+ /** Data for an app embed node. */
77
+ appEmbedData?: AppEmbedData;
78
+ /** Data for a video node. */
79
+ videoData?: VideoData;
80
+ /** Data for an oEmbed node. */
81
+ embedData?: EmbedData;
82
+ /** Data for a collapsible list node. */
83
+ collapsibleListData?: CollapsibleListData;
84
+ /** Data for a table node. */
85
+ tableData?: TableData;
86
+ /** Data for a table cell node. */
87
+ tableCellData?: TableCellData;
88
+ /** Data for a custom external node. */
89
+ externalData?: Record<string, any> | null;
90
+ /** Data for an audio node. */
91
+ audioData?: AudioData;
92
+ /** Data for an ordered list node. */
93
+ orderedListData?: OrderedListData;
94
+ /** Data for a bulleted list node. */
95
+ bulletedListData?: BulletedListData;
96
+ /** Data for a block quote node. */
97
+ blockquoteData?: BlockquoteData;
98
+ /** Data for a caption node. */
99
+ captionData?: CaptionData;
100
+ /** Data for a layout node. Reserved for future use. */
101
+ layoutData?: LayoutData;
102
+ /** Data for a cell node. */
103
+ layoutCellData?: LayoutCellData;
104
+ /** 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. */
105
+ type?: NodeTypeWithLiterals;
106
+ /** Node ID. */
107
+ id?: string;
108
+ /** A list of child nodes. */
109
+ nodes?: Node[];
110
+ /** Padding and background color styling for the node. */
111
+ style?: NodeStyle;
112
+ }
113
+ /** @oneof */
114
+ interface NodeDataOneOf {
115
+ /** Data for a button node. */
116
+ buttonData?: ButtonData;
117
+ /** Data for a code block node. */
118
+ codeBlockData?: CodeBlockData;
119
+ /** Data for a divider node. */
120
+ dividerData?: DividerData;
121
+ /** Data for a file node. */
122
+ fileData?: FileData;
123
+ /** Data for a gallery node. */
124
+ galleryData?: GalleryData;
125
+ /** Data for a GIF node. */
126
+ gifData?: GIFData;
127
+ /** Data for a heading node. */
128
+ headingData?: HeadingData;
129
+ /** Data for an embedded HTML node. */
130
+ htmlData?: HTMLData;
131
+ /** Data for an image node. */
132
+ imageData?: ImageData;
133
+ /** Data for a link preview node. */
134
+ linkPreviewData?: LinkPreviewData;
135
+ /** @deprecated */
136
+ mapData?: MapData;
137
+ /** Data for a paragraph node. */
138
+ paragraphData?: ParagraphData;
139
+ /** Data for a poll node. */
140
+ pollData?: PollData;
141
+ /** Data for a text node. Used to apply decorations to text. */
142
+ textData?: TextData;
143
+ /** Data for an app embed node. */
144
+ appEmbedData?: AppEmbedData;
145
+ /** Data for a video node. */
146
+ videoData?: VideoData;
147
+ /** Data for an oEmbed node. */
148
+ embedData?: EmbedData;
149
+ /** Data for a collapsible list node. */
150
+ collapsibleListData?: CollapsibleListData;
151
+ /** Data for a table node. */
152
+ tableData?: TableData;
153
+ /** Data for a table cell node. */
154
+ tableCellData?: TableCellData;
155
+ /** Data for a custom external node. */
156
+ externalData?: Record<string, any> | null;
157
+ /** Data for an audio node. */
158
+ audioData?: AudioData;
159
+ /** Data for an ordered list node. */
160
+ orderedListData?: OrderedListData;
161
+ /** Data for a bulleted list node. */
162
+ bulletedListData?: BulletedListData;
163
+ /** Data for a block quote node. */
164
+ blockquoteData?: BlockquoteData;
165
+ /** Data for a caption node. */
166
+ captionData?: CaptionData;
167
+ /** Data for a layout node. Reserved for future use. */
168
+ layoutData?: LayoutData;
169
+ /** Data for a cell node. */
170
+ layoutCellData?: LayoutCellData;
171
+ }
172
+ declare enum NodeType {
173
+ PARAGRAPH = "PARAGRAPH",
174
+ TEXT = "TEXT",
175
+ HEADING = "HEADING",
176
+ BULLETED_LIST = "BULLETED_LIST",
177
+ ORDERED_LIST = "ORDERED_LIST",
178
+ LIST_ITEM = "LIST_ITEM",
179
+ BLOCKQUOTE = "BLOCKQUOTE",
180
+ CODE_BLOCK = "CODE_BLOCK",
181
+ VIDEO = "VIDEO",
182
+ DIVIDER = "DIVIDER",
183
+ FILE = "FILE",
184
+ GALLERY = "GALLERY",
185
+ GIF = "GIF",
186
+ HTML = "HTML",
187
+ IMAGE = "IMAGE",
188
+ LINK_PREVIEW = "LINK_PREVIEW",
189
+ /** @deprecated */
190
+ MAP = "MAP",
191
+ POLL = "POLL",
192
+ APP_EMBED = "APP_EMBED",
193
+ BUTTON = "BUTTON",
194
+ COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
195
+ TABLE = "TABLE",
196
+ EMBED = "EMBED",
197
+ COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
198
+ COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
199
+ COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
200
+ TABLE_CELL = "TABLE_CELL",
201
+ TABLE_ROW = "TABLE_ROW",
202
+ EXTERNAL = "EXTERNAL",
203
+ AUDIO = "AUDIO",
204
+ CAPTION = "CAPTION",
205
+ LAYOUT = "LAYOUT",
206
+ LAYOUT_CELL = "LAYOUT_CELL"
207
+ }
208
+ /** @enumType */
209
+ type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
210
+ interface NodeStyle {
211
+ /** The top padding value in pixels. */
212
+ paddingTop?: string | null;
213
+ /** The bottom padding value in pixels. */
214
+ paddingBottom?: string | null;
215
+ /** The background color as a hexadecimal value. */
216
+ backgroundColor?: string | null;
217
+ }
218
+ interface ButtonData {
219
+ /** Styling for the button's container. */
220
+ containerData?: PluginContainerData;
221
+ /** The button type. */
222
+ type?: ButtonDataTypeWithLiterals;
223
+ /** Styling for the button. */
224
+ styles?: Styles;
225
+ /** The text to display on the button. */
226
+ text?: string | null;
227
+ /** Button link details. */
228
+ link?: Link;
229
+ }
230
+ interface Border {
231
+ /**
232
+ * Deprecated: Use `borderWidth` in `styles` instead.
233
+ * @deprecated
234
+ */
235
+ width?: number | null;
236
+ /**
237
+ * Deprecated: Use `borderRadius` in `styles` instead.
238
+ * @deprecated
239
+ */
240
+ radius?: number | null;
241
+ }
242
+ interface Colors {
243
+ /**
244
+ * Deprecated: Use `textColor` in `styles` instead.
245
+ * @deprecated
246
+ */
247
+ text?: string | null;
248
+ /**
249
+ * Deprecated: Use `borderColor` in `styles` instead.
250
+ * @deprecated
251
+ */
252
+ border?: string | null;
253
+ /**
254
+ * Deprecated: Use `backgroundColor` in `styles` instead.
255
+ * @deprecated
256
+ */
257
+ background?: string | null;
258
+ }
259
+ interface PluginContainerData {
260
+ /** The width of the node when it's displayed. */
261
+ width?: PluginContainerDataWidth;
262
+ /** The node's alignment within its container. */
263
+ alignment?: PluginContainerDataAlignmentWithLiterals;
264
+ /** Spoiler cover settings for the node. */
265
+ spoiler?: Spoiler;
266
+ /** The height of the node when it's displayed. */
267
+ height?: Height;
268
+ /** Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. */
269
+ textWrap?: boolean | null;
270
+ }
271
+ declare enum WidthType {
272
+ /** Width matches the content width */
273
+ CONTENT = "CONTENT",
274
+ /** Small Width */
275
+ SMALL = "SMALL",
276
+ /** Width will match the original asset width */
277
+ ORIGINAL = "ORIGINAL",
278
+ /** coast-to-coast display */
279
+ FULL_WIDTH = "FULL_WIDTH"
280
+ }
281
+ /** @enumType */
282
+ type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
283
+ interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
284
+ /**
285
+ * One of the following predefined width options:
286
+ * `CONTENT`: The width of the container matches the content width.
287
+ * `SMALL`: A small width.
288
+ * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
289
+ * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
290
+ */
291
+ size?: WidthTypeWithLiterals;
292
+ /** A custom width value in pixels. */
293
+ custom?: string | null;
294
+ }
295
+ /** @oneof */
296
+ interface PluginContainerDataWidthDataOneOf {
297
+ /**
298
+ * One of the following predefined width options:
299
+ * `CONTENT`: The width of the container matches the content width.
300
+ * `SMALL`: A small width.
301
+ * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
302
+ * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
303
+ */
304
+ size?: WidthTypeWithLiterals;
305
+ /** A custom width value in pixels. */
306
+ custom?: string | null;
307
+ }
308
+ declare enum PluginContainerDataAlignment {
309
+ /** Center Alignment */
310
+ CENTER = "CENTER",
311
+ /** Left Alignment */
312
+ LEFT = "LEFT",
313
+ /** Right Alignment */
314
+ RIGHT = "RIGHT"
315
+ }
316
+ /** @enumType */
317
+ type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
318
+ interface Spoiler {
319
+ /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
320
+ enabled?: boolean | null;
321
+ /** The description displayed on top of the spoiler cover. */
322
+ description?: string | null;
323
+ /** The text for the button used to remove the spoiler cover. */
324
+ buttonText?: string | null;
325
+ }
326
+ interface Height {
327
+ /** A custom height value in pixels. */
328
+ custom?: string | null;
329
+ }
330
+ declare enum ButtonDataType {
331
+ /** Regular link button */
332
+ LINK = "LINK",
333
+ /** Triggers custom action that is defined in plugin configuration by the consumer */
334
+ ACTION = "ACTION"
335
+ }
336
+ /** @enumType */
337
+ type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
338
+ interface Styles {
339
+ /**
340
+ * Deprecated: Use `borderWidth` and `borderRadius` instead.
341
+ * @deprecated
342
+ */
343
+ border?: Border;
344
+ /**
345
+ * Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
346
+ * @deprecated
347
+ */
348
+ colors?: Colors;
349
+ /** Border width in pixels. */
350
+ borderWidth?: number | null;
351
+ /**
352
+ * Deprecated: Use `borderWidth` for normal/hover states instead.
353
+ * @deprecated
354
+ */
355
+ borderWidthHover?: number | null;
356
+ /** Border radius in pixels. */
357
+ borderRadius?: number | null;
358
+ /**
359
+ * Border color as a hexadecimal value.
360
+ * @format COLOR_HEX
361
+ */
362
+ borderColor?: string | null;
363
+ /**
364
+ * Border color as a hexadecimal value (hover state).
365
+ * @format COLOR_HEX
366
+ */
367
+ borderColorHover?: string | null;
368
+ /**
369
+ * Text color as a hexadecimal value.
370
+ * @format COLOR_HEX
371
+ */
372
+ textColor?: string | null;
373
+ /**
374
+ * Text color as a hexadecimal value (hover state).
375
+ * @format COLOR_HEX
376
+ */
377
+ textColorHover?: string | null;
378
+ /**
379
+ * Background color as a hexadecimal value.
380
+ * @format COLOR_HEX
381
+ */
382
+ backgroundColor?: string | null;
383
+ /**
384
+ * Background color as a hexadecimal value (hover state).
385
+ * @format COLOR_HEX
386
+ */
387
+ backgroundColorHover?: string | null;
388
+ /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
389
+ buttonSize?: string | null;
390
+ }
391
+ interface Link extends LinkDataOneOf {
392
+ /** The absolute URL for the linked document. */
393
+ url?: string;
394
+ /** The target node's ID. Used for linking to another node in this object. */
395
+ anchor?: string;
396
+ /**
397
+ * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
398
+ * `SELF` - Default. Opens the linked document in the same frame as the link.
399
+ * `BLANK` - Opens the linked document in a new browser tab or window.
400
+ * `PARENT` - Opens the linked document in the link's parent frame.
401
+ * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
402
+ */
403
+ target?: TargetWithLiterals;
404
+ /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
405
+ rel?: Rel;
406
+ /** A serialized object used for a custom or external link panel. */
407
+ customData?: string | null;
408
+ }
409
+ /** @oneof */
410
+ interface LinkDataOneOf {
411
+ /** The absolute URL for the linked document. */
412
+ url?: string;
413
+ /** The target node's ID. Used for linking to another node in this object. */
414
+ anchor?: string;
415
+ }
416
+ declare enum Target {
417
+ /** Opens the linked document in the same frame as it was clicked (this is default) */
418
+ SELF = "SELF",
419
+ /** Opens the linked document in a new window or tab */
420
+ BLANK = "BLANK",
421
+ /** Opens the linked document in the parent frame */
422
+ PARENT = "PARENT",
423
+ /** Opens the linked document in the full body of the window */
424
+ TOP = "TOP"
425
+ }
426
+ /** @enumType */
427
+ type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
428
+ interface Rel {
429
+ /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
430
+ nofollow?: boolean | null;
431
+ /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
432
+ sponsored?: boolean | null;
433
+ /** Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`. */
434
+ ugc?: boolean | null;
435
+ /** Indicates that this link protect referral information from being passed to the target website. */
436
+ noreferrer?: boolean | null;
437
+ }
438
+ interface CodeBlockData {
439
+ /** Styling for the code block's text. */
440
+ textStyle?: TextStyle;
441
+ }
442
+ interface TextStyle {
443
+ /** Text alignment. Defaults to `AUTO`. */
444
+ textAlignment?: TextAlignmentWithLiterals;
445
+ /** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
446
+ lineHeight?: string | null;
447
+ }
448
+ declare enum TextAlignment {
449
+ /** browser default, eqivalent to `initial` */
450
+ AUTO = "AUTO",
451
+ /** Left align */
452
+ LEFT = "LEFT",
453
+ /** Right align */
454
+ RIGHT = "RIGHT",
455
+ /** Center align */
456
+ CENTER = "CENTER",
457
+ /** 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 */
458
+ JUSTIFY = "JUSTIFY"
459
+ }
460
+ /** @enumType */
461
+ type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
462
+ interface DividerData {
463
+ /** Styling for the divider's container. */
464
+ containerData?: PluginContainerData;
465
+ /** Divider line style. */
466
+ lineStyle?: LineStyleWithLiterals;
467
+ /** Divider width. */
468
+ width?: WidthWithLiterals;
469
+ /** Divider alignment. */
470
+ alignment?: DividerDataAlignmentWithLiterals;
471
+ }
472
+ declare enum LineStyle {
473
+ /** Single Line */
474
+ SINGLE = "SINGLE",
475
+ /** Double Line */
476
+ DOUBLE = "DOUBLE",
477
+ /** Dashed Line */
478
+ DASHED = "DASHED",
479
+ /** Dotted Line */
480
+ DOTTED = "DOTTED"
481
+ }
482
+ /** @enumType */
483
+ type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
484
+ declare enum Width {
485
+ /** Large line */
486
+ LARGE = "LARGE",
487
+ /** Medium line */
488
+ MEDIUM = "MEDIUM",
489
+ /** Small line */
490
+ SMALL = "SMALL"
491
+ }
492
+ /** @enumType */
493
+ type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
494
+ declare enum DividerDataAlignment {
495
+ /** Center alignment */
496
+ CENTER = "CENTER",
497
+ /** Left alignment */
498
+ LEFT = "LEFT",
499
+ /** Right alignment */
500
+ RIGHT = "RIGHT"
501
+ }
502
+ /** @enumType */
503
+ type DividerDataAlignmentWithLiterals = DividerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
504
+ interface FileData {
505
+ /** Styling for the file's container. */
506
+ containerData?: PluginContainerData;
507
+ /** The source for the file's data. */
508
+ src?: FileSource;
509
+ /** File name. */
510
+ name?: string | null;
511
+ /** File type. */
512
+ type?: string | null;
513
+ /**
514
+ * Use `sizeInKb` instead.
515
+ * @deprecated
516
+ */
517
+ size?: number | null;
518
+ /** Settings for PDF files. */
519
+ pdfSettings?: PDFSettings;
520
+ /** File MIME type. */
521
+ mimeType?: string | null;
522
+ /** File path. */
523
+ path?: string | null;
524
+ /** File size in KB. */
525
+ sizeInKb?: string | null;
526
+ }
527
+ declare enum ViewMode {
528
+ /** No PDF view */
529
+ NONE = "NONE",
530
+ /** Full PDF view */
531
+ FULL = "FULL",
532
+ /** Mini PDF view */
533
+ MINI = "MINI"
534
+ }
535
+ /** @enumType */
536
+ type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
537
+ interface FileSource extends FileSourceDataOneOf {
538
+ /** The absolute URL for the file's source. */
539
+ url?: string | null;
540
+ /**
541
+ * Custom ID. Use `id` instead.
542
+ * @deprecated
543
+ */
544
+ custom?: string | null;
545
+ /** An ID that's resolved to a URL by a resolver function. */
546
+ id?: string | null;
547
+ /** Indicates whether the file's source is private. Defaults to `false`. */
548
+ private?: boolean | null;
549
+ }
550
+ /** @oneof */
551
+ interface FileSourceDataOneOf {
552
+ /** The absolute URL for the file's source. */
553
+ url?: string | null;
554
+ /**
555
+ * Custom ID. Use `id` instead.
556
+ * @deprecated
557
+ */
558
+ custom?: string | null;
559
+ /** An ID that's resolved to a URL by a resolver function. */
560
+ id?: string | null;
561
+ }
562
+ interface PDFSettings {
563
+ /**
564
+ * PDF view mode. One of the following:
565
+ * `NONE` : The PDF isn't displayed.
566
+ * `FULL` : A full page view of the PDF is displayed.
567
+ * `MINI` : A mini view of the PDF is displayed.
568
+ */
569
+ viewMode?: ViewModeWithLiterals;
570
+ /** Sets whether the PDF download button is disabled. Defaults to `false`. */
571
+ disableDownload?: boolean | null;
572
+ /** Sets whether the PDF print button is disabled. Defaults to `false`. */
573
+ disablePrint?: boolean | null;
574
+ }
575
+ interface GalleryData {
576
+ /** Styling for the gallery's container. */
577
+ containerData?: PluginContainerData;
578
+ /** The items in the gallery. */
579
+ items?: Item[];
580
+ /** Options for defining the gallery's appearance. */
581
+ options?: GalleryOptions;
582
+ /** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
583
+ disableExpand?: boolean | null;
584
+ /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
585
+ disableDownload?: boolean | null;
586
+ }
587
+ interface Media {
588
+ /** The source for the media's data. */
589
+ src?: FileSource;
590
+ /** Media width in pixels. */
591
+ width?: number | null;
592
+ /** Media height in pixels. */
593
+ height?: number | null;
594
+ /** Media duration in seconds. Only relevant for audio and video files. */
595
+ duration?: number | null;
596
+ }
597
+ interface Image {
598
+ /** Image file details. */
599
+ media?: Media;
600
+ /** Link details for images that are links. */
601
+ link?: Link;
602
+ }
603
+ interface Video {
604
+ /** Video file details. */
605
+ media?: Media;
606
+ /** Video thumbnail file details. */
607
+ thumbnail?: Media;
608
+ }
609
+ interface Item extends ItemDataOneOf {
610
+ /** An image item. */
611
+ image?: Image;
612
+ /** A video item. */
613
+ video?: Video;
614
+ /** Item title. */
615
+ title?: string | null;
616
+ /** Item's alternative text. */
617
+ altText?: string | null;
618
+ }
619
+ /** @oneof */
620
+ interface ItemDataOneOf {
621
+ /** An image item. */
622
+ image?: Image;
623
+ /** A video item. */
624
+ video?: Video;
625
+ }
626
+ interface GalleryOptions {
627
+ /** Gallery layout. */
628
+ layout?: GalleryOptionsLayout;
629
+ /** Styling for gallery items. */
630
+ item?: ItemStyle;
631
+ /** Styling for gallery thumbnail images. */
632
+ thumbnails?: Thumbnails;
633
+ }
634
+ declare enum LayoutType {
635
+ /** Collage type */
636
+ COLLAGE = "COLLAGE",
637
+ /** Masonry type */
638
+ MASONRY = "MASONRY",
639
+ /** Grid type */
640
+ GRID = "GRID",
641
+ /** Thumbnail type */
642
+ THUMBNAIL = "THUMBNAIL",
643
+ /** Slider type */
644
+ SLIDER = "SLIDER",
645
+ /** Slideshow type */
646
+ SLIDESHOW = "SLIDESHOW",
647
+ /** Panorama type */
648
+ PANORAMA = "PANORAMA",
649
+ /** Column type */
650
+ COLUMN = "COLUMN",
651
+ /** Magic type */
652
+ MAGIC = "MAGIC",
653
+ /** Fullsize images type */
654
+ FULLSIZE = "FULLSIZE"
655
+ }
656
+ /** @enumType */
657
+ type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
658
+ declare enum Orientation {
659
+ /** Rows Orientation */
660
+ ROWS = "ROWS",
661
+ /** Columns Orientation */
662
+ COLUMNS = "COLUMNS"
663
+ }
664
+ /** @enumType */
665
+ type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
666
+ declare enum Crop {
667
+ /** Crop to fill */
668
+ FILL = "FILL",
669
+ /** Crop to fit */
670
+ FIT = "FIT"
671
+ }
672
+ /** @enumType */
673
+ type CropWithLiterals = Crop | 'FILL' | 'FIT';
674
+ declare enum ThumbnailsAlignment {
675
+ /** Top alignment */
676
+ TOP = "TOP",
677
+ /** Right alignment */
678
+ RIGHT = "RIGHT",
679
+ /** Bottom alignment */
680
+ BOTTOM = "BOTTOM",
681
+ /** Left alignment */
682
+ LEFT = "LEFT",
683
+ /** No thumbnail */
684
+ NONE = "NONE"
685
+ }
686
+ /** @enumType */
687
+ type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
688
+ interface GalleryOptionsLayout {
689
+ /** Gallery layout type. */
690
+ type?: LayoutTypeWithLiterals;
691
+ /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
692
+ horizontalScroll?: boolean | null;
693
+ /** Gallery orientation. */
694
+ orientation?: OrientationWithLiterals;
695
+ /** The number of columns to display on full size screens. */
696
+ numberOfColumns?: number | null;
697
+ /** The number of columns to display on mobile screens. */
698
+ mobileNumberOfColumns?: number | null;
699
+ }
700
+ interface ItemStyle {
701
+ /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
702
+ targetSize?: number | null;
703
+ /** Item ratio */
704
+ ratio?: number | null;
705
+ /** Sets how item images are cropped. */
706
+ crop?: CropWithLiterals;
707
+ /** The spacing between items in pixels. */
708
+ spacing?: number | null;
709
+ }
710
+ interface Thumbnails {
711
+ /** Thumbnail alignment. */
712
+ placement?: ThumbnailsAlignmentWithLiterals;
713
+ /** Spacing between thumbnails in pixels. */
714
+ spacing?: number | null;
715
+ }
716
+ interface GIFData {
717
+ /** Styling for the GIF's container. */
718
+ containerData?: PluginContainerData;
719
+ /** The source of the full size GIF. */
720
+ original?: GIF;
721
+ /** The source of the downsized GIF. */
722
+ downsized?: GIF;
723
+ /** Height in pixels. */
724
+ height?: number;
725
+ /** Width in pixels. */
726
+ width?: number;
727
+ /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
728
+ gifType?: GIFTypeWithLiterals;
729
+ }
730
+ interface GIF {
731
+ /**
732
+ * GIF format URL.
733
+ * @format WEB_URL
734
+ */
735
+ gif?: string | null;
736
+ /**
737
+ * MP4 format URL.
738
+ * @format WEB_URL
739
+ */
740
+ mp4?: string | null;
741
+ /**
742
+ * Thumbnail URL.
743
+ * @format WEB_URL
744
+ */
745
+ still?: string | null;
746
+ }
747
+ declare enum GIFType {
748
+ NORMAL = "NORMAL",
749
+ STICKER = "STICKER"
750
+ }
751
+ /** @enumType */
752
+ type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
753
+ interface HeadingData {
754
+ /** Heading level from 1-6. */
755
+ level?: number;
756
+ /** Styling for the heading text. */
757
+ textStyle?: TextStyle;
758
+ /** Indentation level from 1-4. */
759
+ indentation?: number | null;
760
+ }
761
+ interface HTMLData extends HTMLDataDataOneOf {
762
+ /** The URL for the HTML code for the node. */
763
+ url?: string;
764
+ /** The HTML code for the node. */
765
+ html?: string;
766
+ /**
767
+ * Whether this is an AdSense element. Use `source` instead.
768
+ * @deprecated
769
+ */
770
+ isAdsense?: boolean | null;
771
+ /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
772
+ containerData?: PluginContainerData;
773
+ /** The type of HTML code. */
774
+ source?: SourceWithLiterals;
775
+ /** If container height is aligned with its content height. Defaults to `true`. */
776
+ autoHeight?: boolean | null;
777
+ }
778
+ /** @oneof */
779
+ interface HTMLDataDataOneOf {
780
+ /** The URL for the HTML code for the node. */
781
+ url?: string;
782
+ /** The HTML code for the node. */
783
+ html?: string;
784
+ /**
785
+ * Whether this is an AdSense element. Use `source` instead.
786
+ * @deprecated
787
+ */
788
+ isAdsense?: boolean | null;
789
+ }
790
+ declare enum Source {
791
+ HTML = "HTML",
792
+ ADSENSE = "ADSENSE",
793
+ AI = "AI"
794
+ }
795
+ /** @enumType */
796
+ type SourceWithLiterals = Source | 'HTML' | 'ADSENSE' | 'AI';
797
+ interface ImageData {
798
+ /** Styling for the image's container. */
799
+ containerData?: PluginContainerData;
800
+ /** Image file details. */
801
+ image?: Media;
802
+ /** Link details for images that are links. */
803
+ link?: Link;
804
+ /** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
805
+ disableExpand?: boolean | null;
806
+ /** Image's alternative text. */
807
+ altText?: string | null;
808
+ /**
809
+ * Deprecated: use Caption node instead.
810
+ * @deprecated
811
+ */
812
+ caption?: string | null;
813
+ /** Sets whether the image's download button is disabled. Defaults to `false`. */
814
+ disableDownload?: boolean | null;
815
+ /** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
816
+ decorative?: boolean | null;
817
+ /** Styling for the image. */
818
+ styles?: ImageDataStyles;
819
+ }
820
+ interface StylesBorder {
821
+ /** Border width in pixels. */
822
+ width?: number | null;
823
+ /**
824
+ * Border color as a hexadecimal value.
825
+ * @format COLOR_HEX
826
+ */
827
+ color?: string | null;
828
+ /** Border radius in pixels. */
829
+ radius?: number | null;
830
+ }
831
+ interface ImageDataStyles {
832
+ /** Border attributes. */
833
+ border?: StylesBorder;
834
+ }
835
+ interface LinkPreviewData {
836
+ /** Styling for the link preview's container. */
837
+ containerData?: PluginContainerData;
838
+ /** Link details. */
839
+ link?: Link;
840
+ /** Preview title. */
841
+ title?: string | null;
842
+ /** Preview thumbnail URL. */
843
+ thumbnailUrl?: string | null;
844
+ /** Preview description. */
845
+ description?: string | null;
846
+ /** The preview content as HTML. */
847
+ html?: string | null;
848
+ /** Styling for the link preview. */
849
+ styles?: LinkPreviewDataStyles;
850
+ }
851
+ declare enum StylesPosition {
852
+ /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
853
+ START = "START",
854
+ /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
855
+ END = "END",
856
+ /** Thumbnail positioned at the top */
857
+ TOP = "TOP",
858
+ /** Thumbnail hidden and not displayed */
859
+ HIDDEN = "HIDDEN"
860
+ }
861
+ /** @enumType */
862
+ type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HIDDEN';
863
+ interface LinkPreviewDataStyles {
864
+ /**
865
+ * Background color as a hexadecimal value.
866
+ * @format COLOR_HEX
867
+ */
868
+ backgroundColor?: string | null;
869
+ /**
870
+ * Title color as a hexadecimal value.
871
+ * @format COLOR_HEX
872
+ */
873
+ titleColor?: string | null;
874
+ /**
875
+ * Subtitle color as a hexadecimal value.
876
+ * @format COLOR_HEX
877
+ */
878
+ subtitleColor?: string | null;
879
+ /**
880
+ * Link color as a hexadecimal value.
881
+ * @format COLOR_HEX
882
+ */
883
+ linkColor?: string | null;
884
+ /** Border width in pixels. */
885
+ borderWidth?: number | null;
886
+ /** Border radius in pixels. */
887
+ borderRadius?: number | null;
888
+ /**
889
+ * Border color as a hexadecimal value.
890
+ * @format COLOR_HEX
891
+ */
892
+ borderColor?: string | null;
893
+ /** Position of thumbnail. Defaults to `START`. */
894
+ thumbnailPosition?: StylesPositionWithLiterals;
895
+ }
896
+ interface MapData {
897
+ /** Styling for the map's container. */
898
+ containerData?: PluginContainerData;
899
+ /** Map settings. */
900
+ mapSettings?: MapSettings;
901
+ }
902
+ interface MapSettings {
903
+ /** The address to display on the map. */
904
+ address?: string | null;
905
+ /** Sets whether the map is draggable. */
906
+ draggable?: boolean | null;
907
+ /** Sets whether the location marker is visible. */
908
+ marker?: boolean | null;
909
+ /** Sets whether street view control is enabled. */
910
+ streetViewControl?: boolean | null;
911
+ /** Sets whether zoom control is enabled. */
912
+ zoomControl?: boolean | null;
913
+ /** Location latitude. */
914
+ lat?: number | null;
915
+ /** Location longitude. */
916
+ lng?: number | null;
917
+ /** Location name. */
918
+ locationName?: string | null;
919
+ /** Sets whether view mode control is enabled. */
920
+ viewModeControl?: boolean | null;
921
+ /** Initial zoom value. */
922
+ initialZoom?: number | null;
923
+ /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
924
+ mapType?: MapTypeWithLiterals;
925
+ }
926
+ declare enum MapType {
927
+ /** Roadmap map type */
928
+ ROADMAP = "ROADMAP",
929
+ /** Satellite map type */
930
+ SATELITE = "SATELITE",
931
+ /** Hybrid map type */
932
+ HYBRID = "HYBRID",
933
+ /** Terrain map type */
934
+ TERRAIN = "TERRAIN"
935
+ }
936
+ /** @enumType */
937
+ type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
938
+ interface ParagraphData {
939
+ /** Styling for the paragraph text. */
940
+ textStyle?: TextStyle;
941
+ /** Indentation level from 1-4. */
942
+ indentation?: number | null;
943
+ /** Paragraph level */
944
+ level?: number | null;
945
+ }
946
+ interface PollData {
947
+ /** Styling for the poll's container. */
948
+ containerData?: PluginContainerData;
949
+ /** Poll data. */
950
+ poll?: Poll;
951
+ /** Layout settings for the poll and voting options. */
952
+ layout?: PollDataLayout;
953
+ /** Styling for the poll and voting options. */
954
+ design?: Design;
955
+ }
956
+ declare enum ViewRole {
957
+ /** Only Poll creator can view the results */
958
+ CREATOR = "CREATOR",
959
+ /** Anyone who voted can see the results */
960
+ VOTERS = "VOTERS",
961
+ /** Anyone can see the results, even if one didn't vote */
962
+ EVERYONE = "EVERYONE"
963
+ }
964
+ /** @enumType */
965
+ type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
966
+ declare enum VoteRole {
967
+ /** Logged in member */
968
+ SITE_MEMBERS = "SITE_MEMBERS",
969
+ /** Anyone */
970
+ ALL = "ALL"
971
+ }
972
+ /** @enumType */
973
+ type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
974
+ interface Permissions {
975
+ /** Sets who can view the poll results. */
976
+ view?: ViewRoleWithLiterals;
977
+ /** Sets who can vote. */
978
+ vote?: VoteRoleWithLiterals;
979
+ /** Sets whether one voter can vote multiple times. Defaults to `false`. */
980
+ allowMultipleVotes?: boolean | null;
981
+ }
982
+ interface Option {
983
+ /** Option ID. */
984
+ id?: string | null;
985
+ /** Option title. */
986
+ title?: string | null;
987
+ /** The image displayed with the option. */
988
+ image?: Media;
989
+ }
990
+ interface Settings {
991
+ /** Permissions settings for voting. */
992
+ permissions?: Permissions;
993
+ /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
994
+ showVoters?: boolean | null;
995
+ /** Sets whether the vote count is displayed. Defaults to `true`. */
996
+ showVotesCount?: boolean | null;
997
+ }
998
+ declare enum PollLayoutType {
999
+ /** List */
1000
+ LIST = "LIST",
1001
+ /** Grid */
1002
+ GRID = "GRID"
1003
+ }
1004
+ /** @enumType */
1005
+ type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
1006
+ declare enum PollLayoutDirection {
1007
+ /** Left-to-right */
1008
+ LTR = "LTR",
1009
+ /** Right-to-left */
1010
+ RTL = "RTL"
1011
+ }
1012
+ /** @enumType */
1013
+ type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
1014
+ interface PollLayout {
1015
+ /** The layout for displaying the voting options. */
1016
+ type?: PollLayoutTypeWithLiterals;
1017
+ /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
1018
+ direction?: PollLayoutDirectionWithLiterals;
1019
+ /** Sets whether to display the main poll image. Defaults to `false`. */
1020
+ enableImage?: boolean | null;
1021
+ }
1022
+ interface OptionLayout {
1023
+ /** Sets whether to display option images. Defaults to `false`. */
1024
+ enableImage?: boolean | null;
1025
+ }
1026
+ declare enum BackgroundType {
1027
+ /** Color background type */
1028
+ COLOR = "COLOR",
1029
+ /** Image background type */
1030
+ IMAGE = "IMAGE",
1031
+ /** Gradiant background type */
1032
+ GRADIENT = "GRADIENT"
1033
+ }
1034
+ /** @enumType */
1035
+ type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
1036
+ interface Gradient {
1037
+ /** The gradient angle in degrees. */
1038
+ angle?: number | null;
1039
+ /**
1040
+ * The start color as a hexademical value.
1041
+ * @format COLOR_HEX
1042
+ */
1043
+ startColor?: string | null;
1044
+ /**
1045
+ * The end color as a hexademical value.
1046
+ * @format COLOR_HEX
1047
+ */
1048
+ lastColor?: string | null;
1049
+ }
1050
+ interface Background extends BackgroundBackgroundOneOf {
1051
+ /**
1052
+ * The background color as a hexademical value.
1053
+ * @format COLOR_HEX
1054
+ */
1055
+ color?: string | null;
1056
+ /** An image to use for the background. */
1057
+ image?: Media;
1058
+ /** Details for a gradient background. */
1059
+ gradient?: Gradient;
1060
+ /** Background type. For each option, include the relevant details. */
1061
+ type?: BackgroundTypeWithLiterals;
1062
+ }
1063
+ /** @oneof */
1064
+ interface BackgroundBackgroundOneOf {
1065
+ /**
1066
+ * The background color as a hexademical value.
1067
+ * @format COLOR_HEX
1068
+ */
1069
+ color?: string | null;
1070
+ /** An image to use for the background. */
1071
+ image?: Media;
1072
+ /** Details for a gradient background. */
1073
+ gradient?: Gradient;
1074
+ }
1075
+ interface PollDesign {
1076
+ /** Background styling. */
1077
+ background?: Background;
1078
+ /** Border radius in pixels. */
1079
+ borderRadius?: number | null;
1080
+ }
1081
+ interface OptionDesign {
1082
+ /** Border radius in pixels. */
1083
+ borderRadius?: number | null;
1084
+ }
1085
+ interface Poll {
1086
+ /** Poll ID. */
1087
+ id?: string | null;
1088
+ /** Poll title. */
1089
+ title?: string | null;
1090
+ /** Poll creator ID. */
1091
+ creatorId?: string | null;
1092
+ /** Main poll image. */
1093
+ image?: Media;
1094
+ /** Voting options. */
1095
+ options?: Option[];
1096
+ /** The poll's permissions and display settings. */
1097
+ settings?: Settings;
1098
+ }
1099
+ interface PollDataLayout {
1100
+ /** Poll layout settings. */
1101
+ poll?: PollLayout;
1102
+ /** Voting otpions layout settings. */
1103
+ options?: OptionLayout;
1104
+ }
1105
+ interface Design {
1106
+ /** Styling for the poll. */
1107
+ poll?: PollDesign;
1108
+ /** Styling for voting options. */
1109
+ options?: OptionDesign;
1110
+ }
1111
+ interface TextData {
1112
+ /** The text to apply decorations to. */
1113
+ text?: string;
1114
+ /** The decorations to apply. */
1115
+ decorations?: Decoration[];
1116
+ }
1117
+ /** Adds appearence changes to text */
1118
+ interface Decoration extends DecorationDataOneOf {
1119
+ /** Data for an anchor link decoration. */
1120
+ anchorData?: AnchorData;
1121
+ /** Data for a color decoration. */
1122
+ colorData?: ColorData;
1123
+ /** Data for an external link decoration. */
1124
+ linkData?: LinkData;
1125
+ /** Data for a mention decoration. */
1126
+ mentionData?: MentionData;
1127
+ /** Data for a font size decoration. */
1128
+ fontSizeData?: FontSizeData;
1129
+ /** Font weight for a bold decoration. */
1130
+ fontWeightValue?: number | null;
1131
+ /** Data for an italic decoration. Defaults to `true`. */
1132
+ italicData?: boolean | null;
1133
+ /** Data for an underline decoration. Defaults to `true`. */
1134
+ underlineData?: boolean | null;
1135
+ /** Data for a spoiler decoration. */
1136
+ spoilerData?: SpoilerData;
1137
+ /** Data for a strikethrough decoration. Defaults to `true`. */
1138
+ strikethroughData?: boolean | null;
1139
+ /** Data for a superscript decoration. Defaults to `true`. */
1140
+ superscriptData?: boolean | null;
1141
+ /** Data for a subscript decoration. Defaults to `true`. */
1142
+ subscriptData?: boolean | null;
1143
+ /** The type of decoration to apply. */
1144
+ type?: DecorationTypeWithLiterals;
1145
+ }
1146
+ /** @oneof */
1147
+ interface DecorationDataOneOf {
1148
+ /** Data for an anchor link decoration. */
1149
+ anchorData?: AnchorData;
1150
+ /** Data for a color decoration. */
1151
+ colorData?: ColorData;
1152
+ /** Data for an external link decoration. */
1153
+ linkData?: LinkData;
1154
+ /** Data for a mention decoration. */
1155
+ mentionData?: MentionData;
1156
+ /** Data for a font size decoration. */
1157
+ fontSizeData?: FontSizeData;
1158
+ /** Font weight for a bold decoration. */
1159
+ fontWeightValue?: number | null;
1160
+ /** Data for an italic decoration. Defaults to `true`. */
1161
+ italicData?: boolean | null;
1162
+ /** Data for an underline decoration. Defaults to `true`. */
1163
+ underlineData?: boolean | null;
1164
+ /** Data for a spoiler decoration. */
1165
+ spoilerData?: SpoilerData;
1166
+ /** Data for a strikethrough decoration. Defaults to `true`. */
1167
+ strikethroughData?: boolean | null;
1168
+ /** Data for a superscript decoration. Defaults to `true`. */
1169
+ superscriptData?: boolean | null;
1170
+ /** Data for a subscript decoration. Defaults to `true`. */
1171
+ subscriptData?: boolean | null;
1172
+ }
1173
+ declare enum DecorationType {
1174
+ BOLD = "BOLD",
1175
+ ITALIC = "ITALIC",
1176
+ UNDERLINE = "UNDERLINE",
1177
+ SPOILER = "SPOILER",
1178
+ ANCHOR = "ANCHOR",
1179
+ MENTION = "MENTION",
1180
+ LINK = "LINK",
1181
+ COLOR = "COLOR",
1182
+ FONT_SIZE = "FONT_SIZE",
1183
+ EXTERNAL = "EXTERNAL",
1184
+ STRIKETHROUGH = "STRIKETHROUGH",
1185
+ SUPERSCRIPT = "SUPERSCRIPT",
1186
+ SUBSCRIPT = "SUBSCRIPT"
1187
+ }
1188
+ /** @enumType */
1189
+ type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH' | 'SUPERSCRIPT' | 'SUBSCRIPT';
1190
+ interface AnchorData {
1191
+ /** The target node's ID. */
1192
+ anchor?: string;
1193
+ }
1194
+ interface ColorData {
1195
+ /** The text's background color as a hexadecimal value. */
1196
+ background?: string | null;
1197
+ /** The text's foreground color as a hexadecimal value. */
1198
+ foreground?: string | null;
1199
+ }
1200
+ interface LinkData {
1201
+ /** Link details. */
1202
+ link?: Link;
1203
+ }
1204
+ interface MentionData {
1205
+ /** The mentioned user's name. */
1206
+ name?: string;
1207
+ /** The version of the user's name that appears after the `@` character in the mention. */
1208
+ slug?: string;
1209
+ /** Mentioned user's ID. */
1210
+ id?: string | null;
1211
+ }
1212
+ interface FontSizeData {
1213
+ /** The units used for the font size. */
1214
+ unit?: FontTypeWithLiterals;
1215
+ /** Font size value. */
1216
+ value?: number | null;
1217
+ }
1218
+ declare enum FontType {
1219
+ PX = "PX",
1220
+ EM = "EM"
1221
+ }
1222
+ /** @enumType */
1223
+ type FontTypeWithLiterals = FontType | 'PX' | 'EM';
1224
+ interface SpoilerData {
1225
+ /** Spoiler ID. */
1226
+ id?: string | null;
1227
+ }
1228
+ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1229
+ /** Data for embedded Wix Bookings content. */
1230
+ bookingData?: BookingData;
1231
+ /** Data for embedded Wix Events content. */
1232
+ eventData?: EventData;
1233
+ /** The type of Wix App content being embedded. */
1234
+ type?: AppTypeWithLiterals;
1235
+ /** The ID of the embedded content. */
1236
+ itemId?: string | null;
1237
+ /** The name of the embedded content. */
1238
+ name?: string | null;
1239
+ /**
1240
+ * Deprecated: Use `image` instead.
1241
+ * @deprecated
1242
+ */
1243
+ imageSrc?: string | null;
1244
+ /** The URL for the embedded content. */
1245
+ url?: string | null;
1246
+ /** An image for the embedded content. */
1247
+ image?: Media;
1248
+ /** Whether to hide the image. */
1249
+ hideImage?: boolean | null;
1250
+ /** Whether to hide the title. */
1251
+ hideTitle?: boolean | null;
1252
+ /** Whether to hide the price. */
1253
+ hidePrice?: boolean | null;
1254
+ /** Whether to hide the description (Event and Booking). */
1255
+ hideDescription?: boolean | null;
1256
+ /** Whether to hide the date and time (Event). */
1257
+ hideDateTime?: boolean | null;
1258
+ /** Whether to hide the location (Event). */
1259
+ hideLocation?: boolean | null;
1260
+ /** Whether to hide the duration (Booking). */
1261
+ hideDuration?: boolean | null;
1262
+ /** Whether to hide the button. */
1263
+ hideButton?: boolean | null;
1264
+ /** Whether to hide the ribbon. */
1265
+ hideRibbon?: boolean | null;
1266
+ /** Button styling options. */
1267
+ buttonStyles?: ButtonStyles;
1268
+ /** Image styling options. */
1269
+ imageStyles?: ImageStyles;
1270
+ /** Ribbon styling options. */
1271
+ ribbonStyles?: RibbonStyles;
1272
+ /** Card styling options. */
1273
+ cardStyles?: CardStyles;
1274
+ /** Styling for the app embed's container. */
1275
+ containerData?: PluginContainerData;
1276
+ /** Pricing data for embedded Wix App content. */
1277
+ pricingData?: PricingData;
1278
+ }
1279
+ /** @oneof */
1280
+ interface AppEmbedDataAppDataOneOf {
1281
+ /** Data for embedded Wix Bookings content. */
1282
+ bookingData?: BookingData;
1283
+ /** Data for embedded Wix Events content. */
1284
+ eventData?: EventData;
1285
+ }
1286
+ declare enum Position {
1287
+ /** Image positioned at the start (left in LTR layouts, right in RTL layouts) */
1288
+ START = "START",
1289
+ /** Image positioned at the end (right in LTR layouts, left in RTL layouts) */
1290
+ END = "END",
1291
+ /** Image positioned at the top */
1292
+ TOP = "TOP"
1293
+ }
1294
+ /** @enumType */
1295
+ type PositionWithLiterals = Position | 'START' | 'END' | 'TOP';
1296
+ declare enum AspectRatio {
1297
+ /** 1:1 aspect ratio */
1298
+ SQUARE = "SQUARE",
1299
+ /** 16:9 aspect ratio */
1300
+ RECTANGLE = "RECTANGLE"
1301
+ }
1302
+ /** @enumType */
1303
+ type AspectRatioWithLiterals = AspectRatio | 'SQUARE' | 'RECTANGLE';
1304
+ declare enum Resizing {
1305
+ /** Fill the container, may crop the image */
1306
+ FILL = "FILL",
1307
+ /** Fit the image within the container */
1308
+ FIT = "FIT"
1309
+ }
1310
+ /** @enumType */
1311
+ type ResizingWithLiterals = Resizing | 'FILL' | 'FIT';
1312
+ declare enum Placement {
1313
+ /** Ribbon placed on the image */
1314
+ IMAGE = "IMAGE",
1315
+ /** Ribbon placed on the product information */
1316
+ PRODUCT_INFO = "PRODUCT_INFO"
1317
+ }
1318
+ /** @enumType */
1319
+ type PlacementWithLiterals = Placement | 'IMAGE' | 'PRODUCT_INFO';
1320
+ declare enum Type {
1321
+ /** Card with visible border and background */
1322
+ CONTAINED = "CONTAINED",
1323
+ /** Card without visible border */
1324
+ FRAMELESS = "FRAMELESS"
1325
+ }
1326
+ /** @enumType */
1327
+ type TypeWithLiterals = Type | 'CONTAINED' | 'FRAMELESS';
1328
+ declare enum Alignment {
1329
+ /** Content aligned to start (left in LTR layouts, right in RTL layouts) */
1330
+ START = "START",
1331
+ /** Content centered */
1332
+ CENTER = "CENTER",
1333
+ /** Content aligned to end (right in LTR layouts, left in RTL layouts) */
1334
+ END = "END"
1335
+ }
1336
+ /** @enumType */
1337
+ type AlignmentWithLiterals = Alignment | 'START' | 'CENTER' | 'END';
1338
+ declare enum Layout {
1339
+ /** Elements stacked vertically */
1340
+ STACKED = "STACKED",
1341
+ /** Elements arranged horizontally */
1342
+ SIDE_BY_SIDE = "SIDE_BY_SIDE"
1343
+ }
1344
+ /** @enumType */
1345
+ type LayoutWithLiterals = Layout | 'STACKED' | 'SIDE_BY_SIDE';
1346
+ declare enum AppType {
1347
+ PRODUCT = "PRODUCT",
1348
+ EVENT = "EVENT",
1349
+ BOOKING = "BOOKING"
1350
+ }
1351
+ /** @enumType */
1352
+ type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
1353
+ interface BookingData {
1354
+ /** Booking duration in minutes. */
1355
+ durations?: string | null;
1356
+ }
1357
+ interface EventData {
1358
+ /** Event schedule. */
1359
+ scheduling?: string | null;
1360
+ /** Event location. */
1361
+ location?: string | null;
1362
+ }
1363
+ interface ButtonStyles {
1364
+ /** Text to display on the button. */
1365
+ buttonText?: string | null;
1366
+ /** Border width in pixels. */
1367
+ borderWidth?: number | null;
1368
+ /** Border radius in pixels. */
1369
+ borderRadius?: number | null;
1370
+ /**
1371
+ * Border color as a hexadecimal value.
1372
+ * @format COLOR_HEX
1373
+ */
1374
+ borderColor?: string | null;
1375
+ /**
1376
+ * Text color as a hexadecimal value.
1377
+ * @format COLOR_HEX
1378
+ */
1379
+ textColor?: string | null;
1380
+ /**
1381
+ * Background color as a hexadecimal value.
1382
+ * @format COLOR_HEX
1383
+ */
1384
+ backgroundColor?: string | null;
1385
+ /**
1386
+ * Border color as a hexadecimal value (hover state).
1387
+ * @format COLOR_HEX
1388
+ */
1389
+ borderColorHover?: string | null;
1390
+ /**
1391
+ * Text color as a hexadecimal value (hover state).
1392
+ * @format COLOR_HEX
1393
+ */
1394
+ textColorHover?: string | null;
1395
+ /**
1396
+ * Background color as a hexadecimal value (hover state).
1397
+ * @format COLOR_HEX
1398
+ */
1399
+ backgroundColorHover?: string | null;
1400
+ /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
1401
+ buttonSize?: string | null;
1402
+ }
1403
+ interface ImageStyles {
1404
+ /** Whether to hide the image. */
1405
+ hideImage?: boolean | null;
1406
+ /** Position of image. Defaults to `START`. */
1407
+ imagePosition?: PositionWithLiterals;
1408
+ /** Aspect ratio for the image. Defaults to `SQUARE`. */
1409
+ aspectRatio?: AspectRatioWithLiterals;
1410
+ /** How the image should be resized. Defaults to `FILL`. */
1411
+ resizing?: ResizingWithLiterals;
1412
+ /**
1413
+ * Image border color as a hexadecimal value.
1414
+ * @format COLOR_HEX
1415
+ */
1416
+ borderColor?: string | null;
1417
+ /** Image border width in pixels. */
1418
+ borderWidth?: number | null;
1419
+ /** Image border radius in pixels. */
1420
+ borderRadius?: number | null;
1421
+ }
1422
+ interface RibbonStyles {
1423
+ /** Text to display on the ribbon. */
1424
+ ribbonText?: string | null;
1425
+ /**
1426
+ * Ribbon background color as a hexadecimal value.
1427
+ * @format COLOR_HEX
1428
+ */
1429
+ backgroundColor?: string | null;
1430
+ /**
1431
+ * Ribbon text color as a hexadecimal value.
1432
+ * @format COLOR_HEX
1433
+ */
1434
+ textColor?: string | null;
1435
+ /**
1436
+ * Ribbon border color as a hexadecimal value.
1437
+ * @format COLOR_HEX
1438
+ */
1439
+ borderColor?: string | null;
1440
+ /** Ribbon border width in pixels. */
1441
+ borderWidth?: number | null;
1442
+ /** Ribbon border radius in pixels. */
1443
+ borderRadius?: number | null;
1444
+ /** Placement of the ribbon. Defaults to `IMAGE`. */
1445
+ ribbonPlacement?: PlacementWithLiterals;
1446
+ }
1447
+ interface CardStyles {
1448
+ /**
1449
+ * Card background color as a hexadecimal value.
1450
+ * @format COLOR_HEX
1451
+ */
1452
+ backgroundColor?: string | null;
1453
+ /**
1454
+ * Card border color as a hexadecimal value.
1455
+ * @format COLOR_HEX
1456
+ */
1457
+ borderColor?: string | null;
1458
+ /** Card border width in pixels. */
1459
+ borderWidth?: number | null;
1460
+ /** Card border radius in pixels. */
1461
+ borderRadius?: number | null;
1462
+ /** Card type. Defaults to `CONTAINED`. */
1463
+ type?: TypeWithLiterals;
1464
+ /** Content alignment. Defaults to `START`. */
1465
+ alignment?: AlignmentWithLiterals;
1466
+ /** Layout for title and price. Defaults to `STACKED`. */
1467
+ titlePriceLayout?: LayoutWithLiterals;
1468
+ /**
1469
+ * Title text color as a hexadecimal value.
1470
+ * @format COLOR_HEX
1471
+ */
1472
+ titleColor?: string | null;
1473
+ /**
1474
+ * Text color as a hexadecimal value.
1475
+ * @format COLOR_HEX
1476
+ */
1477
+ textColor?: string | null;
1478
+ }
1479
+ interface PricingData {
1480
+ /**
1481
+ * Minimum numeric price value as string (e.g., "10.99").
1482
+ * @decimalValue options { maxScale:2 }
1483
+ */
1484
+ valueFrom?: string | null;
1485
+ /**
1486
+ * Maximum numeric price value as string (e.g., "19.99").
1487
+ * @decimalValue options { maxScale:2 }
1488
+ */
1489
+ valueTo?: string | null;
1490
+ /**
1491
+ * Numeric price value as string after discount application (e.g., "15.99").
1492
+ * @decimalValue options { maxScale:2 }
1493
+ */
1494
+ discountedValue?: string | null;
1495
+ /**
1496
+ * Currency of the value in ISO 4217 format (e.g., "USD", "EUR").
1497
+ * @format CURRENCY
1498
+ */
1499
+ currency?: string | null;
1500
+ /**
1501
+ * Pricing plan ID.
1502
+ * @format GUID
1503
+ */
1504
+ pricingPlanId?: string | null;
1505
+ }
1506
+ interface VideoData {
1507
+ /** Styling for the video's container. */
1508
+ containerData?: PluginContainerData;
1509
+ /** Video details. */
1510
+ video?: Media;
1511
+ /** Video thumbnail details. */
1512
+ thumbnail?: Media;
1513
+ /** Sets whether the video's download button is disabled. Defaults to `false`. */
1514
+ disableDownload?: boolean | null;
1515
+ /** Video title. */
1516
+ title?: string | null;
1517
+ /** Video options. */
1518
+ options?: PlaybackOptions;
1519
+ }
1520
+ interface PlaybackOptions {
1521
+ /** Sets whether the media will automatically start playing. */
1522
+ autoPlay?: boolean | null;
1523
+ /** Sets whether media's will be looped. */
1524
+ playInLoop?: boolean | null;
1525
+ /** Sets whether media's controls will be shown. */
1526
+ showControls?: boolean | null;
1527
+ }
1528
+ interface EmbedData {
1529
+ /** Styling for the oEmbed node's container. */
1530
+ containerData?: PluginContainerData;
1531
+ /** An [oEmbed](https://www.oembed.com) object. */
1532
+ oembed?: Oembed;
1533
+ /** Origin asset source. */
1534
+ src?: string | null;
1535
+ }
1536
+ interface Oembed {
1537
+ /** The resource type. */
1538
+ type?: string | null;
1539
+ /** The width of the resource specified in the `url` property in pixels. */
1540
+ width?: number | null;
1541
+ /** The height of the resource specified in the `url` property in pixels. */
1542
+ height?: number | null;
1543
+ /** Resource title. */
1544
+ title?: string | null;
1545
+ /** The source URL for the resource. */
1546
+ url?: string | null;
1547
+ /** HTML for embedding a video player. The HTML should have no padding or margins. */
1548
+ html?: string | null;
1549
+ /** The name of the author or owner of the resource. */
1550
+ authorName?: string | null;
1551
+ /** The URL for the author or owner of the resource. */
1552
+ authorUrl?: string | null;
1553
+ /** The name of the resource provider. */
1554
+ providerName?: string | null;
1555
+ /** The URL for the resource provider. */
1556
+ providerUrl?: string | null;
1557
+ /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
1558
+ thumbnailUrl?: string | null;
1559
+ /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
1560
+ thumbnailWidth?: string | null;
1561
+ /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
1562
+ thumbnailHeight?: string | null;
1563
+ /** The URL for an embedded viedo. */
1564
+ videoUrl?: string | null;
1565
+ /** The oEmbed version number. This value must be `1.0`. */
1566
+ version?: string | null;
1567
+ }
1568
+ interface CollapsibleListData {
1569
+ /** Styling for the collapsible list's container. */
1570
+ containerData?: PluginContainerData;
1571
+ /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
1572
+ expandOnlyOne?: boolean | null;
1573
+ /** Sets which items are expanded when the page loads. */
1574
+ initialExpandedItems?: InitialExpandedItemsWithLiterals;
1575
+ /** The direction of the text in the list. Either left-to-right or right-to-left. */
1576
+ direction?: DirectionWithLiterals;
1577
+ /** If `true`, The collapsible item will appear in search results as an FAQ. */
1578
+ isQapageData?: boolean | null;
1579
+ }
1580
+ declare enum InitialExpandedItems {
1581
+ /** First item will be expended initally */
1582
+ FIRST = "FIRST",
1583
+ /** All items will expended initally */
1584
+ ALL = "ALL",
1585
+ /** All items collapsed initally */
1586
+ NONE = "NONE"
1587
+ }
1588
+ /** @enumType */
1589
+ type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
1590
+ declare enum Direction {
1591
+ /** Left-to-right */
1592
+ LTR = "LTR",
1593
+ /** Right-to-left */
1594
+ RTL = "RTL"
1595
+ }
1596
+ /** @enumType */
1597
+ type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
1598
+ interface TableData {
1599
+ /** Styling for the table's container. */
1600
+ containerData?: PluginContainerData;
1601
+ /** The table's dimensions. */
1602
+ dimensions?: Dimensions;
1603
+ /**
1604
+ * Deprecated: Use `rowHeader` and `columnHeader` instead.
1605
+ * @deprecated
1606
+ */
1607
+ header?: boolean | null;
1608
+ /** Sets whether the table's first row is a header. Defaults to `false`. */
1609
+ rowHeader?: boolean | null;
1610
+ /** Sets whether the table's first column is a header. Defaults to `false`. */
1611
+ columnHeader?: boolean | null;
1612
+ }
1613
+ interface Dimensions {
1614
+ /** An array representing relative width of each column in relation to the other columns. */
1615
+ colsWidthRatio?: number[];
1616
+ /** An array representing the height of each row in pixels. */
1617
+ rowsHeight?: number[];
1618
+ /** An array representing the minimum width of each column in pixels. */
1619
+ colsMinWidth?: number[];
1620
+ }
1621
+ interface TableCellData {
1622
+ /** Styling for the cell's background color and text alignment. */
1623
+ cellStyle?: CellStyle;
1624
+ /** The cell's border colors. */
1625
+ borderColors?: BorderColors;
1626
+ }
1627
+ declare enum VerticalAlignment {
1628
+ /** Top alignment */
1629
+ TOP = "TOP",
1630
+ /** Middle alignment */
1631
+ MIDDLE = "MIDDLE",
1632
+ /** Bottom alignment */
1633
+ BOTTOM = "BOTTOM"
1634
+ }
1635
+ /** @enumType */
1636
+ type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
1637
+ interface CellStyle {
1638
+ /** Vertical alignment for the cell's text. */
1639
+ verticalAlignment?: VerticalAlignmentWithLiterals;
1640
+ /**
1641
+ * Cell background color as a hexadecimal value.
1642
+ * @format COLOR_HEX
1643
+ */
1644
+ backgroundColor?: string | null;
1645
+ }
1646
+ interface BorderColors {
1647
+ /**
1648
+ * Left border color as a hexadecimal value.
1649
+ * @format COLOR_HEX
1650
+ */
1651
+ left?: string | null;
1652
+ /**
1653
+ * Right border color as a hexadecimal value.
1654
+ * @format COLOR_HEX
1655
+ */
1656
+ right?: string | null;
1657
+ /**
1658
+ * Top border color as a hexadecimal value.
1659
+ * @format COLOR_HEX
1660
+ */
1661
+ top?: string | null;
1662
+ /**
1663
+ * Bottom border color as a hexadecimal value.
1664
+ * @format COLOR_HEX
1665
+ */
1666
+ bottom?: string | null;
1667
+ }
1668
+ /**
1669
+ * `NullValue` is a singleton enumeration to represent the null value for the
1670
+ * `Value` type union.
1671
+ *
1672
+ * The JSON representation for `NullValue` is JSON `null`.
1673
+ */
1674
+ declare enum NullValue {
1675
+ /** Null value. */
1676
+ NULL_VALUE = "NULL_VALUE"
1677
+ }
1678
+ /** @enumType */
1679
+ type NullValueWithLiterals = NullValue | 'NULL_VALUE';
1680
+ /**
1681
+ * `ListValue` is a wrapper around a repeated field of values.
1682
+ *
1683
+ * The JSON representation for `ListValue` is JSON array.
1684
+ */
1685
+ interface ListValue {
1686
+ /** Repeated field of dynamically typed values. */
1687
+ values?: any[];
1688
+ }
1689
+ interface AudioData {
1690
+ /** Styling for the audio node's container. */
1691
+ containerData?: PluginContainerData;
1692
+ /** Audio file details. */
1693
+ audio?: Media;
1694
+ /** Sets whether the audio node's download button is disabled. Defaults to `false`. */
1695
+ disableDownload?: boolean | null;
1696
+ /** Cover image. */
1697
+ coverImage?: Media;
1698
+ /** Track name. */
1699
+ name?: string | null;
1700
+ /** Author name. */
1701
+ authorName?: string | null;
1702
+ /** An HTML version of the audio node. */
1703
+ html?: string | null;
1704
+ }
1705
+ interface OrderedListData {
1706
+ /** Indentation level from 0-4. */
1707
+ indentation?: number;
1708
+ /** Offset level from 0-4. */
1709
+ offset?: number | null;
1710
+ /** List start number. */
1711
+ start?: number | null;
1712
+ }
1713
+ interface BulletedListData {
1714
+ /** Indentation level from 0-4. */
1715
+ indentation?: number;
1716
+ /** Offset level from 0-4. */
1717
+ offset?: number | null;
1718
+ }
1719
+ interface BlockquoteData {
1720
+ /** Indentation level from 1-4. */
1721
+ indentation?: number;
1722
+ }
1723
+ interface CaptionData {
1724
+ textStyle?: TextStyle;
1725
+ }
1726
+ interface LayoutData {
1727
+ /**
1728
+ * Background color as a hexadecimal value.
1729
+ * @format COLOR_HEX
1730
+ */
1731
+ backgroundColor?: string | null;
1732
+ /** Background image. */
1733
+ backgroundImage?: BackgroundImage;
1734
+ /**
1735
+ * Border color as a hexadecimal value.
1736
+ * @format COLOR_HEX
1737
+ */
1738
+ borderColor?: string | null;
1739
+ /** Border width in pixels. */
1740
+ borderWidth?: number | null;
1741
+ /** Border */
1742
+ borderRadius?: number | null;
1743
+ /**
1744
+ * Backdrop color as a hexadecimal value.
1745
+ * @format COLOR_HEX
1746
+ */
1747
+ backdropColor?: string | null;
1748
+ /** Backdrop image.radius in pixels. */
1749
+ backdropImage?: BackgroundImage;
1750
+ /** Backdrop top padding. */
1751
+ backdropPaddingTop?: number | null;
1752
+ /** Backdrop bottom padding */
1753
+ backdropPaddingBottom?: number | null;
1754
+ /** Horizontal and vertical gap between columns */
1755
+ gap?: number | null;
1756
+ /**
1757
+ * Padding in pixels for cells. Follows CSS order: top, right, bottom, left
1758
+ * @maxSize 4
1759
+ */
1760
+ cellPadding?: number[];
1761
+ /** Vertical alignment for the cell's items. */
1762
+ cellVerticalAlignment?: VerticalAlignmentAlignmentWithLiterals;
1763
+ /** Responsiveness behaviour of columns when responsiveness applies. Either stacks or wrappers. */
1764
+ responsivenessBehaviour?: ResponsivenessBehaviourWithLiterals;
1765
+ /** Size in pixels when responsiveness_behaviour applies */
1766
+ responsivenessBreakpoint?: number | null;
1767
+ }
1768
+ declare enum Scaling {
1769
+ /** Auto image scaling */
1770
+ AUTO = "AUTO",
1771
+ /** Contain image scaling */
1772
+ CONTAIN = "CONTAIN",
1773
+ /** Cover image scaling */
1774
+ COVER = "COVER"
1775
+ }
1776
+ /** @enumType */
1777
+ type ScalingWithLiterals = Scaling | 'AUTO' | 'CONTAIN' | 'COVER';
1778
+ declare enum ImagePosition {
1779
+ /** Image positioned at the center */
1780
+ CENTER = "CENTER",
1781
+ /** Image positioned on the left */
1782
+ CENTER_LEFT = "CENTER_LEFT",
1783
+ /** Image positioned on the right */
1784
+ CENTER_RIGHT = "CENTER_RIGHT",
1785
+ /** Image positioned at the center top */
1786
+ TOP = "TOP",
1787
+ /** Image positioned at the top left */
1788
+ TOP_LEFT = "TOP_LEFT",
1789
+ /** Image positioned at the top right */
1790
+ TOP_RIGHT = "TOP_RIGHT",
1791
+ /** Image positioned at the center bottom */
1792
+ BOTTOM = "BOTTOM",
1793
+ /** Image positioned at the bottom left */
1794
+ BOTTOM_LEFT = "BOTTOM_LEFT",
1795
+ /** Image positioned at the bottom right */
1796
+ BOTTOM_RIGHT = "BOTTOM_RIGHT"
1797
+ }
1798
+ /** @enumType */
1799
+ type ImagePositionWithLiterals = ImagePosition | 'CENTER' | 'CENTER_LEFT' | 'CENTER_RIGHT' | 'TOP' | 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT';
1800
+ interface BackgroundImage {
1801
+ /** Background image. */
1802
+ media?: Media;
1803
+ /** Background image opacity. */
1804
+ opacity?: number | null;
1805
+ /** Background image scaling. */
1806
+ scaling?: ScalingWithLiterals;
1807
+ /** Position of background. Defaults to `CENTER`. */
1808
+ position?: ImagePositionWithLiterals;
1809
+ }
1810
+ declare enum VerticalAlignmentAlignment {
1811
+ /** Top alignment */
1812
+ TOP = "TOP",
1813
+ /** Middle alignment */
1814
+ MIDDLE = "MIDDLE",
1815
+ /** Bottom alignment */
1816
+ BOTTOM = "BOTTOM"
1817
+ }
1818
+ /** @enumType */
1819
+ type VerticalAlignmentAlignmentWithLiterals = VerticalAlignmentAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
1820
+ declare enum ResponsivenessBehaviour {
1821
+ /** Stacking of columns */
1822
+ STACK = "STACK",
1823
+ /** Wrapping of columns */
1824
+ WRAP = "WRAP"
1825
+ }
1826
+ /** @enumType */
1827
+ type ResponsivenessBehaviourWithLiterals = ResponsivenessBehaviour | 'STACK' | 'WRAP';
1828
+ interface LayoutCellData {
1829
+ /** Size of the cell in 12 columns grid. */
1830
+ colSpan?: number | null;
1831
+ }
1832
+ interface Metadata {
1833
+ /** Schema version. */
1834
+ version?: number;
1835
+ /**
1836
+ * When the object was created.
1837
+ * @readonly
1838
+ * @deprecated
1839
+ */
1840
+ createdTimestamp?: Date | null;
1841
+ /**
1842
+ * When the object was most recently updated.
1843
+ * @deprecated
1844
+ */
1845
+ updatedTimestamp?: Date | null;
1846
+ /** Object ID. */
1847
+ _id?: string | null;
1848
+ }
1849
+ interface DocumentStyle {
1850
+ /** Styling for H1 nodes. */
1851
+ headerOne?: TextNodeStyle;
1852
+ /** Styling for H2 nodes. */
1853
+ headerTwo?: TextNodeStyle;
1854
+ /** Styling for H3 nodes. */
1855
+ headerThree?: TextNodeStyle;
1856
+ /** Styling for H4 nodes. */
1857
+ headerFour?: TextNodeStyle;
1858
+ /** Styling for H5 nodes. */
1859
+ headerFive?: TextNodeStyle;
1860
+ /** Styling for H6 nodes. */
1861
+ headerSix?: TextNodeStyle;
1862
+ /** Styling for paragraph nodes. */
1863
+ paragraph?: TextNodeStyle;
1864
+ /** Styling for block quote nodes. */
1865
+ blockquote?: TextNodeStyle;
1866
+ /** Styling for code block nodes. */
1867
+ codeBlock?: TextNodeStyle;
1868
+ }
1869
+ interface TextNodeStyle {
1870
+ /** The decorations to apply to the node. */
1871
+ decorations?: Decoration[];
1872
+ /** Padding and background color for the node. */
1873
+ nodeStyle?: NodeStyle;
1874
+ /** Line height for text in the node. */
1875
+ lineHeight?: string | null;
1876
+ }
1877
+ interface File {
1878
+ /**
1879
+ * File name
1880
+ * @maxLength 100
1881
+ */
1882
+ fileName?: string;
1883
+ /**
1884
+ * File id. Must be uploaded file to media manager. Read more - https://dev.wix.com/docs/api-reference/assets/media/media-manager/introduction
1885
+ * @maxLength 2048
1886
+ */
1887
+ fileId?: string;
1888
+ }
1889
+ interface PromptConfiguration {
1890
+ /**
1891
+ * System prompt
1892
+ * @maxLength 100000
1893
+ */
1894
+ system?: string;
1895
+ /**
1896
+ * Initial user message template
1897
+ * @maxLength 100000
1898
+ */
1899
+ initialUserMessageTemplate?: string;
1900
+ /**
1901
+ * Ai Model
1902
+ * @maxLength 100
1903
+ */
1904
+ model?: string;
1905
+ /**
1906
+ * Temperature
1907
+ * @max 1
1908
+ */
1909
+ temperature?: number | null;
1910
+ /**
1911
+ * Top k
1912
+ * @max 100
1913
+ */
1914
+ topK?: number | null;
1915
+ /**
1916
+ * Top p
1917
+ * @max 1
1918
+ */
1919
+ topP?: number | null;
1920
+ }
1921
+ /** Request message for prompting the AI assistant with streaming response delivery */
1922
+ interface CreateConversationStreamedRequest {
1923
+ /**
1924
+ * The conversation context including the current document state and message history.
1925
+ * Same as the non-streamed version, but the response will be delivered incrementally
1926
+ * through multiple response chunks rather than a single complete response.
1927
+ */
1928
+ ricosConversation?: RicosConversation;
1929
+ /**
1930
+ * Flag to control whether this conversation should be persisted for future continuation.
1931
+ * When true, the conversation will be stored and can be continued using the continue endpoint.
1932
+ * When false, the conversation will not be persisted .
1933
+ */
1934
+ persist?: boolean;
1935
+ /**
1936
+ * Invocation id
1937
+ * @format GUID
1938
+ */
1939
+ invocationId?: string | null;
1940
+ }
1941
+ /** Streaming response message containing individual chunks of the AI's response */
1942
+ interface ConversationResponse {
1943
+ /** A single chunk of the AI's response stream. */
1944
+ chunk?: RicosConversationChunk;
1945
+ /**
1946
+ * Unique identifier for this conversation session.
1947
+ * @format GUID
1948
+ */
1949
+ conversationId?: string | null;
1950
+ }
1951
+ /**
1952
+ * Represents a single chunk in a Ricos AI conversation flow
1953
+ * Used for streaming responses where the AI assistant delivers content incrementally
1954
+ */
1955
+ interface RicosConversationChunk extends RicosConversationChunkTypeDataOneOf {
1956
+ /** Options for explanation chunks that provide textual context */
1957
+ explainOptions?: ExplainOption;
1958
+ /** Options for insertion chunks that specify where content should be added */
1959
+ insertOptions?: InsertOptions;
1960
+ /** Options for replacement chunks that specify content range to replace */
1961
+ replaceOptions?: ReplaceOptions;
1962
+ /** Options for node chunks that contain rich content nodes */
1963
+ nodeOptions?: NodeOptions;
1964
+ /** Options for node text chunks that contain text with decorations */
1965
+ nodeTextOptions?: NodeTextOptions;
1966
+ /** Options to notify about existing tool use */
1967
+ toolUseOptions?: ToolUseOptions;
1968
+ /** Patch options */
1969
+ patchOptions?: PatchOptions;
1970
+ /** Progress options */
1971
+ progressOptions?: ProgressOptions;
1972
+ /** Summary options */
1973
+ summaryOptions?: SummaryOptions;
1974
+ /** Suggestion options */
1975
+ suggestionOptions?: SuggestionOptions;
1976
+ /** The type of chunk that determines its behavior and purpose */
1977
+ type?: ChunkTypeWithLiterals;
1978
+ }
1979
+ /** @oneof */
1980
+ interface RicosConversationChunkTypeDataOneOf {
1981
+ /** Options for explanation chunks that provide textual context */
1982
+ explainOptions?: ExplainOption;
1983
+ /** Options for insertion chunks that specify where content should be added */
1984
+ insertOptions?: InsertOptions;
1985
+ /** Options for replacement chunks that specify content range to replace */
1986
+ replaceOptions?: ReplaceOptions;
1987
+ /** Options for node chunks that contain rich content nodes */
1988
+ nodeOptions?: NodeOptions;
1989
+ /** Options for node text chunks that contain text with decorations */
1990
+ nodeTextOptions?: NodeTextOptions;
1991
+ /** Options to notify about existing tool use */
1992
+ toolUseOptions?: ToolUseOptions;
1993
+ /** Patch options */
1994
+ patchOptions?: PatchOptions;
1995
+ /** Progress options */
1996
+ progressOptions?: ProgressOptions;
1997
+ /** Summary options */
1998
+ summaryOptions?: SummaryOptions;
1999
+ /** Suggestion options */
2000
+ suggestionOptions?: SuggestionOptions;
2001
+ }
2002
+ /** Defines the type of operation this chunk represents in the conversation flow */
2003
+ declare enum ChunkType {
2004
+ /** Unspecified chunk type */
2005
+ CHUNK_TYPE_UNKNOWN = "CHUNK_TYPE_UNKNOWN",
2006
+ /** Explanation chunk containing descriptive text about changes being made */
2007
+ EXPLAIN = "EXPLAIN",
2008
+ /** Insert operation chunk that adds content after a specified reference point */
2009
+ INSERT = "INSERT",
2010
+ /** Replace operation chunk that substitutes content within a specified range */
2011
+ REPLACE = "REPLACE",
2012
+ /** Node chunk that represents a rich content node (images, headings, etc.) */
2013
+ NODE = "NODE",
2014
+ /** Node text chunk that represents text content within a node with optional decorations */
2015
+ NODE_TEXT = "NODE_TEXT",
2016
+ /** Marker indicating the end of an insert operation range */
2017
+ INSERT_END = "INSERT_END",
2018
+ /** Marker indicating the end of a replace operation range */
2019
+ REPLACE_END = "REPLACE_END",
2020
+ /** Tool use notification chunk indicating that a tool has been used */
2021
+ TOOL_USE = "TOOL_USE",
2022
+ /** Patch chunk type */
2023
+ PATCH = "PATCH",
2024
+ /** Progress chunk type */
2025
+ PROGRESS = "PROGRESS",
2026
+ /** Summary chunk type */
2027
+ SUMMARY = "SUMMARY",
2028
+ /** Suggestion chunk type */
2029
+ SUGGESTION = "SUGGESTION"
2030
+ }
2031
+ /** @enumType */
2032
+ type ChunkTypeWithLiterals = ChunkType | 'CHUNK_TYPE_UNKNOWN' | 'EXPLAIN' | 'INSERT' | 'REPLACE' | 'NODE' | 'NODE_TEXT' | 'INSERT_END' | 'REPLACE_END' | 'TOOL_USE' | 'PATCH' | 'PROGRESS' | 'SUMMARY' | 'SUGGESTION';
2033
+ /** Options for explanation chunks that provide context about AI operations */
2034
+ interface ExplainOption {
2035
+ /**
2036
+ * The explanatory text content describing what changes are being made
2037
+ * @maxLength 100000
2038
+ */
2039
+ text?: string;
2040
+ }
2041
+ /** Options for insert operation chunks that specify insertion behavior */
2042
+ interface InsertOptions {
2043
+ /**
2044
+ * The ID of the chunk after which new content will be inserted
2045
+ * @maxLength 100
2046
+ */
2047
+ after?: string;
2048
+ }
2049
+ /** Options for replace operation chunks that specify replacement range */
2050
+ interface ReplaceOptions {
2051
+ /**
2052
+ * The starting chunk ID of the range to be replaced (inclusive)
2053
+ * @maxLength 100
2054
+ */
2055
+ from?: string;
2056
+ /**
2057
+ * The ending chunk ID of the range to be replaced (inclusive)
2058
+ * @maxLength 100
2059
+ */
2060
+ to?: string;
2061
+ }
2062
+ /** Options for node chunks that contain rich content elements */
2063
+ interface NodeOptions {
2064
+ /**
2065
+ * The parent node ID for hierarchical content structure (null for root level)
2066
+ * @maxLength 100
2067
+ */
2068
+ parent?: string | null;
2069
+ /** The rich content node to be inserted or manipulated (images, headings, paragraphs, etc.) */
2070
+ node?: Node;
2071
+ /** Indication that node is still loading and should treated as such */
2072
+ pending?: boolean;
2073
+ }
2074
+ /** Options for node text chunks that contain formatted text content */
2075
+ interface NodeTextOptions {
2076
+ /**
2077
+ * The parent node ID to which this text content belongs
2078
+ * @maxLength 100
2079
+ */
2080
+ parent?: string;
2081
+ /**
2082
+ * The plain text content to be added to the node
2083
+ * @maxLength 100000
2084
+ */
2085
+ text?: string;
2086
+ /**
2087
+ * Text decorations applied to this content (bold, italic, links, etc.)
2088
+ * @maxSize 15
2089
+ */
2090
+ decorations?: Decoration[];
2091
+ }
2092
+ interface ToolUseOptions {
2093
+ /**
2094
+ * The name of the tool that was used in the conversation
2095
+ * @maxLength 100
2096
+ */
2097
+ toolName?: string;
2098
+ /** The parameters used when invoking the tool */
2099
+ parameters?: Record<string, any> | null;
2100
+ }
2101
+ interface DebugOptions {
2102
+ /**
2103
+ * Raw text received from LLM
2104
+ * @maxLength 100
2105
+ */
2106
+ text?: string;
2107
+ }
2108
+ interface MetadataOptions {
2109
+ microcentsSpent?: string | null;
2110
+ inputTokens?: number | null;
2111
+ outputTokens?: number | null;
2112
+ cacheCreationInputTokens?: number | null;
2113
+ cacheReadInputTokens?: number | null;
2114
+ }
2115
+ interface PatchOptions {
2116
+ /** The rich content node to be patched. Most likely this node was in the pending state */
2117
+ node?: Node;
2118
+ }
2119
+ interface ProgressOptions {
2120
+ /**
2121
+ * The text content describing current progress or ongoing work
2122
+ * @maxLength 100000
2123
+ */
2124
+ text?: string;
2125
+ }
2126
+ interface SummaryOptions {
2127
+ /**
2128
+ * The text content providing a summary of completed work or results
2129
+ * @maxLength 100000
2130
+ */
2131
+ text?: string;
2132
+ }
2133
+ interface SuggestionOptions {
2134
+ /**
2135
+ * The starting node ID of the region for suggestion (inclusive, optional if no specific region)
2136
+ * @maxLength 100
2137
+ */
2138
+ from?: string | null;
2139
+ /**
2140
+ * The ending node ID of the region for suggestion (inclusive, optional if no specific region)
2141
+ * @maxLength 100
2142
+ */
2143
+ to?: string | null;
2144
+ /** The type of action to perform: either replace existing content or insert new content */
2145
+ action?: SuggestionActionWithLiterals;
2146
+ /**
2147
+ * Specific, actionable prompt describing the improvement to be made
2148
+ * @maxLength 1000
2149
+ */
2150
+ prompt?: string;
2151
+ /**
2152
+ * Brief summary of the prompt in a few words
2153
+ * @maxLength 200
2154
+ */
2155
+ summary?: string;
2156
+ }
2157
+ /** Defines the type of suggestion action */
2158
+ declare enum SuggestionAction {
2159
+ /** Unspecified action type */
2160
+ SUGGESTION_ACTION_UNKNOWN = "SUGGESTION_ACTION_UNKNOWN",
2161
+ /** Replace the content in the specified range */
2162
+ REPLACE = "REPLACE",
2163
+ /** Insert new content after the specified range */
2164
+ INSERT = "INSERT"
2165
+ }
2166
+ /** @enumType */
2167
+ type SuggestionActionWithLiterals = SuggestionAction | 'SUGGESTION_ACTION_UNKNOWN' | 'REPLACE' | 'INSERT';
2168
+ /** Request message for continuing an existing conversation with streaming response delivery */
2169
+ interface ContinueConversationStreamedRequest {
2170
+ /** The conversation context including the current document state and message history. */
2171
+ ricosConversation?: RicosConversation;
2172
+ }
2173
+ /** Request message for creating a new conversation with non-streamed response */
2174
+ interface CreateRicosConversationRequest {
2175
+ /** The conversation context including the current document state and message history */
2176
+ ricosConversation?: RicosConversation;
2177
+ /**
2178
+ * Flag to control whether this conversation should be persisted for future continuation
2179
+ * When true, the conversation will be stored and can be continued using the continue endpoint
2180
+ * When false, the conversation will not be persisted
2181
+ */
2182
+ persist?: boolean;
2183
+ /**
2184
+ * Invocation id
2185
+ * @format GUID
2186
+ */
2187
+ invocationId?: string | null;
2188
+ }
2189
+ /** Response message containing complete RichContent and metadata */
2190
+ interface CreateRicosConversationResponse {
2191
+ /** The complete assembled RichContent from all buffered chunks */
2192
+ richContent?: RichContent;
2193
+ /**
2194
+ * Unique identifier for this conversation session
2195
+ * @format GUID
2196
+ */
2197
+ conversationId?: string | null;
2198
+ /** List of explain entries produced during processing */
2199
+ explain?: ExplainOption[];
2200
+ /** List of summary entries produced during processing */
2201
+ summary?: SummaryOptions[];
2202
+ /** OList of tool use notifications produced during processing */
2203
+ toolUse?: ToolUseOptions[];
2204
+ /** OList of metadata entries (included only when requested) */
2205
+ metadata?: MetadataOptions[];
2206
+ /** OList of progress entries produced during processing */
2207
+ progress?: ProgressOptions[];
2208
+ /** List of suggestion entries produced during processing */
2209
+ suggestions?: SuggestionOptions[];
2210
+ }
2211
+ /** Request message for listing RichContent document suggestions */
2212
+ interface ListConversationSuggestionsRequest {
2213
+ /** The RichContent document, for which the suggestions should be retrieved */
2214
+ richContent: RichContent;
2215
+ /**
2216
+ * Existing suggestions
2217
+ * @maxSize 100
2218
+ */
2219
+ suggestions?: Suggestion[];
2220
+ }
2221
+ /** Suggestion structure */
2222
+ interface Suggestion extends SuggestionPositionDetailsOneOf {
2223
+ /** Details for the range of the suggestion */
2224
+ rangeDetails?: RangeDetails;
2225
+ /** Indication, what action is suggested */
2226
+ action?: ActionWithLiterals;
2227
+ /**
2228
+ * The suggested prompt, to complete the suggestions
2229
+ * @maxLength 3000
2230
+ */
2231
+ prompt?: string | null;
2232
+ /**
2233
+ * The summary of the suggestion
2234
+ * @maxLength 3000
2235
+ */
2236
+ summary?: string | null;
2237
+ /** Position description to what part of the document does the suggestion apply */
2238
+ position?: PositionsPositionWithLiterals;
2239
+ }
2240
+ /** @oneof */
2241
+ interface SuggestionPositionDetailsOneOf {
2242
+ /** Details for the range of the suggestion */
2243
+ rangeDetails?: RangeDetails;
2244
+ }
2245
+ declare enum Action {
2246
+ /** Unspecified action type */
2247
+ UNKNOWN_ACTION = "UNKNOWN_ACTION",
2248
+ /** Insert suggestions that adds content after a specified reference point */
2249
+ INSERT = "INSERT",
2250
+ /** Replace suggestion that substitutes content within a specific suggestion */
2251
+ REPLACE = "REPLACE"
2252
+ }
2253
+ /** @enumType */
2254
+ type ActionWithLiterals = Action | 'UNKNOWN_ACTION' | 'INSERT' | 'REPLACE';
2255
+ declare enum PositionsPosition {
2256
+ /** Unspecified position. */
2257
+ UNKNOWN_POSITION = "UNKNOWN_POSITION",
2258
+ /** Suggestion applies to an specific range between two points. */
2259
+ RANGE = "RANGE"
2260
+ }
2261
+ /** @enumType */
2262
+ type PositionsPositionWithLiterals = PositionsPosition | 'UNKNOWN_POSITION' | 'RANGE';
2263
+ /** Define specific range from beginning and the end */
2264
+ interface RangeDetails {
2265
+ /**
2266
+ * Point from where the suggestion begins
2267
+ * @maxLength 100
2268
+ */
2269
+ fromNodeId?: string | null;
2270
+ /**
2271
+ * Point to where the suggestions ends
2272
+ * @maxLength 100
2273
+ */
2274
+ toNodeId?: string | null;
2275
+ }
2276
+ /** Response message containing suggestions fro the provided RichContent document */
2277
+ interface ListConversationSuggestionsResponse {
2278
+ /**
2279
+ * List of suggestions for the document
2280
+ * @maxSize 100
2281
+ */
2282
+ suggestions?: Suggestion[];
2283
+ }
2284
+ interface DomainEvent extends DomainEventBodyOneOf {
2285
+ createdEvent?: EntityCreatedEvent;
2286
+ updatedEvent?: EntityUpdatedEvent;
2287
+ deletedEvent?: EntityDeletedEvent;
2288
+ actionEvent?: ActionEvent;
2289
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2290
+ _id?: string;
2291
+ /**
2292
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2293
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2294
+ */
2295
+ entityFqdn?: string;
2296
+ /**
2297
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
2298
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2299
+ */
2300
+ slug?: string;
2301
+ /** ID of the entity associated with the event. */
2302
+ entityId?: string;
2303
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2304
+ eventTime?: Date | null;
2305
+ /**
2306
+ * Whether the event was triggered as a result of a privacy regulation application
2307
+ * (for example, GDPR).
2308
+ */
2309
+ triggeredByAnonymizeRequest?: boolean | null;
2310
+ /** If present, indicates the action that triggered the event. */
2311
+ originatedFrom?: string | null;
2312
+ /**
2313
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
2314
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
2315
+ */
2316
+ entityEventSequence?: string | null;
2317
+ }
2318
+ /** @oneof */
2319
+ interface DomainEventBodyOneOf {
2320
+ createdEvent?: EntityCreatedEvent;
2321
+ updatedEvent?: EntityUpdatedEvent;
2322
+ deletedEvent?: EntityDeletedEvent;
2323
+ actionEvent?: ActionEvent;
2324
+ }
2325
+ interface EntityCreatedEvent {
2326
+ entity?: string;
2327
+ }
2328
+ interface RestoreInfo {
2329
+ deletedDate?: Date | null;
2330
+ }
2331
+ interface EntityUpdatedEvent {
2332
+ /**
2333
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2334
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2335
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2336
+ */
2337
+ currentEntity?: string;
2338
+ }
2339
+ interface EntityDeletedEvent {
2340
+ /** Entity that was deleted. */
2341
+ deletedEntity?: string | null;
2342
+ }
2343
+ interface ActionEvent {
2344
+ body?: string;
2345
+ }
2346
+ interface MessageEnvelope {
2347
+ /**
2348
+ * App instance ID.
2349
+ * @format GUID
2350
+ */
2351
+ instanceId?: string | null;
2352
+ /**
2353
+ * Event type.
2354
+ * @maxLength 150
2355
+ */
2356
+ eventType?: string;
2357
+ /** The identification type and identity data. */
2358
+ identity?: IdentificationData;
2359
+ /** Stringify payload. */
2360
+ data?: string;
2361
+ }
2362
+ interface IdentificationData extends IdentificationDataIdOneOf {
2363
+ /**
2364
+ * ID of a site visitor that has not logged in to the site.
2365
+ * @format GUID
2366
+ */
2367
+ anonymousVisitorId?: string;
2368
+ /**
2369
+ * ID of a site visitor that has logged in to the site.
2370
+ * @format GUID
2371
+ */
2372
+ memberId?: string;
2373
+ /**
2374
+ * ID of a Wix user (site owner, contributor, etc.).
2375
+ * @format GUID
2376
+ */
2377
+ wixUserId?: string;
2378
+ /**
2379
+ * ID of an app.
2380
+ * @format GUID
2381
+ */
2382
+ appId?: string;
2383
+ /** @readonly */
2384
+ identityType?: WebhookIdentityTypeWithLiterals;
2385
+ }
2386
+ /** @oneof */
2387
+ interface IdentificationDataIdOneOf {
2388
+ /**
2389
+ * ID of a site visitor that has not logged in to the site.
2390
+ * @format GUID
2391
+ */
2392
+ anonymousVisitorId?: string;
2393
+ /**
2394
+ * ID of a site visitor that has logged in to the site.
2395
+ * @format GUID
2396
+ */
2397
+ memberId?: string;
2398
+ /**
2399
+ * ID of a Wix user (site owner, contributor, etc.).
2400
+ * @format GUID
2401
+ */
2402
+ wixUserId?: string;
2403
+ /**
2404
+ * ID of an app.
2405
+ * @format GUID
2406
+ */
2407
+ appId?: string;
2408
+ }
2409
+ declare enum WebhookIdentityType {
2410
+ UNKNOWN = "UNKNOWN",
2411
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2412
+ MEMBER = "MEMBER",
2413
+ WIX_USER = "WIX_USER",
2414
+ APP = "APP"
2415
+ }
2416
+ /** @enumType */
2417
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2418
+ interface CreateConversationStreamedOptions {
2419
+ /**
2420
+ * The conversation context including the current document state and message history.
2421
+ * Same as the non-streamed version, but the response will be delivered incrementally
2422
+ * through multiple response chunks rather than a single complete response.
2423
+ */
2424
+ ricosConversation?: RicosConversation;
2425
+ /**
2426
+ * Flag to control whether this conversation should be persisted for future continuation.
2427
+ * When true, the conversation will be stored and can be continued using the continue endpoint.
2428
+ * When false, the conversation will not be persisted .
2429
+ */
2430
+ persist?: boolean;
2431
+ /**
2432
+ * Invocation id
2433
+ * @format GUID
2434
+ */
2435
+ invocationId?: string | null;
2436
+ }
2437
+ interface ContinueConversationStreamedOptions {
2438
+ /** The conversation context including the current document state and message history. */
2439
+ ricosConversation?: RicosConversation;
2440
+ }
2441
+ interface CreateRicosConversationOptions {
2442
+ /** The conversation context including the current document state and message history */
2443
+ ricosConversation?: RicosConversation;
2444
+ /**
2445
+ * Flag to control whether this conversation should be persisted for future continuation
2446
+ * When true, the conversation will be stored and can be continued using the continue endpoint
2447
+ * When false, the conversation will not be persisted
2448
+ */
2449
+ persist?: boolean;
2450
+ /**
2451
+ * Invocation id
2452
+ * @format GUID
2453
+ */
2454
+ invocationId?: string | null;
2455
+ }
2456
+ interface ListConversationSuggestionsOptions {
2457
+ /**
2458
+ * Existing suggestions
2459
+ * @maxSize 100
2460
+ */
2461
+ suggestions?: Suggestion[];
2462
+ }
2463
+
2464
+ export { Action, type ActionEvent, type ActionWithLiterals, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type BlockquoteData, type BookingData, type Border, type BorderColors, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardStyles, type CellStyle, ChunkType, type ChunkTypeWithLiterals, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type ContinueConversationStreamedOptions, type ContinueConversationStreamedRequest, type ConversationResponse, type CreateConversationStreamedOptions, type CreateConversationStreamedRequest, type CreateRicosConversationOptions, type CreateRicosConversationRequest, type CreateRicosConversationResponse, Crop, type CropWithLiterals, type DebugOptions, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type Design, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type ExplainOption, type File, type FileData, type FileSource, type FileSourceDataOneOf, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type Gradient, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, ImagePosition, type ImagePositionWithLiterals, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InsertOptions, type Item, type ItemDataOneOf, type ItemStyle, Layout, type LayoutCellData, type LayoutData, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListConversationSuggestionsOptions, type ListConversationSuggestionsRequest, type ListConversationSuggestionsResponse, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MentionData, type MessageEnvelope, type Metadata, type MetadataOptions, type Node, type NodeDataOneOf, type NodeOptions, type NodeStyle, type NodeTextOptions, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, type OrderedListData, Orientation, type OrientationWithLiterals, type PDFSettings, type ParagraphData, type PatchOptions, type Permissions, Placement, type PlacementWithLiterals, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, Position, type PositionWithLiterals, PositionsPosition, type PositionsPositionWithLiterals, type PricingData, type ProgressOptions, type PromptConfiguration, type RangeDetails, type Rel, type ReplaceOptions, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, type RicosConversation, type RicosConversationChunk, type RicosConversationChunkTypeDataOneOf, type RicosConversationUserMessageOneOf, Scaling, type ScalingWithLiterals, type Settings, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type Suggestion, SuggestionAction, type SuggestionActionWithLiterals, type SuggestionOptions, type SuggestionPositionDetailsOneOf, type SummaryOptions, type TableCellData, type TableData, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type ToolUseOptions, Type, type TypeWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, ViewMode, type ViewModeWithLiterals, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals };