@wix/stores 1.0.37 → 1.0.39
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -1
- package/build/cjs/index.js +2 -2
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/src/stores-catalog-v1-product-products.public.d.ts +2 -2
- package/build/cjs/src/stores-catalog-v1-product-products.public.js +37 -3
- package/build/cjs/src/stores-catalog-v1-product-products.public.js.map +1 -1
- package/build/cjs/src/stores-catalog-v1-product-products.types.d.ts +2039 -158
- package/build/cjs/src/stores-catalog-v1-product-products.types.js +349 -18
- package/build/cjs/src/stores-catalog-v1-product-products.types.js.map +1 -1
- package/build/cjs/src/stores-catalog-v1-product-products.universal.d.ts +1996 -121
- package/build/cjs/src/stores-catalog-v1-product-products.universal.js +349 -18
- package/build/cjs/src/stores-catalog-v1-product-products.universal.js.map +1 -1
- package/build/es/index.d.ts +1 -1
- package/build/es/index.js +1 -1
- package/build/es/index.js.map +1 -1
- package/build/es/src/stores-catalog-v1-product-products.public.d.ts +2 -2
- package/build/es/src/stores-catalog-v1-product-products.public.js +1 -1
- package/build/es/src/stores-catalog-v1-product-products.public.js.map +1 -1
- package/build/es/src/stores-catalog-v1-product-products.types.d.ts +2039 -158
- package/build/es/src/stores-catalog-v1-product-products.types.js +348 -17
- package/build/es/src/stores-catalog-v1-product-products.types.js.map +1 -1
- package/build/es/src/stores-catalog-v1-product-products.universal.d.ts +1996 -121
- package/build/es/src/stores-catalog-v1-product-products.universal.js +348 -17
- package/build/es/src/stores-catalog-v1-product-products.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,3 +1,2042 @@
|
|
|
1
|
+
/** Product is the main entity of ProductService that can be used for lorem ipsum dolor */
|
|
2
|
+
export interface V1Product {
|
|
3
|
+
/** Product ID. Auto-generated on product creation. */
|
|
4
|
+
id?: string | null;
|
|
5
|
+
/** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */
|
|
6
|
+
revision?: string | null;
|
|
7
|
+
/**
|
|
8
|
+
* Represents the time this Product was created
|
|
9
|
+
* @readonly
|
|
10
|
+
*/
|
|
11
|
+
createdDate?: Date;
|
|
12
|
+
/**
|
|
13
|
+
* Represents the time this Product was last updated
|
|
14
|
+
* @readonly
|
|
15
|
+
*/
|
|
16
|
+
updatedDate?: Date;
|
|
17
|
+
/** Product name. Translatable. */
|
|
18
|
+
name?: string | null;
|
|
19
|
+
/**
|
|
20
|
+
* , (.wix.api.translatable) = {
|
|
21
|
+
* name: "Name"
|
|
22
|
+
* hidden: true
|
|
23
|
+
* grouping: "Names"
|
|
24
|
+
* type: SHORT_TEXT
|
|
25
|
+
* }];
|
|
26
|
+
* A permanent, friendly URL name.
|
|
27
|
+
* If not provided, on create generated automatically.
|
|
28
|
+
* When provided, validated and must be unique.
|
|
29
|
+
*/
|
|
30
|
+
slug?: string | null;
|
|
31
|
+
/**
|
|
32
|
+
* URL to product page on the site.
|
|
33
|
+
* Missing page url also?
|
|
34
|
+
* @readonly
|
|
35
|
+
*/
|
|
36
|
+
url?: PageUrlV2;
|
|
37
|
+
/** Whether the product is visible to site visitors in Online Stores. Default: `true` */
|
|
38
|
+
visible?: boolean | null;
|
|
39
|
+
/** Media items (images, videos etc) associated with this product. */
|
|
40
|
+
media?: V1Media;
|
|
41
|
+
/** Custom SEO data for the product. */
|
|
42
|
+
seoData?: SeoSchema;
|
|
43
|
+
/**
|
|
44
|
+
* Price per unit settings - base measurement unit and quantity in order to show price per unit data on the product page.
|
|
45
|
+
* This setting is fixed for a product. The specific price per unit value for each variant is set on each variant
|
|
46
|
+
* For example - price per 100 gr. of cheese.
|
|
47
|
+
* Allowed only for `type` PHYSICAL.
|
|
48
|
+
* todo: move to `physical_properties` together with `weight_range`
|
|
49
|
+
*/
|
|
50
|
+
pricePerUnit?: PricePerUnitSettings;
|
|
51
|
+
/** for update, call AddProductOptions, AddProductOptionChoice or DeleteProductOptions endpoints */
|
|
52
|
+
options?: V1ProductOption[];
|
|
53
|
+
/** Optional - Brand. To assign existing brand to product provide `brand.id`, to create new brand omit `brand.id` and provide other brand data. */
|
|
54
|
+
brand?: Brand;
|
|
55
|
+
/** Product info sections. */
|
|
56
|
+
infoSections?: InfoSection[];
|
|
57
|
+
/** Product subscription options. */
|
|
58
|
+
subscriptionOptions?: SubscriptionOptionInfo[];
|
|
59
|
+
/** Product customizations. Replaces `customFields` from v1 API. */
|
|
60
|
+
customizations?: Customization[];
|
|
61
|
+
/**
|
|
62
|
+
* A list of all category IDs that this product is included in. Updated automatically when product added/removed from category or when category deleted.
|
|
63
|
+
* @readonly
|
|
64
|
+
*/
|
|
65
|
+
categoryIds?: string[];
|
|
66
|
+
/**
|
|
67
|
+
* Main category id. If product belongs to more than one category main category defines `breadcrumbs` on product page.
|
|
68
|
+
* By default first category from `category_ids` list. Provided value MUST be in `category_ids`
|
|
69
|
+
* Can be empty only in case if product doesn't belong to any category.
|
|
70
|
+
*/
|
|
71
|
+
mainCategoryId?: string | null;
|
|
72
|
+
/**
|
|
73
|
+
* Breadcrumb, Calculated by the breadcrumbs of the `main_category_id` when it changes.
|
|
74
|
+
* @readonly
|
|
75
|
+
*/
|
|
76
|
+
breadcrumbs?: BreadCrumb[];
|
|
77
|
+
/**
|
|
78
|
+
* Do we want to return formatted and converted prices for range?
|
|
79
|
+
* Formatted in BM. converted & formatted in SF
|
|
80
|
+
* Product price range. The minimum and maximum prices of all the variants.
|
|
81
|
+
* todo: use FixedMonetaryAmount in range
|
|
82
|
+
* @readonly
|
|
83
|
+
*/
|
|
84
|
+
priceRange?: V1NumericPropertyRange;
|
|
85
|
+
/**
|
|
86
|
+
* Product cost range. The minimum and maximum costs of all the variants.
|
|
87
|
+
* todo: use FixedMonetaryAmount in range. Requires admin permissions to read
|
|
88
|
+
* @readonly
|
|
89
|
+
*/
|
|
90
|
+
costRange?: V1NumericPropertyRange;
|
|
91
|
+
/**
|
|
92
|
+
* Product inventory (a materialized view by listening to inventory domain events).
|
|
93
|
+
* @readonly
|
|
94
|
+
*/
|
|
95
|
+
inventory?: ProductInventory;
|
|
96
|
+
/** Product type. Affects which properties product has. Also defines type of variants which allowed to be associated with this product. Product type must be provided on creation and cannot be changed. */
|
|
97
|
+
productType?: V1ProductType;
|
|
98
|
+
/**
|
|
99
|
+
* Product weight range. The minimum and maximum weights of all the variants.
|
|
100
|
+
* this is needed for bulk adjust product properties action, and also exist in the current API.
|
|
101
|
+
* todo: Should this stay here? Should bulk adjust action move to the variant service?
|
|
102
|
+
* todo: should we move it to oneof depending on product type
|
|
103
|
+
* @readonly
|
|
104
|
+
*/
|
|
105
|
+
weightRange?: V1NumericPropertyRange;
|
|
106
|
+
}
|
|
107
|
+
export interface PageUrlV2 {
|
|
108
|
+
/** The path to that page - e.g /product-page/a-product */
|
|
109
|
+
relativePath?: string;
|
|
110
|
+
/** The URL of that page. e.g https://mysite.com/product-page/a-product */
|
|
111
|
+
url?: string | null;
|
|
112
|
+
}
|
|
113
|
+
export interface RichContent {
|
|
114
|
+
/** Node objects representing a rich content document. */
|
|
115
|
+
nodes?: Node[];
|
|
116
|
+
/** Object metadata. */
|
|
117
|
+
metadata?: Metadata;
|
|
118
|
+
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
119
|
+
documentStyle?: DocumentStyle;
|
|
120
|
+
}
|
|
121
|
+
export interface Node extends NodeDataOneOf {
|
|
122
|
+
/** 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. */
|
|
123
|
+
type?: NodeType;
|
|
124
|
+
/** Node ID. */
|
|
125
|
+
id?: string;
|
|
126
|
+
/** A list of child nodes. */
|
|
127
|
+
nodes?: Node[];
|
|
128
|
+
/** Padding and background color styling for the node. */
|
|
129
|
+
style?: NodeStyle;
|
|
130
|
+
/** Data for a button node. */
|
|
131
|
+
buttonData?: ButtonData;
|
|
132
|
+
/** Data for a code block node. */
|
|
133
|
+
codeBlockData?: CodeBlockData;
|
|
134
|
+
/** Data for a divider node. */
|
|
135
|
+
dividerData?: DividerData;
|
|
136
|
+
/** Data for a file node. */
|
|
137
|
+
fileData?: FileData;
|
|
138
|
+
/** Data for a gallery node. */
|
|
139
|
+
galleryData?: GalleryData;
|
|
140
|
+
/** Data for a GIF node. */
|
|
141
|
+
gifData?: GIFData;
|
|
142
|
+
/** Data for a heading node. */
|
|
143
|
+
headingData?: HeadingData;
|
|
144
|
+
/** Data for an embedded HTML node. */
|
|
145
|
+
htmlData?: HTMLData;
|
|
146
|
+
/** Data for an image node. */
|
|
147
|
+
imageData?: ImageData;
|
|
148
|
+
/** Data for a link preview node. */
|
|
149
|
+
linkPreviewData?: LinkPreviewData;
|
|
150
|
+
/** Data for a map node. */
|
|
151
|
+
mapData?: MapData;
|
|
152
|
+
/** Data for a paragraph node. */
|
|
153
|
+
paragraphData?: ParagraphData;
|
|
154
|
+
/** Data for a poll node. */
|
|
155
|
+
pollData?: PollData;
|
|
156
|
+
/** Data for a text node. Used to apply decorations to text. */
|
|
157
|
+
textData?: TextData;
|
|
158
|
+
/** Data for an app embed node. */
|
|
159
|
+
appEmbedData?: AppEmbedData;
|
|
160
|
+
/** Data for a video node. */
|
|
161
|
+
videoData?: VideoData;
|
|
162
|
+
/** Data for an oEmbed node. */
|
|
163
|
+
embedData?: EmbedData;
|
|
164
|
+
/** Data for a collapsible list node. */
|
|
165
|
+
collapsibleListData?: CollapsibleListData;
|
|
166
|
+
/** Data for a table node. */
|
|
167
|
+
tableData?: TableData;
|
|
168
|
+
/** Data for a table cell node. */
|
|
169
|
+
tableCellData?: TableCellData;
|
|
170
|
+
/** Data for a custon external node. */
|
|
171
|
+
externalData?: Record<string, any> | null;
|
|
172
|
+
/** Data for an audio node. */
|
|
173
|
+
audioData?: AudioData;
|
|
174
|
+
/** Data for an ordered list node. */
|
|
175
|
+
orderedListData?: OrderedListData;
|
|
176
|
+
/** Data for a bulleted list node. */
|
|
177
|
+
bulletedListData?: BulletedListData;
|
|
178
|
+
/** Data for a block quote node. */
|
|
179
|
+
blockquoteData?: BlockquoteData;
|
|
180
|
+
}
|
|
181
|
+
/** @oneof */
|
|
182
|
+
export interface NodeDataOneOf {
|
|
183
|
+
/** Data for a button node. */
|
|
184
|
+
buttonData?: ButtonData;
|
|
185
|
+
/** Data for a code block node. */
|
|
186
|
+
codeBlockData?: CodeBlockData;
|
|
187
|
+
/** Data for a divider node. */
|
|
188
|
+
dividerData?: DividerData;
|
|
189
|
+
/** Data for a file node. */
|
|
190
|
+
fileData?: FileData;
|
|
191
|
+
/** Data for a gallery node. */
|
|
192
|
+
galleryData?: GalleryData;
|
|
193
|
+
/** Data for a GIF node. */
|
|
194
|
+
gifData?: GIFData;
|
|
195
|
+
/** Data for a heading node. */
|
|
196
|
+
headingData?: HeadingData;
|
|
197
|
+
/** Data for an embedded HTML node. */
|
|
198
|
+
htmlData?: HTMLData;
|
|
199
|
+
/** Data for an image node. */
|
|
200
|
+
imageData?: ImageData;
|
|
201
|
+
/** Data for a link preview node. */
|
|
202
|
+
linkPreviewData?: LinkPreviewData;
|
|
203
|
+
/** Data for a map node. */
|
|
204
|
+
mapData?: MapData;
|
|
205
|
+
/** Data for a paragraph node. */
|
|
206
|
+
paragraphData?: ParagraphData;
|
|
207
|
+
/** Data for a poll node. */
|
|
208
|
+
pollData?: PollData;
|
|
209
|
+
/** Data for a text node. Used to apply decorations to text. */
|
|
210
|
+
textData?: TextData;
|
|
211
|
+
/** Data for an app embed node. */
|
|
212
|
+
appEmbedData?: AppEmbedData;
|
|
213
|
+
/** Data for a video node. */
|
|
214
|
+
videoData?: VideoData;
|
|
215
|
+
/** Data for an oEmbed node. */
|
|
216
|
+
embedData?: EmbedData;
|
|
217
|
+
/** Data for a collapsible list node. */
|
|
218
|
+
collapsibleListData?: CollapsibleListData;
|
|
219
|
+
/** Data for a table node. */
|
|
220
|
+
tableData?: TableData;
|
|
221
|
+
/** Data for a table cell node. */
|
|
222
|
+
tableCellData?: TableCellData;
|
|
223
|
+
/** Data for a custon external node. */
|
|
224
|
+
externalData?: Record<string, any> | null;
|
|
225
|
+
/** Data for an audio node. */
|
|
226
|
+
audioData?: AudioData;
|
|
227
|
+
/** Data for an ordered list node. */
|
|
228
|
+
orderedListData?: OrderedListData;
|
|
229
|
+
/** Data for a bulleted list node. */
|
|
230
|
+
bulletedListData?: BulletedListData;
|
|
231
|
+
/** Data for a block quote node. */
|
|
232
|
+
blockquoteData?: BlockquoteData;
|
|
233
|
+
}
|
|
234
|
+
export declare enum NodeType {
|
|
235
|
+
PARAGRAPH = "PARAGRAPH",
|
|
236
|
+
TEXT = "TEXT",
|
|
237
|
+
HEADING = "HEADING",
|
|
238
|
+
BULLETED_LIST = "BULLETED_LIST",
|
|
239
|
+
ORDERED_LIST = "ORDERED_LIST",
|
|
240
|
+
LIST_ITEM = "LIST_ITEM",
|
|
241
|
+
BLOCKQUOTE = "BLOCKQUOTE",
|
|
242
|
+
CODE_BLOCK = "CODE_BLOCK",
|
|
243
|
+
VIDEO = "VIDEO",
|
|
244
|
+
DIVIDER = "DIVIDER",
|
|
245
|
+
FILE = "FILE",
|
|
246
|
+
GALLERY = "GALLERY",
|
|
247
|
+
GIF = "GIF",
|
|
248
|
+
HTML = "HTML",
|
|
249
|
+
IMAGE = "IMAGE",
|
|
250
|
+
LINK_PREVIEW = "LINK_PREVIEW",
|
|
251
|
+
MAP = "MAP",
|
|
252
|
+
POLL = "POLL",
|
|
253
|
+
APP_EMBED = "APP_EMBED",
|
|
254
|
+
BUTTON = "BUTTON",
|
|
255
|
+
COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
|
|
256
|
+
TABLE = "TABLE",
|
|
257
|
+
EMBED = "EMBED",
|
|
258
|
+
COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
|
|
259
|
+
COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
|
|
260
|
+
COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
|
|
261
|
+
TABLE_CELL = "TABLE_CELL",
|
|
262
|
+
TABLE_ROW = "TABLE_ROW",
|
|
263
|
+
EXTERNAL = "EXTERNAL",
|
|
264
|
+
AUDIO = "AUDIO"
|
|
265
|
+
}
|
|
266
|
+
export interface NodeStyle {
|
|
267
|
+
/** The top padding value in pixels. */
|
|
268
|
+
paddingTop?: string | null;
|
|
269
|
+
/** The bottom padding value in pixels. */
|
|
270
|
+
paddingBottom?: string | null;
|
|
271
|
+
/** The background color as a hexadecimal value. */
|
|
272
|
+
backgroundColor?: string | null;
|
|
273
|
+
}
|
|
274
|
+
export interface ButtonData {
|
|
275
|
+
/** Styling for the button's container. */
|
|
276
|
+
containerData?: PluginContainerData;
|
|
277
|
+
/** The button type. */
|
|
278
|
+
type?: Type;
|
|
279
|
+
/** Styling for the button. */
|
|
280
|
+
styles?: Styles;
|
|
281
|
+
/** The text to display on the button. */
|
|
282
|
+
text?: string | null;
|
|
283
|
+
/** Button link details. */
|
|
284
|
+
link?: Link;
|
|
285
|
+
}
|
|
286
|
+
export interface Border {
|
|
287
|
+
/** Border width in pixels. */
|
|
288
|
+
width?: number | null;
|
|
289
|
+
/** Border radius in pixels. */
|
|
290
|
+
radius?: number | null;
|
|
291
|
+
}
|
|
292
|
+
export interface Colors {
|
|
293
|
+
/** The text color as a hexadecimal value. */
|
|
294
|
+
text?: string | null;
|
|
295
|
+
/** The border color as a hexadecimal value. */
|
|
296
|
+
border?: string | null;
|
|
297
|
+
/** The background color as a hexadecimal value. */
|
|
298
|
+
background?: string | null;
|
|
299
|
+
}
|
|
300
|
+
export interface PluginContainerData {
|
|
301
|
+
/** The width of the node when it's displayed. */
|
|
302
|
+
width?: PluginContainerDataWidth;
|
|
303
|
+
/** The node's alignment within its container. */
|
|
304
|
+
alignment?: PluginContainerDataAlignment;
|
|
305
|
+
/** Spoiler cover settings for the node. */
|
|
306
|
+
spoiler?: Spoiler;
|
|
307
|
+
/** The height of the node when it's displayed. */
|
|
308
|
+
height?: Height;
|
|
309
|
+
/** 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. */
|
|
310
|
+
textWrap?: boolean | null;
|
|
311
|
+
}
|
|
312
|
+
export declare enum WidthType {
|
|
313
|
+
/** Width matches the content width */
|
|
314
|
+
CONTENT = "CONTENT",
|
|
315
|
+
/** Small Width */
|
|
316
|
+
SMALL = "SMALL",
|
|
317
|
+
/** Width will match the original asset width */
|
|
318
|
+
ORIGINAL = "ORIGINAL",
|
|
319
|
+
/** coast-to-coast display */
|
|
320
|
+
FULL_WIDTH = "FULL_WIDTH"
|
|
321
|
+
}
|
|
322
|
+
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
323
|
+
/**
|
|
324
|
+
* One of the following predefined width options:
|
|
325
|
+
* `CONTENT`: The width of the container matches the content width.
|
|
326
|
+
* `SMALL`: Small width.
|
|
327
|
+
* `ORIGINAL`: The width of the container matches the original asset width.
|
|
328
|
+
* `FULL_WIDTH`: Full width.
|
|
329
|
+
*/
|
|
330
|
+
size?: WidthType;
|
|
331
|
+
/** A custom width value in pixels. */
|
|
332
|
+
custom?: string | null;
|
|
333
|
+
}
|
|
334
|
+
/** @oneof */
|
|
335
|
+
export interface PluginContainerDataWidthDataOneOf {
|
|
336
|
+
/**
|
|
337
|
+
* One of the following predefined width options:
|
|
338
|
+
* `CONTENT`: The width of the container matches the content width.
|
|
339
|
+
* `SMALL`: Small width.
|
|
340
|
+
* `ORIGINAL`: The width of the container matches the original asset width.
|
|
341
|
+
* `FULL_WIDTH`: Full width.
|
|
342
|
+
*/
|
|
343
|
+
size?: WidthType;
|
|
344
|
+
/** A custom width value in pixels. */
|
|
345
|
+
custom?: string | null;
|
|
346
|
+
}
|
|
347
|
+
export declare enum PluginContainerDataAlignment {
|
|
348
|
+
/** Center Alignment */
|
|
349
|
+
CENTER = "CENTER",
|
|
350
|
+
/** Left Alignment */
|
|
351
|
+
LEFT = "LEFT",
|
|
352
|
+
/** Right Alignment */
|
|
353
|
+
RIGHT = "RIGHT"
|
|
354
|
+
}
|
|
355
|
+
export interface Spoiler {
|
|
356
|
+
/** Sets whether the spoiler cover is enabled for this node. */
|
|
357
|
+
enabled?: boolean | null;
|
|
358
|
+
/** The description displayed on top of the spoiler cover. */
|
|
359
|
+
description?: string | null;
|
|
360
|
+
/** The text for the button used to remove the spoiler cover. */
|
|
361
|
+
buttonText?: string | null;
|
|
362
|
+
}
|
|
363
|
+
export interface Height {
|
|
364
|
+
/** A custom height value in pixels. */
|
|
365
|
+
custom?: string | null;
|
|
366
|
+
}
|
|
367
|
+
export declare enum Type {
|
|
368
|
+
/** Regular link button */
|
|
369
|
+
LINK = "LINK",
|
|
370
|
+
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
371
|
+
ACTION = "ACTION"
|
|
372
|
+
}
|
|
373
|
+
export interface Styles {
|
|
374
|
+
/** Border attributes. */
|
|
375
|
+
border?: Border;
|
|
376
|
+
/** Color attributes. */
|
|
377
|
+
colors?: Colors;
|
|
378
|
+
}
|
|
379
|
+
export interface Link extends LinkDataOneOf {
|
|
380
|
+
/**
|
|
381
|
+
* he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
|
|
382
|
+
* `SELF` - Default. Opens the linked document in the same frame as the link.
|
|
383
|
+
* `BLANK` - Opens the linked document in a new browser tab or window.
|
|
384
|
+
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
385
|
+
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
386
|
+
*/
|
|
387
|
+
target?: Target;
|
|
388
|
+
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
389
|
+
rel?: Rel;
|
|
390
|
+
/** A serialized object used for a custom or external link panel. */
|
|
391
|
+
customData?: string | null;
|
|
392
|
+
/** The absolute URL for the linked document. */
|
|
393
|
+
url?: string;
|
|
394
|
+
/** The target node's ID. Used for linking to another node in this object. */
|
|
395
|
+
anchor?: string;
|
|
396
|
+
}
|
|
397
|
+
/** @oneof */
|
|
398
|
+
export interface LinkDataOneOf {
|
|
399
|
+
/** The absolute URL for the linked document. */
|
|
400
|
+
url?: string;
|
|
401
|
+
/** The target node's ID. Used for linking to another node in this object. */
|
|
402
|
+
anchor?: string;
|
|
403
|
+
}
|
|
404
|
+
export declare enum Target {
|
|
405
|
+
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
406
|
+
SELF = "SELF",
|
|
407
|
+
/** Opens the linked document in a new window or tab */
|
|
408
|
+
BLANK = "BLANK",
|
|
409
|
+
/** Opens the linked document in the parent frame */
|
|
410
|
+
PARENT = "PARENT",
|
|
411
|
+
/** Opens the linked document in the full body of the window */
|
|
412
|
+
TOP = "TOP"
|
|
413
|
+
}
|
|
414
|
+
export interface Rel {
|
|
415
|
+
/** Indicates to search engine crawlers not to follow the link. */
|
|
416
|
+
nofollow?: boolean | null;
|
|
417
|
+
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. */
|
|
418
|
+
sponsored?: boolean | null;
|
|
419
|
+
/** 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. */
|
|
420
|
+
ugc?: boolean | null;
|
|
421
|
+
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
422
|
+
noreferrer?: boolean | null;
|
|
423
|
+
}
|
|
424
|
+
export interface CodeBlockData {
|
|
425
|
+
/** Styling for the code block's text. */
|
|
426
|
+
textStyle?: TextStyle;
|
|
427
|
+
}
|
|
428
|
+
export interface TextStyle {
|
|
429
|
+
/** Text alignment. Defaults to `AUTO`. */
|
|
430
|
+
textAlignment?: TextAlignment;
|
|
431
|
+
/** A CSS `line-height` value for the text as a unitless ratio. */
|
|
432
|
+
lineHeight?: string | null;
|
|
433
|
+
}
|
|
434
|
+
export declare enum TextAlignment {
|
|
435
|
+
/** browser default, eqivalent to `initial` */
|
|
436
|
+
AUTO = "AUTO",
|
|
437
|
+
/** Left align */
|
|
438
|
+
LEFT = "LEFT",
|
|
439
|
+
/** Right align */
|
|
440
|
+
RIGHT = "RIGHT",
|
|
441
|
+
/** Center align */
|
|
442
|
+
CENTER = "CENTER",
|
|
443
|
+
/** 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 */
|
|
444
|
+
JUSTIFY = "JUSTIFY"
|
|
445
|
+
}
|
|
446
|
+
export interface DividerData {
|
|
447
|
+
/** Styling for the divider's container. */
|
|
448
|
+
containerData?: PluginContainerData;
|
|
449
|
+
/** Divider line style. */
|
|
450
|
+
lineStyle?: LineStyle;
|
|
451
|
+
/** Divider width. */
|
|
452
|
+
width?: Width;
|
|
453
|
+
/** Divider alignment. */
|
|
454
|
+
alignment?: Alignment;
|
|
455
|
+
}
|
|
456
|
+
export declare enum LineStyle {
|
|
457
|
+
/** Single Line */
|
|
458
|
+
SINGLE = "SINGLE",
|
|
459
|
+
/** Double Line */
|
|
460
|
+
DOUBLE = "DOUBLE",
|
|
461
|
+
/** Dashed Line */
|
|
462
|
+
DASHED = "DASHED",
|
|
463
|
+
/** Dotted Line */
|
|
464
|
+
DOTTED = "DOTTED"
|
|
465
|
+
}
|
|
466
|
+
export declare enum Width {
|
|
467
|
+
/** Large line */
|
|
468
|
+
LARGE = "LARGE",
|
|
469
|
+
/** Medium line */
|
|
470
|
+
MEDIUM = "MEDIUM",
|
|
471
|
+
/** Small line */
|
|
472
|
+
SMALL = "SMALL"
|
|
473
|
+
}
|
|
474
|
+
export declare enum Alignment {
|
|
475
|
+
/** Center alignment */
|
|
476
|
+
CENTER = "CENTER",
|
|
477
|
+
/** Left alignment */
|
|
478
|
+
LEFT = "LEFT",
|
|
479
|
+
/** Right alignment */
|
|
480
|
+
RIGHT = "RIGHT"
|
|
481
|
+
}
|
|
482
|
+
export interface FileData {
|
|
483
|
+
/** Styling for the file's container. */
|
|
484
|
+
containerData?: PluginContainerData;
|
|
485
|
+
/** The source for the file's data. */
|
|
486
|
+
src?: FileSource;
|
|
487
|
+
/** File name. */
|
|
488
|
+
name?: string | null;
|
|
489
|
+
/** File type. */
|
|
490
|
+
type?: string | null;
|
|
491
|
+
/** File size in KB. */
|
|
492
|
+
size?: number | null;
|
|
493
|
+
/** Settings for PDF files. */
|
|
494
|
+
pdfSettings?: PDFSettings;
|
|
495
|
+
/** File MIME type. */
|
|
496
|
+
mimeType?: string | null;
|
|
497
|
+
/** File path. */
|
|
498
|
+
path?: string | null;
|
|
499
|
+
}
|
|
500
|
+
export declare enum ViewMode {
|
|
501
|
+
/** No PDF view */
|
|
502
|
+
NONE = "NONE",
|
|
503
|
+
/** Full PDF view */
|
|
504
|
+
FULL = "FULL",
|
|
505
|
+
/** Mini PDF view */
|
|
506
|
+
MINI = "MINI"
|
|
507
|
+
}
|
|
508
|
+
export interface FileSource extends FileSourceDataOneOf {
|
|
509
|
+
/** Indicates whether the file's source is private. */
|
|
510
|
+
private?: boolean | null;
|
|
511
|
+
/** The absolute URL for the file's source. */
|
|
512
|
+
url?: string | null;
|
|
513
|
+
/** Custom ID. Use `id` instead. */
|
|
514
|
+
custom?: string | null;
|
|
515
|
+
/** An ID that's resolved to a URL by a resolver function. */
|
|
516
|
+
id?: string | null;
|
|
517
|
+
}
|
|
518
|
+
/** @oneof */
|
|
519
|
+
export interface FileSourceDataOneOf {
|
|
520
|
+
/** The absolute URL for the file's source. */
|
|
521
|
+
url?: string | null;
|
|
522
|
+
/** Custom ID. Use `id` instead. */
|
|
523
|
+
custom?: string | null;
|
|
524
|
+
/** An ID that's resolved to a URL by a resolver function. */
|
|
525
|
+
id?: string | null;
|
|
526
|
+
}
|
|
527
|
+
export interface PDFSettings {
|
|
528
|
+
/**
|
|
529
|
+
* PDF view mode. One of the following:
|
|
530
|
+
* `NONE` : The PDF isn't displayed.
|
|
531
|
+
* `FULL` : A full page view of the PDF is displayed.
|
|
532
|
+
* `MINI` : A mini view of the PDF is displayed.
|
|
533
|
+
*/
|
|
534
|
+
viewMode?: ViewMode;
|
|
535
|
+
/** Sets whether the PDF download button is disabled. */
|
|
536
|
+
disableDownload?: boolean | null;
|
|
537
|
+
/** Sets whether the PDF print button is disabled. */
|
|
538
|
+
disablePrint?: boolean | null;
|
|
539
|
+
}
|
|
540
|
+
export interface GalleryData {
|
|
541
|
+
/** Styling for the gallery's container. */
|
|
542
|
+
containerData?: PluginContainerData;
|
|
543
|
+
/** The items in the gallery. */
|
|
544
|
+
items?: Item[];
|
|
545
|
+
/** Options for defining the gallery's appearance. */
|
|
546
|
+
options?: GalleryOptions;
|
|
547
|
+
/** Sets whether the gallery's expand button is disabled. */
|
|
548
|
+
disableExpand?: boolean | null;
|
|
549
|
+
/** Sets whether the gallery's download button is disabled. */
|
|
550
|
+
disableDownload?: boolean | null;
|
|
551
|
+
}
|
|
552
|
+
export interface Rich_contentV1Media {
|
|
553
|
+
/** The source for the media's data. */
|
|
554
|
+
src?: FileSource;
|
|
555
|
+
/** Media width in pixels. */
|
|
556
|
+
width?: number | null;
|
|
557
|
+
/** Media height in pixels. */
|
|
558
|
+
height?: number | null;
|
|
559
|
+
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
560
|
+
duration?: number | null;
|
|
561
|
+
}
|
|
562
|
+
export interface Image {
|
|
563
|
+
/** Image file details. */
|
|
564
|
+
media?: Rich_contentV1Media;
|
|
565
|
+
/** Link details for images that are links. */
|
|
566
|
+
link?: Link;
|
|
567
|
+
}
|
|
568
|
+
export interface Video {
|
|
569
|
+
/** Video file details. */
|
|
570
|
+
media?: Rich_contentV1Media;
|
|
571
|
+
/** Video thumbnail file details. */
|
|
572
|
+
thumbnail?: Rich_contentV1Media;
|
|
573
|
+
}
|
|
574
|
+
export interface Item extends ItemDataOneOf {
|
|
575
|
+
/** Item title. */
|
|
576
|
+
title?: string | null;
|
|
577
|
+
/** Item's alternative text. */
|
|
578
|
+
altText?: string | null;
|
|
579
|
+
/** An image item. */
|
|
580
|
+
image?: Image;
|
|
581
|
+
/** A video item. */
|
|
582
|
+
video?: Video;
|
|
583
|
+
}
|
|
584
|
+
/** @oneof */
|
|
585
|
+
export interface ItemDataOneOf {
|
|
586
|
+
/** An image item. */
|
|
587
|
+
image?: Image;
|
|
588
|
+
/** A video item. */
|
|
589
|
+
video?: Video;
|
|
590
|
+
}
|
|
591
|
+
export interface GalleryOptions {
|
|
592
|
+
/** Gallery layout. */
|
|
593
|
+
layout?: Layout;
|
|
594
|
+
/** Styling for gallery items. */
|
|
595
|
+
item?: ItemStyle;
|
|
596
|
+
/** Styling for gallery thumbnail images. */
|
|
597
|
+
thumbnails?: Thumbnails;
|
|
598
|
+
}
|
|
599
|
+
export declare enum LayoutType {
|
|
600
|
+
/** Collage type */
|
|
601
|
+
COLLAGE = "COLLAGE",
|
|
602
|
+
/** Masonry type */
|
|
603
|
+
MASONRY = "MASONRY",
|
|
604
|
+
/** Grid type */
|
|
605
|
+
GRID = "GRID",
|
|
606
|
+
/** Thumbnail type */
|
|
607
|
+
THUMBNAIL = "THUMBNAIL",
|
|
608
|
+
/** Slider type */
|
|
609
|
+
SLIDER = "SLIDER",
|
|
610
|
+
/** Slideshow type */
|
|
611
|
+
SLIDESHOW = "SLIDESHOW",
|
|
612
|
+
/** Panorama type */
|
|
613
|
+
PANORAMA = "PANORAMA",
|
|
614
|
+
/** Column type */
|
|
615
|
+
COLUMN = "COLUMN",
|
|
616
|
+
/** Magic type */
|
|
617
|
+
MAGIC = "MAGIC",
|
|
618
|
+
/** Fullsize images type */
|
|
619
|
+
FULLSIZE = "FULLSIZE"
|
|
620
|
+
}
|
|
621
|
+
export declare enum Orientation {
|
|
622
|
+
/** Rows Orientation */
|
|
623
|
+
ROWS = "ROWS",
|
|
624
|
+
/** Columns Orientation */
|
|
625
|
+
COLUMNS = "COLUMNS"
|
|
626
|
+
}
|
|
627
|
+
export declare enum Crop {
|
|
628
|
+
/** Crop to fill */
|
|
629
|
+
FILL = "FILL",
|
|
630
|
+
/** Crop to fit */
|
|
631
|
+
FIT = "FIT"
|
|
632
|
+
}
|
|
633
|
+
export declare enum ThumbnailsAlignment {
|
|
634
|
+
/** Top alignment */
|
|
635
|
+
TOP = "TOP",
|
|
636
|
+
/** Right alignment */
|
|
637
|
+
RIGHT = "RIGHT",
|
|
638
|
+
/** Bottom alignment */
|
|
639
|
+
BOTTOM = "BOTTOM",
|
|
640
|
+
/** Left alignment */
|
|
641
|
+
LEFT = "LEFT",
|
|
642
|
+
/** No thumbnail */
|
|
643
|
+
NONE = "NONE"
|
|
644
|
+
}
|
|
645
|
+
export interface Layout {
|
|
646
|
+
/** Gallery layout type. */
|
|
647
|
+
type?: LayoutType;
|
|
648
|
+
/** Sets whether horizontal scroll is enabled. */
|
|
649
|
+
horizontalScroll?: boolean | null;
|
|
650
|
+
/** Gallery orientation. */
|
|
651
|
+
orientation?: Orientation;
|
|
652
|
+
/** The number of columns to display on full size screens. */
|
|
653
|
+
numberOfColumns?: number | null;
|
|
654
|
+
/** The number of columns to display on mobile screens. */
|
|
655
|
+
mobileNumberOfColumns?: number | null;
|
|
656
|
+
}
|
|
657
|
+
export interface ItemStyle {
|
|
658
|
+
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
659
|
+
targetSize?: number | null;
|
|
660
|
+
/** Item ratio */
|
|
661
|
+
ratio?: number | null;
|
|
662
|
+
/** Sets how item images are cropped. */
|
|
663
|
+
crop?: Crop;
|
|
664
|
+
/** The spacing between items in pixels. */
|
|
665
|
+
spacing?: number | null;
|
|
666
|
+
}
|
|
667
|
+
export interface Thumbnails {
|
|
668
|
+
/** Thumbnail alignment. */
|
|
669
|
+
placement?: ThumbnailsAlignment;
|
|
670
|
+
/** Spacing between thumbnails in pixels. */
|
|
671
|
+
spacing?: number | null;
|
|
672
|
+
}
|
|
673
|
+
export interface GIFData {
|
|
674
|
+
/** Styling for the GIF's container. */
|
|
675
|
+
containerData?: PluginContainerData;
|
|
676
|
+
/** The source of the full size GIF. */
|
|
677
|
+
original?: GIF;
|
|
678
|
+
/** The source of the downsized GIF. */
|
|
679
|
+
downsized?: GIF;
|
|
680
|
+
/** Height in pixels. */
|
|
681
|
+
height?: number;
|
|
682
|
+
/** Width in pixels. */
|
|
683
|
+
width?: number;
|
|
684
|
+
}
|
|
685
|
+
export interface GIF {
|
|
686
|
+
/** GIF format URL. */
|
|
687
|
+
gif?: string | null;
|
|
688
|
+
/** MP4 format URL. */
|
|
689
|
+
mp4?: string | null;
|
|
690
|
+
/** Thumbnail URL. */
|
|
691
|
+
still?: string | null;
|
|
692
|
+
}
|
|
693
|
+
export interface HeadingData {
|
|
694
|
+
/** Heading level from 1-6. */
|
|
695
|
+
level?: number;
|
|
696
|
+
/** Styling for the heading text. */
|
|
697
|
+
textStyle?: TextStyle;
|
|
698
|
+
/** Indentation level from 1-6. */
|
|
699
|
+
indentation?: number | null;
|
|
700
|
+
}
|
|
701
|
+
export interface HTMLData extends HTMLDataDataOneOf {
|
|
702
|
+
/** Styling for the HTML node's container. */
|
|
703
|
+
containerData?: PluginContainerData;
|
|
704
|
+
/** The type of HTML code. */
|
|
705
|
+
source?: Source;
|
|
706
|
+
/** The URL for the HTML code for the node. */
|
|
707
|
+
url?: string;
|
|
708
|
+
/** The HTML code for the node. */
|
|
709
|
+
html?: string;
|
|
710
|
+
/** Whether this is an AdSense element. Use `source` instead. */
|
|
711
|
+
isAdsense?: boolean | null;
|
|
712
|
+
}
|
|
713
|
+
/** @oneof */
|
|
714
|
+
export interface HTMLDataDataOneOf {
|
|
715
|
+
/** The URL for the HTML code for the node. */
|
|
716
|
+
url?: string;
|
|
717
|
+
/** The HTML code for the node. */
|
|
718
|
+
html?: string;
|
|
719
|
+
/** Whether this is an AdSense element. Use `source` instead. */
|
|
720
|
+
isAdsense?: boolean | null;
|
|
721
|
+
}
|
|
722
|
+
export declare enum Source {
|
|
723
|
+
HTML = "HTML",
|
|
724
|
+
ADSENSE = "ADSENSE"
|
|
725
|
+
}
|
|
726
|
+
export interface ImageData {
|
|
727
|
+
/** Styling for the image's container. */
|
|
728
|
+
containerData?: PluginContainerData;
|
|
729
|
+
/** Image file details. */
|
|
730
|
+
image?: Rich_contentV1Media;
|
|
731
|
+
/** Link details for images that are links. */
|
|
732
|
+
link?: Link;
|
|
733
|
+
/** Sets whether the image expands to full screen when clicked. */
|
|
734
|
+
disableExpand?: boolean | null;
|
|
735
|
+
/** Image's alternative text. */
|
|
736
|
+
altText?: string | null;
|
|
737
|
+
/** Image caption. */
|
|
738
|
+
caption?: string | null;
|
|
739
|
+
/** Sets whether the image's download button is disabled. */
|
|
740
|
+
disableDownload?: boolean | null;
|
|
741
|
+
}
|
|
742
|
+
export interface LinkPreviewData {
|
|
743
|
+
/** Styling for the link preview's container. */
|
|
744
|
+
containerData?: PluginContainerData;
|
|
745
|
+
/** Link details. */
|
|
746
|
+
link?: Link;
|
|
747
|
+
/** Preview title. */
|
|
748
|
+
title?: string | null;
|
|
749
|
+
/** Preview thumbnail URL. */
|
|
750
|
+
thumbnailUrl?: string | null;
|
|
751
|
+
/** Preview description. */
|
|
752
|
+
description?: string | null;
|
|
753
|
+
/** The preview content as HTML. */
|
|
754
|
+
html?: string | null;
|
|
755
|
+
}
|
|
756
|
+
export interface MapData {
|
|
757
|
+
/** Styling for the map's container. */
|
|
758
|
+
containerData?: PluginContainerData;
|
|
759
|
+
/** Map settings. */
|
|
760
|
+
mapSettings?: MapSettings;
|
|
761
|
+
}
|
|
762
|
+
export interface MapSettings {
|
|
763
|
+
/** The address to display on the map. */
|
|
764
|
+
address?: string | null;
|
|
765
|
+
/** Sets whether the map is draggable. */
|
|
766
|
+
draggable?: boolean | null;
|
|
767
|
+
/** Sets whether the location marker is visible. */
|
|
768
|
+
marker?: boolean | null;
|
|
769
|
+
/** Sets whether street view control is enabled. */
|
|
770
|
+
streetViewControl?: boolean | null;
|
|
771
|
+
/** Sets whether zoom control is enabled. */
|
|
772
|
+
zoomControl?: boolean | null;
|
|
773
|
+
/** Location latitude. */
|
|
774
|
+
lat?: number | null;
|
|
775
|
+
/** Location longitude. */
|
|
776
|
+
lng?: number | null;
|
|
777
|
+
/** Location name. */
|
|
778
|
+
locationName?: string | null;
|
|
779
|
+
/** Sets whether view mode control is enabled. */
|
|
780
|
+
viewModeControl?: boolean | null;
|
|
781
|
+
/** Initial zoom value. */
|
|
782
|
+
initialZoom?: number | null;
|
|
783
|
+
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
784
|
+
mapType?: MapType;
|
|
785
|
+
}
|
|
786
|
+
export declare enum MapType {
|
|
787
|
+
/** Roadmap map type */
|
|
788
|
+
ROADMAP = "ROADMAP",
|
|
789
|
+
/** Satellite map type */
|
|
790
|
+
SATELITE = "SATELITE",
|
|
791
|
+
/** Hybrid map type */
|
|
792
|
+
HYBRID = "HYBRID",
|
|
793
|
+
/** Terrain map type */
|
|
794
|
+
TERRAIN = "TERRAIN"
|
|
795
|
+
}
|
|
796
|
+
export interface ParagraphData {
|
|
797
|
+
/** Styling for the paragraph text. */
|
|
798
|
+
textStyle?: TextStyle;
|
|
799
|
+
/** Indentation level from 1-6. */
|
|
800
|
+
indentation?: number | null;
|
|
801
|
+
}
|
|
802
|
+
export interface PollData {
|
|
803
|
+
/** Styling for the poll's container. */
|
|
804
|
+
containerData?: PluginContainerData;
|
|
805
|
+
/** Poll data. */
|
|
806
|
+
poll?: Poll;
|
|
807
|
+
/** Layout settings for the poll and voting options. */
|
|
808
|
+
layout?: PollDataLayout;
|
|
809
|
+
/** Styling for the poll and voting options. */
|
|
810
|
+
design?: Design;
|
|
811
|
+
}
|
|
812
|
+
export declare enum ViewRole {
|
|
813
|
+
/** Only Poll creator can view the results */
|
|
814
|
+
CREATOR = "CREATOR",
|
|
815
|
+
/** Anyone who voted can see the results */
|
|
816
|
+
VOTERS = "VOTERS",
|
|
817
|
+
/** Anyone can see the results, even if one didn't vote */
|
|
818
|
+
EVERYONE = "EVERYONE"
|
|
819
|
+
}
|
|
820
|
+
export declare enum VoteRole {
|
|
821
|
+
/** Logged in member */
|
|
822
|
+
SITE_MEMBERS = "SITE_MEMBERS",
|
|
823
|
+
/** Anyone */
|
|
824
|
+
ALL = "ALL"
|
|
825
|
+
}
|
|
826
|
+
export interface Permissions {
|
|
827
|
+
/** Sets who can view the poll results. */
|
|
828
|
+
view?: ViewRole;
|
|
829
|
+
/** Sets who can vote. */
|
|
830
|
+
vote?: VoteRole;
|
|
831
|
+
/** Sets whether one voter can vote multiple times. */
|
|
832
|
+
allowMultipleVotes?: boolean | null;
|
|
833
|
+
}
|
|
834
|
+
export interface Option {
|
|
835
|
+
/** Option ID. */
|
|
836
|
+
id?: string | null;
|
|
837
|
+
/** Option title. */
|
|
838
|
+
title?: string | null;
|
|
839
|
+
/** The image displayed with the option. */
|
|
840
|
+
image?: Rich_contentV1Media;
|
|
841
|
+
}
|
|
842
|
+
export interface PollSettings {
|
|
843
|
+
/** Permissions settings for voting. */
|
|
844
|
+
permissions?: Permissions;
|
|
845
|
+
/** Sets whether voters are displayed in the vote results. */
|
|
846
|
+
showVoters?: boolean | null;
|
|
847
|
+
/** Sets whether the vote count is displayed. */
|
|
848
|
+
showVotesCount?: boolean | null;
|
|
849
|
+
}
|
|
850
|
+
export declare enum PollLayoutType {
|
|
851
|
+
/** List */
|
|
852
|
+
LIST = "LIST",
|
|
853
|
+
/** Grid */
|
|
854
|
+
GRID = "GRID"
|
|
855
|
+
}
|
|
856
|
+
export declare enum PollLayoutDirection {
|
|
857
|
+
/** Left-to-right */
|
|
858
|
+
LTR = "LTR",
|
|
859
|
+
/** Right-to-left */
|
|
860
|
+
RTL = "RTL"
|
|
861
|
+
}
|
|
862
|
+
export interface PollLayout {
|
|
863
|
+
/** The layout for displaying the voting options. */
|
|
864
|
+
type?: PollLayoutType;
|
|
865
|
+
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
866
|
+
direction?: PollLayoutDirection;
|
|
867
|
+
/** Sets whether to display the main poll image. */
|
|
868
|
+
enableImage?: boolean | null;
|
|
869
|
+
}
|
|
870
|
+
export interface OptionLayout {
|
|
871
|
+
/** Sets whether to display option images. */
|
|
872
|
+
enableImage?: boolean | null;
|
|
873
|
+
}
|
|
874
|
+
export declare enum BackgroundType {
|
|
875
|
+
/** Color background type */
|
|
876
|
+
COLOR = "COLOR",
|
|
877
|
+
/** Image background type */
|
|
878
|
+
IMAGE = "IMAGE",
|
|
879
|
+
/** Gradiant background type */
|
|
880
|
+
GRADIENT = "GRADIENT"
|
|
881
|
+
}
|
|
882
|
+
export interface Gradient {
|
|
883
|
+
/** The gradient angle in degrees. */
|
|
884
|
+
angle?: number | null;
|
|
885
|
+
/** The start color as a hexademical value. */
|
|
886
|
+
startColor?: string | null;
|
|
887
|
+
/** The end color as a hexademical value. */
|
|
888
|
+
lastColor?: string | null;
|
|
889
|
+
}
|
|
890
|
+
export interface Background extends BackgroundBackgroundOneOf {
|
|
891
|
+
/** Background type. For each option, include the relevant details. */
|
|
892
|
+
type?: BackgroundType;
|
|
893
|
+
/** The background color as a hexademical value. */
|
|
894
|
+
color?: string | null;
|
|
895
|
+
/** An image to use for the background. */
|
|
896
|
+
image?: Rich_contentV1Media;
|
|
897
|
+
/** Details for a gradient background. */
|
|
898
|
+
gradient?: Gradient;
|
|
899
|
+
}
|
|
900
|
+
/** @oneof */
|
|
901
|
+
export interface BackgroundBackgroundOneOf {
|
|
902
|
+
/** The background color as a hexademical value. */
|
|
903
|
+
color?: string | null;
|
|
904
|
+
/** An image to use for the background. */
|
|
905
|
+
image?: Rich_contentV1Media;
|
|
906
|
+
/** Details for a gradient background. */
|
|
907
|
+
gradient?: Gradient;
|
|
908
|
+
}
|
|
909
|
+
export interface PollDesign {
|
|
910
|
+
/** Background styling. */
|
|
911
|
+
background?: Background;
|
|
912
|
+
/** Border radius in pixels. */
|
|
913
|
+
borderRadius?: number | null;
|
|
914
|
+
}
|
|
915
|
+
export interface OptionDesign {
|
|
916
|
+
/** Border radius in pixels. */
|
|
917
|
+
borderRadius?: number | null;
|
|
918
|
+
}
|
|
919
|
+
export interface Poll {
|
|
920
|
+
/** Poll ID. */
|
|
921
|
+
id?: string | null;
|
|
922
|
+
/** Poll title. */
|
|
923
|
+
title?: string | null;
|
|
924
|
+
/** Poll creator ID. */
|
|
925
|
+
creatorId?: string | null;
|
|
926
|
+
/** Main poll image. */
|
|
927
|
+
image?: Rich_contentV1Media;
|
|
928
|
+
/** Voting options. */
|
|
929
|
+
options?: Option[];
|
|
930
|
+
/** The poll's permissions and display settings. */
|
|
931
|
+
settings?: PollSettings;
|
|
932
|
+
}
|
|
933
|
+
export interface PollDataLayout {
|
|
934
|
+
/** Poll layout settings. */
|
|
935
|
+
poll?: PollLayout;
|
|
936
|
+
/** Voting otpions layout settings. */
|
|
937
|
+
options?: OptionLayout;
|
|
938
|
+
}
|
|
939
|
+
export interface Design {
|
|
940
|
+
/** Styling for the poll. */
|
|
941
|
+
poll?: PollDesign;
|
|
942
|
+
/** Styling for voting options. */
|
|
943
|
+
options?: OptionDesign;
|
|
944
|
+
}
|
|
945
|
+
export interface TextData {
|
|
946
|
+
/** The text to apply decorations to. */
|
|
947
|
+
text?: string;
|
|
948
|
+
/** The decorations to apply. */
|
|
949
|
+
decorations?: Decoration[];
|
|
950
|
+
}
|
|
951
|
+
/** Adds appearence changes to text */
|
|
952
|
+
export interface Decoration extends DecorationDataOneOf {
|
|
953
|
+
/** The type of decoration to apply. */
|
|
954
|
+
type?: DecorationType;
|
|
955
|
+
/** Data for an anchor link decoration. */
|
|
956
|
+
anchorData?: AnchorData;
|
|
957
|
+
/** Data for a color decoration. */
|
|
958
|
+
colorData?: ColorData;
|
|
959
|
+
/** Data for an external link decoration. */
|
|
960
|
+
linkData?: LinkData;
|
|
961
|
+
/** Data for a mention decoration. */
|
|
962
|
+
mentionData?: MentionData;
|
|
963
|
+
/** Data for a font size decoration. */
|
|
964
|
+
fontSizeData?: FontSizeData;
|
|
965
|
+
/** Font weight for a bold decoration. */
|
|
966
|
+
fontWeightValue?: number | null;
|
|
967
|
+
/** Data for an italic decoration. */
|
|
968
|
+
italicData?: boolean | null;
|
|
969
|
+
/** Data for an underline decoration. */
|
|
970
|
+
underlineData?: boolean | null;
|
|
971
|
+
}
|
|
972
|
+
/** @oneof */
|
|
973
|
+
export interface DecorationDataOneOf {
|
|
974
|
+
/** Data for an anchor link decoration. */
|
|
975
|
+
anchorData?: AnchorData;
|
|
976
|
+
/** Data for a color decoration. */
|
|
977
|
+
colorData?: ColorData;
|
|
978
|
+
/** Data for an external link decoration. */
|
|
979
|
+
linkData?: LinkData;
|
|
980
|
+
/** Data for a mention decoration. */
|
|
981
|
+
mentionData?: MentionData;
|
|
982
|
+
/** Data for a font size decoration. */
|
|
983
|
+
fontSizeData?: FontSizeData;
|
|
984
|
+
/** Font weight for a bold decoration. */
|
|
985
|
+
fontWeightValue?: number | null;
|
|
986
|
+
/** Data for an italic decoration. */
|
|
987
|
+
italicData?: boolean | null;
|
|
988
|
+
/** Data for an underline decoration. */
|
|
989
|
+
underlineData?: boolean | null;
|
|
990
|
+
}
|
|
991
|
+
export declare enum DecorationType {
|
|
992
|
+
BOLD = "BOLD",
|
|
993
|
+
ITALIC = "ITALIC",
|
|
994
|
+
UNDERLINE = "UNDERLINE",
|
|
995
|
+
SPOILER = "SPOILER",
|
|
996
|
+
ANCHOR = "ANCHOR",
|
|
997
|
+
MENTION = "MENTION",
|
|
998
|
+
LINK = "LINK",
|
|
999
|
+
COLOR = "COLOR",
|
|
1000
|
+
FONT_SIZE = "FONT_SIZE",
|
|
1001
|
+
EXTERNAL = "EXTERNAL"
|
|
1002
|
+
}
|
|
1003
|
+
export interface AnchorData {
|
|
1004
|
+
/** The target node's ID. */
|
|
1005
|
+
anchor?: string;
|
|
1006
|
+
}
|
|
1007
|
+
export interface ColorData {
|
|
1008
|
+
/** The text's background color as a hexadecimal value. */
|
|
1009
|
+
background?: string | null;
|
|
1010
|
+
/** The text's foreground color as a hexadecimal value. */
|
|
1011
|
+
foreground?: string | null;
|
|
1012
|
+
}
|
|
1013
|
+
export interface LinkData {
|
|
1014
|
+
/** Link details. */
|
|
1015
|
+
link?: Link;
|
|
1016
|
+
}
|
|
1017
|
+
export interface MentionData {
|
|
1018
|
+
/** The mentioned user's name. */
|
|
1019
|
+
name?: string;
|
|
1020
|
+
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
1021
|
+
slug?: string;
|
|
1022
|
+
/** Mentioned user's ID. */
|
|
1023
|
+
id?: string | null;
|
|
1024
|
+
}
|
|
1025
|
+
export interface FontSizeData {
|
|
1026
|
+
/** The units used for the font size. */
|
|
1027
|
+
unit?: FontType;
|
|
1028
|
+
/** Font size value. */
|
|
1029
|
+
value?: number | null;
|
|
1030
|
+
}
|
|
1031
|
+
export declare enum FontType {
|
|
1032
|
+
PX = "PX",
|
|
1033
|
+
EM = "EM"
|
|
1034
|
+
}
|
|
1035
|
+
export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1036
|
+
/** The type of Wix App content being embedded. */
|
|
1037
|
+
type?: AppType;
|
|
1038
|
+
/** The ID of the embedded content. */
|
|
1039
|
+
itemId?: string | null;
|
|
1040
|
+
/** The name of the embedded content. */
|
|
1041
|
+
name?: string | null;
|
|
1042
|
+
/** Deprecated: Use `image` instead. */
|
|
1043
|
+
imageSrc?: string | null;
|
|
1044
|
+
/** The URL for the embedded content. */
|
|
1045
|
+
url?: string | null;
|
|
1046
|
+
/** An image for the embedded content. */
|
|
1047
|
+
image?: Rich_contentV1Media;
|
|
1048
|
+
/** Data for embedded Wix Bookings content. */
|
|
1049
|
+
bookingData?: BookingData;
|
|
1050
|
+
/** Data for embedded Wix Events content. */
|
|
1051
|
+
eventData?: EventData;
|
|
1052
|
+
}
|
|
1053
|
+
/** @oneof */
|
|
1054
|
+
export interface AppEmbedDataAppDataOneOf {
|
|
1055
|
+
/** Data for embedded Wix Bookings content. */
|
|
1056
|
+
bookingData?: BookingData;
|
|
1057
|
+
/** Data for embedded Wix Events content. */
|
|
1058
|
+
eventData?: EventData;
|
|
1059
|
+
}
|
|
1060
|
+
export declare enum AppType {
|
|
1061
|
+
PRODUCT = "PRODUCT",
|
|
1062
|
+
EVENT = "EVENT",
|
|
1063
|
+
BOOKING = "BOOKING"
|
|
1064
|
+
}
|
|
1065
|
+
export interface BookingData {
|
|
1066
|
+
/** Booking duration in minutes. */
|
|
1067
|
+
durations?: string | null;
|
|
1068
|
+
}
|
|
1069
|
+
export interface EventData {
|
|
1070
|
+
/** Event schedule. */
|
|
1071
|
+
scheduling?: string | null;
|
|
1072
|
+
/** Event location. */
|
|
1073
|
+
location?: string | null;
|
|
1074
|
+
}
|
|
1075
|
+
export interface VideoData {
|
|
1076
|
+
/** Styling for the video's container. */
|
|
1077
|
+
containerData?: PluginContainerData;
|
|
1078
|
+
/** Video details. */
|
|
1079
|
+
video?: Rich_contentV1Media;
|
|
1080
|
+
/** Video thumbnail details. */
|
|
1081
|
+
thumbnail?: Rich_contentV1Media;
|
|
1082
|
+
/** Sets whether the video's download button is disabled. */
|
|
1083
|
+
disableDownload?: boolean | null;
|
|
1084
|
+
/** Video title. */
|
|
1085
|
+
title?: string | null;
|
|
1086
|
+
/** Video options. */
|
|
1087
|
+
options?: PlaybackOptions;
|
|
1088
|
+
}
|
|
1089
|
+
export interface PlaybackOptions {
|
|
1090
|
+
/** Sets whether the media will automatically start playing. */
|
|
1091
|
+
autoPlay?: boolean | null;
|
|
1092
|
+
/** Sets whether media's will be looped. */
|
|
1093
|
+
playInLoop?: boolean | null;
|
|
1094
|
+
/** Sets whether media's controls will be shown. */
|
|
1095
|
+
showControls?: boolean | null;
|
|
1096
|
+
}
|
|
1097
|
+
export interface EmbedData {
|
|
1098
|
+
/** Styling for the oEmbed node's container. */
|
|
1099
|
+
containerData?: PluginContainerData;
|
|
1100
|
+
/** An [oEmbed](https://www.oembed.com) object. */
|
|
1101
|
+
oembed?: Oembed;
|
|
1102
|
+
/** Origin asset source. */
|
|
1103
|
+
src?: string | null;
|
|
1104
|
+
}
|
|
1105
|
+
export interface Oembed {
|
|
1106
|
+
/** The resource type. */
|
|
1107
|
+
type?: string | null;
|
|
1108
|
+
/** The width of the resource specified in the `url` property in pixels. */
|
|
1109
|
+
width?: number | null;
|
|
1110
|
+
/** The height of the resource specified in the `url` property in pixels. */
|
|
1111
|
+
height?: number | null;
|
|
1112
|
+
/** Resource title. */
|
|
1113
|
+
title?: string | null;
|
|
1114
|
+
/** The source URL for the resource. */
|
|
1115
|
+
url?: string | null;
|
|
1116
|
+
/** HTML for embedding a video player. The HTML should have no padding or margins. */
|
|
1117
|
+
html?: string | null;
|
|
1118
|
+
/** The name of the author or owner of the resource. */
|
|
1119
|
+
authorName?: string | null;
|
|
1120
|
+
/** The URL for the author or owner of the resource. */
|
|
1121
|
+
authorUrl?: string | null;
|
|
1122
|
+
/** The name of the resource provider. */
|
|
1123
|
+
providerName?: string | null;
|
|
1124
|
+
/** The URL for the resource provider. */
|
|
1125
|
+
providerUrl?: string | null;
|
|
1126
|
+
/** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
|
|
1127
|
+
thumbnailUrl?: string | null;
|
|
1128
|
+
/** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
|
|
1129
|
+
thumbnailWidth?: string | null;
|
|
1130
|
+
/** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
|
|
1131
|
+
thumbnailHeight?: string | null;
|
|
1132
|
+
/** The URL for an embedded viedo. */
|
|
1133
|
+
videoUrl?: string | null;
|
|
1134
|
+
/** The oEmbed version number. This value must be `1.0`. */
|
|
1135
|
+
version?: string | null;
|
|
1136
|
+
}
|
|
1137
|
+
export interface CollapsibleListData {
|
|
1138
|
+
/** Styling for the collapsible list's container. */
|
|
1139
|
+
containerData?: PluginContainerData;
|
|
1140
|
+
/** If `true`, only one item can be expanded at a time. */
|
|
1141
|
+
expandOnlyOne?: boolean | null;
|
|
1142
|
+
/** Sets which items are expanded when the page loads. */
|
|
1143
|
+
initialExpandedItems?: InitialExpandedItems;
|
|
1144
|
+
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
1145
|
+
direction?: Direction;
|
|
1146
|
+
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1147
|
+
isQapageData?: boolean | null;
|
|
1148
|
+
}
|
|
1149
|
+
export declare enum InitialExpandedItems {
|
|
1150
|
+
/** First item will be expended initally */
|
|
1151
|
+
FIRST = "FIRST",
|
|
1152
|
+
/** All items will expended initally */
|
|
1153
|
+
ALL = "ALL",
|
|
1154
|
+
/** All items collapsed initally */
|
|
1155
|
+
NONE = "NONE"
|
|
1156
|
+
}
|
|
1157
|
+
export declare enum Direction {
|
|
1158
|
+
/** Left-to-right */
|
|
1159
|
+
LTR = "LTR",
|
|
1160
|
+
/** Right-to-left */
|
|
1161
|
+
RTL = "RTL"
|
|
1162
|
+
}
|
|
1163
|
+
export interface TableData {
|
|
1164
|
+
/** Styling for the table's container. */
|
|
1165
|
+
containerData?: PluginContainerData;
|
|
1166
|
+
/** The table's dimensions. */
|
|
1167
|
+
dimensions?: Dimensions;
|
|
1168
|
+
/** Deprecated: Use `rowHeader` and `columnHeader` instead. */
|
|
1169
|
+
header?: boolean | null;
|
|
1170
|
+
/** Sets whether the table's first row is a header. */
|
|
1171
|
+
rowHeader?: boolean | null;
|
|
1172
|
+
/** Sets whether the table's first column is a header. */
|
|
1173
|
+
columnHeader?: boolean | null;
|
|
1174
|
+
}
|
|
1175
|
+
export interface Dimensions {
|
|
1176
|
+
/** An array representing relative width of each column in relation to the other columns. */
|
|
1177
|
+
colsWidthRatio?: number[];
|
|
1178
|
+
/** An array representing the height of each row in pixels. */
|
|
1179
|
+
rowsHeight?: number[];
|
|
1180
|
+
/** An array representing the minimum width of each column in pixels. */
|
|
1181
|
+
colsMinWidth?: number[];
|
|
1182
|
+
}
|
|
1183
|
+
export interface TableCellData {
|
|
1184
|
+
/** Styling for the cell's background color and text alignment. */
|
|
1185
|
+
cellStyle?: CellStyle;
|
|
1186
|
+
/** The cell's border colors. */
|
|
1187
|
+
borderColors?: BorderColors;
|
|
1188
|
+
}
|
|
1189
|
+
export declare enum VerticalAlignment {
|
|
1190
|
+
/** Top alignment */
|
|
1191
|
+
TOP = "TOP",
|
|
1192
|
+
/** Middle alignment */
|
|
1193
|
+
MIDDLE = "MIDDLE",
|
|
1194
|
+
/** Bottom alignment */
|
|
1195
|
+
BOTTOM = "BOTTOM"
|
|
1196
|
+
}
|
|
1197
|
+
export interface CellStyle {
|
|
1198
|
+
/** Vertical alignment for the cell's text. */
|
|
1199
|
+
verticalAlignment?: VerticalAlignment;
|
|
1200
|
+
/** Cell background color as a hexadecimal value. */
|
|
1201
|
+
backgroundColor?: string | null;
|
|
1202
|
+
}
|
|
1203
|
+
export interface BorderColors {
|
|
1204
|
+
/** Left border color as a hexadecimal value. */
|
|
1205
|
+
left?: string | null;
|
|
1206
|
+
/** Right border color as a hexadecimal value. */
|
|
1207
|
+
right?: string | null;
|
|
1208
|
+
/** Top border color as a hexadecimal value. */
|
|
1209
|
+
top?: string | null;
|
|
1210
|
+
/** Bottom border color as a hexadecimal value. */
|
|
1211
|
+
bottom?: string | null;
|
|
1212
|
+
}
|
|
1213
|
+
/**
|
|
1214
|
+
* `NullValue` is a singleton enumeration to represent the null value for the
|
|
1215
|
+
* `Value` type union.
|
|
1216
|
+
*
|
|
1217
|
+
* The JSON representation for `NullValue` is JSON `null`.
|
|
1218
|
+
*/
|
|
1219
|
+
export declare enum NullValue {
|
|
1220
|
+
/** Null value. */
|
|
1221
|
+
NULL_VALUE = "NULL_VALUE"
|
|
1222
|
+
}
|
|
1223
|
+
/**
|
|
1224
|
+
* `ListValue` is a wrapper around a repeated field of values.
|
|
1225
|
+
*
|
|
1226
|
+
* The JSON representation for `ListValue` is JSON array.
|
|
1227
|
+
*/
|
|
1228
|
+
export interface ListValue {
|
|
1229
|
+
/** Repeated field of dynamically typed values. */
|
|
1230
|
+
values?: any[];
|
|
1231
|
+
}
|
|
1232
|
+
export interface AudioData {
|
|
1233
|
+
/** Styling for the audio node's container. */
|
|
1234
|
+
containerData?: PluginContainerData;
|
|
1235
|
+
/** Audio file details. */
|
|
1236
|
+
audio?: Rich_contentV1Media;
|
|
1237
|
+
/** Sets whether the audio node's download button is disabled. */
|
|
1238
|
+
disableDownload?: boolean | null;
|
|
1239
|
+
/** Cover image. */
|
|
1240
|
+
coverImage?: Rich_contentV1Media;
|
|
1241
|
+
/** Track name. */
|
|
1242
|
+
name?: string | null;
|
|
1243
|
+
/** Author name. */
|
|
1244
|
+
authorName?: string | null;
|
|
1245
|
+
/** An HTML version of the audio node. */
|
|
1246
|
+
html?: string | null;
|
|
1247
|
+
}
|
|
1248
|
+
export interface OrderedListData {
|
|
1249
|
+
/** Indentation level. */
|
|
1250
|
+
indentation?: number;
|
|
1251
|
+
}
|
|
1252
|
+
export interface BulletedListData {
|
|
1253
|
+
/** Indentation level. */
|
|
1254
|
+
indentation?: number;
|
|
1255
|
+
}
|
|
1256
|
+
export interface BlockquoteData {
|
|
1257
|
+
/** Indentation level. */
|
|
1258
|
+
indentation?: number;
|
|
1259
|
+
}
|
|
1260
|
+
export interface Metadata {
|
|
1261
|
+
/** Schema version. */
|
|
1262
|
+
version?: number;
|
|
1263
|
+
/**
|
|
1264
|
+
* When the object was created.
|
|
1265
|
+
* @readonly
|
|
1266
|
+
*/
|
|
1267
|
+
createdTimestamp?: Date;
|
|
1268
|
+
/** When the object was most recently updated. */
|
|
1269
|
+
updatedTimestamp?: Date;
|
|
1270
|
+
/** Object ID. */
|
|
1271
|
+
id?: string | null;
|
|
1272
|
+
}
|
|
1273
|
+
export interface DocumentStyle {
|
|
1274
|
+
/** Styling for H1 nodes. */
|
|
1275
|
+
headerOne?: TextNodeStyle;
|
|
1276
|
+
/** Styling for H2 nodes. */
|
|
1277
|
+
headerTwo?: TextNodeStyle;
|
|
1278
|
+
/** Styling for H3 nodes. */
|
|
1279
|
+
headerThree?: TextNodeStyle;
|
|
1280
|
+
/** Styling for H4 nodes. */
|
|
1281
|
+
headerFour?: TextNodeStyle;
|
|
1282
|
+
/** Styling for H5 nodes. */
|
|
1283
|
+
headerFive?: TextNodeStyle;
|
|
1284
|
+
/** Styling for H6 nodes. */
|
|
1285
|
+
headerSix?: TextNodeStyle;
|
|
1286
|
+
/** Styling for paragraph nodes. */
|
|
1287
|
+
paragraph?: TextNodeStyle;
|
|
1288
|
+
/** Styling for block quote nodes. */
|
|
1289
|
+
blockquote?: TextNodeStyle;
|
|
1290
|
+
/** Styling for code block nodes. */
|
|
1291
|
+
codeBlock?: TextNodeStyle;
|
|
1292
|
+
}
|
|
1293
|
+
export interface TextNodeStyle {
|
|
1294
|
+
/** The decorations to apply to the node. */
|
|
1295
|
+
decorations?: Decoration[];
|
|
1296
|
+
/** Padding and background color for the node. */
|
|
1297
|
+
nodeStyle?: NodeStyle;
|
|
1298
|
+
/** Line height for text in the node. */
|
|
1299
|
+
lineHeight?: string | null;
|
|
1300
|
+
}
|
|
1301
|
+
export interface V1Media {
|
|
1302
|
+
/** Primary media (image, video etc) associated with this product. */
|
|
1303
|
+
mainMedia?: PlatformMedia;
|
|
1304
|
+
/** Media (images, videos etc) associated with this product. */
|
|
1305
|
+
items?: PlatformMedia[];
|
|
1306
|
+
}
|
|
1307
|
+
export interface PlatformMedia extends PlatformMediaMediaOneOf {
|
|
1308
|
+
image?: CommonImage;
|
|
1309
|
+
video?: VideoV2;
|
|
1310
|
+
}
|
|
1311
|
+
/** @oneof */
|
|
1312
|
+
export interface PlatformMediaMediaOneOf {
|
|
1313
|
+
image?: CommonImage;
|
|
1314
|
+
video?: VideoV2;
|
|
1315
|
+
}
|
|
1316
|
+
export interface CommonImage {
|
|
1317
|
+
/** WixMedia image ID. */
|
|
1318
|
+
id?: string;
|
|
1319
|
+
/** Image URL. */
|
|
1320
|
+
url?: string;
|
|
1321
|
+
/**
|
|
1322
|
+
* Original image height.
|
|
1323
|
+
* @readonly
|
|
1324
|
+
*/
|
|
1325
|
+
height?: number;
|
|
1326
|
+
/**
|
|
1327
|
+
* Original image width.
|
|
1328
|
+
* @readonly
|
|
1329
|
+
*/
|
|
1330
|
+
width?: number;
|
|
1331
|
+
/** Image alt text. */
|
|
1332
|
+
altText?: string | null;
|
|
1333
|
+
/**
|
|
1334
|
+
* Image filename.
|
|
1335
|
+
* @readonly
|
|
1336
|
+
*/
|
|
1337
|
+
filename?: string | null;
|
|
1338
|
+
}
|
|
1339
|
+
export interface VideoV2 {
|
|
1340
|
+
/** WixMedia ID. */
|
|
1341
|
+
id?: string;
|
|
1342
|
+
/**
|
|
1343
|
+
* Available resolutions for the video, starting with the optimal resolution.
|
|
1344
|
+
* @readonly
|
|
1345
|
+
*/
|
|
1346
|
+
resolutions?: VideoResolution[];
|
|
1347
|
+
/**
|
|
1348
|
+
* Video filename.
|
|
1349
|
+
* @readonly
|
|
1350
|
+
*/
|
|
1351
|
+
filename?: string | null;
|
|
1352
|
+
}
|
|
1353
|
+
export interface VideoResolution {
|
|
1354
|
+
/** Video URL. */
|
|
1355
|
+
url?: string;
|
|
1356
|
+
/** Video height. */
|
|
1357
|
+
height?: number;
|
|
1358
|
+
/** Video width. */
|
|
1359
|
+
width?: number;
|
|
1360
|
+
/** Video format for example, mp4, hls. */
|
|
1361
|
+
format?: string;
|
|
1362
|
+
}
|
|
1363
|
+
/**
|
|
1364
|
+
* 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.
|
|
1365
|
+
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
1366
|
+
* 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.
|
|
1367
|
+
*/
|
|
1368
|
+
export interface SeoSchema {
|
|
1369
|
+
/** SEO tag information. */
|
|
1370
|
+
tags?: Tag[];
|
|
1371
|
+
/** SEO general settings. */
|
|
1372
|
+
settings?: Settings;
|
|
1373
|
+
}
|
|
1374
|
+
export interface Keyword {
|
|
1375
|
+
/** Keyword value. */
|
|
1376
|
+
term?: string;
|
|
1377
|
+
/** Whether the keyword is the main focus keyword. */
|
|
1378
|
+
isMain?: boolean;
|
|
1379
|
+
}
|
|
1380
|
+
export interface Tag {
|
|
1381
|
+
/**
|
|
1382
|
+
* SEO tag type.
|
|
1383
|
+
*
|
|
1384
|
+
*
|
|
1385
|
+
* Supported values: `title`, `meta`, `script`, `link`.
|
|
1386
|
+
*/
|
|
1387
|
+
type?: string;
|
|
1388
|
+
/**
|
|
1389
|
+
* A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.
|
|
1390
|
+
* For example: `{'name': 'description', 'content': 'the description itself'}`.
|
|
1391
|
+
*/
|
|
1392
|
+
props?: Record<string, any> | null;
|
|
1393
|
+
/** SEO tag meta data. For example, `{height: 300, width: 240}`. */
|
|
1394
|
+
meta?: Record<string, any> | null;
|
|
1395
|
+
/** SEO tag inner content. For example, `<title> inner content </title>`. */
|
|
1396
|
+
children?: string;
|
|
1397
|
+
/** Whether the tag is a custom tag. */
|
|
1398
|
+
custom?: boolean;
|
|
1399
|
+
/** Whether the tag is disabled. */
|
|
1400
|
+
disabled?: boolean;
|
|
1401
|
+
}
|
|
1402
|
+
export interface Settings {
|
|
1403
|
+
/**
|
|
1404
|
+
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
1405
|
+
*
|
|
1406
|
+
*
|
|
1407
|
+
* Default: `false` (Auto Redirect is enabled.)
|
|
1408
|
+
*/
|
|
1409
|
+
preventAutoRedirect?: boolean;
|
|
1410
|
+
/** User-selected keyword terms for a specific page. */
|
|
1411
|
+
keywords?: Keyword[];
|
|
1412
|
+
}
|
|
1413
|
+
export interface PricePerUnitSettings {
|
|
1414
|
+
/** Quantity value. e.g to define price per unit product setting to price per 100 gr. Set this value to 100. */
|
|
1415
|
+
quantity?: number;
|
|
1416
|
+
/** Measurement unit, e.g to define price per unit product setting to price per 100 gr. Set this value to "G". */
|
|
1417
|
+
measurementUnit?: MeasurementUnit;
|
|
1418
|
+
}
|
|
1419
|
+
export declare enum MeasurementUnit {
|
|
1420
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
1421
|
+
ML = "ML",
|
|
1422
|
+
CL = "CL",
|
|
1423
|
+
L = "L",
|
|
1424
|
+
CBM = "CBM",
|
|
1425
|
+
MG = "MG",
|
|
1426
|
+
G = "G",
|
|
1427
|
+
KG = "KG",
|
|
1428
|
+
MM = "MM",
|
|
1429
|
+
CM = "CM",
|
|
1430
|
+
M = "M",
|
|
1431
|
+
SQM = "SQM",
|
|
1432
|
+
OZ = "OZ",
|
|
1433
|
+
LB = "LB",
|
|
1434
|
+
FLOZ = "FLOZ",
|
|
1435
|
+
PT = "PT",
|
|
1436
|
+
QT = "QT",
|
|
1437
|
+
GAL = "GAL",
|
|
1438
|
+
IN = "IN",
|
|
1439
|
+
FT = "FT",
|
|
1440
|
+
YD = "YD",
|
|
1441
|
+
SQFT = "SQFT"
|
|
1442
|
+
}
|
|
1443
|
+
export interface V1ProductOption {
|
|
1444
|
+
/** The id of the option */
|
|
1445
|
+
optionId?: string;
|
|
1446
|
+
/**
|
|
1447
|
+
* Option title. Materialized view field
|
|
1448
|
+
* @readonly
|
|
1449
|
+
*/
|
|
1450
|
+
name?: string;
|
|
1451
|
+
/**
|
|
1452
|
+
* Option type. Materialized view field
|
|
1453
|
+
* @readonly
|
|
1454
|
+
*/
|
|
1455
|
+
optionType?: V1OptionType;
|
|
1456
|
+
/** Choices available for this option */
|
|
1457
|
+
optionChoices?: ProductChoice[];
|
|
1458
|
+
/**
|
|
1459
|
+
* When `true` this option affects variants of this product: choices of this option will be used in variant's `choices` field.
|
|
1460
|
+
* When `false` option ignored in all variant related flows.
|
|
1461
|
+
*/
|
|
1462
|
+
generateVariants?: boolean;
|
|
1463
|
+
}
|
|
1464
|
+
export declare enum V1OptionType {
|
|
1465
|
+
UNKNOWN_OPTION_TYPE = "UNKNOWN_OPTION_TYPE",
|
|
1466
|
+
TEXT = "TEXT",
|
|
1467
|
+
SWATCH = "SWATCH"
|
|
1468
|
+
}
|
|
1469
|
+
export interface ProductChoice {
|
|
1470
|
+
/** The id of the choice */
|
|
1471
|
+
choiceId?: string;
|
|
1472
|
+
/**
|
|
1473
|
+
* Materialized value of the choice
|
|
1474
|
+
* todo: copy proto
|
|
1475
|
+
* @readonly
|
|
1476
|
+
*/
|
|
1477
|
+
choice?: V1Choice;
|
|
1478
|
+
}
|
|
1479
|
+
export interface V1Choice extends V1ChoiceValueOneOf {
|
|
1480
|
+
/**
|
|
1481
|
+
* Choice id.
|
|
1482
|
+
* @readonly
|
|
1483
|
+
*/
|
|
1484
|
+
id?: string;
|
|
1485
|
+
/**
|
|
1486
|
+
* The type of this choice.
|
|
1487
|
+
* Choices related to options of type SWATCH must have ONE_COLOR, MULTIPLE_COLORS or IMAGE choice type.
|
|
1488
|
+
* Choice related to options of type TEXT, must have TEXT choice type.
|
|
1489
|
+
*/
|
|
1490
|
+
choiceType?: ChoiceType;
|
|
1491
|
+
/**
|
|
1492
|
+
* A read-only key auto-generated based the choice name that will be used for CatalogSPI endpoints
|
|
1493
|
+
* @readonly
|
|
1494
|
+
*/
|
|
1495
|
+
key?: string | null;
|
|
1496
|
+
/** Choice name. */
|
|
1497
|
+
name?: string;
|
|
1498
|
+
/**
|
|
1499
|
+
* Number of products that have this choice assigned to.
|
|
1500
|
+
* @readonly
|
|
1501
|
+
*/
|
|
1502
|
+
numberOfProducts?: number;
|
|
1503
|
+
/** One color - HEX or RGB color code for display. */
|
|
1504
|
+
colorCode?: string;
|
|
1505
|
+
}
|
|
1506
|
+
/** @oneof */
|
|
1507
|
+
export interface V1ChoiceValueOneOf {
|
|
1508
|
+
/** One color - HEX or RGB color code for display. */
|
|
1509
|
+
colorCode?: string;
|
|
1510
|
+
}
|
|
1511
|
+
export declare enum ChoiceType {
|
|
1512
|
+
UNKNOWN_CHOICE_TYPE = "UNKNOWN_CHOICE_TYPE",
|
|
1513
|
+
TEXT = "TEXT",
|
|
1514
|
+
ONE_COLOR = "ONE_COLOR",
|
|
1515
|
+
MULTIPLE_COLORS = "MULTIPLE_COLORS",
|
|
1516
|
+
IMAGE = "IMAGE"
|
|
1517
|
+
}
|
|
1518
|
+
export interface MultipleColors {
|
|
1519
|
+
/** A list of color codes */
|
|
1520
|
+
colorCodes?: string[];
|
|
1521
|
+
}
|
|
1522
|
+
export interface Brand {
|
|
1523
|
+
/** brand ID */
|
|
1524
|
+
id?: string | null;
|
|
1525
|
+
/** brand name. Translatable */
|
|
1526
|
+
name?: string | null;
|
|
1527
|
+
}
|
|
1528
|
+
export interface InfoSection {
|
|
1529
|
+
/** info section id */
|
|
1530
|
+
id?: string;
|
|
1531
|
+
/** Product info section title. Translatable. */
|
|
1532
|
+
title?: string;
|
|
1533
|
+
/** Product info section description. Translatable. */
|
|
1534
|
+
description?: string | null;
|
|
1535
|
+
}
|
|
1536
|
+
export interface SubscriptionOptionInfo {
|
|
1537
|
+
/** The id of the subscription_option */
|
|
1538
|
+
subscriptionOptionId?: string;
|
|
1539
|
+
/** The visibility of the subscription_option. Default: true */
|
|
1540
|
+
visible?: boolean | null;
|
|
1541
|
+
/**
|
|
1542
|
+
* Subscription option title as materialized view
|
|
1543
|
+
* @readonly
|
|
1544
|
+
*/
|
|
1545
|
+
title?: string;
|
|
1546
|
+
/**
|
|
1547
|
+
* Subscription option description (optional) as materialized view
|
|
1548
|
+
* @readonly
|
|
1549
|
+
*/
|
|
1550
|
+
description?: string | null;
|
|
1551
|
+
}
|
|
1552
|
+
export interface Customization extends CustomizationValueOneOf {
|
|
1553
|
+
/** Title */
|
|
1554
|
+
title?: string;
|
|
1555
|
+
/** Type. */
|
|
1556
|
+
customizationType?: CustomizationType;
|
|
1557
|
+
/** Whether customer's input is mandatory */
|
|
1558
|
+
mandatory?: boolean;
|
|
1559
|
+
/** Text input configuration. Required when `type` is TEXT_INPUT. */
|
|
1560
|
+
text?: TextInputValue;
|
|
1561
|
+
}
|
|
1562
|
+
/** @oneof */
|
|
1563
|
+
export interface CustomizationValueOneOf {
|
|
1564
|
+
/** Text input configuration. Required when `type` is TEXT_INPUT. */
|
|
1565
|
+
text?: TextInputValue;
|
|
1566
|
+
}
|
|
1567
|
+
export declare enum CustomizationType {
|
|
1568
|
+
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
1569
|
+
/** Represents text box for the customer to add a message to their order (e.g., customization request). */
|
|
1570
|
+
TEXT_INPUT = "TEXT_INPUT",
|
|
1571
|
+
CHECKBOX = "CHECKBOX"
|
|
1572
|
+
}
|
|
1573
|
+
export interface TextInputValue {
|
|
1574
|
+
/** Customer's input max length */
|
|
1575
|
+
maxLength?: number;
|
|
1576
|
+
}
|
|
1577
|
+
export interface CheckboxValue {
|
|
1578
|
+
title?: string;
|
|
1579
|
+
}
|
|
1580
|
+
export interface BreadCrumb {
|
|
1581
|
+
/** Category ID. */
|
|
1582
|
+
categoryId?: string;
|
|
1583
|
+
/** Category name. Translatable */
|
|
1584
|
+
categoryName?: string;
|
|
1585
|
+
/** A permanent, friendly URL name of category. */
|
|
1586
|
+
categorySlug?: string;
|
|
1587
|
+
}
|
|
1588
|
+
export interface V1NumericPropertyRange {
|
|
1589
|
+
/** Minimum value. */
|
|
1590
|
+
minValue?: number;
|
|
1591
|
+
/** Maximum value. */
|
|
1592
|
+
maxValue?: number;
|
|
1593
|
+
}
|
|
1594
|
+
/** todo: add information about preorder like it's done in inventory */
|
|
1595
|
+
export interface ProductInventory {
|
|
1596
|
+
/**
|
|
1597
|
+
* inventory ID.
|
|
1598
|
+
* @readonly
|
|
1599
|
+
*/
|
|
1600
|
+
inventoryId?: string;
|
|
1601
|
+
/**
|
|
1602
|
+
* Indicates if any of product variants available for purchase.
|
|
1603
|
+
* @readonly
|
|
1604
|
+
*/
|
|
1605
|
+
available?: boolean;
|
|
1606
|
+
/**
|
|
1607
|
+
* The current status of the inventory
|
|
1608
|
+
* + `IN_STOCK` - In stock
|
|
1609
|
+
* + `OUT_OF_STOCK` - Not in stock
|
|
1610
|
+
* + `PARTIALLY_OUT_OF_STOCK` - Some of the variants are not in stock
|
|
1611
|
+
* @readonly
|
|
1612
|
+
*/
|
|
1613
|
+
inventoryStatus?: ProductInventoryInventoryStatus;
|
|
1614
|
+
}
|
|
1615
|
+
export declare enum ProductInventoryInventoryStatus {
|
|
1616
|
+
UNKNOWN_INVENTORY_STATUS = "UNKNOWN_INVENTORY_STATUS",
|
|
1617
|
+
IN_STOCK = "IN_STOCK",
|
|
1618
|
+
OUT_OF_STOCK = "OUT_OF_STOCK",
|
|
1619
|
+
PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
|
|
1620
|
+
}
|
|
1621
|
+
export declare enum V1ProductType {
|
|
1622
|
+
UNKNOWN_PRODUCT_TYPE = "UNKNOWN_PRODUCT_TYPE",
|
|
1623
|
+
PHYSICAL = "PHYSICAL",
|
|
1624
|
+
DIGITAL = "DIGITAL"
|
|
1625
|
+
}
|
|
1626
|
+
export interface V1CreateProductRequest {
|
|
1627
|
+
/** Product to be created */
|
|
1628
|
+
product?: V1Product;
|
|
1629
|
+
variants?: V1Variant[];
|
|
1630
|
+
}
|
|
1631
|
+
/** Variant is the main entity of VariantService that can be used for lorem ipsum dolor */
|
|
1632
|
+
export interface V1Variant {
|
|
1633
|
+
/**
|
|
1634
|
+
* Variant ID
|
|
1635
|
+
* @readonly
|
|
1636
|
+
*/
|
|
1637
|
+
id?: string | null;
|
|
1638
|
+
/**
|
|
1639
|
+
* Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision
|
|
1640
|
+
* @readonly
|
|
1641
|
+
*/
|
|
1642
|
+
revision?: string | null;
|
|
1643
|
+
/**
|
|
1644
|
+
* Represents the time this Variant was created
|
|
1645
|
+
* @readonly
|
|
1646
|
+
*/
|
|
1647
|
+
createdDate?: Date;
|
|
1648
|
+
/**
|
|
1649
|
+
* Represents the time this Variant was last updated
|
|
1650
|
+
* @readonly
|
|
1651
|
+
*/
|
|
1652
|
+
updatedDate?: Date;
|
|
1653
|
+
/** The id of the product this variant is related to */
|
|
1654
|
+
productId?: string;
|
|
1655
|
+
/**
|
|
1656
|
+
* A list of options with a selection of choice per option
|
|
1657
|
+
* In case this list is empty, this is the default variant of an unmanaged product
|
|
1658
|
+
*/
|
|
1659
|
+
choices?: OptionChoice[];
|
|
1660
|
+
/** Variant price */
|
|
1661
|
+
price?: PriceInfo;
|
|
1662
|
+
/** Cost and profit data. Requires admin permissions to read */
|
|
1663
|
+
costAndProfitInfo?: CostAndProfitInfo;
|
|
1664
|
+
/**
|
|
1665
|
+
* Currency code in ISO 4217 format (e.g., USD).
|
|
1666
|
+
* @readonly
|
|
1667
|
+
*/
|
|
1668
|
+
currency?: string;
|
|
1669
|
+
/** Variant SKU (stock keeping unit) */
|
|
1670
|
+
sku?: string | null;
|
|
1671
|
+
/** Variant shipping weight. Allowed only when `product_type` PHYSICAL. */
|
|
1672
|
+
weight?: number | null;
|
|
1673
|
+
/** Whether the variant is visible to customers. Default is true */
|
|
1674
|
+
visible?: boolean | null;
|
|
1675
|
+
/**
|
|
1676
|
+
* Variant inventory stock status, Generated automatically based on InventoryItems of this variant.
|
|
1677
|
+
* @readonly
|
|
1678
|
+
*/
|
|
1679
|
+
inStock?: boolean;
|
|
1680
|
+
/**
|
|
1681
|
+
* Variant name. Generated automatically based on product name and option choice names
|
|
1682
|
+
* @readonly
|
|
1683
|
+
*/
|
|
1684
|
+
name?: string;
|
|
1685
|
+
/**
|
|
1686
|
+
* Product name.
|
|
1687
|
+
* @readonly
|
|
1688
|
+
*/
|
|
1689
|
+
productName?: string;
|
|
1690
|
+
/**
|
|
1691
|
+
* The main media of the product.
|
|
1692
|
+
* @readonly
|
|
1693
|
+
*/
|
|
1694
|
+
media?: CommonImage;
|
|
1695
|
+
/**
|
|
1696
|
+
* Categories that include the product of this variant. Generated automatically based on the product.
|
|
1697
|
+
* @readonly
|
|
1698
|
+
*/
|
|
1699
|
+
categoryIds?: string[];
|
|
1700
|
+
/** Product media overrides. When not empty only these images will be shown for such variant. Otherwise all images of product with `product_id` */
|
|
1701
|
+
mediaOverrides?: PlatformMedia[];
|
|
1702
|
+
/**
|
|
1703
|
+
* Type of related product. Used for validations, for example `weight` cannot be set for DIGITAL type
|
|
1704
|
+
* @readonly
|
|
1705
|
+
*/
|
|
1706
|
+
productType?: V1ProductType;
|
|
1707
|
+
}
|
|
1708
|
+
export interface OptionChoice {
|
|
1709
|
+
/** The id of the option, should be unique per variant */
|
|
1710
|
+
optionId?: string;
|
|
1711
|
+
/** The id of the choice selected for this option, should be a valid choice_id for the selected option */
|
|
1712
|
+
choiceId?: string;
|
|
1713
|
+
/**
|
|
1714
|
+
* Choice name. Generated automatically based on the given choice name
|
|
1715
|
+
* @readonly
|
|
1716
|
+
*/
|
|
1717
|
+
choiceName?: string;
|
|
1718
|
+
}
|
|
1719
|
+
export interface PriceInfo {
|
|
1720
|
+
/** Variant price - value (Decimal), currency, formatted value */
|
|
1721
|
+
value?: FixedMonetaryAmount;
|
|
1722
|
+
/**
|
|
1723
|
+
* Discount data based on the product
|
|
1724
|
+
* @readonly
|
|
1725
|
+
*/
|
|
1726
|
+
discount?: DiscountData;
|
|
1727
|
+
/**
|
|
1728
|
+
* Discounted variant price (if no discounted price is set, the variant price is returned)
|
|
1729
|
+
* @readonly
|
|
1730
|
+
*/
|
|
1731
|
+
discountedPrice?: FixedMonetaryAmount;
|
|
1732
|
+
/** Price per unit info, in order to show price per unit on the product page, for example €4.00 / 100g. Allowed only for `product_type` PHYSICAL */
|
|
1733
|
+
pricePerUnit?: PricePerUnit;
|
|
1734
|
+
}
|
|
1735
|
+
export interface FixedMonetaryAmount {
|
|
1736
|
+
/** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */
|
|
1737
|
+
value?: string;
|
|
1738
|
+
/**
|
|
1739
|
+
* Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative.
|
|
1740
|
+
* For example, €10.00
|
|
1741
|
+
* @readonly
|
|
1742
|
+
*/
|
|
1743
|
+
formattedValue?: string | null;
|
|
1744
|
+
}
|
|
1745
|
+
/** todo: move to variants */
|
|
1746
|
+
export interface DiscountData extends DiscountDataDiscountValueOneOf {
|
|
1747
|
+
/** Discount type: amount / percent */
|
|
1748
|
+
type?: DiscountDataDiscountType;
|
|
1749
|
+
percent?: PercentDiscountValue;
|
|
1750
|
+
amount?: AmountDiscountValue;
|
|
1751
|
+
}
|
|
1752
|
+
/** @oneof */
|
|
1753
|
+
export interface DiscountDataDiscountValueOneOf {
|
|
1754
|
+
percent?: PercentDiscountValue;
|
|
1755
|
+
amount?: AmountDiscountValue;
|
|
1756
|
+
}
|
|
1757
|
+
export declare enum DiscountDataDiscountType {
|
|
1758
|
+
UNDEFINED = "UNDEFINED",
|
|
1759
|
+
/** No discount */
|
|
1760
|
+
NONE = "NONE",
|
|
1761
|
+
/** Fixed amount discount */
|
|
1762
|
+
AMOUNT = "AMOUNT",
|
|
1763
|
+
/** Percentage off discount */
|
|
1764
|
+
PERCENT = "PERCENT"
|
|
1765
|
+
}
|
|
1766
|
+
export interface PercentDiscountValue {
|
|
1767
|
+
/** The percentage value of the discount - from 0 to 100 */
|
|
1768
|
+
value?: number;
|
|
1769
|
+
}
|
|
1770
|
+
export interface AmountDiscountValue {
|
|
1771
|
+
/** The value of the discount - from 0.01 to 999999999.99 */
|
|
1772
|
+
value?: string;
|
|
1773
|
+
}
|
|
1774
|
+
export interface PricePerUnit {
|
|
1775
|
+
/**
|
|
1776
|
+
* Price per unit data for this variant
|
|
1777
|
+
* measurement_unit value must be corresponding to the measurement unit set on the product,
|
|
1778
|
+
* for example if the base measurement unit is Kg. the variants value of total_measurement_unit must be mg, g, or kg
|
|
1779
|
+
*/
|
|
1780
|
+
variantPricePerUnit?: PricePerUnitSettings;
|
|
1781
|
+
/**
|
|
1782
|
+
* Price per unit product settings. Materialized view of the product setting
|
|
1783
|
+
* @readonly
|
|
1784
|
+
*/
|
|
1785
|
+
productPricePerUnit?: PricePerUnitSettings;
|
|
1786
|
+
/**
|
|
1787
|
+
* Price per unit info in the format of variant specific data / product setting, for example €4.00 / 100g
|
|
1788
|
+
* @readonly
|
|
1789
|
+
*/
|
|
1790
|
+
description?: string | null;
|
|
1791
|
+
}
|
|
1792
|
+
export interface CostAndProfitInfo {
|
|
1793
|
+
/** Item cost. */
|
|
1794
|
+
itemCost?: FixedMonetaryAmount;
|
|
1795
|
+
/**
|
|
1796
|
+
* Profit. Calculated by reducing `cost` from `discounted_price`.
|
|
1797
|
+
* @readonly
|
|
1798
|
+
*/
|
|
1799
|
+
profit?: FixedMonetaryAmount;
|
|
1800
|
+
/**
|
|
1801
|
+
* Profit Margin. Calculated by dividing `profit` by `discounted_price`.
|
|
1802
|
+
* The result is rounded to 4 decimal places.
|
|
1803
|
+
* @readonly
|
|
1804
|
+
*/
|
|
1805
|
+
profitMargin?: number;
|
|
1806
|
+
}
|
|
1807
|
+
export interface V1CreateProductResponse {
|
|
1808
|
+
/** The created Product */
|
|
1809
|
+
product?: V1Product;
|
|
1810
|
+
}
|
|
1811
|
+
export interface V1GetProductRequest {
|
|
1812
|
+
/** Id of the Product to retrieve */
|
|
1813
|
+
productId?: string;
|
|
1814
|
+
}
|
|
1815
|
+
export interface V1GetProductResponse {
|
|
1816
|
+
/** The retrieved Product */
|
|
1817
|
+
product?: V1Product;
|
|
1818
|
+
}
|
|
1819
|
+
export interface V1UpdateProductRequest {
|
|
1820
|
+
/** Product to be updated, may be partial */
|
|
1821
|
+
product: V1Product;
|
|
1822
|
+
}
|
|
1823
|
+
export interface V1UpdateProductResponse {
|
|
1824
|
+
/** The updated Product */
|
|
1825
|
+
product?: V1Product;
|
|
1826
|
+
}
|
|
1827
|
+
export interface V1DeleteProductRequest {
|
|
1828
|
+
/** Id of the Product to delete */
|
|
1829
|
+
productId?: string;
|
|
1830
|
+
/** The revision of the Product */
|
|
1831
|
+
revision?: string;
|
|
1832
|
+
}
|
|
1833
|
+
export interface V1DeleteProductResponse {
|
|
1834
|
+
}
|
|
1835
|
+
export interface V1QueryProductsRequest {
|
|
1836
|
+
/** WQL expression */
|
|
1837
|
+
query?: CursorQuery;
|
|
1838
|
+
}
|
|
1839
|
+
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1840
|
+
/**
|
|
1841
|
+
* Filter object in the following format:
|
|
1842
|
+
* `"filter" : {
|
|
1843
|
+
* "fieldName1": "value1",
|
|
1844
|
+
* "fieldName2":{"$operator":"value2"}
|
|
1845
|
+
* }`
|
|
1846
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
1847
|
+
*/
|
|
1848
|
+
filter?: Record<string, any> | null;
|
|
1849
|
+
/**
|
|
1850
|
+
* Sort object in the following format:
|
|
1851
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
1852
|
+
*/
|
|
1853
|
+
sort?: Sorting[];
|
|
1854
|
+
/** 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`. */
|
|
1855
|
+
cursorPaging?: CursorPaging;
|
|
1856
|
+
}
|
|
1857
|
+
/** @oneof */
|
|
1858
|
+
export interface CursorQueryPagingMethodOneOf {
|
|
1859
|
+
/** 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`. */
|
|
1860
|
+
cursorPaging?: CursorPaging;
|
|
1861
|
+
}
|
|
1862
|
+
export interface Sorting {
|
|
1863
|
+
/** Name of the field to sort by. */
|
|
1864
|
+
fieldName?: string;
|
|
1865
|
+
/** Sort order. */
|
|
1866
|
+
order?: SortOrder;
|
|
1867
|
+
}
|
|
1868
|
+
export declare enum SortOrder {
|
|
1869
|
+
ASC = "ASC",
|
|
1870
|
+
DESC = "DESC"
|
|
1871
|
+
}
|
|
1872
|
+
export interface CursorPaging {
|
|
1873
|
+
/** Number of items to load. */
|
|
1874
|
+
limit?: number | null;
|
|
1875
|
+
/**
|
|
1876
|
+
* Pointer to the next or previous page in the list of results.
|
|
1877
|
+
*
|
|
1878
|
+
* You can get the relevant cursor token
|
|
1879
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
1880
|
+
* Not relevant for the first request.
|
|
1881
|
+
*/
|
|
1882
|
+
cursor?: string | null;
|
|
1883
|
+
}
|
|
1884
|
+
export interface V1QueryProductsResponse {
|
|
1885
|
+
/** Products which satisfy the provided query. */
|
|
1886
|
+
products?: V1Product[];
|
|
1887
|
+
/** Paging metadata. Contains cursor which can be used in next query. */
|
|
1888
|
+
metadata?: CursorPagingMetadata;
|
|
1889
|
+
}
|
|
1890
|
+
export interface CursorPagingMetadata {
|
|
1891
|
+
/** Number of items returned in the response. */
|
|
1892
|
+
count?: number | null;
|
|
1893
|
+
/** Offset that was requested. */
|
|
1894
|
+
cursors?: Cursors;
|
|
1895
|
+
/**
|
|
1896
|
+
* Indicates if there are more results after the current page.
|
|
1897
|
+
* If `true`, another page of results can be retrieved.
|
|
1898
|
+
* If `false`, this is the last page.
|
|
1899
|
+
*/
|
|
1900
|
+
hasNext?: boolean | null;
|
|
1901
|
+
}
|
|
1902
|
+
export interface Cursors {
|
|
1903
|
+
/** Cursor pointing to next page in the list of results. */
|
|
1904
|
+
next?: string | null;
|
|
1905
|
+
/** Cursor pointing to previous page in the list of results. */
|
|
1906
|
+
prev?: string | null;
|
|
1907
|
+
}
|
|
1908
|
+
export interface SetProductOptionsRequest {
|
|
1909
|
+
/** Id of the Product to update */
|
|
1910
|
+
productId?: string;
|
|
1911
|
+
/** A list of options with selected choices */
|
|
1912
|
+
optionsWithChoices?: OptionWithChoices[];
|
|
1913
|
+
/** Variants that will be set for this product after the change, will override all existing variants */
|
|
1914
|
+
variants?: V1Variant[];
|
|
1915
|
+
/** The revision of the Product */
|
|
1916
|
+
revision?: string;
|
|
1917
|
+
}
|
|
1918
|
+
export interface OptionWithChoices {
|
|
1919
|
+
/** The id of the option */
|
|
1920
|
+
optionId?: string;
|
|
1921
|
+
/** A list of choice ids to assign the option passed */
|
|
1922
|
+
choiceIds?: string[];
|
|
1923
|
+
/** Indicates if variants should be generated for this option */
|
|
1924
|
+
generateVariants?: boolean;
|
|
1925
|
+
}
|
|
1926
|
+
export interface SetProductOptionsResponse {
|
|
1927
|
+
/** The Product with updated options and choices */
|
|
1928
|
+
product?: V1Product;
|
|
1929
|
+
}
|
|
1930
|
+
export interface AddProductOptionChoicesRequest {
|
|
1931
|
+
/** Id of the Product to update */
|
|
1932
|
+
productId?: string;
|
|
1933
|
+
/** Id of the option to update */
|
|
1934
|
+
optionId?: string;
|
|
1935
|
+
choiceIds?: string[];
|
|
1936
|
+
/** The revision of the Product */
|
|
1937
|
+
revision?: string;
|
|
1938
|
+
}
|
|
1939
|
+
export interface AddProductOptionChoicesResponse {
|
|
1940
|
+
/** The Product with updated options and choices */
|
|
1941
|
+
product?: V1Product;
|
|
1942
|
+
}
|
|
1943
|
+
export interface V1DeleteProductOptionsRequest {
|
|
1944
|
+
/** Id of the Product to update */
|
|
1945
|
+
productId?: string;
|
|
1946
|
+
optionIds?: string[];
|
|
1947
|
+
/** The revision of the Product */
|
|
1948
|
+
revision?: string;
|
|
1949
|
+
}
|
|
1950
|
+
export interface V1DeleteProductOptionsResponse {
|
|
1951
|
+
/** The Product with updated options and choices */
|
|
1952
|
+
product?: V1Product;
|
|
1953
|
+
}
|
|
1954
|
+
export interface DeleteProductOptionChoicesRequest {
|
|
1955
|
+
/** Id of the Product to update */
|
|
1956
|
+
productId?: string;
|
|
1957
|
+
/** Id of the option to update */
|
|
1958
|
+
optionId?: string;
|
|
1959
|
+
choiceIds?: string[];
|
|
1960
|
+
/** The revision of the Product */
|
|
1961
|
+
revision?: string;
|
|
1962
|
+
}
|
|
1963
|
+
export interface DeleteProductOptionChoicesResponse {
|
|
1964
|
+
/** The Product with updated options and choices */
|
|
1965
|
+
product?: V1Product;
|
|
1966
|
+
}
|
|
1967
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1968
|
+
/** random GUID so clients can tell if event was already handled */
|
|
1969
|
+
id?: string;
|
|
1970
|
+
/**
|
|
1971
|
+
* Assumes actions are also always typed to an entity_type
|
|
1972
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1973
|
+
*/
|
|
1974
|
+
entityFqdn?: string;
|
|
1975
|
+
/**
|
|
1976
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1977
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1978
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
1979
|
+
*/
|
|
1980
|
+
slug?: string;
|
|
1981
|
+
/**
|
|
1982
|
+
* Assuming that all messages including Actions have id
|
|
1983
|
+
* Example: The id of the specific order, the id of a specific campaign
|
|
1984
|
+
*/
|
|
1985
|
+
entityId?: string;
|
|
1986
|
+
/** The time of the event. Useful if there was a delay in dispatching */
|
|
1987
|
+
eventTime?: Date;
|
|
1988
|
+
/**
|
|
1989
|
+
* A field that should be set if this event was triggered by an anonymize request.
|
|
1990
|
+
* For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.
|
|
1991
|
+
* NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.
|
|
1992
|
+
*/
|
|
1993
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1994
|
+
/** If present, indicates the action that triggered the event. */
|
|
1995
|
+
originatedFrom?: string | null;
|
|
1996
|
+
/**
|
|
1997
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
1998
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1999
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2000
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2001
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2002
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2003
|
+
*/
|
|
2004
|
+
entityEventSequence?: string | null;
|
|
2005
|
+
createdEvent?: EntityCreatedEvent;
|
|
2006
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2007
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2008
|
+
actionEvent?: ActionEvent;
|
|
2009
|
+
extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
|
|
2010
|
+
}
|
|
2011
|
+
/** @oneof */
|
|
2012
|
+
export interface DomainEventBodyOneOf {
|
|
2013
|
+
createdEvent?: EntityCreatedEvent;
|
|
2014
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2015
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2016
|
+
actionEvent?: ActionEvent;
|
|
2017
|
+
extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
|
|
2018
|
+
}
|
|
2019
|
+
export interface EntityCreatedEvent {
|
|
2020
|
+
entityAsJson?: string;
|
|
2021
|
+
}
|
|
2022
|
+
export interface EntityUpdatedEvent {
|
|
2023
|
+
/**
|
|
2024
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2025
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2026
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2027
|
+
*/
|
|
2028
|
+
currentEntityAsJson?: string;
|
|
2029
|
+
}
|
|
2030
|
+
export interface EntityDeletedEvent {
|
|
2031
|
+
}
|
|
2032
|
+
export interface ActionEvent {
|
|
2033
|
+
bodyAsJson?: string;
|
|
2034
|
+
}
|
|
2035
|
+
export interface ExtendedFieldsUpdatedEvent {
|
|
2036
|
+
currentEntityAsJson?: string;
|
|
2037
|
+
}
|
|
2038
|
+
export interface Empty {
|
|
2039
|
+
}
|
|
1
2040
|
export interface Product {
|
|
2
2041
|
/**
|
|
3
2042
|
* Product ID (generated automatically by the catalog).
|
|
@@ -227,30 +2266,6 @@ export interface PricePerUnitData {
|
|
|
227
2266
|
/** Base measurement unit */
|
|
228
2267
|
baseMeasurementUnit?: MeasurementUnit;
|
|
229
2268
|
}
|
|
230
|
-
export declare enum MeasurementUnit {
|
|
231
|
-
UNSPECIFIED = "UNSPECIFIED",
|
|
232
|
-
ML = "ML",
|
|
233
|
-
CL = "CL",
|
|
234
|
-
L = "L",
|
|
235
|
-
CBM = "CBM",
|
|
236
|
-
MG = "MG",
|
|
237
|
-
G = "G",
|
|
238
|
-
KG = "KG",
|
|
239
|
-
MM = "MM",
|
|
240
|
-
CM = "CM",
|
|
241
|
-
M = "M",
|
|
242
|
-
SQM = "SQM",
|
|
243
|
-
OZ = "OZ",
|
|
244
|
-
LB = "LB",
|
|
245
|
-
FLOZ = "FLOZ",
|
|
246
|
-
PT = "PT",
|
|
247
|
-
QT = "QT",
|
|
248
|
-
GAL = "GAL",
|
|
249
|
-
IN = "IN",
|
|
250
|
-
FT = "FT",
|
|
251
|
-
YD = "YD",
|
|
252
|
-
SQFT = "SQFT"
|
|
253
|
-
}
|
|
254
2269
|
export interface AdditionalInfoSection {
|
|
255
2270
|
/** Product info section title */
|
|
256
2271
|
title?: string;
|
|
@@ -415,56 +2430,6 @@ export interface VariantStock {
|
|
|
415
2430
|
/** Whether the product is currently in stock (relevant only when tracking manually). */
|
|
416
2431
|
inStock?: boolean;
|
|
417
2432
|
}
|
|
418
|
-
/**
|
|
419
|
-
* 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.
|
|
420
|
-
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
421
|
-
* 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.
|
|
422
|
-
*/
|
|
423
|
-
export interface SeoSchema {
|
|
424
|
-
/** SEO tag information. */
|
|
425
|
-
tags?: Tag[];
|
|
426
|
-
/** SEO general settings. */
|
|
427
|
-
settings?: Settings;
|
|
428
|
-
}
|
|
429
|
-
export interface Keyword {
|
|
430
|
-
/** Keyword value. */
|
|
431
|
-
term?: string;
|
|
432
|
-
/** Whether the keyword is the main focus keyword. */
|
|
433
|
-
isMain?: boolean;
|
|
434
|
-
}
|
|
435
|
-
export interface Tag {
|
|
436
|
-
/**
|
|
437
|
-
* SEO tag type.
|
|
438
|
-
*
|
|
439
|
-
*
|
|
440
|
-
* Supported values: `title`, `meta`, `script`, `link`.
|
|
441
|
-
*/
|
|
442
|
-
type?: string;
|
|
443
|
-
/**
|
|
444
|
-
* A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.
|
|
445
|
-
* For example: `{'name': 'description', 'content': 'the description itself'}`.
|
|
446
|
-
*/
|
|
447
|
-
props?: Record<string, any> | null;
|
|
448
|
-
/** SEO tag meta data. For example, `{height: 300, width: 240}`. */
|
|
449
|
-
meta?: Record<string, any> | null;
|
|
450
|
-
/** SEO tag inner content. For example, `<title> inner content </title>`. */
|
|
451
|
-
children?: string;
|
|
452
|
-
/** Whether the tag is a custom tag. */
|
|
453
|
-
custom?: boolean;
|
|
454
|
-
/** Whether the tag is disabled. */
|
|
455
|
-
disabled?: boolean;
|
|
456
|
-
}
|
|
457
|
-
export interface Settings {
|
|
458
|
-
/**
|
|
459
|
-
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
460
|
-
*
|
|
461
|
-
*
|
|
462
|
-
* Default: `false` (Auto Redirect is enabled.)
|
|
463
|
-
*/
|
|
464
|
-
preventAutoRedirect?: boolean;
|
|
465
|
-
/** User-selected keyword terms for a specific page. */
|
|
466
|
-
keywords?: Keyword[];
|
|
467
|
-
}
|
|
468
2433
|
export interface CreateProductRequest {
|
|
469
2434
|
/** Product information. */
|
|
470
2435
|
product?: Product;
|
|
@@ -1017,34 +2982,12 @@ export interface PlatformQueryPagingMethodOneOf {
|
|
|
1017
2982
|
/** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
|
|
1018
2983
|
cursorPaging?: CursorPaging;
|
|
1019
2984
|
}
|
|
1020
|
-
export interface Sorting {
|
|
1021
|
-
/** Name of the field to sort by. */
|
|
1022
|
-
fieldName?: string;
|
|
1023
|
-
/** Sort order. */
|
|
1024
|
-
order?: SortOrder;
|
|
1025
|
-
}
|
|
1026
|
-
export declare enum SortOrder {
|
|
1027
|
-
ASC = "ASC",
|
|
1028
|
-
DESC = "DESC"
|
|
1029
|
-
}
|
|
1030
2985
|
export interface PlatformPaging {
|
|
1031
2986
|
/** Number of items to load. */
|
|
1032
2987
|
limit?: number | null;
|
|
1033
2988
|
/** Number of items to skip in the current sort order. */
|
|
1034
2989
|
offset?: number | null;
|
|
1035
2990
|
}
|
|
1036
|
-
export interface CursorPaging {
|
|
1037
|
-
/** Number of items to load. */
|
|
1038
|
-
limit?: number | null;
|
|
1039
|
-
/**
|
|
1040
|
-
* Pointer to the next or previous page in the list of results.
|
|
1041
|
-
*
|
|
1042
|
-
* You can get the relevant cursor token
|
|
1043
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
1044
|
-
* Not relevant for the first request.
|
|
1045
|
-
*/
|
|
1046
|
-
cursor?: string | null;
|
|
1047
|
-
}
|
|
1048
2991
|
export interface QueryProductsPlatformizedResponse {
|
|
1049
2992
|
products?: Product[];
|
|
1050
2993
|
metadata?: PlatformPagingMetadata;
|
|
@@ -1059,12 +3002,6 @@ export interface PlatformPagingMetadata {
|
|
|
1059
3002
|
/** Cursors to navigate through result pages. Returned if cursor paging was used. */
|
|
1060
3003
|
cursors?: Cursors;
|
|
1061
3004
|
}
|
|
1062
|
-
export interface Cursors {
|
|
1063
|
-
/** Cursor pointing to next page in the list of results. */
|
|
1064
|
-
next?: string | null;
|
|
1065
|
-
/** Cursor pointing to previous page in the list of results. */
|
|
1066
|
-
prev?: string | null;
|
|
1067
|
-
}
|
|
1068
3005
|
export interface QueryProductsWithBigPageLimitRequest {
|
|
1069
3006
|
query?: QueryWithBigPageLimit;
|
|
1070
3007
|
/** Whether variants should be included in the response. */
|
|
@@ -1242,62 +3179,6 @@ export interface StoreVariant {
|
|
|
1242
3179
|
/** Preorder information. */
|
|
1243
3180
|
preorderInfo?: PreorderInfo;
|
|
1244
3181
|
}
|
|
1245
|
-
export interface PlatformMedia extends PlatformMediaMediaOneOf {
|
|
1246
|
-
image?: Image;
|
|
1247
|
-
video?: VideoV2;
|
|
1248
|
-
}
|
|
1249
|
-
/** @oneof */
|
|
1250
|
-
export interface PlatformMediaMediaOneOf {
|
|
1251
|
-
image?: Image;
|
|
1252
|
-
video?: VideoV2;
|
|
1253
|
-
}
|
|
1254
|
-
export interface Image {
|
|
1255
|
-
/** WixMedia image ID. */
|
|
1256
|
-
id?: string;
|
|
1257
|
-
/** Image URL. */
|
|
1258
|
-
url?: string;
|
|
1259
|
-
/**
|
|
1260
|
-
* Original image height.
|
|
1261
|
-
* @readonly
|
|
1262
|
-
*/
|
|
1263
|
-
height?: number;
|
|
1264
|
-
/**
|
|
1265
|
-
* Original image width.
|
|
1266
|
-
* @readonly
|
|
1267
|
-
*/
|
|
1268
|
-
width?: number;
|
|
1269
|
-
/** Image alt text. */
|
|
1270
|
-
altText?: string | null;
|
|
1271
|
-
/**
|
|
1272
|
-
* Image filename.
|
|
1273
|
-
* @readonly
|
|
1274
|
-
*/
|
|
1275
|
-
filename?: string | null;
|
|
1276
|
-
}
|
|
1277
|
-
export interface VideoV2 {
|
|
1278
|
-
/** WixMedia ID. */
|
|
1279
|
-
id?: string;
|
|
1280
|
-
/**
|
|
1281
|
-
* Available resolutions for the video, starting with the optimal resolution.
|
|
1282
|
-
* @readonly
|
|
1283
|
-
*/
|
|
1284
|
-
resolutions?: VideoResolution[];
|
|
1285
|
-
/**
|
|
1286
|
-
* Video filename.
|
|
1287
|
-
* @readonly
|
|
1288
|
-
*/
|
|
1289
|
-
filename?: string | null;
|
|
1290
|
-
}
|
|
1291
|
-
export interface VideoResolution {
|
|
1292
|
-
/** Video URL. */
|
|
1293
|
-
url?: string;
|
|
1294
|
-
/** Video height. */
|
|
1295
|
-
height?: number;
|
|
1296
|
-
/** Video width. */
|
|
1297
|
-
width?: number;
|
|
1298
|
-
/** Video format for example, mp4, hls. */
|
|
1299
|
-
format?: string;
|
|
1300
|
-
}
|
|
1301
3182
|
export interface PreorderInfo {
|
|
1302
3183
|
/** Whether the item is available for preorder. */
|
|
1303
3184
|
enabled?: boolean;
|