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