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