@wix/auto_sdk_categories_categories 1.0.37 → 1.0.39

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/build/categories-v1-category-categories.universal-DEpZWCgU.d.mts +3874 -0
  2. package/build/categories-v1-category-categories.universal-DEpZWCgU.d.ts +3874 -0
  3. package/build/index.d.mts +267 -0
  4. package/build/index.d.ts +267 -0
  5. package/build/index.js +2948 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +2853 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/categories-v1-category-categories.universal-DEpZWCgU.d.mts +3874 -0
  10. package/build/internal/categories-v1-category-categories.universal-DEpZWCgU.d.ts +3874 -0
  11. package/build/internal/index.d.mts +267 -0
  12. package/build/internal/index.d.ts +267 -0
  13. package/build/internal/index.js +2948 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +2853 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/{es/src/categories-v1-category-categories.types.d.ts → internal/meta.d.mts} +290 -883
  18. package/build/internal/{cjs/src/categories-v1-category-categories.types.d.ts → meta.d.ts} +290 -883
  19. package/build/internal/meta.js +1679 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +1632 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/{cjs/src/categories-v1-category-categories.types.d.ts → meta.d.mts} +290 -883
  24. package/build/{internal/es/src/categories-v1-category-categories.types.d.ts → meta.d.ts} +290 -883
  25. package/build/meta.js +1679 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +1632 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +13 -12
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/categories-v1-category-categories.context.d.ts +0 -55
  40. package/build/cjs/src/categories-v1-category-categories.context.js +0 -103
  41. package/build/cjs/src/categories-v1-category-categories.context.js.map +0 -1
  42. package/build/cjs/src/categories-v1-category-categories.http.d.ts +0 -102
  43. package/build/cjs/src/categories-v1-category-categories.http.js +0 -1332
  44. package/build/cjs/src/categories-v1-category-categories.http.js.map +0 -1
  45. package/build/cjs/src/categories-v1-category-categories.meta.d.ts +0 -51
  46. package/build/cjs/src/categories-v1-category-categories.meta.js +0 -427
  47. package/build/cjs/src/categories-v1-category-categories.meta.js.map +0 -1
  48. package/build/cjs/src/categories-v1-category-categories.public.d.ts +0 -229
  49. package/build/cjs/src/categories-v1-category-categories.public.js +0 -410
  50. package/build/cjs/src/categories-v1-category-categories.public.js.map +0 -1
  51. package/build/cjs/src/categories-v1-category-categories.types.js +0 -438
  52. package/build/cjs/src/categories-v1-category-categories.types.js.map +0 -1
  53. package/build/cjs/src/categories-v1-category-categories.universal.d.ts +0 -4695
  54. package/build/cjs/src/categories-v1-category-categories.universal.js +0 -1763
  55. package/build/cjs/src/categories-v1-category-categories.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/categories-v1-category-categories.context.d.ts +0 -55
  67. package/build/es/src/categories-v1-category-categories.context.js +0 -55
  68. package/build/es/src/categories-v1-category-categories.context.js.map +0 -1
  69. package/build/es/src/categories-v1-category-categories.http.d.ts +0 -102
  70. package/build/es/src/categories-v1-category-categories.http.js +0 -1308
  71. package/build/es/src/categories-v1-category-categories.http.js.map +0 -1
  72. package/build/es/src/categories-v1-category-categories.meta.d.ts +0 -51
  73. package/build/es/src/categories-v1-category-categories.meta.js +0 -380
  74. package/build/es/src/categories-v1-category-categories.meta.js.map +0 -1
  75. package/build/es/src/categories-v1-category-categories.public.d.ts +0 -229
  76. package/build/es/src/categories-v1-category-categories.public.js +0 -341
  77. package/build/es/src/categories-v1-category-categories.public.js.map +0 -1
  78. package/build/es/src/categories-v1-category-categories.types.js +0 -435
  79. package/build/es/src/categories-v1-category-categories.types.js.map +0 -1
  80. package/build/es/src/categories-v1-category-categories.universal.d.ts +0 -4695
  81. package/build/es/src/categories-v1-category-categories.universal.js +0 -1715
  82. package/build/es/src/categories-v1-category-categories.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/categories-v1-category-categories.context.d.ts +0 -55
  93. package/build/internal/cjs/src/categories-v1-category-categories.context.js +0 -103
  94. package/build/internal/cjs/src/categories-v1-category-categories.context.js.map +0 -1
  95. package/build/internal/cjs/src/categories-v1-category-categories.http.d.ts +0 -102
  96. package/build/internal/cjs/src/categories-v1-category-categories.http.js +0 -1332
  97. package/build/internal/cjs/src/categories-v1-category-categories.http.js.map +0 -1
  98. package/build/internal/cjs/src/categories-v1-category-categories.meta.d.ts +0 -51
  99. package/build/internal/cjs/src/categories-v1-category-categories.meta.js +0 -427
  100. package/build/internal/cjs/src/categories-v1-category-categories.meta.js.map +0 -1
  101. package/build/internal/cjs/src/categories-v1-category-categories.public.d.ts +0 -229
  102. package/build/internal/cjs/src/categories-v1-category-categories.public.js +0 -410
  103. package/build/internal/cjs/src/categories-v1-category-categories.public.js.map +0 -1
  104. package/build/internal/cjs/src/categories-v1-category-categories.types.js +0 -438
  105. package/build/internal/cjs/src/categories-v1-category-categories.types.js.map +0 -1
  106. package/build/internal/cjs/src/categories-v1-category-categories.universal.d.ts +0 -4695
  107. package/build/internal/cjs/src/categories-v1-category-categories.universal.js +0 -1763
  108. package/build/internal/cjs/src/categories-v1-category-categories.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/categories-v1-category-categories.context.d.ts +0 -55
  119. package/build/internal/es/src/categories-v1-category-categories.context.js +0 -55
  120. package/build/internal/es/src/categories-v1-category-categories.context.js.map +0 -1
  121. package/build/internal/es/src/categories-v1-category-categories.http.d.ts +0 -102
  122. package/build/internal/es/src/categories-v1-category-categories.http.js +0 -1308
  123. package/build/internal/es/src/categories-v1-category-categories.http.js.map +0 -1
  124. package/build/internal/es/src/categories-v1-category-categories.meta.d.ts +0 -51
  125. package/build/internal/es/src/categories-v1-category-categories.meta.js +0 -380
  126. package/build/internal/es/src/categories-v1-category-categories.meta.js.map +0 -1
  127. package/build/internal/es/src/categories-v1-category-categories.public.d.ts +0 -229
  128. package/build/internal/es/src/categories-v1-category-categories.public.js +0 -341
  129. package/build/internal/es/src/categories-v1-category-categories.public.js.map +0 -1
  130. package/build/internal/es/src/categories-v1-category-categories.types.js +0 -435
  131. package/build/internal/es/src/categories-v1-category-categories.types.js.map +0 -1
  132. package/build/internal/es/src/categories-v1-category-categories.universal.d.ts +0 -4695
  133. package/build/internal/es/src/categories-v1-category-categories.universal.js +0 -1715
  134. package/build/internal/es/src/categories-v1-category-categories.universal.js.map +0 -1
