@wix/ditto-codegen-public 1.0.161 → 1.0.163

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/dist/docs-output/api-docs/bookings-bookings-onBookingCanceled-doc.txt +169 -0
  2. package/dist/docs-output/api-docs/bookings-bookings-onBookingCreated-doc.txt +154 -0
  3. package/dist/docs-output/api-docs/crm-contacts-onContactCreated-doc.txt +87 -171
  4. package/dist/docs-output/api-docs/crm-contacts-onContactDeleted-doc.txt +58 -0
  5. package/dist/docs-output/api-docs/crm-contacts-onContactUpdated-doc.txt +99 -0
  6. package/dist/docs-output/api-docs/data-items-get-doc.txt +95 -54
  7. package/dist/docs-output/api-docs/data-items-insert-doc.txt +235 -43
  8. package/dist/docs-output/api-docs/data-items-onDataItemCreated-doc.txt +61 -0
  9. package/dist/docs-output/api-docs/data-items-onDataItemDeleted-doc.txt +58 -0
  10. package/dist/docs-output/api-docs/data-items-onDataItemUpdated-doc.txt +61 -0
  11. package/dist/docs-output/api-docs/data-items-query-doc.txt +507 -302
  12. package/dist/docs-output/api-docs/data-items-remove-doc.txt +120 -40
  13. package/dist/docs-output/api-docs/data-items-update-doc.txt +425 -46
  14. package/dist/docs-output/api-docs/ecom-cart-addToCart-doc.txt +488 -0
  15. package/dist/docs-output/api-docs/ecom-cart-createCart-doc.txt +518 -0
  16. package/dist/docs-output/api-docs/ecom-cart-createCheckout-doc.txt +155 -0
  17. package/dist/docs-output/api-docs/ecom-cart-deleteCart-doc.txt +92 -0
  18. package/dist/docs-output/api-docs/ecom-cart-getCart-doc.txt +376 -0
  19. package/dist/docs-output/api-docs/ecom-cart-onCartCreated-doc.txt +89 -80
  20. package/dist/docs-output/api-docs/ecom-cart-onCartUpdated-doc.txt +91 -81
  21. package/dist/docs-output/api-docs/ecom-cart-removeLineItemsFromCart-doc.txt +321 -0
  22. package/dist/docs-output/api-docs/ecom-cart-updateCart-doc.txt +539 -0
  23. package/dist/docs-output/api-docs/ecom-checkout-addToCheckout-doc.txt +1005 -0
  24. package/dist/docs-output/api-docs/ecom-checkout-createCheckout-doc.txt +1641 -0
  25. package/dist/docs-output/api-docs/ecom-checkout-getCheckout-doc.txt +1027 -0
  26. package/dist/docs-output/api-docs/ecom-checkout-onCheckoutCompleted-doc.txt +151 -0
  27. package/dist/docs-output/api-docs/ecom-checkout-onCheckoutCreated-doc.txt +150 -0
  28. package/dist/docs-output/api-docs/ecom-checkout-onCheckoutUpdated-doc.txt +150 -0
  29. package/dist/docs-output/api-docs/ecom-checkout-removeLineItemsFromCheckout-doc.txt +879 -0
  30. package/dist/docs-output/api-docs/ecom-checkout-updateCheckout-doc.txt +1011 -0
  31. package/dist/docs-output/api-docs/ecom-currentCart-getCurrentCart-doc.txt +368 -322
  32. package/dist/docs-output/api-docs/ecom-currentCart-updateCurrentCart-doc.txt +506 -321
  33. package/dist/docs-output/api-docs/ecom-orders-bulkUpdateOrders-doc.txt +1040 -0
  34. package/dist/docs-output/api-docs/ecom-orders-cancelOrder-doc.txt +608 -0
  35. package/dist/docs-output/api-docs/ecom-orders-getOrder-doc.txt +926 -0
  36. package/dist/docs-output/api-docs/ecom-orders-onOrderCreated-doc.txt +245 -0
  37. package/dist/docs-output/api-docs/ecom-orders-onOrderUpdated-doc.txt +244 -0
  38. package/dist/docs-output/api-docs/ecom-orders-searchOrders-doc.txt +670 -0
  39. package/dist/docs-output/api-docs/ecom-orders-updateOrder-doc.txt +818 -0
  40. package/dist/docs-output/api-docs/search-wixSiteSearch-search-doc.txt +162 -0
  41. package/dist/docs-output/api-docs/stores-collections-addProductsToCollection-doc.txt +86 -0
  42. package/dist/docs-output/api-docs/stores-collections-createCollection-doc.txt +108 -0
  43. package/dist/docs-output/api-docs/stores-collections-getCollection-doc.txt +102 -0
  44. package/dist/docs-output/api-docs/stores-collections-queryCollections-doc.txt +209 -0
  45. package/dist/docs-output/api-docs/stores-collections-removeProductsFromCollection-doc.txt +86 -0
  46. package/dist/docs-output/api-docs/stores-collections-updateCollection-doc.txt +110 -0
  47. package/dist/docs-output/api-docs/stores-inventory-queryInventory-doc.txt +98 -0
  48. package/dist/docs-output/api-docs/stores-inventory-updateInventoryVariants-doc.txt +249 -0
  49. package/dist/docs-output/api-docs/stores-inventoryItemsV3-queryInventoryItems-doc.txt +236 -0
  50. package/dist/docs-output/api-docs/stores-inventoryItemsV3-updateInventoryItem-doc.txt +139 -0
  51. package/dist/docs-output/api-docs/stores-productsV3-createProduct-doc.txt +1697 -0
  52. package/dist/docs-output/api-docs/stores-productsV3-deleteProduct-doc.txt +73 -0
  53. package/dist/docs-output/api-docs/stores-productsV3-getProduct-doc.txt +933 -0
  54. package/dist/docs-output/api-docs/stores-productsV3-onProductCreated-doc.txt +794 -0
  55. package/dist/docs-output/api-docs/stores-productsV3-onProductDeleted-doc.txt +794 -0
  56. package/dist/docs-output/api-docs/stores-productsV3-onProductUpdated-doc.txt +794 -0
  57. package/dist/docs-output/api-docs/stores-productsV3-queryProducts-doc.txt +1051 -0
  58. package/dist/docs-output/api-docs/stores-productsV3-searchProducts-doc.txt +1144 -0
  59. package/dist/docs-output/api-docs/stores-productsV3-updateProduct-doc.txt +1730 -1600
  60. package/dist/docs-output/api-docs/stores-readOnlyVariantsV3-queryVariants-doc.txt +290 -0
  61. package/dist/docs-output/api-docs/stores-readOnlyVariantsV3-searchVariants-doc.txt +353 -0
  62. package/dist/out.js +929 -79
  63. package/package.json +2 -2
  64. package/dist/docs-output/api-docs/data-items-onDataItemCreated.txt +0 -103
  65. package/dist/docs-output/api-docs/stores-product-onProductCreated-doc.txt +0 -118
  66. package/dist/docs-output/api-docs/stores-productV3-onProductCreated-doc.txt +0 -184
