@wix/auto_sdk_stores_info-sections-v-3 1.0.0

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 (111) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.context.d.ts +30 -0
  11. package/build/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.context.js +65 -0
  12. package/build/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.context.js.map +1 -0
  13. package/build/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.http.d.ts +68 -0
  14. package/build/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.http.js +1101 -0
  15. package/build/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.http.js.map +1 -0
  16. package/build/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.meta.d.ts +28 -0
  17. package/build/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.meta.js +218 -0
  18. package/build/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.meta.js.map +1 -0
  19. package/build/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.public.d.ts +122 -0
  20. package/build/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.public.js +238 -0
  21. package/build/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.public.js.map +1 -0
  22. package/build/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.types.d.ts +2083 -0
  23. package/build/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.types.js +318 -0
  24. package/build/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.types.js.map +1 -0
  25. package/build/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.universal.d.ts +2640 -0
  26. package/build/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.universal.js +862 -0
  27. package/build/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/stores-catalog-v3-info-section-info-sections-v-3.context.d.ts +30 -0
  39. package/build/es/src/stores-catalog-v3-info-section-info-sections-v-3.context.js +30 -0
  40. package/build/es/src/stores-catalog-v3-info-section-info-sections-v-3.context.js.map +1 -0
  41. package/build/es/src/stores-catalog-v3-info-section-info-sections-v-3.http.d.ts +68 -0
  42. package/build/es/src/stores-catalog-v3-info-section-info-sections-v-3.http.js +1088 -0
  43. package/build/es/src/stores-catalog-v3-info-section-info-sections-v-3.http.js.map +1 -0
  44. package/build/es/src/stores-catalog-v3-info-section-info-sections-v-3.meta.d.ts +28 -0
  45. package/build/es/src/stores-catalog-v3-info-section-info-sections-v-3.meta.js +182 -0
  46. package/build/es/src/stores-catalog-v3-info-section-info-sections-v-3.meta.js.map +1 -0
  47. package/build/es/src/stores-catalog-v3-info-section-info-sections-v-3.public.d.ts +122 -0
  48. package/build/es/src/stores-catalog-v3-info-section-info-sections-v-3.public.js +193 -0
  49. package/build/es/src/stores-catalog-v3-info-section-info-sections-v-3.public.js.map +1 -0
  50. package/build/es/src/stores-catalog-v3-info-section-info-sections-v-3.types.d.ts +2083 -0
  51. package/build/es/src/stores-catalog-v3-info-section-info-sections-v-3.types.js +315 -0
  52. package/build/es/src/stores-catalog-v3-info-section-info-sections-v-3.types.js.map +1 -0
  53. package/build/es/src/stores-catalog-v3-info-section-info-sections-v-3.universal.d.ts +2640 -0
  54. package/build/es/src/stores-catalog-v3-info-section-info-sections-v-3.universal.js +826 -0
  55. package/build/es/src/stores-catalog-v3-info-section-info-sections-v-3.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.context.d.ts +30 -0
  66. package/build/internal/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.context.js +65 -0
  67. package/build/internal/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.context.js.map +1 -0
  68. package/build/internal/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.http.d.ts +68 -0
  69. package/build/internal/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.http.js +1101 -0
  70. package/build/internal/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.http.js.map +1 -0
  71. package/build/internal/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.meta.d.ts +28 -0
  72. package/build/internal/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.meta.js +218 -0
  73. package/build/internal/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.meta.js.map +1 -0
  74. package/build/internal/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.public.d.ts +122 -0
  75. package/build/internal/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.public.js +238 -0
  76. package/build/internal/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.public.js.map +1 -0
  77. package/build/internal/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.types.d.ts +2083 -0
  78. package/build/internal/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.types.js +318 -0
  79. package/build/internal/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.types.js.map +1 -0
  80. package/build/internal/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.universal.d.ts +2640 -0
  81. package/build/internal/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.universal.js +862 -0
  82. package/build/internal/cjs/src/stores-catalog-v3-info-section-info-sections-v-3.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/stores-catalog-v3-info-section-info-sections-v-3.context.d.ts +30 -0
  93. package/build/internal/es/src/stores-catalog-v3-info-section-info-sections-v-3.context.js +30 -0
  94. package/build/internal/es/src/stores-catalog-v3-info-section-info-sections-v-3.context.js.map +1 -0
  95. package/build/internal/es/src/stores-catalog-v3-info-section-info-sections-v-3.http.d.ts +68 -0
  96. package/build/internal/es/src/stores-catalog-v3-info-section-info-sections-v-3.http.js +1088 -0
  97. package/build/internal/es/src/stores-catalog-v3-info-section-info-sections-v-3.http.js.map +1 -0
  98. package/build/internal/es/src/stores-catalog-v3-info-section-info-sections-v-3.meta.d.ts +28 -0
  99. package/build/internal/es/src/stores-catalog-v3-info-section-info-sections-v-3.meta.js +182 -0
  100. package/build/internal/es/src/stores-catalog-v3-info-section-info-sections-v-3.meta.js.map +1 -0
  101. package/build/internal/es/src/stores-catalog-v3-info-section-info-sections-v-3.public.d.ts +122 -0
  102. package/build/internal/es/src/stores-catalog-v3-info-section-info-sections-v-3.public.js +193 -0
  103. package/build/internal/es/src/stores-catalog-v3-info-section-info-sections-v-3.public.js.map +1 -0
  104. package/build/internal/es/src/stores-catalog-v3-info-section-info-sections-v-3.types.d.ts +2083 -0
  105. package/build/internal/es/src/stores-catalog-v3-info-section-info-sections-v-3.types.js +315 -0
  106. package/build/internal/es/src/stores-catalog-v3-info-section-info-sections-v-3.types.js.map +1 -0
  107. package/build/internal/es/src/stores-catalog-v3-info-section-info-sections-v-3.universal.d.ts +2640 -0
  108. package/build/internal/es/src/stores-catalog-v3-info-section-info-sections-v-3.universal.js +826 -0
  109. package/build/internal/es/src/stores-catalog-v3-info-section-info-sections-v-3.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,2640 @@