@@ -0,0 +1,3874 @@
1
+ interface Category {
2
+ /**
3
+ * Category ID.
4
+ * @format GUID
5
+ * @immutable
6
+ */
7
+ _id?: string | null;
8
+ /**
9
+ * Revision number, which increments by 1 each time the category is updated.
10
+ * To prevent conflicting changes, the current revision must be passed when updating.
11
+ *
12
+ * Ignored when creating a category.
13
+ * @readonly
14
+ */
15
+ revision?: string | null;
16
+ /**
17
+ * Date and time the category was created.
18
+ * @readonly
19
+ */
20
+ _createdDate?: Date | null;
21
+ /**
22
+ * Date and time the category was updated.
23
+ * @readonly
24
+ */
25
+ _updatedDate?: Date | null;
26
+ /**
27
+ * Category name.
28
+ * @minLength 1
29
+ * @maxLength 80
30
+ */
31
+ name?: string | null;
32
+ /**
33
+ * Category image.
34
+ *
35
+ * + Pass WixMedia image ID for media previously saved in the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager).
36
+ * + Pass full image URL to upload to Wix Media Manager.
37
+ */
38
+ image?: string;
39
+ /**
40
+ * Number of items in this category.
41
+ * @readonly
42
+ */
43
+ itemCounter?: number;
44
+ /**
45
+ * Category description.
46
+ * > **Note:** This field is returned only when you pass `fields: "DESCRIPTION"` in the request.
47
+ * @minLength 1
48
+ * @maxLength 600
49
+ */
50
+ description?: string | null;
51
+ /**
52
+ * Whether the category is visible to site visitors in dynamic pages.
53
+ *
54
+ * + If the parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
55
+ * + Passing `true` will fail if the visibility of any parent categories is `false`.
56
+ * + Default: `false`.
57
+ * @immutable
58
+ */
59
+ visible?: boolean | null;
60
+ /**
61
+ * Category breadcrumbs.
62
+ *
63
+ * > **Note:** Returned only when you pass `"BREADCRUMBS_INFO"` to the `fields` array in Categories API requests.
64
+ * @readonly
65
+ */
66
+ breadcrumbsInfo?: BreadcrumbsInfo;
67
+ /**
68
+ * Parent category reference data.
69
+ * @immutable
70
+ */
71
+ parentCategory?: ParentCategory;
72
+ /**
73
+ * Category slug.
74
+ *
75
+ * If not provided, the slug is autogenerated based on the category name.
76
+ * @format URL_SLUG
77
+ */
78
+ slug?: string | null;
79
+ /**
80
+ * Category description using rich content.
81
+ * > **Note:** Returned only when you pass `"RICH_CONTENT_DESCRIPTION"` to the `fields` array in Categories API requests.
82
+ *
83
+ * <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="indent.emoji.divider.codeBlock.file.gallery.giphy.image.table.link.textHighlight.textColor" exampleid="7dc9240e-d548-417a-abcf-0291b68b4303">
84
+ * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
85
+ * </widget>
86
+ */
87
+ richContentDescription?: RichContent;
88
+ /**
89
+ * ID of the app responsible for managing the items in this category.
90
+ *
91
+ * Pass your app ID to restrict updating and deleting items in this category to your app only.
92
+ * @format GUID
93
+ * @immutable
94
+ */
95
+ managingAppId?: string | null;
96
+ /**
97
+ * Custom extended fields for the category object.
98
+ *
99
+ * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.
100
+ */
101
+ extendedFields?: ExtendedFields;
102
+ }
103
+ interface BreadcrumbsInfo {
104
+ /**
105
+ * List of breadcrumb data. The current category isn't included in the list.
106
+ * @readonly
107
+ * @maxSize 5
108
+ */
109
+ breadcrumbs?: Breadcrumb[];
110
+ }
111
+ interface Breadcrumb {
112
+ /**
113
+ * Category ID.
114
+ * @format GUID
115
+ */
116
+ categoryId?: string;
117
+ /**
118
+ * Category name.
119
+ * @minLength 1
120
+ * @maxLength 80
121
+ */
122
+ categoryName?: string;
123
+ /**
124
+ * Category slug.
125
+ * @minLength 1
126
+ * @maxLength 100
127
+ */
128
+ categorySlug?: string;
129
+ }
130
+ interface ParentCategory {
131
+ /**
132
+ * Parent category ID.
133
+ *
134
+ * Default: root category ID
135
+ * @format GUID
136
+ */
137
+ _id?: string | null;
138
+ /**
139
+ * Index position of the category within the parent category.
140
+ * @readonly
141
+ */
142
+ index?: number | null;
143
+ }
144
+ /**
145
+ * 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.
146
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
147
+ * 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.
148
+ */
149
+ interface SeoSchema {
150
+ /** SEO tag information. */
151
+ tags?: Tag[];
152
+ /** SEO general settings. */
153
+ settings?: Settings;
154
+ }
155
+ interface Keyword {
156
+ /** Keyword value. */
157
+ term?: string;
158
+ /** Whether the keyword is the main focus keyword. */
159
+ isMain?: boolean;
160
+ /**
161
+ * The source that added the keyword terms to the SEO settings.
162
+ * @maxLength 1000
163
+ */
164
+ origin?: string | null;
165
+ }
166
+ interface Tag {
167
+ /**
168
+ * SEO tag type.
169
+ *
170
+ *
171
+ * Supported values: `title`, `meta`, `script`, `link`.
172
+ */
173
+ type?: string;
174
+ /**
175
+ * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
176
+ * For example: `{"name": "description", "content": "the description itself"}`.
177
+ */
178
+ props?: Record<string, any> | null;
179
+ /** SEO tag meta data. For example, `{"height": 300, "width": 240}`. */
180
+ meta?: Record<string, any> | null;
181
+ /** SEO tag inner content. For example, `<title> inner content </title>`. */
182
+ children?: string;
183
+ /** Whether the tag is a custom tag. */
184
+ custom?: boolean;
185
+ /** Whether the tag is disabled. */
186
+ disabled?: boolean;
187
+ }
188
+ interface Settings {
189
+ /**
190
+ * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
191
+ *
192
+ *
193
+ * Default: `false` (Auto Redirect is enabled.)
194
+ */
195
+ preventAutoRedirect?: boolean;
196
+ /**
197
+ * User-selected keyword terms for a specific page.
198
+ * @maxSize 5
199
+ */
200
+ keywords?: Keyword[];
201
+ }
202
+ interface RichContent {
203
+ /** Node objects representing a rich content document. */
204
+ nodes?: Node[];
205
+ /** Object metadata. */
206
+ metadata?: Metadata;
207
+ /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
208
+ documentStyle?: DocumentStyle;
209
+ }
210
+ interface Node extends NodeDataOneOf {
211
+ /** Data for a button node. */
212
+ buttonData?: ButtonData;
213
+ /** Data for a code block node. */
214
+ codeBlockData?: CodeBlockData;
215
+ /** Data for a divider node. */
216
+ dividerData?: DividerData;
217
+ /** Data for a file node. */
218
+ fileData?: FileData;
219
+ /** Data for a gallery node. */
220
+ galleryData?: GalleryData;
221
+ /** Data for a GIF node. */
222
+ gifData?: GIFData;
223
+ /** Data for a heading node. */
224
+ headingData?: HeadingData;
225
+ /** Data for an embedded HTML node. */
226
+ htmlData?: HTMLData;
227
+ /** Data for an image node. */
228
+ imageData?: ImageData;
229
+ /** Data for a link preview node. */
230
+ linkPreviewData?: LinkPreviewData;
231
+ /** @deprecated */
232
+ mapData?: MapData;
233
+ /** Data for a paragraph node. */
234
+ paragraphData?: ParagraphData;
235
+ /** Data for a poll node. */
236
+ pollData?: PollData;
237
+ /** Data for a text node. Used to apply decorations to text. */
238
+ textData?: TextData;
239
+ /** Data for an app embed node. */
240
+ appEmbedData?: AppEmbedData;
241
+ /** Data for a video node. */
242
+ videoData?: VideoData;
243
+ /** Data for an oEmbed node. */
244
+ embedData?: EmbedData;
245
+ /** Data for a collapsible list node. */
246
+ collapsibleListData?: CollapsibleListData;
247
+ /** Data for a table node. */
248
+ tableData?: TableData;
249
+ /** Data for a table cell node. */
250
+ tableCellData?: TableCellData;
251
+ /** Data for a custom external node. */
252
+ externalData?: Record<string, any> | null;
253
+ /** Data for an audio node. */
254
+ audioData?: AudioData;
255
+ /** Data for an ordered list node. */
256
+ orderedListData?: OrderedListData;
257
+ /** Data for a bulleted list node. */
258
+ bulletedListData?: BulletedListData;
259
+ /** Data for a block quote node. */
260
+ blockquoteData?: BlockquoteData;
261
+ /** Data for a caption node. */
262
+ captionData?: CaptionData;
263
+ /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
264
+ layoutCellData?: LayoutCellData;
265
+ /** 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. */
266
+ type?: NodeType;
267
+ /** Node ID. */
268
+ _id?: string;
269
+ /** A list of child nodes. */
270
+ nodes?: Node[];
271
+ /** Padding and background color styling for the node. */
272
+ style?: NodeStyle;
273
+ }
274
+ /** @oneof */
275
+ interface NodeDataOneOf {
276
+ /** Data for a button node. */
277
+ buttonData?: ButtonData;
278
+ /** Data for a code block node. */
279
+ codeBlockData?: CodeBlockData;
280
+ /** Data for a divider node. */
281
+ dividerData?: DividerData;
282
+ /** Data for a file node. */
283
+ fileData?: FileData;
284
+ /** Data for a gallery node. */
285
+ galleryData?: GalleryData;
286
+ /** Data for a GIF node. */
287
+ gifData?: GIFData;
288
+ /** Data for a heading node. */
289
+ headingData?: HeadingData;
290
+ /** Data for an embedded HTML node. */
291
+ htmlData?: HTMLData;
292
+ /** Data for an image node. */
293
+ imageData?: ImageData;
294
+ /** Data for a link preview node. */
295
+ linkPreviewData?: LinkPreviewData;
296
+ /** @deprecated */
297
+ mapData?: MapData;
298
+ /** Data for a paragraph node. */
299
+ paragraphData?: ParagraphData;
300
+ /** Data for a poll node. */
301
+ pollData?: PollData;
302
+ /** Data for a text node. Used to apply decorations to text. */
303
+ textData?: TextData;
304
+ /** Data for an app embed node. */
305
+ appEmbedData?: AppEmbedData;
306
+ /** Data for a video node. */
307
+ videoData?: VideoData;
308
+ /** Data for an oEmbed node. */
309
+ embedData?: EmbedData;
310
+ /** Data for a collapsible list node. */
311
+ collapsibleListData?: CollapsibleListData;
312
+ /** Data for a table node. */
313
+ tableData?: TableData;
314
+ /** Data for a table cell node. */
315
+ tableCellData?: TableCellData;
316
+ /** Data for a custom external node. */
317
+ externalData?: Record<string, any> | null;
318
+ /** Data for an audio node. */
319
+ audioData?: AudioData;
320
+ /** Data for an ordered list node. */
321
+ orderedListData?: OrderedListData;
322
+ /** Data for a bulleted list node. */
323
+ bulletedListData?: BulletedListData;
324
+ /** Data for a block quote node. */
325
+ blockquoteData?: BlockquoteData;
326
+ /** Data for a caption node. */
327
+ captionData?: CaptionData;
328
+ /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
329
+ layoutCellData?: LayoutCellData;
330
+ }
331
+ declare enum NodeType {
332
+ PARAGRAPH = "PARAGRAPH",
333
+ TEXT = "TEXT",
334
+ HEADING = "HEADING",
335
+ BULLETED_LIST = "BULLETED_LIST",
336
+ ORDERED_LIST = "ORDERED_LIST",
337
+ LIST_ITEM = "LIST_ITEM",
338
+ BLOCKQUOTE = "BLOCKQUOTE",
339
+ CODE_BLOCK = "CODE_BLOCK",
340
+ VIDEO = "VIDEO",
341
+ DIVIDER = "DIVIDER",
342
+ FILE = "FILE",
343
+ GALLERY = "GALLERY",
344
+ GIF = "GIF",
345
+ HTML = "HTML",
346
+ IMAGE = "IMAGE",
347
+ LINK_PREVIEW = "LINK_PREVIEW",
348
+ /** @deprecated */
349
+ MAP = "MAP",
350
+ POLL = "POLL",
351
+ APP_EMBED = "APP_EMBED",
352
+ BUTTON = "BUTTON",
353
+ COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
354
+ TABLE = "TABLE",
355
+ EMBED = "EMBED",
356
+ COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
357
+ COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
358
+ COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
359
+ TABLE_CELL = "TABLE_CELL",
360
+ TABLE_ROW = "TABLE_ROW",
361
+ EXTERNAL = "EXTERNAL",
362
+ AUDIO = "AUDIO",
363
+ CAPTION = "CAPTION",
364
+ LAYOUT = "LAYOUT",
365
+ LAYOUT_CELL = "LAYOUT_CELL"
366
+ }
367
+ interface NodeStyle {
368
+ /** The top padding value in pixels. */
369
+ paddingTop?: string | null;
370
+ /** The bottom padding value in pixels. */
371
+ paddingBottom?: string | null;
372
+ /** The background color as a hexadecimal value. */
373
+ backgroundColor?: string | null;
374
+ }
375
+ interface ButtonData {
376
+ /** Styling for the button's container. */
377
+ containerData?: PluginContainerData;
378
+ /** The button type. */
379
+ type?: Type;
380
+ /** Styling for the button. */
381
+ styles?: Styles;
382
+ /** The text to display on the button. */
383
+ text?: string | null;
384
+ /** Button link details. */
385
+ link?: Link;
386
+ }
387
+ interface Border {
388
+ /**
389
+ * Deprecated: Use `borderWidth` in `styles` instead.
390
+ * @deprecated
391
+ */
392
+ width?: number | null;
393
+ /**
394
+ * Deprecated: Use `borderRadius` in `styles` instead.
395
+ * @deprecated
396
+ */
397
+ radius?: number | null;
398
+ }
399
+ interface Colors {
400
+ /**
401
+ * Deprecated: Use `textColor` in `styles` instead.
402
+ * @deprecated
403
+ */
404
+ text?: string | null;
405
+ /**
406
+ * Deprecated: Use `borderColor` in `styles` instead.
407
+ * @deprecated
408
+ */
409
+ border?: string | null;
410
+ /**
411
+ * Deprecated: Use `backgroundColor` in `styles` instead.
412
+ * @deprecated
413
+ */
414
+ background?: string | null;
415
+ }
416
+ interface PluginContainerData {
417
+ /** The width of the node when it's displayed. */
418
+ width?: PluginContainerDataWidth;
419
+ /** The node's alignment within its container. */
420
+ alignment?: PluginContainerDataAlignment;
421
+ /** Spoiler cover settings for the node. */
422
+ spoiler?: Spoiler;
423
+ /** The height of the node when it's displayed. */
424
+ height?: Height;
425
+ /** 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`. */
426
+ textWrap?: boolean | null;
427
+ }
428
+ declare enum WidthType {
429
+ /** Width matches the content width */
430
+ CONTENT = "CONTENT",
431
+ /** Small Width */
432
+ SMALL = "SMALL",
433
+ /** Width will match the original asset width */
434
+ ORIGINAL = "ORIGINAL",
435
+ /** coast-to-coast display */
436
+ FULL_WIDTH = "FULL_WIDTH"
437
+ }
438
+ interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
439
+ /**
440
+ * One of the following predefined width options:
441
+ * `CONTENT`: The width of the container matches the content width.
442
+ * `SMALL`: A small width.
443
+ * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
444
+ * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
445
+ */
446
+ size?: WidthType;
447
+ /** A custom width value in pixels. */
448
+ custom?: string | null;
449
+ }
450
+ /** @oneof */
451
+ interface PluginContainerDataWidthDataOneOf {
452
+ /**
453
+ * One of the following predefined width options:
454
+ * `CONTENT`: The width of the container matches the content width.
455
+ * `SMALL`: A small width.
456
+ * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
457
+ * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
458
+ */
459
+ size?: WidthType;
460
+ /** A custom width value in pixels. */
461
+ custom?: string | null;
462
+ }
463
+ declare enum PluginContainerDataAlignment {
464
+ /** Center Alignment */
465
+ CENTER = "CENTER",
466
+ /** Left Alignment */
467
+ LEFT = "LEFT",
468
+ /** Right Alignment */
469
+ RIGHT = "RIGHT"
470
+ }
471
+ interface Spoiler {
472
+ /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
473
+ enabled?: boolean | null;
474
+ /** The description displayed on top of the spoiler cover. */
475
+ description?: string | null;
476
+ /** The text for the button used to remove the spoiler cover. */
477
+ buttonText?: string | null;
478
+ }
479
+ interface Height {
480
+ /** A custom height value in pixels. */
481
+ custom?: string | null;
482
+ }
483
+ declare enum Type {
484
+ /** Regular link button */
485
+ LINK = "LINK",
486
+ /** Triggers custom action that is defined in plugin configuration by the consumer */
487
+ ACTION = "ACTION"
488
+ }
489
+ interface Styles {
490
+ /**
491
+ * Deprecated: Use `borderWidth` and `borderRadius` instead.
492
+ * @deprecated
493
+ */
494
+ border?: Border;
495
+ /**
496
+ * Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
497
+ * @deprecated
498
+ */
499
+ colors?: Colors;
500
+ /** Border width in pixels. */
501
+ borderWidth?: number | null;
502
+ /**
503
+ * Deprecated: Use `borderWidth` for normal/hover states instead.
504
+ * @deprecated
505
+ */
506
+ borderWidthHover?: number | null;
507
+ /** Border radius in pixels. */
508
+ borderRadius?: number | null;
509
+ /**
510
+ * Border color as a hexadecimal value.
511
+ * @format COLOR_HEX
512
+ */
513
+ borderColor?: string | null;
514
+ /**
515
+ * Border color as a hexadecimal value (hover state).
516
+ * @format COLOR_HEX
517
+ */
518
+ borderColorHover?: string | null;
519
+ /**
520
+ * Text color as a hexadecimal value.
521
+ * @format COLOR_HEX
522
+ */
523
+ textColor?: string | null;
524
+ /**
525
+ * Text color as a hexadecimal value (hover state).
526
+ * @format COLOR_HEX
527
+ */
528
+ textColorHover?: string | null;
529
+ /**
530
+ * Background color as a hexadecimal value.
531
+ * @format COLOR_HEX
532
+ */
533
+ backgroundColor?: string | null;
534
+ /**
535
+ * Background color as a hexadecimal value (hover state).
536
+ * @format COLOR_HEX
537
+ */
538
+ backgroundColorHover?: string | null;
539
+ /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
540
+ buttonSize?: string | null;
541
+ }
542
+ interface Link extends LinkDataOneOf {
543
+ /** The absolute URL for the linked document. */
544
+ url?: string;
545
+ /** The target node's ID. Used for linking to another node in this object. */
546
+ anchor?: string;
547
+ /**
548
+ * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
549
+ * `SELF` - Default. Opens the linked document in the same frame as the link.
550
+ * `BLANK` - Opens the linked document in a new browser tab or window.
551
+ * `PARENT` - Opens the linked document in the link's parent frame.
552
+ * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
553
+ */
554
+ target?: Target;
555
+ /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
556
+ rel?: Rel;
557
+ /** A serialized object used for a custom or external link panel. */
558
+ customData?: string | null;
559
+ }
560
+ /** @oneof */
561
+ interface LinkDataOneOf {
562
+ /** The absolute URL for the linked document. */
563
+ url?: string;
564
+ /** The target node's ID. Used for linking to another node in this object. */
565
+ anchor?: string;
566
+ }
567
+ declare enum Target {
568
+ /** Opens the linked document in the same frame as it was clicked (this is default) */
569
+ SELF = "SELF",
570
+ /** Opens the linked document in a new window or tab */
571
+ BLANK = "BLANK",
572
+ /** Opens the linked document in the parent frame */
573
+ PARENT = "PARENT",
574
+ /** Opens the linked document in the full body of the window */
575
+ TOP = "TOP"
576
+ }
577
+ interface Rel {
578
+ /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
579
+ nofollow?: boolean | null;
580
+ /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
581
+ sponsored?: boolean | null;
582
+ /** 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`. */
583
+ ugc?: boolean | null;
584
+ /** Indicates that this link protect referral information from being passed to the target website. */
585
+ noreferrer?: boolean | null;
586
+ }
587
+ interface CodeBlockData {
588
+ /** Styling for the code block's text. */
589
+ textStyle?: TextStyle;
590
+ }
591
+ interface TextStyle {
592
+ /** Text alignment. Defaults to `AUTO`. */
593
+ textAlignment?: TextAlignment;
594
+ /** 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. */
595
+ lineHeight?: string | null;
596
+ }
597
+ declare enum TextAlignment {
598
+ /** browser default, eqivalent to `initial` */
599
+ AUTO = "AUTO",
600
+ /** Left align */
601
+ LEFT = "LEFT",
602
+ /** Right align */
603
+ RIGHT = "RIGHT",
604
+ /** Center align */
605
+ CENTER = "CENTER",
606
+ /** 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 */
607
+ JUSTIFY = "JUSTIFY"
608
+ }
609
+ interface DividerData {
610
+ /** Styling for the divider's container. */
611
+ containerData?: PluginContainerData;
612
+ /** Divider line style. */
613
+ lineStyle?: LineStyle;
614
+ /** Divider width. */
615
+ width?: Width;
616
+ /** Divider alignment. */
617
+ alignment?: Alignment;
618
+ }
619
+ declare enum LineStyle {
620
+ /** Single Line */
621
+ SINGLE = "SINGLE",
622
+ /** Double Line */
623
+ DOUBLE = "DOUBLE",
624
+ /** Dashed Line */
625
+ DASHED = "DASHED",
626
+ /** Dotted Line */
627
+ DOTTED = "DOTTED"
628
+ }
629
+ declare enum Width {
630
+ /** Large line */
631
+ LARGE = "LARGE",
632
+ /** Medium line */
633
+ MEDIUM = "MEDIUM",
634
+ /** Small line */
635
+ SMALL = "SMALL"
636
+ }
637
+ declare enum Alignment {
638
+ /** Center alignment */
639
+ CENTER = "CENTER",
640
+ /** Left alignment */
641
+ LEFT = "LEFT",
642
+ /** Right alignment */
643
+ RIGHT = "RIGHT"
644
+ }
645
+ interface FileData {
646
+ /** Styling for the file's container. */
647
+ containerData?: PluginContainerData;
648
+ /** The source for the file's data. */
649
+ src?: FileSource;
650
+ /** File name. */
651
+ name?: string | null;
652
+ /** File type. */
653
+ type?: string | null;
654
+ /**
655
+ * Use `sizeInKb` instead.
656
+ * @deprecated
657
+ */
658
+ size?: number | null;
659
+ /** Settings for PDF files. */
660
+ pdfSettings?: PDFSettings;
661
+ /** File MIME type. */
662
+ mimeType?: string | null;
663
+ /** File path. */
664
+ path?: string | null;
665
+ /** File size in KB. */
666
+ sizeInKb?: string | null;
667
+ }
668
+ declare enum ViewMode {
669
+ /** No PDF view */
670
+ NONE = "NONE",
671
+ /** Full PDF view */
672
+ FULL = "FULL",
673
+ /** Mini PDF view */
674
+ MINI = "MINI"
675
+ }
676
+ interface FileSource extends FileSourceDataOneOf {
677
+ /** The absolute URL for the file's source. */
678
+ url?: string | null;
679
+ /**
680
+ * Custom ID. Use `id` instead.
681
+ * @deprecated
682
+ */
683
+ custom?: string | null;
684
+ /** An ID that's resolved to a URL by a resolver function. */
685
+ _id?: string | null;
686
+ /** Indicates whether the file's source is private. Defaults to `false`. */
687
+ private?: boolean | null;
688
+ }
689
+ /** @oneof */
690
+ interface FileSourceDataOneOf {
691
+ /** The absolute URL for the file's source. */
692
+ url?: string | null;
693
+ /**
694
+ * Custom ID. Use `id` instead.
695
+ * @deprecated
696
+ */
697
+ custom?: string | null;
698
+ /** An ID that's resolved to a URL by a resolver function. */
699
+ _id?: string | null;
700
+ }
701
+ interface PDFSettings {
702
+ /**
703
+ * PDF view mode. One of the following:
704
+ * `NONE` : The PDF isn't displayed.
705
+ * `FULL` : A full page view of the PDF is displayed.
706
+ * `MINI` : A mini view of the PDF is displayed.
707
+ */
708
+ viewMode?: ViewMode;
709
+ /** Sets whether the PDF download button is disabled. Defaults to `false`. */
710
+ disableDownload?: boolean | null;
711
+ /** Sets whether the PDF print button is disabled. Defaults to `false`. */
712
+ disablePrint?: boolean | null;
713
+ }
714
+ interface GalleryData {
715
+ /** Styling for the gallery's container. */
716
+ containerData?: PluginContainerData;
717
+ /** The items in the gallery. */
718
+ items?: Item[];
719
+ /** Options for defining the gallery's appearance. */
720
+ options?: GalleryOptions;
721
+ /** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
722
+ disableExpand?: boolean | null;
723
+ /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
724
+ disableDownload?: boolean | null;
725
+ }
726
+ interface Media {
727
+ /** The source for the media's data. */
728
+ src?: FileSource;
729
+ /** Media width in pixels. */
730
+ width?: number | null;
731
+ /** Media height in pixels. */
732
+ height?: number | null;
733
+ /** Media duration in seconds. Only relevant for audio and video files. */
734
+ duration?: number | null;
735
+ }
736
+ interface Image {
737
+ /** Image file details. */
738
+ media?: Media;
739
+ /** Link details for images that are links. */
740
+ link?: Link;
741
+ }
742
+ interface Video {
743
+ /** Video file details. */
744
+ media?: Media;
745
+ /** Video thumbnail file details. */
746
+ thumbnail?: Media;
747
+ }
748
+ interface Item extends ItemDataOneOf {
749
+ /** An image item. */
750
+ image?: Image;
751
+ /** A video item. */
752
+ video?: Video;
753
+ /** Item title. */
754
+ title?: string | null;
755
+ /** Item's alternative text. */
756
+ altText?: string | null;
757
+ }
758
+ /** @oneof */
759
+ interface ItemDataOneOf {
760
+ /** An image item. */
761
+ image?: Image;
762
+ /** A video item. */
763
+ video?: Video;
764
+ }
765
+ interface GalleryOptions {
766
+ /** Gallery layout. */
767
+ layout?: Layout;
768
+ /** Styling for gallery items. */
769
+ item?: ItemStyle;
770
+ /** Styling for gallery thumbnail images. */
771
+ thumbnails?: Thumbnails;
772
+ }
773
+ declare enum LayoutType {
774
+ /** Collage type */
775
+ COLLAGE = "COLLAGE",
776
+ /** Masonry type */
777
+ MASONRY = "MASONRY",
778
+ /** Grid type */
779
+ GRID = "GRID",
780
+ /** Thumbnail type */
781
+ THUMBNAIL = "THUMBNAIL",
782
+ /** Slider type */
783
+ SLIDER = "SLIDER",
784
+ /** Slideshow type */
785
+ SLIDESHOW = "SLIDESHOW",
786
+ /** Panorama type */
787
+ PANORAMA = "PANORAMA",
788
+ /** Column type */
789
+ COLUMN = "COLUMN",
790
+ /** Magic type */
791
+ MAGIC = "MAGIC",
792
+ /** Fullsize images type */
793
+ FULLSIZE = "FULLSIZE"
794
+ }
795
+ declare enum Orientation {
796
+ /** Rows Orientation */
797
+ ROWS = "ROWS",
798
+ /** Columns Orientation */
799
+ COLUMNS = "COLUMNS"
800
+ }
801
+ declare enum Crop {
802
+ /** Crop to fill */
803
+ FILL = "FILL",
804
+ /** Crop to fit */
805
+ FIT = "FIT"
806
+ }
807
+ declare enum ThumbnailsAlignment {
808
+ /** Top alignment */
809
+ TOP = "TOP",
810
+ /** Right alignment */
811
+ RIGHT = "RIGHT",
812
+ /** Bottom alignment */
813
+ BOTTOM = "BOTTOM",
814
+ /** Left alignment */
815
+ LEFT = "LEFT",
816
+ /** No thumbnail */
817
+ NONE = "NONE"
818
+ }
819
+ interface Layout {
820
+ /** Gallery layout type. */
821
+ type?: LayoutType;
822
+ /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
823
+ horizontalScroll?: boolean | null;
824
+ /** Gallery orientation. */
825
+ orientation?: Orientation;
826
+ /** The number of columns to display on full size screens. */
827
+ numberOfColumns?: number | null;
828
+ /** The number of columns to display on mobile screens. */
829
+ mobileNumberOfColumns?: number | null;
830
+ }
831
+ interface ItemStyle {
832
+ /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
833
+ targetSize?: number | null;
834
+ /** Item ratio */
835
+ ratio?: number | null;
836
+ /** Sets how item images are cropped. */
837
+ crop?: Crop;
838
+ /** The spacing between items in pixels. */
839
+ spacing?: number | null;
840
+ }
841
+ interface Thumbnails {
842
+ /** Thumbnail alignment. */
843
+ placement?: ThumbnailsAlignment;
844
+ /** Spacing between thumbnails in pixels. */
845
+ spacing?: number | null;
846
+ }
847
+ interface GIFData {
848
+ /** Styling for the GIF's container. */
849
+ containerData?: PluginContainerData;
850
+ /** The source of the full size GIF. */
851
+ original?: GIF;
852
+ /** The source of the downsized GIF. */
853
+ downsized?: GIF;
854
+ /** Height in pixels. */
855
+ height?: number;
856
+ /** Width in pixels. */
857
+ width?: number;
858
+ /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
859
+ gifType?: GIFType;
860
+ }
861
+ interface GIF {
862
+ /**
863
+ * GIF format URL.
864
+ * @format WEB_URL
865
+ */
866
+ gif?: string | null;
867
+ /**
868
+ * MP4 format URL.
869
+ * @format WEB_URL
870
+ */
871
+ mp4?: string | null;
872
+ /**
873
+ * Thumbnail URL.
874
+ * @format WEB_URL
875
+ */
876
+ still?: string | null;
877
+ }
878
+ declare enum GIFType {
879
+ NORMAL = "NORMAL",
880
+ STICKER = "STICKER"
881
+ }
882
+ interface HeadingData {
883
+ /** Heading level from 1-6. */
884
+ level?: number;
885
+ /** Styling for the heading text. */
886
+ textStyle?: TextStyle;
887
+ /** Indentation level from 1-4. */
888
+ indentation?: number | null;
889
+ }
890
+ interface HTMLData extends HTMLDataDataOneOf {
891
+ /** The URL for the HTML code for the node. */
892
+ url?: string;
893
+ /** The HTML code for the node. */
894
+ html?: string;
895
+ /**
896
+ * Whether this is an AdSense element. Use `source` instead.
897
+ * @deprecated
898
+ */
899
+ isAdsense?: boolean | null;
900
+ /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
901
+ containerData?: PluginContainerData;
902
+ /** The type of HTML code. */
903
+ source?: Source;
904
+ /** If container height is aligned with its content height. Defaults to `true`. */
905
+ autoHeight?: boolean | null;
906
+ }
907
+ /** @oneof */
908
+ interface HTMLDataDataOneOf {
909
+ /** The URL for the HTML code for the node. */
910
+ url?: string;
911
+ /** The HTML code for the node. */
912
+ html?: string;
913
+ /**
914
+ * Whether this is an AdSense element. Use `source` instead.
915
+ * @deprecated
916
+ */
917
+ isAdsense?: boolean | null;
918
+ }
919
+ declare enum Source {
920
+ HTML = "HTML",
921
+ ADSENSE = "ADSENSE"
922
+ }
923
+ interface ImageData {
924
+ /** Styling for the image's container. */
925
+ containerData?: PluginContainerData;
926
+ /** Image file details. */
927
+ image?: Media;
928
+ /** Link details for images that are links. */
929
+ link?: Link;
930
+ /** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
931
+ disableExpand?: boolean | null;
932
+ /** Image's alternative text. */
933
+ altText?: string | null;
934
+ /**
935
+ * Deprecated: use Caption node instead.
936
+ * @deprecated
937
+ */
938
+ caption?: string | null;
939
+ /** Sets whether the image's download button is disabled. Defaults to `false`. */
940
+ disableDownload?: boolean | null;
941
+ /** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
942
+ decorative?: boolean | null;
943
+ /** Styling for the image. */
944
+ styles?: ImageDataStyles;
945
+ }
946
+ interface StylesBorder {
947
+ /** Border width in pixels. */
948
+ width?: number | null;
949
+ /**
950
+ * Border color as a hexadecimal value.
951
+ * @format COLOR_HEX
952
+ */
953
+ color?: string | null;
954
+ /** Border radius in pixels. */
955
+ radius?: number | null;
956
+ }
957
+ interface ImageDataStyles {
958
+ /** Border attributes. */
959
+ border?: StylesBorder;
960
+ }
961
+ interface LinkPreviewData {
962
+ /** Styling for the link preview's container. */
963
+ containerData?: PluginContainerData;
964
+ /** Link details. */
965
+ link?: Link;
966
+ /** Preview title. */
967
+ title?: string | null;
968
+ /** Preview thumbnail URL. */
969
+ thumbnailUrl?: string | null;
970
+ /** Preview description. */
971
+ description?: string | null;
972
+ /** The preview content as HTML. */
973
+ html?: string | null;
974
+ /** Styling for the link preview. */
975
+ styles?: LinkPreviewDataStyles;
976
+ }
977
+ declare enum StylesPosition {
978
+ /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
979
+ START = "START",
980
+ /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
981
+ END = "END",
982
+ /** Thumbnail positioned at the top */
983
+ TOP = "TOP",
984
+ /** Thumbnail hidden and not displayed */
985
+ HIDDEN = "HIDDEN"
986
+ }
987
+ interface LinkPreviewDataStyles {
988
+ /**
989
+ * Background color as a hexadecimal value.
990
+ * @format COLOR_HEX
991
+ */
992
+ backgroundColor?: string | null;
993
+ /**
994
+ * Title color as a hexadecimal value.
995
+ * @format COLOR_HEX
996
+ */
997
+ titleColor?: string | null;
998
+ /**
999
+ * Subtitle color as a hexadecimal value.
1000
+ * @format COLOR_HEX
1001
+ */
1002
+ subtitleColor?: string | null;
1003
+ /**
1004
+ * Link color as a hexadecimal value.
1005
+ * @format COLOR_HEX
1006
+ */
1007
+ linkColor?: string | null;
1008
+ /** Border width in pixels. */
1009
+ borderWidth?: number | null;
1010
+ /** Border radius in pixels. */
1011
+ borderRadius?: number | null;
1012
+ /**
1013
+ * Border color as a hexadecimal value.
1014
+ * @format COLOR_HEX
1015
+ */
1016
+ borderColor?: string | null;
1017
+ /** Position of thumbnail. Defaults to `START`. */
1018
+ thumbnailPosition?: StylesPosition;
1019
+ }
1020
+ interface MapData {
1021
+ /** Styling for the map's container. */
1022
+ containerData?: PluginContainerData;
1023
+ /** Map settings. */
1024
+ mapSettings?: MapSettings;
1025
+ }
1026
+ interface MapSettings {
1027
+ /** The address to display on the map. */
1028
+ address?: string | null;
1029
+ /** Sets whether the map is draggable. */
1030
+ draggable?: boolean | null;
1031
+ /** Sets whether the location marker is visible. */
1032
+ marker?: boolean | null;
1033
+ /** Sets whether street view control is enabled. */
1034
+ streetViewControl?: boolean | null;
1035
+ /** Sets whether zoom control is enabled. */
1036
+ zoomControl?: boolean | null;
1037
+ /** Location latitude. */
1038
+ lat?: number | null;
1039
+ /** Location longitude. */
1040
+ lng?: number | null;
1041
+ /** Location name. */
1042
+ locationName?: string | null;
1043
+ /** Sets whether view mode control is enabled. */
1044
+ viewModeControl?: boolean | null;
1045
+ /** Initial zoom value. */
1046
+ initialZoom?: number | null;
1047
+ /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
1048
+ mapType?: MapType;
1049
+ }
1050
+ declare enum MapType {
1051
+ /** Roadmap map type */
1052
+ ROADMAP = "ROADMAP",
1053
+ /** Satellite map type */
1054
+ SATELITE = "SATELITE",
1055
+ /** Hybrid map type */
1056
+ HYBRID = "HYBRID",
1057
+ /** Terrain map type */
1058
+ TERRAIN = "TERRAIN"
1059
+ }
1060
+ interface ParagraphData {
1061
+ /** Styling for the paragraph text. */
1062
+ textStyle?: TextStyle;
1063
+ /** Indentation level from 1-4. */
1064
+ indentation?: number | null;
1065
+ /** Paragraph level */
1066
+ level?: number | null;
1067
+ }
1068
+ interface PollData {
1069
+ /** Styling for the poll's container. */
1070
+ containerData?: PluginContainerData;
1071
+ /** Poll data. */
1072
+ poll?: Poll;
1073
+ /** Layout settings for the poll and voting options. */
1074
+ layout?: PollDataLayout;
1075
+ /** Styling for the poll and voting options. */
1076
+ design?: Design;
1077
+ }
1078
+ declare enum ViewRole {
1079
+ /** Only Poll creator can view the results */
1080
+ CREATOR = "CREATOR",
1081
+ /** Anyone who voted can see the results */
1082
+ VOTERS = "VOTERS",
1083
+ /** Anyone can see the results, even if one didn't vote */
1084
+ EVERYONE = "EVERYONE"
1085
+ }
1086
+ declare enum VoteRole {
1087
+ /** Logged in member */
1088
+ SITE_MEMBERS = "SITE_MEMBERS",
1089
+ /** Anyone */
1090
+ ALL = "ALL"
1091
+ }
1092
+ interface Permissions {
1093
+ /** Sets who can view the poll results. */
1094
+ view?: ViewRole;
1095
+ /** Sets who can vote. */
1096
+ vote?: VoteRole;
1097
+ /** Sets whether one voter can vote multiple times. Defaults to `false`. */
1098
+ allowMultipleVotes?: boolean | null;
1099
+ }
1100
+ interface Option {
1101
+ /** Option ID. */
1102
+ _id?: string | null;
1103
+ /** Option title. */
1104
+ title?: string | null;
1105
+ /** The image displayed with the option. */
1106
+ image?: Media;
1107
+ }
1108
+ interface PollSettings {
1109
+ /** Permissions settings for voting. */
1110
+ permissions?: Permissions;
1111
+ /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
1112
+ showVoters?: boolean | null;
1113
+ /** Sets whether the vote count is displayed. Defaults to `true`. */
1114
+ showVotesCount?: boolean | null;
1115
+ }
1116
+ declare enum PollLayoutType {
1117
+ /** List */
1118
+ LIST = "LIST",
1119
+ /** Grid */
1120
+ GRID = "GRID"
1121
+ }
1122
+ declare enum PollLayoutDirection {
1123
+ /** Left-to-right */
1124
+ LTR = "LTR",
1125
+ /** Right-to-left */
1126
+ RTL = "RTL"
1127
+ }
1128
+ interface PollLayout {
1129
+ /** The layout for displaying the voting options. */
1130
+ type?: PollLayoutType;
1131
+ /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
1132
+ direction?: PollLayoutDirection;
1133
+ /** Sets whether to display the main poll image. Defaults to `false`. */
1134
+ enableImage?: boolean | null;
1135
+ }
1136
+ interface OptionLayout {
1137
+ /** Sets whether to display option images. Defaults to `false`. */
1138
+ enableImage?: boolean | null;
1139
+ }
1140
+ declare enum BackgroundType {
1141
+ /** Color background type */
1142
+ COLOR = "COLOR",
1143
+ /** Image background type */
1144
+ IMAGE = "IMAGE",
1145
+ /** Gradiant background type */
1146
+ GRADIENT = "GRADIENT"
1147
+ }
1148
+ interface Gradient {
1149
+ /** The gradient angle in degrees. */
1150
+ angle?: number | null;
1151
+ /**
1152
+ * The start color as a hexademical value.
1153
+ * @format COLOR_HEX
1154
+ */
1155
+ startColor?: string | null;
1156
+ /**
1157
+ * The end color as a hexademical value.
1158
+ * @format COLOR_HEX
1159
+ */
1160
+ lastColor?: string | null;
1161
+ }
1162
+ interface Background extends BackgroundBackgroundOneOf {
1163
+ /**
1164
+ * The background color as a hexademical value.
1165
+ * @format COLOR_HEX
1166
+ */
1167
+ color?: string | null;
1168
+ /** An image to use for the background. */
1169
+ image?: Media;
1170
+ /** Details for a gradient background. */
1171
+ gradient?: Gradient;
1172
+ /** Background type. For each option, include the relevant details. */
1173
+ type?: BackgroundType;
1174
+ }
1175
+ /** @oneof */
1176
+ interface BackgroundBackgroundOneOf {
1177
+ /**
1178
+ * The background color as a hexademical value.
1179
+ * @format COLOR_HEX
1180
+ */
1181
+ color?: string | null;
1182
+ /** An image to use for the background. */
1183
+ image?: Media;
1184
+ /** Details for a gradient background. */
1185
+ gradient?: Gradient;
1186
+ }
1187
+ interface PollDesign {
1188
+ /** Background styling. */
1189
+ background?: Background;
1190
+ /** Border radius in pixels. */
1191
+ borderRadius?: number | null;
1192
+ }
1193
+ interface OptionDesign {
1194
+ /** Border radius in pixels. */
1195
+ borderRadius?: number | null;
1196
+ }
1197
+ interface Poll {
1198
+ /** Poll ID. */
1199
+ _id?: string | null;
1200
+ /** Poll title. */
1201
+ title?: string | null;
1202
+ /** Poll creator ID. */
1203
+ creatorId?: string | null;
1204
+ /** Main poll image. */
1205
+ image?: Media;
1206
+ /** Voting options. */
1207
+ options?: Option[];
1208
+ /** The poll's permissions and display settings. */
1209
+ settings?: PollSettings;
1210
+ }
1211
+ interface PollDataLayout {
1212
+ /** Poll layout settings. */
1213
+ poll?: PollLayout;
1214
+ /** Voting otpions layout settings. */
1215
+ options?: OptionLayout;
1216
+ }
1217
+ interface Design {
1218
+ /** Styling for the poll. */
1219
+ poll?: PollDesign;
1220
+ /** Styling for voting options. */
1221
+ options?: OptionDesign;
1222
+ }
1223
+ interface TextData {
1224
+ /** The text to apply decorations to. */
1225
+ text?: string;
1226
+ /** The decorations to apply. */
1227
+ decorations?: Decoration[];
1228
+ }
1229
+ /** Adds appearence changes to text */
1230
+ interface Decoration extends DecorationDataOneOf {
1231
+ /** Data for an anchor link decoration. */
1232
+ anchorData?: AnchorData;
1233
+ /** Data for a color decoration. */
1234
+ colorData?: ColorData;
1235
+ /** Data for an external link decoration. */
1236
+ linkData?: LinkData;
1237
+ /** Data for a mention decoration. */
1238
+ mentionData?: MentionData;
1239
+ /** Data for a font size decoration. */
1240
+ fontSizeData?: FontSizeData;
1241
+ /** Font weight for a bold decoration. */
1242
+ fontWeightValue?: number | null;
1243
+ /** Data for an italic decoration. Defaults to `true`. */
1244
+ italicData?: boolean | null;
1245
+ /** Data for an underline decoration. Defaults to `true`. */
1246
+ underlineData?: boolean | null;
1247
+ /** Data for a spoiler decoration. */
1248
+ spoilerData?: SpoilerData;
1249
+ /** The type of decoration to apply. */
1250
+ type?: DecorationType;
1251
+ }
1252
+ /** @oneof */
1253
+ interface DecorationDataOneOf {
1254
+ /** Data for an anchor link decoration. */
1255
+ anchorData?: AnchorData;
1256
+ /** Data for a color decoration. */
1257
+ colorData?: ColorData;
1258
+ /** Data for an external link decoration. */
1259
+ linkData?: LinkData;
1260
+ /** Data for a mention decoration. */
1261
+ mentionData?: MentionData;
1262
+ /** Data for a font size decoration. */
1263
+ fontSizeData?: FontSizeData;
1264
+ /** Font weight for a bold decoration. */
1265
+ fontWeightValue?: number | null;
1266
+ /** Data for an italic decoration. Defaults to `true`. */
1267
+ italicData?: boolean | null;
1268
+ /** Data for an underline decoration. Defaults to `true`. */
1269
+ underlineData?: boolean | null;
1270
+ /** Data for a spoiler decoration. */
1271
+ spoilerData?: SpoilerData;
1272
+ }
1273
+ declare enum DecorationType {
1274
+ BOLD = "BOLD",
1275
+ ITALIC = "ITALIC",
1276
+ UNDERLINE = "UNDERLINE",
1277
+ SPOILER = "SPOILER",
1278
+ ANCHOR = "ANCHOR",
1279
+ MENTION = "MENTION",
1280
+ LINK = "LINK",
1281
+ COLOR = "COLOR",
1282
+ FONT_SIZE = "FONT_SIZE",
1283
+ EXTERNAL = "EXTERNAL"
1284
+ }
1285
+ interface AnchorData {
1286
+ /** The target node's ID. */
1287
+ anchor?: string;
1288
+ }
1289
+ interface ColorData {
1290
+ /** The text's background color as a hexadecimal value. */
1291
+ background?: string | null;
1292
+ /** The text's foreground color as a hexadecimal value. */
1293
+ foreground?: string | null;
1294
+ }
1295
+ interface LinkData {
1296
+ /** Link details. */
1297
+ link?: Link;
1298
+ }
1299
+ interface MentionData {
1300
+ /** The mentioned user's name. */
1301
+ name?: string;
1302
+ /** The version of the user's name that appears after the `@` character in the mention. */
1303
+ slug?: string;
1304
+ /** Mentioned user's ID. */
1305
+ _id?: string | null;
1306
+ }
1307
+ interface FontSizeData {
1308
+ /** The units used for the font size. */
1309
+ unit?: FontType;
1310
+ /** Font size value. */
1311
+ value?: number | null;
1312
+ }
1313
+ declare enum FontType {
1314
+ PX = "PX",
1315
+ EM = "EM"
1316
+ }
1317
+ interface SpoilerData {
1318
+ /** Spoiler ID. */
1319
+ _id?: string | null;
1320
+ }
1321
+ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1322
+ /** Data for embedded Wix Bookings content. */
1323
+ bookingData?: BookingData;
1324
+ /** Data for embedded Wix Events content. */
1325
+ eventData?: EventData;
1326
+ /** The type of Wix App content being embedded. */
1327
+ type?: AppType;
1328
+ /** The ID of the embedded content. */
1329
+ itemId?: string | null;
1330
+ /** The name of the embedded content. */
1331
+ name?: string | null;
1332
+ /**
1333
+ * Deprecated: Use `image` instead.
1334
+ * @deprecated
1335
+ */
1336
+ imageSrc?: string | null;
1337
+ /** The URL for the embedded content. */
1338
+ url?: string | null;
1339
+ /** An image for the embedded content. */
1340
+ image?: Media;
1341
+ }
1342
+ /** @oneof */
1343
+ interface AppEmbedDataAppDataOneOf {
1344
+ /** Data for embedded Wix Bookings content. */
1345
+ bookingData?: BookingData;
1346
+ /** Data for embedded Wix Events content. */
1347
+ eventData?: EventData;
1348
+ }
1349
+ declare enum AppType {
1350
+ PRODUCT = "PRODUCT",
1351
+ EVENT = "EVENT",
1352
+ BOOKING = "BOOKING"
1353
+ }
1354
+ interface BookingData {
1355
+ /** Booking duration in minutes. */
1356
+ durations?: string | null;
1357
+ }
1358
+ interface EventData {
1359
+ /** Event schedule. */
1360
+ scheduling?: string | null;
1361
+ /** Event location. */
1362
+ location?: string | null;
1363
+ }
1364
+ interface VideoData {
1365
+ /** Styling for the video's container. */
1366
+ containerData?: PluginContainerData;
1367
+ /** Video details. */
1368
+ video?: Media;
1369
+ /** Video thumbnail details. */
1370
+ thumbnail?: Media;
1371
+ /** Sets whether the video's download button is disabled. Defaults to `false`. */
1372
+ disableDownload?: boolean | null;
1373
+ /** Video title. */
1374
+ title?: string | null;
1375
+ /** Video options. */
1376
+ options?: PlaybackOptions;
1377
+ }
1378
+ interface PlaybackOptions {
1379
+ /** Sets whether the media will automatically start playing. */
1380
+ autoPlay?: boolean | null;
1381
+ /** Sets whether media's will be looped. */
1382
+ playInLoop?: boolean | null;
1383
+ /** Sets whether media's controls will be shown. */
1384
+ showControls?: boolean | null;
1385
+ }
1386
+ interface EmbedData {
1387
+ /** Styling for the oEmbed node's container. */
1388
+ containerData?: PluginContainerData;
1389
+ /** An [oEmbed](https://www.oembed.com) object. */
1390
+ oembed?: Oembed;
1391
+ /** Origin asset source. */
1392
+ src?: string | null;
1393
+ }
1394
+ interface Oembed {
1395
+ /** The resource type. */
1396
+ type?: string | null;
1397
+ /** The width of the resource specified in the `url` property in pixels. */
1398
+ width?: number | null;
1399
+ /** The height of the resource specified in the `url` property in pixels. */
1400
+ height?: number | null;
1401
+ /** Resource title. */
1402
+ title?: string | null;
1403
+ /** The source URL for the resource. */
1404
+ url?: string | null;
1405
+ /** HTML for embedding a video player. The HTML should have no padding or margins. */
1406
+ html?: string | null;
1407
+ /** The name of the author or owner of the resource. */
1408
+ authorName?: string | null;
1409
+ /** The URL for the author or owner of the resource. */
1410
+ authorUrl?: string | null;
1411
+ /** The name of the resource provider. */
1412
+ providerName?: string | null;
1413
+ /** The URL for the resource provider. */
1414
+ providerUrl?: string | null;
1415
+ /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
1416
+ thumbnailUrl?: string | null;
1417
+ /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
1418
+ thumbnailWidth?: string | null;
1419
+ /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
1420
+ thumbnailHeight?: string | null;
1421
+ /** The URL for an embedded viedo. */
1422
+ videoUrl?: string | null;
1423
+ /** The oEmbed version number. This value must be `1.0`. */
1424
+ version?: string | null;
1425
+ }
1426
+ interface CollapsibleListData {
1427
+ /** Styling for the collapsible list's container. */
1428
+ containerData?: PluginContainerData;
1429
+ /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
1430
+ expandOnlyOne?: boolean | null;
1431
+ /** Sets which items are expanded when the page loads. */
1432
+ initialExpandedItems?: InitialExpandedItems;
1433
+ /** The direction of the text in the list. Either left-to-right or right-to-left. */
1434
+ direction?: Direction;
1435
+ /** If `true`, The collapsible item will appear in search results as an FAQ. */
1436
+ isQapageData?: boolean | null;
1437
+ }
1438
+ declare enum InitialExpandedItems {
1439
+ /** First item will be expended initally */
1440
+ FIRST = "FIRST",
1441
+ /** All items will expended initally */
1442
+ ALL = "ALL",
1443
+ /** All items collapsed initally */
1444
+ NONE = "NONE"
1445
+ }
1446
+ declare enum Direction {
1447
+ /** Left-to-right */
1448
+ LTR = "LTR",
1449
+ /** Right-to-left */
1450
+ RTL = "RTL"
1451
+ }
1452
+ interface TableData {
1453
+ /** Styling for the table's container. */
1454
+ containerData?: PluginContainerData;
1455
+ /** The table's dimensions. */
1456
+ dimensions?: Dimensions;
1457
+ /**
1458
+ * Deprecated: Use `rowHeader` and `columnHeader` instead.
1459
+ * @deprecated
1460
+ */
1461
+ header?: boolean | null;
1462
+ /** Sets whether the table's first row is a header. Defaults to `false`. */
1463
+ rowHeader?: boolean | null;
1464
+ /** Sets whether the table's first column is a header. Defaults to `false`. */
1465
+ columnHeader?: boolean | null;
1466
+ }
1467
+ interface Dimensions {
1468
+ /** An array representing relative width of each column in relation to the other columns. */
1469
+ colsWidthRatio?: number[];
1470
+ /** An array representing the height of each row in pixels. */
1471
+ rowsHeight?: number[];
1472
+ /** An array representing the minimum width of each column in pixels. */
1473
+ colsMinWidth?: number[];
1474
+ }
1475
+ interface TableCellData {
1476
+ /** Styling for the cell's background color and text alignment. */
1477
+ cellStyle?: CellStyle;
1478
+ /** The cell's border colors. */
1479
+ borderColors?: BorderColors;
1480
+ }
1481
+ declare enum VerticalAlignment {
1482
+ /** Top alignment */
1483
+ TOP = "TOP",
1484
+ /** Middle alignment */
1485
+ MIDDLE = "MIDDLE",
1486
+ /** Bottom alignment */
1487
+ BOTTOM = "BOTTOM"
1488
+ }
1489
+ interface CellStyle {
1490
+ /** Vertical alignment for the cell's text. */
1491
+ verticalAlignment?: VerticalAlignment;
1492
+ /**
1493
+ * Cell background color as a hexadecimal value.
1494
+ * @format COLOR_HEX
1495
+ */
1496
+ backgroundColor?: string | null;
1497
+ }
1498
+ interface BorderColors {
1499
+ /**
1500
+ * Left border color as a hexadecimal value.
1501
+ * @format COLOR_HEX
1502
+ */
1503
+ left?: string | null;
1504
+ /**
1505
+ * Right border color as a hexadecimal value.
1506
+ * @format COLOR_HEX
1507
+ */
1508
+ right?: string | null;
1509
+ /**
1510
+ * Top border color as a hexadecimal value.
1511
+ * @format COLOR_HEX
1512
+ */
1513
+ top?: string | null;
1514
+ /**
1515
+ * Bottom border color as a hexadecimal value.
1516
+ * @format COLOR_HEX
1517
+ */
1518
+ bottom?: string | null;
1519
+ }
1520
+ /**
1521
+ * `NullValue` is a singleton enumeration to represent the null value for the
1522
+ * `Value` type union.
1523
+ *
1524
+ * The JSON representation for `NullValue` is JSON `null`.
1525
+ */
1526
+ declare enum NullValue {
1527
+ /** Null value. */
1528
+ NULL_VALUE = "NULL_VALUE"
1529
+ }
1530
+ /**
1531
+ * `ListValue` is a wrapper around a repeated field of values.
1532
+ *
1533
+ * The JSON representation for `ListValue` is JSON array.
1534
+ */
1535
+ interface ListValue {
1536
+ /** Repeated field of dynamically typed values. */
1537
+ values?: any[];
1538
+ }
1539
+ interface AudioData {
1540
+ /** Styling for the audio node's container. */
1541
+ containerData?: PluginContainerData;
1542
+ /** Audio file details. */
1543
+ audio?: Media;
1544
+ /** Sets whether the audio node's download button is disabled. Defaults to `false`. */
1545
+ disableDownload?: boolean | null;
1546
+ /** Cover image. */
1547
+ coverImage?: Media;
1548
+ /** Track name. */
1549
+ name?: string | null;
1550
+ /** Author name. */
1551
+ authorName?: string | null;
1552
+ /** An HTML version of the audio node. */
1553
+ html?: string | null;
1554
+ }
1555
+ interface OrderedListData {
1556
+ /** Indentation level from 0-4. */
1557
+ indentation?: number;
1558
+ /** Offset level from 0-4. */
1559
+ offset?: number | null;
1560
+ /** List start number. */
1561
+ start?: number | null;
1562
+ }
1563
+ interface BulletedListData {
1564
+ /** Indentation level from 0-4. */
1565
+ indentation?: number;
1566
+ /** Offset level from 0-4. */
1567
+ offset?: number | null;
1568
+ }
1569
+ interface BlockquoteData {
1570
+ /** Indentation level from 1-4. */
1571
+ indentation?: number;
1572
+ }
1573
+ interface CaptionData {
1574
+ textStyle?: TextStyle;
1575
+ }
1576
+ interface LayoutCellData {
1577
+ /** Size of the cell in 12 columns grid. */
1578
+ colSpan?: number | null;
1579
+ }
1580
+ interface Metadata {
1581
+ /** Schema version. */
1582
+ version?: number;
1583
+ /**
1584
+ * When the object was created.
1585
+ * @readonly
1586
+ * @deprecated
1587
+ */
1588
+ createdTimestamp?: Date | null;
1589
+ /**
1590
+ * When the object was most recently updated.
1591
+ * @deprecated
1592
+ */
1593
+ updatedTimestamp?: Date | null;
1594
+ /** Object ID. */
1595
+ _id?: string | null;
1596
+ }
1597
+ interface DocumentStyle {
1598
+ /** Styling for H1 nodes. */
1599
+ headerOne?: TextNodeStyle;
1600
+ /** Styling for H2 nodes. */
1601
+ headerTwo?: TextNodeStyle;
1602
+ /** Styling for H3 nodes. */
1603
+ headerThree?: TextNodeStyle;
1604
+ /** Styling for H4 nodes. */
1605
+ headerFour?: TextNodeStyle;
1606
+ /** Styling for H5 nodes. */
1607
+ headerFive?: TextNodeStyle;
1608
+ /** Styling for H6 nodes. */
1609
+ headerSix?: TextNodeStyle;
1610
+ /** Styling for paragraph nodes. */
1611
+ paragraph?: TextNodeStyle;
1612
+ /** Styling for block quote nodes. */
1613
+ blockquote?: TextNodeStyle;
1614
+ /** Styling for code block nodes. */
1615
+ codeBlock?: TextNodeStyle;
1616
+ }
1617
+ interface TextNodeStyle {
1618
+ /** The decorations to apply to the node. */
1619
+ decorations?: Decoration[];
1620
+ /** Padding and background color for the node. */
1621
+ nodeStyle?: NodeStyle;
1622
+ /** Line height for text in the node. */
1623
+ lineHeight?: string | null;
1624
+ }
1625
+ interface TreeReference {
1626
+ /**
1627
+ * Namespace of the app that manages the tree.
1628
+ *
1629
+ * For example, `"@wix/stores"`, `"@bookings/bookingslist"`, `"@achievements/quizzes"`.
1630
+ * @minLength 4
1631
+ * @maxLength 150
1632
+ */
1633
+ appNamespace?: string;
1634
+ /**
1635
+ * Tree key. You must pass this when a single app manages more than one tree.
1636
+ * @minLength 1
1637
+ * @maxLength 44
1638
+ */
1639
+ treeKey?: string | null;
1640
+ }
1641
+ interface ExtendedFields {
1642
+ /**
1643
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
1644
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
1645
+ *
1646
+ * You can only access fields for which you have the appropriate permissions.
1647
+ *
1648
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
1649
+ */
1650
+ namespaces?: Record<string, Record<string, any>>;
1651
+ }
1652
+ interface InvalidateCache extends InvalidateCacheGetByOneOf {
1653
+ /**
1654
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
1655
+ * @format GUID
1656
+ */
1657
+ metaSiteId?: string;
1658
+ /**
1659
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
1660
+ * @format GUID
1661
+ */
1662
+ siteId?: string;
1663
+ /** Invalidate by App */
1664
+ app?: App;
1665
+ /** Invalidate by page id */
1666
+ page?: Page;
1667
+ /** Invalidate by URI path */
1668
+ uri?: URI;
1669
+ /** Invalidate by file (for media files such as PDFs) */
1670
+ file?: File;
1671
+ /**
1672
+ * tell us why you're invalidating the cache. You don't need to add your app name
1673
+ * @maxLength 256
1674
+ */
1675
+ reason?: string | null;
1676
+ /** Is local DS */
1677
+ localDc?: boolean;
1678
+ hardPurge?: boolean;
1679
+ }
1680
+ /** @oneof */
1681
+ interface InvalidateCacheGetByOneOf {
1682
+ /**
1683
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
1684
+ * @format GUID
1685
+ */
1686
+ metaSiteId?: string;
1687
+ /**
1688
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
1689
+ * @format GUID
1690
+ */
1691
+ siteId?: string;
1692
+ /** Invalidate by App */
1693
+ app?: App;
1694
+ /** Invalidate by page id */
1695
+ page?: Page;
1696
+ /** Invalidate by URI path */
1697
+ uri?: URI;
1698
+ /** Invalidate by file (for media files such as PDFs) */
1699
+ file?: File;
1700
+ }
1701
+ interface App {
1702
+ /**
1703
+ * The AppDefId
1704
+ * @minLength 1
1705
+ */
1706
+ appDefId?: string;
1707
+ /**
1708
+ * The instance Id
1709
+ * @format GUID
1710
+ */
1711
+ instanceId?: string;
1712
+ }
1713
+ interface Page {
1714
+ /**
1715
+ * the msid the page is on
1716
+ * @format GUID
1717
+ */
1718
+ metaSiteId?: string;
1719
+ /**
1720
+ * Invalidate by Page ID
1721
+ * @minLength 1
1722
+ */
1723
+ pageId?: string;
1724
+ }
1725
+ interface URI {
1726
+ /**
1727
+ * the msid the URI is on
1728
+ * @format GUID
1729
+ */
1730
+ metaSiteId?: string;
1731
+ /**
1732
+ * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
1733
+ * @minLength 1
1734
+ */
1735
+ uriPath?: string;
1736
+ }
1737
+ interface File {
1738
+ /**
1739
+ * the msid the file is related to
1740
+ * @format GUID
1741
+ */
1742
+ metaSiteId?: string;
1743
+ /**
1744
+ * Invalidate by filename (for media files such as PDFs)
1745
+ * @minLength 1
1746
+ * @maxLength 256
1747
+ */
1748
+ fileName?: string;
1749
+ }
1750
+ interface CategoryMoved {
1751
+ /**
1752
+ * Category ID.
1753
+ * @format GUID
1754
+ */
1755
+ categoryId?: string;
1756
+ /** Parent category details. */
1757
+ parentCategory?: ParentCategory;
1758
+ /** Category tree reference details. */
1759
+ treeReference?: TreeReference;
1760
+ }
1761
+ interface ItemAddedToCategory {
1762
+ /**
1763
+ * Category ID.
1764
+ * @format GUID
1765
+ */
1766
+ categoryId?: string;
1767
+ /** Details about the added item. */
1768
+ addedItem?: ItemReference;
1769
+ /** Category tree reference details. */
1770
+ treeReference?: TreeReference;
1771
+ }
1772
+ interface ItemReference {
1773
+ /**
1774
+ * ID of the item within the catalog it belongs to.
1775
+ *
1776
+ * For example, `product.id` for Wix Stores or `event.id` for Wix Events.
1777
+ * @minLength 1
1778
+ * @maxLength 36
1779
+ */
1780
+ catalogItemId?: string;
1781
+ /**
1782
+ * ID of the app providing the catalog.
1783
+ *
1784
+ * You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
1785
+ *
1786
+ * For items from Wix catalogs, the following values always apply:
1787
+ * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
1788
+ * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
1789
+ * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
1790
+ * @minLength 1
1791
+ * @maxLength 36
1792
+ */
1793
+ appId?: string;
1794
+ }
1795
+ interface ItemsAddedToCategory {
1796
+ /**
1797
+ * Category ID.
1798
+ * @format GUID
1799
+ */
1800
+ categoryId?: string;
1801
+ /**
1802
+ * List of added items.
1803
+ * @maxSize 100
1804
+ */
1805
+ addedItems?: ItemReference[];
1806
+ /** Category tree reference details. */
1807
+ treeReference?: TreeReference;
1808
+ }
1809
+ interface ItemRemovedFromCategory {
1810
+ /**
1811
+ * Category ID.
1812
+ * @format GUID
1813
+ */
1814
+ categoryId?: string;
1815
+ /** Details about the removed item. */
1816
+ removedItem?: ItemReference;
1817
+ /** Category tree reference details. */
1818
+ treeReference?: TreeReference;
1819
+ }
1820
+ interface ItemsRemovedFromCategory {
1821
+ /**
1822
+ * Category ID.
1823
+ * @format GUID
1824
+ */
1825
+ categoryId?: string;
1826
+ /**
1827
+ * List of removed items.
1828
+ * @maxSize 100
1829
+ */
1830
+ removedItems?: ItemReference[];
1831
+ /** Category tree reference details. */
1832
+ treeReference?: TreeReference;
1833
+ }
1834
+ interface ItemsArrangedInCategory {
1835
+ /**
1836
+ * Category ID.
1837
+ * @format GUID
1838
+ */
1839
+ categoryId?: string;
1840
+ /** Category tree reference details. */
1841
+ treeReference?: TreeReference;
1842
+ }
1843
+ interface CreateCategoryRequest {
1844
+ /** Category to create. */
1845
+ category: Category;
1846
+ /** Category tree reference details. */
1847
+ treeReference: TreeReference;
1848
+ /**
1849
+ * Fields to include in the response.
1850
+ * @maxSize 100
1851
+ */
1852
+ fields?: SingleEntityOpsRequestedFields[];
1853
+ }
1854
+ declare enum SingleEntityOpsRequestedFields {
1855
+ /** Not implemented. */
1856
+ UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
1857
+ BREADCRUMBS_INFO = "BREADCRUMBS_INFO",
1858
+ DESCRIPTION = "DESCRIPTION",
1859
+ RICH_CONTENT_DESCRIPTION = "RICH_CONTENT_DESCRIPTION"
1860
+ }
1861
+ interface CreateCategoryResponse {
1862
+ /** Created category. */
1863
+ category?: Category;
1864
+ }
1865
+ interface GetCategoryRequest {
1866
+ /**
1867
+ * Category ID.
1868
+ * @format GUID
1869
+ */
1870
+ categoryId: string;
1871
+ /** Category tree reference details. */
1872
+ treeReference: TreeReference;
1873
+ /**
1874
+ * Fields to include in the response.
1875
+ * @maxSize 100
1876
+ */
1877
+ fields?: SingleEntityOpsRequestedFields[];
1878
+ }
1879
+ interface GetCategoryResponse {
1880
+ /** Category. */
1881
+ category?: Category;
1882
+ }
1883
+ interface UpdateCategoryRequest {
1884
+ /** Category to update. */
1885
+ category: Category;
1886
+ /** Category tree reference details. */
1887
+ treeReference: TreeReference;
1888
+ /**
1889
+ * Fields to include in the response.
1890
+ * @maxSize 100
1891
+ */
1892
+ fields?: SingleEntityOpsRequestedFields[];
1893
+ }
1894
+ interface UpdateCategoryResponse {
1895
+ /** Updated category. */
1896
+ category?: Category;
1897
+ }
1898
+ interface DeleteCategoryRequest {
1899
+ /**
1900
+ * Category ID.
1901
+ * @format GUID
1902
+ */
1903
+ categoryId: string;
1904
+ /** Category tree reference details. */
1905
+ treeReference: TreeReference;
1906
+ }
1907
+ interface DeleteCategoryResponse {
1908
+ }
1909
+ interface QueryCategoriesRequest {
1910
+ /** Query options. */
1911
+ query?: CursorQuery;
1912
+ /** Category tree reference details. */
1913
+ treeReference: TreeReference;
1914
+ /**
1915
+ * Whether to return non-visible categories.
1916
+ *
1917
+ * Default: `false` (only visible categories are returned)
1918
+ */
1919
+ returnNonVisibleCategories?: boolean;
1920
+ /**
1921
+ * Fields to include in the response.
1922
+ * @maxSize 100
1923
+ */
1924
+ fields?: RequestedFields[];
1925
+ }
1926
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
1927
+ /** 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`. */
1928
+ cursorPaging?: CursorPaging;
1929
+ /**
1930
+ * Filter object in the following format:
1931
+ * `"filter" : {
1932
+ * "fieldName1": "value1",
1933
+ * "fieldName2":{"$operator":"value2"}
1934
+ * }`
1935
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
1936
+ */
1937
+ filter?: Record<string, any> | null;
1938
+ /**
1939
+ * Sort object in the following format:
1940
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
1941
+ * @maxSize 5
1942
+ */
1943
+ sort?: Sorting[];
1944
+ }
1945
+ /** @oneof */
1946
+ interface CursorQueryPagingMethodOneOf {
1947
+ /** 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`. */
1948
+ cursorPaging?: CursorPaging;
1949
+ }
1950
+ interface Sorting {
1951
+ /**
1952
+ * Name of the field to sort by.
1953
+ * @maxLength 512
1954
+ */
1955
+ fieldName?: string;
1956
+ /** Sort order. */
1957
+ order?: SortOrder;
1958
+ }
1959
+ declare enum SortOrder {
1960
+ /** Ascending order. */
1961
+ ASC = "ASC",
1962
+ /** Descending order. */
1963
+ DESC = "DESC"
1964
+ }
1965
+ interface CursorPaging {
1966
+ /**
1967
+ * Maximum number of items to return in the results.
1968
+ * @max 1000
1969
+ */
1970
+ limit?: number | null;
1971
+ /**
1972
+ * Pointer to the next or previous page in the list of results.
1973
+ *
1974
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1975
+ * Not relevant for the first request.
1976
+ * @maxLength 16000
1977
+ */
1978
+ cursor?: string | null;
1979
+ }
1980
+ declare enum RequestedFields {
1981
+ /** Not implemented. */
1982
+ UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
1983
+ BREADCRUMBS_INFO = "BREADCRUMBS_INFO"
1984
+ }
1985
+ interface QueryCategoriesResponse {
1986
+ /**
1987
+ * List of categories.
1988
+ * @maxSize 1000
1989
+ */
1990
+ categories?: Category[];
1991
+ /** Paging metadata. */
1992
+ pagingMetadata?: CursorPagingMetadata;
1993
+ }
1994
+ interface CursorPagingMetadata {
1995
+ /** Number of items returned in the response. */
1996
+ count?: number | null;
1997
+ /** Cursor strings that point to the next page, previous page, or both. */
1998
+ cursors?: Cursors;
1999
+ /**
2000
+ * Whether there are more pages to retrieve following the current page.
2001
+ *
2002
+ * + `true`: Another page of results can be retrieved.
2003
+ * + `false`: This is the last page.
2004
+ */
2005
+ hasNext?: boolean | null;
2006
+ }
2007
+ interface Cursors {
2008
+ /**
2009
+ * Cursor string pointing to the next page in the list of results.
2010
+ * @maxLength 16000
2011
+ */
2012
+ next?: string | null;
2013
+ /**
2014
+ * Cursor pointing to the previous page in the list of results.
2015
+ * @maxLength 16000
2016
+ */
2017
+ prev?: string | null;
2018
+ }
2019
+ interface ListCompactCategoriesByIdsRequest {
2020
+ /**
2021
+ * List of category ids.
2022
+ * @format GUID
2023
+ * @minSize 1
2024
+ * @maxSize 1000
2025
+ */
2026
+ categoryIds?: string[];
2027
+ /** A reference to the tree that contains the categories. */
2028
+ treeReference?: TreeReference;
2029
+ }
2030
+ interface ListCompactCategoriesByIdsResponse {
2031
+ /** Categories which satisfy the provided ids. */
2032
+ categories?: CompactCategory[];
2033
+ }
2034
+ interface CompactCategory {
2035
+ /**
2036
+ * Category ID.
2037
+ * @format GUID
2038
+ */
2039
+ _id?: string | null;
2040
+ /**
2041
+ * Category name.
2042
+ * @minLength 1
2043
+ * @maxLength 80
2044
+ */
2045
+ name?: string | null;
2046
+ }
2047
+ interface SearchCategoriesRequest {
2048
+ /** Search options. */
2049
+ search?: CursorSearch;
2050
+ /**
2051
+ * Category tree reference details.
2052
+ * > **Note:** Pass `treeReference` only in the first request. Pass the cursor token in subsequent requests.
2053
+ */
2054
+ treeReference: TreeReference;
2055
+ /**
2056
+ * Whether to return the categories with `visible: false`.
2057
+ *
2058
+ * Default: `false` - only visible categories are returned in the response
2059
+ */
2060
+ returnNonVisibleCategories?: boolean;
2061
+ /**
2062
+ * Fields to include in the response.
2063
+ * @maxSize 100
2064
+ */
2065
+ fields?: RequestedFields[];
2066
+ }
2067
+ interface CursorSearch extends CursorSearchPagingMethodOneOf {
2068
+ /**
2069
+ * Cursor pointing to page of results.
2070
+ * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
2071
+ */
2072
+ cursorPaging?: CursorPaging;
2073
+ /** A filter object. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
2074
+ filter?: Record<string, any> | null;
2075
+ /**
2076
+ * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
2077
+ * @maxSize 10
2078
+ */
2079
+ sort?: Sorting[];
2080
+ /**
2081
+ * 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.
2082
+ * @maxSize 10
2083
+ */
2084
+ aggregations?: Aggregation[];
2085
+ /** Free text to match in searchable fields */
2086
+ search?: SearchDetails;
2087
+ /**
2088
+ * UTC offset or IANA time zone. Valid values are
2089
+ * ISO 8601 UTC offsets, such as +02:00 or -06:00,
2090
+ * and IANA time zone IDs, such as Europe/Rome
2091
+ *
2092
+ * Affects all filters and aggregations returned values.
2093
+ * You may override this behavior in a specific filter by providing
2094
+ * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
2095
+ * @maxLength 50
2096
+ */
2097
+ timeZone?: string | null;
2098
+ }
2099
+ /** @oneof */
2100
+ interface CursorSearchPagingMethodOneOf {
2101
+ /**
2102
+ * Cursor pointing to page of results.
2103
+ * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
2104
+ */
2105
+ cursorPaging?: CursorPaging;
2106
+ }
2107
+ interface Aggregation extends AggregationKindOneOf {
2108
+ /** Value aggregation */
2109
+ value?: ValueAggregation;
2110
+ /** Range aggregation */
2111
+ range?: RangeAggregation;
2112
+ /** Scalar aggregation */
2113
+ scalar?: ScalarAggregation;
2114
+ /** Date histogram aggregation */
2115
+ dateHistogram?: DateHistogramAggregation;
2116
+ /** Nested aggregation */
2117
+ nested?: NestedAggregation;
2118
+ /**
2119
+ * User-defined name of aggregation, should be unique, will appear in aggregation results
2120
+ * @maxLength 100
2121
+ */
2122
+ name?: string | null;
2123
+ /** Type of aggregation, client must provide matching aggregation field below */
2124
+ type?: AggregationType;
2125
+ /**
2126
+ * Field to aggregate by, use dot notation to specify json path
2127
+ * @maxLength 200
2128
+ */
2129
+ fieldPath?: string;
2130
+ }
2131
+ /** @oneof */
2132
+ interface AggregationKindOneOf {
2133
+ /** Value aggregation */
2134
+ value?: ValueAggregation;
2135
+ /** Range aggregation */
2136
+ range?: RangeAggregation;
2137
+ /** Scalar aggregation */
2138
+ scalar?: ScalarAggregation;
2139
+ /** Date histogram aggregation */
2140
+ dateHistogram?: DateHistogramAggregation;
2141
+ /** Nested aggregation */
2142
+ nested?: NestedAggregation;
2143
+ }
2144
+ interface RangeBucket {
2145
+ /** Inclusive lower bound of the range. Required if to is not given */
2146
+ from?: number | null;
2147
+ /** Exclusive upper bound of the range. Required if from is not given */
2148
+ to?: number | null;
2149
+ }
2150
+ declare enum SortType {
2151
+ /** Sort by number of matches. */
2152
+ COUNT = "COUNT",
2153
+ /** Sort alphabetically by field value. */
2154
+ VALUE = "VALUE"
2155
+ }
2156
+ declare enum SortDirection {
2157
+ /** Sort in descending order. */
2158
+ DESC = "DESC",
2159
+ /** Sort in ascending order. */
2160
+ ASC = "ASC"
2161
+ }
2162
+ declare enum MissingValues {
2163
+ /** Exclude missing values from the aggregation results. */
2164
+ EXCLUDE = "EXCLUDE",
2165
+ /** Included missing values in the aggregation results. */
2166
+ INCLUDE = "INCLUDE"
2167
+ }
2168
+ interface IncludeMissingValuesOptions {
2169
+ /**
2170
+ * Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
2171
+ * @maxLength 20
2172
+ */
2173
+ addToBucket?: string;
2174
+ }
2175
+ declare enum ScalarType {
2176
+ UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
2177
+ /** Count of distinct values. */
2178
+ COUNT_DISTINCT = "COUNT_DISTINCT",
2179
+ /** Minimum value. */
2180
+ MIN = "MIN",
2181
+ /** Maximum value. */
2182
+ MAX = "MAX"
2183
+ }
2184
+ interface ValueAggregation extends ValueAggregationOptionsOneOf {
2185
+ /** Options for including missing values */
2186
+ includeOptions?: IncludeMissingValuesOptions;
2187
+ /** Type of sort to perform. */
2188
+ sortType?: SortType;
2189
+ /** Direction to sort in. */
2190
+ sortDirection?: SortDirection;
2191
+ /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
2192
+ limit?: number | null;
2193
+ /**
2194
+ * Whether missing values are included in the aggregation results.
2195
+ * Default: `EXCLUDE`
2196
+ */
2197
+ missingValues?: MissingValues;
2198
+ }
2199
+ /** @oneof */
2200
+ interface ValueAggregationOptionsOneOf {
2201
+ /** Options for including missing values */
2202
+ includeOptions?: IncludeMissingValuesOptions;
2203
+ }
2204
+ declare enum NestedAggregationType {
2205
+ /** Unknown aggregation type. */
2206
+ UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
2207
+ /** An aggregation where result buckets are dynamically built - one per unique value. */
2208
+ VALUE = "VALUE",
2209
+ /** An aggregation, where user can define set of ranges - each representing a bucket. */
2210
+ RANGE = "RANGE",
2211
+ /** A single-value metric aggregation - such as min, max, sum, and avg. */
2212
+ SCALAR = "SCALAR",
2213
+ /** An aggregation, where result buckets are dynamically built - one per time interval such as hour, day, and week. */
2214
+ DATE_HISTOGRAM = "DATE_HISTOGRAM"
2215
+ }
2216
+ interface RangeAggregation {
2217
+ /**
2218
+ * 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
2219
+ * @maxSize 50
2220
+ */
2221
+ buckets?: RangeBucket[];
2222
+ }
2223
+ interface ScalarAggregation {
2224
+ /** Define the operator for the scalar aggregation */
2225
+ type?: ScalarType;
2226
+ }
2227
+ interface DateHistogramAggregation {
2228
+ /** Interval for date histogram aggregation */
2229
+ interval?: Interval;
2230
+ }
2231
+ declare enum Interval {
2232
+ UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
2233
+ /** Yearly interval */
2234
+ YEAR = "YEAR",
2235
+ /** Monthly interval */
2236
+ MONTH = "MONTH",
2237
+ /** Weekly interval */
2238
+ WEEK = "WEEK",
2239
+ /** Daily interval */
2240
+ DAY = "DAY",
2241
+ /** Hourly interval */
2242
+ HOUR = "HOUR",
2243
+ /** Minute interval */
2244
+ MINUTE = "MINUTE",
2245
+ /** Second interval */
2246
+ SECOND = "SECOND"
2247
+ }
2248
+ interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
2249
+ /** Value aggregation */
2250
+ value?: ValueAggregation;
2251
+ /** Range aggregation */
2252
+ range?: RangeAggregation;
2253
+ /** Scalar aggregation */
2254
+ scalar?: ScalarAggregation;
2255
+ /** Date histogram aggregation */
2256
+ dateHistogram?: DateHistogramAggregation;
2257
+ /**
2258
+ * User-defined name of aggregation, should be unique, will appear in aggregation results
2259
+ * @maxLength 100
2260
+ */
2261
+ name?: string | null;
2262
+ /** Type of aggregation client must provide matching aggregation field below */
2263
+ type?: NestedAggregationType;
2264
+ /**
2265
+ * Field to aggregate by, use dont notation to specify json path
2266
+ * @maxLength 200
2267
+ */
2268
+ fieldPath?: string;
2269
+ }
2270
+ /** @oneof */
2271
+ interface NestedAggregationItemKindOneOf {
2272
+ /** Value aggregation */
2273
+ value?: ValueAggregation;
2274
+ /** Range aggregation */
2275
+ range?: RangeAggregation;
2276
+ /** Scalar aggregation */
2277
+ scalar?: ScalarAggregation;
2278
+ /** Date histogram aggregation */
2279
+ dateHistogram?: DateHistogramAggregation;
2280
+ }
2281
+ declare enum AggregationType {
2282
+ UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
2283
+ /** An aggregation where result buckets are dynamically built - one per unique value. */
2284
+ VALUE = "VALUE",
2285
+ /** An aggregation, where user can define set of ranges - each representing a bucket. */
2286
+ RANGE = "RANGE",
2287
+ /** A single-value metric aggregation - such as min, max, sum, and avg. */
2288
+ SCALAR = "SCALAR",
2289
+ /** An aggregation, where result buckets are dynamically built - one per time interval such as hour, day, and week. */
2290
+ DATE_HISTOGRAM = "DATE_HISTOGRAM",
2291
+ /** Multi-level aggregation, where each next aggregation is nested within the previous one. */
2292
+ NESTED = "NESTED"
2293
+ }
2294
+ /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
2295
+ interface NestedAggregation {
2296
+ /**
2297
+ * Flattened list of aggregations, where each next aggregation is nested within previous one
2298
+ * @minSize 2
2299
+ * @maxSize 3
2300
+ */
2301
+ nestedAggregations?: NestedAggregationItem[];
2302
+ }
2303
+ interface SearchDetails {
2304
+ /** Defines how separate search terms in `expression` are combined. */
2305
+ mode?: Mode;
2306
+ /**
2307
+ * Search term or expression.
2308
+ * @maxLength 100
2309
+ */
2310
+ expression?: string | null;
2311
+ /**
2312
+ * Fields in which to search for the `expression`. Use dot notation to specify field path.
2313
+ *
2314
+ * When empty - all searchable fields are looked at.
2315
+ * @maxLength 200
2316
+ * @maxSize 20
2317
+ */
2318
+ fields?: string[];
2319
+ /** Whether to use fuzzy search - allowing typos and other minor errors in the search. */
2320
+ fuzzy?: boolean;
2321
+ }
2322
+ declare enum Mode {
2323
+ /** Any of the search terms must be present. */
2324
+ OR = "OR",
2325
+ /** All search terms must be present. */
2326
+ AND = "AND"
2327
+ }
2328
+ interface SearchCategoriesResponse {
2329
+ /**
2330
+ * List of categories.
2331
+ * @maxSize 1000
2332
+ */
2333
+ categories?: Category[];
2334
+ /** Paging metadata. */
2335
+ pagingMetadata?: CursorPagingMetadata;
2336
+ /** Aggregation data. */
2337
+ aggregationData?: AggregationData;
2338
+ }
2339
+ interface AggregationData {
2340
+ /**
2341
+ * key = aggregation name (as derived from search request)
2342
+ * @maxSize 10000
2343
+ */
2344
+ results?: AggregationResults[];
2345
+ }
2346
+ interface ValueAggregationResult {
2347
+ /**
2348
+ * Value of the field
2349
+ * @maxLength 100
2350
+ */
2351
+ value?: string;
2352
+ /** Count of entities with this value */
2353
+ count?: number;
2354
+ }
2355
+ interface RangeAggregationResult {
2356
+ /** Inclusive lower bound of the range */
2357
+ from?: number | null;
2358
+ /** Exclusive upper bound of the range */
2359
+ to?: number | null;
2360
+ /** Count of entities in this range */
2361
+ count?: number;
2362
+ }
2363
+ interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
2364
+ /** Value aggregation results */
2365
+ values?: ValueResults;
2366
+ /** Range aggregation results */
2367
+ ranges?: RangeResults;
2368
+ /** Scalar aggregation results */
2369
+ scalar?: AggregationResultsScalarResult;
2370
+ /**
2371
+ * User-defined name of aggregation, matches the one provided in request
2372
+ * @maxLength 100
2373
+ */
2374
+ name?: string;
2375
+ /** Type of aggregation that matches result */
2376
+ type?: AggregationType;
2377
+ /**
2378
+ * Field to aggregate by, matches the one provided in request
2379
+ * @maxLength 200
2380
+ */
2381
+ fieldPath?: string;
2382
+ }
2383
+ /** @oneof */
2384
+ interface NestedAggregationResultsResultOneOf {
2385
+ /** Value aggregation results */
2386
+ values?: ValueResults;
2387
+ /** Range aggregation results */
2388
+ ranges?: RangeResults;
2389
+ /** Scalar aggregation results */
2390
+ scalar?: AggregationResultsScalarResult;
2391
+ }
2392
+ interface ValueResults {
2393
+ /**
2394
+ * List of value aggregations
2395
+ * @maxSize 250
2396
+ */
2397
+ results?: ValueAggregationResult[];
2398
+ }
2399
+ interface RangeResults {
2400
+ /**
2401
+ * List of ranges returned in same order as requested
2402
+ * @maxSize 50
2403
+ */
2404
+ results?: RangeAggregationResult[];
2405
+ }
2406
+ interface AggregationResultsScalarResult {
2407
+ /** Type of scalar aggregation */
2408
+ type?: ScalarType;
2409
+ /** Value of the scalar aggregation */
2410
+ value?: number;
2411
+ }
2412
+ interface NestedValueAggregationResult {
2413
+ /**
2414
+ * Value of the field
2415
+ * @maxLength 1000
2416
+ */
2417
+ value?: string;
2418
+ /** Nested aggregations */
2419
+ nestedResults?: NestedAggregationResults;
2420
+ }
2421
+ interface ValueResult {
2422
+ /**
2423
+ * Value of the field
2424
+ * @maxLength 1000
2425
+ */
2426
+ value?: string;
2427
+ /** Count of entities with this value */
2428
+ count?: number | null;
2429
+ }
2430
+ interface RangeResult {
2431
+ /** Inclusive lower bound of the range */
2432
+ from?: number | null;
2433
+ /** Exclusive upper bound of the range */
2434
+ to?: number | null;
2435
+ /** Count of entities in this range */
2436
+ count?: number | null;
2437
+ }
2438
+ interface ScalarResult {
2439
+ /** Value of the scalar aggregation */
2440
+ value?: number;
2441
+ }
2442
+ interface NestedResultValue extends NestedResultValueResultOneOf {
2443
+ /** Value aggregation result */
2444
+ value?: ValueResult;
2445
+ /** Range aggregation result */
2446
+ range?: RangeResult;
2447
+ /** Scalar aggregation result */
2448
+ scalar?: ScalarResult;
2449
+ /** Date histogram aggregation result */
2450
+ dateHistogram?: ValueResult;
2451
+ }
2452
+ /** @oneof */
2453
+ interface NestedResultValueResultOneOf {
2454
+ /** Value aggregation result */
2455
+ value?: ValueResult;
2456
+ /** Range aggregation result */
2457
+ range?: RangeResult;
2458
+ /** Scalar aggregation result */
2459
+ scalar?: ScalarResult;
2460
+ /** Date histogram aggregation result */
2461
+ dateHistogram?: ValueResult;
2462
+ }
2463
+ interface Results {
2464
+ /** List of nested aggregations */
2465
+ results?: Record<string, NestedResultValue>;
2466
+ }
2467
+ interface DateHistogramResult {
2468
+ /**
2469
+ * Date in ISO 8601 format
2470
+ * @maxLength 100
2471
+ */
2472
+ value?: string;
2473
+ /** Count of documents in the bucket */
2474
+ count?: number;
2475
+ }
2476
+ interface GroupByValueResults {
2477
+ /**
2478
+ * List of value aggregations
2479
+ * @maxSize 1000
2480
+ */
2481
+ results?: NestedValueAggregationResult[];
2482
+ }
2483
+ interface DateHistogramResults {
2484
+ /**
2485
+ * List of date histogram aggregations
2486
+ * @maxSize 200
2487
+ */
2488
+ results?: DateHistogramResult[];
2489
+ }
2490
+ /**
2491
+ * Results of `NESTED` aggregation type in a flattened form
2492
+ * aggregations in resulting array are keyed by requested aggregation `name`.
2493
+ */
2494
+ interface NestedResults {
2495
+ /**
2496
+ * List of nested aggregations
2497
+ * @maxSize 1000
2498
+ */
2499
+ results?: Results[];
2500
+ }
2501
+ interface AggregationResults extends AggregationResultsResultOneOf {
2502
+ /** Value aggregation results */
2503
+ values?: ValueResults;
2504
+ /** Range aggregation results */
2505
+ ranges?: RangeResults;
2506
+ /** Scalar aggregation results */
2507
+ scalar?: AggregationResultsScalarResult;
2508
+ /** Group by value aggregation results */
2509
+ groupedByValue?: GroupByValueResults;
2510
+ /** Date histogram aggregation results */
2511
+ dateHistogram?: DateHistogramResults;
2512
+ /** Nested aggregation results */
2513
+ nested?: NestedResults;
2514
+ /**
2515
+ * User-defined name of aggregation as derived from search request
2516
+ * @maxLength 100
2517
+ */
2518
+ name?: string;
2519
+ /** Type of aggregation that must match provided kind as derived from search request */
2520
+ type?: AggregationType;
2521
+ /**
2522
+ * Field to aggregate by as derived from search request
2523
+ * @maxLength 200
2524
+ */
2525
+ fieldPath?: string;
2526
+ }
2527
+ /** @oneof */
2528
+ interface AggregationResultsResultOneOf {
2529
+ /** Value aggregation results */
2530
+ values?: ValueResults;
2531
+ /** Range aggregation results */
2532
+ ranges?: RangeResults;
2533
+ /** Scalar aggregation results */
2534
+ scalar?: AggregationResultsScalarResult;
2535
+ /** Group by value aggregation results */
2536
+ groupedByValue?: GroupByValueResults;
2537
+ /** Date histogram aggregation results */
2538
+ dateHistogram?: DateHistogramResults;
2539
+ /** Nested aggregation results */
2540
+ nested?: NestedResults;
2541
+ }
2542
+ interface DeprecatedSearchCategoriesWithOffsetRequest {
2543
+ /** WQL query expression. */
2544
+ search?: OffsetSearch;
2545
+ /** Category tree reference details. */
2546
+ treeReference?: TreeReference;
2547
+ /** Whether to return categories with `visible:false`. Default: false so only visible categories will be in response. */
2548
+ returnNonVisibleCategories?: boolean;
2549
+ /**
2550
+ * Fields to include in the response.
2551
+ * @maxSize 100
2552
+ */
2553
+ fields?: RequestedFields[];
2554
+ }
2555
+ interface OffsetSearch extends OffsetSearchPagingMethodOneOf {
2556
+ /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
2557
+ paging?: Paging;
2558
+ /** A filter object. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
2559
+ filter?: Record<string, any> | null;
2560
+ /**
2561
+ * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
2562
+ * @maxSize 10
2563
+ */
2564
+ sort?: Sorting[];
2565
+ /**
2566
+ * 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.
2567
+ * @maxSize 10
2568
+ */
2569
+ aggregations?: Aggregation[];
2570
+ /** Free text to match in searchable fields */
2571
+ search?: SearchDetails;
2572
+ /**
2573
+ * UTC offset or IANA time zone. Valid values are
2574
+ * ISO 8601 UTC offsets, such as +02:00 or -06:00,
2575
+ * and IANA time zone IDs, such as Europe/Rome
2576
+ *
2577
+ * Affects all filters and aggregations returned values.
2578
+ * You may override this behavior in a specific filter by providing
2579
+ * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
2580
+ * @maxLength 50
2581
+ */
2582
+ timeZone?: string | null;
2583
+ }
2584
+ /** @oneof */
2585
+ interface OffsetSearchPagingMethodOneOf {
2586
+ /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
2587
+ paging?: Paging;
2588
+ }
2589
+ interface Paging {
2590
+ /**
2591
+ * Number of items to load.
2592
+ * @max 1000
2593
+ */
2594
+ limit?: number | null;
2595
+ /** Number of items to skip in the current sort order. */
2596
+ offset?: number | null;
2597
+ }
2598
+ interface DeprecatedSearchCategoriesWithOffsetResponse {
2599
+ /**
2600
+ * Categories which satisfy the provided query.
2601
+ * @maxSize 1000
2602
+ */
2603
+ categories?: Category[];
2604
+ /** Paging metadata. */
2605
+ pagingMetadata?: PagingMetadata;
2606
+ /** Aggregation data. */
2607
+ aggregationData?: AggregationData;
2608
+ }
2609
+ interface PagingMetadata {
2610
+ /** Number of items returned in the response. */
2611
+ count?: number | null;
2612
+ /** Offset that was requested. */
2613
+ offset?: number | null;
2614
+ /** Total number of items that match the query. */
2615
+ total?: number | null;
2616
+ /** Flag that indicates the server failed to calculate the `total` field. */
2617
+ tooManyToCount?: boolean | null;
2618
+ }
2619
+ interface CountCategoriesRequest {
2620
+ /**
2621
+ * Filter object.
2622
+ *
2623
+ * Learn more about the [filter object structure](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
2624
+ */
2625
+ filter?: Record<string, any> | null;
2626
+ /** Search options. */
2627
+ search?: SearchDetails;
2628
+ /** Category tree reference details. */
2629
+ treeReference: TreeReference;
2630
+ /**
2631
+ * Whether to return categories with `visible: false` (hidden categories).
2632
+ *
2633
+ * Default: `false` - only visible categories are returned in the response
2634
+ */
2635
+ returnNonVisibleCategories?: boolean;
2636
+ }
2637
+ interface CountCategoriesResponse {
2638
+ /** Total count of categories which satisfy the given filter and/or search. */
2639
+ count?: number;
2640
+ }
2641
+ interface MoveCategoryRequest {
2642
+ /**
2643
+ * ID of the category to move.
2644
+ * @format GUID
2645
+ */
2646
+ categoryId: string;
2647
+ /** Category tree reference details. */
2648
+ treeReference: TreeReference;
2649
+ /**
2650
+ * Parent category ID.
2651
+ *
2652
+ * Default: root category ID
2653
+ * @format GUID
2654
+ */
2655
+ parentCategoryId?: string | null;
2656
+ /**
2657
+ * Where to place the subcategory.
2658
+ *
2659
+ * + `FIRST`: Position the category as the first subcategory.
2660
+ * + `LAST`: Position the category as the last subcategory.
2661
+ * + `AFTER`: Position the category after the category ID passed in `moveAfterCategoryId`.
2662
+ */
2663
+ position: Position;
2664
+ /**
2665
+ * Required when passing `position: AFTER`.
2666
+ * @format GUID
2667
+ */
2668
+ moveAfterCategoryId?: string | null;
2669
+ }
2670
+ declare enum Position {
2671
+ UNKNOWN_POSITION = "UNKNOWN_POSITION",
2672
+ FIRST = "FIRST",
2673
+ LAST = "LAST",
2674
+ AFTER = "AFTER"
2675
+ }
2676
+ interface MoveCategoryResponse {
2677
+ /**
2678
+ * Parent category ID.
2679
+ * @format GUID
2680
+ */
2681
+ parentCategoryId?: string | null;
2682
+ /**
2683
+ * List of category IDs in the new order of arrangement.
2684
+ * @format GUID
2685
+ * @maxSize 100
2686
+ */
2687
+ categoriesAfterMove?: string[];
2688
+ }
2689
+ interface BulkCreateCategoriesRequest {
2690
+ /**
2691
+ * List of categories to be created.
2692
+ * @minSize 1
2693
+ * @maxSize 100
2694
+ */
2695
+ categories?: Category[];
2696
+ /** Category tree reference details. */
2697
+ treeReference?: TreeReference;
2698
+ /**
2699
+ * Whether to return the category entity in the response.
2700
+ *
2701
+ * Default: `false`
2702
+ */
2703
+ returnEntity?: boolean;
2704
+ /**
2705
+ * Fields to include in the response.
2706
+ * @maxSize 100
2707
+ */
2708
+ fields?: RequestedFields[];
2709
+ }
2710
+ interface BulkCreateCategoriesResponse {
2711
+ /**
2712
+ * Categories created by bulk action.
2713
+ * @minSize 1
2714
+ * @maxSize 100
2715
+ */
2716
+ results?: BulkCategoriesResult[];
2717
+ /** Bulk action metadata. */
2718
+ bulkActionMetadata?: BulkActionMetadata;
2719
+ }
2720
+ interface BulkCategoriesResult {
2721
+ /** Bulk action metadata for category. */
2722
+ itemMetadata?: ItemMetadata;
2723
+ /**
2724
+ * Full category entity.
2725
+ *
2726
+ * Returned only if `returnEntity: true` is passed in the request.
2727
+ */
2728
+ category?: Category;
2729
+ }
2730
+ interface ItemMetadata {
2731
+ /**
2732
+ * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
2733
+ * @format GUID
2734
+ */
2735
+ _id?: string | null;
2736
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
2737
+ originalIndex?: number;
2738
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
2739
+ success?: boolean;
2740
+ /** Details about the error in case of failure. */
2741
+ error?: ApplicationError;
2742
+ }
2743
+ interface ApplicationError {
2744
+ /** Error code. */
2745
+ code?: string;
2746
+ /** Description of the error. */
2747
+ description?: string;
2748
+ /** Data related to the error. */
2749
+ data?: Record<string, any> | null;
2750
+ }
2751
+ interface BulkActionMetadata {
2752
+ /** Number of items that were successfully processed. */
2753
+ totalSuccesses?: number;
2754
+ /** Number of items that couldn't be processed. */
2755
+ totalFailures?: number;
2756
+ /** Number of failures without details because detailed failure threshold was exceeded. */
2757
+ undetailedFailures?: number;
2758
+ }
2759
+ interface BulkUpdateCategoriesRequest {
2760
+ /**
2761
+ * List of categories to update.
2762
+ * @minSize 1
2763
+ * @maxSize 100
2764
+ */
2765
+ categories: MaskedCategory[];
2766
+ /** Category tree reference details. */
2767
+ treeReference: TreeReference;
2768
+ /**
2769
+ * Whether to return the full category entity in the response.
2770
+ *
2771
+ * Default: `false`
2772
+ */
2773
+ returnEntity?: boolean;
2774
+ /**
2775
+ * Fields to include in the response.
2776
+ * @maxSize 100
2777
+ */
2778
+ fields?: RequestedFields[];
2779
+ }
2780
+ interface MaskedCategory {
2781
+ /** Category to update. */
2782
+ category?: Category;
2783
+ }
2784
+ interface BulkUpdateCategoriesResponse {
2785
+ /**
2786
+ * Categories updated by bulk action.
2787
+ * @minSize 1
2788
+ * @maxSize 100
2789
+ */
2790
+ results?: BulkCategoriesResult[];
2791
+ /** Bulk action metadata. */
2792
+ bulkActionMetadata?: BulkActionMetadata;
2793
+ }
2794
+ interface UpdateCategoryVisibilityRequest {
2795
+ /**
2796
+ * Category ID.
2797
+ * @format GUID
2798
+ */
2799
+ categoryId: string;
2800
+ /**
2801
+ * Whether the category is visible to site visitors in dynamic pages.
2802
+ *
2803
+ * + If a parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
2804
+ * + Passing `true` will fail if the visibility of any parent categories is `false`.
2805
+ */
2806
+ visible: boolean;
2807
+ /** Category tree reference details. */
2808
+ treeReference: TreeReference;
2809
+ /**
2810
+ * Latest revision of the category.
2811
+ * To prevent conflicting changes, the current revision must be passed on update.
2812
+ */
2813
+ revision: string | null;
2814
+ /**
2815
+ * Fields to include in the response.
2816
+ * @maxSize 100
2817
+ */
2818
+ fields?: SingleEntityOpsRequestedFields[];
2819
+ }
2820
+ interface UpdateCategoryVisibilityResponse {
2821
+ /** Updated category. */
2822
+ category?: Category;
2823
+ }
2824
+ interface BulkShowCategoriesRequest {
2825
+ /**
2826
+ * IDs of the categories to update.
2827
+ * @format GUID
2828
+ * @minSize 1
2829
+ * @maxSize 100
2830
+ */
2831
+ categoryIds: string[];
2832
+ /** Category tree reference details. */
2833
+ treeReference: TreeReference;
2834
+ /**
2835
+ * Whether to return the category entity in the response.
2836
+ *
2837
+ * Default: `false`
2838
+ */
2839
+ returnEntity?: boolean;
2840
+ /**
2841
+ * Fields to include in the response.
2842
+ * @maxSize 100
2843
+ */
2844
+ fields?: RequestedFields[];
2845
+ }
2846
+ interface BulkShowCategoriesResponse {
2847
+ /**
2848
+ * Categories updated by bulk action.
2849
+ * @minSize 1
2850
+ * @maxSize 100
2851
+ */
2852
+ results?: BulkCategoriesResult[];
2853
+ /** Bulk action metadata. */
2854
+ bulkActionMetadata?: BulkActionMetadata;
2855
+ }
2856
+ interface BulkUpdateCategoryVisibilityByFilterRequest {
2857
+ /**
2858
+ * Filter object in the following format:
2859
+ * `"filter" : {
2860
+ * "fieldName1": "value1",
2861
+ * "fieldName2":{"$operator":"value2"}
2862
+ * }`
2863
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2864
+ */
2865
+ filter?: Record<string, any> | null;
2866
+ /** Category tree reference details. */
2867
+ treeReference?: TreeReference;
2868
+ /** value to set `visible` to. This value will be set for all categories that match the filter */
2869
+ visible?: boolean;
2870
+ }
2871
+ interface BulkUpdateCategoryVisibilityByFilterResponse {
2872
+ /**
2873
+ * Job ID.
2874
+ *
2875
+ * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..
2876
+ * @format GUID
2877
+ */
2878
+ jobId?: string;
2879
+ }
2880
+ interface BulkDeleteCategoriesRequest {
2881
+ /**
2882
+ * IDs of categories to be deleted.
2883
+ * @format GUID
2884
+ * @minSize 1
2885
+ * @maxSize 100
2886
+ */
2887
+ categoryIds?: string[];
2888
+ }
2889
+ interface BulkDeleteCategoriesResponse {
2890
+ /**
2891
+ * Categories deleted by bulk action.
2892
+ * @minSize 1
2893
+ * @maxSize 100
2894
+ */
2895
+ results?: BulkDeleteCategoriesResponseBulkCategoriesResult[];
2896
+ /** Bulk action metadata. */
2897
+ bulkActionMetadata?: BulkActionMetadata;
2898
+ }
2899
+ interface BulkDeleteCategoriesResponseBulkCategoriesResult {
2900
+ /** Information about successful action or error for failure. */
2901
+ itemMetadata?: ItemMetadata;
2902
+ }
2903
+ interface BulkDeleteCategoriesByFilterRequest {
2904
+ /**
2905
+ * Filter object in the following format:
2906
+ * `"filter" : {
2907
+ * "fieldName1": "value1",
2908
+ * "fieldName2":{"$operator":"value2"}
2909
+ * }`
2910
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2911
+ */
2912
+ filter?: Record<string, any> | null;
2913
+ /** Category tree reference details. */
2914
+ treeReference?: TreeReference;
2915
+ }
2916
+ interface BulkDeleteCategoriesByFilterResponse {
2917
+ /**
2918
+ * Job ID.
2919
+ *
2920
+ * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..
2921
+ * @format GUID
2922
+ */
2923
+ jobId?: string;
2924
+ }
2925
+ interface BulkAddItemsToCategoryRequest {
2926
+ /**
2927
+ * Category ID.
2928
+ * @format GUID
2929
+ */
2930
+ categoryId: string;
2931
+ /**
2932
+ * List of items to add.
2933
+ * @minSize 1
2934
+ * @maxSize 1000
2935
+ */
2936
+ items: ItemReference[];
2937
+ /** Category tree reference details. */
2938
+ treeReference: TreeReference;
2939
+ }
2940
+ interface BulkAddItemsToCategoryResponse {
2941
+ /**
2942
+ * List of items added to a category by bulk action.
2943
+ * @minSize 1
2944
+ * @maxSize 100
2945
+ */
2946
+ results?: BulkItemsToCategoryResult[];
2947
+ /** Bulk action metadata. */
2948
+ bulkActionMetadata?: BulkActionMetadata;
2949
+ }
2950
+ interface BulkItemsToCategoryResult {
2951
+ /** Bulk action metadata for item reference. */
2952
+ itemMetadata?: ItemReferenceMetadata;
2953
+ }
2954
+ interface ItemReferenceMetadata {
2955
+ /** Catalog and item reference info. */
2956
+ item?: ItemReference;
2957
+ /** Original index of the item within the request array. Allows for correlation between request and response items. */
2958
+ originalIndex?: number;
2959
+ /**
2960
+ * Whether the action was successful.
2961
+ * When `false`, the `error` field is populated.
2962
+ */
2963
+ success?: boolean;
2964
+ /** Error details in the case of an unsuccessful action. */
2965
+ error?: ApplicationError;
2966
+ }
2967
+ interface BulkAddItemToCategoriesRequest {
2968
+ /** Item to add. */
2969
+ item: ItemReference;
2970
+ /**
2971
+ * IDs of categories to which to add the item.
2972
+ * @format GUID
2973
+ * @minSize 1
2974
+ * @maxSize 100
2975
+ */
2976
+ categoryIds: string[];
2977
+ /** Category tree reference details. */
2978
+ treeReference: TreeReference;
2979
+ }
2980
+ interface BulkAddItemToCategoriesResponse {
2981
+ /**
2982
+ * Items added by bulk action.
2983
+ * @minSize 1
2984
+ * @maxSize 100
2985
+ */
2986
+ results?: BulkItemToCategoriesResult[];
2987
+ /** Bulk action metadata. */
2988
+ bulkActionMetadata?: BulkActionMetadata;
2989
+ }
2990
+ interface BulkItemToCategoriesResult {
2991
+ /** Bulk action metadata for category. */
2992
+ itemMetadata?: ItemMetadata;
2993
+ }
2994
+ interface BulkRemoveItemsFromCategoryRequest {
2995
+ /**
2996
+ * Category ID.
2997
+ * @format GUID
2998
+ */
2999
+ categoryId: string;
3000
+ /**
3001
+ * List of items to remove.
3002
+ * @minSize 1
3003
+ * @maxSize 100
3004
+ */
3005
+ items: ItemReference[];
3006
+ /** Category tree reference details. */
3007
+ treeReference: TreeReference;
3008
+ }
3009
+ interface BulkRemoveItemsFromCategoryResponse {
3010
+ /**
3011
+ * Items removed by bulk action.
3012
+ * @minSize 1
3013
+ * @maxSize 100
3014
+ */
3015
+ results?: BulkItemsToCategoryResult[];
3016
+ /** Bulk action metadata. */
3017
+ bulkActionMetadata?: BulkActionMetadata;
3018
+ }
3019
+ interface BulkRemoveItemFromCategoriesRequest {
3020
+ /** Item to remove. */
3021
+ item: ItemReference;
3022
+ /**
3023
+ * IDs of categories from which to remove the item.
3024
+ * @format GUID
3025
+ * @minSize 1
3026
+ * @maxSize 100
3027
+ */
3028
+ categoryIds: string[];
3029
+ /** Category tree reference details. */
3030
+ treeReference: TreeReference;
3031
+ }
3032
+ interface BulkRemoveItemFromCategoriesResponse {
3033
+ /**
3034
+ * Items removed by bulk action.
3035
+ * @minSize 1
3036
+ * @maxSize 100
3037
+ */
3038
+ results?: BulkItemToCategoriesResult[];
3039
+ /** Bulk action metadata. */
3040
+ bulkActionMetadata?: BulkActionMetadata;
3041
+ }
3042
+ interface ListItemsInCategoryRequest extends ListItemsInCategoryRequestPagingMethodOneOf {
3043
+ /**
3044
+ * Cursor paging options.
3045
+ *
3046
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
3047
+ */
3048
+ cursorPaging?: CursorPaging;
3049
+ /**
3050
+ * Category ID.
3051
+ * @format GUID
3052
+ */
3053
+ categoryId: string;
3054
+ /** Category tree reference details. */
3055
+ treeReference: TreeReference;
3056
+ /**
3057
+ * Whether to use category arrangement for sorting items.
3058
+ *
3059
+ * Default: `false`
3060
+ */
3061
+ useCategoryArrangement?: boolean;
3062
+ /**
3063
+ * Whether to include items from subcategories.
3064
+ *
3065
+ * Default: `false` (only direct items of the category will be returned)
3066
+ */
3067
+ includeItemsFromSubcategories?: boolean;
3068
+ }
3069
+ /** @oneof */
3070
+ interface ListItemsInCategoryRequestPagingMethodOneOf {
3071
+ /**
3072
+ * Cursor paging options.
3073
+ *
3074
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
3075
+ */
3076
+ cursorPaging?: CursorPaging;
3077
+ }
3078
+ interface ListItemsInCategoryResponse {
3079
+ /**
3080
+ * List of items in the category.
3081
+ * @maxSize 100
3082
+ */
3083
+ items?: ItemReference[];
3084
+ /** Paging metadata. */
3085
+ pagingMetadata?: PagingMetadataV2;
3086
+ }
3087
+ interface PagingMetadataV2 {
3088
+ /** Number of items returned in the response. */
3089
+ count?: number | null;
3090
+ /** Offset that was requested. */
3091
+ offset?: number | null;
3092
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
3093
+ total?: number | null;
3094
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
3095
+ cursors?: Cursors;
3096
+ }
3097
+ interface ListCategoriesForItemRequest {
3098
+ /** Item reference info. */
3099
+ item: ItemReference;
3100
+ /** Category tree reference details. */
3101
+ treeReference: TreeReference;
3102
+ }
3103
+ interface ListCategoriesForItemResponse {
3104
+ /**
3105
+ * List of IDs of categories that directly contain this item.
3106
+ * @format GUID
3107
+ * @maxSize 1000
3108
+ */
3109
+ directCategoryIds?: string[];
3110
+ /**
3111
+ * List of IDs of categories that directly contain this item, and their parent category IDs.
3112
+ * @format GUID
3113
+ * @maxSize 1000
3114
+ */
3115
+ allCategoryIds?: string[];
3116
+ }
3117
+ interface ListCategoriesForItemsRequest {
3118
+ /**
3119
+ * List of Item reference info.
3120
+ * @maxSize 100
3121
+ */
3122
+ items: ItemReference[];
3123
+ /** Category tree reference details. */
3124
+ treeReference: TreeReference;
3125
+ }
3126
+ interface ListCategoriesForItemsResponse {
3127
+ /**
3128
+ * Map of item references to lists of direct category IDs and all category IDs, including parent categories and direct ones.
3129
+ * @maxSize 100
3130
+ */
3131
+ categoriesForItems?: MapItemToCategories[];
3132
+ }
3133
+ interface MapItemToCategories {
3134
+ /** Item reference info. */
3135
+ item?: ItemReference;
3136
+ /**
3137
+ * List of IDs of categories that directly contain this item.
3138
+ * @format GUID
3139
+ * @maxSize 1000
3140
+ */
3141
+ directCategoryIds?: string[];
3142
+ /**
3143
+ * List of IDs of categories that indirectly contain this item, including all ancestors of its direct categories in the hierarchy.
3144
+ * @format GUID
3145
+ * @maxSize 1000
3146
+ */
3147
+ indirectCategoryIds?: string[];
3148
+ }
3149
+ interface ListTreesRequest {
3150
+ }
3151
+ interface ListTreesResponse {
3152
+ /**
3153
+ * List of trees.
3154
+ * @maxSize 20
3155
+ */
3156
+ trees?: TreeReference[];
3157
+ }
3158
+ interface MoveItemInCategoryRequest {
3159
+ /**
3160
+ * Category ID.
3161
+ * @format GUID
3162
+ */
3163
+ categoryId?: string;
3164
+ /** Category tree reference details. */
3165
+ treeReference?: TreeReference;
3166
+ /** Item to move. */
3167
+ item?: ItemReference;
3168
+ /**
3169
+ * Where to move item.
3170
+ * `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.
3171
+ * `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.
3172
+ * `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.
3173
+ * `NONE` - don't use manual arrangement for `item`, it will be shown after all items with manual arrangement according to default sorting.
3174
+ */
3175
+ position?: MoveItemInCategoryRequestPosition;
3176
+ /** Required when `position` is `BEFORE`. `before_item` must be manually arranged item. */
3177
+ beforeItem?: ItemReference;
3178
+ }
3179
+ declare enum MoveItemInCategoryRequestPosition {
3180
+ UNKNOWN_POSITION = "UNKNOWN_POSITION",
3181
+ FIRST = "FIRST",
3182
+ LAST = "LAST",
3183
+ BEFORE = "BEFORE",
3184
+ NONE = "NONE"
3185
+ }
3186
+ interface MoveItemInCategoryResponse {
3187
+ /**
3188
+ * Information about manually arranged items after move.
3189
+ * @maxSize 100
3190
+ */
3191
+ itemsAfterMove?: ItemReference[];
3192
+ }
3193
+ interface SetArrangedItemsRequest {
3194
+ /**
3195
+ * Category ID.
3196
+ * @format GUID
3197
+ */
3198
+ categoryId: string;
3199
+ /** Category tree reference details. */
3200
+ treeReference: TreeReference;
3201
+ /**
3202
+ * List of items to set.
3203
+ * @maxSize 100
3204
+ */
3205
+ items?: ItemReference[];
3206
+ }
3207
+ interface SetArrangedItemsResponse {
3208
+ /**
3209
+ * List of arranged items.
3210
+ * @maxSize 100
3211
+ */
3212
+ items?: ItemReference[];
3213
+ }
3214
+ interface GetArrangedItemsRequest {
3215
+ /**
3216
+ * Category ID.
3217
+ * @format GUID
3218
+ */
3219
+ categoryId: string;
3220
+ /** Category tree reference details. */
3221
+ treeReference: TreeReference;
3222
+ }
3223
+ interface GetArrangedItemsResponse {
3224
+ /**
3225
+ * List of arranged items.
3226
+ * @maxSize 100
3227
+ */
3228
+ items?: ItemReference[];
3229
+ }
3230
+ interface GetCategoriesTreeRequest {
3231
+ /** Category tree reference details. */
3232
+ treeReference?: TreeReference;
3233
+ }
3234
+ interface GetCategoriesTreeResponse {
3235
+ /** Categories tree. */
3236
+ categoriesTree?: CategoryTreeNode[];
3237
+ }
3238
+ /** Represents a node in the view of categories tree */
3239
+ interface CategoryTreeNode {
3240
+ /** Category ID. */
3241
+ _id?: Uint8Array;
3242
+ /**
3243
+ * List of subcategories.
3244
+ * @maxSize 1000
3245
+ */
3246
+ subcategories?: CategoryTreeNode[];
3247
+ }
3248
+ interface DomainEvent extends DomainEventBodyOneOf {
3249
+ createdEvent?: EntityCreatedEvent;
3250
+ updatedEvent?: EntityUpdatedEvent;
3251
+ deletedEvent?: EntityDeletedEvent;
3252
+ actionEvent?: ActionEvent;
3253
+ /**
3254
+ * Unique event ID.
3255
+ * Allows clients to ignore duplicate webhooks.
3256
+ */
3257
+ _id?: string;
3258
+ /**
3259
+ * Assumes actions are also always typed to an entity_type
3260
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
3261
+ */
3262
+ entityFqdn?: string;
3263
+ /**
3264
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
3265
+ * This is although the created/updated/deleted notion is duplication of the oneof types
3266
+ * Example: created/updated/deleted/started/completed/email_opened
3267
+ */
3268
+ slug?: string;
3269
+ /** ID of the entity associated with the event. */
3270
+ entityId?: string;
3271
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
3272
+ eventTime?: Date | null;
3273
+ /**
3274
+ * Whether the event was triggered as a result of a privacy regulation application
3275
+ * (for example, GDPR).
3276
+ */
3277
+ triggeredByAnonymizeRequest?: boolean | null;
3278
+ /** If present, indicates the action that triggered the event. */
3279
+ originatedFrom?: string | null;
3280
+ /**
3281
+ * A sequence number defining the order of updates to the underlying entity.
3282
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
3283
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
3284
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
3285
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
3286
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
3287
+ */
3288
+ entityEventSequence?: string | null;
3289
+ }
3290
+ /** @oneof */
3291
+ interface DomainEventBodyOneOf {
3292
+ createdEvent?: EntityCreatedEvent;
3293
+ updatedEvent?: EntityUpdatedEvent;
3294
+ deletedEvent?: EntityDeletedEvent;
3295
+ actionEvent?: ActionEvent;
3296
+ }
3297
+ interface EntityCreatedEvent {
3298
+ entity?: string;
3299
+ }
3300
+ interface RestoreInfo {
3301
+ deletedDate?: Date | null;
3302
+ }
3303
+ interface EntityUpdatedEvent {
3304
+ /**
3305
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3306
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3307
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3308
+ */
3309
+ currentEntity?: string;
3310
+ }
3311
+ interface EntityDeletedEvent {
3312
+ /** Entity that was deleted */
3313
+ deletedEntity?: string | null;
3314
+ }
3315
+ interface ActionEvent {
3316
+ body?: string;
3317
+ }
3318
+ interface Empty {
3319
+ }
3320
+ interface MessageEnvelope {
3321
+ /**
3322
+ * App instance ID.
3323
+ * @format GUID
3324
+ */
3325
+ instanceId?: string | null;
3326
+ /**
3327
+ * Event type.
3328
+ * @maxLength 150
3329
+ */
3330
+ eventType?: string;
3331
+ /** The identification type and identity data. */
3332
+ identity?: IdentificationData;
3333
+ /** Stringify payload. */
3334
+ data?: string;
3335
+ }
3336
+ interface IdentificationData extends IdentificationDataIdOneOf {
3337
+ /**
3338
+ * ID of a site visitor that has not logged in to the site.
3339
+ * @format GUID
3340
+ */
3341
+ anonymousVisitorId?: string;
3342
+ /**
3343
+ * ID of a site visitor that has logged in to the site.
3344
+ * @format GUID
3345
+ */
3346
+ memberId?: string;
3347
+ /**
3348
+ * ID of a Wix user (site owner, contributor, etc.).
3349
+ * @format GUID
3350
+ */
3351
+ wixUserId?: string;
3352
+ /**
3353
+ * ID of an app.
3354
+ * @format GUID
3355
+ */
3356
+ appId?: string;
3357
+ /** @readonly */
3358
+ identityType?: WebhookIdentityType;
3359
+ }
3360
+ /** @oneof */
3361
+ interface IdentificationDataIdOneOf {
3362
+ /**
3363
+ * ID of a site visitor that has not logged in to the site.
3364
+ * @format GUID
3365
+ */
3366
+ anonymousVisitorId?: string;
3367
+ /**
3368
+ * ID of a site visitor that has logged in to the site.
3369
+ * @format GUID
3370
+ */
3371
+ memberId?: string;
3372
+ /**
3373
+ * ID of a Wix user (site owner, contributor, etc.).
3374
+ * @format GUID
3375
+ */
3376
+ wixUserId?: string;
3377
+ /**
3378
+ * ID of an app.
3379
+ * @format GUID
3380
+ */
3381
+ appId?: string;
3382
+ }
3383
+ declare enum WebhookIdentityType {
3384
+ UNKNOWN = "UNKNOWN",
3385
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3386
+ MEMBER = "MEMBER",
3387
+ WIX_USER = "WIX_USER",
3388
+ APP = "APP"
3389
+ }
3390
+ interface BaseEventMetadata {
3391
+ /**
3392
+ * App instance ID.
3393
+ * @format GUID
3394
+ */
3395
+ instanceId?: string | null;
3396
+ /**
3397
+ * Event type.
3398
+ * @maxLength 150
3399
+ */
3400
+ eventType?: string;
3401
+ /** The identification type and identity data. */
3402
+ identity?: IdentificationData;
3403
+ }
3404
+ interface EventMetadata extends BaseEventMetadata {
3405
+ /**
3406
+ * Unique event ID.
3407
+ * Allows clients to ignore duplicate webhooks.
3408
+ */
3409
+ _id?: string;
3410
+ /**
3411
+ * Assumes actions are also always typed to an entity_type
3412
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
3413
+ */
3414
+ entityFqdn?: string;
3415
+ /**
3416
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
3417
+ * This is although the created/updated/deleted notion is duplication of the oneof types
3418
+ * Example: created/updated/deleted/started/completed/email_opened
3419
+ */
3420
+ slug?: string;
3421
+ /** ID of the entity associated with the event. */
3422
+ entityId?: string;
3423
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
3424
+ eventTime?: Date | null;
3425
+ /**
3426
+ * Whether the event was triggered as a result of a privacy regulation application
3427
+ * (for example, GDPR).
3428
+ */
3429
+ triggeredByAnonymizeRequest?: boolean | null;
3430
+ /** If present, indicates the action that triggered the event. */
3431
+ originatedFrom?: string | null;
3432
+ /**
3433
+ * A sequence number defining the order of updates to the underlying entity.
3434
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
3435
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
3436
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
3437
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
3438
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
3439
+ */
3440
+ entityEventSequence?: string | null;
3441
+ }
3442
+ interface CategoryMovedEnvelope {
3443
+ data: CategoryMoved;
3444
+ metadata: EventMetadata;
3445
+ }
3446
+ interface CategoryCreatedEnvelope {
3447
+ entity: Category;
3448
+ metadata: EventMetadata;
3449
+ }
3450
+ interface CategoryDeletedEnvelope {
3451
+ metadata: EventMetadata;
3452
+ }
3453
+ interface CategoryItemAddedToCategoryEnvelope {
3454
+ data: ItemAddedToCategory;
3455
+ metadata: EventMetadata;
3456
+ }
3457
+ interface CategoryItemRemovedFromCategoryEnvelope {
3458
+ data: ItemRemovedFromCategory;
3459
+ metadata: EventMetadata;
3460
+ }
3461
+ interface CategoryItemsArrangedInCategoryEnvelope {
3462
+ data: ItemsArrangedInCategory;
3463
+ metadata: EventMetadata;
3464
+ }
3465
+ interface CategoryUpdatedEnvelope {
3466
+ entity: Category;
3467
+ metadata: EventMetadata;
3468
+ }
3469
+ interface CreateCategoryOptions {
3470
+ /** Category tree reference details. */
3471
+ treeReference: TreeReference;
3472
+ /**
3473
+ * Fields to include in the response.
3474
+ * @maxSize 100
3475
+ */
3476
+ fields?: SingleEntityOpsRequestedFields[];
3477
+ }
3478
+ interface GetCategoryOptions {
3479
+ /**
3480
+ * Fields to include in the response.
3481
+ * @maxSize 100
3482
+ */
3483
+ fields?: SingleEntityOpsRequestedFields[];
3484
+ }
3485
+ interface UpdateCategory {
3486
+ /**
3487
+ * Category ID.
3488
+ * @format GUID
3489
+ * @immutable
3490
+ */
3491
+ _id?: string | null;
3492
+ /**
3493
+ * Revision number, which increments by 1 each time the category is updated.
3494
+ * To prevent conflicting changes, the current revision must be passed when updating.
3495
+ *
3496
+ * Ignored when creating a category.
3497
+ * @readonly
3498
+ */
3499
+ revision?: string | null;
3500
+ /**
3501
+ * Date and time the category was created.
3502
+ * @readonly
3503
+ */
3504
+ _createdDate?: Date | null;
3505
+ /**
3506
+ * Date and time the category was updated.
3507
+ * @readonly
3508
+ */
3509
+ _updatedDate?: Date | null;
3510
+ /**
3511
+ * Category name.
3512
+ * @minLength 1
3513
+ * @maxLength 80
3514
+ */
3515
+ name?: string | null;
3516
+ /**
3517
+ * Category image.
3518
+ *
3519
+ * + Pass WixMedia image ID for media previously saved in the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager).
3520
+ * + Pass full image URL to upload to Wix Media Manager.
3521
+ */
3522
+ image?: string;
3523
+ /**
3524
+ * Number of items in this category.
3525
+ * @readonly
3526
+ */
3527
+ itemCounter?: number;
3528
+ /**
3529
+ * Category description.
3530
+ * > **Note:** This field is returned only when you pass `fields: "DESCRIPTION"` in the request.
3531
+ * @minLength 1
3532
+ * @maxLength 600
3533
+ */
3534
+ description?: string | null;
3535
+ /**
3536
+ * Whether the category is visible to site visitors in dynamic pages.
3537
+ *
3538
+ * + If the parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
3539
+ * + Passing `true` will fail if the visibility of any parent categories is `false`.
3540
+ * + Default: `false`.
3541
+ * @immutable
3542
+ */
3543
+ visible?: boolean | null;
3544
+ /**
3545
+ * Category breadcrumbs.
3546
+ *
3547
+ * > **Note:** Returned only when you pass `"BREADCRUMBS_INFO"` to the `fields` array in Categories API requests.
3548
+ * @readonly
3549
+ */
3550
+ breadcrumbsInfo?: BreadcrumbsInfo;
3551
+ /**
3552
+ * Parent category reference data.
3553
+ * @immutable
3554
+ */
3555
+ parentCategory?: ParentCategory;
3556
+ /**
3557
+ * Category slug.
3558
+ *
3559
+ * If not provided, the slug is autogenerated based on the category name.
3560
+ * @format URL_SLUG
3561
+ */
3562
+ slug?: string | null;
3563
+ /**
3564
+ * Category description using rich content.
3565
+ * > **Note:** Returned only when you pass `"RICH_CONTENT_DESCRIPTION"` to the `fields` array in Categories API requests.
3566
+ *
3567
+ * <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="indent.emoji.divider.codeBlock.file.gallery.giphy.image.table.link.textHighlight.textColor" exampleid="7dc9240e-d548-417a-abcf-0291b68b4303">
3568
+ * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
3569
+ * </widget>
3570
+ */
3571
+ richContentDescription?: RichContent;
3572
+ /**
3573
+ * ID of the app responsible for managing the items in this category.
3574
+ *
3575
+ * Pass your app ID to restrict updating and deleting items in this category to your app only.
3576
+ * @format GUID
3577
+ * @immutable
3578
+ */
3579
+ managingAppId?: string | null;
3580
+ /**
3581
+ * Custom extended fields for the category object.
3582
+ *
3583
+ * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.
3584
+ */
3585
+ extendedFields?: ExtendedFields;
3586
+ }
3587
+ interface UpdateCategoryOptions {
3588
+ /** Category tree reference details. */
3589
+ treeReference: TreeReference;
3590
+ /**
3591
+ * Fields to include in the response.
3592
+ * @maxSize 100
3593
+ */
3594
+ fields?: SingleEntityOpsRequestedFields[];
3595
+ }
3596
+ interface QueryCategoriesOptions {
3597
+ /** Category tree reference details. */
3598
+ treeReference: TreeReference;
3599
+ /**
3600
+ * Whether to return non-visible categories.
3601
+ *
3602
+ * Default: `false` (only visible categories are returned)
3603
+ */
3604
+ returnNonVisibleCategories?: boolean | undefined;
3605
+ /**
3606
+ * Fields to include in the response.
3607
+ * @maxSize 100
3608
+ */
3609
+ fields?: RequestedFields[] | undefined;
3610
+ }
3611
+ interface QueryCursorResult {
3612
+ cursors: Cursors;
3613
+ hasNext: () => boolean;
3614
+ hasPrev: () => boolean;
3615
+ length: number;
3616
+ pageSize: number;
3617
+ }
3618
+ interface CategoriesQueryResult extends QueryCursorResult {
3619
+ items: Category[];
3620
+ query: CategoriesQueryBuilder;
3621
+ next: () => Promise<CategoriesQueryResult>;
3622
+ prev: () => Promise<CategoriesQueryResult>;
3623
+ }
3624
+ interface CategoriesQueryBuilder {
3625
+ /** @param propertyName - Property whose value is compared with `value`.
3626
+ * @param value - Value to compare against.
3627
+ * @documentationMaturity preview
3628
+ */
3629
+ eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
3630
+ /** @param propertyName - Property whose value is compared with `value`.
3631
+ * @param value - Value to compare against.
3632
+ * @documentationMaturity preview
3633
+ */
3634
+ ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
3635
+ /** @param propertyName - Property whose value is compared with `value`.
3636
+ * @param value - Value to compare against.
3637
+ * @documentationMaturity preview
3638
+ */
3639
+ ge: (propertyName: '_createdDate' | '_updatedDate' | 'parentCategory.index', value: any) => CategoriesQueryBuilder;
3640
+ /** @param propertyName - Property whose value is compared with `value`.
3641
+ * @param value - Value to compare against.
3642
+ * @documentationMaturity preview
3643
+ */
3644
+ gt: (propertyName: '_createdDate' | '_updatedDate' | 'parentCategory.index', value: any) => CategoriesQueryBuilder;
3645
+ /** @param propertyName - Property whose value is compared with `value`.
3646
+ * @param value - Value to compare against.
3647
+ * @documentationMaturity preview
3648
+ */
3649
+ le: (propertyName: '_createdDate' | '_updatedDate' | 'parentCategory.index', value: any) => CategoriesQueryBuilder;
3650
+ /** @param propertyName - Property whose value is compared with `value`.
3651
+ * @param value - Value to compare against.
3652
+ * @documentationMaturity preview
3653
+ */
3654
+ lt: (propertyName: '_createdDate' | '_updatedDate' | 'parentCategory.index', value: any) => CategoriesQueryBuilder;
3655
+ /** @param propertyName - Property whose value is compared with `string`.
3656
+ * @param string - String to compare against. Case-insensitive.
3657
+ * @documentationMaturity preview
3658
+ */
3659
+ startsWith: (propertyName: '_id' | 'name' | 'description' | 'parentCategory.id' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: string) => CategoriesQueryBuilder;
3660
+ /** @param propertyName - Property whose value is compared with `values`.
3661
+ * @param values - List of values to compare against.
3662
+ * @documentationMaturity preview
3663
+ */
3664
+ hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any[]) => CategoriesQueryBuilder;
3665
+ /** @documentationMaturity preview */
3666
+ in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: any) => CategoriesQueryBuilder;
3667
+ /** @documentationMaturity preview */
3668
+ exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'treeReference.appNamespace' | 'treeReference.treeKey' | 'managingAppId', value: boolean) => CategoriesQueryBuilder;
3669
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
3670
+ * @documentationMaturity preview
3671
+ */
3672
+ ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'name' | 'parentCategory.id' | 'parentCategory.index' | 'managingAppId'>) => CategoriesQueryBuilder;
3673
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
3674
+ * @documentationMaturity preview
3675
+ */
3676
+ descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'name' | 'parentCategory.id' | 'parentCategory.index' | 'managingAppId'>) => CategoriesQueryBuilder;
3677
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
3678
+ * @documentationMaturity preview
3679
+ */
3680
+ limit: (limit: number) => CategoriesQueryBuilder;
3681
+ /** @param cursor - A pointer to specific record
3682
+ * @documentationMaturity preview
3683
+ */
3684
+ skipTo: (cursor: string) => CategoriesQueryBuilder;
3685
+ /** @documentationMaturity preview */
3686
+ find: () => Promise<CategoriesQueryResult>;
3687
+ }
3688
+ interface SearchCategoriesOptions {
3689
+ /** Search options. */
3690
+ search?: CursorSearch;
3691
+ /**
3692
+ * Category tree reference details.
3693
+ * > **Note:** Pass `treeReference` only in the first request. Pass the cursor token in subsequent requests.
3694
+ */
3695
+ treeReference: TreeReference;
3696
+ /**
3697
+ * Whether to return the categories with `visible: false`.
3698
+ *
3699
+ * Default: `false` - only visible categories are returned in the response
3700
+ */
3701
+ returnNonVisibleCategories?: boolean;
3702
+ /**
3703
+ * Fields to include in the response.
3704
+ * @maxSize 100
3705
+ */
3706
+ fields?: RequestedFields[];
3707
+ }
3708
+ interface CountCategoriesOptions {
3709
+ /**
3710
+ * Filter object.
3711
+ *
3712
+ * Learn more about the [filter object structure](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
3713
+ */
3714
+ filter?: Record<string, any> | null;
3715
+ /** Search options. */
3716
+ search?: SearchDetails;
3717
+ /** Category tree reference details. */
3718
+ treeReference: TreeReference;
3719
+ /**
3720
+ * Whether to return categories with `visible: false` (hidden categories).
3721
+ *
3722
+ * Default: `false` - only visible categories are returned in the response
3723
+ */
3724
+ returnNonVisibleCategories?: boolean;
3725
+ }
3726
+ interface MoveCategoryOptions {
3727
+ /**
3728
+ * Parent category ID.
3729
+ *
3730
+ * Default: root category ID
3731
+ * @format GUID
3732
+ */
3733
+ parentCategoryId?: string | null;
3734
+ /**
3735
+ * Where to place the subcategory.
3736
+ *
3737
+ * + `FIRST`: Position the category as the first subcategory.
3738
+ * + `LAST`: Position the category as the last subcategory.
3739
+ * + `AFTER`: Position the category after the category ID passed in `moveAfterCategoryId`.
3740
+ */
3741
+ position: Position;
3742
+ /**
3743
+ * Required when passing `position: AFTER`.
3744
+ * @format GUID
3745
+ */
3746
+ moveAfterCategoryId?: string | null;
3747
+ }
3748
+ interface BulkUpdateCategoriesOptions {
3749
+ /** Category tree reference details. */
3750
+ treeReference: TreeReference;
3751
+ /**
3752
+ * Whether to return the full category entity in the response.
3753
+ *
3754
+ * Default: `false`
3755
+ */
3756
+ returnEntity?: boolean;
3757
+ /**
3758
+ * Fields to include in the response.
3759
+ * @maxSize 100
3760
+ */
3761
+ fields?: RequestedFields[];
3762
+ }
3763
+ interface UpdateCategoryVisibilityOptions {
3764
+ /**
3765
+ * Whether the category is visible to site visitors in dynamic pages.
3766
+ *
3767
+ * + If a parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
3768
+ * + Passing `true` will fail if the visibility of any parent categories is `false`.
3769
+ */
3770
+ visible: boolean;
3771
+ /** Category tree reference details. */
3772
+ treeReference: TreeReference;
3773
+ /**
3774
+ * Latest revision of the category.
3775
+ * To prevent conflicting changes, the current revision must be passed on update.
3776
+ */
3777
+ revision: string | null;
3778
+ /**
3779
+ * Fields to include in the response.
3780
+ * @maxSize 100
3781
+ */
3782
+ fields?: SingleEntityOpsRequestedFields[];
3783
+ }
3784
+ interface BulkShowCategoriesOptions {
3785
+ /** Category tree reference details. */
3786
+ treeReference: TreeReference;
3787
+ /**
3788
+ * Whether to return the category entity in the response.
3789
+ *
3790
+ * Default: `false`
3791
+ */
3792
+ returnEntity?: boolean;
3793
+ /**
3794
+ * Fields to include in the response.
3795
+ * @maxSize 100
3796
+ */
3797
+ fields?: RequestedFields[];
3798
+ }
3799
+ interface BulkAddItemsToCategoryOptions {
3800
+ /** Category tree reference details. */
3801
+ treeReference: TreeReference;
3802
+ }
3803
+ interface BulkAddItemToCategoriesOptions {
3804
+ /**
3805
+ * IDs of categories to which to add the item.
3806
+ * @format GUID
3807
+ * @minSize 1
3808
+ * @maxSize 100
3809
+ */
3810
+ categoryIds: string[];
3811
+ /** Category tree reference details. */
3812
+ treeReference: TreeReference;
3813
+ }
3814
+ interface BulkRemoveItemsFromCategoryOptions {
3815
+ /** Category tree reference details. */
3816
+ treeReference: TreeReference;
3817
+ }
3818
+ interface BulkRemoveItemFromCategoriesOptions {
3819
+ /**
3820
+ * IDs of categories from which to remove the item.
3821
+ * @format GUID
3822
+ * @minSize 1
3823
+ * @maxSize 100
3824
+ */
3825
+ categoryIds: string[];
3826
+ /** Category tree reference details. */
3827
+ treeReference: TreeReference;
3828
+ }
3829
+ interface ListItemsInCategoryOptions extends ListItemsInCategoryOptionsPagingMethodOneOf {
3830
+ /**
3831
+ * Whether to use category arrangement for sorting items.
3832
+ *
3833
+ * Default: `false`
3834
+ */
3835
+ useCategoryArrangement?: boolean;
3836
+ /**
3837
+ * Whether to include items from subcategories.
3838
+ *
3839
+ * Default: `false` (only direct items of the category will be returned)
3840
+ */
3841
+ includeItemsFromSubcategories?: boolean;
3842
+ /**
3843
+ * Cursor paging options.
3844
+ *
3845
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
3846
+ */
3847
+ cursorPaging?: CursorPaging;
3848
+ }
3849
+ /** @oneof */
3850
+ interface ListItemsInCategoryOptionsPagingMethodOneOf {
3851
+ /**
3852
+ * Cursor paging options.
3853
+ *
3854
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
3855
+ */
3856
+ cursorPaging?: CursorPaging;
3857
+ }
3858
+ interface ListCategoriesForItemOptions {
3859
+ /** Category tree reference details. */
3860
+ treeReference: TreeReference;
3861
+ }
3862
+ interface ListCategoriesForItemsOptions {
3863
+ /** Category tree reference details. */
3864
+ treeReference: TreeReference;
3865
+ }
3866
+ interface SetArrangedItemsOptions {
3867
+ /**
3868
+ * List of items to set.
3869
+ * @maxSize 100
3870
+ */
3871
+ items?: ItemReference[];
3872
+ }
3873
+
3874
+ export { ThumbnailsAlignment as $, type ListTreesResponse as A, type BulkUpdateCategoriesOptions as B, type Category as C, type SetArrangedItemsOptions as D, type SetArrangedItemsResponse as E, type GetArrangedItemsResponse as F, type GetCategoryOptions as G, Type as H, type ItemReference as I, Target as J, TextAlignment as K, type ListItemsInCategoryOptions as L, type MoveCategoryOptions as M, NodeType as N, LineStyle as O, PluginContainerDataAlignment as P, type QueryCategoriesOptions as Q, Width as R, type SearchCategoriesOptions as S, type TreeReference as T, type UpdateCategory as U, Alignment as V, WidthType as W, ViewMode as X, LayoutType as Y, Orientation as Z, Crop as _, type CreateCategoryOptions as a, type Video as a$, GIFType as a0, Source as a1, StylesPosition as a2, MapType as a3, ViewRole as a4, VoteRole as a5, PollLayoutType as a6, PollLayoutDirection as a7, BackgroundType as a8, DecorationType as a9, type Settings as aA, type RichContent as aB, type Node as aC, type NodeDataOneOf as aD, type NodeStyle as aE, type ButtonData as aF, type Border as aG, type Colors as aH, type PluginContainerData as aI, type PluginContainerDataWidth as aJ, type PluginContainerDataWidthDataOneOf as aK, type Spoiler as aL, type Height as aM, type Styles as aN, type Link as aO, type LinkDataOneOf as aP, type Rel as aQ, type CodeBlockData as aR, type TextStyle as aS, type DividerData as aT, type FileData as aU, type FileSource as aV, type FileSourceDataOneOf as aW, type PDFSettings as aX, type GalleryData as aY, type Media as aZ, type Image as a_, FontType as aa, AppType as ab, InitialExpandedItems as ac, Direction as ad, VerticalAlignment as ae, NullValue as af, SingleEntityOpsRequestedFields as ag, SortOrder as ah, RequestedFields as ai, SortType as aj, SortDirection as ak, MissingValues as al, ScalarType as am, NestedAggregationType as an, Interval as ao, AggregationType as ap, Mode as aq, Position as ar, MoveItemInCategoryRequestPosition as as, WebhookIdentityType as at, type BreadcrumbsInfo as au, type Breadcrumb as av, type ParentCategory as aw, type SeoSchema as ax, type Keyword as ay, type Tag as az, type UpdateCategoryOptions as b, type Metadata as b$, type Item as b0, type ItemDataOneOf as b1, type GalleryOptions as b2, type Layout as b3, type ItemStyle as b4, type Thumbnails as b5, type GIFData as b6, type GIF as b7, type HeadingData as b8, type HTMLData as b9, type AnchorData as bA, type ColorData as bB, type LinkData as bC, type MentionData as bD, type FontSizeData as bE, type SpoilerData as bF, type AppEmbedData as bG, type AppEmbedDataAppDataOneOf as bH, type BookingData as bI, type EventData as bJ, type VideoData as bK, type PlaybackOptions as bL, type EmbedData as bM, type Oembed as bN, type CollapsibleListData as bO, type TableData as bP, type Dimensions as bQ, type TableCellData as bR, type CellStyle as bS, type BorderColors as bT, type ListValue as bU, type AudioData as bV, type OrderedListData as bW, type BulletedListData as bX, type BlockquoteData as bY, type CaptionData as bZ, type LayoutCellData as b_, type HTMLDataDataOneOf as ba, type ImageData as bb, type StylesBorder as bc, type ImageDataStyles as bd, type LinkPreviewData as be, type LinkPreviewDataStyles as bf, type MapData as bg, type MapSettings as bh, type ParagraphData as bi, type PollData as bj, type Permissions as bk, type Option as bl, type PollSettings as bm, type PollLayout as bn, type OptionLayout as bo, type Gradient as bp, type Background as bq, type BackgroundBackgroundOneOf as br, type PollDesign as bs, type OptionDesign as bt, type Poll as bu, type PollDataLayout as bv, type Design as bw, type TextData as bx, type Decoration as by, type DecorationDataOneOf as bz, type CategoriesQueryBuilder as c, type NestedResultValueResultOneOf as c$, type DocumentStyle as c0, type TextNodeStyle as c1, type ExtendedFields as c2, type InvalidateCache as c3, type InvalidateCacheGetByOneOf as c4, type App as c5, type Page as c6, type URI as c7, type File as c8, type CategoryMoved as c9, type CursorSearchPagingMethodOneOf as cA, type Aggregation as cB, type AggregationKindOneOf as cC, type RangeBucket as cD, type IncludeMissingValuesOptions as cE, type ValueAggregation as cF, type ValueAggregationOptionsOneOf as cG, type RangeAggregation as cH, type ScalarAggregation as cI, type DateHistogramAggregation as cJ, type NestedAggregationItem as cK, type NestedAggregationItemKindOneOf as cL, type NestedAggregation as cM, type SearchDetails as cN, type AggregationData as cO, type ValueAggregationResult as cP, type RangeAggregationResult as cQ, type NestedAggregationResults as cR, type NestedAggregationResultsResultOneOf as cS, type ValueResults as cT, type RangeResults as cU, type AggregationResultsScalarResult as cV, type NestedValueAggregationResult as cW, type ValueResult as cX, type RangeResult as cY, type ScalarResult as cZ, type NestedResultValue as c_, type ItemAddedToCategory as ca, type ItemsAddedToCategory as cb, type ItemRemovedFromCategory as cc, type ItemsRemovedFromCategory as cd, type ItemsArrangedInCategory as ce, type CreateCategoryRequest as cf, type CreateCategoryResponse as cg, type GetCategoryRequest as ch, type GetCategoryResponse as ci, type UpdateCategoryRequest as cj, type UpdateCategoryResponse as ck, type DeleteCategoryRequest as cl, type DeleteCategoryResponse as cm, type QueryCategoriesRequest as cn, type CursorQuery as co, type CursorQueryPagingMethodOneOf as cp, type Sorting as cq, type CursorPaging as cr, type QueryCategoriesResponse as cs, type CursorPagingMetadata as ct, type Cursors as cu, type ListCompactCategoriesByIdsRequest as cv, type ListCompactCategoriesByIdsResponse as cw, type CompactCategory as cx, type SearchCategoriesRequest as cy, type CursorSearch as cz, type SearchCategoriesResponse as d, type IdentificationDataIdOneOf as d$, type Results as d0, type DateHistogramResult as d1, type GroupByValueResults as d2, type DateHistogramResults as d3, type NestedResults as d4, type AggregationResults as d5, type AggregationResultsResultOneOf as d6, type DeprecatedSearchCategoriesWithOffsetRequest as d7, type OffsetSearch as d8, type OffsetSearchPagingMethodOneOf as d9, type BulkItemToCategoriesResult as dA, type BulkRemoveItemsFromCategoryRequest as dB, type BulkRemoveItemFromCategoriesRequest as dC, type ListItemsInCategoryRequest as dD, type ListItemsInCategoryRequestPagingMethodOneOf as dE, type PagingMetadataV2 as dF, type ListCategoriesForItemRequest as dG, type ListCategoriesForItemsRequest as dH, type MapItemToCategories as dI, type ListTreesRequest as dJ, type MoveItemInCategoryRequest as dK, type MoveItemInCategoryResponse as dL, type SetArrangedItemsRequest as dM, type GetArrangedItemsRequest as dN, type GetCategoriesTreeRequest as dO, type GetCategoriesTreeResponse as dP, type CategoryTreeNode as dQ, type DomainEvent as dR, type DomainEventBodyOneOf as dS, type EntityCreatedEvent as dT, type RestoreInfo as dU, type EntityUpdatedEvent as dV, type EntityDeletedEvent as dW, type ActionEvent as dX, type Empty as dY, type MessageEnvelope as dZ, type IdentificationData as d_, type Paging as da, type DeprecatedSearchCategoriesWithOffsetResponse as db, type PagingMetadata as dc, type CountCategoriesRequest as dd, type MoveCategoryRequest as de, type BulkCreateCategoriesRequest as df, type BulkCreateCategoriesResponse as dg, type BulkCategoriesResult as dh, type ItemMetadata as di, type ApplicationError as dj, type BulkActionMetadata as dk, type BulkUpdateCategoriesRequest as dl, type UpdateCategoryVisibilityRequest as dm, type BulkShowCategoriesRequest as dn, type BulkUpdateCategoryVisibilityByFilterRequest as dp, type BulkUpdateCategoryVisibilityByFilterResponse as dq, type BulkDeleteCategoriesRequest as dr, type BulkDeleteCategoriesResponse as ds, type BulkDeleteCategoriesResponseBulkCategoriesResult as dt, type BulkDeleteCategoriesByFilterRequest as du, type BulkDeleteCategoriesByFilterResponse as dv, type BulkAddItemsToCategoryRequest as dw, type BulkItemsToCategoryResult as dx, type ItemReferenceMetadata as dy, type BulkAddItemToCategoriesRequest as dz, type CountCategoriesOptions as e, type BaseEventMetadata as e0, type EventMetadata as e1, type CategoryMovedEnvelope as e2, type CategoryCreatedEnvelope as e3, type CategoryDeletedEnvelope as e4, type CategoryItemAddedToCategoryEnvelope as e5, type CategoryItemRemovedFromCategoryEnvelope as e6, type CategoryItemsArrangedInCategoryEnvelope as e7, type CategoryUpdatedEnvelope as e8, type CategoriesQueryResult as e9, type ListItemsInCategoryOptionsPagingMethodOneOf as ea, type CountCategoriesResponse as f, type MoveCategoryResponse as g, type MaskedCategory as h, type BulkUpdateCategoriesResponse as i, type UpdateCategoryVisibilityOptions as j, type UpdateCategoryVisibilityResponse as k, type BulkShowCategoriesOptions as l, type BulkShowCategoriesResponse as m, type BulkAddItemsToCategoryOptions as n, type BulkAddItemsToCategoryResponse as o, type BulkAddItemToCategoriesOptions as p, type BulkAddItemToCategoriesResponse as q, type BulkRemoveItemsFromCategoryOptions as r, type BulkRemoveItemsFromCategoryResponse as s, type BulkRemoveItemFromCategoriesOptions as t, type BulkRemoveItemFromCategoriesResponse as u, type ListItemsInCategoryResponse as v, type ListCategoriesForItemOptions as w, type ListCategoriesForItemResponse as x, type ListCategoriesForItemsOptions as y, type ListCategoriesForItemsResponse as z };