@@ -0,0 +1,794 @@
1
+ <stores_productsV3_onProductCreated>
2
+ <description>
3
+ # This is a Webhook method
4
+
5
+ # Method name:
6
+
7
+ stores.productsV3.onProductCreated(handler: OnProductCreatedHandler)
8
+
9
+ # Method Link:
10
+
11
+ https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/products-v3/on-product-created
12
+
13
+ # Method Description:
14
+
15
+ undefined
16
+
17
+
18
+ </description>
19
+ <usage>
20
+ import { productsV3 } from "@wix/stores";
21
+
22
+ productsV3.onProductCreated((event) => {
23
+ // handle your event here
24
+ });
25
+
26
+ </usage>
27
+ <type_definition>
28
+ ```
29
+ Method: stores.productsV3.onProductCreated(handler)
30
+ Description: none
31
+ Method parameters:
32
+ param name: handler | type: OnProductCreatedHandler | description: none
33
+ - name: event | type: ProductCreatedEnvelope | description: none
34
+ - name: entity | type: V3Product | description: none
35
+ - name: brand | type: Brand | description: Product brand. + Pass `brand.name` to add a new brand while creating a product. + Pass an existing brand's `id` to assign that brand to the product.
36
+ - name: _id | type: string | description: Brand GUID.
37
+ - name: name | type: string | description: Brand name.
38
+ - name: description | type: RichContent | description: Product description using rich content. > **Note:** Returned only when you pass `"DESCRIPTION"` to the `fields` array in Products API requests. <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="indent.emoji.divider.codeBlock.file.gallery.giphy.image.table.link.textHighlight.textColor" exampleid="7dc9240e-d548-417a-abcf-0291b68b4303"> <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a> </widget>
39
+ - name: documentStyle | type: DocumentStyle | description: Global styling for header, paragraph, block quote, and code block nodes in the object.
40
+ - name: blockquote | type: TextNodeStyle | description: Styling for block quote nodes.
41
+ - name: decorations | type: Array<Decoration> | description: The decorations to apply to the node.
42
+ - name: type | type: DecorationType | description: The type of decoration to apply.
43
+ enum: ANCHOR, BOLD, COLOR, EXTERNAL, FONT_FAMILY, FONT_SIZE, ITALIC, LINK, MENTION, SPOILER, STRIKETHROUGH, SUBSCRIPT, SUPERSCRIPT, UNDERLINE
44
+ - ONE-OF:
45
+ - name: anchorData | type: AnchorData | description: Data for an anchor link decoration.
46
+ - name: anchor | type: string | description: The target node's GUID.
47
+ - name: colorData | type: ColorData | description: Data for a color decoration.
48
+ - name: background | type: string | description: The text's background color as a hexadecimal value.
49
+ - name: foreground | type: string | description: The text's foreground color as a hexadecimal value.
50
+ - name: fontFamilyData | type: FontFamilyData | description: Data for a font family decoration.
51
+ - name: value | type: string | description: none
52
+ - name: fontSizeData | type: FontSizeData | description: Data for a font size decoration.
53
+ - name: unit | type: FontType | description: The units used for the font size.
54
+ enum: EM, PX
55
+ - name: value | type: number | description: Font size value.
56
+ - name: fontWeightValue | type: number | description: Font weight for a bold decoration.
57
+ - name: italicData | type: boolean | description: Data for an italic decoration. Defaults to `true`.
58
+ - name: linkData | type: LinkData | description: Data for an external link decoration.
59
+ - name: link | type: Link | description: Link details.
60
+ - name: customData | type: string | description: A serialized object used for a custom or external link panel.
61
+ - name: rel | type: Rel | description: The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document.
62
+ - name: nofollow | type: boolean | description: Indicates to search engine crawlers not to follow the link. Defaults to `false`.
63
+ - name: noreferrer | type: boolean | description: Indicates that this link protect referral information from being passed to the target website.
64
+ - name: sponsored | type: boolean | description: Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`.
65
+ - name: ugc | type: boolean | description: Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`.
66
+ - name: target | type: Target | description: he HTML `target` attribute value for the link. This property defines where the linked document opens as follows: `SELF` - Default. Opens the linked document in the same frame as the link. `BLANK` - Opens the linked document in a new browser tab or window. `PARENT` - Opens the linked document in the link's parent frame. `TOP` - Opens the linked document in the full body of the link's browser tab or window.
67
+ enum:
68
+ BLANK: Opens the linked document in a new window or tab
69
+ PARENT: Opens the linked document in the parent frame
70
+ SELF: Opens the linked document in the same frame as it was clicked (this is default)
71
+ TOP: Opens the linked document in the full body of the window
72
+ - ONE-OF:
73
+ - name: anchor | type: string | description: The target node's GUID. Used for linking to another node in this object.
74
+ - name: url | type: string | description: The absolute URL for the linked document.
75
+ - name: mentionData | type: MentionData | description: Data for a mention decoration.
76
+ - name: id | type: string | description: Mentioned user's GUID.
77
+ - name: name | type: string | description: The mentioned user's name.
78
+ - name: slug | type: string | description: The version of the user's name that appears after the `@` character in the mention.
79
+ - name: spoilerData | type: SpoilerData | description: Data for a spoiler decoration.
80
+ - name: id | type: string | description: Spoiler GUID.
81
+ - name: strikethroughData | type: boolean | description: Data for a strikethrough decoration. Defaults to `true`.
82
+ - name: subscriptData | type: boolean | description: Data for a subscript decoration. Defaults to `true`.
83
+ - name: superscriptData | type: boolean | description: Data for a superscript decoration. Defaults to `true`.
84
+ - name: underlineData | type: boolean | description: Data for an underline decoration. Defaults to `true`.
85
+ - name: lineHeight | type: string | description: Line height for text in the node.
86
+ - name: nodeStyle | type: NodeStyle | description: Padding and background color for the node.
87
+ - name: backgroundColor | type: string | description: The background color as a hexadecimal value.
88
+ - name: paddingBottom | type: string | description: The bottom padding value in pixels.
89
+ - name: paddingTop | type: string | description: The top padding value in pixels.
90
+ - name: codeBlock | type: TextNodeStyle | description: Styling for code block nodes.
91
+ - name: headerFive | type: TextNodeStyle | description: Styling for H5 nodes.
92
+ - name: headerFour | type: TextNodeStyle | description: Styling for H4 nodes.
93
+ - name: headerOne | type: TextNodeStyle | description: Styling for H1 nodes.
94
+ - name: headerSix | type: TextNodeStyle | description: Styling for H6 nodes.
95
+ - name: headerThree | type: TextNodeStyle | description: Styling for H3 nodes.
96
+ - name: headerTwo | type: TextNodeStyle | description: Styling for H2 nodes.
97
+ - name: paragraph | type: TextNodeStyle | description: Styling for paragraph nodes.
98
+ - name: metadata | type: Metadata | description: Object metadata.
99
+ - name: _id | type: string | description: Object GUID.
100
+ - name: version | type: number | description: Schema version.
101
+ - name: nodes | type: Array<Node> | description: Node objects representing a rich content document.
102
+ - name: id | type: string | description: Node GUID.
103
+ - name: nodes | type: Array<Node> | description: A list of child nodes.
104
+ - name: style | type: NodeStyle | description: Padding and background color styling for the node.
105
+ - name: type | type: NodeType | description: 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.
106
+ enum: APP_EMBED, AUDIO, BLOCKQUOTE, BULLETED_LIST, BUTTON, CAPTION, CODE_BLOCK, COLLAPSIBLE_ITEM, COLLAPSIBLE_ITEM_BODY, COLLAPSIBLE_ITEM_TITLE, COLLAPSIBLE_LIST, DIVIDER, EMBED, EXTERNAL, FILE, GALLERY, GIF, HEADING, HTML, IMAGE, LAYOUT, LAYOUT_CELL, LINK_PREVIEW, LIST_ITEM, MAP, ORDERED_LIST, PARAGRAPH, POLL, TABLE, TABLE_CELL, TABLE_ROW, TEXT, VIDEO
107
+ - ONE-OF:
108
+ - name: appEmbedData | type: AppEmbedData | description: Data for an app embed node.
109
+ - name: buttonStyles | type: ButtonStyles | description: Button styling options.
110
+ - name: backgroundColor | type: string | description: Background color as a hexadecimal value.
111
+ - name: backgroundColorHover | type: string | description: Background color as a hexadecimal value (hover state).
112
+ - name: borderColor | type: string | description: Border color as a hexadecimal value.
113
+ - name: borderColorHover | type: string | description: Border color as a hexadecimal value (hover state).
114
+ - name: borderRadius | type: number | description: Border radius in pixels.
115
+ - name: borderWidth | type: number | description: Border width in pixels.
116
+ - name: buttonSize | type: string | description: Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`.
117
+ - name: buttonText | type: string | description: Text to display on the button.
118
+ - name: textColor | type: string | description: Text color as a hexadecimal value.
119
+ - name: textColorHover | type: string | description: Text color as a hexadecimal value (hover state).
120
+ - name: cardStyles | type: CardStyles | description: Card styling options.
121
+ - name: alignment | type: Alignment | description: Content alignment. Defaults to `START`.
122
+ enum:
123
+ CENTER: Content centered
124
+ END: Content aligned to end (right in LTR layouts, left in RTL layouts)
125
+ START: Content aligned to start (left in LTR layouts, right in RTL layouts)
126
+ - name: backgroundColor | type: string | description: Card background color as a hexadecimal value.
127
+ - name: borderColor | type: string | description: Card border color as a hexadecimal value.
128
+ - name: borderRadius | type: number | description: Card border radius in pixels.
129
+ - name: borderWidth | type: number | description: Card border width in pixels.
130
+ - name: textColor | type: string | description: Text color as a hexadecimal value.
131
+ - name: titleColor | type: string | description: Title text color as a hexadecimal value.
132
+ - name: titlePriceLayout | type: Layout | description: Layout for title and price. Defaults to `STACKED`.
133
+ enum:
134
+ SIDE_BY_SIDE: Elements arranged horizontally
135
+ STACKED: Elements stacked vertically
136
+ - name: type | type: Type | description: Card type. Defaults to `CONTAINED`.
137
+ enum:
138
+ CONTAINED: Card with visible border and background
139
+ FRAMELESS: Card without visible border
140
+ - name: containerData | type: PluginContainerData | description: Styling for the app embed's container.
141
+ - name: alignment | type: PluginContainerDataAlignment | description: The node's alignment within its container.
142
+ enum:
143
+ CENTER: Center Alignment
144
+ LEFT: Left Alignment
145
+ RIGHT: Right Alignment
146
+ - name: height | type: Height | description: The height of the node when it's displayed.
147
+ - name: custom | type: string | description: A custom height value in pixels.
148
+ - name: spoiler | type: Spoiler | description: Spoiler cover settings for the node.
149
+ - name: buttonText | type: string | description: The text for the button used to remove the spoiler cover.
150
+ - name: description | type: string | description: The description displayed on top of the spoiler cover.
151
+ - name: enabled | type: boolean | description: Sets whether the spoiler cover is enabled for this node. Defaults to `false`.
152
+ - name: textWrap | type: boolean | description: Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`.
153
+ - name: width | type: PluginContainerDataWidth | description: The width of the node when it's displayed.
154
+ - ONE-OF:
155
+ - name: custom | type: string | description: A custom width value in pixels.
156
+ - name: size | type: WidthType | description: One of the following predefined width options: `CONTENT`: The width of the container matches the content width. `SMALL`: A small width. `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width. `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
157
+ enum:
158
+ CONTENT: Width matches the content width
159
+ FULL_WIDTH: coast-to-coast display
160
+ ORIGINAL: Width will match the original asset width
161
+ SMALL: Small Width
162
+ - name: hideButton | type: boolean | description: Whether to hide the button.
163
+ - name: hideDateTime | type: boolean | description: Whether to hide the date and time (Event).
164
+ - name: hideDescription | type: boolean | description: Whether to hide the description (Event and Booking).
165
+ - name: hideDuration | type: boolean | description: Whether to hide the duration (Booking).
166
+ - name: hideImage | type: boolean | description: Whether to hide the image.
167
+ - name: hideLocation | type: boolean | description: Whether to hide the location (Event).
168
+ - name: hidePrice | type: boolean | description: Whether to hide the price.
169
+ - name: hideRibbon | type: boolean | description: Whether to hide the ribbon.
170
+ - name: hideTitle | type: boolean | description: Whether to hide the title.
171
+ - name: image | type: V1Media | description: An image for the embedded content.
172
+ - name: duration | type: number | description: Media duration in seconds. Only relevant for audio and video files.
173
+ - name: height | type: number | description: Media height in pixels.
174
+ - name: src | type: FileSource | description: The source for the media's data.
175
+ - name: private | type: boolean | description: Indicates whether the file's source is private. Defaults to `false`.
176
+ - ONE-OF:
177
+ - name: custom | type: string | description: Custom GUID. Use `id` instead.
178
+ - name: id | type: string | description: An GUID that's resolved to a URL by a resolver function.
179
+ - name: url | type: string | description: The absolute URL for the file's source.
180
+ - name: width | type: number | description: Media width in pixels.
181
+ - name: imageStyles | type: ImageStyles | description: Image styling options.
182
+ - name: aspectRatio | type: AspectRatio | description: Aspect ratio for the image. Defaults to `SQUARE`.
183
+ enum:
184
+ RECTANGLE: 16:9 aspect ratio
185
+ SQUARE: 1:1 aspect ratio
186
+ - name: borderColor | type: string | description: Image border color as a hexadecimal value.
187
+ - name: borderRadius | type: number | description: Image border radius in pixels.
188
+ - name: borderWidth | type: number | description: Image border width in pixels.
189
+ - name: hideImage | type: boolean | description: Whether to hide the image.
190
+ - name: imagePosition | type: Position | description: Position of image. Defaults to `START`.
191
+ enum:
192
+ END: Image positioned at the end (right in LTR layouts, left in RTL layouts)
193
+ START: Image positioned at the start (left in LTR layouts, right in RTL layouts)
194
+ TOP: Image positioned at the top
195
+ - name: resizing | type: Resizing | description: How the image should be resized. Defaults to `FILL`.
196
+ enum:
197
+ FILL: Fill the container, may crop the image
198
+ FIT: Fit the image within the container
199
+ - name: itemId | type: string | description: The GUID of the embedded content.
200
+ - name: name | type: string | description: The name of the embedded content.
201
+ - name: pricingData | type: PricingData | description: Pricing data for embedded Wix App content.
202
+ - name: currency | type: string | description: Currency of the value in ISO 4217 format (e.g., "USD", "EUR").
203
+ - name: discountedValue | type: string | description: Numeric price value as string after discount application (e.g., "15.99").
204
+ - name: pricingPlanId | type: string | description: Pricing plan GUID.
205
+ - name: valueFrom | type: string | description: Minimum numeric price value as string (e.g., "10.99").
206
+ - name: valueTo | type: string | description: Maximum numeric price value as string (e.g., "19.99").
207
+ - name: ribbonStyles | type: RibbonStyles | description: Ribbon styling options.
208
+ - name: backgroundColor | type: string | description: Ribbon background color as a hexadecimal value.
209
+ - name: borderColor | type: string | description: Ribbon border color as a hexadecimal value.
210
+ - name: borderRadius | type: number | description: Ribbon border radius in pixels.
211
+ - name: borderWidth | type: number | description: Ribbon border width in pixels.
212
+ - name: ribbonPlacement | type: Placement | description: Placement of the ribbon. Defaults to `IMAGE`.
213
+ enum:
214
+ IMAGE: Ribbon placed on the image
215
+ PRODUCT_INFO: Ribbon placed on the product information
216
+ - name: ribbonText | type: string | description: Text to display on the ribbon.
217
+ - name: textColor | type: string | description: Ribbon text color as a hexadecimal value.
218
+ - name: type | type: AppType | description: The type of Wix App content being embedded.
219
+ enum: BOOKING, EVENT, PRODUCT
220
+ - name: url | type: string | description: The URL for the embedded content.
221
+ - ONE-OF:
222
+ - name: bookingData | type: BookingData | description: Data for embedded Wix Bookings content.
223
+ - name: durations | type: string | description: Booking duration in minutes.
224
+ - name: eventData | type: EventData | description: Data for embedded Wix Events content.
225
+ - name: location | type: string | description: Event location.
226
+ - name: scheduling | type: string | description: Event schedule.
227
+ - name: audioData | type: AudioData | description: Data for an audio node.
228
+ - name: audio | type: V1Media | description: Audio file details.
229
+ - name: authorName | type: string | description: Author name.
230
+ - name: containerData | type: PluginContainerData | description: Styling for the audio node's container.
231
+ - name: coverImage | type: V1Media | description: Cover image.
232
+ - name: disableDownload | type: boolean | description: Sets whether the audio node's download button is disabled. Defaults to `false`.
233
+ - name: html | type: string | description: An HTML version of the audio node.
234
+ - name: name | type: string | description: Track name.
235
+ - name: blockquoteData | type: BlockquoteData | description: Data for a block quote node.
236
+ - name: indentation | type: number | description: Indentation level from 1-4.
237
+ - name: bulletedListData | type: BulletedListData | description: Data for a bulleted list node.
238
+ - name: indentation | type: number | description: Indentation level from 0-4.
239
+ - name: offset | type: number | description: Offset level from 0-4.
240
+ - name: buttonData | type: ButtonData | description: Data for a button node.
241
+ - name: containerData | type: PluginContainerData | description: Styling for the button's container.
242
+ - name: link | type: Link | description: Button link details.
243
+ - name: styles | type: Styles | description: Styling for the button.
244
+ - name: backgroundColor | type: string | description: Background color as a hexadecimal value.
245
+ - name: backgroundColorHover | type: string | description: Background color as a hexadecimal value (hover state).
246
+ - name: borderColor | type: string | description: Border color as a hexadecimal value.
247
+ - name: borderColorHover | type: string | description: Border color as a hexadecimal value (hover state).
248
+ - name: borderRadius | type: number | description: Border radius in pixels.
249
+ - name: borderWidth | type: number | description: Border width in pixels.
250
+ - name: buttonSize | type: string | description: Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`.
251
+ - name: textColor | type: string | description: Text color as a hexadecimal value.
252
+ - name: textColorHover | type: string | description: Text color as a hexadecimal value (hover state).
253
+ - name: text | type: string | description: The text to display on the button.
254
+ - name: type | type: ButtonDataType | description: The button type.
255
+ enum:
256
+ ACTION: Triggers custom action that is defined in plugin configuration by the consumer
257
+ LINK: Regular link button
258
+ - name: captionData | type: CaptionData | description: Data for a caption node.
259
+ - name: textStyle | type: TextStyle | description: none
260
+ - name: lineHeight | type: string | description: A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px.
261
+ - name: textAlignment | type: TextAlignment | description: Text alignment. Defaults to `AUTO`.
262
+ enum:
263
+ AUTO: browser default, eqivalent to `initial`
264
+ CENTER: Center align
265
+ JUSTIFY: 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
266
+ LEFT: Left align
267
+ RIGHT: Right align
268
+ - name: codeBlockData | type: CodeBlockData | description: Data for a code block node.
269
+ - name: textStyle | type: TextStyle | description: Styling for the code block's text.
270
+ - name: collapsibleListData | type: CollapsibleListData | description: Data for a collapsible list node.
271
+ - name: containerData | type: PluginContainerData | description: Styling for the collapsible list's container.
272
+ - name: direction | type: Direction | description: The direction of the text in the list. Either left-to-right or right-to-left.
273
+ enum:
274
+ LTR: Left-to-right
275
+ RTL: Right-to-left
276
+ - name: expandOnlyOne | type: boolean | description: If `true`, only one item can be expanded at a time. Defaults to `false`.
277
+ - name: initialExpandedItems | type: InitialExpandedItems | description: Sets which items are expanded when the page loads.
278
+ enum:
279
+ ALL: All items will expended initally
280
+ FIRST: First item will be expended initally
281
+ NONE: All items collapsed initally
282
+ - name: isQapageData | type: boolean | description: If `true`, The collapsible item will appear in search results as an FAQ.
283
+ - name: dividerData | type: DividerData | description: Data for a divider node.
284
+ - name: alignment | type: DividerDataAlignment | description: Divider alignment.
285
+ enum:
286
+ CENTER: Center alignment
287
+ LEFT: Left alignment
288
+ RIGHT: Right alignment
289
+ - name: containerData | type: PluginContainerData | description: Styling for the divider's container.
290
+ - name: lineStyle | type: LineStyle | description: Divider line style.
291
+ enum:
292
+ DASHED: Dashed Line
293
+ DOTTED: Dotted Line
294
+ DOUBLE: Double Line
295
+ SINGLE: Single Line
296
+ - name: width | type: Width | description: Divider width.
297
+ enum:
298
+ LARGE: Large line
299
+ MEDIUM: Medium line
300
+ SMALL: Small line
301
+ - name: embedData | type: EmbedData | description: Data for an oEmbed node.
302
+ - name: containerData | type: PluginContainerData | description: Styling for the oEmbed node's container.
303
+ - name: oembed | type: Oembed | description: An [oEmbed](https://www.oembed.com) object.
304
+ - name: authorName | type: string | description: The name of the author or owner of the resource.
305
+ - name: authorUrl | type: string | description: The URL for the author or owner of the resource.
306
+ - name: height | type: number | description: The height of the resource specified in the `url` property in pixels.
307
+ - name: html | type: string | description: HTML for embedding a video player. The HTML should have no padding or margins.
308
+ - name: providerName | type: string | description: The name of the resource provider.
309
+ - name: providerUrl | type: string | description: The URL for the resource provider.
310
+ - name: thumbnailHeight | type: string | description: The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined.
311
+ - name: thumbnailUrl | type: string | description: The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined.
312
+ - name: thumbnailWidth | type: string | description: The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined.
313
+ - name: title | type: string | description: Resource title.
314
+ - name: type | type: string | description: The resource type.
315
+ - name: url | type: string | description: The source URL for the resource.
316
+ - name: version | type: string | description: The oEmbed version number. This value must be `1.0`.
317
+ - name: videoUrl | type: string | description: The URL for an embedded viedo.
318
+ - name: width | type: number | description: The width of the resource specified in the `url` property in pixels.
319
+ - name: src | type: string | description: Origin asset source.
320
+ - name: externalData | type: Record<string, any> | description: Data for a custom external node.
321
+ - name: fileData | type: FileData | description: Data for a file node.
322
+ - name: containerData | type: PluginContainerData | description: Styling for the file's container.
323
+ - name: mimeType | type: string | description: File MIME type.
324
+ - name: name | type: string | description: File name.
325
+ - name: path | type: string | description: File path.
326
+ - name: pdfSettings | type: PDFSettings | description: Settings for PDF files.
327
+ - name: disableDownload | type: boolean | description: Sets whether the PDF download button is disabled. Defaults to `false`.
328
+ - name: disablePrint | type: boolean | description: Sets whether the PDF print button is disabled. Defaults to `false`.
329
+ - name: viewMode | type: ViewMode | description: PDF view mode. One of the following: `NONE` : The PDF isn't displayed. `FULL` : A full page view of the PDF is displayed. `MINI` : A mini view of the PDF is displayed.
330
+ enum:
331
+ FULL: Full PDF view
332
+ MINI: Mini PDF view
333
+ NONE: No PDF view
334
+ - name: sizeInKb | type: string | description: File size in KB.
335
+ - name: src | type: FileSource | description: The source for the file's data.
336
+ - name: type | type: string | description: File type.
337
+ - name: galleryData | type: GalleryData | description: Data for a gallery node.
338
+ - name: containerData | type: PluginContainerData | description: Styling for the gallery's container.
339
+ - name: disableDownload | type: boolean | description: Sets whether the gallery's download button is disabled. Defaults to `false`.
340
+ - name: disableExpand | type: boolean | description: Sets whether the gallery's expand button is disabled. Defaults to `false`.
341
+ - name: items | type: Array<Item> | description: The items in the gallery.
342
+ - name: altText | type: string | description: Item's alternative text.
343
+ - name: title | type: string | description: Item title.
344
+ - ONE-OF:
345
+ - name: image | type: Image | description: An image item.
346
+ - name: link | type: Link | description: Link details for images that are links.
347
+ - name: media | type: V1Media | description: Image file details.
348
+ - name: video | type: Video | description: A video item.
349
+ - name: media | type: V1Media | description: Video file details.
350
+ - name: thumbnail | type: V1Media | description: Video thumbnail file details.
351
+ - name: options | type: GalleryOptions | description: Options for defining the gallery's appearance.
352
+ - name: item | type: ItemStyle | description: Styling for gallery items.
353
+ - name: crop | type: Crop | description: Sets how item images are cropped.
354
+ enum:
355
+ FILL: Crop to fill
356
+ FIT: Crop to fit
357
+ - name: ratio | type: number | description: Item ratio
358
+ - name: spacing | type: number | description: The spacing between items in pixels.
359
+ - name: targetSize | type: number | description: Desirable dimension for each item in pixels (behvaior changes according to gallery type)
360
+ - name: layout | type: GalleryOptionsLayout | description: Gallery layout.
361
+ - name: horizontalScroll | type: boolean | description: Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`.
362
+ - name: mobileNumberOfColumns | type: number | description: The number of columns to display on mobile screens.
363
+ - name: numberOfColumns | type: number | description: The number of columns to display on full size screens.
364
+ - name: orientation | type: Orientation | description: Gallery orientation.
365
+ enum:
366
+ COLUMNS: Columns Orientation
367
+ ROWS: Rows Orientation
368
+ - name: type | type: LayoutType | description: Gallery layout type.
369
+ enum:
370
+ COLLAGE: Collage type
371
+ COLUMN: Column type
372
+ FULLSIZE: Fullsize images type
373
+ GRID: Grid type
374
+ MAGIC: Magic type
375
+ MASONRY: Masonry type
376
+ PANORAMA: Panorama type
377
+ SLIDER: Slider type
378
+ SLIDESHOW: Slideshow type
379
+ THUMBNAIL: Thumbnail type
380
+ - name: thumbnails | type: Thumbnails | description: Styling for gallery thumbnail images.
381
+ - name: placement | type: ThumbnailsAlignment | description: Thumbnail alignment.
382
+ enum:
383
+ BOTTOM: Bottom alignment
384
+ LEFT: Left alignment
385
+ NONE: No thumbnail
386
+ RIGHT: Right alignment
387
+ TOP: Top alignment
388
+ - name: spacing | type: number | description: Spacing between thumbnails in pixels.
389
+ - name: gifData | type: GIFData | description: Data for a GIF node.
390
+ - name: containerData | type: PluginContainerData | description: Styling for the GIF's container.
391
+ - name: downsized | type: GIF | description: The source of the downsized GIF.
392
+ - name: gif | type: string | description: GIF format URL.
393
+ - name: mp4 | type: string | description: MP4 format URL.
394
+ - name: still | type: string | description: Thumbnail URL.
395
+ - name: gifType | type: GIFType | description: Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`.
396
+ enum: NORMAL, STICKER
397
+ - name: height | type: number | description: Height in pixels.
398
+ - name: original | type: GIF | description: The source of the full size GIF.
399
+ - name: width | type: number | description: Width in pixels.
400
+ - name: headingData | type: HeadingData | description: Data for a heading node.
401
+ - name: indentation | type: number | description: Indentation level from 1-4.
402
+ - name: level | type: number | description: Heading level from 1-6.
403
+ - name: textStyle | type: TextStyle | description: Styling for the heading text.
404
+ - name: htmlData | type: HTMLData | description: Data for an embedded HTML node.
405
+ - name: autoHeight | type: boolean | description: If container height is aligned with its content height. Defaults to `true`.
406
+ - name: containerData | type: PluginContainerData | description: Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`.
407
+ - name: source | type: Source | description: The type of HTML code.
408
+ enum: ADSENSE, AI, HTML
409
+ - ONE-OF:
410
+ - name: html | type: string | description: The HTML code for the node.
411
+ - name: isAdsense | type: boolean | description: Whether this is an AdSense element. Use `source` instead.
412
+ - name: url | type: string | description: The URL for the HTML code for the node.
413
+ - name: imageData | type: ImageData | description: Data for an image node.
414
+ - name: altText | type: string | description: Image's alternative text.
415
+ - name: containerData | type: PluginContainerData | description: Styling for the image's container.
416
+ - name: decorative | type: boolean | description: Sets whether the image is decorative and does not need an explanation. Defaults to `false`.
417
+ - name: disableDownload | type: boolean | description: Sets whether the image's download button is disabled. Defaults to `false`.
418
+ - name: disableExpand | type: boolean | description: Sets whether the image expands to full screen when clicked. Defaults to `false`.
419
+ - name: image | type: V1Media | description: Image file details.
420
+ - name: link | type: Link | description: Link details for images that are links.
421
+ - name: styles | type: ImageDataStyles | description: Styling for the image.
422
+ - name: border | type: StylesBorder | description: Border attributes.
423
+ - name: color | type: string | description: Border color as a hexadecimal value.
424
+ - name: radius | type: number | description: Border radius in pixels.
425
+ - name: width | type: number | description: Border width in pixels.
426
+ - name: layoutCellData | type: LayoutCellData | description: Data for a cell node.
427
+ - name: colSpan | type: number | description: Size of the cell in 12 columns grid.
428
+ - name: layoutData | type: LayoutData | description: Data for a layout node. Reserved for future use.
429
+ - name: backdropColor | type: string | description: Backdrop color as a hexadecimal value.
430
+ - name: backdropImage | type: BackgroundImage | description: Backdrop image.radius in pixels.
431
+ - name: media | type: V1Media | description: Background image.
432
+ - name: opacity | type: number | description: Background image opacity.
433
+ - name: position | type: ImagePosition | description: Position of background. Defaults to `CENTER`.
434
+ enum:
435
+ BOTTOM: Image positioned at the center bottom
436
+ BOTTOM_LEFT: Image positioned at the bottom left
437
+ BOTTOM_RIGHT: Image positioned at the bottom right
438
+ CENTER: Image positioned at the center
439
+ CENTER_LEFT: Image positioned on the left
440
+ CENTER_RIGHT: Image positioned on the right
441
+ TOP: Image positioned at the center top
442
+ TOP_LEFT: Image positioned at the top left
443
+ TOP_RIGHT: Image positioned at the top right
444
+ - name: scaling | type: Scaling | description: Background image scaling.
445
+ enum:
446
+ AUTO: Auto image scaling
447
+ CONTAIN: Contain image scaling
448
+ COVER: Cover image scaling
449
+ - name: backdropPaddingBottom | type: number | description: Backdrop bottom padding
450
+ - name: backdropPaddingTop | type: number | description: Backdrop top padding.
451
+ - name: backgroundColor | type: string | description: Background color as a hexadecimal value.
452
+ - name: backgroundImage | type: BackgroundImage | description: Background image.
453
+ - name: borderColor | type: string | description: Border color as a hexadecimal value.
454
+ - name: borderRadius | type: number | description: Border
455
+ - name: borderWidth | type: number | description: Border width in pixels.
456
+ - name: cellPadding | type: Array<number> | description: Padding in pixels for cells. Follows CSS order: top, right, bottom, left
457
+ - name: cellVerticalAlignment | type: VerticalAlignmentAlignment | description: Vertical alignment for the cell's items.
458
+ enum:
459
+ BOTTOM: Bottom alignment
460
+ MIDDLE: Middle alignment
461
+ TOP: Top alignment
462
+ - name: containerData | type: PluginContainerData | description: Styling for the layout's container.
463
+ - name: gap | type: number | description: Horizontal and vertical gap between columns
464
+ - name: responsivenessBehaviour | type: ResponsivenessBehaviour | description: Responsiveness behaviour of columns when responsiveness applies. Either stacks or wrappers.
465
+ enum:
466
+ STACK: Stacking of columns
467
+ WRAP: Wrapping of columns
468
+ - name: responsivenessBreakpoint | type: number | description: Size in pixels when responsiveness_behaviour applies
469
+ - name: linkPreviewData | type: LinkPreviewData | description: Data for a link preview node.
470
+ - name: containerData | type: PluginContainerData | description: Styling for the link preview's container.
471
+ - name: description | type: string | description: Preview description.
472
+ - name: html | type: string | description: The preview content as HTML.
473
+ - name: link | type: Link | description: Link details.
474
+ - name: styles | type: LinkPreviewDataStyles | description: Styling for the link preview.
475
+ - name: backgroundColor | type: string | description: Background color as a hexadecimal value.
476
+ - name: borderColor | type: string | description: Border color as a hexadecimal value.
477
+ - name: borderRadius | type: number | description: Border radius in pixels.
478
+ - name: borderWidth | type: number | description: Border width in pixels.
479
+ - name: linkColor | type: string | description: Link color as a hexadecimal value.
480
+ - name: subtitleColor | type: string | description: Subtitle color as a hexadecimal value.
481
+ - name: thumbnailPosition | type: StylesPosition | description: Position of thumbnail. Defaults to `START`.
482
+ enum:
483
+ END: Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts)
484
+ HIDDEN: Thumbnail hidden and not displayed
485
+ START: Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts)
486
+ TOP: Thumbnail positioned at the top
487
+ - name: titleColor | type: string | description: Title color as a hexadecimal value.
488
+ - name: thumbnailUrl | type: string | description: Preview thumbnail URL.
489
+ - name: title | type: string | description: Preview title.
490
+ - name: mapData | type: MapData | description: none
491
+ - name: containerData | type: PluginContainerData | description: Styling for the map's container.
492
+ - name: mapSettings | type: MapSettings | description: Map settings.
493
+ - name: address | type: string | description: The address to display on the map.
494
+ - name: draggable | type: boolean | description: Sets whether the map is draggable.
495
+ - name: initialZoom | type: number | description: Initial zoom value.
496
+ - name: lat | type: number | description: Location latitude.
497
+ - name: lng | type: number | description: Location longitude.
498
+ - name: locationName | type: string | description: Location name.
499
+ - name: mapType | type: MapType | description: Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types.
500
+ enum:
501
+ HYBRID: Hybrid map type
502
+ ROADMAP: Roadmap map type
503
+ SATELITE: Satellite map type
504
+ TERRAIN: Terrain map type
505
+ - name: marker | type: boolean | description: Sets whether the location marker is visible.
506
+ - name: streetViewControl | type: boolean | description: Sets whether street view control is enabled.
507
+ - name: viewModeControl | type: boolean | description: Sets whether view mode control is enabled.
508
+ - name: zoomControl | type: boolean | description: Sets whether zoom control is enabled.
509
+ - name: orderedListData | type: OrderedListData | description: Data for an ordered list node.
510
+ - name: indentation | type: number | description: Indentation level from 0-4.
511
+ - name: offset | type: number | description: Offset level from 0-4.
512
+ - name: start | type: number | description: List start number.
513
+ - name: paragraphData | type: ParagraphData | description: Data for a paragraph node.
514
+ - name: indentation | type: number | description: Indentation level from 1-4.
515
+ - name: level | type: number | description: Paragraph level
516
+ - name: textStyle | type: TextStyle | description: Styling for the paragraph text.
517
+ - name: pollData | type: PollData | description: Data for a poll node.
518
+ - name: containerData | type: PluginContainerData | description: Styling for the poll's container.
519
+ - name: design | type: Design | description: Styling for the poll and voting options.
520
+ - name: options | type: OptionDesign | description: Styling for voting options.
521
+ - name: borderRadius | type: number | description: Border radius in pixels.
522
+ - name: poll | type: PollDesign | description: Styling for the poll.
523
+ - name: background | type: Background | description: Background styling.
524
+ - name: type | type: BackgroundType | description: Background type. For each option, include the relevant details.
525
+ enum:
526
+ COLOR: Color background type
527
+ GRADIENT: Gradiant background type
528
+ IMAGE: Image background type
529
+ - ONE-OF:
530
+ - name: color | type: string | description: The background color as a hexademical value.
531
+ - name: gradient | type: Gradient | description: Details for a gradient background.
532
+ - name: angle | type: number | description: The gradient angle in degrees.
533
+ - name: lastColor | type: string | description: The end color as a hexademical value.
534
+ - name: startColor | type: string | description: The start color as a hexademical value.
535
+ - name: image | type: V1Media | description: An image to use for the background.
536
+ - name: borderRadius | type: number | description: Border radius in pixels.
537
+ - name: layout | type: PollDataLayout | description: Layout settings for the poll and voting options.
538
+ - name: options | type: OptionLayout | description: Voting otpions layout settings.
539
+ - name: enableImage | type: boolean | description: Sets whether to display option images. Defaults to `false`.
540
+ - name: poll | type: PollLayout | description: Poll layout settings.
541
+ - name: direction | type: PollLayoutDirection | description: The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right.
542
+ enum:
543
+ LTR: Left-to-right
544
+ RTL: Right-to-left
545
+ - name: enableImage | type: boolean | description: Sets whether to display the main poll image. Defaults to `false`.
546
+ - name: type | type: PollLayoutType | description: The layout for displaying the voting options.
547
+ enum:
548
+ GRID: Grid
549
+ LIST: List
550
+ - name: poll | type: Poll | description: Poll data.
551
+ - name: creatorId | type: string | description: Poll creator GUID.
552
+ - name: id | type: string | description: Poll GUID.
553
+ - name: image | type: V1Media | description: Main poll image.
554
+ - name: options | type: Array<Option> | description: Voting options.
555
+ - name: id | type: string | description: Option GUID.
556
+ - name: image | type: V1Media | description: The image displayed with the option.
557
+ - name: title | type: string | description: Option title.
558
+ - name: settings | type: PollSettings | description: The poll's permissions and display settings.
559
+ - name: permissions | type: Permissions | description: Permissions settings for voting.
560
+ - name: allowMultipleVotes | type: boolean | description: Sets whether one voter can vote multiple times. Defaults to `false`.
561
+ - name: view | type: ViewRole | description: Sets who can view the poll results.
562
+ enum:
563
+ CREATOR: Only Poll creator can view the results
564
+ EVERYONE: Anyone can see the results, even if one didn't vote
565
+ VOTERS: Anyone who voted can see the results
566
+ - name: vote | type: VoteRole | description: Sets who can vote.
567
+ enum:
568
+ ALL: Anyone
569
+ SITE_MEMBERS: Logged in member
570
+ - name: showVoters | type: boolean | description: Sets whether voters are displayed in the vote results. Defaults to `true`.
571
+ - name: showVotesCount | type: boolean | description: Sets whether the vote count is displayed. Defaults to `true`.
572
+ - name: title | type: string | description: Poll title.
573
+ - name: tableCellData | type: TableCellData | description: Data for a table cell node.
574
+ - name: borderColors | type: BorderColors | description: The cell's border colors.
575
+ - name: bottom | type: string | description: Bottom border color as a hexadecimal value.
576
+ - name: left | type: string | description: Left border color as a hexadecimal value.
577
+ - name: right | type: string | description: Right border color as a hexadecimal value.
578
+ - name: top | type: string | description: Top border color as a hexadecimal value.
579
+ - name: borderWidths | type: BorderWidths | description: The cell's border widths.
580
+ - name: bottom | type: number | description: Bottom border width in pixels.
581
+ - name: left | type: number | description: Left border width in pixels.
582
+ - name: right | type: number | description: Right border width in pixels.
583
+ - name: top | type: number | description: Top border width in pixels.
584
+ - name: cellStyle | type: CellStyle | description: Styling for the cell's background color and text alignment.
585
+ - name: backgroundColor | type: string | description: Cell background color as a hexadecimal value.
586
+ - name: verticalAlignment | type: VerticalAlignment | description: Vertical alignment for the cell's text.
587
+ enum:
588
+ BOTTOM: Bottom alignment
589
+ MIDDLE: Middle alignment
590
+ TOP: Top alignment
591
+ - name: colspan | type: number | description: Defines how many columns the cell spans. Default: 1.
592
+ - name: rowspan | type: number | description: Defines how many rows the cell spans. Default: 1.
593
+ - name: tableData | type: TableData | description: Data for a table node.
594
+ - name: cellPadding | type: Array<number> | description: Padding in pixels for cells. Follows CSS order: top, right, bottom, left.
595
+ - name: cellSpacing | type: number | description: The spacing between cells in pixels. Defaults to `0`.
596
+ - name: columnHeader | type: boolean | description: Sets whether the table's first column is a header. Defaults to `false`.
597
+ - name: containerData | type: PluginContainerData | description: Styling for the table's container.
598
+ - name: dimensions | type: Dimensions | description: The table's dimensions.
599
+ - name: colsMinWidth | type: Array<number> | description: An array representing the minimum width of each column in pixels.
600
+ - name: colsWidthRatio | type: Array<number> | description: An array representing relative width of each column in relation to the other columns.
601
+ - name: rowsHeight | type: Array<number> | description: An array representing the height of each row in pixels.
602
+ - name: rowHeader | type: boolean | description: Sets whether the table's first row is a header. Defaults to `false`.
603
+ - name: textData | type: TextData | description: Data for a text node. Used to apply decorations to text.
604
+ - name: decorations | type: Array<Decoration> | description: The decorations to apply.
605
+ - name: text | type: string | description: The text to apply decorations to.
606
+ - name: videoData | type: VideoData | description: Data for a video node.
607
+ - name: containerData | type: PluginContainerData | description: Styling for the video's container.
608
+ - name: disableDownload | type: boolean | description: Sets whether the video's download button is disabled. Defaults to `false`.
609
+ - name: options | type: PlaybackOptions | description: Video options.
610
+ - name: autoPlay | type: boolean | description: Sets whether the media will automatically start playing.
611
+ - name: playInLoop | type: boolean | description: Sets whether media's will be looped.
612
+ - name: showControls | type: boolean | description: Sets whether media's controls will be shown.
613
+ - name: thumbnail | type: V1Media | description: Video thumbnail details.
614
+ - name: title | type: string | description: Video title.
615
+ - name: video | type: V1Media | description: Video details.
616
+ - name: extendedFields | type: ExtendedFields | description: Custom extended fields for the product object. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
617
+ - name: namespaces | type: Record<string, undefined> | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
618
+ - name: infoSections | type: Array<InfoSection> | description: Product info section. + Pass `infoSection.uniqueName`, `infoSection.title`, and `infoSection.description` to add a new info section while creating a product. + Pass an existing info section's `id` or `uniqueName` to assign that info section to the product.
619
+ - name: _id | type: string | description: Info section GUID.
620
+ - name: plainDescription | type: string | description: Info section description in HTML. When provided on create/update, this string must be a valid HTML. It will then be converted to rich content. `plainDescription` is ignored when value is also passed to the `description` field. > **Note:** Returned only when you pass `"INFO_SECTION_PLAIN_DESCRIPTION"` to the `fields` array in Products API requests.
621
+ - name: uniqueName | type: string | description: Info section unique name. > **Note:** Returned only when you pass `"INFO_SECTION"` to the `fields` array in Products API requests.
622
+ - name: mainCategoryId | type: string | description: The GUID of the product's primary direct category, which defines the product’s breadcrumbs path. For example, if the product's main category is "T-Shirts" (which is a subcategory of "Clothing"), the breadcrumbs path will be "Clothing > T-Shirts".
623
+ - name: media | type: Media | description: Product media items.
624
+ - name: itemsInfo | type: MediaItemsInfo | description: All media items. > **Note:** Returned only when you pass `"MEDIA_ITEMS_INFO"` to the `fields` array in Products API requests.
625
+ - name: items | type: Array<ProductMedia> | description: All media items (images, videos etc) associated with this product.
626
+ - name: altText | type: string | description: Image alt text.
627
+ - name: displayName | type: string | description: Media display name. Allows to override the default media name. Can be passed only when `setBy: url`.
628
+ - name: thumbnail | type: Thumbnail | description: Media thumbnail. > **Note:** Returned only when you pass `"THUMBNAIL"` to the `fields` array in Products API requests.
629
+ - name: altText | type: string | description: Thumbnail alt text.
630
+ - name: height | type: number | description: Thumbnail height.
631
+ - name: url | type: string | description: Thumbnail url.
632
+ - name: width | type: number | description: Thumbnail width.
633
+ - ONE-OF:
634
+ - name: _id | type: string | description: Set media by GUID of an existing file in Wix Media Manager.
635
+ - name: url | type: string | description: Set media using an external media URL.
636
+ - ONE-OF:
637
+ - name: image | type: string | description: Product image.
638
+ - name: video | type: string | description: Product video.
639
+ - name: modifiers | type: Array<ConnectedModifier> | description: Product modifiers. Allows the customer to customize product, e.g. select Color, Size and so on similarly to `options` but with one main difference - `modifiers` never generate any variants.
640
+ - name: _id | type: string | description: GUID of a customization with `customizationType: MODIFIER`.
641
+ - name: mandatory | type: boolean | description: Whether customer input is required for this modifier.
642
+ - name: modifierRenderType | type: ModifierRenderType | description: Modifier render type.
643
+ enum:
644
+ FREE_TEXT: Free text.
645
+ SWATCH_CHOICES: Swatch choices.
646
+ TEXT_CHOICES: Text choices.
647
+ UNKNOWN_MODIFIER_RENDER_TYPE: Not implemented.
648
+ - name: name | type: string | description: Modifier title.
649
+ - ONE-OF:
650
+ - name: choicesSettings | type: ModifierChoicesSettings | description: Choice settings.
651
+ - name: choices | type: Array<ConnectedModifierChoice> | description: List of modifier choices.
652
+ - name: addedPrice | type: string | description: Added price.
653
+ - name: choiceId | type: string | description: Choice GUID.
654
+ - name: choiceType | type: ChoiceType | description: Choice type.
655
+ enum:
656
+ CHOICE_TEXT: Text choice.
657
+ IMAGE: Image choice.
658
+ MULTIPLE_COLORS: Multiple colors choice.
659
+ ONE_COLOR: Single color choice.
660
+ UNKNOWN_CHOICE_TYPE
661
+ - name: linkedMedia | type: Array<ProductMedia> | description: Product media.
662
+ - name: name | type: string | description: Choice name.
663
+ - ONE-OF:
664
+ - name: colorCode | type: string | description: Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
665
+ - name: freeTextSettings | type: FreeTextSettings | description: Free text modifier settings.
666
+ - name: defaultAddedPrice | type: string | description: Default amount to be added to the product's price.
667
+ - name: maxCharCount | type: number | description: Maximum number of characters.
668
+ - name: minCharCount | type: number | description: Minimum number of characters.
669
+ - name: title | type: string | description: Title of the text to be input by the customer.
670
+ - name: name | type: string | description: Product name. Translatable.
671
+ - name: options | type: Array<ConnectedOption> | description: Product options. Allows the customer to customize the product. For example, selecting color, size, and more. Always generates variants: every variant must have exactly one choice related to each option. Since options and variants tightly coupled and rely on each other they usually should be provided together in all operations.
672
+ - name: _id | type: string | description: GUID of a customization with `customizationType: PRODUCT_OPTION`.
673
+ - name: name | type: string | description: Option name.
674
+ - name: optionRenderType | type: ProductOptionRenderType | description: Option render type.
675
+ enum:
676
+ SWATCH_CHOICES: Swatch choices.
677
+ TEXT_CHOICES: Text choices.
678
+ UNKNOWN_OPTION_RENDER_TYPE: Not implemented.
679
+ - ONE-OF:
680
+ - name: choicesSettings | type: ChoicesSettings | description: Choices settings.
681
+ - name: choices | type: Array<ConnectedOptionChoice> | description: List of available choices for the option.
682
+ - name: choiceId | type: string | description: The id of the choice.
683
+ - name: choiceType | type: ChoiceType | description: The type of this choice.
684
+ - name: linkedMedia | type: Array<ProductMedia> | description: Product media overrides. When not empty only these images will be shown when such choices selected by customer. Otherwise all images of product. When several choices from different options selected only media filter present in `media_overrides` of ALL choices will be shown. For example if Color:red has images 1,2,3 and Material:Silk has images 2,3,5 then only images 2,3 will be shown when both of them selected.
685
+ - name: name | type: string | description: Choice name.
686
+ - ONE-OF:
687
+ - name: colorCode | type: string | description: Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
688
+ - name: plainDescription | type: string | description: Product description in HTML. + When provided on create/update, this string must be a valid HTML. It will then be converted to rich content. + `plainDescription` is ignored when value is also passed to the `description` field. > **Note:** Returned only when you pass `"PLAIN_DESCRIPTION"` to the `fields` array in Products API requests.
689
+ - name: productType | type: ProductType | description: Product type. When passing `productType: PHYSICAL`, you must also pass `physicalProperties`.
690
+ enum:
691
+ DIGITAL: Digital product.
692
+ PHYSICAL: Physical product.
693
+ UNKNOWN_PRODUCT_TYPE: Not implemented.
694
+ - name: ribbon | type: Ribbon | description: Product ribbon. + Pass `ribbon.name` to add a new ribbon while creating a product. + Pass an existing ribbon's `id` or `name` to assign that ribbon to the product.
695
+ - name: _id | type: string | description: Ribbon GUID.
696
+ - name: name | type: string | description: Ribbon name.
697
+ - name: seoData | type: SeoSchema | description: Product SEO data.
698
+ - name: settings | type: Settings | description: SEO general settings.
699
+ - name: keywords | type: Array<Keyword> | description: User-selected keyword terms for a specific page.
700
+ - name: isMain | type: boolean | description: Whether the keyword is the main focus keyword.
701
+ - name: origin | type: string | description: The source that added the keyword terms to the SEO settings.
702
+ - name: term | type: string | description: Keyword value.
703
+ - name: preventAutoRedirect | type: boolean | description: Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled. Default: `false` (automatical redirect is enabled).
704
+ - name: tags | type: Array<Tag> | description: SEO tag information.
705
+ - name: children | type: string | description: SEO tag inner content. For example, `<title> inner content </title>`.
706
+ - name: custom | type: boolean | description: Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).
707
+ - name: disabled | type: boolean | description: Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines.
708
+ - name: meta | type: Record<string, any> | description: SEO tag metadata. For example, `{"height": 300, "width": 240}`.
709
+ - name: props | type: Record<string, any> | description: A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value. For example: `{"name": "description", "content": "the description itself"}`.
710
+ - name: type | type: string | description: SEO tag type. Supported values: `title`, `meta`, `script`, `link`.
711
+ - name: slug | type: string | description: Product slug. If not provided, the slug is autogenerated based on the product name.
712
+ - name: subscriptionDetails | type: SubscriptionDetails | description: Product subscriptions.
713
+ - name: allowOneTimePurchases | type: boolean | description: Whether to allow one-time purchases in addition to subscription-based purchases. Default: `false`
714
+ - name: subscriptions | type: Array<Subscription> | description: Subscriptions.
715
+ - name: _id | type: string | description: Subscription GUID.
716
+ - name: description | type: string | description: Subscription description.
717
+ - name: discount | type: SubscriptionDiscount | description: Discount info (optional). For example, a $20 discount would be `amount: 20`, `type: AMOUNT`.
718
+ - name: type | type: DiscountType | description: Discount type.
719
+ enum:
720
+ AMOUNT: Discount by a specific amount.
721
+ PERCENT: Discount by a percentage.
722
+ UNKNOWN_DISCOUNT
723
+ - ONE-OF:
724
+ - name: amountOff | type: string | description: Amount to discount from the variant discounted_price.
725
+ - name: percentOff | type: number | description: Percentage to discount from variant discounted_price.
726
+ - name: frequency | type: SubscriptionFrequency | description: Frequency of recurring payment. For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months.
727
+ enum: DAY, MONTH, UNDEFINED, WEEK, YEAR
728
+ - name: interval | type: number | description: Interval of recurring payment. Default: `1`. For example, if `frequency: MONTH`, `billingCycles: 3` and `interval: 2`; payment will be made every 2 months for a total of 6 months.
729
+ - name: title | type: string | description: Subscription title.
730
+ - name: visible | type: boolean | description: Whether the subscription is visible to site visitors. Default: `true`
731
+ - ONE-OF:
732
+ - name: autoRenewal | type: boolean | description: Whether subscription is renewed automatically at the end of each period. Cannot be `false`, instead set `billingCycles`.
733
+ - name: billingCycles | type: number | description: Number of billing cycles before subscription ends.
734
+ - name: taxGroupId | type: string | description: Tax group GUID.
735
+ - name: variantsInfo | type: VariantsInfo | description: Product variants. Each variant must reference all product options via its `choices` array. Each choice references an option using `optionChoiceNames` for all requests.
736
+ - name: variants | type: Array<Variant> | description: List of related variants.
737
+ - name: _id | type: string | description: Variant GUID.
738
+ - name: barcode | type: string | description: Variant barcode.
739
+ - name: choices | type: Array<OptionChoice> | description: List of choices that define the product's variant, which requires exactly one choice per product option. Must use `optionChoiceNames` in all requests this field is required. Empty only for default variants of unmanaged products.
740
+ - name: optionChoiceIds | type: OptionChoiceIds | description: Option and choice GUIDs. These match the GUIDs of the option and choice from the product's options field.
741
+ - name: choiceId | type: string | description: Choice GUID.
742
+ - name: optionId | type: string | description: Option GUID.
743
+ - name: optionChoiceNames | type: OptionChoiceNames | description: Option and choice names. This needs to be used in all requests `OptionChoice` is needed, and all `OptionChoiceNames` fields are required. > **Note:** Returned only when you pass `"VARIANT_OPTION_CHOICE_NAMES"` to the `fields` array in Products API requests.
744
+ - name: choiceName | type: string | description: Choice name.
745
+ - name: optionName | type: string | description: Option name.
746
+ - name: renderType | type: ProductOptionRenderType | description: Render type.
747
+ - name: price | type: PriceInfo | description: Variant price.
748
+ - name: actualPrice | type: FixedMonetaryAmount | description: Variant price. Must be greater or equal to 0.
749
+ - name: amount | type: string | description: Monetary amount. For example, `"3.99"`, or `"-4.99"` for a negative amount.
750
+ - name: compareAtPrice | type: FixedMonetaryAmount | description: The compare-at-price represents the original price of a product before any discount. It is optional and should only be set if a discount applies. When set, it must be higher than the current price to reflect accurate savings.
751
+ - name: revenueDetails | type: RevenueDetails | description: Variant revenue details. > **Note:** Returned only when the following conditions are met: > + You pass `"MERCHANT_DATA"` to the `fields` array in Products API requests. > + Your app has the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
752
+ - name: cost | type: FixedMonetaryAmount | description: Item cost.
753
+ - name: sku | type: string | description: Variant SKU (stock keeping unit).
754
+ - name: visible | type: boolean | description: Whether the variant is visible to site visitors. Default: `true`
755
+ - ONE-OF:
756
+ - name: digitalProperties | type: VariantDigitalProperties | description: Digital properties. Must be passed when `productType: DIGITAL`
757
+ - name: digitalFile | type: SecuredMedia | description: Digital file which will be downloaded by customer after successful purchase.
758
+ - name: _id | type: string | description: Media GUID in media manager.
759
+ - name: physicalProperties | type: VariantPhysicalProperties | description: Physical properties. Must be passed when `productType: PHYSICAL`
760
+ - name: pricePerUnit | type: PricePerUnit | description: Price per unit info, in order to show price per unit on the product page. For example if one sells cheese and defines 100g here then we know that buying this variant buyer receives 100g of cheese. But on product page price will be displayed for units defined on product level. See `pricePerUnit.value` to understand how it's calculated.
761
+ - name: settings | type: PricePerUnitSettings | description: Price per unit data for this variant. `measurementUnit` value must correspond to the measurement unit set on the product.
762
+ - name: measurementUnit | type: MeasurementUnit | description: Measurement unit. For example, to define price per 100 grams, set this field to "G".
763
+ enum: CBM, CL, CM, FLOZ, FT, G, GAL, IN, KG, L, LB, M, MG, ML, MM, OZ, PT, QT, SQFT, SQM, UNSPECIFIED, YD
764
+ - name: quantity | type: number | description: Quantity. For example, to define price per per 100 grams, set this field to `100`.
765
+ - name: weight | type: number | description: Variant shipping weight. product.physicalProperties.shipping_weight_range values are taken from here.
766
+ - name: visible | type: boolean | description: Whether the product is visible to site visitors on the site. Default: `true`
767
+ - name: visibleInPos | type: boolean | description: Whether the product is visible in POS (point of sale). Default: `true` > **Note:** Always `false` for `productType: DIGITAL`.
768
+ - ONE-OF:
769
+ - name: physicalProperties | type: PhysicalProperties | description: Physical properties. Required when `productType: PHYSICAL`.
770
+ - name: deliveryProfileId | type: string | description: Delivery profile GUID.
771
+ - name: fulfillerId | type: string | description: Fulfiller GUID.
772
+ - name: pricePerUnit | type: PricePerUnitSettings | description: Price per unit settings. > **Note:** Use this field only when relevant. For example, for products that are sold by weight, volume, or length.
773
+ - name: metadata | type: EventMetadata | description: none
774
+ - name: _id | type: string | description: Event GUID. With this GUID you can easily spot duplicated events and ignore them.
775
+ - name: entityEventSequence | type: string | description: A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number. You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
776
+ - name: entityFqdn | type: string | description: Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
777
+ - name: entityId | type: string | description: GUID of the entity associated with the event.
778
+ - name: eventTime | type: Date | description: Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`.
779
+ - name: eventType | type: string | description: Event type.
780
+ - name: identity | type: IdentificationData | description: The identification type and identity data.
781
+ - ONE-OF:
782
+ - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site.
783
+ - name: appId | type: string | description: GUID of an app.
784
+ - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site.
785
+ - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.).
786
+ - name: instanceId | type: string | description: App instance GUID.
787
+ - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
788
+ - name: slug | type: string | description: Event action name, placed at the top level to make it easier for users to dispatch messages. For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
789
+ - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
790
+ Return type: PRIMITIVE<void>
791
+
792
+ ```
793
+ </type_definition>
794
+ </stores_productsV3_onProductCreated>