1
+ /**
2
+ * An info section is a visible property of a product
3
+ * Add info sections to a product to provide all the explanations your customers need.
4
+ */
5
+ export interface InfoSection {
6
+ /**
7
+ * Info section ID.
8
+ * @readonly
9
+ */
10
+ _id?: string | null;
11
+ /**
12
+ * Revision number, which increments by 1 each time the info section is updated.
13
+ * To prevent conflicting changes,
14
+ * the current revision must be passed when updating the info section.
15
+ *
16
+ * Ignored when creating an info section.
17
+ * @readonly
18
+ */
19
+ revision?: string | null;
20
+ /**
21
+ * Date and time the info section was created.
22
+ * @readonly
23
+ */
24
+ _createdDate?: Date | null;
25
+ /**
26
+ * Date and time the info section was updated.
27
+ * @readonly
28
+ */
29
+ _updatedDate?: Date | null;
30
+ /** Unique name. Used as an identifier. */
31
+ uniqueName?: string;
32
+ /** Info section title. */
33
+ title?: string;
34
+ /**
35
+ * Info section description using rich content.
36
+ *
37
+ * <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">
38
+ * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
39
+ * </widget>
40
+ */
41
+ description?: RichContent;
42
+ /**
43
+ * Info section description in HTML.
44
+ *
45
+ * When provided on create/update, this string must be a valid HTML. It will then be converted to rich content.
46
+ * `plainDescription` is ignored when value is also passed to the `description` field.
47
+ */
48
+ plainDescription?: string | null;
49
+ /**
50
+ * Number of products this info section is assigned to.
51
+ * > **Note:** Returned only when you pass `"ASSIGNED_PRODUCTS_COUNT"` to the `fields` array in Info Sections API requests.
52
+ * @readonly
53
+ */
54
+ assignedProductsCount?: number | null;
55
+ }
56
+ export interface RichContent {
57
+ /** Node objects representing a rich content document. */
58
+ nodes?: Node[];
59
+ /** Object metadata. */
60
+ metadata?: Metadata;
61
+ /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
62
+ documentStyle?: DocumentStyle;
63
+ }
64
+ export interface Node extends NodeDataOneOf {
65
+ /** Data for a button node. */
66
+ buttonData?: ButtonData;
67
+ /** Data for a code block node. */
68
+ codeBlockData?: CodeBlockData;
69
+ /** Data for a divider node. */
70
+ dividerData?: DividerData;
71
+ /** Data for a file node. */
72
+ fileData?: FileData;
73
+ /** Data for a gallery node. */
74
+ galleryData?: GalleryData;
75
+ /** Data for a GIF node. */
76
+ gifData?: GIFData;
77
+ /** Data for a heading node. */
78
+ headingData?: HeadingData;
79
+ /** Data for an embedded HTML node. */
80
+ htmlData?: HTMLData;
81
+ /** Data for an image node. */
82
+ imageData?: ImageData;
83
+ /** Data for a link preview node. */
84
+ linkPreviewData?: LinkPreviewData;
85
+ /** @deprecated */
86
+ mapData?: MapData;
87
+ /** Data for a paragraph node. */
88
+ paragraphData?: ParagraphData;
89
+ /** Data for a poll node. */
90
+ pollData?: PollData;
91
+ /** Data for a text node. Used to apply decorations to text. */
92
+ textData?: TextData;
93
+ /** Data for an app embed node. */
94
+ appEmbedData?: AppEmbedData;
95
+ /** Data for a video node. */
96
+ videoData?: VideoData;
97
+ /** Data for an oEmbed node. */
98
+ embedData?: EmbedData;
99
+ /** Data for a collapsible list node. */
100
+ collapsibleListData?: CollapsibleListData;
101
+ /** Data for a table node. */
102
+ tableData?: TableData;
103
+ /** Data for a table cell node. */
104
+ tableCellData?: TableCellData;
105
+ /** Data for a custom external node. */
106
+ externalData?: Record<string, any> | null;
107
+ /** Data for an audio node. */
108
+ audioData?: AudioData;
109
+ /** Data for an ordered list node. */
110
+ orderedListData?: OrderedListData;
111
+ /** Data for a bulleted list node. */
112
+ bulletedListData?: BulletedListData;
113
+ /** Data for a block quote node. */
114
+ blockquoteData?: BlockquoteData;
115
+ /** Data for a caption node. */
116
+ captionData?: CaptionData;
117
+ /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
118
+ layoutCellData?: LayoutCellData;
119
+ /** 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. */
120
+ type?: NodeType;
121
+ /** Node ID. */
122
+ _id?: string;
123
+ /** A list of child nodes. */
124
+ nodes?: Node[];
125
+ /** Padding and background color styling for the node. */
126
+ style?: NodeStyle;
127
+ }
128
+ /** @oneof */
129
+ export interface NodeDataOneOf {
130
+ /** Data for a button node. */
131
+ buttonData?: ButtonData;
132
+ /** Data for a code block node. */
133
+ codeBlockData?: CodeBlockData;
134
+ /** Data for a divider node. */
135
+ dividerData?: DividerData;
136
+ /** Data for a file node. */
137
+ fileData?: FileData;
138
+ /** Data for a gallery node. */
139
+ galleryData?: GalleryData;
140
+ /** Data for a GIF node. */
141
+ gifData?: GIFData;
142
+ /** Data for a heading node. */
143
+ headingData?: HeadingData;
144
+ /** Data for an embedded HTML node. */
145
+ htmlData?: HTMLData;
146
+ /** Data for an image node. */
147
+ imageData?: ImageData;
148
+ /** Data for a link preview node. */
149
+ linkPreviewData?: LinkPreviewData;
150
+ /** @deprecated */
151
+ mapData?: MapData;
152
+ /** Data for a paragraph node. */
153
+ paragraphData?: ParagraphData;
154
+ /** Data for a poll node. */
155
+ pollData?: PollData;
156
+ /** Data for a text node. Used to apply decorations to text. */
157
+ textData?: TextData;
158
+ /** Data for an app embed node. */
159
+ appEmbedData?: AppEmbedData;
160
+ /** Data for a video node. */
161
+ videoData?: VideoData;
162
+ /** Data for an oEmbed node. */
163
+ embedData?: EmbedData;
164
+ /** Data for a collapsible list node. */
165
+ collapsibleListData?: CollapsibleListData;
166
+ /** Data for a table node. */
167
+ tableData?: TableData;
168
+ /** Data for a table cell node. */
169
+ tableCellData?: TableCellData;
170
+ /** Data for a custom external node. */
171
+ externalData?: Record<string, any> | null;
172
+ /** Data for an audio node. */
173
+ audioData?: AudioData;
174
+ /** Data for an ordered list node. */
175
+ orderedListData?: OrderedListData;
176
+ /** Data for a bulleted list node. */
177
+ bulletedListData?: BulletedListData;
178
+ /** Data for a block quote node. */
179
+ blockquoteData?: BlockquoteData;
180
+ /** Data for a caption node. */
181
+ captionData?: CaptionData;
182
+ /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
183
+ layoutCellData?: LayoutCellData;
184
+ }
185
+ export declare enum NodeType {
186
+ PARAGRAPH = "PARAGRAPH",
187
+ TEXT = "TEXT",
188
+ HEADING = "HEADING",
189
+ BULLETED_LIST = "BULLETED_LIST",
190
+ ORDERED_LIST = "ORDERED_LIST",
191
+ LIST_ITEM = "LIST_ITEM",
192
+ BLOCKQUOTE = "BLOCKQUOTE",
193
+ CODE_BLOCK = "CODE_BLOCK",
194
+ VIDEO = "VIDEO",
195
+ DIVIDER = "DIVIDER",
196
+ FILE = "FILE",
197
+ GALLERY = "GALLERY",
198
+ GIF = "GIF",
199
+ HTML = "HTML",
200
+ IMAGE = "IMAGE",
201
+ LINK_PREVIEW = "LINK_PREVIEW",
202
+ /** @deprecated */
203
+ MAP = "MAP",
204
+ POLL = "POLL",
205
+ APP_EMBED = "APP_EMBED",
206
+ BUTTON = "BUTTON",
207
+ COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
208
+ TABLE = "TABLE",
209
+ EMBED = "EMBED",
210
+ COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
211
+ COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
212
+ COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
213
+ TABLE_CELL = "TABLE_CELL",
214
+ TABLE_ROW = "TABLE_ROW",
215
+ EXTERNAL = "EXTERNAL",
216
+ AUDIO = "AUDIO",
217
+ CAPTION = "CAPTION",
218
+ LAYOUT = "LAYOUT",
219
+ LAYOUT_CELL = "LAYOUT_CELL"
220
+ }
221
+ export interface NodeStyle {
222
+ /** The top padding value in pixels. */
223
+ paddingTop?: string | null;
224
+ /** The bottom padding value in pixels. */
225
+ paddingBottom?: string | null;
226
+ /** The background color as a hexadecimal value. */
227
+ backgroundColor?: string | null;
228
+ }
229
+ export interface ButtonData {
230
+ /** Styling for the button's container. */
231
+ containerData?: PluginContainerData;
232
+ /** The button type. */
233
+ type?: Type;
234
+ /** Styling for the button. */
235
+ styles?: Styles;
236
+ /** The text to display on the button. */
237
+ text?: string | null;
238
+ /** Button link details. */
239
+ link?: Link;
240
+ }
241
+ export interface Border {
242
+ /** Border width in pixels. */
243
+ width?: number | null;
244
+ /** Border radius in pixels. */
245
+ radius?: number | null;
246
+ }
247
+ export interface Colors {
248
+ /** The text color as a hexadecimal value. */
249
+ text?: string | null;
250
+ /** The border color as a hexadecimal value. */
251
+ border?: string | null;
252
+ /** The background color as a hexadecimal value. */
253
+ background?: string | null;
254
+ }
255
+ export interface PluginContainerData {
256
+ /** The width of the node when it's displayed. */
257
+ width?: PluginContainerDataWidth;
258
+ /** The node's alignment within its container. */
259
+ alignment?: PluginContainerDataAlignment;
260
+ /** Spoiler cover settings for the node. */
261
+ spoiler?: Spoiler;
262
+ /** The height of the node when it's displayed. */
263
+ height?: Height;
264
+ /** 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`. */
265
+ textWrap?: boolean | null;
266
+ }
267
+ export declare enum WidthType {
268
+ /** Width matches the content width */
269
+ CONTENT = "CONTENT",
270
+ /** Small Width */
271
+ SMALL = "SMALL",
272
+ /** Width will match the original asset width */
273
+ ORIGINAL = "ORIGINAL",
274
+ /** coast-to-coast display */
275
+ FULL_WIDTH = "FULL_WIDTH"
276
+ }
277
+ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
278
+ /**
279
+ * One of the following predefined width options:
280
+ * `CONTENT`: The width of the container matches the content width.
281
+ * `SMALL`: A small width.
282
+ * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
283
+ * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
284
+ */
285
+ size?: WidthType;
286
+ /** A custom width value in pixels. */
287
+ custom?: string | null;
288
+ }
289
+ /** @oneof */
290
+ export interface PluginContainerDataWidthDataOneOf {
291
+ /**
292
+ * One of the following predefined width options:
293
+ * `CONTENT`: The width of the container matches the content width.
294
+ * `SMALL`: A small width.
295
+ * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
296
+ * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
297
+ */
298
+ size?: WidthType;
299
+ /** A custom width value in pixels. */
300
+ custom?: string | null;
301
+ }
302
+ export declare enum PluginContainerDataAlignment {
303
+ /** Center Alignment */
304
+ CENTER = "CENTER",
305
+ /** Left Alignment */
306
+ LEFT = "LEFT",
307
+ /** Right Alignment */
308
+ RIGHT = "RIGHT"
309
+ }
310
+ export interface Spoiler {
311
+ /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
312
+ enabled?: boolean | null;
313
+ /** The description displayed on top of the spoiler cover. */
314
+ description?: string | null;
315
+ /** The text for the button used to remove the spoiler cover. */
316
+ buttonText?: string | null;
317
+ }
318
+ export interface Height {
319
+ /** A custom height value in pixels. */
320
+ custom?: string | null;
321
+ }
322
+ export declare enum Type {
323
+ /** Regular link button */
324
+ LINK = "LINK",
325
+ /** Triggers custom action that is defined in plugin configuration by the consumer */
326
+ ACTION = "ACTION"
327
+ }
328
+ export interface Styles {
329
+ /** Border attributes. */
330
+ border?: Border;
331
+ /** Color attributes. */
332
+ colors?: Colors;
333
+ }
334
+ export interface Link extends LinkDataOneOf {
335
+ /** The absolute URL for the linked document. */
336
+ url?: string;
337
+ /** The target node's ID. Used for linking to another node in this object. */
338
+ anchor?: string;
339
+ /**
340
+ * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
341
+ * `SELF` - Default. Opens the linked document in the same frame as the link.
342
+ * `BLANK` - Opens the linked document in a new browser tab or window.
343
+ * `PARENT` - Opens the linked document in the link's parent frame.
344
+ * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
345
+ */
346
+ target?: Target;
347
+ /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
348
+ rel?: Rel;
349
+ /** A serialized object used for a custom or external link panel. */
350
+ customData?: string | null;
351
+ }
352
+ /** @oneof */
353
+ export interface LinkDataOneOf {
354
+ /** The absolute URL for the linked document. */
355
+ url?: string;
356
+ /** The target node's ID. Used for linking to another node in this object. */
357
+ anchor?: string;
358
+ }
359
+ export declare enum Target {
360
+ /** Opens the linked document in the same frame as it was clicked (this is default) */
361
+ SELF = "SELF",
362
+ /** Opens the linked document in a new window or tab */
363
+ BLANK = "BLANK",
364
+ /** Opens the linked document in the parent frame */
365
+ PARENT = "PARENT",
366
+ /** Opens the linked document in the full body of the window */
367
+ TOP = "TOP"
368
+ }
369
+ export interface Rel {
370
+ /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
371
+ nofollow?: boolean | null;
372
+ /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
373
+ sponsored?: boolean | null;
374
+ /** 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`. */
375
+ ugc?: boolean | null;
376
+ /** Indicates that this link protect referral information from being passed to the target website. */
377
+ noreferrer?: boolean | null;
378
+ }
379
+ export interface CodeBlockData {
380
+ /** Styling for the code block's text. */
381
+ textStyle?: TextStyle;
382
+ }
383
+ export interface TextStyle {
384
+ /** Text alignment. Defaults to `AUTO`. */
385
+ textAlignment?: TextAlignment;
386
+ /** 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. */
387
+ lineHeight?: string | null;
388
+ }
389
+ export declare enum TextAlignment {
390
+ /** browser default, eqivalent to `initial` */
391
+ AUTO = "AUTO",
392
+ /** Left align */
393
+ LEFT = "LEFT",
394
+ /** Right align */
395
+ RIGHT = "RIGHT",
396
+ /** Center align */
397
+ CENTER = "CENTER",
398
+ /** 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 */
399
+ JUSTIFY = "JUSTIFY"
400
+ }
401
+ export interface DividerData {
402
+ /** Styling for the divider's container. */
403
+ containerData?: PluginContainerData;
404
+ /** Divider line style. */
405
+ lineStyle?: LineStyle;
406
+ /** Divider width. */
407
+ width?: Width;
408
+ /** Divider alignment. */
409
+ alignment?: Alignment;
410
+ }
411
+ export declare enum LineStyle {
412
+ /** Single Line */
413
+ SINGLE = "SINGLE",
414
+ /** Double Line */
415
+ DOUBLE = "DOUBLE",
416
+ /** Dashed Line */
417
+ DASHED = "DASHED",
418
+ /** Dotted Line */
419
+ DOTTED = "DOTTED"
420
+ }
421
+ export declare enum Width {
422
+ /** Large line */
423
+ LARGE = "LARGE",
424
+ /** Medium line */
425
+ MEDIUM = "MEDIUM",
426
+ /** Small line */
427
+ SMALL = "SMALL"
428
+ }
429
+ export declare enum Alignment {
430
+ /** Center alignment */
431
+ CENTER = "CENTER",
432
+ /** Left alignment */
433
+ LEFT = "LEFT",
434
+ /** Right alignment */
435
+ RIGHT = "RIGHT"
436
+ }
437
+ export interface FileData {
438
+ /** Styling for the file's container. */
439
+ containerData?: PluginContainerData;
440
+ /** The source for the file's data. */
441
+ src?: FileSource;
442
+ /** File name. */
443
+ name?: string | null;
444
+ /** File type. */
445
+ type?: string | null;
446
+ /**
447
+ * Use `sizeInKb` instead.
448
+ * @deprecated
449
+ */
450
+ size?: number | null;
451
+ /** Settings for PDF files. */
452
+ pdfSettings?: PDFSettings;
453
+ /** File MIME type. */
454
+ mimeType?: string | null;
455
+ /** File path. */
456
+ path?: string | null;
457
+ /** File size in KB. */
458
+ sizeInKb?: string | null;
459
+ }
460
+ export declare enum ViewMode {
461
+ /** No PDF view */
462
+ NONE = "NONE",
463
+ /** Full PDF view */
464
+ FULL = "FULL",
465
+ /** Mini PDF view */
466
+ MINI = "MINI"
467
+ }
468
+ export interface FileSource extends FileSourceDataOneOf {
469
+ /** The absolute URL for the file's source. */
470
+ url?: string | null;
471
+ /**
472
+ * Custom ID. Use `id` instead.
473
+ * @deprecated
474
+ */
475
+ custom?: string | null;
476
+ /** An ID that's resolved to a URL by a resolver function. */
477
+ _id?: string | null;
478
+ /** Indicates whether the file's source is private. Defaults to `false`. */
479
+ private?: boolean | null;
480
+ }
481
+ /** @oneof */
482
+ export interface FileSourceDataOneOf {
483
+ /** The absolute URL for the file's source. */
484
+ url?: string | null;
485
+ /**
486
+ * Custom ID. Use `id` instead.
487
+ * @deprecated
488
+ */
489
+ custom?: string | null;
490
+ /** An ID that's resolved to a URL by a resolver function. */
491
+ _id?: string | null;
492
+ }
493
+ export interface PDFSettings {
494
+ /**
495
+ * PDF view mode. One of the following:
496
+ * `NONE` : The PDF isn't displayed.
497
+ * `FULL` : A full page view of the PDF is displayed.
498
+ * `MINI` : A mini view of the PDF is displayed.
499
+ */
500
+ viewMode?: ViewMode;
501
+ /** Sets whether the PDF download button is disabled. Defaults to `false`. */
502
+ disableDownload?: boolean | null;
503
+ /** Sets whether the PDF print button is disabled. Defaults to `false`. */
504
+ disablePrint?: boolean | null;
505
+ }
506
+ export interface GalleryData {
507
+ /** Styling for the gallery's container. */
508
+ containerData?: PluginContainerData;
509
+ /** The items in the gallery. */
510
+ items?: Item[];
511
+ /** Options for defining the gallery's appearance. */
512
+ options?: GalleryOptions;
513
+ /** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
514
+ disableExpand?: boolean | null;
515
+ /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
516
+ disableDownload?: boolean | null;
517
+ }
518
+ export interface Media {
519
+ /** The source for the media's data. */
520
+ src?: FileSource;
521
+ /** Media width in pixels. */
522
+ width?: number | null;
523
+ /** Media height in pixels. */
524
+ height?: number | null;
525
+ /** Media duration in seconds. Only relevant for audio and video files. */
526
+ duration?: number | null;
527
+ }
528
+ export interface Image {
529
+ /** Image file details. */
530
+ media?: Media;
531
+ /** Link details for images that are links. */
532
+ link?: Link;
533
+ }
534
+ export interface Video {
535
+ /** Video file details. */
536
+ media?: Media;
537
+ /** Video thumbnail file details. */
538
+ thumbnail?: Media;
539
+ }
540
+ export interface Item extends ItemDataOneOf {
541
+ /** An image item. */
542
+ image?: Image;
543
+ /** A video item. */
544
+ video?: Video;
545
+ /** Item title. */
546
+ title?: string | null;
547
+ /** Item's alternative text. */
548
+ altText?: string | null;
549
+ }
550
+ /** @oneof */
551
+ export interface ItemDataOneOf {
552
+ /** An image item. */
553
+ image?: Image;
554
+ /** A video item. */
555
+ video?: Video;
556
+ }
557
+ export interface GalleryOptions {
558
+ /** Gallery layout. */
559
+ layout?: Layout;
560
+ /** Styling for gallery items. */
561
+ item?: ItemStyle;
562
+ /** Styling for gallery thumbnail images. */
563
+ thumbnails?: Thumbnails;
564
+ }
565
+ export declare enum LayoutType {
566
+ /** Collage type */
567
+ COLLAGE = "COLLAGE",
568
+ /** Masonry type */
569
+ MASONRY = "MASONRY",
570
+ /** Grid type */
571
+ GRID = "GRID",
572
+ /** Thumbnail type */
573
+ THUMBNAIL = "THUMBNAIL",
574
+ /** Slider type */
575
+ SLIDER = "SLIDER",
576
+ /** Slideshow type */
577
+ SLIDESHOW = "SLIDESHOW",
578
+ /** Panorama type */
579
+ PANORAMA = "PANORAMA",
580
+ /** Column type */
581
+ COLUMN = "COLUMN",
582
+ /** Magic type */
583
+ MAGIC = "MAGIC",
584
+ /** Fullsize images type */
585
+ FULLSIZE = "FULLSIZE"
586
+ }
587
+ export declare enum Orientation {
588
+ /** Rows Orientation */
589
+ ROWS = "ROWS",
590
+ /** Columns Orientation */
591
+ COLUMNS = "COLUMNS"
592
+ }
593
+ export declare enum Crop {
594
+ /** Crop to fill */
595
+ FILL = "FILL",
596
+ /** Crop to fit */
597
+ FIT = "FIT"
598
+ }
599
+ export declare enum ThumbnailsAlignment {
600
+ /** Top alignment */
601
+ TOP = "TOP",
602
+ /** Right alignment */
603
+ RIGHT = "RIGHT",
604
+ /** Bottom alignment */
605
+ BOTTOM = "BOTTOM",
606
+ /** Left alignment */
607
+ LEFT = "LEFT",
608
+ /** No thumbnail */
609
+ NONE = "NONE"
610
+ }
611
+ export interface Layout {
612
+ /** Gallery layout type. */
613
+ type?: LayoutType;
614
+ /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
615
+ horizontalScroll?: boolean | null;
616
+ /** Gallery orientation. */
617
+ orientation?: Orientation;
618
+ /** The number of columns to display on full size screens. */
619
+ numberOfColumns?: number | null;
620
+ /** The number of columns to display on mobile screens. */
621
+ mobileNumberOfColumns?: number | null;
622
+ }
623
+ export interface ItemStyle {
624
+ /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
625
+ targetSize?: number | null;
626
+ /** Item ratio */
627
+ ratio?: number | null;
628
+ /** Sets how item images are cropped. */
629
+ crop?: Crop;
630
+ /** The spacing between items in pixels. */
631
+ spacing?: number | null;
632
+ }
633
+ export interface Thumbnails {
634
+ /** Thumbnail alignment. */
635
+ placement?: ThumbnailsAlignment;
636
+ /** Spacing between thumbnails in pixels. */
637
+ spacing?: number | null;
638
+ }
639
+ export interface GIFData {
640
+ /** Styling for the GIF's container. */
641
+ containerData?: PluginContainerData;
642
+ /** The source of the full size GIF. */
643
+ original?: GIF;
644
+ /** The source of the downsized GIF. */
645
+ downsized?: GIF;
646
+ /** Height in pixels. */
647
+ height?: number;
648
+ /** Width in pixels. */
649
+ width?: number;
650
+ /** Type of GIF (Sticker or GIF). Defaults to `GIF`. */
651
+ gifType?: GIFType;
652
+ }
653
+ export interface GIF {
654
+ /** GIF format URL. */
655
+ gif?: string | null;
656
+ /** MP4 format URL. */
657
+ mp4?: string | null;
658
+ /** Thumbnail URL. */
659
+ still?: string | null;
660
+ }
661
+ export declare enum GIFType {
662
+ GIF = "GIF",
663
+ STICKER = "STICKER"
664
+ }
665
+ export interface HeadingData {
666
+ /** Heading level from 1-6. */
667
+ level?: number;
668
+ /** Styling for the heading text. */
669
+ textStyle?: TextStyle;
670
+ /** Indentation level from 1-4. */
671
+ indentation?: number | null;
672
+ }
673
+ export interface HTMLData extends HTMLDataDataOneOf {
674
+ /** The URL for the HTML code for the node. */
675
+ url?: string;
676
+ /** The HTML code for the node. */
677
+ html?: string;
678
+ /**
679
+ * Whether this is an AdSense element. Use `source` instead.
680
+ * @deprecated
681
+ */
682
+ isAdsense?: boolean | null;
683
+ /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
684
+ containerData?: PluginContainerData;
685
+ /** The type of HTML code. */
686
+ source?: Source;
687
+ /** If container height is aligned with its content height. Defaults to `true`. */
688
+ autoHeight?: boolean | null;
689
+ }
690
+ /** @oneof */
691
+ export interface HTMLDataDataOneOf {
692
+ /** The URL for the HTML code for the node. */
693
+ url?: string;
694
+ /** The HTML code for the node. */
695
+ html?: string;
696
+ /**
697
+ * Whether this is an AdSense element. Use `source` instead.
698
+ * @deprecated
699
+ */
700
+ isAdsense?: boolean | null;
701
+ }
702
+ export declare enum Source {
703
+ HTML = "HTML",
704
+ ADSENSE = "ADSENSE"
705
+ }
706
+ export interface ImageData {
707
+ /** Styling for the image's container. */
708
+ containerData?: PluginContainerData;
709
+ /** Image file details. */
710
+ image?: Media;
711
+ /** Link details for images that are links. */
712
+ link?: Link;
713
+ /** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
714
+ disableExpand?: boolean | null;
715
+ /** Image's alternative text. */
716
+ altText?: string | null;
717
+ /**
718
+ * Deprecated: use Caption node instead.
719
+ * @deprecated
720
+ */
721
+ caption?: string | null;
722
+ /** Sets whether the image's download button is disabled. Defaults to `false`. */
723
+ disableDownload?: boolean | null;
724
+ }
725
+ export interface LinkPreviewData {
726
+ /** Styling for the link preview's container. */
727
+ containerData?: PluginContainerData;
728
+ /** Link details. */
729
+ link?: Link;
730
+ /** Preview title. */
731
+ title?: string | null;
732
+ /** Preview thumbnail URL. */
733
+ thumbnailUrl?: string | null;
734
+ /** Preview description. */
735
+ description?: string | null;
736
+ /** The preview content as HTML. */
737
+ html?: string | null;
738
+ }
739
+ export interface MapData {
740
+ /** Styling for the map's container. */
741
+ containerData?: PluginContainerData;
742
+ /** Map settings. */
743
+ mapSettings?: MapSettings;
744
+ }
745
+ export interface MapSettings {
746
+ /** The address to display on the map. */
747
+ address?: string | null;
748
+ /** Sets whether the map is draggable. */
749
+ draggable?: boolean | null;
750
+ /** Sets whether the location marker is visible. */
751
+ marker?: boolean | null;
752
+ /** Sets whether street view control is enabled. */
753
+ streetViewControl?: boolean | null;
754
+ /** Sets whether zoom control is enabled. */
755
+ zoomControl?: boolean | null;
756
+ /** Location latitude. */
757
+ lat?: number | null;
758
+ /** Location longitude. */
759
+ lng?: number | null;
760
+ /** Location name. */
761
+ locationName?: string | null;
762
+ /** Sets whether view mode control is enabled. */
763
+ viewModeControl?: boolean | null;
764
+ /** Initial zoom value. */
765
+ initialZoom?: number | null;
766
+ /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
767
+ mapType?: MapType;
768
+ }
769
+ export declare enum MapType {
770
+ /** Roadmap map type */
771
+ ROADMAP = "ROADMAP",
772
+ /** Satellite map type */
773
+ SATELITE = "SATELITE",
774
+ /** Hybrid map type */
775
+ HYBRID = "HYBRID",
776
+ /** Terrain map type */
777
+ TERRAIN = "TERRAIN"
778
+ }
779
+ export interface ParagraphData {
780
+ /** Styling for the paragraph text. */
781
+ textStyle?: TextStyle;
782
+ /** Indentation level from 1-4. */
783
+ indentation?: number | null;
784
+ /** Paragraph level */
785
+ level?: number | null;
786
+ }
787
+ export interface PollData {
788
+ /** Styling for the poll's container. */
789
+ containerData?: PluginContainerData;
790
+ /** Poll data. */
791
+ poll?: Poll;
792
+ /** Layout settings for the poll and voting options. */
793
+ layout?: PollDataLayout;
794
+ /** Styling for the poll and voting options. */
795
+ design?: Design;
796
+ }
797
+ export declare enum ViewRole {
798
+ /** Only Poll creator can view the results */
799
+ CREATOR = "CREATOR",
800
+ /** Anyone who voted can see the results */
801
+ VOTERS = "VOTERS",
802
+ /** Anyone can see the results, even if one didn't vote */
803
+ EVERYONE = "EVERYONE"
804
+ }
805
+ export declare enum VoteRole {
806
+ /** Logged in member */
807
+ SITE_MEMBERS = "SITE_MEMBERS",
808
+ /** Anyone */
809
+ ALL = "ALL"
810
+ }
811
+ export interface Permissions {
812
+ /** Sets who can view the poll results. */
813
+ view?: ViewRole;
814
+ /** Sets who can vote. */
815
+ vote?: VoteRole;
816
+ /** Sets whether one voter can vote multiple times. Defaults to `false`. */
817
+ allowMultipleVotes?: boolean | null;
818
+ }
819
+ export interface Option {
820
+ /** Option ID. */
821
+ _id?: string | null;
822
+ /** Option title. */
823
+ title?: string | null;
824
+ /** The image displayed with the option. */
825
+ image?: Media;
826
+ }
827
+ export interface Settings {
828
+ /** Permissions settings for voting. */
829
+ permissions?: Permissions;
830
+ /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
831
+ showVoters?: boolean | null;
832
+ /** Sets whether the vote count is displayed. Defaults to `true`. */
833
+ showVotesCount?: boolean | null;
834
+ }
835
+ export declare enum PollLayoutType {
836
+ /** List */
837
+ LIST = "LIST",
838
+ /** Grid */
839
+ GRID = "GRID"
840
+ }
841
+ export declare enum PollLayoutDirection {
842
+ /** Left-to-right */
843
+ LTR = "LTR",
844
+ /** Right-to-left */
845
+ RTL = "RTL"
846
+ }
847
+ export interface PollLayout {
848
+ /** The layout for displaying the voting options. */
849
+ type?: PollLayoutType;
850
+ /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
851
+ direction?: PollLayoutDirection;
852
+ /** Sets whether to display the main poll image. Defaults to `false`. */
853
+ enableImage?: boolean | null;
854
+ }
855
+ export interface OptionLayout {
856
+ /** Sets whether to display option images. Defaults to `false`. */
857
+ enableImage?: boolean | null;
858
+ }
859
+ export declare enum BackgroundType {
860
+ /** Color background type */
861
+ COLOR = "COLOR",
862
+ /** Image background type */
863
+ IMAGE = "IMAGE",
864
+ /** Gradiant background type */
865
+ GRADIENT = "GRADIENT"
866
+ }
867
+ export interface Gradient {
868
+ /** The gradient angle in degrees. */
869
+ angle?: number | null;
870
+ /** The start color as a hexademical value. */
871
+ startColor?: string | null;
872
+ /** The end color as a hexademical value. */
873
+ lastColor?: string | null;
874
+ }
875
+ export interface Background extends BackgroundBackgroundOneOf {
876
+ /** The background color as a hexademical value. */
877
+ color?: string | null;
878
+ /** An image to use for the background. */
879
+ image?: Media;
880
+ /** Details for a gradient background. */
881
+ gradient?: Gradient;
882
+ /** Background type. For each option, include the relevant details. */
883
+ type?: BackgroundType;
884
+ }
885
+ /** @oneof */
886
+ export interface BackgroundBackgroundOneOf {
887
+ /** The background color as a hexademical value. */
888
+ color?: string | null;
889
+ /** An image to use for the background. */
890
+ image?: Media;
891
+ /** Details for a gradient background. */
892
+ gradient?: Gradient;
893
+ }
894
+ export interface PollDesign {
895
+ /** Background styling. */
896
+ background?: Background;
897
+ /** Border radius in pixels. */
898
+ borderRadius?: number | null;
899
+ }
900
+ export interface OptionDesign {
901
+ /** Border radius in pixels. */
902
+ borderRadius?: number | null;
903
+ }
904
+ export interface Poll {
905
+ /** Poll ID. */
906
+ _id?: string | null;
907
+ /** Poll title. */
908
+ title?: string | null;
909
+ /** Poll creator ID. */
910
+ creatorId?: string | null;
911
+ /** Main poll image. */
912
+ image?: Media;
913
+ /** Voting options. */
914
+ options?: Option[];
915
+ /** The poll's permissions and display settings. */
916
+ settings?: Settings;
917
+ }
918
+ export interface PollDataLayout {
919
+ /** Poll layout settings. */
920
+ poll?: PollLayout;
921
+ /** Voting otpions layout settings. */
922
+ options?: OptionLayout;
923
+ }
924
+ export interface Design {
925
+ /** Styling for the poll. */
926
+ poll?: PollDesign;
927
+ /** Styling for voting options. */
928
+ options?: OptionDesign;
929
+ }
930
+ export interface TextData {
931
+ /** The text to apply decorations to. */
932
+ text?: string;
933
+ /** The decorations to apply. */
934
+ decorations?: Decoration[];
935
+ }
936
+ /** Adds appearence changes to text */
937
+ export interface Decoration extends DecorationDataOneOf {
938
+ /** Data for an anchor link decoration. */
939
+ anchorData?: AnchorData;
940
+ /** Data for a color decoration. */
941
+ colorData?: ColorData;
942
+ /** Data for an external link decoration. */
943
+ linkData?: LinkData;
944
+ /** Data for a mention decoration. */
945
+ mentionData?: MentionData;
946
+ /** Data for a font size decoration. */
947
+ fontSizeData?: FontSizeData;
948
+ /** Font weight for a bold decoration. */
949
+ fontWeightValue?: number | null;
950
+ /** Data for an italic decoration. Defaults to `true`. */
951
+ italicData?: boolean | null;
952
+ /** Data for an underline decoration. Defaults to `true`. */
953
+ underlineData?: boolean | null;
954
+ /** Data for a spoiler decoration. */
955
+ spoilerData?: SpoilerData;
956
+ /** The type of decoration to apply. */
957
+ type?: DecorationType;
958
+ }
959
+ /** @oneof */
960
+ export interface DecorationDataOneOf {
961
+ /** Data for an anchor link decoration. */
962
+ anchorData?: AnchorData;
963
+ /** Data for a color decoration. */
964
+ colorData?: ColorData;
965
+ /** Data for an external link decoration. */
966
+ linkData?: LinkData;
967
+ /** Data for a mention decoration. */
968
+ mentionData?: MentionData;
969
+ /** Data for a font size decoration. */
970
+ fontSizeData?: FontSizeData;
971
+ /** Font weight for a bold decoration. */
972
+ fontWeightValue?: number | null;
973
+ /** Data for an italic decoration. Defaults to `true`. */
974
+ italicData?: boolean | null;
975
+ /** Data for an underline decoration. Defaults to `true`. */
976
+ underlineData?: boolean | null;
977
+ /** Data for a spoiler decoration. */
978
+ spoilerData?: SpoilerData;
979
+ }
980
+ export declare enum DecorationType {
981
+ BOLD = "BOLD",
982
+ ITALIC = "ITALIC",
983
+ UNDERLINE = "UNDERLINE",
984
+ SPOILER = "SPOILER",
985
+ ANCHOR = "ANCHOR",
986
+ MENTION = "MENTION",
987
+ LINK = "LINK",
988
+ COLOR = "COLOR",
989
+ FONT_SIZE = "FONT_SIZE",
990
+ EXTERNAL = "EXTERNAL"
991
+ }
992
+ export interface AnchorData {
993
+ /** The target node's ID. */
994
+ anchor?: string;
995
+ }
996
+ export interface ColorData {
997
+ /** The text's background color as a hexadecimal value. */
998
+ background?: string | null;
999
+ /** The text's foreground color as a hexadecimal value. */
1000
+ foreground?: string | null;
1001
+ }
1002
+ export interface LinkData {
1003
+ /** Link details. */
1004
+ link?: Link;
1005
+ }
1006
+ export interface MentionData {
1007
+ /** The mentioned user's name. */
1008
+ name?: string;
1009
+ /** The version of the user's name that appears after the `@` character in the mention. */
1010
+ slug?: string;
1011
+ /** Mentioned user's ID. */
1012
+ _id?: string | null;
1013
+ }
1014
+ export interface FontSizeData {
1015
+ /** The units used for the font size. */
1016
+ unit?: FontType;
1017
+ /** Font size value. */
1018
+ value?: number | null;
1019
+ }
1020
+ export declare enum FontType {
1021
+ PX = "PX",
1022
+ EM = "EM"
1023
+ }
1024
+ export interface SpoilerData {
1025
+ /** Spoiler ID. */
1026
+ _id?: string | null;
1027
+ }
1028
+ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1029
+ /** Data for embedded Wix Bookings content. */
1030
+ bookingData?: BookingData;
1031
+ /** Data for embedded Wix Events content. */
1032
+ eventData?: EventData;
1033
+ /** The type of Wix App content being embedded. */
1034
+ type?: AppType;
1035
+ /** The ID of the embedded content. */
1036
+ itemId?: string | null;
1037
+ /** The name of the embedded content. */
1038
+ name?: string | null;
1039
+ /**
1040
+ * Deprecated: Use `image` instead.
1041
+ * @deprecated
1042
+ */
1043
+ imageSrc?: string | null;
1044
+ /** The URL for the embedded content. */
1045
+ url?: string | null;
1046
+ /** An image for the embedded content. */
1047
+ image?: Media;
1048
+ }
1049
+ /** @oneof */
1050
+ export interface AppEmbedDataAppDataOneOf {
1051
+ /** Data for embedded Wix Bookings content. */
1052
+ bookingData?: BookingData;
1053
+ /** Data for embedded Wix Events content. */
1054
+ eventData?: EventData;
1055
+ }
1056
+ export declare enum AppType {
1057
+ PRODUCT = "PRODUCT",
1058
+ EVENT = "EVENT",
1059
+ BOOKING = "BOOKING"
1060
+ }
1061
+ export interface BookingData {
1062
+ /** Booking duration in minutes. */
1063
+ durations?: string | null;
1064
+ }
1065
+ export interface EventData {
1066
+ /** Event schedule. */
1067
+ scheduling?: string | null;
1068
+ /** Event location. */
1069
+ location?: string | null;
1070
+ }
1071
+ export interface VideoData {
1072
+ /** Styling for the video's container. */
1073
+ containerData?: PluginContainerData;
1074
+ /** Video details. */
1075
+ video?: Media;
1076
+ /** Video thumbnail details. */
1077
+ thumbnail?: Media;
1078
+ /** Sets whether the video's download button is disabled. Defaults to `false`. */
1079
+ disableDownload?: boolean | null;
1080
+ /** Video title. */
1081
+ title?: string | null;
1082
+ /** Video options. */
1083
+ options?: PlaybackOptions;
1084
+ }
1085
+ export interface PlaybackOptions {
1086
+ /** Sets whether the media will automatically start playing. */
1087
+ autoPlay?: boolean | null;
1088
+ /** Sets whether media's will be looped. */
1089
+ playInLoop?: boolean | null;
1090
+ /** Sets whether media's controls will be shown. */
1091
+ showControls?: boolean | null;
1092
+ }
1093
+ export interface EmbedData {
1094
+ /** Styling for the oEmbed node's container. */
1095
+ containerData?: PluginContainerData;
1096
+ /** An [oEmbed](https://www.oembed.com) object. */
1097
+ oembed?: Oembed;
1098
+ /** Origin asset source. */
1099
+ src?: string | null;
1100
+ }
1101
+ export interface Oembed {
1102
+ /** The resource type. */
1103
+ type?: string | null;
1104
+ /** The width of the resource specified in the `url` property in pixels. */
1105
+ width?: number | null;
1106
+ /** The height of the resource specified in the `url` property in pixels. */
1107
+ height?: number | null;
1108
+ /** Resource title. */
1109
+ title?: string | null;
1110
+ /** The source URL for the resource. */
1111
+ url?: string | null;
1112
+ /** HTML for embedding a video player. The HTML should have no padding or margins. */
1113
+ html?: string | null;
1114
+ /** The name of the author or owner of the resource. */
1115
+ authorName?: string | null;
1116
+ /** The URL for the author or owner of the resource. */
1117
+ authorUrl?: string | null;
1118
+ /** The name of the resource provider. */
1119
+ providerName?: string | null;
1120
+ /** The URL for the resource provider. */
1121
+ providerUrl?: string | null;
1122
+ /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
1123
+ thumbnailUrl?: string | null;
1124
+ /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
1125
+ thumbnailWidth?: string | null;
1126
+ /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
1127
+ thumbnailHeight?: string | null;
1128
+ /** The URL for an embedded viedo. */
1129
+ videoUrl?: string | null;
1130
+ /** The oEmbed version number. This value must be `1.0`. */
1131
+ version?: string | null;
1132
+ }
1133
+ export interface CollapsibleListData {
1134
+ /** Styling for the collapsible list's container. */
1135
+ containerData?: PluginContainerData;
1136
+ /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
1137
+ expandOnlyOne?: boolean | null;
1138
+ /** Sets which items are expanded when the page loads. */
1139
+ initialExpandedItems?: InitialExpandedItems;
1140
+ /** The direction of the text in the list. Either left-to-right or right-to-left. */
1141
+ direction?: Direction;
1142
+ /** If `true`, The collapsible item will appear in search results as an FAQ. */
1143
+ isQapageData?: boolean | null;
1144
+ }
1145
+ export declare enum InitialExpandedItems {
1146
+ /** First item will be expended initally */
1147
+ FIRST = "FIRST",
1148
+ /** All items will expended initally */
1149
+ ALL = "ALL",
1150
+ /** All items collapsed initally */
1151
+ NONE = "NONE"
1152
+ }
1153
+ export declare enum Direction {
1154
+ /** Left-to-right */
1155
+ LTR = "LTR",
1156
+ /** Right-to-left */
1157
+ RTL = "RTL"
1158
+ }
1159
+ export interface TableData {
1160
+ /** Styling for the table's container. */
1161
+ containerData?: PluginContainerData;
1162
+ /** The table's dimensions. */
1163
+ dimensions?: Dimensions;
1164
+ /**
1165
+ * Deprecated: Use `rowHeader` and `columnHeader` instead.
1166
+ * @deprecated
1167
+ */
1168
+ header?: boolean | null;
1169
+ /** Sets whether the table's first row is a header. Defaults to `false`. */
1170
+ rowHeader?: boolean | null;
1171
+ /** Sets whether the table's first column is a header. Defaults to `false`. */
1172
+ columnHeader?: boolean | null;
1173
+ }
1174
+ export interface Dimensions {
1175
+ /** An array representing relative width of each column in relation to the other columns. */
1176
+ colsWidthRatio?: number[];
1177
+ /** An array representing the height of each row in pixels. */
1178
+ rowsHeight?: number[];
1179
+ /** An array representing the minimum width of each column in pixels. */
1180
+ colsMinWidth?: number[];
1181
+ }
1182
+ export interface TableCellData {
1183
+ /** Styling for the cell's background color and text alignment. */
1184
+ cellStyle?: CellStyle;
1185
+ /** The cell's border colors. */
1186
+ borderColors?: BorderColors;
1187
+ }
1188
+ export declare enum VerticalAlignment {
1189
+ /** Top alignment */
1190
+ TOP = "TOP",
1191
+ /** Middle alignment */
1192
+ MIDDLE = "MIDDLE",
1193
+ /** Bottom alignment */
1194
+ BOTTOM = "BOTTOM"
1195
+ }
1196
+ export interface CellStyle {
1197
+ /** Vertical alignment for the cell's text. */
1198
+ verticalAlignment?: VerticalAlignment;
1199
+ /** Cell background color as a hexadecimal value. */
1200
+ backgroundColor?: string | null;
1201
+ }
1202
+ export interface BorderColors {
1203
+ /** Left border color as a hexadecimal value. */
1204
+ left?: string | null;
1205
+ /** Right border color as a hexadecimal value. */
1206
+ right?: string | null;
1207
+ /** Top border color as a hexadecimal value. */
1208
+ top?: string | null;
1209
+ /** Bottom border color as a hexadecimal value. */
1210
+ bottom?: string | null;
1211
+ }
1212
+ /**
1213
+ * `NullValue` is a singleton enumeration to represent the null value for the
1214
+ * `Value` type union.
1215
+ *
1216
+ * The JSON representation for `NullValue` is JSON `null`.
1217
+ */
1218
+ export declare enum NullValue {
1219
+ /** Null value. */
1220
+ NULL_VALUE = "NULL_VALUE"
1221
+ }
1222
+ /**
1223
+ * `ListValue` is a wrapper around a repeated field of values.
1224
+ *
1225
+ * The JSON representation for `ListValue` is JSON array.
1226
+ */
1227
+ export interface ListValue {
1228
+ /** Repeated field of dynamically typed values. */
1229
+ values?: any[];
1230
+ }
1231
+ export interface AudioData {
1232
+ /** Styling for the audio node's container. */
1233
+ containerData?: PluginContainerData;
1234
+ /** Audio file details. */
1235
+ audio?: Media;
1236
+ /** Sets whether the audio node's download button is disabled. Defaults to `false`. */
1237
+ disableDownload?: boolean | null;
1238
+ /** Cover image. */
1239
+ coverImage?: Media;
1240
+ /** Track name. */
1241
+ name?: string | null;
1242
+ /** Author name. */
1243
+ authorName?: string | null;
1244
+ /** An HTML version of the audio node. */
1245
+ html?: string | null;
1246
+ }
1247
+ export interface OrderedListData {
1248
+ /** Indentation level from 0-4. */
1249
+ indentation?: number;
1250
+ /** Offset level from 0-4. */
1251
+ offset?: number | null;
1252
+ /** List start number. */
1253
+ start?: number | null;
1254
+ }
1255
+ export interface BulletedListData {
1256
+ /** Indentation level from 0-4. */
1257
+ indentation?: number;
1258
+ /** Offset level from 0-4. */
1259
+ offset?: number | null;
1260
+ }
1261
+ export interface BlockquoteData {
1262
+ /** Indentation level from 1-4. */
1263
+ indentation?: number;
1264
+ }
1265
+ export interface CaptionData {
1266
+ textStyle?: TextStyle;
1267
+ }
1268
+ export interface LayoutCellData {
1269
+ /** Size of the cell in 12 columns grid. */
1270
+ colSpan?: number | null;
1271
+ }
1272
+ export interface Metadata {
1273
+ /** Schema version. */
1274
+ version?: number;
1275
+ /**
1276
+ * When the object was created.
1277
+ * @readonly
1278
+ * @deprecated
1279
+ */
1280
+ createdTimestamp?: Date | null;
1281
+ /**
1282
+ * When the object was most recently updated.
1283
+ * @deprecated
1284
+ */
1285
+ updatedTimestamp?: Date | null;
1286
+ /** Object ID. */
1287
+ _id?: string | null;
1288
+ }
1289
+ export interface DocumentStyle {
1290
+ /** Styling for H1 nodes. */
1291
+ headerOne?: TextNodeStyle;
1292
+ /** Styling for H2 nodes. */
1293
+ headerTwo?: TextNodeStyle;
1294
+ /** Styling for H3 nodes. */
1295
+ headerThree?: TextNodeStyle;
1296
+ /** Styling for H4 nodes. */
1297
+ headerFour?: TextNodeStyle;
1298
+ /** Styling for H5 nodes. */
1299
+ headerFive?: TextNodeStyle;
1300
+ /** Styling for H6 nodes. */
1301
+ headerSix?: TextNodeStyle;
1302
+ /** Styling for paragraph nodes. */
1303
+ paragraph?: TextNodeStyle;
1304
+ /** Styling for block quote nodes. */
1305
+ blockquote?: TextNodeStyle;
1306
+ /** Styling for code block nodes. */
1307
+ codeBlock?: TextNodeStyle;
1308
+ }
1309
+ export interface TextNodeStyle {
1310
+ /** The decorations to apply to the node. */
1311
+ decorations?: Decoration[];
1312
+ /** Padding and background color for the node. */
1313
+ nodeStyle?: NodeStyle;
1314
+ /** Line height for text in the node. */
1315
+ lineHeight?: string | null;
1316
+ }
1317
+ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
1318
+ /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
1319
+ metaSiteId?: string;
1320
+ /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
1321
+ siteId?: string;
1322
+ /** Invalidate by App */
1323
+ app?: App;
1324
+ /** Invalidate by page id */
1325
+ page?: Page;
1326
+ /** Invalidate by URI path */
1327
+ uri?: URI;
1328
+ /** Invalidate by file (for media files such as PDFs) */
1329
+ file?: File;
1330
+ /** tell us why you're invalidating the cache. You don't need to add your app name */
1331
+ reason?: string | null;
1332
+ /** Is local DS */
1333
+ localDc?: boolean;
1334
+ hardPurge?: boolean;
1335
+ }
1336
+ /** @oneof */
1337
+ export interface InvalidateCacheGetByOneOf {
1338
+ /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
1339
+ metaSiteId?: string;
1340
+ /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
1341
+ siteId?: string;
1342
+ /** Invalidate by App */
1343
+ app?: App;
1344
+ /** Invalidate by page id */
1345
+ page?: Page;
1346
+ /** Invalidate by URI path */
1347
+ uri?: URI;
1348
+ /** Invalidate by file (for media files such as PDFs) */
1349
+ file?: File;
1350
+ }
1351
+ export interface App {
1352
+ /** The AppDefId */
1353
+ appDefId?: string;
1354
+ /** The instance Id */
1355
+ instanceId?: string;
1356
+ }
1357
+ export interface Page {
1358
+ /** the msid the page is on */
1359
+ metaSiteId?: string;
1360
+ /** Invalidate by Page ID */
1361
+ pageId?: string;
1362
+ }
1363
+ export interface URI {
1364
+ /** the msid the URI is on */
1365
+ metaSiteId?: string;
1366
+ /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
1367
+ uriPath?: string;
1368
+ }
1369
+ export interface File {
1370
+ /** the msid the file is related to */
1371
+ metaSiteId?: string;
1372
+ /** Invalidate by filename (for media files such as PDFs) */
1373
+ fileName?: string;
1374
+ }
1375
+ export interface CreateInfoSectionRequest {
1376
+ /** Info section to create. */
1377
+ infoSection: InfoSection;
1378
+ }
1379
+ export interface CreateInfoSectionResponse {
1380
+ /** Created info section. */
1381
+ infoSection?: InfoSection;
1382
+ }
1383
+ export interface GetInfoSectionRequest {
1384
+ /** Info section ID. */
1385
+ infoSectionId: string;
1386
+ /**
1387
+ * Fields to include in the response.
1388
+ *
1389
+ * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1390
+ */
1391
+ fields?: RequestedFields[];
1392
+ }
1393
+ export declare enum RequestedFields {
1394
+ UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
1395
+ ASSIGNED_PRODUCTS_COUNT = "ASSIGNED_PRODUCTS_COUNT"
1396
+ }
1397
+ export interface GetInfoSectionResponse {
1398
+ /** Info section. */
1399
+ infoSection?: InfoSection;
1400
+ }
1401
+ export interface GetOrCreateInfoSectionRequest {
1402
+ /** Info section to retrieve or create. */
1403
+ infoSection?: InfoSectionForGetOrCreate;
1404
+ /**
1405
+ * Fields to include in the response.
1406
+ *
1407
+ * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1408
+ */
1409
+ fields?: RequestedFields[];
1410
+ }
1411
+ export interface InfoSectionForGetOrCreate {
1412
+ /**
1413
+ * Info section ID.
1414
+ * Pass an ID to retrieve an existing info section.
1415
+ */
1416
+ _id?: string | null;
1417
+ /**
1418
+ * Info section unique name.
1419
+ *
1420
+ * > **Note:**
1421
+ * > + Pass the `uniqueName` of an existing info section to return it.
1422
+ * > + If no such info section exists - pass `uniqueName` and `title` to create an info section.
1423
+ */
1424
+ uniqueName?: string | null;
1425
+ /**
1426
+ * Info section title.
1427
+ *
1428
+ * Required when passing `uniqueName` to create a new info section.
1429
+ */
1430
+ title?: string | null;
1431
+ /**
1432
+ * Info section description using rich content.
1433
+ *
1434
+ * Learn more about [Working with Rich Content](https://dev.wix.com/docs/go-headless/tutorials-templates/other-tutorials/working-with-rich-content).
1435
+ */
1436
+ description?: RichContent;
1437
+ /**
1438
+ * Info section description in HTML.
1439
+ *
1440
+ * When provided on create/update, this string must be a valid HTML. It will then be converted to rich content.
1441
+ * `plainDescription` is ignored when value is also passed to the `description` field.
1442
+ */
1443
+ plainDescription?: string | null;
1444
+ }
1445
+ export interface GetOrCreateInfoSectionResponse {
1446
+ /** Info section. */
1447
+ infoSection?: InfoSection;
1448
+ }
1449
+ export interface BulkGetOrCreateInfoSectionsRequest {
1450
+ /** Info sections to retrieve or create. */
1451
+ infoSections?: InfoSectionForGetOrCreate[];
1452
+ /**
1453
+ * Fields to include in the response.
1454
+ *
1455
+ * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1456
+ */
1457
+ fields?: RequestedFields[];
1458
+ }
1459
+ export interface BulkGetOrCreateInfoSectionsResponse {
1460
+ /** Info sections retrieved or created by bulk action. */
1461
+ results?: BulkInfoSectionItemResult[];
1462
+ /** Bulk action metadata. */
1463
+ bulkActionMetadata?: BulkActionMetadata;
1464
+ }
1465
+ export interface BulkInfoSectionItemResult {
1466
+ /** Bulk action metadata for inventory item. */
1467
+ itemMetadata?: ItemMetadata;
1468
+ /**
1469
+ * Full inventory item entity.
1470
+ *
1471
+ * Returned only if `returnEntity: true` is passed in the request.
1472
+ */
1473
+ item?: InfoSection;
1474
+ }
1475
+ export interface ItemMetadata {
1476
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
1477
+ _id?: string | null;
1478
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
1479
+ originalIndex?: number;
1480
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
1481
+ success?: boolean;
1482
+ /** Details about the error in case of failure. */
1483
+ error?: ApplicationError;
1484
+ }
1485
+ export interface ApplicationError {
1486
+ /** Error code. */
1487
+ code?: string;
1488
+ /** Description of the error. */
1489
+ description?: string;
1490
+ /** Data related to the error. */
1491
+ data?: Record<string, any> | null;
1492
+ }
1493
+ export interface BulkActionMetadata {
1494
+ /** Number of items that were successfully processed. */
1495
+ totalSuccesses?: number;
1496
+ /** Number of items that couldn't be processed. */
1497
+ totalFailures?: number;
1498
+ /** Number of failures without details because detailed failure threshold was exceeded. */
1499
+ undetailedFailures?: number;
1500
+ }
1501
+ export interface UpdateInfoSectionRequest {
1502
+ /** Info section to update. */
1503
+ infoSection: InfoSection;
1504
+ /**
1505
+ * Fields to include in the response.
1506
+ *
1507
+ * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1508
+ */
1509
+ fields?: RequestedFields[];
1510
+ }
1511
+ export interface UpdateInfoSectionResponse {
1512
+ /** Updated info section. */
1513
+ infoSection?: InfoSection;
1514
+ }
1515
+ export interface DeleteInfoSectionRequest {
1516
+ /** Info section ID */
1517
+ infoSectionId: string;
1518
+ }
1519
+ export interface DeleteInfoSectionResponse {
1520
+ }
1521
+ export interface QueryInfoSectionsRequest {
1522
+ /** Query options. */
1523
+ query?: CursorQuery;
1524
+ /**
1525
+ * Fields to include in the response.
1526
+ *
1527
+ * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1528
+ */
1529
+ fields?: RequestedFields[];
1530
+ }
1531
+ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1532
+ /**
1533
+ * Cursor paging options.
1534
+ *
1535
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
1536
+ */
1537
+ cursorPaging?: CursorPaging;
1538
+ /**
1539
+ * Filter object.
1540
+ *
1541
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
1542
+ */
1543
+ filter?: Record<string, any> | null;
1544
+ /**
1545
+ * Sort object.
1546
+ *
1547
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
1548
+ */
1549
+ sort?: Sorting[];
1550
+ }
1551
+ /** @oneof */
1552
+ export interface CursorQueryPagingMethodOneOf {
1553
+ /**
1554
+ * Cursor paging options.
1555
+ *
1556
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
1557
+ */
1558
+ cursorPaging?: CursorPaging;
1559
+ }
1560
+ export interface Sorting {
1561
+ /** Name of the field to sort by. */
1562
+ fieldName?: string;
1563
+ /** Sort order. */
1564
+ order?: SortOrder;
1565
+ }
1566
+ export declare enum SortOrder {
1567
+ ASC = "ASC",
1568
+ DESC = "DESC"
1569
+ }
1570
+ export interface CursorPaging {
1571
+ /** Maximum number of items to return in the results. */
1572
+ limit?: number | null;
1573
+ /**
1574
+ * Pointer to the next or previous page in the list of results.
1575
+ *
1576
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1577
+ * Not relevant for the first request.
1578
+ */
1579
+ cursor?: string | null;
1580
+ }
1581
+ export interface QueryInfoSectionsResponse {
1582
+ /** List of info sections. */
1583
+ infoSections?: InfoSection[];
1584
+ /** Details on the paged set of results returned. */
1585
+ pagingMetadata?: CursorPagingMetadata;
1586
+ }
1587
+ export interface CursorPagingMetadata {
1588
+ /** Number of items returned in current page. */
1589
+ count?: number | null;
1590
+ /** Cursor strings that point to the next page, previous page, or both. */
1591
+ cursors?: Cursors;
1592
+ /**
1593
+ * Whether there are more pages to retrieve following the current page.
1594
+ *
1595
+ * + `true`: Another page of results can be retrieved.
1596
+ * + `false`: This is the last page.
1597
+ */
1598
+ hasNext?: boolean | null;
1599
+ }
1600
+ export interface Cursors {
1601
+ /** Cursor string pointing to the next page in the list of results. */
1602
+ next?: string | null;
1603
+ /** Cursor pointing to the previous page in the list of results. */
1604
+ prev?: string | null;
1605
+ }
1606
+ export interface BulkCreateInfoSectionsRequest {
1607
+ /** Info sections to create. */
1608
+ infoSections: InfoSection[];
1609
+ /**
1610
+ * Whether to return the full created info section entities in the response.
1611
+ *
1612
+ * Default: `false`
1613
+ */
1614
+ returnEntity?: boolean;
1615
+ }
1616
+ export interface BulkCreateInfoSectionsResponse {
1617
+ /** Info sections created by bulk action. */
1618
+ results?: BulkInfoSectionItemResult[];
1619
+ /** Bulk action metadata. */
1620
+ bulkActionMetadata?: BulkActionMetadata;
1621
+ }
1622
+ export interface BulkUpdateInfoSectionsRequest {
1623
+ /** List of info sections to update. */
1624
+ infoSections: MaskedInfoSection[];
1625
+ /**
1626
+ * Whether to return the full updated info sections entities in the response.
1627
+ *
1628
+ * Default: `false`
1629
+ */
1630
+ returnEntity?: boolean;
1631
+ /**
1632
+ * Fields to include in the response.
1633
+ *
1634
+ * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1635
+ */
1636
+ fields?: RequestedFields[];
1637
+ }
1638
+ export interface MaskedInfoSection {
1639
+ /** Info section to update. */
1640
+ infoSection?: InfoSection;
1641
+ /** Explicit list of fields to update. */
1642
+ fieldMask?: string[];
1643
+ }
1644
+ export interface BulkUpdateInfoSectionsResponse {
1645
+ /** Info sections updated by bulk action. */
1646
+ results?: BulkInfoSectionItemResult[];
1647
+ /** Bulk action metadata. */
1648
+ bulkActionMetadata?: BulkActionMetadata;
1649
+ }
1650
+ export interface BulkDeleteInfoSectionsRequest {
1651
+ /** IDs of info sections to delete. */
1652
+ infoSectionIds: string[];
1653
+ }
1654
+ export interface BulkDeleteInfoSectionsResponse {
1655
+ /** Info sections deleted by bulk action */
1656
+ results?: BulkInfoSectionResult[];
1657
+ /** Bulk action metadata. */
1658
+ bulkActionMetadata?: BulkActionMetadata;
1659
+ }
1660
+ export interface BulkInfoSectionResult {
1661
+ /** Bulk action metadata for info section. */
1662
+ itemMetadata?: ItemMetadata;
1663
+ }
1664
+ export interface DomainEvent extends DomainEventBodyOneOf {
1665
+ createdEvent?: EntityCreatedEvent;
1666
+ updatedEvent?: EntityUpdatedEvent;
1667
+ deletedEvent?: EntityDeletedEvent;
1668
+ actionEvent?: ActionEvent;
1669
+ /**
1670
+ * Unique event ID.
1671
+ * Allows clients to ignore duplicate webhooks.
1672
+ */
1673
+ _id?: string;
1674
+ /**
1675
+ * Assumes actions are also always typed to an entity_type
1676
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1677
+ */
1678
+ entityFqdn?: string;
1679
+ /**
1680
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1681
+ * This is although the created/updated/deleted notion is duplication of the oneof types
1682
+ * Example: created/updated/deleted/started/completed/email_opened
1683
+ */
1684
+ slug?: string;
1685
+ /** ID of the entity associated with the event. */
1686
+ entityId?: string;
1687
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1688
+ eventTime?: Date | null;
1689
+ /**
1690
+ * Whether the event was triggered as a result of a privacy regulation application
1691
+ * (for example, GDPR).
1692
+ */
1693
+ triggeredByAnonymizeRequest?: boolean | null;
1694
+ /** If present, indicates the action that triggered the event. */
1695
+ originatedFrom?: string | null;
1696
+ /**
1697
+ * A sequence number defining the order of updates to the underlying entity.
1698
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
1699
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1700
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1701
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
1702
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1703
+ */
1704
+ entityEventSequence?: string | null;
1705
+ }
1706
+ /** @oneof */
1707
+ export interface DomainEventBodyOneOf {
1708
+ createdEvent?: EntityCreatedEvent;
1709
+ updatedEvent?: EntityUpdatedEvent;
1710
+ deletedEvent?: EntityDeletedEvent;
1711
+ actionEvent?: ActionEvent;
1712
+ }
1713
+ export interface EntityCreatedEvent {
1714
+ entity?: string;
1715
+ }
1716
+ export interface RestoreInfo {
1717
+ deletedDate?: Date | null;
1718
+ }
1719
+ export interface EntityUpdatedEvent {
1720
+ /**
1721
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1722
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1723
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1724
+ */
1725
+ currentEntity?: string;
1726
+ }
1727
+ export interface EntityDeletedEvent {
1728
+ /** Entity that was deleted */
1729
+ deletedEntity?: string | null;
1730
+ }
1731
+ export interface ActionEvent {
1732
+ body?: string;
1733
+ }
1734
+ export interface Empty {
1735
+ }
1736
+ export interface MessageEnvelope {
1737
+ /** App instance ID. */
1738
+ instanceId?: string | null;
1739
+ /** Event type. */
1740
+ eventType?: string;
1741
+ /** The identification type and identity data. */
1742
+ identity?: IdentificationData;
1743
+ /** Stringify payload. */
1744
+ data?: string;
1745
+ }
1746
+ export interface IdentificationData extends IdentificationDataIdOneOf {
1747
+ /** ID of a site visitor that has not logged in to the site. */
1748
+ anonymousVisitorId?: string;
1749
+ /** ID of a site visitor that has logged in to the site. */
1750
+ memberId?: string;
1751
+ /** ID of a Wix user (site owner, contributor, etc.). */
1752
+ wixUserId?: string;
1753
+ /** ID of an app. */
1754
+ appId?: string;
1755
+ /** @readonly */
1756
+ identityType?: WebhookIdentityType;
1757
+ }
1758
+ /** @oneof */
1759
+ export interface IdentificationDataIdOneOf {
1760
+ /** ID of a site visitor that has not logged in to the site. */
1761
+ anonymousVisitorId?: string;
1762
+ /** ID of a site visitor that has logged in to the site. */
1763
+ memberId?: string;
1764
+ /** ID of a Wix user (site owner, contributor, etc.). */
1765
+ wixUserId?: string;
1766
+ /** ID of an app. */
1767
+ appId?: string;
1768
+ }
1769
+ export declare enum WebhookIdentityType {
1770
+ UNKNOWN = "UNKNOWN",
1771
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1772
+ MEMBER = "MEMBER",
1773
+ WIX_USER = "WIX_USER",
1774
+ APP = "APP"
1775
+ }
1776
+ interface PluginContainerDataWidthNonNullableFields {
1777
+ size: WidthType;
1778
+ }
1779
+ interface PluginContainerDataNonNullableFields {
1780
+ width?: PluginContainerDataWidthNonNullableFields;
1781
+ alignment: PluginContainerDataAlignment;
1782
+ }
1783
+ interface LinkNonNullableFields {
1784
+ url: string;
1785
+ anchor: string;
1786
+ target: Target;
1787
+ }
1788
+ interface ButtonDataNonNullableFields {
1789
+ containerData?: PluginContainerDataNonNullableFields;
1790
+ type: Type;
1791
+ link?: LinkNonNullableFields;
1792
+ }
1793
+ interface TextStyleNonNullableFields {
1794
+ textAlignment: TextAlignment;
1795
+ }
1796
+ interface CodeBlockDataNonNullableFields {
1797
+ textStyle?: TextStyleNonNullableFields;
1798
+ }
1799
+ interface DividerDataNonNullableFields {
1800
+ containerData?: PluginContainerDataNonNullableFields;
1801
+ lineStyle: LineStyle;
1802
+ width: Width;
1803
+ alignment: Alignment;
1804
+ }
1805
+ interface PDFSettingsNonNullableFields {
1806
+ viewMode: ViewMode;
1807
+ }
1808
+ interface FileDataNonNullableFields {
1809
+ containerData?: PluginContainerDataNonNullableFields;
1810
+ pdfSettings?: PDFSettingsNonNullableFields;
1811
+ }
1812
+ interface ImageNonNullableFields {
1813
+ link?: LinkNonNullableFields;
1814
+ }
1815
+ interface ItemNonNullableFields {
1816
+ image?: ImageNonNullableFields;
1817
+ }
1818
+ interface LayoutNonNullableFields {
1819
+ type: LayoutType;
1820
+ orientation: Orientation;
1821
+ }
1822
+ interface ItemStyleNonNullableFields {
1823
+ crop: Crop;
1824
+ }
1825
+ interface ThumbnailsNonNullableFields {
1826
+ placement: ThumbnailsAlignment;
1827
+ }
1828
+ interface GalleryOptionsNonNullableFields {
1829
+ layout?: LayoutNonNullableFields;
1830
+ item?: ItemStyleNonNullableFields;
1831
+ thumbnails?: ThumbnailsNonNullableFields;
1832
+ }
1833
+ interface GalleryDataNonNullableFields {
1834
+ containerData?: PluginContainerDataNonNullableFields;
1835
+ items: ItemNonNullableFields[];
1836
+ options?: GalleryOptionsNonNullableFields;
1837
+ }
1838
+ interface GIFDataNonNullableFields {
1839
+ containerData?: PluginContainerDataNonNullableFields;
1840
+ height: number;
1841
+ width: number;
1842
+ gifType: GIFType;
1843
+ }
1844
+ interface HeadingDataNonNullableFields {
1845
+ level: number;
1846
+ textStyle?: TextStyleNonNullableFields;
1847
+ }
1848
+ interface HTMLDataNonNullableFields {
1849
+ url: string;
1850
+ html: string;
1851
+ containerData?: PluginContainerDataNonNullableFields;
1852
+ source: Source;
1853
+ }
1854
+ interface ImageDataNonNullableFields {
1855
+ containerData?: PluginContainerDataNonNullableFields;
1856
+ link?: LinkNonNullableFields;
1857
+ }
1858
+ interface LinkPreviewDataNonNullableFields {
1859
+ containerData?: PluginContainerDataNonNullableFields;
1860
+ link?: LinkNonNullableFields;
1861
+ }
1862
+ interface MapSettingsNonNullableFields {
1863
+ mapType: MapType;
1864
+ }
1865
+ interface MapDataNonNullableFields {
1866
+ containerData?: PluginContainerDataNonNullableFields;
1867
+ mapSettings?: MapSettingsNonNullableFields;
1868
+ }
1869
+ interface ParagraphDataNonNullableFields {
1870
+ textStyle?: TextStyleNonNullableFields;
1871
+ }
1872
+ interface PermissionsNonNullableFields {
1873
+ view: ViewRole;
1874
+ vote: VoteRole;
1875
+ }
1876
+ interface SettingsNonNullableFields {
1877
+ permissions?: PermissionsNonNullableFields;
1878
+ }
1879
+ interface PollNonNullableFields {
1880
+ settings?: SettingsNonNullableFields;
1881
+ }
1882
+ interface PollLayoutNonNullableFields {
1883
+ type: PollLayoutType;
1884
+ direction: PollLayoutDirection;
1885
+ }
1886
+ interface PollDataLayoutNonNullableFields {
1887
+ poll?: PollLayoutNonNullableFields;
1888
+ }
1889
+ interface BackgroundNonNullableFields {
1890
+ type: BackgroundType;
1891
+ }
1892
+ interface PollDesignNonNullableFields {
1893
+ background?: BackgroundNonNullableFields;
1894
+ }
1895
+ interface DesignNonNullableFields {
1896
+ poll?: PollDesignNonNullableFields;
1897
+ }
1898
+ interface PollDataNonNullableFields {
1899
+ containerData?: PluginContainerDataNonNullableFields;
1900
+ poll?: PollNonNullableFields;
1901
+ layout?: PollDataLayoutNonNullableFields;
1902
+ design?: DesignNonNullableFields;
1903
+ }
1904
+ interface AnchorDataNonNullableFields {
1905
+ anchor: string;
1906
+ }
1907
+ interface LinkDataNonNullableFields {
1908
+ link?: LinkNonNullableFields;
1909
+ }
1910
+ interface MentionDataNonNullableFields {
1911
+ name: string;
1912
+ slug: string;
1913
+ }
1914
+ interface FontSizeDataNonNullableFields {
1915
+ unit: FontType;
1916
+ }
1917
+ interface DecorationNonNullableFields {
1918
+ anchorData?: AnchorDataNonNullableFields;
1919
+ linkData?: LinkDataNonNullableFields;
1920
+ mentionData?: MentionDataNonNullableFields;
1921
+ fontSizeData?: FontSizeDataNonNullableFields;
1922
+ type: DecorationType;
1923
+ }
1924
+ interface TextDataNonNullableFields {
1925
+ text: string;
1926
+ decorations: DecorationNonNullableFields[];
1927
+ }
1928
+ interface AppEmbedDataNonNullableFields {
1929
+ type: AppType;
1930
+ }
1931
+ interface VideoDataNonNullableFields {
1932
+ containerData?: PluginContainerDataNonNullableFields;
1933
+ }
1934
+ interface EmbedDataNonNullableFields {
1935
+ containerData?: PluginContainerDataNonNullableFields;
1936
+ }
1937
+ interface CollapsibleListDataNonNullableFields {
1938
+ containerData?: PluginContainerDataNonNullableFields;
1939
+ initialExpandedItems: InitialExpandedItems;
1940
+ direction: Direction;
1941
+ }
1942
+ interface DimensionsNonNullableFields {
1943
+ colsWidthRatio: number[];
1944
+ rowsHeight: number[];
1945
+ colsMinWidth: number[];
1946
+ }
1947
+ interface TableDataNonNullableFields {
1948
+ containerData?: PluginContainerDataNonNullableFields;
1949
+ dimensions?: DimensionsNonNullableFields;
1950
+ }
1951
+ interface CellStyleNonNullableFields {
1952
+ verticalAlignment: VerticalAlignment;
1953
+ }
1954
+ interface TableCellDataNonNullableFields {
1955
+ cellStyle?: CellStyleNonNullableFields;
1956
+ }
1957
+ interface AudioDataNonNullableFields {
1958
+ containerData?: PluginContainerDataNonNullableFields;
1959
+ }
1960
+ interface OrderedListDataNonNullableFields {
1961
+ indentation: number;
1962
+ }
1963
+ interface BulletedListDataNonNullableFields {
1964
+ indentation: number;
1965
+ }
1966
+ interface BlockquoteDataNonNullableFields {
1967
+ indentation: number;
1968
+ }
1969
+ interface CaptionDataNonNullableFields {
1970
+ textStyle?: TextStyleNonNullableFields;
1971
+ }
1972
+ interface NodeNonNullableFields {
1973
+ buttonData?: ButtonDataNonNullableFields;
1974
+ codeBlockData?: CodeBlockDataNonNullableFields;
1975
+ dividerData?: DividerDataNonNullableFields;
1976
+ fileData?: FileDataNonNullableFields;
1977
+ galleryData?: GalleryDataNonNullableFields;
1978
+ gifData?: GIFDataNonNullableFields;
1979
+ headingData?: HeadingDataNonNullableFields;
1980
+ htmlData?: HTMLDataNonNullableFields;
1981
+ imageData?: ImageDataNonNullableFields;
1982
+ linkPreviewData?: LinkPreviewDataNonNullableFields;
1983
+ mapData?: MapDataNonNullableFields;
1984
+ paragraphData?: ParagraphDataNonNullableFields;
1985
+ pollData?: PollDataNonNullableFields;
1986
+ textData?: TextDataNonNullableFields;
1987
+ appEmbedData?: AppEmbedDataNonNullableFields;
1988
+ videoData?: VideoDataNonNullableFields;
1989
+ embedData?: EmbedDataNonNullableFields;
1990
+ collapsibleListData?: CollapsibleListDataNonNullableFields;
1991
+ tableData?: TableDataNonNullableFields;
1992
+ tableCellData?: TableCellDataNonNullableFields;
1993
+ audioData?: AudioDataNonNullableFields;
1994
+ orderedListData?: OrderedListDataNonNullableFields;
1995
+ bulletedListData?: BulletedListDataNonNullableFields;
1996
+ blockquoteData?: BlockquoteDataNonNullableFields;
1997
+ captionData?: CaptionDataNonNullableFields;
1998
+ type: NodeType;
1999
+ _id: string;
2000
+ nodes: NodeNonNullableFields[];
2001
+ }
2002
+ interface MetadataNonNullableFields {
2003
+ version: number;
2004
+ }
2005
+ interface TextNodeStyleNonNullableFields {
2006
+ decorations: DecorationNonNullableFields[];
2007
+ }
2008
+ interface DocumentStyleNonNullableFields {
2009
+ headerOne?: TextNodeStyleNonNullableFields;
2010
+ headerTwo?: TextNodeStyleNonNullableFields;
2011
+ headerThree?: TextNodeStyleNonNullableFields;
2012
+ headerFour?: TextNodeStyleNonNullableFields;
2013
+ headerFive?: TextNodeStyleNonNullableFields;
2014
+ headerSix?: TextNodeStyleNonNullableFields;
2015
+ paragraph?: TextNodeStyleNonNullableFields;
2016
+ blockquote?: TextNodeStyleNonNullableFields;
2017
+ codeBlock?: TextNodeStyleNonNullableFields;
2018
+ }
2019
+ interface RichContentNonNullableFields {
2020
+ nodes: NodeNonNullableFields[];
2021
+ metadata?: MetadataNonNullableFields;
2022
+ documentStyle?: DocumentStyleNonNullableFields;
2023
+ }
2024
+ export interface InfoSectionNonNullableFields {
2025
+ uniqueName: string;
2026
+ title: string;
2027
+ description?: RichContentNonNullableFields;
2028
+ }
2029
+ export interface CreateInfoSectionResponseNonNullableFields {
2030
+ infoSection?: InfoSectionNonNullableFields;
2031
+ }
2032
+ export interface GetInfoSectionResponseNonNullableFields {
2033
+ infoSection?: InfoSectionNonNullableFields;
2034
+ }
2035
+ export interface GetOrCreateInfoSectionResponseNonNullableFields {
2036
+ infoSection?: InfoSectionNonNullableFields;
2037
+ }
2038
+ interface ApplicationErrorNonNullableFields {
2039
+ code: string;
2040
+ description: string;
2041
+ }
2042
+ interface ItemMetadataNonNullableFields {
2043
+ originalIndex: number;
2044
+ success: boolean;
2045
+ error?: ApplicationErrorNonNullableFields;
2046
+ }
2047
+ interface BulkInfoSectionItemResultNonNullableFields {
2048
+ itemMetadata?: ItemMetadataNonNullableFields;
2049
+ item?: InfoSectionNonNullableFields;
2050
+ }
2051
+ interface BulkActionMetadataNonNullableFields {
2052
+ totalSuccesses: number;
2053
+ totalFailures: number;
2054
+ undetailedFailures: number;
2055
+ }
2056
+ export interface BulkGetOrCreateInfoSectionsResponseNonNullableFields {
2057
+ results: BulkInfoSectionItemResultNonNullableFields[];
2058
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields;
2059
+ }
2060
+ export interface UpdateInfoSectionResponseNonNullableFields {
2061
+ infoSection?: InfoSectionNonNullableFields;
2062
+ }
2063
+ export interface QueryInfoSectionsResponseNonNullableFields {
2064
+ infoSections: InfoSectionNonNullableFields[];
2065
+ }
2066
+ export interface BulkCreateInfoSectionsResponseNonNullableFields {
2067
+ results: BulkInfoSectionItemResultNonNullableFields[];
2068
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields;
2069
+ }
2070
+ export interface BulkUpdateInfoSectionsResponseNonNullableFields {
2071
+ results: BulkInfoSectionItemResultNonNullableFields[];
2072
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields;
2073
+ }
2074
+ interface BulkInfoSectionResultNonNullableFields {
2075
+ itemMetadata?: ItemMetadataNonNullableFields;
2076
+ }
2077
+ export interface BulkDeleteInfoSectionsResponseNonNullableFields {
2078
+ results: BulkInfoSectionResultNonNullableFields[];
2079
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields;
2080
+ }
2081
+ export interface BaseEventMetadata {
2082
+ /** App instance ID. */
2083
+ instanceId?: string | null;
2084
+ /** Event type. */
2085
+ eventType?: string;
2086
+ /** The identification type and identity data. */
2087
+ identity?: IdentificationData;
2088
+ }
2089
+ export interface EventMetadata extends BaseEventMetadata {
2090
+ /**
2091
+ * Unique event ID.
2092
+ * Allows clients to ignore duplicate webhooks.
2093
+ */
2094
+ _id?: string;
2095
+ /**
2096
+ * Assumes actions are also always typed to an entity_type
2097
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
2098
+ */
2099
+ entityFqdn?: string;
2100
+ /**
2101
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
2102
+ * This is although the created/updated/deleted notion is duplication of the oneof types
2103
+ * Example: created/updated/deleted/started/completed/email_opened
2104
+ */
2105
+ slug?: string;
2106
+ /** ID of the entity associated with the event. */
2107
+ entityId?: string;
2108
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
2109
+ eventTime?: Date | null;
2110
+ /**
2111
+ * Whether the event was triggered as a result of a privacy regulation application
2112
+ * (for example, GDPR).
2113
+ */
2114
+ triggeredByAnonymizeRequest?: boolean | null;
2115
+ /** If present, indicates the action that triggered the event. */
2116
+ originatedFrom?: string | null;
2117
+ /**
2118
+ * A sequence number defining the order of updates to the underlying entity.
2119
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
2120
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
2121
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
2122
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
2123
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
2124
+ */
2125
+ entityEventSequence?: string | null;
2126
+ }
2127
+ export interface InfoSectionCreatedEnvelope {
2128
+ entity: InfoSection;
2129
+ metadata: EventMetadata;
2130
+ }
2131
+ /**
2132
+ * Triggered when an info section is created.
2133
+ * @permissionScope Read info sections in v3 catalog
2134
+ * @permissionScopeId SCOPE.STORES.INFO_SECTION_READ
2135
+ * @permissionScope Read v3 catalog
2136
+ * @permissionScopeId SCOPE.STORES.CATALOG_READ
2137
+ * @permissionScope Manage Products
2138
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2139
+ * @permissionScope Read Products
2140
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
2141
+ * @permissionScope Product write in v3 catalog
2142
+ * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
2143
+ * @permissionScope Manage v3 catalog
2144
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
2145
+ * @permissionScope Manage Orders
2146
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
2147
+ * @permissionId WIX_STORES.INFO_SECTION_READ
2148
+ * @webhook
2149
+ * @eventType wix.stores.catalog.v3.info_section_created
2150
+ * @documentationMaturity preview
2151
+ */
2152
+ export declare function onInfoSectionCreated(handler: (event: InfoSectionCreatedEnvelope) => void | Promise<void>): void;
2153
+ export interface InfoSectionDeletedEnvelope {
2154
+ metadata: EventMetadata;
2155
+ }
2156
+ /**
2157
+ * Triggered when an info section is deleted.
2158
+ * @permissionScope Read info sections in v3 catalog
2159
+ * @permissionScopeId SCOPE.STORES.INFO_SECTION_READ
2160
+ * @permissionScope Read v3 catalog
2161
+ * @permissionScopeId SCOPE.STORES.CATALOG_READ
2162
+ * @permissionScope Manage Products
2163
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2164
+ * @permissionScope Read Products
2165
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
2166
+ * @permissionScope Product write in v3 catalog
2167
+ * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
2168
+ * @permissionScope Manage v3 catalog
2169
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
2170
+ * @permissionScope Manage Orders
2171
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
2172
+ * @permissionId WIX_STORES.INFO_SECTION_READ
2173
+ * @webhook
2174
+ * @eventType wix.stores.catalog.v3.info_section_deleted
2175
+ * @documentationMaturity preview
2176
+ */
2177
+ export declare function onInfoSectionDeleted(handler: (event: InfoSectionDeletedEnvelope) => void | Promise<void>): void;
2178
+ export interface InfoSectionUpdatedEnvelope {
2179
+ entity: InfoSection;
2180
+ metadata: EventMetadata;
2181
+ }
2182
+ /**
2183
+ * Triggered when an info section is updated.
2184
+ * @permissionScope Read info sections in v3 catalog
2185
+ * @permissionScopeId SCOPE.STORES.INFO_SECTION_READ
2186
+ * @permissionScope Read v3 catalog
2187
+ * @permissionScopeId SCOPE.STORES.CATALOG_READ
2188
+ * @permissionScope Manage Products
2189
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2190
+ * @permissionScope Read Products
2191
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
2192
+ * @permissionScope Product write in v3 catalog
2193
+ * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
2194
+ * @permissionScope Manage v3 catalog
2195
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
2196
+ * @permissionScope Manage Orders
2197
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
2198
+ * @permissionId WIX_STORES.INFO_SECTION_READ
2199
+ * @webhook
2200
+ * @eventType wix.stores.catalog.v3.info_section_updated
2201
+ * @documentationMaturity preview
2202
+ */
2203
+ export declare function onInfoSectionUpdated(handler: (event: InfoSectionUpdatedEnvelope) => void | Promise<void>): void;
2204
+ /**
2205
+ * Creates an info section.
2206
+ *
2207
+ * To assign the info section to a product, include the `infoSection.id` or `infoSection.uniqueName`
2208
+ * when [creating](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product) or
2209
+ * [updating](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/update-product) a product.
2210
+ * @param infoSection - Info section to create.
2211
+ * @public
2212
+ * @documentationMaturity preview
2213
+ * @requiredField infoSection
2214
+ * @requiredField infoSection.title
2215
+ * @requiredField infoSection.uniqueName
2216
+ * @permissionId WIX_STORES.INFO_SECTION_CREATE
2217
+ * @permissionScope Manage Products
2218
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2219
+ * @permissionScope Info section write in v3 catalog
2220
+ * @permissionScopeId SCOPE.STORES.INFO_SECTION_WRITE
2221
+ * @permissionScope Product write in v3 catalog
2222
+ * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
2223
+ * @permissionScope Manage v3 catalog
2224
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
2225
+ * @applicableIdentity APP
2226
+ * @returns Created info section.
2227
+ * @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.CreateInfoSection
2228
+ */
2229
+ export declare function createInfoSection(infoSection: InfoSection): Promise<InfoSection & InfoSectionNonNullableFields>;
2230
+ /**
2231
+ * Retrieves an info section.
2232
+ * @param infoSectionId - Info section ID.
2233
+ * @public
2234
+ * @documentationMaturity preview
2235
+ * @requiredField infoSectionId
2236
+ * @permissionId WIX_STORES.INFO_SECTION_READ
2237
+ * @permissionScope Read info sections in v3 catalog
2238
+ * @permissionScopeId SCOPE.STORES.INFO_SECTION_READ
2239
+ * @permissionScope Read v3 catalog
2240
+ * @permissionScopeId SCOPE.STORES.CATALOG_READ
2241
+ * @permissionScope Manage Products
2242
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2243
+ * @permissionScope Read Products
2244
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
2245
+ * @permissionScope Product write in v3 catalog
2246
+ * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
2247
+ * @permissionScope Manage v3 catalog
2248
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
2249
+ * @permissionScope Manage Orders
2250
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
2251
+ * @applicableIdentity APP
2252
+ * @applicableIdentity VISITOR
2253
+ * @returns Info section.
2254
+ * @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.GetInfoSection
2255
+ */
2256
+ export declare function getInfoSection(infoSectionId: string, options?: GetInfoSectionOptions): Promise<InfoSection & InfoSectionNonNullableFields>;
2257
+ export interface GetInfoSectionOptions {
2258
+ /**
2259
+ * Fields to include in the response.
2260
+ *
2261
+ * Supported values: `ASSIGNED_PRODUCTS_COUNT`
2262
+ */
2263
+ fields?: RequestedFields[];
2264
+ }
2265
+ /**
2266
+ * Retrieves an info section by ID or `uniqueName`, or creates an info section if one with the passed `uniqueName` doesn't exist.
2267
+ *
2268
+ * > **Note:** If an info section with the passed `uniqueName` doesn't exist, the `uniqueName` and `title` fields are required to create a new info section.
2269
+ * @public
2270
+ * @documentationMaturity preview
2271
+ * @permissionId WIX_STORES.INFO_SECTION_GET_OR_CREATE
2272
+ * @permissionScope Manage Products
2273
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2274
+ * @permissionScope Info section write in v3 catalog
2275
+ * @permissionScopeId SCOPE.STORES.INFO_SECTION_WRITE
2276
+ * @permissionScope Product write in v3 catalog
2277
+ * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
2278
+ * @permissionScope Manage v3 catalog
2279
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
2280
+ * @applicableIdentity APP
2281
+ * @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.GetOrCreateInfoSection
2282
+ */
2283
+ export declare function getOrCreateInfoSection(options?: GetOrCreateInfoSectionOptions): Promise<GetOrCreateInfoSectionResponse & GetOrCreateInfoSectionResponseNonNullableFields>;
2284
+ export interface GetOrCreateInfoSectionOptions {
2285
+ /** Info section to retrieve or create. */
2286
+ infoSection?: InfoSectionForGetOrCreate;
2287
+ /**
2288
+ * Fields to include in the response.
2289
+ *
2290
+ * Supported values: `ASSIGNED_PRODUCTS_COUNT`
2291
+ */
2292
+ fields?: RequestedFields[];
2293
+ }
2294
+ /**
2295
+ * Retrieves multiple info sections by ID or `uniqueName`, or creates multiple info sections if those with the passed `uniqueName` don't exist.
2296
+ *
2297
+ * > **Note:** If an info section with the passed `uniqueName` doesn't exist, the `uniqueName` and `title` fields are required to create a new info section.
2298
+ * @public
2299
+ * @documentationMaturity preview
2300
+ * @permissionId WIX_STORES.INFO_SECTION_GET_OR_CREATE
2301
+ * @permissionScope Manage Products
2302
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2303
+ * @permissionScope Info section write in v3 catalog
2304
+ * @permissionScopeId SCOPE.STORES.INFO_SECTION_WRITE
2305
+ * @permissionScope Product write in v3 catalog
2306
+ * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
2307
+ * @permissionScope Manage v3 catalog
2308
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
2309
+ * @applicableIdentity APP
2310
+ * @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.BulkGetOrCreateInfoSections
2311
+ */
2312
+ export declare function bulkGetOrCreateInfoSections(options?: BulkGetOrCreateInfoSectionsOptions): Promise<BulkGetOrCreateInfoSectionsResponse & BulkGetOrCreateInfoSectionsResponseNonNullableFields>;
2313
+ export interface BulkGetOrCreateInfoSectionsOptions {
2314
+ /** Info sections to retrieve or create. */
2315
+ infoSections?: InfoSectionForGetOrCreate[];
2316
+ /**
2317
+ * Fields to include in the response.
2318
+ *
2319
+ * Supported values: `ASSIGNED_PRODUCTS_COUNT`
2320
+ */
2321
+ fields?: RequestedFields[];
2322
+ }
2323
+ /**
2324
+ * Updates an info section.
2325
+ *
2326
+ *
2327
+ * Each time the info section is updated, `revision` increments by 1.
2328
+ * The current `revision` must be passed when updating the info section.
2329
+ * This ensures you're working with the latest info section and prevents unintended overwrites.
2330
+ * @param _id - Info section ID.
2331
+ * @public
2332
+ * @documentationMaturity preview
2333
+ * @requiredField _id
2334
+ * @requiredField infoSection
2335
+ * @requiredField infoSection.revision
2336
+ * @permissionId WIX_STORES.INFO_SECTION_UPDATE
2337
+ * @permissionScope Manage Products
2338
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2339
+ * @permissionScope Info section write in v3 catalog
2340
+ * @permissionScopeId SCOPE.STORES.INFO_SECTION_WRITE
2341
+ * @permissionScope Product write in v3 catalog
2342
+ * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
2343
+ * @permissionScope Manage v3 catalog
2344
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
2345
+ * @applicableIdentity APP
2346
+ * @returns Updated info section.
2347
+ * @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.UpdateInfoSection
2348
+ */
2349
+ export declare function updateInfoSection(_id: string | null, infoSection: UpdateInfoSection, options?: UpdateInfoSectionOptions): Promise<InfoSection & InfoSectionNonNullableFields>;
2350
+ export interface UpdateInfoSection {
2351
+ /**
2352
+ * Info section ID.
2353
+ * @readonly
2354
+ */
2355
+ _id?: string | null;
2356
+ /**
2357
+ * Revision number, which increments by 1 each time the info section is updated.
2358
+ * To prevent conflicting changes,
2359
+ * the current revision must be passed when updating the info section.
2360
+ *
2361
+ * Ignored when creating an info section.
2362
+ * @readonly
2363
+ */
2364
+ revision?: string | null;
2365
+ /**
2366
+ * Date and time the info section was created.
2367
+ * @readonly
2368
+ */
2369
+ _createdDate?: Date | null;
2370
+ /**
2371
+ * Date and time the info section was updated.
2372
+ * @readonly
2373
+ */
2374
+ _updatedDate?: Date | null;
2375
+ /** Unique name. Used as an identifier. */
2376
+ uniqueName?: string;
2377
+ /** Info section title. */
2378
+ title?: string;
2379
+ /**
2380
+ * Info section description using rich content.
2381
+ *
2382
+ * <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">
2383
+ * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
2384
+ * </widget>
2385
+ */
2386
+ description?: RichContent;
2387
+ /**
2388
+ * Info section description in HTML.
2389
+ *
2390
+ * When provided on create/update, this string must be a valid HTML. It will then be converted to rich content.
2391
+ * `plainDescription` is ignored when value is also passed to the `description` field.
2392
+ */
2393
+ plainDescription?: string | null;
2394
+ /**
2395
+ * Number of products this info section is assigned to.
2396
+ * > **Note:** Returned only when you pass `"ASSIGNED_PRODUCTS_COUNT"` to the `fields` array in Info Sections API requests.
2397
+ * @readonly
2398
+ */
2399
+ assignedProductsCount?: number | null;
2400
+ }
2401
+ export interface UpdateInfoSectionOptions {
2402
+ /**
2403
+ * Fields to include in the response.
2404
+ *
2405
+ * Supported values: `ASSIGNED_PRODUCTS_COUNT`
2406
+ */
2407
+ fields?: RequestedFields[];
2408
+ }
2409
+ /**
2410
+ * Deletes an info section.
2411
+ *
2412
+ * > **Note:** Deleting an info section will also remove it from all products it is assigned to.
2413
+ * @param infoSectionId - Info section ID
2414
+ * @public
2415
+ * @documentationMaturity preview
2416
+ * @requiredField infoSectionId
2417
+ * @permissionId WIX_STORES.INFO_SECTION_DELETE
2418
+ * @permissionScope Manage Products
2419
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2420
+ * @permissionScope Info section write in v3 catalog
2421
+ * @permissionScopeId SCOPE.STORES.INFO_SECTION_WRITE
2422
+ * @permissionScope Product write in v3 catalog
2423
+ * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
2424
+ * @permissionScope Manage v3 catalog
2425
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
2426
+ * @applicableIdentity APP
2427
+ * @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.DeleteInfoSection
2428
+ */
2429
+ export declare function deleteInfoSection(infoSectionId: string): Promise<void>;
2430
+ /**
2431
+ * Retrieves a list of up to 100 info sections, given the provided filtering, sorting, and cursor paging.
2432
+ * Pass supported values to the `fields` array in the request to include those fields in the response.
2433
+ *
2434
+ *
2435
+ * Query Info Sections runs with these defaults, which you can override:
2436
+ *
2437
+ * - `createdDate` is sorted in `DESC` order
2438
+ * - `cursorPaging.limit` is `100`
2439
+ *
2440
+ * For field support for filters and sorting,
2441
+ * see [Info Sections: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/info-sections-v3/supported-filters-and-sorting).
2442
+ *
2443
+ * To learn about working with _Query_ endpoints, see
2444
+ * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
2445
+ * and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
2446
+ * @public
2447
+ * @documentationMaturity preview
2448
+ * @permissionScope Read info sections in v3 catalog
2449
+ * @permissionScopeId SCOPE.STORES.INFO_SECTION_READ
2450
+ * @permissionScope Read v3 catalog
2451
+ * @permissionScopeId SCOPE.STORES.CATALOG_READ
2452
+ * @permissionScope Manage Products
2453
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2454
+ * @permissionScope Read Products
2455
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
2456
+ * @permissionScope Product write in v3 catalog
2457
+ * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
2458
+ * @permissionScope Manage v3 catalog
2459
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
2460
+ * @permissionScope Manage Orders
2461
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
2462
+ * @permissionId WIX_STORES.INFO_SECTION_READ
2463
+ * @applicableIdentity APP
2464
+ * @applicableIdentity VISITOR
2465
+ * @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.QueryInfoSections
2466
+ */
2467
+ export declare function queryInfoSections(options?: QueryInfoSectionsOptions): InfoSectionsQueryBuilder;
2468
+ export interface QueryInfoSectionsOptions {
2469
+ /**
2470
+ * Fields to include in the response.
2471
+ *
2472
+ * Supported values: `ASSIGNED_PRODUCTS_COUNT`
2473
+ */
2474
+ fields?: RequestedFields[] | undefined;
2475
+ }
2476
+ interface QueryCursorResult {
2477
+ cursors: Cursors;
2478
+ hasNext: () => boolean;
2479
+ hasPrev: () => boolean;
2480
+ length: number;
2481
+ pageSize: number;
2482
+ }
2483
+ export interface InfoSectionsQueryResult extends QueryCursorResult {
2484
+ items: InfoSection[];
2485
+ query: InfoSectionsQueryBuilder;
2486
+ next: () => Promise<InfoSectionsQueryResult>;
2487
+ prev: () => Promise<InfoSectionsQueryResult>;
2488
+ }
2489
+ export interface InfoSectionsQueryBuilder {
2490
+ /** @param propertyName - Property whose value is compared with `value`.
2491
+ * @param value - Value to compare against.
2492
+ * @documentationMaturity preview
2493
+ */
2494
+ eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'uniqueName' | 'title', value: any) => InfoSectionsQueryBuilder;
2495
+ /** @param propertyName - Property whose value is compared with `value`.
2496
+ * @param value - Value to compare against.
2497
+ * @documentationMaturity preview
2498
+ */
2499
+ ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'uniqueName' | 'title', value: any) => InfoSectionsQueryBuilder;
2500
+ /** @param propertyName - Property whose value is compared with `value`.
2501
+ * @param value - Value to compare against.
2502
+ * @documentationMaturity preview
2503
+ */
2504
+ ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => InfoSectionsQueryBuilder;
2505
+ /** @param propertyName - Property whose value is compared with `value`.
2506
+ * @param value - Value to compare against.
2507
+ * @documentationMaturity preview
2508
+ */
2509
+ gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => InfoSectionsQueryBuilder;
2510
+ /** @param propertyName - Property whose value is compared with `value`.
2511
+ * @param value - Value to compare against.
2512
+ * @documentationMaturity preview
2513
+ */
2514
+ le: (propertyName: '_createdDate' | '_updatedDate', value: any) => InfoSectionsQueryBuilder;
2515
+ /** @param propertyName - Property whose value is compared with `value`.
2516
+ * @param value - Value to compare against.
2517
+ * @documentationMaturity preview
2518
+ */
2519
+ lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => InfoSectionsQueryBuilder;
2520
+ /** @param propertyName - Property whose value is compared with `string`.
2521
+ * @param string - String to compare against. Case-insensitive.
2522
+ * @documentationMaturity preview
2523
+ */
2524
+ startsWith: (propertyName: '_id' | 'uniqueName' | 'title', value: string) => InfoSectionsQueryBuilder;
2525
+ /** @param propertyName - Property whose value is compared with `values`.
2526
+ * @param values - List of values to compare against.
2527
+ * @documentationMaturity preview
2528
+ */
2529
+ hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'uniqueName' | 'title', value: any[]) => InfoSectionsQueryBuilder;
2530
+ /** @documentationMaturity preview */
2531
+ in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'uniqueName' | 'title', value: any) => InfoSectionsQueryBuilder;
2532
+ /** @documentationMaturity preview */
2533
+ exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'uniqueName' | 'title', value: boolean) => InfoSectionsQueryBuilder;
2534
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
2535
+ * @documentationMaturity preview
2536
+ */
2537
+ ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'uniqueName' | 'title'>) => InfoSectionsQueryBuilder;
2538
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
2539
+ * @documentationMaturity preview
2540
+ */
2541
+ descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'uniqueName' | 'title'>) => InfoSectionsQueryBuilder;
2542
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
2543
+ * @documentationMaturity preview
2544
+ */
2545
+ limit: (limit: number) => InfoSectionsQueryBuilder;
2546
+ /** @param cursor - A pointer to specific record
2547
+ * @documentationMaturity preview
2548
+ */
2549
+ skipTo: (cursor: string) => InfoSectionsQueryBuilder;
2550
+ /** @documentationMaturity preview */
2551
+ find: () => Promise<InfoSectionsQueryResult>;
2552
+ }
2553
+ /**
2554
+ * Creates multiple info sections.
2555
+ * @param infoSections - Info sections to create.
2556
+ * @public
2557
+ * @documentationMaturity preview
2558
+ * @requiredField infoSections
2559
+ * @requiredField infoSections.title
2560
+ * @requiredField infoSections.uniqueName
2561
+ * @permissionId WIX_STORES.INFO_SECTION_CREATE
2562
+ * @permissionScope Manage Products
2563
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2564
+ * @permissionScope Info section write in v3 catalog
2565
+ * @permissionScopeId SCOPE.STORES.INFO_SECTION_WRITE
2566
+ * @permissionScope Product write in v3 catalog
2567
+ * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
2568
+ * @permissionScope Manage v3 catalog
2569
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
2570
+ * @applicableIdentity APP
2571
+ * @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.BulkCreateInfoSections
2572
+ */
2573
+ export declare function bulkCreateInfoSections(infoSections: InfoSection[], options?: BulkCreateInfoSectionsOptions): Promise<BulkCreateInfoSectionsResponse & BulkCreateInfoSectionsResponseNonNullableFields>;
2574
+ export interface BulkCreateInfoSectionsOptions {
2575
+ /**
2576
+ * Whether to return the full created info section entities in the response.
2577
+ *
2578
+ * Default: `false`
2579
+ */
2580
+ returnEntity?: boolean;
2581
+ }
2582
+ /**
2583
+ * Updates multiple info sections.
2584
+ *
2585
+ * Each time an info section is updated, `revision` increments by 1.
2586
+ * The current `revision` must be passed when updating an info section.
2587
+ * This ensures you're working with the latest info section and prevents unintended overwrites.
2588
+ * @param infoSections - List of info sections to update.
2589
+ * @public
2590
+ * @documentationMaturity preview
2591
+ * @requiredField infoSections
2592
+ * @requiredField infoSections.infoSection._id
2593
+ * @requiredField infoSections.infoSection.revision
2594
+ * @permissionId WIX_STORES.INFO_SECTION_UPDATE
2595
+ * @permissionScope Manage Products
2596
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2597
+ * @permissionScope Info section write in v3 catalog
2598
+ * @permissionScopeId SCOPE.STORES.INFO_SECTION_WRITE
2599
+ * @permissionScope Product write in v3 catalog
2600
+ * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
2601
+ * @permissionScope Manage v3 catalog
2602
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
2603
+ * @applicableIdentity APP
2604
+ * @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.BulkUpdateInfoSections
2605
+ */
2606
+ export declare function bulkUpdateInfoSections(infoSections: MaskedInfoSection[], options?: BulkUpdateInfoSectionsOptions): Promise<BulkUpdateInfoSectionsResponse & BulkUpdateInfoSectionsResponseNonNullableFields>;
2607
+ export interface BulkUpdateInfoSectionsOptions {
2608
+ /**
2609
+ * Whether to return the full updated info sections entities in the response.
2610
+ *
2611
+ * Default: `false`
2612
+ */
2613
+ returnEntity?: boolean;
2614
+ /**
2615
+ * Fields to include in the response.
2616
+ *
2617
+ * Supported values: `ASSIGNED_PRODUCTS_COUNT`
2618
+ */
2619
+ fields?: RequestedFields[];
2620
+ }
2621
+ /**
2622
+ * Deletes multiple info sections.
2623
+ * @param infoSectionIds - IDs of info sections to delete.
2624
+ * @public
2625
+ * @documentationMaturity preview
2626
+ * @requiredField infoSectionIds
2627
+ * @permissionId WIX_STORES.INFO_SECTION_DELETE
2628
+ * @permissionScope Manage Products
2629
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
2630
+ * @permissionScope Info section write in v3 catalog
2631
+ * @permissionScopeId SCOPE.STORES.INFO_SECTION_WRITE
2632
+ * @permissionScope Product write in v3 catalog
2633
+ * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
2634
+ * @permissionScope Manage v3 catalog
2635
+ * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
2636
+ * @applicableIdentity APP
2637
+ * @fqn com.wix.stores.catalog.info.section.v3.InfoSectionsService.BulkDeleteInfoSections
2638
+ */
2639
+ export declare function bulkDeleteInfoSections(infoSectionIds: string[]): Promise<BulkDeleteInfoSectionsResponse & BulkDeleteInfoSectionsResponseNonNullableFields>;
2640
+ export {};