@wix/categories 1.0.37 → 1.0.38

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.
@@ -0,0 +1,4070 @@
1
+ /**
2
+ * A Category is the main entity of CategoriesService that can be created, customized and managed by the user.
3
+ * Category can be organized into a hierarchical tree structure by assigning a parent category.
4
+ * This structure can then be used to group similar items in order to make it easier for clients to find them.
5
+ */
6
+ interface Category {
7
+ /** Category ID. */
8
+ _id?: string | null;
9
+ /**
10
+ * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision
11
+ * @readonly
12
+ */
13
+ revision?: string | null;
14
+ /**
15
+ * Represents the time this Category was created.
16
+ * @readonly
17
+ */
18
+ _createdDate?: Date;
19
+ /**
20
+ * Represents the time this Category was last updated.
21
+ * @readonly
22
+ */
23
+ _updatedDate?: Date;
24
+ /** Category name. */
25
+ name?: string | null;
26
+ /**
27
+ * Category image.
28
+ * Pass existing media ID for image previously saved in Wix media manager.
29
+ * Pass full image URL to upload an image to Wix media manager.
30
+ * In case of full url the image will be updated eventually.
31
+ */
32
+ image?: string;
33
+ /**
34
+ * Number of items in this category alone.
35
+ * @readonly
36
+ */
37
+ itemCounter?: number;
38
+ /** Category description. */
39
+ description?: string | null;
40
+ /**
41
+ * Whether the category is visible to site visitors in dynamic pages (If not passed, the default is `false`).
42
+ * Even if visible is `false`, it can still be added manually to static page.
43
+ * If parent visibility is updated to `false`, all the children visibility will be updated eventually to `false`.
44
+ * It is not allowed to set visible as `true` if at least one of the parent categories has visible `false`.
45
+ */
46
+ visible?: boolean | null;
47
+ /**
48
+ * A category's breadcrumbs, Updated on moved to different parent or on renamed.
49
+ * > **Note:** This field is returned only when you pass `fields: "BREADCRUMBS"` in the request.
50
+ * @readonly
51
+ */
52
+ breadcrumbs?: BreadcrumbItemValues;
53
+ /** The parent category. */
54
+ parentCategory?: ParentCategory;
55
+ /**
56
+ * A permanent, friendly URL name.
57
+ * If not provided, on create generated automatically.
58
+ * When provided, validated and must be unique.
59
+ */
60
+ slug?: string | null;
61
+ /**
62
+ * Category description which supports rich content. It is independent from `description` field and can be used instead of it or in addition to it.
63
+ * In order to use this field you have to integrate with "Ricos" on frontend side. To learn how to do it visit https://ricos.js.org/.
64
+ */
65
+ richContentDescription?: RichContent;
66
+ /**
67
+ * Optional - the ID of the app responsible for managing the items within this category.
68
+ * If provided, the update of items assigned to this category and the deletion of it will be allowed only to the managing app.
69
+ * The default is Empty.
70
+ */
71
+ managingAppId?: string | null;
72
+ /** Extensions enabling users to save custom data related to the category. */
73
+ extendedFields?: ExtendedFields;
74
+ }
75
+ /** Wrapper for optional BreadcrumbItem values */
76
+ interface BreadcrumbItemValues {
77
+ /**
78
+ * The wrapped BreadcrumbItem values
79
+ * @readonly
80
+ */
81
+ values?: BreadcrumbItem[];
82
+ }
83
+ interface BreadcrumbItem {
84
+ /** Represents the id of the category. */
85
+ categoryId?: string;
86
+ /** Represents the name of the category. Translatable */
87
+ categoryName?: string;
88
+ /** Represents the slug. A permanent, friendly URL name of the category. */
89
+ categorySlug?: string;
90
+ }
91
+ interface ParentCategory {
92
+ /**
93
+ * Represents the id of the parent category.
94
+ * If not passed, the default is the root category.
95
+ */
96
+ _id?: string | null;
97
+ /**
98
+ * Represents the index of current category within the parent category.
99
+ * @readonly
100
+ */
101
+ index?: number | null;
102
+ }
103
+ /**
104
+ * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
105
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
106
+ * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
107
+ */
108
+ interface SeoSchema {
109
+ /** SEO tag information. */
110
+ tags?: Tag[];
111
+ /** SEO general settings. */
112
+ settings?: Settings;
113
+ }
114
+ interface Keyword {
115
+ /** Keyword value. */
116
+ term?: string;
117
+ /** Whether the keyword is the main focus keyword. */
118
+ isMain?: boolean;
119
+ }
120
+ interface Tag {
121
+ /**
122
+ * SEO tag type.
123
+ *
124
+ *
125
+ * Supported values: `title`, `meta`, `script`, `link`.
126
+ */
127
+ type?: string;
128
+ /**
129
+ * A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.
130
+ * For example: `{'name': 'description', 'content': 'the description itself'}`.
131
+ */
132
+ props?: Record<string, any> | null;
133
+ /** SEO tag meta data. For example, `{height: 300, width: 240}`. */
134
+ meta?: Record<string, any> | null;
135
+ /** SEO tag inner content. For example, `<title> inner content </title>`. */
136
+ children?: string;
137
+ /** Whether the tag is a custom tag. */
138
+ custom?: boolean;
139
+ /** Whether the tag is disabled. */
140
+ disabled?: boolean;
141
+ }
142
+ interface Settings {
143
+ /**
144
+ * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
145
+ *
146
+ *
147
+ * Default: `false` (Auto Redirect is enabled.)
148
+ */
149
+ preventAutoRedirect?: boolean;
150
+ /** User-selected keyword terms for a specific page. */
151
+ keywords?: Keyword[];
152
+ }
153
+ interface RichContent {
154
+ /** Node objects representing a rich content document. */
155
+ nodes?: Node[];
156
+ /** Object metadata. */
157
+ metadata?: Metadata;
158
+ /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
159
+ documentStyle?: DocumentStyle;
160
+ }
161
+ interface Node extends NodeDataOneOf {
162
+ /** Data for a button node. */
163
+ buttonData?: ButtonData;
164
+ /** Data for a code block node. */
165
+ codeBlockData?: CodeBlockData;
166
+ /** Data for a divider node. */
167
+ dividerData?: DividerData;
168
+ /** Data for a file node. */
169
+ fileData?: FileData;
170
+ /** Data for a gallery node. */
171
+ galleryData?: GalleryData;
172
+ /** Data for a GIF node. */
173
+ gifData?: GIFData;
174
+ /** Data for a heading node. */
175
+ headingData?: HeadingData;
176
+ /** Data for an embedded HTML node. */
177
+ htmlData?: HTMLData;
178
+ /** Data for an image node. */
179
+ imageData?: ImageData;
180
+ /** Data for a link preview node. */
181
+ linkPreviewData?: LinkPreviewData;
182
+ /** Data for a map node. */
183
+ mapData?: MapData;
184
+ /** Data for a paragraph node. */
185
+ paragraphData?: ParagraphData;
186
+ /** Data for a poll node. */
187
+ pollData?: PollData;
188
+ /** Data for a text node. Used to apply decorations to text. */
189
+ textData?: TextData;
190
+ /** Data for an app embed node. */
191
+ appEmbedData?: AppEmbedData;
192
+ /** Data for a video node. */
193
+ videoData?: VideoData;
194
+ /** Data for an oEmbed node. */
195
+ embedData?: EmbedData;
196
+ /** Data for a collapsible list node. */
197
+ collapsibleListData?: CollapsibleListData;
198
+ /** Data for a table node. */
199
+ tableData?: TableData;
200
+ /** Data for a table cell node. */
201
+ tableCellData?: TableCellData;
202
+ /** Data for a custom external node. */
203
+ externalData?: Record<string, any> | null;
204
+ /** Data for an audio node. */
205
+ audioData?: AudioData;
206
+ /** Data for an ordered list node. */
207
+ orderedListData?: OrderedListData;
208
+ /** Data for a bulleted list node. */
209
+ bulletedListData?: BulletedListData;
210
+ /** Data for a block quote node. */
211
+ blockquoteData?: BlockquoteData;
212
+ /** 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. */
213
+ type?: NodeType;
214
+ /** Node ID. */
215
+ _id?: string;
216
+ /** A list of child nodes. */
217
+ nodes?: Node[];
218
+ /** Padding and background color styling for the node. */
219
+ style?: NodeStyle;
220
+ }
221
+ /** @oneof */
222
+ interface NodeDataOneOf {
223
+ /** Data for a button node. */
224
+ buttonData?: ButtonData;
225
+ /** Data for a code block node. */
226
+ codeBlockData?: CodeBlockData;
227
+ /** Data for a divider node. */
228
+ dividerData?: DividerData;
229
+ /** Data for a file node. */
230
+ fileData?: FileData;
231
+ /** Data for a gallery node. */
232
+ galleryData?: GalleryData;
233
+ /** Data for a GIF node. */
234
+ gifData?: GIFData;
235
+ /** Data for a heading node. */
236
+ headingData?: HeadingData;
237
+ /** Data for an embedded HTML node. */
238
+ htmlData?: HTMLData;
239
+ /** Data for an image node. */
240
+ imageData?: ImageData;
241
+ /** Data for a link preview node. */
242
+ linkPreviewData?: LinkPreviewData;
243
+ /** Data for a map node. */
244
+ mapData?: MapData;
245
+ /** Data for a paragraph node. */
246
+ paragraphData?: ParagraphData;
247
+ /** Data for a poll node. */
248
+ pollData?: PollData;
249
+ /** Data for a text node. Used to apply decorations to text. */
250
+ textData?: TextData;
251
+ /** Data for an app embed node. */
252
+ appEmbedData?: AppEmbedData;
253
+ /** Data for a video node. */
254
+ videoData?: VideoData;
255
+ /** Data for an oEmbed node. */
256
+ embedData?: EmbedData;
257
+ /** Data for a collapsible list node. */
258
+ collapsibleListData?: CollapsibleListData;
259
+ /** Data for a table node. */
260
+ tableData?: TableData;
261
+ /** Data for a table cell node. */
262
+ tableCellData?: TableCellData;
263
+ /** Data for a custom external node. */
264
+ externalData?: Record<string, any> | null;
265
+ /** Data for an audio node. */
266
+ audioData?: AudioData;
267
+ /** Data for an ordered list node. */
268
+ orderedListData?: OrderedListData;
269
+ /** Data for a bulleted list node. */
270
+ bulletedListData?: BulletedListData;
271
+ /** Data for a block quote node. */
272
+ blockquoteData?: BlockquoteData;
273
+ }
274
+ declare enum NodeType {
275
+ PARAGRAPH = "PARAGRAPH",
276
+ TEXT = "TEXT",
277
+ HEADING = "HEADING",
278
+ BULLETED_LIST = "BULLETED_LIST",
279
+ ORDERED_LIST = "ORDERED_LIST",
280
+ LIST_ITEM = "LIST_ITEM",
281
+ BLOCKQUOTE = "BLOCKQUOTE",
282
+ CODE_BLOCK = "CODE_BLOCK",
283
+ VIDEO = "VIDEO",
284
+ DIVIDER = "DIVIDER",
285
+ FILE = "FILE",
286
+ GALLERY = "GALLERY",
287
+ GIF = "GIF",
288
+ HTML = "HTML",
289
+ IMAGE = "IMAGE",
290
+ LINK_PREVIEW = "LINK_PREVIEW",
291
+ MAP = "MAP",
292
+ POLL = "POLL",
293
+ APP_EMBED = "APP_EMBED",
294
+ BUTTON = "BUTTON",
295
+ COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
296
+ TABLE = "TABLE",
297
+ EMBED = "EMBED",
298
+ COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
299
+ COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
300
+ COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
301
+ TABLE_CELL = "TABLE_CELL",
302
+ TABLE_ROW = "TABLE_ROW",
303
+ EXTERNAL = "EXTERNAL",
304
+ AUDIO = "AUDIO"
305
+ }
306
+ interface NodeStyle {
307
+ /** The top padding value in pixels. */
308
+ paddingTop?: string | null;
309
+ /** The bottom padding value in pixels. */
310
+ paddingBottom?: string | null;
311
+ /** The background color as a hexadecimal value. */
312
+ backgroundColor?: string | null;
313
+ }
314
+ interface ButtonData {
315
+ /** Styling for the button's container. */
316
+ containerData?: PluginContainerData;
317
+ /** The button type. */
318
+ type?: Type;
319
+ /** Styling for the button. */
320
+ styles?: Styles;
321
+ /** The text to display on the button. */
322
+ text?: string | null;
323
+ /** Button link details. */
324
+ link?: Link;
325
+ }
326
+ interface Border {
327
+ /** Border width in pixels. */
328
+ width?: number | null;
329
+ /** Border radius in pixels. */
330
+ radius?: number | null;
331
+ }
332
+ interface Colors {
333
+ /** The text color as a hexadecimal value. */
334
+ text?: string | null;
335
+ /** The border color as a hexadecimal value. */
336
+ border?: string | null;
337
+ /** The background color as a hexadecimal value. */
338
+ background?: string | null;
339
+ }
340
+ interface PluginContainerData {
341
+ /** The width of the node when it's displayed. */
342
+ width?: PluginContainerDataWidth;
343
+ /** The node's alignment within its container. */
344
+ alignment?: PluginContainerDataAlignment;
345
+ /** Spoiler cover settings for the node. */
346
+ spoiler?: Spoiler;
347
+ /** The height of the node when it's displayed. */
348
+ height?: Height;
349
+ /** 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`. */
350
+ textWrap?: boolean | null;
351
+ }
352
+ declare enum WidthType {
353
+ /** Width matches the content width */
354
+ CONTENT = "CONTENT",
355
+ /** Small Width */
356
+ SMALL = "SMALL",
357
+ /** Width will match the original asset width */
358
+ ORIGINAL = "ORIGINAL",
359
+ /** coast-to-coast display */
360
+ FULL_WIDTH = "FULL_WIDTH"
361
+ }
362
+ interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
363
+ /**
364
+ * One of the following predefined width options:
365
+ * `CONTENT`: The width of the container matches the content width.
366
+ * `SMALL`: A small width.
367
+ * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
368
+ * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
369
+ */
370
+ size?: WidthType;
371
+ /** A custom width value in pixels. */
372
+ custom?: string | null;
373
+ }
374
+ /** @oneof */
375
+ interface PluginContainerDataWidthDataOneOf {
376
+ /**
377
+ * One of the following predefined width options:
378
+ * `CONTENT`: The width of the container matches the content width.
379
+ * `SMALL`: A small width.
380
+ * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
381
+ * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
382
+ */
383
+ size?: WidthType;
384
+ /** A custom width value in pixels. */
385
+ custom?: string | null;
386
+ }
387
+ declare enum PluginContainerDataAlignment {
388
+ /** Center Alignment */
389
+ CENTER = "CENTER",
390
+ /** Left Alignment */
391
+ LEFT = "LEFT",
392
+ /** Right Alignment */
393
+ RIGHT = "RIGHT"
394
+ }
395
+ interface Spoiler {
396
+ /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
397
+ enabled?: boolean | null;
398
+ /** The description displayed on top of the spoiler cover. */
399
+ description?: string | null;
400
+ /** The text for the button used to remove the spoiler cover. */
401
+ buttonText?: string | null;
402
+ }
403
+ interface Height {
404
+ /** A custom height value in pixels. */
405
+ custom?: string | null;
406
+ }
407
+ declare enum Type {
408
+ /** Regular link button */
409
+ LINK = "LINK",
410
+ /** Triggers custom action that is defined in plugin configuration by the consumer */
411
+ ACTION = "ACTION"
412
+ }
413
+ interface Styles {
414
+ /** Border attributes. */
415
+ border?: Border;
416
+ /** Color attributes. */
417
+ colors?: Colors;
418
+ }
419
+ interface Link extends LinkDataOneOf {
420
+ /** The absolute URL for the linked document. */
421
+ url?: string;
422
+ /** The target node's ID. Used for linking to another node in this object. */
423
+ anchor?: string;
424
+ /**
425
+ * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
426
+ * `SELF` - Default. Opens the linked document in the same frame as the link.
427
+ * `BLANK` - Opens the linked document in a new browser tab or window.
428
+ * `PARENT` - Opens the linked document in the link's parent frame.
429
+ * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
430
+ */
431
+ target?: Target;
432
+ /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
433
+ rel?: Rel;
434
+ /** A serialized object used for a custom or external link panel. */
435
+ customData?: string | null;
436
+ }
437
+ /** @oneof */
438
+ interface LinkDataOneOf {
439
+ /** The absolute URL for the linked document. */
440
+ url?: string;
441
+ /** The target node's ID. Used for linking to another node in this object. */
442
+ anchor?: string;
443
+ }
444
+ declare enum Target {
445
+ /** Opens the linked document in the same frame as it was clicked (this is default) */
446
+ SELF = "SELF",
447
+ /** Opens the linked document in a new window or tab */
448
+ BLANK = "BLANK",
449
+ /** Opens the linked document in the parent frame */
450
+ PARENT = "PARENT",
451
+ /** Opens the linked document in the full body of the window */
452
+ TOP = "TOP"
453
+ }
454
+ interface Rel {
455
+ /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
456
+ nofollow?: boolean | null;
457
+ /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
458
+ sponsored?: boolean | null;
459
+ /** 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`. */
460
+ ugc?: boolean | null;
461
+ /** Indicates that this link protect referral information from being passed to the target website. */
462
+ noreferrer?: boolean | null;
463
+ }
464
+ interface CodeBlockData {
465
+ /** Styling for the code block's text. */
466
+ textStyle?: TextStyle;
467
+ }
468
+ interface TextStyle {
469
+ /** Text alignment. Defaults to `AUTO`. */
470
+ textAlignment?: TextAlignment;
471
+ /** 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. */
472
+ lineHeight?: string | null;
473
+ }
474
+ declare enum TextAlignment {
475
+ /** browser default, eqivalent to `initial` */
476
+ AUTO = "AUTO",
477
+ /** Left align */
478
+ LEFT = "LEFT",
479
+ /** Right align */
480
+ RIGHT = "RIGHT",
481
+ /** Center align */
482
+ CENTER = "CENTER",
483
+ /** 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 */
484
+ JUSTIFY = "JUSTIFY"
485
+ }
486
+ interface DividerData {
487
+ /** Styling for the divider's container. */
488
+ containerData?: PluginContainerData;
489
+ /** Divider line style. */
490
+ lineStyle?: LineStyle;
491
+ /** Divider width. */
492
+ width?: Width;
493
+ /** Divider alignment. */
494
+ alignment?: Alignment;
495
+ }
496
+ declare enum LineStyle {
497
+ /** Single Line */
498
+ SINGLE = "SINGLE",
499
+ /** Double Line */
500
+ DOUBLE = "DOUBLE",
501
+ /** Dashed Line */
502
+ DASHED = "DASHED",
503
+ /** Dotted Line */
504
+ DOTTED = "DOTTED"
505
+ }
506
+ declare enum Width {
507
+ /** Large line */
508
+ LARGE = "LARGE",
509
+ /** Medium line */
510
+ MEDIUM = "MEDIUM",
511
+ /** Small line */
512
+ SMALL = "SMALL"
513
+ }
514
+ declare enum Alignment {
515
+ /** Center alignment */
516
+ CENTER = "CENTER",
517
+ /** Left alignment */
518
+ LEFT = "LEFT",
519
+ /** Right alignment */
520
+ RIGHT = "RIGHT"
521
+ }
522
+ interface FileData {
523
+ /** Styling for the file's container. */
524
+ containerData?: PluginContainerData;
525
+ /** The source for the file's data. */
526
+ src?: FileSource;
527
+ /** File name. */
528
+ name?: string | null;
529
+ /** File type. */
530
+ type?: string | null;
531
+ /**
532
+ * Use `sizeInKb` instead.
533
+ * @deprecated
534
+ */
535
+ size?: number | null;
536
+ /** Settings for PDF files. */
537
+ pdfSettings?: PDFSettings;
538
+ /** File MIME type. */
539
+ mimeType?: string | null;
540
+ /** File path. */
541
+ path?: string | null;
542
+ /** File size in KB. */
543
+ sizeInKb?: string | null;
544
+ }
545
+ declare enum ViewMode {
546
+ /** No PDF view */
547
+ NONE = "NONE",
548
+ /** Full PDF view */
549
+ FULL = "FULL",
550
+ /** Mini PDF view */
551
+ MINI = "MINI"
552
+ }
553
+ interface FileSource extends FileSourceDataOneOf {
554
+ /** The absolute URL for the file's source. */
555
+ url?: string | null;
556
+ /**
557
+ * Custom ID. Use `id` instead.
558
+ * @deprecated
559
+ */
560
+ custom?: string | null;
561
+ /** An ID that's resolved to a URL by a resolver function. */
562
+ _id?: string | null;
563
+ /** Indicates whether the file's source is private. Defaults to `false`. */
564
+ private?: boolean | null;
565
+ }
566
+ /** @oneof */
567
+ interface FileSourceDataOneOf {
568
+ /** The absolute URL for the file's source. */
569
+ url?: string | null;
570
+ /**
571
+ * Custom ID. Use `id` instead.
572
+ * @deprecated
573
+ */
574
+ custom?: string | null;
575
+ /** An ID that's resolved to a URL by a resolver function. */
576
+ _id?: string | null;
577
+ }
578
+ interface PDFSettings {
579
+ /**
580
+ * PDF view mode. One of the following:
581
+ * `NONE` : The PDF isn't displayed.
582
+ * `FULL` : A full page view of the PDF is displayed.
583
+ * `MINI` : A mini view of the PDF is displayed.
584
+ */
585
+ viewMode?: ViewMode;
586
+ /** Sets whether the PDF download button is disabled. Defaults to `false`. */
587
+ disableDownload?: boolean | null;
588
+ /** Sets whether the PDF print button is disabled. Defaults to `false`. */
589
+ disablePrint?: boolean | null;
590
+ }
591
+ interface GalleryData {
592
+ /** Styling for the gallery's container. */
593
+ containerData?: PluginContainerData;
594
+ /** The items in the gallery. */
595
+ items?: Item[];
596
+ /** Options for defining the gallery's appearance. */
597
+ options?: GalleryOptions;
598
+ /** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
599
+ disableExpand?: boolean | null;
600
+ /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
601
+ disableDownload?: boolean | null;
602
+ }
603
+ interface Media {
604
+ /** The source for the media's data. */
605
+ src?: FileSource;
606
+ /** Media width in pixels. */
607
+ width?: number | null;
608
+ /** Media height in pixels. */
609
+ height?: number | null;
610
+ /** Media duration in seconds. Only relevant for audio and video files. */
611
+ duration?: number | null;
612
+ }
613
+ interface Image {
614
+ /** Image file details. */
615
+ media?: Media;
616
+ /** Link details for images that are links. */
617
+ link?: Link;
618
+ }
619
+ interface Video {
620
+ /** Video file details. */
621
+ media?: Media;
622
+ /** Video thumbnail file details. */
623
+ thumbnail?: Media;
624
+ }
625
+ interface Item extends ItemDataOneOf {
626
+ /** An image item. */
627
+ image?: Image;
628
+ /** A video item. */
629
+ video?: Video;
630
+ /** Item title. */
631
+ title?: string | null;
632
+ /** Item's alternative text. */
633
+ altText?: string | null;
634
+ }
635
+ /** @oneof */
636
+ interface ItemDataOneOf {
637
+ /** An image item. */
638
+ image?: Image;
639
+ /** A video item. */
640
+ video?: Video;
641
+ }
642
+ interface GalleryOptions {
643
+ /** Gallery layout. */
644
+ layout?: Layout;
645
+ /** Styling for gallery items. */
646
+ item?: ItemStyle;
647
+ /** Styling for gallery thumbnail images. */
648
+ thumbnails?: Thumbnails;
649
+ }
650
+ declare enum LayoutType {
651
+ /** Collage type */
652
+ COLLAGE = "COLLAGE",
653
+ /** Masonry type */
654
+ MASONRY = "MASONRY",
655
+ /** Grid type */
656
+ GRID = "GRID",
657
+ /** Thumbnail type */
658
+ THUMBNAIL = "THUMBNAIL",
659
+ /** Slider type */
660
+ SLIDER = "SLIDER",
661
+ /** Slideshow type */
662
+ SLIDESHOW = "SLIDESHOW",
663
+ /** Panorama type */
664
+ PANORAMA = "PANORAMA",
665
+ /** Column type */
666
+ COLUMN = "COLUMN",
667
+ /** Magic type */
668
+ MAGIC = "MAGIC",
669
+ /** Fullsize images type */
670
+ FULLSIZE = "FULLSIZE"
671
+ }
672
+ declare enum Orientation {
673
+ /** Rows Orientation */
674
+ ROWS = "ROWS",
675
+ /** Columns Orientation */
676
+ COLUMNS = "COLUMNS"
677
+ }
678
+ declare enum Crop {
679
+ /** Crop to fill */
680
+ FILL = "FILL",
681
+ /** Crop to fit */
682
+ FIT = "FIT"
683
+ }
684
+ declare enum ThumbnailsAlignment {
685
+ /** Top alignment */
686
+ TOP = "TOP",
687
+ /** Right alignment */
688
+ RIGHT = "RIGHT",
689
+ /** Bottom alignment */
690
+ BOTTOM = "BOTTOM",
691
+ /** Left alignment */
692
+ LEFT = "LEFT",
693
+ /** No thumbnail */
694
+ NONE = "NONE"
695
+ }
696
+ interface Layout {
697
+ /** Gallery layout type. */
698
+ type?: LayoutType;
699
+ /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
700
+ horizontalScroll?: boolean | null;
701
+ /** Gallery orientation. */
702
+ orientation?: Orientation;
703
+ /** The number of columns to display on full size screens. */
704
+ numberOfColumns?: number | null;
705
+ /** The number of columns to display on mobile screens. */
706
+ mobileNumberOfColumns?: number | null;
707
+ }
708
+ interface ItemStyle {
709
+ /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
710
+ targetSize?: number | null;
711
+ /** Item ratio */
712
+ ratio?: number | null;
713
+ /** Sets how item images are cropped. */
714
+ crop?: Crop;
715
+ /** The spacing between items in pixels. */
716
+ spacing?: number | null;
717
+ }
718
+ interface Thumbnails {
719
+ /** Thumbnail alignment. */
720
+ placement?: ThumbnailsAlignment;
721
+ /** Spacing between thumbnails in pixels. */
722
+ spacing?: number | null;
723
+ }
724
+ interface GIFData {
725
+ /** Styling for the GIF's container. */
726
+ containerData?: PluginContainerData;
727
+ /** The source of the full size GIF. */
728
+ original?: GIF;
729
+ /** The source of the downsized GIF. */
730
+ downsized?: GIF;
731
+ /** Height in pixels. */
732
+ height?: number;
733
+ /** Width in pixels. */
734
+ width?: number;
735
+ }
736
+ interface GIF {
737
+ /** GIF format URL. */
738
+ gif?: string | null;
739
+ /** MP4 format URL. */
740
+ mp4?: string | null;
741
+ /** Thumbnail URL. */
742
+ still?: string | null;
743
+ }
744
+ interface HeadingData {
745
+ /** Heading level from 1-6. */
746
+ level?: number;
747
+ /** Styling for the heading text. */
748
+ textStyle?: TextStyle;
749
+ /** Indentation level from 1-4. */
750
+ indentation?: number | null;
751
+ }
752
+ interface HTMLData extends HTMLDataDataOneOf {
753
+ /** The URL for the HTML code for the node. */
754
+ url?: string;
755
+ /** The HTML code for the node. */
756
+ html?: string;
757
+ /**
758
+ * Whether this is an AdSense element. Use `source` instead.
759
+ * @deprecated
760
+ */
761
+ isAdsense?: boolean | null;
762
+ /** Styling for the HTML node's container. */
763
+ containerData?: PluginContainerData;
764
+ /** The type of HTML code. */
765
+ source?: Source;
766
+ }
767
+ /** @oneof */
768
+ interface HTMLDataDataOneOf {
769
+ /** The URL for the HTML code for the node. */
770
+ url?: string;
771
+ /** The HTML code for the node. */
772
+ html?: string;
773
+ /**
774
+ * Whether this is an AdSense element. Use `source` instead.
775
+ * @deprecated
776
+ */
777
+ isAdsense?: boolean | null;
778
+ }
779
+ declare enum Source {
780
+ HTML = "HTML",
781
+ ADSENSE = "ADSENSE"
782
+ }
783
+ interface ImageData {
784
+ /** Styling for the image's container. */
785
+ containerData?: PluginContainerData;
786
+ /** Image file details. */
787
+ image?: Media;
788
+ /** Link details for images that are links. */
789
+ link?: Link;
790
+ /** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
791
+ disableExpand?: boolean | null;
792
+ /** Image's alternative text. */
793
+ altText?: string | null;
794
+ /** Image caption. */
795
+ caption?: string | null;
796
+ /** Sets whether the image's download button is disabled. Defaults to `false`. */
797
+ disableDownload?: boolean | null;
798
+ }
799
+ interface LinkPreviewData {
800
+ /** Styling for the link preview's container. */
801
+ containerData?: PluginContainerData;
802
+ /** Link details. */
803
+ link?: Link;
804
+ /** Preview title. */
805
+ title?: string | null;
806
+ /** Preview thumbnail URL. */
807
+ thumbnailUrl?: string | null;
808
+ /** Preview description. */
809
+ description?: string | null;
810
+ /** The preview content as HTML. */
811
+ html?: string | null;
812
+ }
813
+ interface MapData {
814
+ /** Styling for the map's container. */
815
+ containerData?: PluginContainerData;
816
+ /** Map settings. */
817
+ mapSettings?: MapSettings;
818
+ }
819
+ interface MapSettings {
820
+ /** The address to display on the map. */
821
+ address?: string | null;
822
+ /** Sets whether the map is draggable. */
823
+ draggable?: boolean | null;
824
+ /** Sets whether the location marker is visible. */
825
+ marker?: boolean | null;
826
+ /** Sets whether street view control is enabled. */
827
+ streetViewControl?: boolean | null;
828
+ /** Sets whether zoom control is enabled. */
829
+ zoomControl?: boolean | null;
830
+ /** Location latitude. */
831
+ lat?: number | null;
832
+ /** Location longitude. */
833
+ lng?: number | null;
834
+ /** Location name. */
835
+ locationName?: string | null;
836
+ /** Sets whether view mode control is enabled. */
837
+ viewModeControl?: boolean | null;
838
+ /** Initial zoom value. */
839
+ initialZoom?: number | null;
840
+ /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
841
+ mapType?: MapType;
842
+ }
843
+ declare enum MapType {
844
+ /** Roadmap map type */
845
+ ROADMAP = "ROADMAP",
846
+ /** Satellite map type */
847
+ SATELITE = "SATELITE",
848
+ /** Hybrid map type */
849
+ HYBRID = "HYBRID",
850
+ /** Terrain map type */
851
+ TERRAIN = "TERRAIN"
852
+ }
853
+ interface ParagraphData {
854
+ /** Styling for the paragraph text. */
855
+ textStyle?: TextStyle;
856
+ /** Indentation level from 1-4. */
857
+ indentation?: number | null;
858
+ /** Paragraph level */
859
+ level?: number | null;
860
+ }
861
+ interface PollData {
862
+ /** Styling for the poll's container. */
863
+ containerData?: PluginContainerData;
864
+ /** Poll data. */
865
+ poll?: Poll;
866
+ /** Layout settings for the poll and voting options. */
867
+ layout?: PollDataLayout;
868
+ /** Styling for the poll and voting options. */
869
+ design?: Design;
870
+ }
871
+ declare enum ViewRole {
872
+ /** Only Poll creator can view the results */
873
+ CREATOR = "CREATOR",
874
+ /** Anyone who voted can see the results */
875
+ VOTERS = "VOTERS",
876
+ /** Anyone can see the results, even if one didn't vote */
877
+ EVERYONE = "EVERYONE"
878
+ }
879
+ declare enum VoteRole {
880
+ /** Logged in member */
881
+ SITE_MEMBERS = "SITE_MEMBERS",
882
+ /** Anyone */
883
+ ALL = "ALL"
884
+ }
885
+ interface Permissions {
886
+ /** Sets who can view the poll results. */
887
+ view?: ViewRole;
888
+ /** Sets who can vote. */
889
+ vote?: VoteRole;
890
+ /** Sets whether one voter can vote multiple times. Defaults to `false`. */
891
+ allowMultipleVotes?: boolean | null;
892
+ }
893
+ interface Option {
894
+ /** Option ID. */
895
+ _id?: string | null;
896
+ /** Option title. */
897
+ title?: string | null;
898
+ /** The image displayed with the option. */
899
+ image?: Media;
900
+ }
901
+ interface PollSettings {
902
+ /** Permissions settings for voting. */
903
+ permissions?: Permissions;
904
+ /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
905
+ showVoters?: boolean | null;
906
+ /** Sets whether the vote count is displayed. Defaults to `true`. */
907
+ showVotesCount?: boolean | null;
908
+ }
909
+ declare enum PollLayoutType {
910
+ /** List */
911
+ LIST = "LIST",
912
+ /** Grid */
913
+ GRID = "GRID"
914
+ }
915
+ declare enum PollLayoutDirection {
916
+ /** Left-to-right */
917
+ LTR = "LTR",
918
+ /** Right-to-left */
919
+ RTL = "RTL"
920
+ }
921
+ interface PollLayout {
922
+ /** The layout for displaying the voting options. */
923
+ type?: PollLayoutType;
924
+ /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
925
+ direction?: PollLayoutDirection;
926
+ /** Sets whether to display the main poll image. Defaults to `false`. */
927
+ enableImage?: boolean | null;
928
+ }
929
+ interface OptionLayout {
930
+ /** Sets whether to display option images. Defaults to `false`. */
931
+ enableImage?: boolean | null;
932
+ }
933
+ declare enum BackgroundType {
934
+ /** Color background type */
935
+ COLOR = "COLOR",
936
+ /** Image background type */
937
+ IMAGE = "IMAGE",
938
+ /** Gradiant background type */
939
+ GRADIENT = "GRADIENT"
940
+ }
941
+ interface Gradient {
942
+ /** The gradient angle in degrees. */
943
+ angle?: number | null;
944
+ /** The start color as a hexademical value. */
945
+ startColor?: string | null;
946
+ /** The end color as a hexademical value. */
947
+ lastColor?: string | null;
948
+ }
949
+ interface Background extends BackgroundBackgroundOneOf {
950
+ /** The background color as a hexademical value. */
951
+ color?: string | null;
952
+ /** An image to use for the background. */
953
+ image?: Media;
954
+ /** Details for a gradient background. */
955
+ gradient?: Gradient;
956
+ /** Background type. For each option, include the relevant details. */
957
+ type?: BackgroundType;
958
+ }
959
+ /** @oneof */
960
+ interface BackgroundBackgroundOneOf {
961
+ /** The background color as a hexademical value. */
962
+ color?: string | null;
963
+ /** An image to use for the background. */
964
+ image?: Media;
965
+ /** Details for a gradient background. */
966
+ gradient?: Gradient;
967
+ }
968
+ interface PollDesign {
969
+ /** Background styling. */
970
+ background?: Background;
971
+ /** Border radius in pixels. */
972
+ borderRadius?: number | null;
973
+ }
974
+ interface OptionDesign {
975
+ /** Border radius in pixels. */
976
+ borderRadius?: number | null;
977
+ }
978
+ interface Poll {
979
+ /** Poll ID. */
980
+ _id?: string | null;
981
+ /** Poll title. */
982
+ title?: string | null;
983
+ /** Poll creator ID. */
984
+ creatorId?: string | null;
985
+ /** Main poll image. */
986
+ image?: Media;
987
+ /** Voting options. */
988
+ options?: Option[];
989
+ /** The poll's permissions and display settings. */
990
+ settings?: PollSettings;
991
+ }
992
+ interface PollDataLayout {
993
+ /** Poll layout settings. */
994
+ poll?: PollLayout;
995
+ /** Voting otpions layout settings. */
996
+ options?: OptionLayout;
997
+ }
998
+ interface Design {
999
+ /** Styling for the poll. */
1000
+ poll?: PollDesign;
1001
+ /** Styling for voting options. */
1002
+ options?: OptionDesign;
1003
+ }
1004
+ interface TextData {
1005
+ /** The text to apply decorations to. */
1006
+ text?: string;
1007
+ /** The decorations to apply. */
1008
+ decorations?: Decoration[];
1009
+ }
1010
+ /** Adds appearence changes to text */
1011
+ interface Decoration extends DecorationDataOneOf {
1012
+ /** Data for an anchor link decoration. */
1013
+ anchorData?: AnchorData;
1014
+ /** Data for a color decoration. */
1015
+ colorData?: ColorData;
1016
+ /** Data for an external link decoration. */
1017
+ linkData?: LinkData;
1018
+ /** Data for a mention decoration. */
1019
+ mentionData?: MentionData;
1020
+ /** Data for a font size decoration. */
1021
+ fontSizeData?: FontSizeData;
1022
+ /** Font weight for a bold decoration. */
1023
+ fontWeightValue?: number | null;
1024
+ /** Data for an italic decoration. Defaults to `true`. */
1025
+ italicData?: boolean | null;
1026
+ /** Data for an underline decoration. Defaults to `true`. */
1027
+ underlineData?: boolean | null;
1028
+ /** Data for a spoiler decoration. */
1029
+ spoilerData?: SpoilerData;
1030
+ /** The type of decoration to apply. */
1031
+ type?: DecorationType;
1032
+ }
1033
+ /** @oneof */
1034
+ interface DecorationDataOneOf {
1035
+ /** Data for an anchor link decoration. */
1036
+ anchorData?: AnchorData;
1037
+ /** Data for a color decoration. */
1038
+ colorData?: ColorData;
1039
+ /** Data for an external link decoration. */
1040
+ linkData?: LinkData;
1041
+ /** Data for a mention decoration. */
1042
+ mentionData?: MentionData;
1043
+ /** Data for a font size decoration. */
1044
+ fontSizeData?: FontSizeData;
1045
+ /** Font weight for a bold decoration. */
1046
+ fontWeightValue?: number | null;
1047
+ /** Data for an italic decoration. Defaults to `true`. */
1048
+ italicData?: boolean | null;
1049
+ /** Data for an underline decoration. Defaults to `true`. */
1050
+ underlineData?: boolean | null;
1051
+ /** Data for a spoiler decoration. */
1052
+ spoilerData?: SpoilerData;
1053
+ }
1054
+ declare enum DecorationType {
1055
+ BOLD = "BOLD",
1056
+ ITALIC = "ITALIC",
1057
+ UNDERLINE = "UNDERLINE",
1058
+ SPOILER = "SPOILER",
1059
+ ANCHOR = "ANCHOR",
1060
+ MENTION = "MENTION",
1061
+ LINK = "LINK",
1062
+ COLOR = "COLOR",
1063
+ FONT_SIZE = "FONT_SIZE",
1064
+ EXTERNAL = "EXTERNAL"
1065
+ }
1066
+ interface AnchorData {
1067
+ /** The target node's ID. */
1068
+ anchor?: string;
1069
+ }
1070
+ interface ColorData {
1071
+ /** The text's background color as a hexadecimal value. */
1072
+ background?: string | null;
1073
+ /** The text's foreground color as a hexadecimal value. */
1074
+ foreground?: string | null;
1075
+ }
1076
+ interface LinkData {
1077
+ /** Link details. */
1078
+ link?: Link;
1079
+ }
1080
+ interface MentionData {
1081
+ /** The mentioned user's name. */
1082
+ name?: string;
1083
+ /** The version of the user's name that appears after the `@` character in the mention. */
1084
+ slug?: string;
1085
+ /** Mentioned user's ID. */
1086
+ _id?: string | null;
1087
+ }
1088
+ interface FontSizeData {
1089
+ /** The units used for the font size. */
1090
+ unit?: FontType;
1091
+ /** Font size value. */
1092
+ value?: number | null;
1093
+ }
1094
+ declare enum FontType {
1095
+ PX = "PX",
1096
+ EM = "EM"
1097
+ }
1098
+ interface SpoilerData {
1099
+ /** Spoiler ID. */
1100
+ _id?: string | null;
1101
+ }
1102
+ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1103
+ /** Data for embedded Wix Bookings content. */
1104
+ bookingData?: BookingData;
1105
+ /** Data for embedded Wix Events content. */
1106
+ eventData?: EventData;
1107
+ /** The type of Wix App content being embedded. */
1108
+ type?: AppType;
1109
+ /** The ID of the embedded content. */
1110
+ itemId?: string | null;
1111
+ /** The name of the embedded content. */
1112
+ name?: string | null;
1113
+ /**
1114
+ * Deprecated: Use `image` instead.
1115
+ * @deprecated
1116
+ */
1117
+ imageSrc?: string | null;
1118
+ /** The URL for the embedded content. */
1119
+ url?: string | null;
1120
+ /** An image for the embedded content. */
1121
+ image?: Media;
1122
+ }
1123
+ /** @oneof */
1124
+ interface AppEmbedDataAppDataOneOf {
1125
+ /** Data for embedded Wix Bookings content. */
1126
+ bookingData?: BookingData;
1127
+ /** Data for embedded Wix Events content. */
1128
+ eventData?: EventData;
1129
+ }
1130
+ declare enum AppType {
1131
+ PRODUCT = "PRODUCT",
1132
+ EVENT = "EVENT",
1133
+ BOOKING = "BOOKING"
1134
+ }
1135
+ interface BookingData {
1136
+ /** Booking duration in minutes. */
1137
+ durations?: string | null;
1138
+ }
1139
+ interface EventData {
1140
+ /** Event schedule. */
1141
+ scheduling?: string | null;
1142
+ /** Event location. */
1143
+ location?: string | null;
1144
+ }
1145
+ interface VideoData {
1146
+ /** Styling for the video's container. */
1147
+ containerData?: PluginContainerData;
1148
+ /** Video details. */
1149
+ video?: Media;
1150
+ /** Video thumbnail details. */
1151
+ thumbnail?: Media;
1152
+ /** Sets whether the video's download button is disabled. Defaults to `false`. */
1153
+ disableDownload?: boolean | null;
1154
+ /** Video title. */
1155
+ title?: string | null;
1156
+ /** Video options. */
1157
+ options?: PlaybackOptions;
1158
+ }
1159
+ interface PlaybackOptions {
1160
+ /** Sets whether the media will automatically start playing. */
1161
+ autoPlay?: boolean | null;
1162
+ /** Sets whether media's will be looped. */
1163
+ playInLoop?: boolean | null;
1164
+ /** Sets whether media's controls will be shown. */
1165
+ showControls?: boolean | null;
1166
+ }
1167
+ interface EmbedData {
1168
+ /** Styling for the oEmbed node's container. */
1169
+ containerData?: PluginContainerData;
1170
+ /** An [oEmbed](https://www.oembed.com) object. */
1171
+ oembed?: Oembed;
1172
+ /** Origin asset source. */
1173
+ src?: string | null;
1174
+ }
1175
+ interface Oembed {
1176
+ /** The resource type. */
1177
+ type?: string | null;
1178
+ /** The width of the resource specified in the `url` property in pixels. */
1179
+ width?: number | null;
1180
+ /** The height of the resource specified in the `url` property in pixels. */
1181
+ height?: number | null;
1182
+ /** Resource title. */
1183
+ title?: string | null;
1184
+ /** The source URL for the resource. */
1185
+ url?: string | null;
1186
+ /** HTML for embedding a video player. The HTML should have no padding or margins. */
1187
+ html?: string | null;
1188
+ /** The name of the author or owner of the resource. */
1189
+ authorName?: string | null;
1190
+ /** The URL for the author or owner of the resource. */
1191
+ authorUrl?: string | null;
1192
+ /** The name of the resource provider. */
1193
+ providerName?: string | null;
1194
+ /** The URL for the resource provider. */
1195
+ providerUrl?: string | null;
1196
+ /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
1197
+ thumbnailUrl?: string | null;
1198
+ /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
1199
+ thumbnailWidth?: string | null;
1200
+ /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
1201
+ thumbnailHeight?: string | null;
1202
+ /** The URL for an embedded viedo. */
1203
+ videoUrl?: string | null;
1204
+ /** The oEmbed version number. This value must be `1.0`. */
1205
+ version?: string | null;
1206
+ }
1207
+ interface CollapsibleListData {
1208
+ /** Styling for the collapsible list's container. */
1209
+ containerData?: PluginContainerData;
1210
+ /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
1211
+ expandOnlyOne?: boolean | null;
1212
+ /** Sets which items are expanded when the page loads. */
1213
+ initialExpandedItems?: InitialExpandedItems;
1214
+ /** The direction of the text in the list. Either left-to-right or right-to-left. */
1215
+ direction?: Direction;
1216
+ /** If `true`, The collapsible item will appear in search results as an FAQ. */
1217
+ isQapageData?: boolean | null;
1218
+ }
1219
+ declare enum InitialExpandedItems {
1220
+ /** First item will be expended initally */
1221
+ FIRST = "FIRST",
1222
+ /** All items will expended initally */
1223
+ ALL = "ALL",
1224
+ /** All items collapsed initally */
1225
+ NONE = "NONE"
1226
+ }
1227
+ declare enum Direction {
1228
+ /** Left-to-right */
1229
+ LTR = "LTR",
1230
+ /** Right-to-left */
1231
+ RTL = "RTL"
1232
+ }
1233
+ interface TableData {
1234
+ /** Styling for the table's container. */
1235
+ containerData?: PluginContainerData;
1236
+ /** The table's dimensions. */
1237
+ dimensions?: Dimensions;
1238
+ /**
1239
+ * Deprecated: Use `rowHeader` and `columnHeader` instead.
1240
+ * @deprecated
1241
+ */
1242
+ header?: boolean | null;
1243
+ /** Sets whether the table's first row is a header. Defaults to `false`. */
1244
+ rowHeader?: boolean | null;
1245
+ /** Sets whether the table's first column is a header. Defaults to `false`. */
1246
+ columnHeader?: boolean | null;
1247
+ }
1248
+ interface Dimensions {
1249
+ /** An array representing relative width of each column in relation to the other columns. */
1250
+ colsWidthRatio?: number[];
1251
+ /** An array representing the height of each row in pixels. */
1252
+ rowsHeight?: number[];
1253
+ /** An array representing the minimum width of each column in pixels. */
1254
+ colsMinWidth?: number[];
1255
+ }
1256
+ interface TableCellData {
1257
+ /** Styling for the cell's background color and text alignment. */
1258
+ cellStyle?: CellStyle;
1259
+ /** The cell's border colors. */
1260
+ borderColors?: BorderColors;
1261
+ }
1262
+ declare enum VerticalAlignment {
1263
+ /** Top alignment */
1264
+ TOP = "TOP",
1265
+ /** Middle alignment */
1266
+ MIDDLE = "MIDDLE",
1267
+ /** Bottom alignment */
1268
+ BOTTOM = "BOTTOM"
1269
+ }
1270
+ interface CellStyle {
1271
+ /** Vertical alignment for the cell's text. */
1272
+ verticalAlignment?: VerticalAlignment;
1273
+ /** Cell background color as a hexadecimal value. */
1274
+ backgroundColor?: string | null;
1275
+ }
1276
+ interface BorderColors {
1277
+ /** Left border color as a hexadecimal value. */
1278
+ left?: string | null;
1279
+ /** Right border color as a hexadecimal value. */
1280
+ right?: string | null;
1281
+ /** Top border color as a hexadecimal value. */
1282
+ top?: string | null;
1283
+ /** Bottom border color as a hexadecimal value. */
1284
+ bottom?: string | null;
1285
+ }
1286
+ /**
1287
+ * `NullValue` is a singleton enumeration to represent the null value for the
1288
+ * `Value` type union.
1289
+ *
1290
+ * The JSON representation for `NullValue` is JSON `null`.
1291
+ */
1292
+ declare enum NullValue {
1293
+ /** Null value. */
1294
+ NULL_VALUE = "NULL_VALUE"
1295
+ }
1296
+ /**
1297
+ * `ListValue` is a wrapper around a repeated field of values.
1298
+ *
1299
+ * The JSON representation for `ListValue` is JSON array.
1300
+ */
1301
+ interface ListValue {
1302
+ /** Repeated field of dynamically typed values. */
1303
+ values?: any[];
1304
+ }
1305
+ interface AudioData {
1306
+ /** Styling for the audio node's container. */
1307
+ containerData?: PluginContainerData;
1308
+ /** Audio file details. */
1309
+ audio?: Media;
1310
+ /** Sets whether the audio node's download button is disabled. Defaults to `false`. */
1311
+ disableDownload?: boolean | null;
1312
+ /** Cover image. */
1313
+ coverImage?: Media;
1314
+ /** Track name. */
1315
+ name?: string | null;
1316
+ /** Author name. */
1317
+ authorName?: string | null;
1318
+ /** An HTML version of the audio node. */
1319
+ html?: string | null;
1320
+ }
1321
+ interface OrderedListData {
1322
+ /** Indentation level from 0-4. */
1323
+ indentation?: number;
1324
+ /** Offset level from 0-4. */
1325
+ offset?: number | null;
1326
+ }
1327
+ interface BulletedListData {
1328
+ /** Indentation level from 0-4. */
1329
+ indentation?: number;
1330
+ /** Offset level from 0-4. */
1331
+ offset?: number | null;
1332
+ }
1333
+ interface BlockquoteData {
1334
+ /** Indentation level from 1-4. */
1335
+ indentation?: number;
1336
+ }
1337
+ interface Metadata {
1338
+ /** Schema version. */
1339
+ version?: number;
1340
+ /**
1341
+ * When the object was created.
1342
+ * @readonly
1343
+ * @deprecated
1344
+ */
1345
+ createdTimestamp?: Date;
1346
+ /**
1347
+ * When the object was most recently updated.
1348
+ * @deprecated
1349
+ */
1350
+ updatedTimestamp?: Date;
1351
+ /** Object ID. */
1352
+ _id?: string | null;
1353
+ }
1354
+ interface DocumentStyle {
1355
+ /** Styling for H1 nodes. */
1356
+ headerOne?: TextNodeStyle;
1357
+ /** Styling for H2 nodes. */
1358
+ headerTwo?: TextNodeStyle;
1359
+ /** Styling for H3 nodes. */
1360
+ headerThree?: TextNodeStyle;
1361
+ /** Styling for H4 nodes. */
1362
+ headerFour?: TextNodeStyle;
1363
+ /** Styling for H5 nodes. */
1364
+ headerFive?: TextNodeStyle;
1365
+ /** Styling for H6 nodes. */
1366
+ headerSix?: TextNodeStyle;
1367
+ /** Styling for paragraph nodes. */
1368
+ paragraph?: TextNodeStyle;
1369
+ /** Styling for block quote nodes. */
1370
+ blockquote?: TextNodeStyle;
1371
+ /** Styling for code block nodes. */
1372
+ codeBlock?: TextNodeStyle;
1373
+ }
1374
+ interface TextNodeStyle {
1375
+ /** The decorations to apply to the node. */
1376
+ decorations?: Decoration[];
1377
+ /** Padding and background color for the node. */
1378
+ nodeStyle?: NodeStyle;
1379
+ /** Line height for text in the node. */
1380
+ lineHeight?: string | null;
1381
+ }
1382
+ interface TreeReference {
1383
+ /**
1384
+ * The unique namespace of an app in dev-center that owns this tree.
1385
+ * Should meet the format of @company/app1 where @company is an organizational unit and app1 is the app name.
1386
+ * For example: @bookings/bookingslist, @achievements/quizzes
1387
+ */
1388
+ appNamespace?: string;
1389
+ /** Optional - The key of the tree. Must be provided when single app manages more than one tree. */
1390
+ treeKey?: string | null;
1391
+ }
1392
+ interface ExtendedFields {
1393
+ /**
1394
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
1395
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
1396
+ *
1397
+ * You can only access fields for which you have the appropriate permissions.
1398
+ *
1399
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
1400
+ */
1401
+ namespaces?: Record<string, Record<string, any>>;
1402
+ }
1403
+ interface InvalidateCache extends InvalidateCacheGetByOneOf {
1404
+ /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
1405
+ metaSiteId?: string;
1406
+ /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
1407
+ siteId?: string;
1408
+ /** Invalidate by App */
1409
+ app?: App;
1410
+ /** Invalidate by page id */
1411
+ page?: Page;
1412
+ /** Invalidate by URI path */
1413
+ uri?: URI;
1414
+ /** Invalidate by file (for media files such as PDFs) */
1415
+ file?: File;
1416
+ /** tell us why you're invalidating the cache. You don't need to add your app name */
1417
+ reason?: string | null;
1418
+ /** Is local DS */
1419
+ localDc?: boolean;
1420
+ }
1421
+ /** @oneof */
1422
+ interface InvalidateCacheGetByOneOf {
1423
+ /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
1424
+ metaSiteId?: string;
1425
+ /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
1426
+ siteId?: string;
1427
+ /** Invalidate by App */
1428
+ app?: App;
1429
+ /** Invalidate by page id */
1430
+ page?: Page;
1431
+ /** Invalidate by URI path */
1432
+ uri?: URI;
1433
+ /** Invalidate by file (for media files such as PDFs) */
1434
+ file?: File;
1435
+ }
1436
+ interface App {
1437
+ /** The AppDefId */
1438
+ appDefId?: string;
1439
+ /** The instance Id */
1440
+ instanceId?: string;
1441
+ }
1442
+ interface Page {
1443
+ /** the msid the page is on */
1444
+ metaSiteId?: string;
1445
+ /** Invalidate by Page ID */
1446
+ pageId?: string;
1447
+ }
1448
+ interface URI {
1449
+ /** the msid the URI is on */
1450
+ metaSiteId?: string;
1451
+ /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
1452
+ uriPath?: string;
1453
+ }
1454
+ interface File {
1455
+ /** the msid the file is related to */
1456
+ metaSiteId?: string;
1457
+ /** Invalidate by filename (for media files such as PDFs) */
1458
+ fileName?: string;
1459
+ }
1460
+ interface CreateCategoryRequest {
1461
+ /** Category to be created. */
1462
+ category: Category;
1463
+ /** A reference to the tree that contains this category. */
1464
+ treeReference: TreeReference;
1465
+ /** Fields to return in the response. When not provided, these fields are not returned. */
1466
+ fields?: RequestedFields[];
1467
+ }
1468
+ declare enum RequestedFields {
1469
+ UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
1470
+ BREADCRUMBS = "BREADCRUMBS"
1471
+ }
1472
+ interface CreateCategoryResponse {
1473
+ /** The created Category. */
1474
+ category?: Category;
1475
+ }
1476
+ interface GetCategoryRequest {
1477
+ /** Id of the Category to retrieve. */
1478
+ categoryId: string;
1479
+ /** A reference to the tree that contains this category. */
1480
+ treeReference: TreeReference;
1481
+ /** Fields to return in the response. When not provided, these fields are not returned. */
1482
+ fields?: RequestedFields[];
1483
+ }
1484
+ interface GetCategoryResponse {
1485
+ /** The retrieved Category. */
1486
+ category?: Category;
1487
+ }
1488
+ interface UpdateCategoryRequest {
1489
+ /** Category to be updated, may be partial. */
1490
+ category: Category;
1491
+ /** A reference to the tree that contains this category. */
1492
+ treeReference: TreeReference;
1493
+ /** Fields to return in the response. When not provided, these fields are not returned. */
1494
+ fields?: RequestedFields[];
1495
+ }
1496
+ interface UpdateCategoryResponse {
1497
+ /** The updated Category. */
1498
+ category?: Category;
1499
+ }
1500
+ interface DeleteCategoryRequest {
1501
+ /** Id of the Category to delete. */
1502
+ categoryId: string;
1503
+ /** A reference to the tree that contains this category. */
1504
+ treeReference: TreeReference;
1505
+ }
1506
+ interface DeleteCategoryResponse {
1507
+ }
1508
+ interface QueryCategoriesRequest {
1509
+ /** WQL query expression. */
1510
+ query?: QueryV2;
1511
+ /**
1512
+ * A reference to the tree that contains this category.
1513
+ * Used only in the first request. Following requests use the cursor token.
1514
+ */
1515
+ treeReference?: TreeReference;
1516
+ /**
1517
+ * Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
1518
+ * Used only in the first request. Following requests use the cursor token.
1519
+ */
1520
+ returnNonVisibleCategories?: boolean;
1521
+ /** Fields to return in the response. When not provided, these fields are not returned. */
1522
+ fields?: RequestedFields[];
1523
+ }
1524
+ interface QueryV2 extends QueryV2PagingMethodOneOf {
1525
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1526
+ cursorPaging?: CursorPaging;
1527
+ /**
1528
+ * Filter object in the following format:
1529
+ * `"filter" : {
1530
+ * "fieldName1": "value1",
1531
+ * "fieldName2":{"$operator":"value2"}
1532
+ * }`
1533
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
1534
+ */
1535
+ filter?: Record<string, any> | null;
1536
+ /**
1537
+ * Sort object in the following format:
1538
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
1539
+ */
1540
+ sort?: Sorting[];
1541
+ }
1542
+ /** @oneof */
1543
+ interface QueryV2PagingMethodOneOf {
1544
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1545
+ cursorPaging?: CursorPaging;
1546
+ }
1547
+ interface Sorting {
1548
+ /** Name of the field to sort by. */
1549
+ fieldName?: string;
1550
+ /** Sort order. */
1551
+ order?: SortOrder;
1552
+ }
1553
+ declare enum SortOrder {
1554
+ ASC = "ASC",
1555
+ DESC = "DESC"
1556
+ }
1557
+ interface Paging {
1558
+ /** Number of items to load. */
1559
+ limit?: number | null;
1560
+ /** Number of items to skip in the current sort order. */
1561
+ offset?: number | null;
1562
+ }
1563
+ interface CursorPaging {
1564
+ /** Maximum number of items to return in the results. */
1565
+ limit?: number | null;
1566
+ /**
1567
+ * Pointer to the next or previous page in the list of results.
1568
+ *
1569
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1570
+ * Not relevant for the first request.
1571
+ */
1572
+ cursor?: string | null;
1573
+ }
1574
+ interface QueryCategoriesResponse {
1575
+ /** Categories which satisfy the provided query. */
1576
+ categories?: Category[];
1577
+ /** Paging metadata. Contains cursor which can be used in next query. */
1578
+ pagingMetadata?: PlatformPagingMetadataV2;
1579
+ }
1580
+ interface PlatformPagingMetadataV2 {
1581
+ /** The number of items returned in this response. */
1582
+ count?: number | null;
1583
+ /** Cursors to navigate through result pages. Returned if cursor paging was used. */
1584
+ cursors?: CommonCursors;
1585
+ }
1586
+ interface CommonCursors {
1587
+ /** Cursor string pointing to the next page in the list of results. */
1588
+ next?: string | null;
1589
+ /** Cursor pointing to the previous page in the list of results. */
1590
+ prev?: string | null;
1591
+ }
1592
+ interface ListCompactCategoriesByIdsRequest {
1593
+ /** List of category ids. */
1594
+ categoryIds?: string[];
1595
+ /** A reference to the tree that contains the categories. */
1596
+ treeReference?: TreeReference;
1597
+ }
1598
+ interface ListCompactCategoriesByIdsResponse {
1599
+ /** Categories which satisfy the provided ids. */
1600
+ categories?: CompactCategory[];
1601
+ }
1602
+ interface CompactCategory {
1603
+ /** Category ID. */
1604
+ _id?: string | null;
1605
+ /** Category name. */
1606
+ name?: string | null;
1607
+ }
1608
+ interface SearchCategoriesRequest {
1609
+ /** WQL query expression. */
1610
+ search?: CursorSearch;
1611
+ /**
1612
+ * A reference to the tree that contains this category.
1613
+ * Used only in the first request. Following requests use the cursor token.
1614
+ */
1615
+ treeReference: TreeReference;
1616
+ /**
1617
+ * Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
1618
+ * Used only in the first request. Following requests use the cursor token.
1619
+ */
1620
+ returnNonVisibleCategories?: boolean;
1621
+ /** Fields to return in the response. When not provided, these fields are not returned. */
1622
+ fields?: RequestedFields[];
1623
+ }
1624
+ interface CursorSearch extends CursorSearchPagingMethodOneOf {
1625
+ /**
1626
+ * Cursor pointing to page of results.
1627
+ * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
1628
+ */
1629
+ cursorPaging?: CursorPaging;
1630
+ /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
1631
+ filter?: Record<string, any> | null;
1632
+ /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
1633
+ sort?: Sorting[];
1634
+ /** Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. */
1635
+ aggregations?: Aggregation[];
1636
+ /** Free text to match in searchable fields */
1637
+ search?: SearchDetails;
1638
+ /**
1639
+ * UTC offset or IANA time zone. Valid values are
1640
+ * ISO 8601 UTC offsets, such as +02:00 or -06:00,
1641
+ * and IANA time zone IDs, such as Europe/Rome
1642
+ *
1643
+ * Affects all filters and aggregations returned values.
1644
+ * You may override this behavior in a specific filter by providing
1645
+ * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
1646
+ */
1647
+ timeZone?: string | null;
1648
+ }
1649
+ /** @oneof */
1650
+ interface CursorSearchPagingMethodOneOf {
1651
+ /**
1652
+ * Cursor pointing to page of results.
1653
+ * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
1654
+ */
1655
+ cursorPaging?: CursorPaging;
1656
+ }
1657
+ interface Aggregation extends AggregationKindOneOf {
1658
+ /** Value aggregation */
1659
+ value?: ValueAggregation;
1660
+ /** Range aggregation */
1661
+ range?: RangeAggregation;
1662
+ /** Scalar aggregation */
1663
+ scalar?: ScalarAggregation;
1664
+ /** Date histogram aggregation */
1665
+ dateHistogram?: DateHistogramAggregation;
1666
+ /** Nested aggregation */
1667
+ nested?: NestedAggregation;
1668
+ /** User-defined name of aggregation, should be unique, will appear in aggregation results */
1669
+ name?: string | null;
1670
+ /** Type of aggregation, client must provide matching aggregation field below */
1671
+ type?: AggregationType;
1672
+ /** Field to aggregate by, use dot notation to specify json path */
1673
+ fieldPath?: string;
1674
+ }
1675
+ /** @oneof */
1676
+ interface AggregationKindOneOf {
1677
+ /** Value aggregation */
1678
+ value?: ValueAggregation;
1679
+ /** Range aggregation */
1680
+ range?: RangeAggregation;
1681
+ /** Scalar aggregation */
1682
+ scalar?: ScalarAggregation;
1683
+ /** Date histogram aggregation */
1684
+ dateHistogram?: DateHistogramAggregation;
1685
+ /** Nested aggregation */
1686
+ nested?: NestedAggregation;
1687
+ }
1688
+ interface RangeBucket {
1689
+ /** Inclusive lower bound of the range. Required if to is not given */
1690
+ from?: number | null;
1691
+ /** Exclusive upper bound of the range. Required if from is not given */
1692
+ to?: number | null;
1693
+ }
1694
+ declare enum SortType {
1695
+ /** Should sort by number of matches */
1696
+ COUNT = "COUNT",
1697
+ /** Should sort by value of the field alphabetically */
1698
+ VALUE = "VALUE"
1699
+ }
1700
+ declare enum SortDirection {
1701
+ /** Should sort in descending order */
1702
+ DESC = "DESC",
1703
+ /** Should sort in ascending order */
1704
+ ASC = "ASC"
1705
+ }
1706
+ declare enum MissingValues {
1707
+ /** Should missing values be excluded from the aggregation results */
1708
+ EXCLUDE = "EXCLUDE",
1709
+ /** Should missing values be included in the aggregation results */
1710
+ INCLUDE = "INCLUDE"
1711
+ }
1712
+ interface IncludeMissingValuesOptions {
1713
+ /** Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
1714
+ addToBucket?: string;
1715
+ }
1716
+ declare enum ScalarType {
1717
+ UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
1718
+ /** Count of distinct values */
1719
+ COUNT_DISTINCT = "COUNT_DISTINCT",
1720
+ /** Minimum value */
1721
+ MIN = "MIN",
1722
+ /** Maximum value */
1723
+ MAX = "MAX",
1724
+ /** Sum of values */
1725
+ SUM = "SUM",
1726
+ /** Average of values */
1727
+ AVG = "AVG"
1728
+ }
1729
+ interface ValueAggregation extends ValueAggregationOptionsOneOf {
1730
+ /** Options for including missing values */
1731
+ includeOptions?: IncludeMissingValuesOptions;
1732
+ /** Should sort by number of matches or value of the field */
1733
+ sortType?: SortType;
1734
+ /** Should sort in ascending or descending order */
1735
+ sortDirection?: SortDirection;
1736
+ /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
1737
+ limit?: number | null;
1738
+ /** Should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
1739
+ missingValues?: MissingValues;
1740
+ }
1741
+ /** @oneof */
1742
+ interface ValueAggregationOptionsOneOf {
1743
+ /** Options for including missing values */
1744
+ includeOptions?: IncludeMissingValuesOptions;
1745
+ }
1746
+ declare enum NestedAggregationType {
1747
+ UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
1748
+ /** An aggregation where result buckets are dynamically built - one per unique value */
1749
+ VALUE = "VALUE",
1750
+ /** An aggregation, where user can define set of ranges - each representing a bucket */
1751
+ RANGE = "RANGE",
1752
+ /** A single-value metric aggregation - e.g. min, max, sum, avg */
1753
+ SCALAR = "SCALAR",
1754
+ /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
1755
+ DATE_HISTOGRAM = "DATE_HISTOGRAM"
1756
+ }
1757
+ interface RangeAggregation {
1758
+ /** List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds */
1759
+ buckets?: RangeBucket[];
1760
+ }
1761
+ interface ScalarAggregation {
1762
+ /** Define the operator for the scalar aggregation */
1763
+ type?: ScalarType;
1764
+ }
1765
+ interface DateHistogramAggregation {
1766
+ /** Interval for date histogram aggregation */
1767
+ interval?: Interval;
1768
+ }
1769
+ declare enum Interval {
1770
+ UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
1771
+ /** Yearly interval */
1772
+ YEAR = "YEAR",
1773
+ /** Monthly interval */
1774
+ MONTH = "MONTH",
1775
+ /** Weekly interval */
1776
+ WEEK = "WEEK",
1777
+ /** Daily interval */
1778
+ DAY = "DAY",
1779
+ /** Hourly interval */
1780
+ HOUR = "HOUR",
1781
+ /** Minute interval */
1782
+ MINUTE = "MINUTE",
1783
+ /** Second interval */
1784
+ SECOND = "SECOND"
1785
+ }
1786
+ interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
1787
+ /** Value aggregation */
1788
+ value?: ValueAggregation;
1789
+ /** Range aggregation */
1790
+ range?: RangeAggregation;
1791
+ /** Scalar aggregation */
1792
+ scalar?: ScalarAggregation;
1793
+ /** Date histogram aggregation */
1794
+ dateHistogram?: DateHistogramAggregation;
1795
+ /** User-defined name of aggregation, should be unique, will appear in aggregation results */
1796
+ name?: string | null;
1797
+ /** Type of aggregation, client must provide matching aggregation field below */
1798
+ type?: NestedAggregationType;
1799
+ /** Field to aggregate by, use dont notation to specify json path */
1800
+ fieldPath?: string;
1801
+ }
1802
+ /** @oneof */
1803
+ interface NestedAggregationItemKindOneOf {
1804
+ /** Value aggregation */
1805
+ value?: ValueAggregation;
1806
+ /** Range aggregation */
1807
+ range?: RangeAggregation;
1808
+ /** Scalar aggregation */
1809
+ scalar?: ScalarAggregation;
1810
+ /** Date histogram aggregation */
1811
+ dateHistogram?: DateHistogramAggregation;
1812
+ }
1813
+ declare enum AggregationType {
1814
+ UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
1815
+ /** An aggregation where result buckets are dynamically built - one per unique value */
1816
+ VALUE = "VALUE",
1817
+ /** An aggregation, where user can define set of ranges - each representing a bucket */
1818
+ RANGE = "RANGE",
1819
+ /** A single-value metric aggregation - e.g. min, max, sum, avg */
1820
+ SCALAR = "SCALAR",
1821
+ /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
1822
+ DATE_HISTOGRAM = "DATE_HISTOGRAM",
1823
+ /** Multi-level aggregation, where each next aggregation is nested within previous one */
1824
+ NESTED = "NESTED"
1825
+ }
1826
+ /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
1827
+ interface NestedAggregation {
1828
+ /** Flattened list of aggregations, where each next aggregation is nested within previous one */
1829
+ nestedAggregations?: NestedAggregationItem[];
1830
+ }
1831
+ interface SearchDetails {
1832
+ /** Defines how separate search terms in `expression` are combined */
1833
+ mode?: Mode;
1834
+ /** Search term or expression */
1835
+ expression?: string | null;
1836
+ /** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path */
1837
+ fields?: string[];
1838
+ /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
1839
+ fuzzy?: boolean;
1840
+ }
1841
+ declare enum Mode {
1842
+ /** Any of the search terms must be present */
1843
+ OR = "OR",
1844
+ /** All search terms must be present */
1845
+ AND = "AND"
1846
+ }
1847
+ interface SearchCategoriesResponse {
1848
+ /** Categories which satisfy the provided query. */
1849
+ categories?: Category[];
1850
+ /** Paging metadata. Contains cursor which can be used in next query. */
1851
+ pagingMetadata?: CursorPagingMetadata;
1852
+ /** Aggregation data. */
1853
+ aggregationData?: AggregationData;
1854
+ }
1855
+ interface CursorPagingMetadata {
1856
+ /** Number of items returned in the response. */
1857
+ count?: number | null;
1858
+ /** Cursor strings that point to the next page, previous page, or both. */
1859
+ cursors?: Cursors;
1860
+ /**
1861
+ * Whether there are more pages to retrieve following the current page.
1862
+ *
1863
+ * + `true`: Another page of results can be retrieved.
1864
+ * + `false`: This is the last page.
1865
+ */
1866
+ hasNext?: boolean | null;
1867
+ }
1868
+ interface Cursors {
1869
+ /** Cursor string pointing to the next page in the list of results. */
1870
+ next?: string | null;
1871
+ /** Cursor pointing to the previous page in the list of results. */
1872
+ prev?: string | null;
1873
+ }
1874
+ interface AggregationData {
1875
+ /** key = aggregation name (as derived from search request) */
1876
+ results?: AggregationResults[];
1877
+ }
1878
+ interface ValueAggregationResult {
1879
+ /** Value of the field */
1880
+ value?: string;
1881
+ /** Count of entities with this value */
1882
+ count?: number;
1883
+ }
1884
+ interface RangeAggregationResult {
1885
+ /** Inclusive lower bound of the range */
1886
+ from?: number | null;
1887
+ /** Exclusive upper bound of the range */
1888
+ to?: number | null;
1889
+ /** Count of entities in this range */
1890
+ count?: number;
1891
+ }
1892
+ interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
1893
+ /** Value aggregation results */
1894
+ values?: ValueResults;
1895
+ /** Range aggregation results */
1896
+ ranges?: RangeResults;
1897
+ /** Scalar aggregation results */
1898
+ scalar?: AggregationResultsScalarResult;
1899
+ /** User-defined name of aggregation, matches the one provided in request */
1900
+ name?: string;
1901
+ /** Type of aggregation that matches result */
1902
+ type?: AggregationType;
1903
+ /** Field to aggregate by, matches the one provided in request */
1904
+ fieldPath?: string;
1905
+ }
1906
+ /** @oneof */
1907
+ interface NestedAggregationResultsResultOneOf {
1908
+ /** Value aggregation results */
1909
+ values?: ValueResults;
1910
+ /** Range aggregation results */
1911
+ ranges?: RangeResults;
1912
+ /** Scalar aggregation results */
1913
+ scalar?: AggregationResultsScalarResult;
1914
+ }
1915
+ interface ValueResults {
1916
+ /** List of value aggregations */
1917
+ results?: ValueAggregationResult[];
1918
+ }
1919
+ interface RangeResults {
1920
+ /** List of ranges returned in same order as requested */
1921
+ results?: RangeAggregationResult[];
1922
+ }
1923
+ interface AggregationResultsScalarResult {
1924
+ /** Type of scalar aggregation */
1925
+ type?: ScalarType;
1926
+ /** Value of the scalar aggregation */
1927
+ value?: number;
1928
+ }
1929
+ interface NestedValueAggregationResult {
1930
+ /** Value of the field */
1931
+ value?: string;
1932
+ /** Nested aggregations */
1933
+ nestedResults?: NestedAggregationResults;
1934
+ }
1935
+ interface ValueResult {
1936
+ /** Value of the field */
1937
+ value?: string;
1938
+ /** Count of entities with this value */
1939
+ count?: number | null;
1940
+ }
1941
+ interface RangeResult {
1942
+ /** Inclusive lower bound of the range */
1943
+ from?: number | null;
1944
+ /** Exclusive upper bound of the range */
1945
+ to?: number | null;
1946
+ /** Count of entities in this range */
1947
+ count?: number | null;
1948
+ }
1949
+ interface ScalarResult {
1950
+ /** Value of the scalar aggregation */
1951
+ value?: number;
1952
+ }
1953
+ interface NestedResultValue extends NestedResultValueResultOneOf {
1954
+ /** Value aggregation result */
1955
+ value?: ValueResult;
1956
+ /** Range aggregation result */
1957
+ range?: RangeResult;
1958
+ /** Scalar aggregation result */
1959
+ scalar?: ScalarResult;
1960
+ /** Date histogram aggregation result */
1961
+ dateHistogram?: ValueResult;
1962
+ }
1963
+ /** @oneof */
1964
+ interface NestedResultValueResultOneOf {
1965
+ /** Value aggregation result */
1966
+ value?: ValueResult;
1967
+ /** Range aggregation result */
1968
+ range?: RangeResult;
1969
+ /** Scalar aggregation result */
1970
+ scalar?: ScalarResult;
1971
+ /** Date histogram aggregation result */
1972
+ dateHistogram?: ValueResult;
1973
+ }
1974
+ interface Results {
1975
+ /** List of nested aggregations */
1976
+ results?: Record<string, NestedResultValue>;
1977
+ }
1978
+ interface DateHistogramResult {
1979
+ /** Date in ISO 8601 format */
1980
+ value?: string;
1981
+ /** Count of documents in the bucket */
1982
+ count?: number;
1983
+ }
1984
+ interface GroupByValueResults {
1985
+ /** List of value aggregations */
1986
+ results?: NestedValueAggregationResult[];
1987
+ }
1988
+ interface DateHistogramResults {
1989
+ /** List of date histogram aggregations */
1990
+ results?: DateHistogramResult[];
1991
+ }
1992
+ /**
1993
+ * Results of `NESTED` aggregation type in a flattened form
1994
+ * aggregations in resulting array are keyed by requested aggregation `name`.
1995
+ */
1996
+ interface NestedResults {
1997
+ /** List of nested aggregations */
1998
+ results?: Results[];
1999
+ }
2000
+ interface AggregationResults extends AggregationResultsResultOneOf {
2001
+ /** Value aggregation results */
2002
+ values?: ValueResults;
2003
+ /** Range aggregation results */
2004
+ ranges?: RangeResults;
2005
+ /** Scalar aggregation results */
2006
+ scalar?: AggregationResultsScalarResult;
2007
+ /** Group by value aggregation results */
2008
+ groupedByValue?: GroupByValueResults;
2009
+ /** Date histogram aggregation results */
2010
+ dateHistogram?: DateHistogramResults;
2011
+ /** Nested aggregation results */
2012
+ nested?: NestedResults;
2013
+ /** User-defined name of aggregation as derived from search request */
2014
+ name?: string;
2015
+ /** Type of aggregation that must match provided kind as derived from search request */
2016
+ type?: AggregationType;
2017
+ /** Field to aggregate by as derived from search request */
2018
+ fieldPath?: string;
2019
+ }
2020
+ /** @oneof */
2021
+ interface AggregationResultsResultOneOf {
2022
+ /** Value aggregation results */
2023
+ values?: ValueResults;
2024
+ /** Range aggregation results */
2025
+ ranges?: RangeResults;
2026
+ /** Scalar aggregation results */
2027
+ scalar?: AggregationResultsScalarResult;
2028
+ /** Group by value aggregation results */
2029
+ groupedByValue?: GroupByValueResults;
2030
+ /** Date histogram aggregation results */
2031
+ dateHistogram?: DateHistogramResults;
2032
+ /** Nested aggregation results */
2033
+ nested?: NestedResults;
2034
+ }
2035
+ interface DeprecatedSearchCategoriesWithOffsetRequest {
2036
+ /** WQL query expression. */
2037
+ search?: PlatformOffsetSearch;
2038
+ /** A reference to the tree that contains this category. */
2039
+ treeReference?: TreeReference;
2040
+ /** Whether to return categories with `visible:false`. Default: false so only visible categories will be in response. */
2041
+ returnNonVisibleCategories?: boolean;
2042
+ /** Fields to return in the response. When not provided, these fields are not returned. */
2043
+ fields?: RequestedFields[];
2044
+ }
2045
+ interface PlatformOffsetSearch extends PlatformOffsetSearchPagingMethodOneOf {
2046
+ /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
2047
+ paging?: PlatformPaging;
2048
+ /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
2049
+ filter?: Record<string, any> | null;
2050
+ /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
2051
+ sort?: CommonSorting[];
2052
+ /** Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. */
2053
+ aggregations?: CommonAggregation[];
2054
+ /** free text to match in searchable fields */
2055
+ search?: CommonSearchDetails;
2056
+ }
2057
+ /** @oneof */
2058
+ interface PlatformOffsetSearchPagingMethodOneOf {
2059
+ /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
2060
+ paging?: PlatformPaging;
2061
+ }
2062
+ interface CommonSorting {
2063
+ /** Name of the field to sort by. */
2064
+ fieldName?: string;
2065
+ /** Sort order. */
2066
+ order?: CommonSortOrder;
2067
+ }
2068
+ declare enum CommonSortOrder {
2069
+ ASC = "ASC",
2070
+ DESC = "DESC"
2071
+ }
2072
+ interface CommonAggregation extends CommonAggregationKindOneOf {
2073
+ /** Value aggregation */
2074
+ value?: AggregationValueAggregation;
2075
+ /** Range aggregation */
2076
+ range?: AggregationRangeAggregation;
2077
+ /** Scalar aggregation */
2078
+ scalar?: AggregationScalarAggregation;
2079
+ /** Date histogram aggregation */
2080
+ dateHistogram?: AggregationDateHistogramAggregation;
2081
+ /** Nested aggregation */
2082
+ nested?: AggregationNestedAggregation;
2083
+ /** User-defined name of aggregation, should be unique, will appear in aggregation results */
2084
+ name?: string | null;
2085
+ /** Type of aggregation, client must provide matching aggregation field below */
2086
+ type?: CommonAggregationType;
2087
+ /** Field to aggregate by, use dot notation to specify json path */
2088
+ fieldPath?: string;
2089
+ /**
2090
+ * deprecated, use `nested` instead
2091
+ * @deprecated deprecated, use `nested` instead
2092
+ * @replacedBy kind.nested
2093
+ * @targetRemovalDate 2024-03-30
2094
+ */
2095
+ groupBy?: GroupByAggregation;
2096
+ }
2097
+ /** @oneof */
2098
+ interface CommonAggregationKindOneOf {
2099
+ /** Value aggregation */
2100
+ value?: AggregationValueAggregation;
2101
+ /** Range aggregation */
2102
+ range?: AggregationRangeAggregation;
2103
+ /** Scalar aggregation */
2104
+ scalar?: AggregationScalarAggregation;
2105
+ /** Date histogram aggregation */
2106
+ dateHistogram?: AggregationDateHistogramAggregation;
2107
+ /** Nested aggregation */
2108
+ nested?: AggregationNestedAggregation;
2109
+ }
2110
+ interface RangeAggregationRangeBucket {
2111
+ /** Inclusive lower bound of the range. Required if to is not given */
2112
+ from?: number | null;
2113
+ /** Exclusive upper bound of the range. Required if from is not given */
2114
+ to?: number | null;
2115
+ }
2116
+ declare enum ValueAggregationSortType {
2117
+ /** Should sort by number of matches */
2118
+ COUNT = "COUNT",
2119
+ /** Should sort by value of the field alphabetically */
2120
+ VALUE = "VALUE"
2121
+ }
2122
+ declare enum ValueAggregationSortDirection {
2123
+ /** Should sort in descending order */
2124
+ DESC = "DESC",
2125
+ /** Should sort in ascending order */
2126
+ ASC = "ASC"
2127
+ }
2128
+ declare enum ValueAggregationMissingValues {
2129
+ /** Should missing values be excluded from the aggregation results */
2130
+ EXCLUDE = "EXCLUDE",
2131
+ /** Should missing values be included in the aggregation results */
2132
+ INCLUDE = "INCLUDE"
2133
+ }
2134
+ interface ValueAggregationIncludeMissingValuesOptions {
2135
+ /** Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
2136
+ addToBucket?: string;
2137
+ }
2138
+ declare enum CommonScalarType {
2139
+ UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
2140
+ /** Count of distinct values */
2141
+ COUNT_DISTINCT = "COUNT_DISTINCT",
2142
+ /** Minimum value */
2143
+ MIN = "MIN",
2144
+ /** Maximum value */
2145
+ MAX = "MAX",
2146
+ /** Sum of values */
2147
+ SUM = "SUM",
2148
+ /** Average of values */
2149
+ AVG = "AVG"
2150
+ }
2151
+ interface AggregationValueAggregation extends AggregationValueAggregationOptionsOneOf {
2152
+ /** Options for including missing values */
2153
+ includeOptions?: ValueAggregationIncludeMissingValuesOptions;
2154
+ /** Should sort by number of matches or value of the field */
2155
+ sortType?: ValueAggregationSortType;
2156
+ /** Should sort in ascending or descending order */
2157
+ sortDirection?: ValueAggregationSortDirection;
2158
+ /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
2159
+ limit?: number | null;
2160
+ /** Should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
2161
+ missingValues?: ValueAggregationMissingValues;
2162
+ }
2163
+ /** @oneof */
2164
+ interface AggregationValueAggregationOptionsOneOf {
2165
+ /** Options for including missing values */
2166
+ includeOptions?: ValueAggregationIncludeMissingValuesOptions;
2167
+ }
2168
+ declare enum NestedAggregationNestedAggregationType {
2169
+ UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
2170
+ /** An aggregation where result buckets are dynamically built - one per unique value */
2171
+ VALUE = "VALUE",
2172
+ /** An aggregation, where user can define set of ranges - each representing a bucket */
2173
+ RANGE = "RANGE",
2174
+ /** A single-value metric aggregation - e.g. min, max, sum, avg */
2175
+ SCALAR = "SCALAR",
2176
+ /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
2177
+ DATE_HISTOGRAM = "DATE_HISTOGRAM"
2178
+ }
2179
+ interface AggregationRangeAggregation {
2180
+ /** List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds */
2181
+ buckets?: RangeAggregationRangeBucket[];
2182
+ }
2183
+ interface AggregationScalarAggregation {
2184
+ /** Define the operator for the scalar aggregation */
2185
+ type?: CommonScalarType;
2186
+ }
2187
+ interface AggregationDateHistogramAggregation {
2188
+ /** Interval for date histogram aggregation */
2189
+ interval?: DateHistogramAggregationInterval;
2190
+ }
2191
+ declare enum DateHistogramAggregationInterval {
2192
+ UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
2193
+ /** Yearly interval */
2194
+ YEAR = "YEAR",
2195
+ /** Monthly interval */
2196
+ MONTH = "MONTH",
2197
+ /** Weekly interval */
2198
+ WEEK = "WEEK",
2199
+ /** Daily interval */
2200
+ DAY = "DAY",
2201
+ /** Hourly interval */
2202
+ HOUR = "HOUR",
2203
+ /** Minute interval */
2204
+ MINUTE = "MINUTE",
2205
+ /** Second interval */
2206
+ SECOND = "SECOND"
2207
+ }
2208
+ interface NestedAggregationNestedAggregationItem extends NestedAggregationNestedAggregationItemKindOneOf {
2209
+ /** Value aggregation */
2210
+ value?: AggregationValueAggregation;
2211
+ /** Range aggregation */
2212
+ range?: AggregationRangeAggregation;
2213
+ /** Scalar aggregation */
2214
+ scalar?: AggregationScalarAggregation;
2215
+ /** Date histogram aggregation */
2216
+ dateHistogram?: AggregationDateHistogramAggregation;
2217
+ /** User-defined name of aggregation, should be unique, will appear in aggregation results */
2218
+ name?: string | null;
2219
+ /** Type of aggregation, client must provide matching aggregation field below */
2220
+ type?: NestedAggregationNestedAggregationType;
2221
+ /** Field to aggregate by, use dont notation to specify json path */
2222
+ fieldPath?: string;
2223
+ }
2224
+ /** @oneof */
2225
+ interface NestedAggregationNestedAggregationItemKindOneOf {
2226
+ /** Value aggregation */
2227
+ value?: AggregationValueAggregation;
2228
+ /** Range aggregation */
2229
+ range?: AggregationRangeAggregation;
2230
+ /** Scalar aggregation */
2231
+ scalar?: AggregationScalarAggregation;
2232
+ /** Date histogram aggregation */
2233
+ dateHistogram?: AggregationDateHistogramAggregation;
2234
+ }
2235
+ declare enum CommonAggregationType {
2236
+ UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
2237
+ /** An aggregation where result buckets are dynamically built - one per unique value */
2238
+ VALUE = "VALUE",
2239
+ /** An aggregation, where user can define set of ranges - each representing a bucket */
2240
+ RANGE = "RANGE",
2241
+ /** A single-value metric aggregation - e.g. min, max, sum, avg */
2242
+ SCALAR = "SCALAR",
2243
+ /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
2244
+ DATE_HISTOGRAM = "DATE_HISTOGRAM",
2245
+ /** Multi-level aggregation, where each next aggregation is nested within previous one */
2246
+ NESTED = "NESTED"
2247
+ }
2248
+ /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
2249
+ interface AggregationNestedAggregation {
2250
+ /** Flattened list of aggregations, where each next aggregation is nested within previous one */
2251
+ nestedAggregations?: NestedAggregationNestedAggregationItem[];
2252
+ }
2253
+ interface GroupByAggregation extends GroupByAggregationKindOneOf {
2254
+ /** Value aggregation configuration */
2255
+ value?: AggregationValueAggregation;
2256
+ /** User-defined name of aggregation, should be unique, will appear in aggregation results */
2257
+ name?: string | null;
2258
+ /** Field to aggregate by */
2259
+ fieldPath?: string;
2260
+ }
2261
+ /** @oneof */
2262
+ interface GroupByAggregationKindOneOf {
2263
+ /** Value aggregation configuration */
2264
+ value?: AggregationValueAggregation;
2265
+ }
2266
+ interface CommonSearchDetails {
2267
+ /** Defines how separate search terms in `expression` are combined */
2268
+ mode?: SearchDetailsMode;
2269
+ /** Search term or expression */
2270
+ expression?: string | null;
2271
+ /** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path */
2272
+ fields?: string[];
2273
+ /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
2274
+ fuzzy?: boolean;
2275
+ }
2276
+ declare enum SearchDetailsMode {
2277
+ /** Any of the search terms must be present */
2278
+ OR = "OR",
2279
+ /** All search terms must be present */
2280
+ AND = "AND"
2281
+ }
2282
+ interface PlatformPaging {
2283
+ /** Number of items to load. */
2284
+ limit?: number | null;
2285
+ /** Number of items to skip in the current sort order. */
2286
+ offset?: number | null;
2287
+ }
2288
+ interface DeprecatedSearchCategoriesWithOffsetResponse {
2289
+ /** Categories which satisfy the provided query. */
2290
+ categories?: Category[];
2291
+ /** Paging metadata. */
2292
+ pagingMetadata?: PagingMetadata;
2293
+ /** Aggregation data. */
2294
+ aggregationData?: AggregationData;
2295
+ }
2296
+ interface PagingMetadata {
2297
+ /** Number of items returned in the response. */
2298
+ count?: number | null;
2299
+ /** Offset that was requested. */
2300
+ offset?: number | null;
2301
+ /** Total number of items that match the query. */
2302
+ total?: number | null;
2303
+ /** Flag that indicates the server failed to calculate the `total` field. */
2304
+ tooManyToCount?: boolean | null;
2305
+ }
2306
+ interface CountCategoriesRequest {
2307
+ /**
2308
+ * A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf)
2309
+ * To understand supported filters and limitations see `SearchCategories` method.
2310
+ */
2311
+ filter?: Record<string, any> | null;
2312
+ /** free text to match in searchable fields */
2313
+ search?: SearchDetails;
2314
+ /**
2315
+ * A reference to the tree that contains this category.
2316
+ * Used only in the first request. Following requests use the cursor token.
2317
+ */
2318
+ treeReference: TreeReference;
2319
+ /**
2320
+ * Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
2321
+ * Used only in the first request. Following requests use the cursor token.
2322
+ */
2323
+ returnNonVisibleCategories?: boolean;
2324
+ }
2325
+ interface CountCategoriesResponse {
2326
+ /** Total count of categories which satisfy the provided request. */
2327
+ count?: number;
2328
+ }
2329
+ interface MoveCategoryRequest {
2330
+ /** ID of category to place. */
2331
+ categoryId: string;
2332
+ /** A reference to the tree that contains this category. */
2333
+ treeReference: TreeReference;
2334
+ /**
2335
+ * ID of parent category.
2336
+ * Optional. When not passed it will fallback to the root category
2337
+ */
2338
+ parentCategoryId?: string | null;
2339
+ /**
2340
+ * Where to place the subcategory.
2341
+ * `FIRST` - make category with `category_id` first subcategory with manual arrangement.
2342
+ * `LAST` - make category with `category_id` last subcategory with manual arrangement.
2343
+ * `BEFORE` - requires `move_before_category_id`, category with `category_id` will be moved before it.
2344
+ */
2345
+ position: Position;
2346
+ /** Required when `position` is `BEFORE`. Otherwise ignored */
2347
+ moveBeforeCategoryId?: string | null;
2348
+ }
2349
+ declare enum Position {
2350
+ UNKNOWN_POSITION = "UNKNOWN_POSITION",
2351
+ FIRST = "FIRST",
2352
+ LAST = "LAST",
2353
+ BEFORE = "BEFORE"
2354
+ }
2355
+ interface MoveCategoryResponse {
2356
+ /** ID of parent category. */
2357
+ parentCategoryId?: string | null;
2358
+ /** Information about manually arranged categories after move. */
2359
+ categoriesAfterMove?: string[];
2360
+ }
2361
+ interface CategoryMoved {
2362
+ /** Category ID. */
2363
+ categoryId?: string;
2364
+ /** ID of parent category and index. */
2365
+ parentCategory?: ParentCategory;
2366
+ /** A reference to the tree that contains this category. */
2367
+ treeReference?: TreeReference;
2368
+ }
2369
+ interface BulkCreateCategoriesRequest {
2370
+ /** List of categories to be created. */
2371
+ categories?: Category[];
2372
+ /** A reference to the tree that contains the categories. */
2373
+ treeReference?: TreeReference;
2374
+ /** Whether to return the category entity in the response. */
2375
+ returnEntity?: boolean;
2376
+ /** Fields to return in the response. When not provided, these fields are not returned. */
2377
+ fields?: RequestedFields[];
2378
+ }
2379
+ interface BulkCreateCategoriesResponse {
2380
+ /** Categories created by bulk action. */
2381
+ results?: BulkCategoriesResult[];
2382
+ /** Bulk action metadata. */
2383
+ bulkActionMetadata?: BulkActionMetadata;
2384
+ }
2385
+ interface BulkCategoriesResult {
2386
+ /** Information about successful action or error for failure. */
2387
+ itemMetadata?: ItemMetadata;
2388
+ /** Created or updated category. Optional - returned only if requested with `return_entity` set to `true`. */
2389
+ category?: Category;
2390
+ }
2391
+ interface ItemMetadata {
2392
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
2393
+ _id?: string | null;
2394
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
2395
+ originalIndex?: number;
2396
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
2397
+ success?: boolean;
2398
+ /** Details about the error in case of failure. */
2399
+ error?: ApplicationError;
2400
+ }
2401
+ interface ApplicationError {
2402
+ /** Error code. */
2403
+ code?: string;
2404
+ /** Description of the error. */
2405
+ description?: string;
2406
+ /** Data related to the error. */
2407
+ data?: Record<string, any> | null;
2408
+ }
2409
+ interface BulkActionMetadata {
2410
+ /** Number of items that were successfully processed. */
2411
+ totalSuccesses?: number;
2412
+ /** Number of items that couldn't be processed. */
2413
+ totalFailures?: number;
2414
+ /** Number of failures without details because detailed failure threshold was exceeded. */
2415
+ undetailedFailures?: number;
2416
+ }
2417
+ interface BulkUpdateCategoriesRequest {
2418
+ /** List of categories to be updated. */
2419
+ categories: MaskedCategory[];
2420
+ /** A reference to the tree that contains the categories. */
2421
+ treeReference: TreeReference;
2422
+ /** Whether to return the category entity in the response. */
2423
+ returnEntity?: boolean;
2424
+ /** Fields to return in the response. When not provided, these fields are not returned. */
2425
+ fields?: RequestedFields[];
2426
+ }
2427
+ interface MaskedCategory {
2428
+ /** Category to be updated, may be partial. */
2429
+ category?: Category;
2430
+ }
2431
+ interface BulkUpdateCategoriesResponse {
2432
+ /** Categories updated by bulk action. */
2433
+ results?: BulkCategoriesResult[];
2434
+ /** Bulk action metadata. */
2435
+ bulkActionMetadata?: BulkActionMetadata;
2436
+ }
2437
+ interface UpdateCategoryVisibilityRequest {
2438
+ /** ID of category to be updated */
2439
+ categoryId: string;
2440
+ /** value to set `visible` to */
2441
+ visible: boolean;
2442
+ /** A reference to the tree that contains this category. */
2443
+ treeReference: TreeReference;
2444
+ /** Latest revision of the category. */
2445
+ revision: string | null;
2446
+ /** Fields to return in the response. When not provided, these fields are not returned. */
2447
+ fields?: RequestedFields[];
2448
+ }
2449
+ interface UpdateCategoryVisibilityResponse {
2450
+ /** The updated Category. */
2451
+ category?: Category;
2452
+ }
2453
+ interface BulkUpdateCategoryVisibilityRequest {
2454
+ /** IDs of categories to be updated. */
2455
+ categoryIds?: string[];
2456
+ /** value to set `visible` to. This value will be set for all categories in the request */
2457
+ visible?: boolean;
2458
+ /** A reference to the tree that contains this category. */
2459
+ treeReference?: TreeReference;
2460
+ /** Whether to return the category entity in the response. */
2461
+ returnEntity?: boolean;
2462
+ /** Fields to return in the response. When not provided, these fields are not returned. */
2463
+ fields?: RequestedFields[];
2464
+ }
2465
+ interface BulkUpdateCategoryVisibilityResponse {
2466
+ /** Categories updated by bulk action. */
2467
+ results?: BulkCategoriesResult[];
2468
+ /** Bulk action metadata. */
2469
+ bulkActionMetadata?: BulkActionMetadata;
2470
+ }
2471
+ interface BulkUpdateCategoryVisibilityByFilterRequest {
2472
+ /**
2473
+ * Filter object in the following format:
2474
+ * `"filter" : {
2475
+ * "fieldName1": "value1",
2476
+ * "fieldName2":{"$operator":"value2"}
2477
+ * }`
2478
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2479
+ */
2480
+ filter?: Record<string, any> | null;
2481
+ /** A reference to the tree that contains the categories. */
2482
+ treeReference?: TreeReference;
2483
+ /** value to set `visible` to. This value will be set for all categories that match the filter */
2484
+ visible?: boolean;
2485
+ }
2486
+ interface BulkUpdateCategoryVisibilityByFilterResponse {
2487
+ /** Token that can be used to query "AsyncJobService" */
2488
+ jobId?: string;
2489
+ }
2490
+ interface BulkDeleteCategoriesRequest {
2491
+ /** IDs of categories to be deleted. */
2492
+ categoryIds?: string[];
2493
+ /** Fields to return in the response. When not provided, these fields are not returned. */
2494
+ fields?: RequestedFields[];
2495
+ }
2496
+ interface BulkDeleteCategoriesResponse {
2497
+ /** Categories deleted by bulk action. */
2498
+ results?: BulkDeleteCategoriesResponseBulkCategoriesResult[];
2499
+ /** Bulk action metadata. */
2500
+ bulkActionMetadata?: BulkActionMetadata;
2501
+ }
2502
+ interface BulkDeleteCategoriesResponseBulkCategoriesResult {
2503
+ /** Information about successful action or error for failure. */
2504
+ itemMetadata?: ItemMetadata;
2505
+ }
2506
+ interface BulkDeleteCategoriesByFilterRequest {
2507
+ /**
2508
+ * Filter object in the following format:
2509
+ * `"filter" : {
2510
+ * "fieldName1": "value1",
2511
+ * "fieldName2":{"$operator":"value2"}
2512
+ * }`
2513
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2514
+ */
2515
+ filter?: Record<string, any> | null;
2516
+ /** A reference to the tree that contains the categories. */
2517
+ treeReference?: TreeReference;
2518
+ }
2519
+ interface BulkDeleteCategoriesByFilterResponse {
2520
+ /** Token that can be used to query "AsyncJobService" */
2521
+ jobId?: string;
2522
+ }
2523
+ interface BulkAddItemsToCategoryRequest {
2524
+ /** Category id. */
2525
+ categoryId: string;
2526
+ /** List of catalog items with reference info. */
2527
+ items: ItemReference[];
2528
+ /** A reference to the tree that contains this category. */
2529
+ treeReference: TreeReference;
2530
+ }
2531
+ interface ItemReference {
2532
+ /** ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores or `eventId` for Wix Events. */
2533
+ catalogItemId?: string;
2534
+ /** ID of the catalog app. For example, the Wix Stores `appId`, or the 3rd-party `appId`. */
2535
+ appId?: string;
2536
+ }
2537
+ interface BulkAddItemsToCategoryResponse {
2538
+ /** Items added by bulk action. */
2539
+ results?: BulkItemsToCategoryResult[];
2540
+ /** Bulk action metadata. */
2541
+ bulkActionMetadata?: BulkActionMetadata;
2542
+ }
2543
+ interface BulkItemsToCategoryResult {
2544
+ /** Information about items that were added successfully and errors for failed items. */
2545
+ itemMetadata?: ItemReferenceMetadata;
2546
+ }
2547
+ interface ItemReferenceMetadata {
2548
+ /** Item reference from request. */
2549
+ item?: ItemReference;
2550
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
2551
+ originalIndex?: number;
2552
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
2553
+ success?: boolean;
2554
+ /** Details about the error in case of failure. */
2555
+ error?: ApplicationError;
2556
+ }
2557
+ interface ItemAddedToCategory {
2558
+ /** Category ID. */
2559
+ categoryId?: string;
2560
+ /** Catalog item reference info. */
2561
+ addedItem?: ItemReference;
2562
+ /** A reference to the tree that contains this category. */
2563
+ treeReference?: TreeReference;
2564
+ }
2565
+ interface ItemsAddedToCategory {
2566
+ /** Category ID. */
2567
+ categoryId?: string;
2568
+ /** List of catalog items with reference info. */
2569
+ addedItems?: ItemReference[];
2570
+ /** A reference to the tree that contains this category. */
2571
+ treeReference?: TreeReference;
2572
+ }
2573
+ interface BulkAddItemToCategoriesRequest {
2574
+ /** Catalog item reference info */
2575
+ item: ItemReference;
2576
+ /** Category ids. */
2577
+ categoryIds: string[];
2578
+ /** A reference to the tree that contains the categories. */
2579
+ treeReference: TreeReference;
2580
+ }
2581
+ interface BulkAddItemToCategoriesResponse {
2582
+ /** Items added by bulk action. */
2583
+ results?: BulkItemToCategoriesResult[];
2584
+ /** Bulk action metadata. */
2585
+ bulkActionMetadata?: BulkActionMetadata;
2586
+ }
2587
+ interface BulkItemToCategoriesResult {
2588
+ /** Information about categories to which item was added successfully and errors for failed items. `id` is ID of category. */
2589
+ itemMetadata?: ItemMetadata;
2590
+ }
2591
+ interface BulkRemoveItemsFromCategoryRequest {
2592
+ /** Category id */
2593
+ categoryId: string;
2594
+ /** List of catalog items with reference info. */
2595
+ items: ItemReference[];
2596
+ /** A reference to the tree that contains this category. */
2597
+ treeReference: TreeReference;
2598
+ }
2599
+ interface BulkRemoveItemsFromCategoryResponse {
2600
+ /** Items removed by bulk action. */
2601
+ results?: BulkItemsToCategoryResult[];
2602
+ /** Bulk action metadata. */
2603
+ bulkActionMetadata?: BulkActionMetadata;
2604
+ }
2605
+ interface ItemRemovedFromCategory {
2606
+ /** Category ID. */
2607
+ categoryId?: string;
2608
+ /** Catalog item reference info. */
2609
+ removedItem?: ItemReference;
2610
+ /** A reference to the tree that contains this category. */
2611
+ treeReference?: TreeReference;
2612
+ }
2613
+ interface ItemsRemovedFromCategory {
2614
+ /** Category ID. */
2615
+ categoryId?: string;
2616
+ /** List of catalog items with reference info. */
2617
+ removedItems?: ItemReference[];
2618
+ /** A reference to the tree that contains this category. */
2619
+ treeReference?: TreeReference;
2620
+ }
2621
+ interface BulkRemoveItemFromCategoriesRequest {
2622
+ /** Catalog item reference info */
2623
+ item: ItemReference;
2624
+ /** Category ids. */
2625
+ categoryIds: string[];
2626
+ /** A reference to the tree that contains the categories. */
2627
+ treeReference: TreeReference;
2628
+ }
2629
+ interface BulkRemoveItemFromCategoriesResponse {
2630
+ /** Items removed by bulk action. */
2631
+ results?: BulkItemToCategoriesResult[];
2632
+ /** Bulk action metadata. */
2633
+ bulkActionMetadata?: BulkActionMetadata;
2634
+ }
2635
+ interface ListItemsInCategoryRequest extends ListItemsInCategoryRequestPagingMethodOneOf {
2636
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `use_category_arrangement` or `include_items_from_subcategories`. */
2637
+ cursorPaging?: CursorPaging;
2638
+ /** ID of category containing items. */
2639
+ categoryId: string;
2640
+ /** A reference to the tree that contains this category. */
2641
+ treeReference: TreeReference;
2642
+ /** Default: `false`. When `true` items arranged by user will be return before all other items. */
2643
+ useCategoryArrangement?: boolean;
2644
+ /** Default: `false`. When `false` only direct items of category will be returned. When `true` response contains also items from all subcategories which current category contains */
2645
+ includeItemsFromSubcategories?: boolean;
2646
+ }
2647
+ /** @oneof */
2648
+ interface ListItemsInCategoryRequestPagingMethodOneOf {
2649
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `use_category_arrangement` or `include_items_from_subcategories`. */
2650
+ cursorPaging?: CursorPaging;
2651
+ }
2652
+ interface ListItemsInCategoryResponse {
2653
+ /** Items which satisfy query. */
2654
+ items?: ItemReference[];
2655
+ /** Paging metadata. Contains cursor which can be used in next query. */
2656
+ pagingMetadata?: PagingMetadataV2;
2657
+ }
2658
+ interface PagingMetadataV2 {
2659
+ /** Number of items returned in the response. */
2660
+ count?: number | null;
2661
+ /** Offset that was requested. */
2662
+ offset?: number | null;
2663
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
2664
+ total?: number | null;
2665
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
2666
+ cursors?: Cursors;
2667
+ }
2668
+ interface ListCategoriesForItemRequest {
2669
+ /** Catalog item reference info. */
2670
+ item: ItemReference;
2671
+ /** A reference to the tree that contains the categories. */
2672
+ treeReference: TreeReference;
2673
+ }
2674
+ interface ListCategoriesForItemResponse {
2675
+ /** A list of category IDs that contain this item directly. */
2676
+ directCategoryIds?: string[];
2677
+ /** A list of category IDs that contain this item directly and their parent category IDs. */
2678
+ allCategoryIds?: string[];
2679
+ }
2680
+ interface ListTreesRequest {
2681
+ }
2682
+ interface ListTreesResponse {
2683
+ /** A list of all trees */
2684
+ trees?: TreeReference[];
2685
+ }
2686
+ interface MoveItemInCategoryRequest {
2687
+ /**
2688
+ * ID of category.
2689
+ * Item must be direct child of this category, otherwise error returned
2690
+ */
2691
+ categoryId?: string;
2692
+ /** A reference to the tree that contains this category. */
2693
+ treeReference?: TreeReference;
2694
+ /** Item to move. */
2695
+ item?: ItemReference;
2696
+ /**
2697
+ * Where to move item.
2698
+ * `FIRST` - make `item` first item with manual arrangement. If before this operation category already has 100 manually arranged items, the 100th item will be removed from list of items with manual arrangement.
2699
+ * `LAST` - make `item` last item with manual arrangement. If before this operation category already has 100 manually arranged items, moving item will be not last but 100th.
2700
+ * `BEFORE` - requires `before_item`, `item` will be moved before it. If `before_item` was 100th item in category it will be removed from list of items with manual arrangement.
2701
+ * `NONE` - don't use manual arrangement for `item`, it will be shown after all items with manual arrangement according to default sorting.
2702
+ */
2703
+ position?: MoveItemInCategoryRequestPosition;
2704
+ /** Required when `position` is `BEFORE`. `before_item` must be manually arranged item. */
2705
+ beforeItem?: ItemReference;
2706
+ }
2707
+ declare enum MoveItemInCategoryRequestPosition {
2708
+ UNKNOWN_POSITION = "UNKNOWN_POSITION",
2709
+ FIRST = "FIRST",
2710
+ LAST = "LAST",
2711
+ BEFORE = "BEFORE",
2712
+ NONE = "NONE"
2713
+ }
2714
+ interface MoveItemInCategoryResponse {
2715
+ /** Information about manually arranged items after move. */
2716
+ itemsAfterMove?: ItemReference[];
2717
+ }
2718
+ interface ItemsArrangedInCategory {
2719
+ /** Category ID. */
2720
+ categoryId?: string;
2721
+ /** A reference to the tree that contains this category. */
2722
+ treeReference?: TreeReference;
2723
+ }
2724
+ interface SetArrangedItemsRequest {
2725
+ /** ID of category. */
2726
+ categoryId: string;
2727
+ /** A reference to the tree that contains this category. */
2728
+ treeReference: TreeReference;
2729
+ /**
2730
+ * List of arranged items to set.
2731
+ * All items must be direct children of category with `category_id`, otherwise error returned.
2732
+ */
2733
+ items?: ItemReference[];
2734
+ }
2735
+ interface SetArrangedItemsResponse {
2736
+ /** The updated list of arranged items in category. */
2737
+ items?: ItemReference[];
2738
+ }
2739
+ interface GetArrangedItemsRequest {
2740
+ /** ID of category. */
2741
+ categoryId: string;
2742
+ /** A reference to the tree that contains this category. */
2743
+ treeReference: TreeReference;
2744
+ }
2745
+ interface GetArrangedItemsResponse {
2746
+ /** List of arranged items in category. */
2747
+ items?: ItemReference[];
2748
+ }
2749
+ interface GetCategoriesTreeRequest {
2750
+ /** A reference to the tree. */
2751
+ treeReference?: TreeReference;
2752
+ }
2753
+ interface GetCategoriesTreeResponse {
2754
+ /** Categories tree. */
2755
+ categoriesTree?: CategoryTreeNode[];
2756
+ }
2757
+ /** Represents a node in the view of categories tree */
2758
+ interface CategoryTreeNode {
2759
+ /** Category ID. */
2760
+ _id?: Uint8Array;
2761
+ /** A list of child categories. */
2762
+ subcategories?: CategoryTreeNode[];
2763
+ }
2764
+ interface DomainEvent extends DomainEventBodyOneOf {
2765
+ createdEvent?: EntityCreatedEvent;
2766
+ updatedEvent?: EntityUpdatedEvent;
2767
+ deletedEvent?: EntityDeletedEvent;
2768
+ actionEvent?: ActionEvent;
2769
+ /**
2770
+ * Unique event ID.
2771
+ * Allows clients to ignore duplicate webhooks.
2772
+ */
2773
+ _id?: string;
2774
+ /**
2775
+ * Assumes actions are also always typed to an entity_type
2776
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
2777
+ */
2778
+ entityFqdn?: string;
2779
+ /**
2780
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
2781
+ * This is although the created/updated/deleted notion is duplication of the oneof types
2782
+ * Example: created/updated/deleted/started/completed/email_opened
2783
+ */
2784
+ slug?: string;
2785
+ /** ID of the entity associated with the event. */
2786
+ entityId?: string;
2787
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
2788
+ eventTime?: Date;
2789
+ /**
2790
+ * Whether the event was triggered as a result of a privacy regulation application
2791
+ * (for example, GDPR).
2792
+ */
2793
+ triggeredByAnonymizeRequest?: boolean | null;
2794
+ /** If present, indicates the action that triggered the event. */
2795
+ originatedFrom?: string | null;
2796
+ /**
2797
+ * A sequence number defining the order of updates to the underlying entity.
2798
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
2799
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
2800
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
2801
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
2802
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
2803
+ */
2804
+ entityEventSequence?: string | null;
2805
+ }
2806
+ /** @oneof */
2807
+ interface DomainEventBodyOneOf {
2808
+ createdEvent?: EntityCreatedEvent;
2809
+ updatedEvent?: EntityUpdatedEvent;
2810
+ deletedEvent?: EntityDeletedEvent;
2811
+ actionEvent?: ActionEvent;
2812
+ }
2813
+ interface EntityCreatedEvent {
2814
+ entity?: string;
2815
+ }
2816
+ interface RestoreInfo {
2817
+ deletedDate?: Date;
2818
+ }
2819
+ interface EntityUpdatedEvent {
2820
+ /**
2821
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2822
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2823
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2824
+ */
2825
+ currentEntity?: string;
2826
+ }
2827
+ interface EntityDeletedEvent {
2828
+ /** Entity that was deleted */
2829
+ deletedEntity?: string | null;
2830
+ }
2831
+ interface ActionEvent {
2832
+ body?: string;
2833
+ }
2834
+ interface Empty {
2835
+ }
2836
+ interface MessageEnvelope {
2837
+ /** App instance ID. */
2838
+ instanceId?: string | null;
2839
+ /** Event type. */
2840
+ eventType?: string;
2841
+ /** The identification type and identity data. */
2842
+ identity?: IdentificationData;
2843
+ /** Stringify payload. */
2844
+ data?: string;
2845
+ }
2846
+ interface IdentificationData extends IdentificationDataIdOneOf {
2847
+ /** ID of a site visitor that has not logged in to the site. */
2848
+ anonymousVisitorId?: string;
2849
+ /** ID of a site visitor that has logged in to the site. */
2850
+ memberId?: string;
2851
+ /** ID of a Wix user (site owner, contributor, etc.). */
2852
+ wixUserId?: string;
2853
+ /** ID of an app. */
2854
+ appId?: string;
2855
+ /** @readonly */
2856
+ identityType?: WebhookIdentityType;
2857
+ }
2858
+ /** @oneof */
2859
+ interface IdentificationDataIdOneOf {
2860
+ /** ID of a site visitor that has not logged in to the site. */
2861
+ anonymousVisitorId?: string;
2862
+ /** ID of a site visitor that has logged in to the site. */
2863
+ memberId?: string;
2864
+ /** ID of a Wix user (site owner, contributor, etc.). */
2865
+ wixUserId?: string;
2866
+ /** ID of an app. */
2867
+ appId?: string;
2868
+ }
2869
+ declare enum WebhookIdentityType {
2870
+ UNKNOWN = "UNKNOWN",
2871
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2872
+ MEMBER = "MEMBER",
2873
+ WIX_USER = "WIX_USER",
2874
+ APP = "APP"
2875
+ }
2876
+ interface BreadcrumbItemNonNullableFields {
2877
+ categoryId: string;
2878
+ categoryName: string;
2879
+ categorySlug: string;
2880
+ }
2881
+ interface BreadcrumbItemValuesNonNullableFields {
2882
+ values: BreadcrumbItemNonNullableFields[];
2883
+ }
2884
+ interface TagNonNullableFields {
2885
+ type: string;
2886
+ children: string;
2887
+ custom: boolean;
2888
+ disabled: boolean;
2889
+ }
2890
+ interface KeywordNonNullableFields {
2891
+ term: string;
2892
+ isMain: boolean;
2893
+ }
2894
+ interface SettingsNonNullableFields {
2895
+ preventAutoRedirect: boolean;
2896
+ keywords: KeywordNonNullableFields[];
2897
+ }
2898
+ interface SeoSchemaNonNullableFields {
2899
+ tags: TagNonNullableFields[];
2900
+ settings?: SettingsNonNullableFields;
2901
+ }
2902
+ interface PluginContainerDataWidthNonNullableFields {
2903
+ size: WidthType;
2904
+ }
2905
+ interface PluginContainerDataNonNullableFields {
2906
+ width?: PluginContainerDataWidthNonNullableFields;
2907
+ alignment: PluginContainerDataAlignment;
2908
+ }
2909
+ interface LinkNonNullableFields {
2910
+ url: string;
2911
+ anchor: string;
2912
+ target: Target;
2913
+ }
2914
+ interface ButtonDataNonNullableFields {
2915
+ containerData?: PluginContainerDataNonNullableFields;
2916
+ type: Type;
2917
+ link?: LinkNonNullableFields;
2918
+ }
2919
+ interface TextStyleNonNullableFields {
2920
+ textAlignment: TextAlignment;
2921
+ }
2922
+ interface CodeBlockDataNonNullableFields {
2923
+ textStyle?: TextStyleNonNullableFields;
2924
+ }
2925
+ interface DividerDataNonNullableFields {
2926
+ containerData?: PluginContainerDataNonNullableFields;
2927
+ lineStyle: LineStyle;
2928
+ width: Width;
2929
+ alignment: Alignment;
2930
+ }
2931
+ interface PDFSettingsNonNullableFields {
2932
+ viewMode: ViewMode;
2933
+ }
2934
+ interface FileDataNonNullableFields {
2935
+ containerData?: PluginContainerDataNonNullableFields;
2936
+ pdfSettings?: PDFSettingsNonNullableFields;
2937
+ }
2938
+ interface ImageNonNullableFields {
2939
+ link?: LinkNonNullableFields;
2940
+ }
2941
+ interface ItemNonNullableFields {
2942
+ image?: ImageNonNullableFields;
2943
+ }
2944
+ interface LayoutNonNullableFields {
2945
+ type: LayoutType;
2946
+ orientation: Orientation;
2947
+ }
2948
+ interface ItemStyleNonNullableFields {
2949
+ crop: Crop;
2950
+ }
2951
+ interface ThumbnailsNonNullableFields {
2952
+ placement: ThumbnailsAlignment;
2953
+ }
2954
+ interface GalleryOptionsNonNullableFields {
2955
+ layout?: LayoutNonNullableFields;
2956
+ item?: ItemStyleNonNullableFields;
2957
+ thumbnails?: ThumbnailsNonNullableFields;
2958
+ }
2959
+ interface GalleryDataNonNullableFields {
2960
+ containerData?: PluginContainerDataNonNullableFields;
2961
+ items: ItemNonNullableFields[];
2962
+ options?: GalleryOptionsNonNullableFields;
2963
+ }
2964
+ interface GIFDataNonNullableFields {
2965
+ containerData?: PluginContainerDataNonNullableFields;
2966
+ height: number;
2967
+ width: number;
2968
+ }
2969
+ interface HeadingDataNonNullableFields {
2970
+ level: number;
2971
+ textStyle?: TextStyleNonNullableFields;
2972
+ }
2973
+ interface HTMLDataNonNullableFields {
2974
+ url: string;
2975
+ html: string;
2976
+ containerData?: PluginContainerDataNonNullableFields;
2977
+ source: Source;
2978
+ }
2979
+ interface ImageDataNonNullableFields {
2980
+ containerData?: PluginContainerDataNonNullableFields;
2981
+ link?: LinkNonNullableFields;
2982
+ }
2983
+ interface LinkPreviewDataNonNullableFields {
2984
+ containerData?: PluginContainerDataNonNullableFields;
2985
+ link?: LinkNonNullableFields;
2986
+ }
2987
+ interface MapSettingsNonNullableFields {
2988
+ mapType: MapType;
2989
+ }
2990
+ interface MapDataNonNullableFields {
2991
+ containerData?: PluginContainerDataNonNullableFields;
2992
+ mapSettings?: MapSettingsNonNullableFields;
2993
+ }
2994
+ interface ParagraphDataNonNullableFields {
2995
+ textStyle?: TextStyleNonNullableFields;
2996
+ }
2997
+ interface PermissionsNonNullableFields {
2998
+ view: ViewRole;
2999
+ vote: VoteRole;
3000
+ }
3001
+ interface PollSettingsNonNullableFields {
3002
+ permissions?: PermissionsNonNullableFields;
3003
+ }
3004
+ interface PollNonNullableFields {
3005
+ settings?: PollSettingsNonNullableFields;
3006
+ }
3007
+ interface PollLayoutNonNullableFields {
3008
+ type: PollLayoutType;
3009
+ direction: PollLayoutDirection;
3010
+ }
3011
+ interface PollDataLayoutNonNullableFields {
3012
+ poll?: PollLayoutNonNullableFields;
3013
+ }
3014
+ interface BackgroundNonNullableFields {
3015
+ type: BackgroundType;
3016
+ }
3017
+ interface PollDesignNonNullableFields {
3018
+ background?: BackgroundNonNullableFields;
3019
+ }
3020
+ interface DesignNonNullableFields {
3021
+ poll?: PollDesignNonNullableFields;
3022
+ }
3023
+ interface PollDataNonNullableFields {
3024
+ containerData?: PluginContainerDataNonNullableFields;
3025
+ poll?: PollNonNullableFields;
3026
+ layout?: PollDataLayoutNonNullableFields;
3027
+ design?: DesignNonNullableFields;
3028
+ }
3029
+ interface AnchorDataNonNullableFields {
3030
+ anchor: string;
3031
+ }
3032
+ interface LinkDataNonNullableFields {
3033
+ link?: LinkNonNullableFields;
3034
+ }
3035
+ interface MentionDataNonNullableFields {
3036
+ name: string;
3037
+ slug: string;
3038
+ }
3039
+ interface FontSizeDataNonNullableFields {
3040
+ unit: FontType;
3041
+ }
3042
+ interface DecorationNonNullableFields {
3043
+ anchorData?: AnchorDataNonNullableFields;
3044
+ linkData?: LinkDataNonNullableFields;
3045
+ mentionData?: MentionDataNonNullableFields;
3046
+ fontSizeData?: FontSizeDataNonNullableFields;
3047
+ type: DecorationType;
3048
+ }
3049
+ interface TextDataNonNullableFields {
3050
+ text: string;
3051
+ decorations: DecorationNonNullableFields[];
3052
+ }
3053
+ interface AppEmbedDataNonNullableFields {
3054
+ type: AppType;
3055
+ }
3056
+ interface VideoDataNonNullableFields {
3057
+ containerData?: PluginContainerDataNonNullableFields;
3058
+ }
3059
+ interface EmbedDataNonNullableFields {
3060
+ containerData?: PluginContainerDataNonNullableFields;
3061
+ }
3062
+ interface CollapsibleListDataNonNullableFields {
3063
+ containerData?: PluginContainerDataNonNullableFields;
3064
+ initialExpandedItems: InitialExpandedItems;
3065
+ direction: Direction;
3066
+ }
3067
+ interface DimensionsNonNullableFields {
3068
+ colsWidthRatio: number[];
3069
+ rowsHeight: number[];
3070
+ colsMinWidth: number[];
3071
+ }
3072
+ interface TableDataNonNullableFields {
3073
+ containerData?: PluginContainerDataNonNullableFields;
3074
+ dimensions?: DimensionsNonNullableFields;
3075
+ }
3076
+ interface CellStyleNonNullableFields {
3077
+ verticalAlignment: VerticalAlignment;
3078
+ }
3079
+ interface TableCellDataNonNullableFields {
3080
+ cellStyle?: CellStyleNonNullableFields;
3081
+ }
3082
+ interface AudioDataNonNullableFields {
3083
+ containerData?: PluginContainerDataNonNullableFields;
3084
+ }
3085
+ interface OrderedListDataNonNullableFields {
3086
+ indentation: number;
3087
+ }
3088
+ interface BulletedListDataNonNullableFields {
3089
+ indentation: number;
3090
+ }
3091
+ interface BlockquoteDataNonNullableFields {
3092
+ indentation: number;
3093
+ }
3094
+ interface NodeNonNullableFields {
3095
+ buttonData?: ButtonDataNonNullableFields;
3096
+ codeBlockData?: CodeBlockDataNonNullableFields;
3097
+ dividerData?: DividerDataNonNullableFields;
3098
+ fileData?: FileDataNonNullableFields;
3099
+ galleryData?: GalleryDataNonNullableFields;
3100
+ gifData?: GIFDataNonNullableFields;
3101
+ headingData?: HeadingDataNonNullableFields;
3102
+ htmlData?: HTMLDataNonNullableFields;
3103
+ imageData?: ImageDataNonNullableFields;
3104
+ linkPreviewData?: LinkPreviewDataNonNullableFields;
3105
+ mapData?: MapDataNonNullableFields;
3106
+ paragraphData?: ParagraphDataNonNullableFields;
3107
+ pollData?: PollDataNonNullableFields;
3108
+ textData?: TextDataNonNullableFields;
3109
+ appEmbedData?: AppEmbedDataNonNullableFields;
3110
+ videoData?: VideoDataNonNullableFields;
3111
+ embedData?: EmbedDataNonNullableFields;
3112
+ collapsibleListData?: CollapsibleListDataNonNullableFields;
3113
+ tableData?: TableDataNonNullableFields;
3114
+ tableCellData?: TableCellDataNonNullableFields;
3115
+ audioData?: AudioDataNonNullableFields;
3116
+ orderedListData?: OrderedListDataNonNullableFields;
3117
+ bulletedListData?: BulletedListDataNonNullableFields;
3118
+ blockquoteData?: BlockquoteDataNonNullableFields;
3119
+ type: NodeType;
3120
+ _id: string;
3121
+ nodes: NodeNonNullableFields[];
3122
+ }
3123
+ interface MetadataNonNullableFields {
3124
+ version: number;
3125
+ }
3126
+ interface TextNodeStyleNonNullableFields {
3127
+ decorations: DecorationNonNullableFields[];
3128
+ }
3129
+ interface DocumentStyleNonNullableFields {
3130
+ headerOne?: TextNodeStyleNonNullableFields;
3131
+ headerTwo?: TextNodeStyleNonNullableFields;
3132
+ headerThree?: TextNodeStyleNonNullableFields;
3133
+ headerFour?: TextNodeStyleNonNullableFields;
3134
+ headerFive?: TextNodeStyleNonNullableFields;
3135
+ headerSix?: TextNodeStyleNonNullableFields;
3136
+ paragraph?: TextNodeStyleNonNullableFields;
3137
+ blockquote?: TextNodeStyleNonNullableFields;
3138
+ codeBlock?: TextNodeStyleNonNullableFields;
3139
+ }
3140
+ interface RichContentNonNullableFields {
3141
+ nodes: NodeNonNullableFields[];
3142
+ metadata?: MetadataNonNullableFields;
3143
+ documentStyle?: DocumentStyleNonNullableFields;
3144
+ }
3145
+ interface TreeReferenceNonNullableFields {
3146
+ appNamespace: string;
3147
+ }
3148
+ interface CategoryNonNullableFields {
3149
+ image: string;
3150
+ itemCounter: number;
3151
+ totalItemCounter: number;
3152
+ breadcrumbs?: BreadcrumbItemValuesNonNullableFields;
3153
+ seoData?: SeoSchemaNonNullableFields;
3154
+ richContentDescription?: RichContentNonNullableFields;
3155
+ treeReference?: TreeReferenceNonNullableFields;
3156
+ }
3157
+ interface CreateCategoryResponseNonNullableFields {
3158
+ category?: CategoryNonNullableFields;
3159
+ }
3160
+ interface GetCategoryResponseNonNullableFields {
3161
+ category?: CategoryNonNullableFields;
3162
+ }
3163
+ interface UpdateCategoryResponseNonNullableFields {
3164
+ category?: CategoryNonNullableFields;
3165
+ }
3166
+ interface ValueAggregationResultNonNullableFields {
3167
+ value: string;
3168
+ count: number;
3169
+ }
3170
+ interface ValueResultsNonNullableFields {
3171
+ results: ValueAggregationResultNonNullableFields[];
3172
+ }
3173
+ interface RangeAggregationResultNonNullableFields {
3174
+ count: number;
3175
+ }
3176
+ interface RangeResultsNonNullableFields {
3177
+ results: RangeAggregationResultNonNullableFields[];
3178
+ }
3179
+ interface AggregationResultsScalarResultNonNullableFields {
3180
+ type: ScalarType;
3181
+ value: number;
3182
+ }
3183
+ interface NestedAggregationResultsNonNullableFields {
3184
+ values?: ValueResultsNonNullableFields;
3185
+ ranges?: RangeResultsNonNullableFields;
3186
+ scalar?: AggregationResultsScalarResultNonNullableFields;
3187
+ name: string;
3188
+ type: AggregationType;
3189
+ fieldPath: string;
3190
+ }
3191
+ interface NestedValueAggregationResultNonNullableFields {
3192
+ value: string;
3193
+ nestedResults?: NestedAggregationResultsNonNullableFields;
3194
+ }
3195
+ interface GroupByValueResultsNonNullableFields {
3196
+ results: NestedValueAggregationResultNonNullableFields[];
3197
+ }
3198
+ interface DateHistogramResultNonNullableFields {
3199
+ value: string;
3200
+ count: number;
3201
+ }
3202
+ interface DateHistogramResultsNonNullableFields {
3203
+ results: DateHistogramResultNonNullableFields[];
3204
+ }
3205
+ interface AggregationResultsNonNullableFields {
3206
+ values?: ValueResultsNonNullableFields;
3207
+ ranges?: RangeResultsNonNullableFields;
3208
+ scalar?: AggregationResultsScalarResultNonNullableFields;
3209
+ groupedByValue?: GroupByValueResultsNonNullableFields;
3210
+ dateHistogram?: DateHistogramResultsNonNullableFields;
3211
+ name: string;
3212
+ type: AggregationType;
3213
+ fieldPath: string;
3214
+ }
3215
+ interface AggregationDataNonNullableFields {
3216
+ results: AggregationResultsNonNullableFields[];
3217
+ }
3218
+ interface SearchCategoriesResponseNonNullableFields {
3219
+ categories: CategoryNonNullableFields[];
3220
+ aggregationData?: AggregationDataNonNullableFields;
3221
+ }
3222
+ interface CountCategoriesResponseNonNullableFields {
3223
+ count: number;
3224
+ }
3225
+ interface MoveCategoryResponseNonNullableFields {
3226
+ categoriesAfterMove: string[];
3227
+ }
3228
+ interface ApplicationErrorNonNullableFields {
3229
+ code: string;
3230
+ description: string;
3231
+ }
3232
+ interface ItemMetadataNonNullableFields {
3233
+ originalIndex: number;
3234
+ success: boolean;
3235
+ error?: ApplicationErrorNonNullableFields;
3236
+ }
3237
+ interface BulkCategoriesResultNonNullableFields {
3238
+ itemMetadata?: ItemMetadataNonNullableFields;
3239
+ category?: CategoryNonNullableFields;
3240
+ }
3241
+ interface BulkActionMetadataNonNullableFields {
3242
+ totalSuccesses: number;
3243
+ totalFailures: number;
3244
+ undetailedFailures: number;
3245
+ }
3246
+ interface BulkUpdateCategoriesResponseNonNullableFields {
3247
+ results: BulkCategoriesResultNonNullableFields[];
3248
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields;
3249
+ }
3250
+ interface UpdateCategoryVisibilityResponseNonNullableFields {
3251
+ category?: CategoryNonNullableFields;
3252
+ }
3253
+ interface ItemReferenceNonNullableFields {
3254
+ catalogItemId: string;
3255
+ appId: string;
3256
+ }
3257
+ interface ItemReferenceMetadataNonNullableFields {
3258
+ item?: ItemReferenceNonNullableFields;
3259
+ originalIndex: number;
3260
+ success: boolean;
3261
+ error?: ApplicationErrorNonNullableFields;
3262
+ }
3263
+ interface BulkItemsToCategoryResultNonNullableFields {
3264
+ itemMetadata?: ItemReferenceMetadataNonNullableFields;
3265
+ }
3266
+ interface BulkAddItemsToCategoryResponseNonNullableFields {
3267
+ results: BulkItemsToCategoryResultNonNullableFields[];
3268
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields;
3269
+ }
3270
+ interface BulkItemToCategoriesResultNonNullableFields {
3271
+ itemMetadata?: ItemMetadataNonNullableFields;
3272
+ }
3273
+ interface BulkAddItemToCategoriesResponseNonNullableFields {
3274
+ results: BulkItemToCategoriesResultNonNullableFields[];
3275
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields;
3276
+ }
3277
+ interface BulkRemoveItemsFromCategoryResponseNonNullableFields {
3278
+ results: BulkItemsToCategoryResultNonNullableFields[];
3279
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields;
3280
+ }
3281
+ interface BulkRemoveItemFromCategoriesResponseNonNullableFields {
3282
+ results: BulkItemToCategoriesResultNonNullableFields[];
3283
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields;
3284
+ }
3285
+ interface ListItemsInCategoryResponseNonNullableFields {
3286
+ items: ItemReferenceNonNullableFields[];
3287
+ }
3288
+ interface ListCategoriesForItemResponseNonNullableFields {
3289
+ directCategoryIds: string[];
3290
+ allCategoryIds: string[];
3291
+ }
3292
+ interface ListTreesResponseNonNullableFields {
3293
+ trees: TreeReferenceNonNullableFields[];
3294
+ }
3295
+ interface SetArrangedItemsResponseNonNullableFields {
3296
+ items: ItemReferenceNonNullableFields[];
3297
+ }
3298
+ interface GetArrangedItemsResponseNonNullableFields {
3299
+ items: ItemReferenceNonNullableFields[];
3300
+ }
3301
+ interface BaseEventMetadata {
3302
+ /** App instance ID. */
3303
+ instanceId?: string | null;
3304
+ /** Event type. */
3305
+ eventType?: string;
3306
+ /** The identification type and identity data. */
3307
+ identity?: IdentificationData;
3308
+ }
3309
+ interface EventMetadata extends BaseEventMetadata {
3310
+ /**
3311
+ * Unique event ID.
3312
+ * Allows clients to ignore duplicate webhooks.
3313
+ */
3314
+ _id?: string;
3315
+ /**
3316
+ * Assumes actions are also always typed to an entity_type
3317
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
3318
+ */
3319
+ entityFqdn?: string;
3320
+ /**
3321
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
3322
+ * This is although the created/updated/deleted notion is duplication of the oneof types
3323
+ * Example: created/updated/deleted/started/completed/email_opened
3324
+ */
3325
+ slug?: string;
3326
+ /** ID of the entity associated with the event. */
3327
+ entityId?: string;
3328
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
3329
+ eventTime?: Date;
3330
+ /**
3331
+ * Whether the event was triggered as a result of a privacy regulation application
3332
+ * (for example, GDPR).
3333
+ */
3334
+ triggeredByAnonymizeRequest?: boolean | null;
3335
+ /** If present, indicates the action that triggered the event. */
3336
+ originatedFrom?: string | null;
3337
+ /**
3338
+ * A sequence number defining the order of updates to the underlying entity.
3339
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
3340
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
3341
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
3342
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
3343
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
3344
+ */
3345
+ entityEventSequence?: string | null;
3346
+ }
3347
+ interface CategoryCreatedEnvelope {
3348
+ entity: Category;
3349
+ metadata: EventMetadata;
3350
+ }
3351
+ interface CategoryUpdatedEnvelope {
3352
+ entity: Category;
3353
+ metadata: EventMetadata;
3354
+ }
3355
+ interface CategoryDeletedEnvelope {
3356
+ metadata: EventMetadata;
3357
+ }
3358
+ interface CategoryMovedEnvelope {
3359
+ data: CategoryMoved;
3360
+ metadata: EventMetadata;
3361
+ }
3362
+ interface CategoryItemAddedToCategoryEnvelope {
3363
+ data: ItemAddedToCategory;
3364
+ metadata: EventMetadata;
3365
+ }
3366
+ interface CategoryItemRemovedFromCategoryEnvelope {
3367
+ data: ItemRemovedFromCategory;
3368
+ metadata: EventMetadata;
3369
+ }
3370
+ interface CategoryItemsArrangedInCategoryEnvelope {
3371
+ data: ItemsArrangedInCategory;
3372
+ metadata: EventMetadata;
3373
+ }
3374
+ interface CreateCategoryOptions {
3375
+ /** A reference to the tree that contains this category. */
3376
+ treeReference: TreeReference;
3377
+ /** Fields to return in the response. When not provided, these fields are not returned. */
3378
+ fields?: RequestedFields[];
3379
+ }
3380
+ interface GetCategoryOptions {
3381
+ /** Fields to return in the response. When not provided, these fields are not returned. */
3382
+ fields?: RequestedFields[];
3383
+ }
3384
+ interface UpdateCategory {
3385
+ /** Category ID. */
3386
+ _id?: string | null;
3387
+ /**
3388
+ * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision
3389
+ * @readonly
3390
+ */
3391
+ revision?: string | null;
3392
+ /**
3393
+ * Represents the time this Category was created.
3394
+ * @readonly
3395
+ */
3396
+ _createdDate?: Date;
3397
+ /**
3398
+ * Represents the time this Category was last updated.
3399
+ * @readonly
3400
+ */
3401
+ _updatedDate?: Date;
3402
+ /** Category name. */
3403
+ name?: string | null;
3404
+ /**
3405
+ * Category image.
3406
+ * Pass existing media ID for image previously saved in Wix media manager.
3407
+ * Pass full image URL to upload an image to Wix media manager.
3408
+ * In case of full url the image will be updated eventually.
3409
+ */
3410
+ image?: string;
3411
+ /**
3412
+ * Number of items in this category alone.
3413
+ * @readonly
3414
+ */
3415
+ itemCounter?: number;
3416
+ /** Category description. */
3417
+ description?: string | null;
3418
+ /**
3419
+ * Whether the category is visible to site visitors in dynamic pages (If not passed, the default is `false`).
3420
+ * Even if visible is `false`, it can still be added manually to static page.
3421
+ * If parent visibility is updated to `false`, all the children visibility will be updated eventually to `false`.
3422
+ * It is not allowed to set visible as `true` if at least one of the parent categories has visible `false`.
3423
+ */
3424
+ visible?: boolean | null;
3425
+ /**
3426
+ * A category's breadcrumbs, Updated on moved to different parent or on renamed.
3427
+ * > **Note:** This field is returned only when you pass `fields: "BREADCRUMBS"` in the request.
3428
+ * @readonly
3429
+ */
3430
+ breadcrumbs?: BreadcrumbItemValues;
3431
+ /** The parent category. */
3432
+ parentCategory?: ParentCategory;
3433
+ /**
3434
+ * A permanent, friendly URL name.
3435
+ * If not provided, on create generated automatically.
3436
+ * When provided, validated and must be unique.
3437
+ */
3438
+ slug?: string | null;
3439
+ /**
3440
+ * Category description which supports rich content. It is independent from `description` field and can be used instead of it or in addition to it.
3441
+ * In order to use this field you have to integrate with "Ricos" on frontend side. To learn how to do it visit https://ricos.js.org/.
3442
+ */
3443
+ richContentDescription?: RichContent;
3444
+ /**
3445
+ * Optional - the ID of the app responsible for managing the items within this category.
3446
+ * If provided, the update of items assigned to this category and the deletion of it will be allowed only to the managing app.
3447
+ * The default is Empty.
3448
+ */
3449
+ managingAppId?: string | null;
3450
+ /** Extensions enabling users to save custom data related to the category. */
3451
+ extendedFields?: ExtendedFields;
3452
+ }
3453
+ interface UpdateCategoryOptions {
3454
+ /** A reference to the tree that contains this category. */
3455
+ treeReference: TreeReference;
3456
+ /** Fields to return in the response. When not provided, these fields are not returned. */
3457
+ fields?: RequestedFields[];
3458
+ }
3459
+ interface SearchCategoriesOptions {
3460
+ /** WQL query expression. */
3461
+ search?: CursorSearch;
3462
+ /**
3463
+ * A reference to the tree that contains this category.
3464
+ * Used only in the first request. Following requests use the cursor token.
3465
+ */
3466
+ treeReference: TreeReference;
3467
+ /**
3468
+ * Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
3469
+ * Used only in the first request. Following requests use the cursor token.
3470
+ */
3471
+ returnNonVisibleCategories?: boolean;
3472
+ /** Fields to return in the response. When not provided, these fields are not returned. */
3473
+ fields?: RequestedFields[];
3474
+ }
3475
+ interface CountCategoriesOptions {
3476
+ /**
3477
+ * A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf)
3478
+ * To understand supported filters and limitations see `SearchCategories` method.
3479
+ */
3480
+ filter?: Record<string, any> | null;
3481
+ /** free text to match in searchable fields */
3482
+ search?: SearchDetails;
3483
+ /**
3484
+ * A reference to the tree that contains this category.
3485
+ * Used only in the first request. Following requests use the cursor token.
3486
+ */
3487
+ treeReference: TreeReference;
3488
+ /**
3489
+ * Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
3490
+ * Used only in the first request. Following requests use the cursor token.
3491
+ */
3492
+ returnNonVisibleCategories?: boolean;
3493
+ }
3494
+ interface MoveCategoryOptions {
3495
+ /**
3496
+ * ID of parent category.
3497
+ * Optional. When not passed it will fallback to the root category
3498
+ */
3499
+ parentCategoryId?: string | null;
3500
+ /**
3501
+ * Where to place the subcategory.
3502
+ * `FIRST` - make category with `category_id` first subcategory with manual arrangement.
3503
+ * `LAST` - make category with `category_id` last subcategory with manual arrangement.
3504
+ * `BEFORE` - requires `move_before_category_id`, category with `category_id` will be moved before it.
3505
+ */
3506
+ position: Position;
3507
+ /** Required when `position` is `BEFORE`. Otherwise ignored */
3508
+ moveBeforeCategoryId?: string | null;
3509
+ }
3510
+ interface BulkUpdateCategoriesOptions {
3511
+ /** A reference to the tree that contains the categories. */
3512
+ treeReference: TreeReference;
3513
+ /** Whether to return the category entity in the response. */
3514
+ returnEntity?: boolean;
3515
+ /** Fields to return in the response. When not provided, these fields are not returned. */
3516
+ fields?: RequestedFields[];
3517
+ }
3518
+ interface UpdateCategoryVisibilityOptions {
3519
+ /** value to set `visible` to */
3520
+ visible: boolean;
3521
+ /** A reference to the tree that contains this category. */
3522
+ treeReference: TreeReference;
3523
+ /** Latest revision of the category. */
3524
+ revision: string | null;
3525
+ /** Fields to return in the response. When not provided, these fields are not returned. */
3526
+ fields?: RequestedFields[];
3527
+ }
3528
+ interface BulkAddItemsToCategoryOptions {
3529
+ /** A reference to the tree that contains this category. */
3530
+ treeReference: TreeReference;
3531
+ }
3532
+ interface BulkAddItemToCategoriesOptions {
3533
+ /** Category ids. */
3534
+ categoryIds: string[];
3535
+ /** A reference to the tree that contains the categories. */
3536
+ treeReference: TreeReference;
3537
+ }
3538
+ interface BulkRemoveItemsFromCategoryOptions {
3539
+ /** A reference to the tree that contains this category. */
3540
+ treeReference: TreeReference;
3541
+ }
3542
+ interface BulkRemoveItemFromCategoriesOptions {
3543
+ /** Category ids. */
3544
+ categoryIds: string[];
3545
+ /** A reference to the tree that contains the categories. */
3546
+ treeReference: TreeReference;
3547
+ }
3548
+ interface ListItemsInCategoryOptions extends ListItemsInCategoryRequestPagingMethodOneOf {
3549
+ /** Default: `false`. When `true` items arranged by user will be return before all other items. */
3550
+ useCategoryArrangement?: boolean;
3551
+ /** Default: `false`. When `false` only direct items of category will be returned. When `true` response contains also items from all subcategories which current category contains */
3552
+ includeItemsFromSubcategories?: boolean;
3553
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `use_category_arrangement` or `include_items_from_subcategories`. */
3554
+ cursorPaging?: CursorPaging;
3555
+ }
3556
+ interface ListCategoriesForItemOptions {
3557
+ /** A reference to the tree that contains the categories. */
3558
+ treeReference: TreeReference;
3559
+ }
3560
+ interface SetArrangedItemsOptions {
3561
+ /**
3562
+ * List of arranged items to set.
3563
+ * All items must be direct children of category with `category_id`, otherwise error returned.
3564
+ */
3565
+ items?: ItemReference[];
3566
+ }
3567
+
3568
+ type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
3569
+ interface HttpClient {
3570
+ request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
3571
+ fetchWithAuth: typeof fetch;
3572
+ wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
3573
+ }
3574
+ type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
3575
+ type HttpResponse<T = any> = {
3576
+ data: T;
3577
+ status: number;
3578
+ statusText: string;
3579
+ headers: any;
3580
+ request?: any;
3581
+ };
3582
+ type RequestOptions<_TResponse = any, Data = any> = {
3583
+ method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
3584
+ url: string;
3585
+ data?: Data;
3586
+ params?: URLSearchParams;
3587
+ } & APIMetadata;
3588
+ type APIMetadata = {
3589
+ methodFqn?: string;
3590
+ entityFqdn?: string;
3591
+ packageName?: string;
3592
+ };
3593
+ type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
3594
+ type EventDefinition<Payload = unknown, Type extends string = string> = {
3595
+ __type: 'event-definition';
3596
+ type: Type;
3597
+ isDomainEvent?: boolean;
3598
+ transformations?: (envelope: unknown) => Payload;
3599
+ __payload: Payload;
3600
+ };
3601
+ declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
3602
+ type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
3603
+ type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
3604
+
3605
+ declare global {
3606
+ // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
3607
+ interface SymbolConstructor {
3608
+ readonly observable: symbol;
3609
+ }
3610
+ }
3611
+
3612
+ declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
3613
+
3614
+ declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
3615
+
3616
+ declare const createCategory: ReturnType<typeof createRESTModule<typeof publicCreateCategory>>;
3617
+ declare const getCategory: ReturnType<typeof createRESTModule<typeof publicGetCategory>>;
3618
+ declare const updateCategory: ReturnType<typeof createRESTModule<typeof publicUpdateCategory>>;
3619
+ declare const deleteCategory: ReturnType<typeof createRESTModule<typeof publicDeleteCategory>>;
3620
+ declare const searchCategories: ReturnType<typeof createRESTModule<typeof publicSearchCategories>>;
3621
+ declare const countCategories: ReturnType<typeof createRESTModule<typeof publicCountCategories>>;
3622
+ declare const moveCategory: ReturnType<typeof createRESTModule<typeof publicMoveCategory>>;
3623
+ declare const bulkUpdateCategories: ReturnType<typeof createRESTModule<typeof publicBulkUpdateCategories>>;
3624
+ declare const updateCategoryVisibility: ReturnType<typeof createRESTModule<typeof publicUpdateCategoryVisibility>>;
3625
+ declare const bulkAddItemsToCategory: ReturnType<typeof createRESTModule<typeof publicBulkAddItemsToCategory>>;
3626
+ declare const bulkAddItemToCategories: ReturnType<typeof createRESTModule<typeof publicBulkAddItemToCategories>>;
3627
+ declare const bulkRemoveItemsFromCategory: ReturnType<typeof createRESTModule<typeof publicBulkRemoveItemsFromCategory>>;
3628
+ declare const bulkRemoveItemFromCategories: ReturnType<typeof createRESTModule<typeof publicBulkRemoveItemFromCategories>>;
3629
+ declare const listItemsInCategory: ReturnType<typeof createRESTModule<typeof publicListItemsInCategory>>;
3630
+ declare const listCategoriesForItem: ReturnType<typeof createRESTModule<typeof publicListCategoriesForItem>>;
3631
+ declare const listTrees: ReturnType<typeof createRESTModule<typeof publicListTrees>>;
3632
+ declare const setArrangedItems: ReturnType<typeof createRESTModule<typeof publicSetArrangedItems>>;
3633
+ declare const getArrangedItems: ReturnType<typeof createRESTModule<typeof publicGetArrangedItems>>;
3634
+ declare const onCategoryCreated: ReturnType<typeof createEventModule<typeof publicOnCategoryCreated>>;
3635
+ declare const onCategoryUpdated: ReturnType<typeof createEventModule<typeof publicOnCategoryUpdated>>;
3636
+ declare const onCategoryDeleted: ReturnType<typeof createEventModule<typeof publicOnCategoryDeleted>>;
3637
+ declare const onCategoryMoved: ReturnType<typeof createEventModule<typeof publicOnCategoryMoved>>;
3638
+ declare const onCategoryItemAddedToCategory: ReturnType<typeof createEventModule<typeof publicOnCategoryItemAddedToCategory>>;
3639
+ declare const onCategoryItemRemovedFromCategory: ReturnType<typeof createEventModule<typeof publicOnCategoryItemRemovedFromCategory>>;
3640
+ declare const onCategoryItemsArrangedInCategory: ReturnType<typeof createEventModule<typeof publicOnCategoryItemsArrangedInCategory>>;
3641
+
3642
+ type index_d_ActionEvent = ActionEvent;
3643
+ type index_d_Aggregation = Aggregation;
3644
+ type index_d_AggregationData = AggregationData;
3645
+ type index_d_AggregationDateHistogramAggregation = AggregationDateHistogramAggregation;
3646
+ type index_d_AggregationKindOneOf = AggregationKindOneOf;
3647
+ type index_d_AggregationNestedAggregation = AggregationNestedAggregation;
3648
+ type index_d_AggregationRangeAggregation = AggregationRangeAggregation;
3649
+ type index_d_AggregationResults = AggregationResults;
3650
+ type index_d_AggregationResultsResultOneOf = AggregationResultsResultOneOf;
3651
+ type index_d_AggregationResultsScalarResult = AggregationResultsScalarResult;
3652
+ type index_d_AggregationScalarAggregation = AggregationScalarAggregation;
3653
+ type index_d_AggregationType = AggregationType;
3654
+ declare const index_d_AggregationType: typeof AggregationType;
3655
+ type index_d_AggregationValueAggregation = AggregationValueAggregation;
3656
+ type index_d_AggregationValueAggregationOptionsOneOf = AggregationValueAggregationOptionsOneOf;
3657
+ type index_d_Alignment = Alignment;
3658
+ declare const index_d_Alignment: typeof Alignment;
3659
+ type index_d_AnchorData = AnchorData;
3660
+ type index_d_App = App;
3661
+ type index_d_AppEmbedData = AppEmbedData;
3662
+ type index_d_AppEmbedDataAppDataOneOf = AppEmbedDataAppDataOneOf;
3663
+ type index_d_AppType = AppType;
3664
+ declare const index_d_AppType: typeof AppType;
3665
+ type index_d_ApplicationError = ApplicationError;
3666
+ type index_d_AudioData = AudioData;
3667
+ type index_d_Background = Background;
3668
+ type index_d_BackgroundBackgroundOneOf = BackgroundBackgroundOneOf;
3669
+ type index_d_BackgroundType = BackgroundType;
3670
+ declare const index_d_BackgroundType: typeof BackgroundType;
3671
+ type index_d_BaseEventMetadata = BaseEventMetadata;
3672
+ type index_d_BlockquoteData = BlockquoteData;
3673
+ type index_d_BookingData = BookingData;
3674
+ type index_d_Border = Border;
3675
+ type index_d_BorderColors = BorderColors;
3676
+ type index_d_BreadcrumbItem = BreadcrumbItem;
3677
+ type index_d_BreadcrumbItemValues = BreadcrumbItemValues;
3678
+ type index_d_BulkActionMetadata = BulkActionMetadata;
3679
+ type index_d_BulkAddItemToCategoriesOptions = BulkAddItemToCategoriesOptions;
3680
+ type index_d_BulkAddItemToCategoriesRequest = BulkAddItemToCategoriesRequest;
3681
+ type index_d_BulkAddItemToCategoriesResponse = BulkAddItemToCategoriesResponse;
3682
+ type index_d_BulkAddItemToCategoriesResponseNonNullableFields = BulkAddItemToCategoriesResponseNonNullableFields;
3683
+ type index_d_BulkAddItemsToCategoryOptions = BulkAddItemsToCategoryOptions;
3684
+ type index_d_BulkAddItemsToCategoryRequest = BulkAddItemsToCategoryRequest;
3685
+ type index_d_BulkAddItemsToCategoryResponse = BulkAddItemsToCategoryResponse;
3686
+ type index_d_BulkAddItemsToCategoryResponseNonNullableFields = BulkAddItemsToCategoryResponseNonNullableFields;
3687
+ type index_d_BulkCategoriesResult = BulkCategoriesResult;
3688
+ type index_d_BulkCreateCategoriesRequest = BulkCreateCategoriesRequest;
3689
+ type index_d_BulkCreateCategoriesResponse = BulkCreateCategoriesResponse;
3690
+ type index_d_BulkDeleteCategoriesByFilterRequest = BulkDeleteCategoriesByFilterRequest;
3691
+ type index_d_BulkDeleteCategoriesByFilterResponse = BulkDeleteCategoriesByFilterResponse;
3692
+ type index_d_BulkDeleteCategoriesRequest = BulkDeleteCategoriesRequest;
3693
+ type index_d_BulkDeleteCategoriesResponse = BulkDeleteCategoriesResponse;
3694
+ type index_d_BulkDeleteCategoriesResponseBulkCategoriesResult = BulkDeleteCategoriesResponseBulkCategoriesResult;
3695
+ type index_d_BulkItemToCategoriesResult = BulkItemToCategoriesResult;
3696
+ type index_d_BulkItemsToCategoryResult = BulkItemsToCategoryResult;
3697
+ type index_d_BulkRemoveItemFromCategoriesOptions = BulkRemoveItemFromCategoriesOptions;
3698
+ type index_d_BulkRemoveItemFromCategoriesRequest = BulkRemoveItemFromCategoriesRequest;
3699
+ type index_d_BulkRemoveItemFromCategoriesResponse = BulkRemoveItemFromCategoriesResponse;
3700
+ type index_d_BulkRemoveItemFromCategoriesResponseNonNullableFields = BulkRemoveItemFromCategoriesResponseNonNullableFields;
3701
+ type index_d_BulkRemoveItemsFromCategoryOptions = BulkRemoveItemsFromCategoryOptions;
3702
+ type index_d_BulkRemoveItemsFromCategoryRequest = BulkRemoveItemsFromCategoryRequest;
3703
+ type index_d_BulkRemoveItemsFromCategoryResponse = BulkRemoveItemsFromCategoryResponse;
3704
+ type index_d_BulkRemoveItemsFromCategoryResponseNonNullableFields = BulkRemoveItemsFromCategoryResponseNonNullableFields;
3705
+ type index_d_BulkUpdateCategoriesOptions = BulkUpdateCategoriesOptions;
3706
+ type index_d_BulkUpdateCategoriesRequest = BulkUpdateCategoriesRequest;
3707
+ type index_d_BulkUpdateCategoriesResponse = BulkUpdateCategoriesResponse;
3708
+ type index_d_BulkUpdateCategoriesResponseNonNullableFields = BulkUpdateCategoriesResponseNonNullableFields;
3709
+ type index_d_BulkUpdateCategoryVisibilityByFilterRequest = BulkUpdateCategoryVisibilityByFilterRequest;
3710
+ type index_d_BulkUpdateCategoryVisibilityByFilterResponse = BulkUpdateCategoryVisibilityByFilterResponse;
3711
+ type index_d_BulkUpdateCategoryVisibilityRequest = BulkUpdateCategoryVisibilityRequest;
3712
+ type index_d_BulkUpdateCategoryVisibilityResponse = BulkUpdateCategoryVisibilityResponse;
3713
+ type index_d_BulletedListData = BulletedListData;
3714
+ type index_d_ButtonData = ButtonData;
3715
+ type index_d_Category = Category;
3716
+ type index_d_CategoryCreatedEnvelope = CategoryCreatedEnvelope;
3717
+ type index_d_CategoryDeletedEnvelope = CategoryDeletedEnvelope;
3718
+ type index_d_CategoryItemAddedToCategoryEnvelope = CategoryItemAddedToCategoryEnvelope;
3719
+ type index_d_CategoryItemRemovedFromCategoryEnvelope = CategoryItemRemovedFromCategoryEnvelope;
3720
+ type index_d_CategoryItemsArrangedInCategoryEnvelope = CategoryItemsArrangedInCategoryEnvelope;
3721
+ type index_d_CategoryMoved = CategoryMoved;
3722
+ type index_d_CategoryMovedEnvelope = CategoryMovedEnvelope;
3723
+ type index_d_CategoryNonNullableFields = CategoryNonNullableFields;
3724
+ type index_d_CategoryTreeNode = CategoryTreeNode;
3725
+ type index_d_CategoryUpdatedEnvelope = CategoryUpdatedEnvelope;
3726
+ type index_d_CellStyle = CellStyle;
3727
+ type index_d_CodeBlockData = CodeBlockData;
3728
+ type index_d_CollapsibleListData = CollapsibleListData;
3729
+ type index_d_ColorData = ColorData;
3730
+ type index_d_Colors = Colors;
3731
+ type index_d_CommonAggregation = CommonAggregation;
3732
+ type index_d_CommonAggregationKindOneOf = CommonAggregationKindOneOf;
3733
+ type index_d_CommonAggregationType = CommonAggregationType;
3734
+ declare const index_d_CommonAggregationType: typeof CommonAggregationType;
3735
+ type index_d_CommonCursors = CommonCursors;
3736
+ type index_d_CommonScalarType = CommonScalarType;
3737
+ declare const index_d_CommonScalarType: typeof CommonScalarType;
3738
+ type index_d_CommonSearchDetails = CommonSearchDetails;
3739
+ type index_d_CommonSortOrder = CommonSortOrder;
3740
+ declare const index_d_CommonSortOrder: typeof CommonSortOrder;
3741
+ type index_d_CommonSorting = CommonSorting;
3742
+ type index_d_CompactCategory = CompactCategory;
3743
+ type index_d_CountCategoriesOptions = CountCategoriesOptions;
3744
+ type index_d_CountCategoriesRequest = CountCategoriesRequest;
3745
+ type index_d_CountCategoriesResponse = CountCategoriesResponse;
3746
+ type index_d_CountCategoriesResponseNonNullableFields = CountCategoriesResponseNonNullableFields;
3747
+ type index_d_CreateCategoryOptions = CreateCategoryOptions;
3748
+ type index_d_CreateCategoryRequest = CreateCategoryRequest;
3749
+ type index_d_CreateCategoryResponse = CreateCategoryResponse;
3750
+ type index_d_CreateCategoryResponseNonNullableFields = CreateCategoryResponseNonNullableFields;
3751
+ type index_d_Crop = Crop;
3752
+ declare const index_d_Crop: typeof Crop;
3753
+ type index_d_CursorPaging = CursorPaging;
3754
+ type index_d_CursorPagingMetadata = CursorPagingMetadata;
3755
+ type index_d_CursorSearch = CursorSearch;
3756
+ type index_d_CursorSearchPagingMethodOneOf = CursorSearchPagingMethodOneOf;
3757
+ type index_d_Cursors = Cursors;
3758
+ type index_d_DateHistogramAggregation = DateHistogramAggregation;
3759
+ type index_d_DateHistogramAggregationInterval = DateHistogramAggregationInterval;
3760
+ declare const index_d_DateHistogramAggregationInterval: typeof DateHistogramAggregationInterval;
3761
+ type index_d_DateHistogramResult = DateHistogramResult;
3762
+ type index_d_DateHistogramResults = DateHistogramResults;
3763
+ type index_d_Decoration = Decoration;
3764
+ type index_d_DecorationDataOneOf = DecorationDataOneOf;
3765
+ type index_d_DecorationType = DecorationType;
3766
+ declare const index_d_DecorationType: typeof DecorationType;
3767
+ type index_d_DeleteCategoryRequest = DeleteCategoryRequest;
3768
+ type index_d_DeleteCategoryResponse = DeleteCategoryResponse;
3769
+ type index_d_DeprecatedSearchCategoriesWithOffsetRequest = DeprecatedSearchCategoriesWithOffsetRequest;
3770
+ type index_d_DeprecatedSearchCategoriesWithOffsetResponse = DeprecatedSearchCategoriesWithOffsetResponse;
3771
+ type index_d_Design = Design;
3772
+ type index_d_Dimensions = Dimensions;
3773
+ type index_d_Direction = Direction;
3774
+ declare const index_d_Direction: typeof Direction;
3775
+ type index_d_DividerData = DividerData;
3776
+ type index_d_DocumentStyle = DocumentStyle;
3777
+ type index_d_DomainEvent = DomainEvent;
3778
+ type index_d_DomainEventBodyOneOf = DomainEventBodyOneOf;
3779
+ type index_d_EmbedData = EmbedData;
3780
+ type index_d_Empty = Empty;
3781
+ type index_d_EntityCreatedEvent = EntityCreatedEvent;
3782
+ type index_d_EntityDeletedEvent = EntityDeletedEvent;
3783
+ type index_d_EntityUpdatedEvent = EntityUpdatedEvent;
3784
+ type index_d_EventData = EventData;
3785
+ type index_d_EventMetadata = EventMetadata;
3786
+ type index_d_ExtendedFields = ExtendedFields;
3787
+ type index_d_File = File;
3788
+ type index_d_FileData = FileData;
3789
+ type index_d_FileSource = FileSource;
3790
+ type index_d_FileSourceDataOneOf = FileSourceDataOneOf;
3791
+ type index_d_FontSizeData = FontSizeData;
3792
+ type index_d_FontType = FontType;
3793
+ declare const index_d_FontType: typeof FontType;
3794
+ type index_d_GIF = GIF;
3795
+ type index_d_GIFData = GIFData;
3796
+ type index_d_GalleryData = GalleryData;
3797
+ type index_d_GalleryOptions = GalleryOptions;
3798
+ type index_d_GetArrangedItemsRequest = GetArrangedItemsRequest;
3799
+ type index_d_GetArrangedItemsResponse = GetArrangedItemsResponse;
3800
+ type index_d_GetArrangedItemsResponseNonNullableFields = GetArrangedItemsResponseNonNullableFields;
3801
+ type index_d_GetCategoriesTreeRequest = GetCategoriesTreeRequest;
3802
+ type index_d_GetCategoriesTreeResponse = GetCategoriesTreeResponse;
3803
+ type index_d_GetCategoryOptions = GetCategoryOptions;
3804
+ type index_d_GetCategoryRequest = GetCategoryRequest;
3805
+ type index_d_GetCategoryResponse = GetCategoryResponse;
3806
+ type index_d_GetCategoryResponseNonNullableFields = GetCategoryResponseNonNullableFields;
3807
+ type index_d_Gradient = Gradient;
3808
+ type index_d_GroupByAggregation = GroupByAggregation;
3809
+ type index_d_GroupByAggregationKindOneOf = GroupByAggregationKindOneOf;
3810
+ type index_d_GroupByValueResults = GroupByValueResults;
3811
+ type index_d_HTMLData = HTMLData;
3812
+ type index_d_HTMLDataDataOneOf = HTMLDataDataOneOf;
3813
+ type index_d_HeadingData = HeadingData;
3814
+ type index_d_Height = Height;
3815
+ type index_d_IdentificationData = IdentificationData;
3816
+ type index_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
3817
+ type index_d_Image = Image;
3818
+ type index_d_ImageData = ImageData;
3819
+ type index_d_IncludeMissingValuesOptions = IncludeMissingValuesOptions;
3820
+ type index_d_InitialExpandedItems = InitialExpandedItems;
3821
+ declare const index_d_InitialExpandedItems: typeof InitialExpandedItems;
3822
+ type index_d_Interval = Interval;
3823
+ declare const index_d_Interval: typeof Interval;
3824
+ type index_d_InvalidateCache = InvalidateCache;
3825
+ type index_d_InvalidateCacheGetByOneOf = InvalidateCacheGetByOneOf;
3826
+ type index_d_Item = Item;
3827
+ type index_d_ItemAddedToCategory = ItemAddedToCategory;
3828
+ type index_d_ItemDataOneOf = ItemDataOneOf;
3829
+ type index_d_ItemMetadata = ItemMetadata;
3830
+ type index_d_ItemReference = ItemReference;
3831
+ type index_d_ItemReferenceMetadata = ItemReferenceMetadata;
3832
+ type index_d_ItemRemovedFromCategory = ItemRemovedFromCategory;
3833
+ type index_d_ItemStyle = ItemStyle;
3834
+ type index_d_ItemsAddedToCategory = ItemsAddedToCategory;
3835
+ type index_d_ItemsArrangedInCategory = ItemsArrangedInCategory;
3836
+ type index_d_ItemsRemovedFromCategory = ItemsRemovedFromCategory;
3837
+ type index_d_Keyword = Keyword;
3838
+ type index_d_Layout = Layout;
3839
+ type index_d_LayoutType = LayoutType;
3840
+ declare const index_d_LayoutType: typeof LayoutType;
3841
+ type index_d_LineStyle = LineStyle;
3842
+ declare const index_d_LineStyle: typeof LineStyle;
3843
+ type index_d_Link = Link;
3844
+ type index_d_LinkData = LinkData;
3845
+ type index_d_LinkDataOneOf = LinkDataOneOf;
3846
+ type index_d_LinkPreviewData = LinkPreviewData;
3847
+ type index_d_ListCategoriesForItemOptions = ListCategoriesForItemOptions;
3848
+ type index_d_ListCategoriesForItemRequest = ListCategoriesForItemRequest;
3849
+ type index_d_ListCategoriesForItemResponse = ListCategoriesForItemResponse;
3850
+ type index_d_ListCategoriesForItemResponseNonNullableFields = ListCategoriesForItemResponseNonNullableFields;
3851
+ type index_d_ListCompactCategoriesByIdsRequest = ListCompactCategoriesByIdsRequest;
3852
+ type index_d_ListCompactCategoriesByIdsResponse = ListCompactCategoriesByIdsResponse;
3853
+ type index_d_ListItemsInCategoryOptions = ListItemsInCategoryOptions;
3854
+ type index_d_ListItemsInCategoryRequest = ListItemsInCategoryRequest;
3855
+ type index_d_ListItemsInCategoryRequestPagingMethodOneOf = ListItemsInCategoryRequestPagingMethodOneOf;
3856
+ type index_d_ListItemsInCategoryResponse = ListItemsInCategoryResponse;
3857
+ type index_d_ListItemsInCategoryResponseNonNullableFields = ListItemsInCategoryResponseNonNullableFields;
3858
+ type index_d_ListTreesRequest = ListTreesRequest;
3859
+ type index_d_ListTreesResponse = ListTreesResponse;
3860
+ type index_d_ListTreesResponseNonNullableFields = ListTreesResponseNonNullableFields;
3861
+ type index_d_ListValue = ListValue;
3862
+ type index_d_MapData = MapData;
3863
+ type index_d_MapSettings = MapSettings;
3864
+ type index_d_MapType = MapType;
3865
+ declare const index_d_MapType: typeof MapType;
3866
+ type index_d_MaskedCategory = MaskedCategory;
3867
+ type index_d_Media = Media;
3868
+ type index_d_MentionData = MentionData;
3869
+ type index_d_MessageEnvelope = MessageEnvelope;
3870
+ type index_d_Metadata = Metadata;
3871
+ type index_d_MissingValues = MissingValues;
3872
+ declare const index_d_MissingValues: typeof MissingValues;
3873
+ type index_d_Mode = Mode;
3874
+ declare const index_d_Mode: typeof Mode;
3875
+ type index_d_MoveCategoryOptions = MoveCategoryOptions;
3876
+ type index_d_MoveCategoryRequest = MoveCategoryRequest;
3877
+ type index_d_MoveCategoryResponse = MoveCategoryResponse;
3878
+ type index_d_MoveCategoryResponseNonNullableFields = MoveCategoryResponseNonNullableFields;
3879
+ type index_d_MoveItemInCategoryRequest = MoveItemInCategoryRequest;
3880
+ type index_d_MoveItemInCategoryRequestPosition = MoveItemInCategoryRequestPosition;
3881
+ declare const index_d_MoveItemInCategoryRequestPosition: typeof MoveItemInCategoryRequestPosition;
3882
+ type index_d_MoveItemInCategoryResponse = MoveItemInCategoryResponse;
3883
+ type index_d_NestedAggregation = NestedAggregation;
3884
+ type index_d_NestedAggregationItem = NestedAggregationItem;
3885
+ type index_d_NestedAggregationItemKindOneOf = NestedAggregationItemKindOneOf;
3886
+ type index_d_NestedAggregationNestedAggregationItem = NestedAggregationNestedAggregationItem;
3887
+ type index_d_NestedAggregationNestedAggregationItemKindOneOf = NestedAggregationNestedAggregationItemKindOneOf;
3888
+ type index_d_NestedAggregationNestedAggregationType = NestedAggregationNestedAggregationType;
3889
+ declare const index_d_NestedAggregationNestedAggregationType: typeof NestedAggregationNestedAggregationType;
3890
+ type index_d_NestedAggregationResults = NestedAggregationResults;
3891
+ type index_d_NestedAggregationResultsResultOneOf = NestedAggregationResultsResultOneOf;
3892
+ type index_d_NestedAggregationType = NestedAggregationType;
3893
+ declare const index_d_NestedAggregationType: typeof NestedAggregationType;
3894
+ type index_d_NestedResultValue = NestedResultValue;
3895
+ type index_d_NestedResultValueResultOneOf = NestedResultValueResultOneOf;
3896
+ type index_d_NestedResults = NestedResults;
3897
+ type index_d_NestedValueAggregationResult = NestedValueAggregationResult;
3898
+ type index_d_Node = Node;
3899
+ type index_d_NodeDataOneOf = NodeDataOneOf;
3900
+ type index_d_NodeStyle = NodeStyle;
3901
+ type index_d_NodeType = NodeType;
3902
+ declare const index_d_NodeType: typeof NodeType;
3903
+ type index_d_NullValue = NullValue;
3904
+ declare const index_d_NullValue: typeof NullValue;
3905
+ type index_d_Oembed = Oembed;
3906
+ type index_d_Option = Option;
3907
+ type index_d_OptionDesign = OptionDesign;
3908
+ type index_d_OptionLayout = OptionLayout;
3909
+ type index_d_OrderedListData = OrderedListData;
3910
+ type index_d_Orientation = Orientation;
3911
+ declare const index_d_Orientation: typeof Orientation;
3912
+ type index_d_PDFSettings = PDFSettings;
3913
+ type index_d_Page = Page;
3914
+ type index_d_Paging = Paging;
3915
+ type index_d_PagingMetadata = PagingMetadata;
3916
+ type index_d_PagingMetadataV2 = PagingMetadataV2;
3917
+ type index_d_ParagraphData = ParagraphData;
3918
+ type index_d_ParentCategory = ParentCategory;
3919
+ type index_d_Permissions = Permissions;
3920
+ type index_d_PlatformOffsetSearch = PlatformOffsetSearch;
3921
+ type index_d_PlatformOffsetSearchPagingMethodOneOf = PlatformOffsetSearchPagingMethodOneOf;
3922
+ type index_d_PlatformPaging = PlatformPaging;
3923
+ type index_d_PlatformPagingMetadataV2 = PlatformPagingMetadataV2;
3924
+ type index_d_PlaybackOptions = PlaybackOptions;
3925
+ type index_d_PluginContainerData = PluginContainerData;
3926
+ type index_d_PluginContainerDataAlignment = PluginContainerDataAlignment;
3927
+ declare const index_d_PluginContainerDataAlignment: typeof PluginContainerDataAlignment;
3928
+ type index_d_PluginContainerDataWidth = PluginContainerDataWidth;
3929
+ type index_d_PluginContainerDataWidthDataOneOf = PluginContainerDataWidthDataOneOf;
3930
+ type index_d_Poll = Poll;
3931
+ type index_d_PollData = PollData;
3932
+ type index_d_PollDataLayout = PollDataLayout;
3933
+ type index_d_PollDesign = PollDesign;
3934
+ type index_d_PollLayout = PollLayout;
3935
+ type index_d_PollLayoutDirection = PollLayoutDirection;
3936
+ declare const index_d_PollLayoutDirection: typeof PollLayoutDirection;
3937
+ type index_d_PollLayoutType = PollLayoutType;
3938
+ declare const index_d_PollLayoutType: typeof PollLayoutType;
3939
+ type index_d_PollSettings = PollSettings;
3940
+ type index_d_Position = Position;
3941
+ declare const index_d_Position: typeof Position;
3942
+ type index_d_QueryCategoriesRequest = QueryCategoriesRequest;
3943
+ type index_d_QueryCategoriesResponse = QueryCategoriesResponse;
3944
+ type index_d_QueryV2 = QueryV2;
3945
+ type index_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;
3946
+ type index_d_RangeAggregation = RangeAggregation;
3947
+ type index_d_RangeAggregationRangeBucket = RangeAggregationRangeBucket;
3948
+ type index_d_RangeAggregationResult = RangeAggregationResult;
3949
+ type index_d_RangeBucket = RangeBucket;
3950
+ type index_d_RangeResult = RangeResult;
3951
+ type index_d_RangeResults = RangeResults;
3952
+ type index_d_Rel = Rel;
3953
+ type index_d_RequestedFields = RequestedFields;
3954
+ declare const index_d_RequestedFields: typeof RequestedFields;
3955
+ type index_d_RestoreInfo = RestoreInfo;
3956
+ type index_d_Results = Results;
3957
+ type index_d_RichContent = RichContent;
3958
+ type index_d_ScalarAggregation = ScalarAggregation;
3959
+ type index_d_ScalarResult = ScalarResult;
3960
+ type index_d_ScalarType = ScalarType;
3961
+ declare const index_d_ScalarType: typeof ScalarType;
3962
+ type index_d_SearchCategoriesOptions = SearchCategoriesOptions;
3963
+ type index_d_SearchCategoriesRequest = SearchCategoriesRequest;
3964
+ type index_d_SearchCategoriesResponse = SearchCategoriesResponse;
3965
+ type index_d_SearchCategoriesResponseNonNullableFields = SearchCategoriesResponseNonNullableFields;
3966
+ type index_d_SearchDetails = SearchDetails;
3967
+ type index_d_SearchDetailsMode = SearchDetailsMode;
3968
+ declare const index_d_SearchDetailsMode: typeof SearchDetailsMode;
3969
+ type index_d_SeoSchema = SeoSchema;
3970
+ type index_d_SetArrangedItemsOptions = SetArrangedItemsOptions;
3971
+ type index_d_SetArrangedItemsRequest = SetArrangedItemsRequest;
3972
+ type index_d_SetArrangedItemsResponse = SetArrangedItemsResponse;
3973
+ type index_d_SetArrangedItemsResponseNonNullableFields = SetArrangedItemsResponseNonNullableFields;
3974
+ type index_d_Settings = Settings;
3975
+ type index_d_SortDirection = SortDirection;
3976
+ declare const index_d_SortDirection: typeof SortDirection;
3977
+ type index_d_SortOrder = SortOrder;
3978
+ declare const index_d_SortOrder: typeof SortOrder;
3979
+ type index_d_SortType = SortType;
3980
+ declare const index_d_SortType: typeof SortType;
3981
+ type index_d_Sorting = Sorting;
3982
+ type index_d_Source = Source;
3983
+ declare const index_d_Source: typeof Source;
3984
+ type index_d_Spoiler = Spoiler;
3985
+ type index_d_SpoilerData = SpoilerData;
3986
+ type index_d_Styles = Styles;
3987
+ type index_d_TableCellData = TableCellData;
3988
+ type index_d_TableData = TableData;
3989
+ type index_d_Tag = Tag;
3990
+ type index_d_Target = Target;
3991
+ declare const index_d_Target: typeof Target;
3992
+ type index_d_TextAlignment = TextAlignment;
3993
+ declare const index_d_TextAlignment: typeof TextAlignment;
3994
+ type index_d_TextData = TextData;
3995
+ type index_d_TextNodeStyle = TextNodeStyle;
3996
+ type index_d_TextStyle = TextStyle;
3997
+ type index_d_Thumbnails = Thumbnails;
3998
+ type index_d_ThumbnailsAlignment = ThumbnailsAlignment;
3999
+ declare const index_d_ThumbnailsAlignment: typeof ThumbnailsAlignment;
4000
+ type index_d_TreeReference = TreeReference;
4001
+ type index_d_Type = Type;
4002
+ declare const index_d_Type: typeof Type;
4003
+ type index_d_URI = URI;
4004
+ type index_d_UpdateCategory = UpdateCategory;
4005
+ type index_d_UpdateCategoryOptions = UpdateCategoryOptions;
4006
+ type index_d_UpdateCategoryRequest = UpdateCategoryRequest;
4007
+ type index_d_UpdateCategoryResponse = UpdateCategoryResponse;
4008
+ type index_d_UpdateCategoryResponseNonNullableFields = UpdateCategoryResponseNonNullableFields;
4009
+ type index_d_UpdateCategoryVisibilityOptions = UpdateCategoryVisibilityOptions;
4010
+ type index_d_UpdateCategoryVisibilityRequest = UpdateCategoryVisibilityRequest;
4011
+ type index_d_UpdateCategoryVisibilityResponse = UpdateCategoryVisibilityResponse;
4012
+ type index_d_UpdateCategoryVisibilityResponseNonNullableFields = UpdateCategoryVisibilityResponseNonNullableFields;
4013
+ type index_d_ValueAggregation = ValueAggregation;
4014
+ type index_d_ValueAggregationIncludeMissingValuesOptions = ValueAggregationIncludeMissingValuesOptions;
4015
+ type index_d_ValueAggregationMissingValues = ValueAggregationMissingValues;
4016
+ declare const index_d_ValueAggregationMissingValues: typeof ValueAggregationMissingValues;
4017
+ type index_d_ValueAggregationOptionsOneOf = ValueAggregationOptionsOneOf;
4018
+ type index_d_ValueAggregationResult = ValueAggregationResult;
4019
+ type index_d_ValueAggregationSortDirection = ValueAggregationSortDirection;
4020
+ declare const index_d_ValueAggregationSortDirection: typeof ValueAggregationSortDirection;
4021
+ type index_d_ValueAggregationSortType = ValueAggregationSortType;
4022
+ declare const index_d_ValueAggregationSortType: typeof ValueAggregationSortType;
4023
+ type index_d_ValueResult = ValueResult;
4024
+ type index_d_ValueResults = ValueResults;
4025
+ type index_d_VerticalAlignment = VerticalAlignment;
4026
+ declare const index_d_VerticalAlignment: typeof VerticalAlignment;
4027
+ type index_d_Video = Video;
4028
+ type index_d_VideoData = VideoData;
4029
+ type index_d_ViewMode = ViewMode;
4030
+ declare const index_d_ViewMode: typeof ViewMode;
4031
+ type index_d_ViewRole = ViewRole;
4032
+ declare const index_d_ViewRole: typeof ViewRole;
4033
+ type index_d_VoteRole = VoteRole;
4034
+ declare const index_d_VoteRole: typeof VoteRole;
4035
+ type index_d_WebhookIdentityType = WebhookIdentityType;
4036
+ declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
4037
+ type index_d_Width = Width;
4038
+ declare const index_d_Width: typeof Width;
4039
+ type index_d_WidthType = WidthType;
4040
+ declare const index_d_WidthType: typeof WidthType;
4041
+ declare const index_d_bulkAddItemToCategories: typeof bulkAddItemToCategories;
4042
+ declare const index_d_bulkAddItemsToCategory: typeof bulkAddItemsToCategory;
4043
+ declare const index_d_bulkRemoveItemFromCategories: typeof bulkRemoveItemFromCategories;
4044
+ declare const index_d_bulkRemoveItemsFromCategory: typeof bulkRemoveItemsFromCategory;
4045
+ declare const index_d_bulkUpdateCategories: typeof bulkUpdateCategories;
4046
+ declare const index_d_countCategories: typeof countCategories;
4047
+ declare const index_d_createCategory: typeof createCategory;
4048
+ declare const index_d_deleteCategory: typeof deleteCategory;
4049
+ declare const index_d_getArrangedItems: typeof getArrangedItems;
4050
+ declare const index_d_getCategory: typeof getCategory;
4051
+ declare const index_d_listCategoriesForItem: typeof listCategoriesForItem;
4052
+ declare const index_d_listItemsInCategory: typeof listItemsInCategory;
4053
+ declare const index_d_listTrees: typeof listTrees;
4054
+ declare const index_d_moveCategory: typeof moveCategory;
4055
+ declare const index_d_onCategoryCreated: typeof onCategoryCreated;
4056
+ declare const index_d_onCategoryDeleted: typeof onCategoryDeleted;
4057
+ declare const index_d_onCategoryItemAddedToCategory: typeof onCategoryItemAddedToCategory;
4058
+ declare const index_d_onCategoryItemRemovedFromCategory: typeof onCategoryItemRemovedFromCategory;
4059
+ declare const index_d_onCategoryItemsArrangedInCategory: typeof onCategoryItemsArrangedInCategory;
4060
+ declare const index_d_onCategoryMoved: typeof onCategoryMoved;
4061
+ declare const index_d_onCategoryUpdated: typeof onCategoryUpdated;
4062
+ declare const index_d_searchCategories: typeof searchCategories;
4063
+ declare const index_d_setArrangedItems: typeof setArrangedItems;
4064
+ declare const index_d_updateCategory: typeof updateCategory;
4065
+ declare const index_d_updateCategoryVisibility: typeof updateCategoryVisibility;
4066
+ declare namespace index_d {
4067
+ export { type index_d_ActionEvent as ActionEvent, type index_d_Aggregation as Aggregation, type index_d_AggregationData as AggregationData, type index_d_AggregationDateHistogramAggregation as AggregationDateHistogramAggregation, type index_d_AggregationKindOneOf as AggregationKindOneOf, type index_d_AggregationNestedAggregation as AggregationNestedAggregation, type index_d_AggregationRangeAggregation as AggregationRangeAggregation, type index_d_AggregationResults as AggregationResults, type index_d_AggregationResultsResultOneOf as AggregationResultsResultOneOf, type index_d_AggregationResultsScalarResult as AggregationResultsScalarResult, type index_d_AggregationScalarAggregation as AggregationScalarAggregation, index_d_AggregationType as AggregationType, type index_d_AggregationValueAggregation as AggregationValueAggregation, type index_d_AggregationValueAggregationOptionsOneOf as AggregationValueAggregationOptionsOneOf, index_d_Alignment as Alignment, type index_d_AnchorData as AnchorData, type index_d_App as App, type index_d_AppEmbedData as AppEmbedData, type index_d_AppEmbedDataAppDataOneOf as AppEmbedDataAppDataOneOf, index_d_AppType as AppType, type index_d_ApplicationError as ApplicationError, type index_d_AudioData as AudioData, type index_d_Background as Background, type index_d_BackgroundBackgroundOneOf as BackgroundBackgroundOneOf, index_d_BackgroundType as BackgroundType, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_BlockquoteData as BlockquoteData, type index_d_BookingData as BookingData, type index_d_Border as Border, type index_d_BorderColors as BorderColors, type index_d_BreadcrumbItem as BreadcrumbItem, type index_d_BreadcrumbItemValues as BreadcrumbItemValues, type index_d_BulkActionMetadata as BulkActionMetadata, type index_d_BulkAddItemToCategoriesOptions as BulkAddItemToCategoriesOptions, type index_d_BulkAddItemToCategoriesRequest as BulkAddItemToCategoriesRequest, type index_d_BulkAddItemToCategoriesResponse as BulkAddItemToCategoriesResponse, type index_d_BulkAddItemToCategoriesResponseNonNullableFields as BulkAddItemToCategoriesResponseNonNullableFields, type index_d_BulkAddItemsToCategoryOptions as BulkAddItemsToCategoryOptions, type index_d_BulkAddItemsToCategoryRequest as BulkAddItemsToCategoryRequest, type index_d_BulkAddItemsToCategoryResponse as BulkAddItemsToCategoryResponse, type index_d_BulkAddItemsToCategoryResponseNonNullableFields as BulkAddItemsToCategoryResponseNonNullableFields, type index_d_BulkCategoriesResult as BulkCategoriesResult, type index_d_BulkCreateCategoriesRequest as BulkCreateCategoriesRequest, type index_d_BulkCreateCategoriesResponse as BulkCreateCategoriesResponse, type index_d_BulkDeleteCategoriesByFilterRequest as BulkDeleteCategoriesByFilterRequest, type index_d_BulkDeleteCategoriesByFilterResponse as BulkDeleteCategoriesByFilterResponse, type index_d_BulkDeleteCategoriesRequest as BulkDeleteCategoriesRequest, type index_d_BulkDeleteCategoriesResponse as BulkDeleteCategoriesResponse, type index_d_BulkDeleteCategoriesResponseBulkCategoriesResult as BulkDeleteCategoriesResponseBulkCategoriesResult, type index_d_BulkItemToCategoriesResult as BulkItemToCategoriesResult, type index_d_BulkItemsToCategoryResult as BulkItemsToCategoryResult, type index_d_BulkRemoveItemFromCategoriesOptions as BulkRemoveItemFromCategoriesOptions, type index_d_BulkRemoveItemFromCategoriesRequest as BulkRemoveItemFromCategoriesRequest, type index_d_BulkRemoveItemFromCategoriesResponse as BulkRemoveItemFromCategoriesResponse, type index_d_BulkRemoveItemFromCategoriesResponseNonNullableFields as BulkRemoveItemFromCategoriesResponseNonNullableFields, type index_d_BulkRemoveItemsFromCategoryOptions as BulkRemoveItemsFromCategoryOptions, type index_d_BulkRemoveItemsFromCategoryRequest as BulkRemoveItemsFromCategoryRequest, type index_d_BulkRemoveItemsFromCategoryResponse as BulkRemoveItemsFromCategoryResponse, type index_d_BulkRemoveItemsFromCategoryResponseNonNullableFields as BulkRemoveItemsFromCategoryResponseNonNullableFields, type index_d_BulkUpdateCategoriesOptions as BulkUpdateCategoriesOptions, type index_d_BulkUpdateCategoriesRequest as BulkUpdateCategoriesRequest, type index_d_BulkUpdateCategoriesResponse as BulkUpdateCategoriesResponse, type index_d_BulkUpdateCategoriesResponseNonNullableFields as BulkUpdateCategoriesResponseNonNullableFields, type index_d_BulkUpdateCategoryVisibilityByFilterRequest as BulkUpdateCategoryVisibilityByFilterRequest, type index_d_BulkUpdateCategoryVisibilityByFilterResponse as BulkUpdateCategoryVisibilityByFilterResponse, type index_d_BulkUpdateCategoryVisibilityRequest as BulkUpdateCategoryVisibilityRequest, type index_d_BulkUpdateCategoryVisibilityResponse as BulkUpdateCategoryVisibilityResponse, type index_d_BulletedListData as BulletedListData, type index_d_ButtonData as ButtonData, type index_d_Category as Category, type index_d_CategoryCreatedEnvelope as CategoryCreatedEnvelope, type index_d_CategoryDeletedEnvelope as CategoryDeletedEnvelope, type index_d_CategoryItemAddedToCategoryEnvelope as CategoryItemAddedToCategoryEnvelope, type index_d_CategoryItemRemovedFromCategoryEnvelope as CategoryItemRemovedFromCategoryEnvelope, type index_d_CategoryItemsArrangedInCategoryEnvelope as CategoryItemsArrangedInCategoryEnvelope, type index_d_CategoryMoved as CategoryMoved, type index_d_CategoryMovedEnvelope as CategoryMovedEnvelope, type index_d_CategoryNonNullableFields as CategoryNonNullableFields, type index_d_CategoryTreeNode as CategoryTreeNode, type index_d_CategoryUpdatedEnvelope as CategoryUpdatedEnvelope, type index_d_CellStyle as CellStyle, type index_d_CodeBlockData as CodeBlockData, type index_d_CollapsibleListData as CollapsibleListData, type index_d_ColorData as ColorData, type index_d_Colors as Colors, type index_d_CommonAggregation as CommonAggregation, type index_d_CommonAggregationKindOneOf as CommonAggregationKindOneOf, index_d_CommonAggregationType as CommonAggregationType, type index_d_CommonCursors as CommonCursors, index_d_CommonScalarType as CommonScalarType, type index_d_CommonSearchDetails as CommonSearchDetails, index_d_CommonSortOrder as CommonSortOrder, type index_d_CommonSorting as CommonSorting, type index_d_CompactCategory as CompactCategory, type index_d_CountCategoriesOptions as CountCategoriesOptions, type index_d_CountCategoriesRequest as CountCategoriesRequest, type index_d_CountCategoriesResponse as CountCategoriesResponse, type index_d_CountCategoriesResponseNonNullableFields as CountCategoriesResponseNonNullableFields, type index_d_CreateCategoryOptions as CreateCategoryOptions, type index_d_CreateCategoryRequest as CreateCategoryRequest, type index_d_CreateCategoryResponse as CreateCategoryResponse, type index_d_CreateCategoryResponseNonNullableFields as CreateCategoryResponseNonNullableFields, index_d_Crop as Crop, type index_d_CursorPaging as CursorPaging, type index_d_CursorPagingMetadata as CursorPagingMetadata, type index_d_CursorSearch as CursorSearch, type index_d_CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOf, type index_d_Cursors as Cursors, type index_d_DateHistogramAggregation as DateHistogramAggregation, index_d_DateHistogramAggregationInterval as DateHistogramAggregationInterval, type index_d_DateHistogramResult as DateHistogramResult, type index_d_DateHistogramResults as DateHistogramResults, type index_d_Decoration as Decoration, type index_d_DecorationDataOneOf as DecorationDataOneOf, index_d_DecorationType as DecorationType, type index_d_DeleteCategoryRequest as DeleteCategoryRequest, type index_d_DeleteCategoryResponse as DeleteCategoryResponse, type index_d_DeprecatedSearchCategoriesWithOffsetRequest as DeprecatedSearchCategoriesWithOffsetRequest, type index_d_DeprecatedSearchCategoriesWithOffsetResponse as DeprecatedSearchCategoriesWithOffsetResponse, type index_d_Design as Design, type index_d_Dimensions as Dimensions, index_d_Direction as Direction, type index_d_DividerData as DividerData, type index_d_DocumentStyle as DocumentStyle, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_EmbedData as EmbedData, type index_d_Empty as Empty, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventData as EventData, type index_d_EventMetadata as EventMetadata, type index_d_ExtendedFields as ExtendedFields, type index_d_File as File, type index_d_FileData as FileData, type index_d_FileSource as FileSource, type index_d_FileSourceDataOneOf as FileSourceDataOneOf, type index_d_FontSizeData as FontSizeData, index_d_FontType as FontType, type index_d_GIF as GIF, type index_d_GIFData as GIFData, type index_d_GalleryData as GalleryData, type index_d_GalleryOptions as GalleryOptions, type index_d_GetArrangedItemsRequest as GetArrangedItemsRequest, type index_d_GetArrangedItemsResponse as GetArrangedItemsResponse, type index_d_GetArrangedItemsResponseNonNullableFields as GetArrangedItemsResponseNonNullableFields, type index_d_GetCategoriesTreeRequest as GetCategoriesTreeRequest, type index_d_GetCategoriesTreeResponse as GetCategoriesTreeResponse, type index_d_GetCategoryOptions as GetCategoryOptions, type index_d_GetCategoryRequest as GetCategoryRequest, type index_d_GetCategoryResponse as GetCategoryResponse, type index_d_GetCategoryResponseNonNullableFields as GetCategoryResponseNonNullableFields, type index_d_Gradient as Gradient, type index_d_GroupByAggregation as GroupByAggregation, type index_d_GroupByAggregationKindOneOf as GroupByAggregationKindOneOf, type index_d_GroupByValueResults as GroupByValueResults, type index_d_HTMLData as HTMLData, type index_d_HTMLDataDataOneOf as HTMLDataDataOneOf, type index_d_HeadingData as HeadingData, type index_d_Height as Height, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_Image as Image, type index_d_ImageData as ImageData, type index_d_IncludeMissingValuesOptions as IncludeMissingValuesOptions, index_d_InitialExpandedItems as InitialExpandedItems, index_d_Interval as Interval, type index_d_InvalidateCache as InvalidateCache, type index_d_InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOf, type index_d_Item as Item, type index_d_ItemAddedToCategory as ItemAddedToCategory, type index_d_ItemDataOneOf as ItemDataOneOf, type index_d_ItemMetadata as ItemMetadata, type index_d_ItemReference as ItemReference, type index_d_ItemReferenceMetadata as ItemReferenceMetadata, type index_d_ItemRemovedFromCategory as ItemRemovedFromCategory, type index_d_ItemStyle as ItemStyle, type index_d_ItemsAddedToCategory as ItemsAddedToCategory, type index_d_ItemsArrangedInCategory as ItemsArrangedInCategory, type index_d_ItemsRemovedFromCategory as ItemsRemovedFromCategory, type index_d_Keyword as Keyword, type index_d_Layout as Layout, index_d_LayoutType as LayoutType, index_d_LineStyle as LineStyle, type index_d_Link as Link, type index_d_LinkData as LinkData, type index_d_LinkDataOneOf as LinkDataOneOf, type index_d_LinkPreviewData as LinkPreviewData, type index_d_ListCategoriesForItemOptions as ListCategoriesForItemOptions, type index_d_ListCategoriesForItemRequest as ListCategoriesForItemRequest, type index_d_ListCategoriesForItemResponse as ListCategoriesForItemResponse, type index_d_ListCategoriesForItemResponseNonNullableFields as ListCategoriesForItemResponseNonNullableFields, type index_d_ListCompactCategoriesByIdsRequest as ListCompactCategoriesByIdsRequest, type index_d_ListCompactCategoriesByIdsResponse as ListCompactCategoriesByIdsResponse, type index_d_ListItemsInCategoryOptions as ListItemsInCategoryOptions, type index_d_ListItemsInCategoryRequest as ListItemsInCategoryRequest, type index_d_ListItemsInCategoryRequestPagingMethodOneOf as ListItemsInCategoryRequestPagingMethodOneOf, type index_d_ListItemsInCategoryResponse as ListItemsInCategoryResponse, type index_d_ListItemsInCategoryResponseNonNullableFields as ListItemsInCategoryResponseNonNullableFields, type index_d_ListTreesRequest as ListTreesRequest, type index_d_ListTreesResponse as ListTreesResponse, type index_d_ListTreesResponseNonNullableFields as ListTreesResponseNonNullableFields, type index_d_ListValue as ListValue, type index_d_MapData as MapData, type index_d_MapSettings as MapSettings, index_d_MapType as MapType, type index_d_MaskedCategory as MaskedCategory, type index_d_Media as Media, type index_d_MentionData as MentionData, type index_d_MessageEnvelope as MessageEnvelope, type index_d_Metadata as Metadata, index_d_MissingValues as MissingValues, index_d_Mode as Mode, type index_d_MoveCategoryOptions as MoveCategoryOptions, type index_d_MoveCategoryRequest as MoveCategoryRequest, type index_d_MoveCategoryResponse as MoveCategoryResponse, type index_d_MoveCategoryResponseNonNullableFields as MoveCategoryResponseNonNullableFields, type index_d_MoveItemInCategoryRequest as MoveItemInCategoryRequest, index_d_MoveItemInCategoryRequestPosition as MoveItemInCategoryRequestPosition, type index_d_MoveItemInCategoryResponse as MoveItemInCategoryResponse, type index_d_NestedAggregation as NestedAggregation, type index_d_NestedAggregationItem as NestedAggregationItem, type index_d_NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOf, type index_d_NestedAggregationNestedAggregationItem as NestedAggregationNestedAggregationItem, type index_d_NestedAggregationNestedAggregationItemKindOneOf as NestedAggregationNestedAggregationItemKindOneOf, index_d_NestedAggregationNestedAggregationType as NestedAggregationNestedAggregationType, type index_d_NestedAggregationResults as NestedAggregationResults, type index_d_NestedAggregationResultsResultOneOf as NestedAggregationResultsResultOneOf, index_d_NestedAggregationType as NestedAggregationType, type index_d_NestedResultValue as NestedResultValue, type index_d_NestedResultValueResultOneOf as NestedResultValueResultOneOf, type index_d_NestedResults as NestedResults, type index_d_NestedValueAggregationResult as NestedValueAggregationResult, type index_d_Node as Node, type index_d_NodeDataOneOf as NodeDataOneOf, type index_d_NodeStyle as NodeStyle, index_d_NodeType as NodeType, index_d_NullValue as NullValue, type index_d_Oembed as Oembed, type index_d_Option as Option, type index_d_OptionDesign as OptionDesign, type index_d_OptionLayout as OptionLayout, type index_d_OrderedListData as OrderedListData, index_d_Orientation as Orientation, type index_d_PDFSettings as PDFSettings, type index_d_Page as Page, type index_d_Paging as Paging, type index_d_PagingMetadata as PagingMetadata, type index_d_PagingMetadataV2 as PagingMetadataV2, type index_d_ParagraphData as ParagraphData, type index_d_ParentCategory as ParentCategory, type index_d_Permissions as Permissions, type index_d_PlatformOffsetSearch as PlatformOffsetSearch, type index_d_PlatformOffsetSearchPagingMethodOneOf as PlatformOffsetSearchPagingMethodOneOf, type index_d_PlatformPaging as PlatformPaging, type index_d_PlatformPagingMetadataV2 as PlatformPagingMetadataV2, type index_d_PlaybackOptions as PlaybackOptions, type index_d_PluginContainerData as PluginContainerData, index_d_PluginContainerDataAlignment as PluginContainerDataAlignment, type index_d_PluginContainerDataWidth as PluginContainerDataWidth, type index_d_PluginContainerDataWidthDataOneOf as PluginContainerDataWidthDataOneOf, type index_d_Poll as Poll, type index_d_PollData as PollData, type index_d_PollDataLayout as PollDataLayout, type index_d_PollDesign as PollDesign, type index_d_PollLayout as PollLayout, index_d_PollLayoutDirection as PollLayoutDirection, index_d_PollLayoutType as PollLayoutType, type index_d_PollSettings as PollSettings, index_d_Position as Position, type index_d_QueryCategoriesRequest as QueryCategoriesRequest, type index_d_QueryCategoriesResponse as QueryCategoriesResponse, type index_d_QueryV2 as QueryV2, type index_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, type index_d_RangeAggregation as RangeAggregation, type index_d_RangeAggregationRangeBucket as RangeAggregationRangeBucket, type index_d_RangeAggregationResult as RangeAggregationResult, type index_d_RangeBucket as RangeBucket, type index_d_RangeResult as RangeResult, type index_d_RangeResults as RangeResults, type index_d_Rel as Rel, index_d_RequestedFields as RequestedFields, type index_d_RestoreInfo as RestoreInfo, type index_d_Results as Results, type index_d_RichContent as RichContent, type index_d_ScalarAggregation as ScalarAggregation, type index_d_ScalarResult as ScalarResult, index_d_ScalarType as ScalarType, type index_d_SearchCategoriesOptions as SearchCategoriesOptions, type index_d_SearchCategoriesRequest as SearchCategoriesRequest, type index_d_SearchCategoriesResponse as SearchCategoriesResponse, type index_d_SearchCategoriesResponseNonNullableFields as SearchCategoriesResponseNonNullableFields, type index_d_SearchDetails as SearchDetails, index_d_SearchDetailsMode as SearchDetailsMode, type index_d_SeoSchema as SeoSchema, type index_d_SetArrangedItemsOptions as SetArrangedItemsOptions, type index_d_SetArrangedItemsRequest as SetArrangedItemsRequest, type index_d_SetArrangedItemsResponse as SetArrangedItemsResponse, type index_d_SetArrangedItemsResponseNonNullableFields as SetArrangedItemsResponseNonNullableFields, type index_d_Settings as Settings, index_d_SortDirection as SortDirection, index_d_SortOrder as SortOrder, index_d_SortType as SortType, type index_d_Sorting as Sorting, index_d_Source as Source, type index_d_Spoiler as Spoiler, type index_d_SpoilerData as SpoilerData, type index_d_Styles as Styles, type index_d_TableCellData as TableCellData, type index_d_TableData as TableData, type index_d_Tag as Tag, index_d_Target as Target, index_d_TextAlignment as TextAlignment, type index_d_TextData as TextData, type index_d_TextNodeStyle as TextNodeStyle, type index_d_TextStyle as TextStyle, type index_d_Thumbnails as Thumbnails, index_d_ThumbnailsAlignment as ThumbnailsAlignment, type index_d_TreeReference as TreeReference, index_d_Type as Type, type index_d_URI as URI, type index_d_UpdateCategory as UpdateCategory, type index_d_UpdateCategoryOptions as UpdateCategoryOptions, type index_d_UpdateCategoryRequest as UpdateCategoryRequest, type index_d_UpdateCategoryResponse as UpdateCategoryResponse, type index_d_UpdateCategoryResponseNonNullableFields as UpdateCategoryResponseNonNullableFields, type index_d_UpdateCategoryVisibilityOptions as UpdateCategoryVisibilityOptions, type index_d_UpdateCategoryVisibilityRequest as UpdateCategoryVisibilityRequest, type index_d_UpdateCategoryVisibilityResponse as UpdateCategoryVisibilityResponse, type index_d_UpdateCategoryVisibilityResponseNonNullableFields as UpdateCategoryVisibilityResponseNonNullableFields, type index_d_ValueAggregation as ValueAggregation, type index_d_ValueAggregationIncludeMissingValuesOptions as ValueAggregationIncludeMissingValuesOptions, index_d_ValueAggregationMissingValues as ValueAggregationMissingValues, type index_d_ValueAggregationOptionsOneOf as ValueAggregationOptionsOneOf, type index_d_ValueAggregationResult as ValueAggregationResult, index_d_ValueAggregationSortDirection as ValueAggregationSortDirection, index_d_ValueAggregationSortType as ValueAggregationSortType, type index_d_ValueResult as ValueResult, type index_d_ValueResults as ValueResults, index_d_VerticalAlignment as VerticalAlignment, type index_d_Video as Video, type index_d_VideoData as VideoData, index_d_ViewMode as ViewMode, index_d_ViewRole as ViewRole, index_d_VoteRole as VoteRole, index_d_WebhookIdentityType as WebhookIdentityType, index_d_Width as Width, index_d_WidthType as WidthType, index_d_bulkAddItemToCategories as bulkAddItemToCategories, index_d_bulkAddItemsToCategory as bulkAddItemsToCategory, index_d_bulkRemoveItemFromCategories as bulkRemoveItemFromCategories, index_d_bulkRemoveItemsFromCategory as bulkRemoveItemsFromCategory, index_d_bulkUpdateCategories as bulkUpdateCategories, index_d_countCategories as countCategories, index_d_createCategory as createCategory, index_d_deleteCategory as deleteCategory, index_d_getArrangedItems as getArrangedItems, index_d_getCategory as getCategory, index_d_listCategoriesForItem as listCategoriesForItem, index_d_listItemsInCategory as listItemsInCategory, index_d_listTrees as listTrees, index_d_moveCategory as moveCategory, index_d_onCategoryCreated as onCategoryCreated, index_d_onCategoryDeleted as onCategoryDeleted, index_d_onCategoryItemAddedToCategory as onCategoryItemAddedToCategory, index_d_onCategoryItemRemovedFromCategory as onCategoryItemRemovedFromCategory, index_d_onCategoryItemsArrangedInCategory as onCategoryItemsArrangedInCategory, index_d_onCategoryMoved as onCategoryMoved, index_d_onCategoryUpdated as onCategoryUpdated, index_d_searchCategories as searchCategories, index_d_setArrangedItems as setArrangedItems, index_d_updateCategory as updateCategory, index_d_updateCategoryVisibility as updateCategoryVisibility };
4068
+ }
4069
+
4070
+ export { index_d as categories };