@wix/auto_sdk_comments_comments 1.0.16 → 1.0.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{internal/cjs/src/comments-v2-comment-comments.universal.d.ts → comments-v2-comment-comments.universal-kzUoSqmO.d.mts} +315 -774
- package/build/{es/src/comments-v2-comment-comments.universal.d.ts → comments-v2-comment-comments.universal-kzUoSqmO.d.ts} +315 -774
- package/build/index.d.mts +257 -0
- package/build/index.d.ts +257 -0
- package/build/index.js +5269 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +5182 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/comments-v2-comment-comments.universal.d.ts → comments-v2-comment-comments.universal-kzUoSqmO.d.mts} +315 -774
- package/build/{cjs/src/comments-v2-comment-comments.universal.d.ts → internal/comments-v2-comment-comments.universal-kzUoSqmO.d.ts} +315 -774
- package/build/internal/index.d.mts +257 -0
- package/build/internal/index.d.ts +257 -0
- package/build/internal/index.js +5269 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +5182 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/{es/src/comments-v2-comment-comments.types.d.ts → internal/meta.d.mts} +274 -590
- package/build/internal/{cjs/src/comments-v2-comment-comments.types.d.ts → meta.d.ts} +274 -590
- package/build/internal/meta.js +2832 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +2788 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{cjs/src/comments-v2-comment-comments.types.d.ts → meta.d.mts} +274 -590
- package/build/{internal/es/src/comments-v2-comment-comments.types.d.ts → meta.d.ts} +274 -590
- package/build/meta.js +2832 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +2788 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/comments-v2-comment-comments.context.d.ts +0 -68
- package/build/cjs/src/comments-v2-comment-comments.context.js +0 -109
- package/build/cjs/src/comments-v2-comment-comments.context.js.map +0 -1
- package/build/cjs/src/comments-v2-comment-comments.http.d.ts +0 -90
- package/build/cjs/src/comments-v2-comment-comments.http.js +0 -2533
- package/build/cjs/src/comments-v2-comment-comments.http.js.map +0 -1
- package/build/cjs/src/comments-v2-comment-comments.meta.d.ts +0 -48
- package/build/cjs/src/comments-v2-comment-comments.meta.js +0 -370
- package/build/cjs/src/comments-v2-comment-comments.meta.js.map +0 -1
- package/build/cjs/src/comments-v2-comment-comments.public.d.ts +0 -202
- package/build/cjs/src/comments-v2-comment-comments.public.js +0 -1341
- package/build/cjs/src/comments-v2-comment-comments.public.js.map +0 -1
- package/build/cjs/src/comments-v2-comment-comments.types.js +0 -386
- package/build/cjs/src/comments-v2-comment-comments.types.js.map +0 -1
- package/build/cjs/src/comments-v2-comment-comments.universal.js +0 -1606
- package/build/cjs/src/comments-v2-comment-comments.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/comments-v2-comment-comments.context.d.ts +0 -68
- package/build/es/src/comments-v2-comment-comments.context.js +0 -68
- package/build/es/src/comments-v2-comment-comments.context.js.map +0 -1
- package/build/es/src/comments-v2-comment-comments.http.d.ts +0 -90
- package/build/es/src/comments-v2-comment-comments.http.js +0 -2512
- package/build/es/src/comments-v2-comment-comments.http.js.map +0 -1
- package/build/es/src/comments-v2-comment-comments.meta.d.ts +0 -48
- package/build/es/src/comments-v2-comment-comments.meta.js +0 -326
- package/build/es/src/comments-v2-comment-comments.meta.js.map +0 -1
- package/build/es/src/comments-v2-comment-comments.public.d.ts +0 -202
- package/build/es/src/comments-v2-comment-comments.public.js +0 -1282
- package/build/es/src/comments-v2-comment-comments.public.js.map +0 -1
- package/build/es/src/comments-v2-comment-comments.types.js +0 -383
- package/build/es/src/comments-v2-comment-comments.types.js.map +0 -1
- package/build/es/src/comments-v2-comment-comments.universal.js +0 -1561
- package/build/es/src/comments-v2-comment-comments.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.context.d.ts +0 -68
- package/build/internal/cjs/src/comments-v2-comment-comments.context.js +0 -109
- package/build/internal/cjs/src/comments-v2-comment-comments.context.js.map +0 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.http.d.ts +0 -90
- package/build/internal/cjs/src/comments-v2-comment-comments.http.js +0 -2533
- package/build/internal/cjs/src/comments-v2-comment-comments.http.js.map +0 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.meta.d.ts +0 -48
- package/build/internal/cjs/src/comments-v2-comment-comments.meta.js +0 -370
- package/build/internal/cjs/src/comments-v2-comment-comments.meta.js.map +0 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.public.d.ts +0 -202
- package/build/internal/cjs/src/comments-v2-comment-comments.public.js +0 -1341
- package/build/internal/cjs/src/comments-v2-comment-comments.public.js.map +0 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.types.js +0 -386
- package/build/internal/cjs/src/comments-v2-comment-comments.types.js.map +0 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.universal.js +0 -1606
- package/build/internal/cjs/src/comments-v2-comment-comments.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/comments-v2-comment-comments.context.d.ts +0 -68
- package/build/internal/es/src/comments-v2-comment-comments.context.js +0 -68
- package/build/internal/es/src/comments-v2-comment-comments.context.js.map +0 -1
- package/build/internal/es/src/comments-v2-comment-comments.http.d.ts +0 -90
- package/build/internal/es/src/comments-v2-comment-comments.http.js +0 -2512
- package/build/internal/es/src/comments-v2-comment-comments.http.js.map +0 -1
- package/build/internal/es/src/comments-v2-comment-comments.meta.d.ts +0 -48
- package/build/internal/es/src/comments-v2-comment-comments.meta.js +0 -326
- package/build/internal/es/src/comments-v2-comment-comments.meta.js.map +0 -1
- package/build/internal/es/src/comments-v2-comment-comments.public.d.ts +0 -202
- package/build/internal/es/src/comments-v2-comment-comments.public.js +0 -1282
- package/build/internal/es/src/comments-v2-comment-comments.public.js.map +0 -1
- package/build/internal/es/src/comments-v2-comment-comments.types.js +0 -383
- package/build/internal/es/src/comments-v2-comment-comments.types.js.map +0 -1
- package/build/internal/es/src/comments-v2-comment-comments.universal.js +0 -1561
- package/build/internal/es/src/comments-v2-comment-comments.universal.js.map +0 -1
|
@@ -1,9 +1,11 @@
|
|
|
1
|
+
import { c7 as CreateCommentRequest$1, c9 as CreateCommentResponse$1, cb as GetCommentRequest$1, cc as GetCommentResponse$1, cd as UpdateCommentRequest$1, ce as UpdateCommentResponse$1, cg as DeleteCommentRequest$1, ch as DeleteCommentResponse$1, cj as ModerateDraftContentRequest$1, a as ModerateDraftContentResponse$1, cm as QueryCommentsRequest$1, cr as QueryCommentsResponse$1, cu as MarkCommentRequest$1, c as MarkCommentResponse$1, cw as UnmarkCommentRequest$1, d as UnmarkCommentResponse$1, cy as HideCommentRequest$1, H as HideCommentResponse$1, cz as PublishCommentRequest$1, P as PublishCommentResponse$1, cA as CountCommentsRequest$1, f as CountCommentsResponse$1, cB as ListCommentsByResourceRequest$1, g as ListCommentsByResourceResponse$1, cG as GetCommentThreadRequest$1, h as GetCommentThreadResponse$1, cH as BulkPublishCommentRequest$1, i as BulkPublishCommentResponse$1, cI as BulkHideCommentRequest$1, k as BulkHideCommentResponse$1, cJ as BulkDeleteCommentRequest$1, m as BulkDeleteCommentResponse$1, cK as BulkModerateDraftContentRequest$1, o as BulkModerateDraftContentResponse$1, cL as BulkMoveCommentByFilterRequest$1, q as BulkMoveCommentByFilterResponse$1 } from './comments-v2-comment-comments.universal-kzUoSqmO.js';
|
|
2
|
+
|
|
1
3
|
/**
|
|
2
4
|
* A comment is a user-generated message in response to a specific resource. It allows site visitors
|
|
3
5
|
* to share feedback or engage in discussions around different types of resources, including blog posts, forum threads,
|
|
4
6
|
* or other site content. Comments are composed of text, images, videos, or other forms of media.
|
|
5
7
|
*/
|
|
6
|
-
|
|
8
|
+
interface Comment {
|
|
7
9
|
/**
|
|
8
10
|
* Comment ID.
|
|
9
11
|
* @format GUID
|
|
@@ -107,7 +109,7 @@ export interface Comment {
|
|
|
107
109
|
contentEdited?: boolean | null;
|
|
108
110
|
}
|
|
109
111
|
/** Comment content. */
|
|
110
|
-
|
|
112
|
+
interface CommentContent {
|
|
111
113
|
/**
|
|
112
114
|
* Comment rich content.
|
|
113
115
|
*
|
|
@@ -129,7 +131,7 @@ export interface CommentContent {
|
|
|
129
131
|
*/
|
|
130
132
|
attachments?: Attachment[];
|
|
131
133
|
}
|
|
132
|
-
|
|
134
|
+
interface RichContent {
|
|
133
135
|
/** Node objects representing a rich content document. */
|
|
134
136
|
nodes?: Node[];
|
|
135
137
|
/** Object metadata. */
|
|
@@ -137,7 +139,7 @@ export interface RichContent {
|
|
|
137
139
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
138
140
|
documentStyle?: DocumentStyle;
|
|
139
141
|
}
|
|
140
|
-
|
|
142
|
+
interface Node extends NodeDataOneOf {
|
|
141
143
|
/** Data for a button node. */
|
|
142
144
|
buttonData?: ButtonData;
|
|
143
145
|
/** Data for a code block node. */
|
|
@@ -202,7 +204,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
202
204
|
style?: NodeStyle;
|
|
203
205
|
}
|
|
204
206
|
/** @oneof */
|
|
205
|
-
|
|
207
|
+
interface NodeDataOneOf {
|
|
206
208
|
/** Data for a button node. */
|
|
207
209
|
buttonData?: ButtonData;
|
|
208
210
|
/** Data for a code block node. */
|
|
@@ -258,7 +260,7 @@ export interface NodeDataOneOf {
|
|
|
258
260
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
259
261
|
layoutCellData?: LayoutCellData;
|
|
260
262
|
}
|
|
261
|
-
|
|
263
|
+
declare enum NodeType {
|
|
262
264
|
PARAGRAPH = "PARAGRAPH",
|
|
263
265
|
TEXT = "TEXT",
|
|
264
266
|
HEADING = "HEADING",
|
|
@@ -295,8 +297,8 @@ export declare enum NodeType {
|
|
|
295
297
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
296
298
|
}
|
|
297
299
|
/** @enumType */
|
|
298
|
-
|
|
299
|
-
|
|
300
|
+
type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
|
|
301
|
+
interface NodeStyle {
|
|
300
302
|
/** The top padding value in pixels. */
|
|
301
303
|
paddingTop?: string | null;
|
|
302
304
|
/** The bottom padding value in pixels. */
|
|
@@ -304,7 +306,7 @@ export interface NodeStyle {
|
|
|
304
306
|
/** The background color as a hexadecimal value. */
|
|
305
307
|
backgroundColor?: string | null;
|
|
306
308
|
}
|
|
307
|
-
|
|
309
|
+
interface ButtonData {
|
|
308
310
|
/** Styling for the button's container. */
|
|
309
311
|
containerData?: PluginContainerData;
|
|
310
312
|
/** The button type. */
|
|
@@ -316,7 +318,7 @@ export interface ButtonData {
|
|
|
316
318
|
/** Button link details. */
|
|
317
319
|
link?: Link;
|
|
318
320
|
}
|
|
319
|
-
|
|
321
|
+
interface Border {
|
|
320
322
|
/**
|
|
321
323
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
322
324
|
* @deprecated
|
|
@@ -328,7 +330,7 @@ export interface Border {
|
|
|
328
330
|
*/
|
|
329
331
|
radius?: number | null;
|
|
330
332
|
}
|
|
331
|
-
|
|
333
|
+
interface Colors {
|
|
332
334
|
/**
|
|
333
335
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
334
336
|
* @deprecated
|
|
@@ -345,7 +347,7 @@ export interface Colors {
|
|
|
345
347
|
*/
|
|
346
348
|
background?: string | null;
|
|
347
349
|
}
|
|
348
|
-
|
|
350
|
+
interface PluginContainerData {
|
|
349
351
|
/** The width of the node when it's displayed. */
|
|
350
352
|
width?: PluginContainerDataWidth;
|
|
351
353
|
/** The node's alignment within its container. */
|
|
@@ -357,7 +359,7 @@ export interface PluginContainerData {
|
|
|
357
359
|
/** 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`. */
|
|
358
360
|
textWrap?: boolean | null;
|
|
359
361
|
}
|
|
360
|
-
|
|
362
|
+
declare enum WidthType {
|
|
361
363
|
/** Width matches the content width */
|
|
362
364
|
CONTENT = "CONTENT",
|
|
363
365
|
/** Small Width */
|
|
@@ -368,8 +370,8 @@ export declare enum WidthType {
|
|
|
368
370
|
FULL_WIDTH = "FULL_WIDTH"
|
|
369
371
|
}
|
|
370
372
|
/** @enumType */
|
|
371
|
-
|
|
372
|
-
|
|
373
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
374
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
373
375
|
/**
|
|
374
376
|
* One of the following predefined width options:
|
|
375
377
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -382,7 +384,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
382
384
|
custom?: string | null;
|
|
383
385
|
}
|
|
384
386
|
/** @oneof */
|
|
385
|
-
|
|
387
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
386
388
|
/**
|
|
387
389
|
* One of the following predefined width options:
|
|
388
390
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -394,7 +396,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
394
396
|
/** A custom width value in pixels. */
|
|
395
397
|
custom?: string | null;
|
|
396
398
|
}
|
|
397
|
-
|
|
399
|
+
declare enum PluginContainerDataAlignment {
|
|
398
400
|
/** Center Alignment */
|
|
399
401
|
CENTER = "CENTER",
|
|
400
402
|
/** Left Alignment */
|
|
@@ -403,8 +405,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
403
405
|
RIGHT = "RIGHT"
|
|
404
406
|
}
|
|
405
407
|
/** @enumType */
|
|
406
|
-
|
|
407
|
-
|
|
408
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
409
|
+
interface Spoiler {
|
|
408
410
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
409
411
|
enabled?: boolean | null;
|
|
410
412
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -412,19 +414,19 @@ export interface Spoiler {
|
|
|
412
414
|
/** The text for the button used to remove the spoiler cover. */
|
|
413
415
|
buttonText?: string | null;
|
|
414
416
|
}
|
|
415
|
-
|
|
417
|
+
interface Height {
|
|
416
418
|
/** A custom height value in pixels. */
|
|
417
419
|
custom?: string | null;
|
|
418
420
|
}
|
|
419
|
-
|
|
421
|
+
declare enum Type {
|
|
420
422
|
/** Regular link button */
|
|
421
423
|
LINK = "LINK",
|
|
422
424
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
423
425
|
ACTION = "ACTION"
|
|
424
426
|
}
|
|
425
427
|
/** @enumType */
|
|
426
|
-
|
|
427
|
-
|
|
428
|
+
type TypeWithLiterals = Type | 'LINK' | 'ACTION';
|
|
429
|
+
interface Styles {
|
|
428
430
|
/**
|
|
429
431
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
430
432
|
* @deprecated
|
|
@@ -477,7 +479,7 @@ export interface Styles {
|
|
|
477
479
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
478
480
|
buttonSize?: string | null;
|
|
479
481
|
}
|
|
480
|
-
|
|
482
|
+
interface Link extends LinkDataOneOf {
|
|
481
483
|
/** The absolute URL for the linked document. */
|
|
482
484
|
url?: string;
|
|
483
485
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -496,13 +498,13 @@ export interface Link extends LinkDataOneOf {
|
|
|
496
498
|
customData?: string | null;
|
|
497
499
|
}
|
|
498
500
|
/** @oneof */
|
|
499
|
-
|
|
501
|
+
interface LinkDataOneOf {
|
|
500
502
|
/** The absolute URL for the linked document. */
|
|
501
503
|
url?: string;
|
|
502
504
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
503
505
|
anchor?: string;
|
|
504
506
|
}
|
|
505
|
-
|
|
507
|
+
declare enum Target {
|
|
506
508
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
507
509
|
SELF = "SELF",
|
|
508
510
|
/** Opens the linked document in a new window or tab */
|
|
@@ -513,8 +515,8 @@ export declare enum Target {
|
|
|
513
515
|
TOP = "TOP"
|
|
514
516
|
}
|
|
515
517
|
/** @enumType */
|
|
516
|
-
|
|
517
|
-
|
|
518
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
519
|
+
interface Rel {
|
|
518
520
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
519
521
|
nofollow?: boolean | null;
|
|
520
522
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -524,17 +526,17 @@ export interface Rel {
|
|
|
524
526
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
525
527
|
noreferrer?: boolean | null;
|
|
526
528
|
}
|
|
527
|
-
|
|
529
|
+
interface CodeBlockData {
|
|
528
530
|
/** Styling for the code block's text. */
|
|
529
531
|
textStyle?: TextStyle;
|
|
530
532
|
}
|
|
531
|
-
|
|
533
|
+
interface TextStyle {
|
|
532
534
|
/** Text alignment. Defaults to `AUTO`. */
|
|
533
535
|
textAlignment?: TextAlignmentWithLiterals;
|
|
534
536
|
/** 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. */
|
|
535
537
|
lineHeight?: string | null;
|
|
536
538
|
}
|
|
537
|
-
|
|
539
|
+
declare enum TextAlignment {
|
|
538
540
|
/** browser default, eqivalent to `initial` */
|
|
539
541
|
AUTO = "AUTO",
|
|
540
542
|
/** Left align */
|
|
@@ -547,8 +549,8 @@ export declare enum TextAlignment {
|
|
|
547
549
|
JUSTIFY = "JUSTIFY"
|
|
548
550
|
}
|
|
549
551
|
/** @enumType */
|
|
550
|
-
|
|
551
|
-
|
|
552
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
553
|
+
interface DividerData {
|
|
552
554
|
/** Styling for the divider's container. */
|
|
553
555
|
containerData?: PluginContainerData;
|
|
554
556
|
/** Divider line style. */
|
|
@@ -558,7 +560,7 @@ export interface DividerData {
|
|
|
558
560
|
/** Divider alignment. */
|
|
559
561
|
alignment?: AlignmentWithLiterals;
|
|
560
562
|
}
|
|
561
|
-
|
|
563
|
+
declare enum LineStyle {
|
|
562
564
|
/** Single Line */
|
|
563
565
|
SINGLE = "SINGLE",
|
|
564
566
|
/** Double Line */
|
|
@@ -569,8 +571,8 @@ export declare enum LineStyle {
|
|
|
569
571
|
DOTTED = "DOTTED"
|
|
570
572
|
}
|
|
571
573
|
/** @enumType */
|
|
572
|
-
|
|
573
|
-
|
|
574
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
575
|
+
declare enum Width {
|
|
574
576
|
/** Large line */
|
|
575
577
|
LARGE = "LARGE",
|
|
576
578
|
/** Medium line */
|
|
@@ -579,8 +581,8 @@ export declare enum Width {
|
|
|
579
581
|
SMALL = "SMALL"
|
|
580
582
|
}
|
|
581
583
|
/** @enumType */
|
|
582
|
-
|
|
583
|
-
|
|
584
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
585
|
+
declare enum Alignment {
|
|
584
586
|
/** Center alignment */
|
|
585
587
|
CENTER = "CENTER",
|
|
586
588
|
/** Left alignment */
|
|
@@ -589,8 +591,8 @@ export declare enum Alignment {
|
|
|
589
591
|
RIGHT = "RIGHT"
|
|
590
592
|
}
|
|
591
593
|
/** @enumType */
|
|
592
|
-
|
|
593
|
-
|
|
594
|
+
type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
595
|
+
interface FileData {
|
|
594
596
|
/** Styling for the file's container. */
|
|
595
597
|
containerData?: PluginContainerData;
|
|
596
598
|
/** The source for the file's data. */
|
|
@@ -613,7 +615,7 @@ export interface FileData {
|
|
|
613
615
|
/** File size in KB. */
|
|
614
616
|
sizeInKb?: string | null;
|
|
615
617
|
}
|
|
616
|
-
|
|
618
|
+
declare enum ViewMode {
|
|
617
619
|
/** No PDF view */
|
|
618
620
|
NONE = "NONE",
|
|
619
621
|
/** Full PDF view */
|
|
@@ -622,8 +624,8 @@ export declare enum ViewMode {
|
|
|
622
624
|
MINI = "MINI"
|
|
623
625
|
}
|
|
624
626
|
/** @enumType */
|
|
625
|
-
|
|
626
|
-
|
|
627
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
628
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
627
629
|
/** The absolute URL for the file's source. */
|
|
628
630
|
url?: string | null;
|
|
629
631
|
/**
|
|
@@ -637,7 +639,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
637
639
|
private?: boolean | null;
|
|
638
640
|
}
|
|
639
641
|
/** @oneof */
|
|
640
|
-
|
|
642
|
+
interface FileSourceDataOneOf {
|
|
641
643
|
/** The absolute URL for the file's source. */
|
|
642
644
|
url?: string | null;
|
|
643
645
|
/**
|
|
@@ -648,7 +650,7 @@ export interface FileSourceDataOneOf {
|
|
|
648
650
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
649
651
|
id?: string | null;
|
|
650
652
|
}
|
|
651
|
-
|
|
653
|
+
interface PDFSettings {
|
|
652
654
|
/**
|
|
653
655
|
* PDF view mode. One of the following:
|
|
654
656
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -661,7 +663,7 @@ export interface PDFSettings {
|
|
|
661
663
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
662
664
|
disablePrint?: boolean | null;
|
|
663
665
|
}
|
|
664
|
-
|
|
666
|
+
interface GalleryData {
|
|
665
667
|
/** Styling for the gallery's container. */
|
|
666
668
|
containerData?: PluginContainerData;
|
|
667
669
|
/** The items in the gallery. */
|
|
@@ -673,7 +675,7 @@ export interface GalleryData {
|
|
|
673
675
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
674
676
|
disableDownload?: boolean | null;
|
|
675
677
|
}
|
|
676
|
-
|
|
678
|
+
interface Media {
|
|
677
679
|
/** The source for the media's data. */
|
|
678
680
|
src?: FileSource;
|
|
679
681
|
/** Media width in pixels. */
|
|
@@ -683,19 +685,19 @@ export interface Media {
|
|
|
683
685
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
684
686
|
duration?: number | null;
|
|
685
687
|
}
|
|
686
|
-
|
|
688
|
+
interface ItemImage {
|
|
687
689
|
/** Image file details. */
|
|
688
690
|
media?: Media;
|
|
689
691
|
/** Link details for images that are links. */
|
|
690
692
|
link?: Link;
|
|
691
693
|
}
|
|
692
|
-
|
|
694
|
+
interface Video {
|
|
693
695
|
/** Video file details. */
|
|
694
696
|
media?: Media;
|
|
695
697
|
/** Video thumbnail file details. */
|
|
696
698
|
thumbnail?: Media;
|
|
697
699
|
}
|
|
698
|
-
|
|
700
|
+
interface Item extends ItemDataOneOf {
|
|
699
701
|
/** An image item. */
|
|
700
702
|
image?: ItemImage;
|
|
701
703
|
/** A video item. */
|
|
@@ -706,13 +708,13 @@ export interface Item extends ItemDataOneOf {
|
|
|
706
708
|
altText?: string | null;
|
|
707
709
|
}
|
|
708
710
|
/** @oneof */
|
|
709
|
-
|
|
711
|
+
interface ItemDataOneOf {
|
|
710
712
|
/** An image item. */
|
|
711
713
|
image?: ItemImage;
|
|
712
714
|
/** A video item. */
|
|
713
715
|
video?: Video;
|
|
714
716
|
}
|
|
715
|
-
|
|
717
|
+
interface GalleryOptions {
|
|
716
718
|
/** Gallery layout. */
|
|
717
719
|
layout?: Layout;
|
|
718
720
|
/** Styling for gallery items. */
|
|
@@ -720,7 +722,7 @@ export interface GalleryOptions {
|
|
|
720
722
|
/** Styling for gallery thumbnail images. */
|
|
721
723
|
thumbnails?: Thumbnails;
|
|
722
724
|
}
|
|
723
|
-
|
|
725
|
+
declare enum LayoutType {
|
|
724
726
|
/** Collage type */
|
|
725
727
|
COLLAGE = "COLLAGE",
|
|
726
728
|
/** Masonry type */
|
|
@@ -743,24 +745,24 @@ export declare enum LayoutType {
|
|
|
743
745
|
FULLSIZE = "FULLSIZE"
|
|
744
746
|
}
|
|
745
747
|
/** @enumType */
|
|
746
|
-
|
|
747
|
-
|
|
748
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
749
|
+
declare enum Orientation {
|
|
748
750
|
/** Rows Orientation */
|
|
749
751
|
ROWS = "ROWS",
|
|
750
752
|
/** Columns Orientation */
|
|
751
753
|
COLUMNS = "COLUMNS"
|
|
752
754
|
}
|
|
753
755
|
/** @enumType */
|
|
754
|
-
|
|
755
|
-
|
|
756
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
757
|
+
declare enum Crop {
|
|
756
758
|
/** Crop to fill */
|
|
757
759
|
FILL = "FILL",
|
|
758
760
|
/** Crop to fit */
|
|
759
761
|
FIT = "FIT"
|
|
760
762
|
}
|
|
761
763
|
/** @enumType */
|
|
762
|
-
|
|
763
|
-
|
|
764
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
765
|
+
declare enum ThumbnailsAlignment {
|
|
764
766
|
/** Top alignment */
|
|
765
767
|
TOP = "TOP",
|
|
766
768
|
/** Right alignment */
|
|
@@ -773,8 +775,8 @@ export declare enum ThumbnailsAlignment {
|
|
|
773
775
|
NONE = "NONE"
|
|
774
776
|
}
|
|
775
777
|
/** @enumType */
|
|
776
|
-
|
|
777
|
-
|
|
778
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
779
|
+
interface Layout {
|
|
778
780
|
/** Gallery layout type. */
|
|
779
781
|
type?: LayoutTypeWithLiterals;
|
|
780
782
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -786,7 +788,7 @@ export interface Layout {
|
|
|
786
788
|
/** The number of columns to display on mobile screens. */
|
|
787
789
|
mobileNumberOfColumns?: number | null;
|
|
788
790
|
}
|
|
789
|
-
|
|
791
|
+
interface ItemStyle {
|
|
790
792
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
791
793
|
targetSize?: number | null;
|
|
792
794
|
/** Item ratio */
|
|
@@ -796,13 +798,13 @@ export interface ItemStyle {
|
|
|
796
798
|
/** The spacing between items in pixels. */
|
|
797
799
|
spacing?: number | null;
|
|
798
800
|
}
|
|
799
|
-
|
|
801
|
+
interface Thumbnails {
|
|
800
802
|
/** Thumbnail alignment. */
|
|
801
803
|
placement?: ThumbnailsAlignmentWithLiterals;
|
|
802
804
|
/** Spacing between thumbnails in pixels. */
|
|
803
805
|
spacing?: number | null;
|
|
804
806
|
}
|
|
805
|
-
|
|
807
|
+
interface GIFData {
|
|
806
808
|
/** Styling for the GIF's container. */
|
|
807
809
|
containerData?: PluginContainerData;
|
|
808
810
|
/** The source of the full size GIF. */
|
|
@@ -816,7 +818,7 @@ export interface GIFData {
|
|
|
816
818
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
817
819
|
gifType?: GIFTypeWithLiterals;
|
|
818
820
|
}
|
|
819
|
-
|
|
821
|
+
interface GIF {
|
|
820
822
|
/**
|
|
821
823
|
* GIF format URL.
|
|
822
824
|
* @format WEB_URL
|
|
@@ -833,13 +835,13 @@ export interface GIF {
|
|
|
833
835
|
*/
|
|
834
836
|
still?: string | null;
|
|
835
837
|
}
|
|
836
|
-
|
|
838
|
+
declare enum GIFType {
|
|
837
839
|
NORMAL = "NORMAL",
|
|
838
840
|
STICKER = "STICKER"
|
|
839
841
|
}
|
|
840
842
|
/** @enumType */
|
|
841
|
-
|
|
842
|
-
|
|
843
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
844
|
+
interface HeadingData {
|
|
843
845
|
/** Heading level from 1-6. */
|
|
844
846
|
level?: number;
|
|
845
847
|
/** Styling for the heading text. */
|
|
@@ -847,7 +849,7 @@ export interface HeadingData {
|
|
|
847
849
|
/** Indentation level from 1-4. */
|
|
848
850
|
indentation?: number | null;
|
|
849
851
|
}
|
|
850
|
-
|
|
852
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
851
853
|
/** The URL for the HTML code for the node. */
|
|
852
854
|
url?: string;
|
|
853
855
|
/** The HTML code for the node. */
|
|
@@ -865,7 +867,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
865
867
|
autoHeight?: boolean | null;
|
|
866
868
|
}
|
|
867
869
|
/** @oneof */
|
|
868
|
-
|
|
870
|
+
interface HTMLDataDataOneOf {
|
|
869
871
|
/** The URL for the HTML code for the node. */
|
|
870
872
|
url?: string;
|
|
871
873
|
/** The HTML code for the node. */
|
|
@@ -876,13 +878,13 @@ export interface HTMLDataDataOneOf {
|
|
|
876
878
|
*/
|
|
877
879
|
isAdsense?: boolean | null;
|
|
878
880
|
}
|
|
879
|
-
|
|
881
|
+
declare enum Source {
|
|
880
882
|
HTML = "HTML",
|
|
881
883
|
ADSENSE = "ADSENSE"
|
|
882
884
|
}
|
|
883
885
|
/** @enumType */
|
|
884
|
-
|
|
885
|
-
|
|
886
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
887
|
+
interface ImageData {
|
|
886
888
|
/** Styling for the image's container. */
|
|
887
889
|
containerData?: PluginContainerData;
|
|
888
890
|
/** Image file details. */
|
|
@@ -905,7 +907,7 @@ export interface ImageData {
|
|
|
905
907
|
/** Styling for the image. */
|
|
906
908
|
styles?: ImageDataStyles;
|
|
907
909
|
}
|
|
908
|
-
|
|
910
|
+
interface StylesBorder {
|
|
909
911
|
/** Border width in pixels. */
|
|
910
912
|
width?: number | null;
|
|
911
913
|
/**
|
|
@@ -916,11 +918,11 @@ export interface StylesBorder {
|
|
|
916
918
|
/** Border radius in pixels. */
|
|
917
919
|
radius?: number | null;
|
|
918
920
|
}
|
|
919
|
-
|
|
921
|
+
interface ImageDataStyles {
|
|
920
922
|
/** Border attributes. */
|
|
921
923
|
border?: StylesBorder;
|
|
922
924
|
}
|
|
923
|
-
|
|
925
|
+
interface LinkPreviewData {
|
|
924
926
|
/** Styling for the link preview's container. */
|
|
925
927
|
containerData?: PluginContainerData;
|
|
926
928
|
/** Link details. */
|
|
@@ -936,7 +938,7 @@ export interface LinkPreviewData {
|
|
|
936
938
|
/** Styling for the link preview. */
|
|
937
939
|
styles?: LinkPreviewDataStyles;
|
|
938
940
|
}
|
|
939
|
-
|
|
941
|
+
declare enum Position {
|
|
940
942
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
941
943
|
START = "START",
|
|
942
944
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -947,8 +949,8 @@ export declare enum Position {
|
|
|
947
949
|
HIDDEN = "HIDDEN"
|
|
948
950
|
}
|
|
949
951
|
/** @enumType */
|
|
950
|
-
|
|
951
|
-
|
|
952
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
953
|
+
interface LinkPreviewDataStyles {
|
|
952
954
|
/**
|
|
953
955
|
* Background color as a hexadecimal value.
|
|
954
956
|
* @format COLOR_HEX
|
|
@@ -981,13 +983,13 @@ export interface LinkPreviewDataStyles {
|
|
|
981
983
|
/** Position of thumbnail. Defaults to `START`. */
|
|
982
984
|
thumbnailPosition?: PositionWithLiterals;
|
|
983
985
|
}
|
|
984
|
-
|
|
986
|
+
interface MapData {
|
|
985
987
|
/** Styling for the map's container. */
|
|
986
988
|
containerData?: PluginContainerData;
|
|
987
989
|
/** Map settings. */
|
|
988
990
|
mapSettings?: MapSettings;
|
|
989
991
|
}
|
|
990
|
-
|
|
992
|
+
interface MapSettings {
|
|
991
993
|
/** The address to display on the map. */
|
|
992
994
|
address?: string | null;
|
|
993
995
|
/** Sets whether the map is draggable. */
|
|
@@ -1011,7 +1013,7 @@ export interface MapSettings {
|
|
|
1011
1013
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
1012
1014
|
mapType?: MapTypeWithLiterals;
|
|
1013
1015
|
}
|
|
1014
|
-
|
|
1016
|
+
declare enum MapType {
|
|
1015
1017
|
/** Roadmap map type */
|
|
1016
1018
|
ROADMAP = "ROADMAP",
|
|
1017
1019
|
/** Satellite map type */
|
|
@@ -1022,8 +1024,8 @@ export declare enum MapType {
|
|
|
1022
1024
|
TERRAIN = "TERRAIN"
|
|
1023
1025
|
}
|
|
1024
1026
|
/** @enumType */
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
1028
|
+
interface ParagraphData {
|
|
1027
1029
|
/** Styling for the paragraph text. */
|
|
1028
1030
|
textStyle?: TextStyle;
|
|
1029
1031
|
/** Indentation level from 1-4. */
|
|
@@ -1031,7 +1033,7 @@ export interface ParagraphData {
|
|
|
1031
1033
|
/** Paragraph level */
|
|
1032
1034
|
level?: number | null;
|
|
1033
1035
|
}
|
|
1034
|
-
|
|
1036
|
+
interface PollData {
|
|
1035
1037
|
/** Styling for the poll's container. */
|
|
1036
1038
|
containerData?: PluginContainerData;
|
|
1037
1039
|
/** Poll data. */
|
|
@@ -1041,7 +1043,7 @@ export interface PollData {
|
|
|
1041
1043
|
/** Styling for the poll and voting options. */
|
|
1042
1044
|
design?: Design;
|
|
1043
1045
|
}
|
|
1044
|
-
|
|
1046
|
+
declare enum ViewRole {
|
|
1045
1047
|
/** Only Poll creator can view the results */
|
|
1046
1048
|
CREATOR = "CREATOR",
|
|
1047
1049
|
/** Anyone who voted can see the results */
|
|
@@ -1050,16 +1052,16 @@ export declare enum ViewRole {
|
|
|
1050
1052
|
EVERYONE = "EVERYONE"
|
|
1051
1053
|
}
|
|
1052
1054
|
/** @enumType */
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
1056
|
+
declare enum VoteRole {
|
|
1055
1057
|
/** Logged in member */
|
|
1056
1058
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
1057
1059
|
/** Anyone */
|
|
1058
1060
|
ALL = "ALL"
|
|
1059
1061
|
}
|
|
1060
1062
|
/** @enumType */
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
1064
|
+
interface Permissions {
|
|
1063
1065
|
/** Sets who can view the poll results. */
|
|
1064
1066
|
view?: ViewRoleWithLiterals;
|
|
1065
1067
|
/** Sets who can vote. */
|
|
@@ -1067,7 +1069,7 @@ export interface Permissions {
|
|
|
1067
1069
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1068
1070
|
allowMultipleVotes?: boolean | null;
|
|
1069
1071
|
}
|
|
1070
|
-
|
|
1072
|
+
interface Option {
|
|
1071
1073
|
/** Option ID. */
|
|
1072
1074
|
id?: string | null;
|
|
1073
1075
|
/** Option title. */
|
|
@@ -1075,7 +1077,7 @@ export interface Option {
|
|
|
1075
1077
|
/** The image displayed with the option. */
|
|
1076
1078
|
image?: Media;
|
|
1077
1079
|
}
|
|
1078
|
-
|
|
1080
|
+
interface Settings {
|
|
1079
1081
|
/** Permissions settings for voting. */
|
|
1080
1082
|
permissions?: Permissions;
|
|
1081
1083
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -1083,23 +1085,23 @@ export interface Settings {
|
|
|
1083
1085
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
1084
1086
|
showVotesCount?: boolean | null;
|
|
1085
1087
|
}
|
|
1086
|
-
|
|
1088
|
+
declare enum PollLayoutType {
|
|
1087
1089
|
/** List */
|
|
1088
1090
|
LIST = "LIST",
|
|
1089
1091
|
/** Grid */
|
|
1090
1092
|
GRID = "GRID"
|
|
1091
1093
|
}
|
|
1092
1094
|
/** @enumType */
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
1096
|
+
declare enum PollLayoutDirection {
|
|
1095
1097
|
/** Left-to-right */
|
|
1096
1098
|
LTR = "LTR",
|
|
1097
1099
|
/** Right-to-left */
|
|
1098
1100
|
RTL = "RTL"
|
|
1099
1101
|
}
|
|
1100
1102
|
/** @enumType */
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
1104
|
+
interface PollLayout {
|
|
1103
1105
|
/** The layout for displaying the voting options. */
|
|
1104
1106
|
type?: PollLayoutTypeWithLiterals;
|
|
1105
1107
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -1107,11 +1109,11 @@ export interface PollLayout {
|
|
|
1107
1109
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1108
1110
|
enableImage?: boolean | null;
|
|
1109
1111
|
}
|
|
1110
|
-
|
|
1112
|
+
interface OptionLayout {
|
|
1111
1113
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
1112
1114
|
enableImage?: boolean | null;
|
|
1113
1115
|
}
|
|
1114
|
-
|
|
1116
|
+
declare enum BackgroundType {
|
|
1115
1117
|
/** Color background type */
|
|
1116
1118
|
COLOR = "COLOR",
|
|
1117
1119
|
/** Image background type */
|
|
@@ -1120,8 +1122,8 @@ export declare enum BackgroundType {
|
|
|
1120
1122
|
GRADIENT = "GRADIENT"
|
|
1121
1123
|
}
|
|
1122
1124
|
/** @enumType */
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
1126
|
+
interface Gradient {
|
|
1125
1127
|
/** The gradient angle in degrees. */
|
|
1126
1128
|
angle?: number | null;
|
|
1127
1129
|
/**
|
|
@@ -1135,7 +1137,7 @@ export interface Gradient {
|
|
|
1135
1137
|
*/
|
|
1136
1138
|
lastColor?: string | null;
|
|
1137
1139
|
}
|
|
1138
|
-
|
|
1140
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
1139
1141
|
/**
|
|
1140
1142
|
* The background color as a hexademical value.
|
|
1141
1143
|
* @format COLOR_HEX
|
|
@@ -1149,7 +1151,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1149
1151
|
type?: BackgroundTypeWithLiterals;
|
|
1150
1152
|
}
|
|
1151
1153
|
/** @oneof */
|
|
1152
|
-
|
|
1154
|
+
interface BackgroundBackgroundOneOf {
|
|
1153
1155
|
/**
|
|
1154
1156
|
* The background color as a hexademical value.
|
|
1155
1157
|
* @format COLOR_HEX
|
|
@@ -1160,17 +1162,17 @@ export interface BackgroundBackgroundOneOf {
|
|
|
1160
1162
|
/** Details for a gradient background. */
|
|
1161
1163
|
gradient?: Gradient;
|
|
1162
1164
|
}
|
|
1163
|
-
|
|
1165
|
+
interface PollDesign {
|
|
1164
1166
|
/** Background styling. */
|
|
1165
1167
|
background?: Background;
|
|
1166
1168
|
/** Border radius in pixels. */
|
|
1167
1169
|
borderRadius?: number | null;
|
|
1168
1170
|
}
|
|
1169
|
-
|
|
1171
|
+
interface OptionDesign {
|
|
1170
1172
|
/** Border radius in pixels. */
|
|
1171
1173
|
borderRadius?: number | null;
|
|
1172
1174
|
}
|
|
1173
|
-
|
|
1175
|
+
interface Poll {
|
|
1174
1176
|
/** Poll ID. */
|
|
1175
1177
|
id?: string | null;
|
|
1176
1178
|
/** Poll title. */
|
|
@@ -1184,26 +1186,26 @@ export interface Poll {
|
|
|
1184
1186
|
/** The poll's permissions and display settings. */
|
|
1185
1187
|
settings?: Settings;
|
|
1186
1188
|
}
|
|
1187
|
-
|
|
1189
|
+
interface PollDataLayout {
|
|
1188
1190
|
/** Poll layout settings. */
|
|
1189
1191
|
poll?: PollLayout;
|
|
1190
1192
|
/** Voting otpions layout settings. */
|
|
1191
1193
|
options?: OptionLayout;
|
|
1192
1194
|
}
|
|
1193
|
-
|
|
1195
|
+
interface Design {
|
|
1194
1196
|
/** Styling for the poll. */
|
|
1195
1197
|
poll?: PollDesign;
|
|
1196
1198
|
/** Styling for voting options. */
|
|
1197
1199
|
options?: OptionDesign;
|
|
1198
1200
|
}
|
|
1199
|
-
|
|
1201
|
+
interface TextData {
|
|
1200
1202
|
/** The text to apply decorations to. */
|
|
1201
1203
|
text?: string;
|
|
1202
1204
|
/** The decorations to apply. */
|
|
1203
1205
|
decorations?: Decoration[];
|
|
1204
1206
|
}
|
|
1205
1207
|
/** Adds appearence changes to text */
|
|
1206
|
-
|
|
1208
|
+
interface Decoration extends DecorationDataOneOf {
|
|
1207
1209
|
/** Data for an anchor link decoration. */
|
|
1208
1210
|
anchorData?: AnchorData;
|
|
1209
1211
|
/** Data for a color decoration. */
|
|
@@ -1228,7 +1230,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
1228
1230
|
type?: DecorationTypeWithLiterals;
|
|
1229
1231
|
}
|
|
1230
1232
|
/** @oneof */
|
|
1231
|
-
|
|
1233
|
+
interface DecorationDataOneOf {
|
|
1232
1234
|
/** Data for an anchor link decoration. */
|
|
1233
1235
|
anchorData?: AnchorData;
|
|
1234
1236
|
/** Data for a color decoration. */
|
|
@@ -1250,7 +1252,7 @@ export interface DecorationDataOneOf {
|
|
|
1250
1252
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1251
1253
|
strikethroughData?: boolean | null;
|
|
1252
1254
|
}
|
|
1253
|
-
|
|
1255
|
+
declare enum DecorationType {
|
|
1254
1256
|
BOLD = "BOLD",
|
|
1255
1257
|
ITALIC = "ITALIC",
|
|
1256
1258
|
UNDERLINE = "UNDERLINE",
|
|
@@ -1264,22 +1266,22 @@ export declare enum DecorationType {
|
|
|
1264
1266
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1265
1267
|
}
|
|
1266
1268
|
/** @enumType */
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
1270
|
+
interface AnchorData {
|
|
1269
1271
|
/** The target node's ID. */
|
|
1270
1272
|
anchor?: string;
|
|
1271
1273
|
}
|
|
1272
|
-
|
|
1274
|
+
interface ColorData {
|
|
1273
1275
|
/** The text's background color as a hexadecimal value. */
|
|
1274
1276
|
background?: string | null;
|
|
1275
1277
|
/** The text's foreground color as a hexadecimal value. */
|
|
1276
1278
|
foreground?: string | null;
|
|
1277
1279
|
}
|
|
1278
|
-
|
|
1280
|
+
interface LinkData {
|
|
1279
1281
|
/** Link details. */
|
|
1280
1282
|
link?: Link;
|
|
1281
1283
|
}
|
|
1282
|
-
|
|
1284
|
+
interface MentionData {
|
|
1283
1285
|
/** The mentioned user's name. */
|
|
1284
1286
|
name?: string;
|
|
1285
1287
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -1287,23 +1289,23 @@ export interface MentionData {
|
|
|
1287
1289
|
/** Mentioned user's ID. */
|
|
1288
1290
|
id?: string | null;
|
|
1289
1291
|
}
|
|
1290
|
-
|
|
1292
|
+
interface FontSizeData {
|
|
1291
1293
|
/** The units used for the font size. */
|
|
1292
1294
|
unit?: FontTypeWithLiterals;
|
|
1293
1295
|
/** Font size value. */
|
|
1294
1296
|
value?: number | null;
|
|
1295
1297
|
}
|
|
1296
|
-
|
|
1298
|
+
declare enum FontType {
|
|
1297
1299
|
PX = "PX",
|
|
1298
1300
|
EM = "EM"
|
|
1299
1301
|
}
|
|
1300
1302
|
/** @enumType */
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
1304
|
+
interface SpoilerData {
|
|
1303
1305
|
/** Spoiler ID. */
|
|
1304
1306
|
id?: string | null;
|
|
1305
1307
|
}
|
|
1306
|
-
|
|
1308
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1307
1309
|
/** Data for embedded Wix Bookings content. */
|
|
1308
1310
|
bookingData?: BookingData;
|
|
1309
1311
|
/** Data for embedded Wix Events content. */
|
|
@@ -1325,30 +1327,30 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1325
1327
|
image?: Media;
|
|
1326
1328
|
}
|
|
1327
1329
|
/** @oneof */
|
|
1328
|
-
|
|
1330
|
+
interface AppEmbedDataAppDataOneOf {
|
|
1329
1331
|
/** Data for embedded Wix Bookings content. */
|
|
1330
1332
|
bookingData?: BookingData;
|
|
1331
1333
|
/** Data for embedded Wix Events content. */
|
|
1332
1334
|
eventData?: EventData;
|
|
1333
1335
|
}
|
|
1334
|
-
|
|
1336
|
+
declare enum AppType {
|
|
1335
1337
|
PRODUCT = "PRODUCT",
|
|
1336
1338
|
EVENT = "EVENT",
|
|
1337
1339
|
BOOKING = "BOOKING"
|
|
1338
1340
|
}
|
|
1339
1341
|
/** @enumType */
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
1343
|
+
interface BookingData {
|
|
1342
1344
|
/** Booking duration in minutes. */
|
|
1343
1345
|
durations?: string | null;
|
|
1344
1346
|
}
|
|
1345
|
-
|
|
1347
|
+
interface EventData {
|
|
1346
1348
|
/** Event schedule. */
|
|
1347
1349
|
scheduling?: string | null;
|
|
1348
1350
|
/** Event location. */
|
|
1349
1351
|
location?: string | null;
|
|
1350
1352
|
}
|
|
1351
|
-
|
|
1353
|
+
interface VideoData {
|
|
1352
1354
|
/** Styling for the video's container. */
|
|
1353
1355
|
containerData?: PluginContainerData;
|
|
1354
1356
|
/** Video details. */
|
|
@@ -1362,7 +1364,7 @@ export interface VideoData {
|
|
|
1362
1364
|
/** Video options. */
|
|
1363
1365
|
options?: PlaybackOptions;
|
|
1364
1366
|
}
|
|
1365
|
-
|
|
1367
|
+
interface PlaybackOptions {
|
|
1366
1368
|
/** Sets whether the media will automatically start playing. */
|
|
1367
1369
|
autoPlay?: boolean | null;
|
|
1368
1370
|
/** Sets whether media's will be looped. */
|
|
@@ -1370,7 +1372,7 @@ export interface PlaybackOptions {
|
|
|
1370
1372
|
/** Sets whether media's controls will be shown. */
|
|
1371
1373
|
showControls?: boolean | null;
|
|
1372
1374
|
}
|
|
1373
|
-
|
|
1375
|
+
interface EmbedData {
|
|
1374
1376
|
/** Styling for the oEmbed node's container. */
|
|
1375
1377
|
containerData?: PluginContainerData;
|
|
1376
1378
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -1378,7 +1380,7 @@ export interface EmbedData {
|
|
|
1378
1380
|
/** Origin asset source. */
|
|
1379
1381
|
src?: string | null;
|
|
1380
1382
|
}
|
|
1381
|
-
|
|
1383
|
+
interface Oembed {
|
|
1382
1384
|
/** The resource type. */
|
|
1383
1385
|
type?: string | null;
|
|
1384
1386
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -1410,7 +1412,7 @@ export interface Oembed {
|
|
|
1410
1412
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
1411
1413
|
version?: string | null;
|
|
1412
1414
|
}
|
|
1413
|
-
|
|
1415
|
+
interface CollapsibleListData {
|
|
1414
1416
|
/** Styling for the collapsible list's container. */
|
|
1415
1417
|
containerData?: PluginContainerData;
|
|
1416
1418
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -1422,7 +1424,7 @@ export interface CollapsibleListData {
|
|
|
1422
1424
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1423
1425
|
isQapageData?: boolean | null;
|
|
1424
1426
|
}
|
|
1425
|
-
|
|
1427
|
+
declare enum InitialExpandedItems {
|
|
1426
1428
|
/** First item will be expended initally */
|
|
1427
1429
|
FIRST = "FIRST",
|
|
1428
1430
|
/** All items will expended initally */
|
|
@@ -1431,16 +1433,16 @@ export declare enum InitialExpandedItems {
|
|
|
1431
1433
|
NONE = "NONE"
|
|
1432
1434
|
}
|
|
1433
1435
|
/** @enumType */
|
|
1434
|
-
|
|
1435
|
-
|
|
1436
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
1437
|
+
declare enum Direction {
|
|
1436
1438
|
/** Left-to-right */
|
|
1437
1439
|
LTR = "LTR",
|
|
1438
1440
|
/** Right-to-left */
|
|
1439
1441
|
RTL = "RTL"
|
|
1440
1442
|
}
|
|
1441
1443
|
/** @enumType */
|
|
1442
|
-
|
|
1443
|
-
|
|
1444
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
1445
|
+
interface TableData {
|
|
1444
1446
|
/** Styling for the table's container. */
|
|
1445
1447
|
containerData?: PluginContainerData;
|
|
1446
1448
|
/** The table's dimensions. */
|
|
@@ -1455,7 +1457,7 @@ export interface TableData {
|
|
|
1455
1457
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1456
1458
|
columnHeader?: boolean | null;
|
|
1457
1459
|
}
|
|
1458
|
-
|
|
1460
|
+
interface Dimensions {
|
|
1459
1461
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
1460
1462
|
colsWidthRatio?: number[];
|
|
1461
1463
|
/** An array representing the height of each row in pixels. */
|
|
@@ -1463,13 +1465,13 @@ export interface Dimensions {
|
|
|
1463
1465
|
/** An array representing the minimum width of each column in pixels. */
|
|
1464
1466
|
colsMinWidth?: number[];
|
|
1465
1467
|
}
|
|
1466
|
-
|
|
1468
|
+
interface TableCellData {
|
|
1467
1469
|
/** Styling for the cell's background color and text alignment. */
|
|
1468
1470
|
cellStyle?: CellStyle;
|
|
1469
1471
|
/** The cell's border colors. */
|
|
1470
1472
|
borderColors?: BorderColors;
|
|
1471
1473
|
}
|
|
1472
|
-
|
|
1474
|
+
declare enum VerticalAlignment {
|
|
1473
1475
|
/** Top alignment */
|
|
1474
1476
|
TOP = "TOP",
|
|
1475
1477
|
/** Middle alignment */
|
|
@@ -1478,8 +1480,8 @@ export declare enum VerticalAlignment {
|
|
|
1478
1480
|
BOTTOM = "BOTTOM"
|
|
1479
1481
|
}
|
|
1480
1482
|
/** @enumType */
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
1484
|
+
interface CellStyle {
|
|
1483
1485
|
/** Vertical alignment for the cell's text. */
|
|
1484
1486
|
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
1485
1487
|
/**
|
|
@@ -1488,7 +1490,7 @@ export interface CellStyle {
|
|
|
1488
1490
|
*/
|
|
1489
1491
|
backgroundColor?: string | null;
|
|
1490
1492
|
}
|
|
1491
|
-
|
|
1493
|
+
interface BorderColors {
|
|
1492
1494
|
/**
|
|
1493
1495
|
* Left border color as a hexadecimal value.
|
|
1494
1496
|
* @format COLOR_HEX
|
|
@@ -1510,28 +1512,7 @@ export interface BorderColors {
|
|
|
1510
1512
|
*/
|
|
1511
1513
|
bottom?: string | null;
|
|
1512
1514
|
}
|
|
1513
|
-
|
|
1514
|
-
* `NullValue` is a singleton enumeration to represent the null value for the
|
|
1515
|
-
* `Value` type union.
|
|
1516
|
-
*
|
|
1517
|
-
* The JSON representation for `NullValue` is JSON `null`.
|
|
1518
|
-
*/
|
|
1519
|
-
export declare enum NullValue {
|
|
1520
|
-
/** Null value. */
|
|
1521
|
-
NULL_VALUE = "NULL_VALUE"
|
|
1522
|
-
}
|
|
1523
|
-
/** @enumType */
|
|
1524
|
-
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
1525
|
-
/**
|
|
1526
|
-
* `ListValue` is a wrapper around a repeated field of values.
|
|
1527
|
-
*
|
|
1528
|
-
* The JSON representation for `ListValue` is JSON array.
|
|
1529
|
-
*/
|
|
1530
|
-
export interface ListValue {
|
|
1531
|
-
/** Repeated field of dynamically typed values. */
|
|
1532
|
-
values?: any[];
|
|
1533
|
-
}
|
|
1534
|
-
export interface AudioData {
|
|
1515
|
+
interface AudioData {
|
|
1535
1516
|
/** Styling for the audio node's container. */
|
|
1536
1517
|
containerData?: PluginContainerData;
|
|
1537
1518
|
/** Audio file details. */
|
|
@@ -1547,7 +1528,7 @@ export interface AudioData {
|
|
|
1547
1528
|
/** An HTML version of the audio node. */
|
|
1548
1529
|
html?: string | null;
|
|
1549
1530
|
}
|
|
1550
|
-
|
|
1531
|
+
interface OrderedListData {
|
|
1551
1532
|
/** Indentation level from 0-4. */
|
|
1552
1533
|
indentation?: number;
|
|
1553
1534
|
/** Offset level from 0-4. */
|
|
@@ -1555,24 +1536,24 @@ export interface OrderedListData {
|
|
|
1555
1536
|
/** List start number. */
|
|
1556
1537
|
start?: number | null;
|
|
1557
1538
|
}
|
|
1558
|
-
|
|
1539
|
+
interface BulletedListData {
|
|
1559
1540
|
/** Indentation level from 0-4. */
|
|
1560
1541
|
indentation?: number;
|
|
1561
1542
|
/** Offset level from 0-4. */
|
|
1562
1543
|
offset?: number | null;
|
|
1563
1544
|
}
|
|
1564
|
-
|
|
1545
|
+
interface BlockquoteData {
|
|
1565
1546
|
/** Indentation level from 1-4. */
|
|
1566
1547
|
indentation?: number;
|
|
1567
1548
|
}
|
|
1568
|
-
|
|
1549
|
+
interface CaptionData {
|
|
1569
1550
|
textStyle?: TextStyle;
|
|
1570
1551
|
}
|
|
1571
|
-
|
|
1552
|
+
interface LayoutCellData {
|
|
1572
1553
|
/** Size of the cell in 12 columns grid. */
|
|
1573
1554
|
colSpan?: number | null;
|
|
1574
1555
|
}
|
|
1575
|
-
|
|
1556
|
+
interface Metadata {
|
|
1576
1557
|
/** Schema version. */
|
|
1577
1558
|
version?: number;
|
|
1578
1559
|
/**
|
|
@@ -1589,7 +1570,7 @@ export interface Metadata {
|
|
|
1589
1570
|
/** Object ID. */
|
|
1590
1571
|
id?: string | null;
|
|
1591
1572
|
}
|
|
1592
|
-
|
|
1573
|
+
interface DocumentStyle {
|
|
1593
1574
|
/** Styling for H1 nodes. */
|
|
1594
1575
|
headerOne?: TextNodeStyle;
|
|
1595
1576
|
/** Styling for H2 nodes. */
|
|
@@ -1609,7 +1590,7 @@ export interface DocumentStyle {
|
|
|
1609
1590
|
/** Styling for code block nodes. */
|
|
1610
1591
|
codeBlock?: TextNodeStyle;
|
|
1611
1592
|
}
|
|
1612
|
-
|
|
1593
|
+
interface TextNodeStyle {
|
|
1613
1594
|
/** The decorations to apply to the node. */
|
|
1614
1595
|
decorations?: Decoration[];
|
|
1615
1596
|
/** Padding and background color for the node. */
|
|
@@ -1617,7 +1598,7 @@ export interface TextNodeStyle {
|
|
|
1617
1598
|
/** Line height for text in the node. */
|
|
1618
1599
|
lineHeight?: string | null;
|
|
1619
1600
|
}
|
|
1620
|
-
|
|
1601
|
+
interface Mention extends MentionIdentityOneOf {
|
|
1621
1602
|
/**
|
|
1622
1603
|
* Wix user ID.
|
|
1623
1604
|
* @format GUID
|
|
@@ -1640,7 +1621,7 @@ export interface Mention extends MentionIdentityOneOf {
|
|
|
1640
1621
|
groupId?: string | null;
|
|
1641
1622
|
}
|
|
1642
1623
|
/** @oneof */
|
|
1643
|
-
|
|
1624
|
+
interface MentionIdentityOneOf {
|
|
1644
1625
|
/**
|
|
1645
1626
|
* Wix user ID.
|
|
1646
1627
|
* @format GUID
|
|
@@ -1662,7 +1643,7 @@ export interface MentionIdentityOneOf {
|
|
|
1662
1643
|
*/
|
|
1663
1644
|
groupId?: string | null;
|
|
1664
1645
|
}
|
|
1665
|
-
|
|
1646
|
+
interface Attachment extends AttachmentMediaOneOf {
|
|
1666
1647
|
/** Information about the image. */
|
|
1667
1648
|
image?: Image;
|
|
1668
1649
|
/** Information about the video. */
|
|
@@ -1678,7 +1659,7 @@ export interface Attachment extends AttachmentMediaOneOf {
|
|
|
1678
1659
|
mimeType?: string | null;
|
|
1679
1660
|
}
|
|
1680
1661
|
/** @oneof */
|
|
1681
|
-
|
|
1662
|
+
interface AttachmentMediaOneOf {
|
|
1682
1663
|
/** Information about the image. */
|
|
1683
1664
|
image?: Image;
|
|
1684
1665
|
/** Information about the video. */
|
|
@@ -1688,7 +1669,7 @@ export interface AttachmentMediaOneOf {
|
|
|
1688
1669
|
/** Information about the document. */
|
|
1689
1670
|
document?: Document;
|
|
1690
1671
|
}
|
|
1691
|
-
|
|
1672
|
+
interface Image {
|
|
1692
1673
|
/** WixMedia image ID. */
|
|
1693
1674
|
id?: string;
|
|
1694
1675
|
/** Image URL. */
|
|
@@ -1725,7 +1706,7 @@ export interface Image {
|
|
|
1725
1706
|
*/
|
|
1726
1707
|
sizeInBytes?: string | null;
|
|
1727
1708
|
}
|
|
1728
|
-
|
|
1709
|
+
interface VideoV2 {
|
|
1729
1710
|
/** WixMedia ID. */
|
|
1730
1711
|
id?: string;
|
|
1731
1712
|
/** Original video URL. */
|
|
@@ -1758,7 +1739,7 @@ export interface VideoV2 {
|
|
|
1758
1739
|
*/
|
|
1759
1740
|
urlExpirationDate?: Date | null;
|
|
1760
1741
|
}
|
|
1761
|
-
|
|
1742
|
+
interface VideoResolution {
|
|
1762
1743
|
/** Video URL. */
|
|
1763
1744
|
url?: string;
|
|
1764
1745
|
/** Video height. */
|
|
@@ -1797,7 +1778,7 @@ export interface VideoResolution {
|
|
|
1797
1778
|
*/
|
|
1798
1779
|
assetKey?: string | null;
|
|
1799
1780
|
}
|
|
1800
|
-
|
|
1781
|
+
interface Audio {
|
|
1801
1782
|
/** WixMedia ID. */
|
|
1802
1783
|
id?: string;
|
|
1803
1784
|
/** Audio URL. */
|
|
@@ -1848,7 +1829,7 @@ export interface Audio {
|
|
|
1848
1829
|
*/
|
|
1849
1830
|
quality?: string | null;
|
|
1850
1831
|
}
|
|
1851
|
-
|
|
1832
|
+
interface Document {
|
|
1852
1833
|
/** WixMedia ID. */
|
|
1853
1834
|
id?: string;
|
|
1854
1835
|
/** Document URL. */
|
|
@@ -1870,7 +1851,7 @@ export interface Document {
|
|
|
1870
1851
|
*/
|
|
1871
1852
|
filename?: string | null;
|
|
1872
1853
|
}
|
|
1873
|
-
|
|
1854
|
+
interface CommentAuthor extends CommentAuthorIdentityOneOf {
|
|
1874
1855
|
/**
|
|
1875
1856
|
* Wix user ID.
|
|
1876
1857
|
* @format GUID
|
|
@@ -1886,36 +1867,9 @@ export interface ContentAuthor extends ContentAuthorAuthorOneOf {
|
|
|
1886
1867
|
* @format GUID
|
|
1887
1868
|
*/
|
|
1888
1869
|
visitorId?: string | null;
|
|
1889
|
-
/**
|
|
1890
|
-
* Application ID. For more information, see [Authenticate as an App Instance](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/authenticate-as-an-app-instance).
|
|
1891
|
-
* @format GUID
|
|
1892
|
-
*/
|
|
1893
|
-
appId?: string | null;
|
|
1894
1870
|
}
|
|
1895
1871
|
/** @oneof */
|
|
1896
|
-
|
|
1897
|
-
/**
|
|
1898
|
-
* Wix user ID.
|
|
1899
|
-
* @format GUID
|
|
1900
|
-
*/
|
|
1901
|
-
userId?: string | null;
|
|
1902
|
-
/**
|
|
1903
|
-
* Member ID. See the Members API for more details.
|
|
1904
|
-
* @format GUID
|
|
1905
|
-
*/
|
|
1906
|
-
memberId?: string | null;
|
|
1907
|
-
/**
|
|
1908
|
-
* Visitor ID.
|
|
1909
|
-
* @format GUID
|
|
1910
|
-
*/
|
|
1911
|
-
visitorId?: string | null;
|
|
1912
|
-
/**
|
|
1913
|
-
* Application ID. For more information, see [Authenticate as an App Instance](https://dev.wix.com/docs/build-apps/develop-your-app/access/authentication/authenticate-as-an-app-instance).
|
|
1914
|
-
* @format GUID
|
|
1915
|
-
*/
|
|
1916
|
-
appId?: string | null;
|
|
1917
|
-
}
|
|
1918
|
-
export interface CommentAuthor extends CommentAuthorIdentityOneOf {
|
|
1872
|
+
interface CommentAuthorIdentityOneOf {
|
|
1919
1873
|
/**
|
|
1920
1874
|
* Wix user ID.
|
|
1921
1875
|
* @format GUID
|
|
@@ -1932,25 +1886,7 @@ export interface CommentAuthor extends CommentAuthorIdentityOneOf {
|
|
|
1932
1886
|
*/
|
|
1933
1887
|
visitorId?: string | null;
|
|
1934
1888
|
}
|
|
1935
|
-
|
|
1936
|
-
export interface CommentAuthorIdentityOneOf {
|
|
1937
|
-
/**
|
|
1938
|
-
* Wix user ID.
|
|
1939
|
-
* @format GUID
|
|
1940
|
-
*/
|
|
1941
|
-
userId?: string | null;
|
|
1942
|
-
/**
|
|
1943
|
-
* Member ID. See the Members API for more details.
|
|
1944
|
-
* @format GUID
|
|
1945
|
-
*/
|
|
1946
|
-
memberId?: string | null;
|
|
1947
|
-
/**
|
|
1948
|
-
* Visitor ID.
|
|
1949
|
-
* @format GUID
|
|
1950
|
-
*/
|
|
1951
|
-
visitorId?: string | null;
|
|
1952
|
-
}
|
|
1953
|
-
export interface ParentComment {
|
|
1889
|
+
interface ParentComment {
|
|
1954
1890
|
/**
|
|
1955
1891
|
* Comment ID of the parent comment.
|
|
1956
1892
|
* @format GUID
|
|
@@ -1968,7 +1904,7 @@ export interface ParentComment {
|
|
|
1968
1904
|
*/
|
|
1969
1905
|
status?: StatusWithLiterals;
|
|
1970
1906
|
}
|
|
1971
|
-
|
|
1907
|
+
declare enum Status {
|
|
1972
1908
|
/** Unknown status. */
|
|
1973
1909
|
UNKNOWN = "UNKNOWN",
|
|
1974
1910
|
/** This comment is published and publicly visible. */
|
|
@@ -1981,8 +1917,8 @@ export declare enum Status {
|
|
|
1981
1917
|
HIDDEN = "HIDDEN"
|
|
1982
1918
|
}
|
|
1983
1919
|
/** @enumType */
|
|
1984
|
-
|
|
1985
|
-
|
|
1920
|
+
type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'DELETED' | 'PENDING' | 'HIDDEN';
|
|
1921
|
+
interface VoteSummary {
|
|
1986
1922
|
/** Number of upvotes less downvotes on this comment. */
|
|
1987
1923
|
netVoteCount?: number;
|
|
1988
1924
|
/** Number of upvotes on this comment. */
|
|
@@ -1990,7 +1926,7 @@ export interface VoteSummary {
|
|
|
1990
1926
|
/** Number of downvotes on this comment. */
|
|
1991
1927
|
downvoteCount?: number;
|
|
1992
1928
|
}
|
|
1993
|
-
|
|
1929
|
+
interface CommentReactionSummary {
|
|
1994
1930
|
/** Total amount of reactions. */
|
|
1995
1931
|
total?: number;
|
|
1996
1932
|
/**
|
|
@@ -1999,122 +1935,7 @@ export interface CommentReactionSummary {
|
|
|
1999
1935
|
*/
|
|
2000
1936
|
reactionCodeCount?: Record<string, number>;
|
|
2001
1937
|
}
|
|
2002
|
-
|
|
2003
|
-
/** insert/update documents */
|
|
2004
|
-
update?: InternalDocumentUpdateOperation;
|
|
2005
|
-
/** delete by document ids */
|
|
2006
|
-
deleteByIds?: DeleteByIdsOperation;
|
|
2007
|
-
/** delete documents matching filter */
|
|
2008
|
-
deleteByFilter?: DeleteByFilterOperation;
|
|
2009
|
-
/** update internal documents matching filter */
|
|
2010
|
-
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
2011
|
-
/** update only existing documents */
|
|
2012
|
-
updateExisting?: InternalUpdateExistingOperation;
|
|
2013
|
-
/** insert/update documents with versioning */
|
|
2014
|
-
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
2015
|
-
/** delete by document ids with versioning */
|
|
2016
|
-
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
2017
|
-
/**
|
|
2018
|
-
* type of the documents
|
|
2019
|
-
* @minLength 2
|
|
2020
|
-
*/
|
|
2021
|
-
documentType?: string;
|
|
2022
|
-
/**
|
|
2023
|
-
* language of the documents (mandatory)
|
|
2024
|
-
* @minLength 2
|
|
2025
|
-
*/
|
|
2026
|
-
language?: string | null;
|
|
2027
|
-
/**
|
|
2028
|
-
* one or more search documents
|
|
2029
|
-
* @deprecated
|
|
2030
|
-
*/
|
|
2031
|
-
addDocuments?: InternalDocument[];
|
|
2032
|
-
/**
|
|
2033
|
-
* one or more ids of indexed documents to be removed. Removal will happen before addition (if both provided)
|
|
2034
|
-
* @deprecated
|
|
2035
|
-
*/
|
|
2036
|
-
removeDocumentIds?: string[];
|
|
2037
|
-
/** id to pass to processing notification */
|
|
2038
|
-
correlationId?: string | null;
|
|
2039
|
-
/** when event was created / issued */
|
|
2040
|
-
issuedAt?: Date | null;
|
|
2041
|
-
}
|
|
2042
|
-
/** @oneof */
|
|
2043
|
-
export interface UpdateInternalDocumentsEventOperationOneOf {
|
|
2044
|
-
/** insert/update documents */
|
|
2045
|
-
update?: InternalDocumentUpdateOperation;
|
|
2046
|
-
/** delete by document ids */
|
|
2047
|
-
deleteByIds?: DeleteByIdsOperation;
|
|
2048
|
-
/** delete documents matching filter */
|
|
2049
|
-
deleteByFilter?: DeleteByFilterOperation;
|
|
2050
|
-
/** update internal documents matching filter */
|
|
2051
|
-
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
2052
|
-
/** update only existing documents */
|
|
2053
|
-
updateExisting?: InternalUpdateExistingOperation;
|
|
2054
|
-
/** insert/update documents with versioning */
|
|
2055
|
-
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
2056
|
-
/** delete by document ids with versioning */
|
|
2057
|
-
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
2058
|
-
}
|
|
2059
|
-
export interface InternalDocument {
|
|
2060
|
-
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
2061
|
-
document?: Record<string, any> | null;
|
|
2062
|
-
}
|
|
2063
|
-
export interface InternalDocumentUpdateOperation {
|
|
2064
|
-
/** documents to index or update */
|
|
2065
|
-
documents?: InternalDocument[];
|
|
2066
|
-
}
|
|
2067
|
-
export interface DeleteByIdsOperation {
|
|
2068
|
-
/** ids of the documents to delete */
|
|
2069
|
-
documentIds?: string[];
|
|
2070
|
-
}
|
|
2071
|
-
export interface DeleteByFilterOperation {
|
|
2072
|
-
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
2073
|
-
filter?: Record<string, any> | null;
|
|
2074
|
-
}
|
|
2075
|
-
export interface InternalDocumentUpdateByFilterOperation {
|
|
2076
|
-
/** documents matching this filter will be updated */
|
|
2077
|
-
filter?: Record<string, any> | null;
|
|
2078
|
-
/** partial document to apply */
|
|
2079
|
-
document?: InternalDocument;
|
|
2080
|
-
}
|
|
2081
|
-
export interface InternalUpdateExistingOperation {
|
|
2082
|
-
/** documents to update */
|
|
2083
|
-
documents?: InternalDocument[];
|
|
2084
|
-
}
|
|
2085
|
-
export interface VersionedDocumentUpdateOperation {
|
|
2086
|
-
/** documents to create or overwrite */
|
|
2087
|
-
documents?: InternalDocument[];
|
|
2088
|
-
/** versioning mode to use instead of default */
|
|
2089
|
-
versioningMode?: VersioningModeWithLiterals;
|
|
2090
|
-
}
|
|
2091
|
-
export declare enum VersioningMode {
|
|
2092
|
-
/** use default versioning mode agreed with search team */
|
|
2093
|
-
DEFAULT = "DEFAULT",
|
|
2094
|
-
/** execute only if version is greater than existing */
|
|
2095
|
-
GREATER_THAN = "GREATER_THAN",
|
|
2096
|
-
/** execute only if version is greater or equal to existing */
|
|
2097
|
-
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
2098
|
-
}
|
|
2099
|
-
/** @enumType */
|
|
2100
|
-
export type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
|
|
2101
|
-
export interface VersionedDeleteByIdsOperation {
|
|
2102
|
-
/** ids with version of the documents to delete */
|
|
2103
|
-
documentIds?: VersionedDocumentId[];
|
|
2104
|
-
}
|
|
2105
|
-
export interface VersionedDocumentId {
|
|
2106
|
-
/** document id */
|
|
2107
|
-
documentId?: string;
|
|
2108
|
-
/** document version */
|
|
2109
|
-
version?: string;
|
|
2110
|
-
/** versioning mode to use instead of default */
|
|
2111
|
-
versioningMode?: VersioningModeWithLiterals;
|
|
2112
|
-
}
|
|
2113
|
-
export interface CommentModerated {
|
|
2114
|
-
comment?: Comment;
|
|
2115
|
-
moderationAction?: ActionWithLiterals;
|
|
2116
|
-
}
|
|
2117
|
-
export declare enum Action {
|
|
1938
|
+
declare enum Action {
|
|
2118
1939
|
/** Unknown content. */
|
|
2119
1940
|
UNKNOWN = "UNKNOWN",
|
|
2120
1941
|
/** Approve draft content. */
|
|
@@ -2123,76 +1944,45 @@ export declare enum Action {
|
|
|
2123
1944
|
REJECT = "REJECT"
|
|
2124
1945
|
}
|
|
2125
1946
|
/** @enumType */
|
|
2126
|
-
|
|
2127
|
-
|
|
1947
|
+
type ActionWithLiterals = Action | 'UNKNOWN' | 'APPROVE' | 'REJECT';
|
|
1948
|
+
interface CreateCommentRequest {
|
|
2128
1949
|
/** Comment to create. */
|
|
2129
1950
|
comment?: Comment;
|
|
2130
1951
|
}
|
|
2131
|
-
|
|
2132
|
-
}
|
|
2133
|
-
export interface CreateCommentResponse {
|
|
1952
|
+
interface CreateCommentResponse {
|
|
2134
1953
|
/** Created comment. */
|
|
2135
1954
|
comment?: Comment;
|
|
2136
1955
|
}
|
|
2137
|
-
|
|
2138
|
-
/** ID of the app that the comment is added to. */
|
|
2139
|
-
appId?: string;
|
|
2140
|
-
/**
|
|
2141
|
-
* ID of the specific context the comment is in response to.
|
|
2142
|
-
*
|
|
2143
|
-
* Within some Wix apps, the `contextId` will be the same as the `resourceId`. For example in Wix Forum, the `forumPostId` is used as both the `contextId` and the `resourceId`.
|
|
2144
|
-
*/
|
|
2145
|
-
contextId?: string;
|
|
2146
|
-
/**
|
|
2147
|
-
* ID of the specific resource that the comment is in response to.
|
|
2148
|
-
*
|
|
2149
|
-
* Within some Wix apps, the `resourceId` will be the same as the `contextId`. For example in Wix Forum, the `forumPostId` is used as both the `resourceId` and the `contextId`.
|
|
2150
|
-
*/
|
|
2151
|
-
resourceId?: string;
|
|
2152
|
-
/** How many comments are published for the resource. */
|
|
2153
|
-
publishedCommentCount?: number;
|
|
2154
|
-
}
|
|
2155
|
-
export interface GetCommentRequest {
|
|
1956
|
+
interface GetCommentRequest {
|
|
2156
1957
|
/**
|
|
2157
1958
|
* ID of the comment to retrieve.
|
|
2158
1959
|
* @format GUID
|
|
2159
1960
|
*/
|
|
2160
1961
|
commentId: string;
|
|
2161
1962
|
}
|
|
2162
|
-
|
|
1963
|
+
interface GetCommentResponse {
|
|
2163
1964
|
/** Retrieved comment. */
|
|
2164
1965
|
comment?: Comment;
|
|
2165
1966
|
}
|
|
2166
1967
|
/** Comment info to update. */
|
|
2167
|
-
|
|
1968
|
+
interface UpdateCommentRequest {
|
|
2168
1969
|
/** Comment info to update. */
|
|
2169
1970
|
comment?: Comment;
|
|
2170
1971
|
}
|
|
2171
|
-
|
|
1972
|
+
interface UpdateCommentResponse {
|
|
2172
1973
|
/** Updated comment. */
|
|
2173
1974
|
comment?: Comment;
|
|
2174
1975
|
}
|
|
2175
|
-
|
|
2176
|
-
/** Comment ID. */
|
|
2177
|
-
commentId?: string;
|
|
2178
|
-
/** Content before the update. */
|
|
2179
|
-
previousContent?: CommentContent;
|
|
2180
|
-
/** Content after the update. */
|
|
2181
|
-
currentContent?: CommentContent;
|
|
2182
|
-
}
|
|
2183
|
-
export interface DeleteCommentRequest {
|
|
1976
|
+
interface DeleteCommentRequest {
|
|
2184
1977
|
/**
|
|
2185
1978
|
* ID of the comment to delete.
|
|
2186
1979
|
* @format GUID
|
|
2187
1980
|
*/
|
|
2188
1981
|
commentId: string;
|
|
2189
1982
|
}
|
|
2190
|
-
|
|
2191
|
-
}
|
|
2192
|
-
export interface CommentDeleted {
|
|
2193
|
-
comment?: Comment;
|
|
1983
|
+
interface DeleteCommentResponse {
|
|
2194
1984
|
}
|
|
2195
|
-
|
|
1985
|
+
interface ModerateDraftContentRequest {
|
|
2196
1986
|
/**
|
|
2197
1987
|
* ID of the comment to moderate.
|
|
2198
1988
|
* @format GUID
|
|
@@ -2207,20 +1997,11 @@ export interface ModerateDraftContentRequest {
|
|
|
2207
1997
|
/** Draft content action. */
|
|
2208
1998
|
draftContentAction?: ActionWithLiterals;
|
|
2209
1999
|
}
|
|
2210
|
-
|
|
2000
|
+
interface ModerateDraftContentResponse {
|
|
2211
2001
|
/** Moderated comment. */
|
|
2212
2002
|
comment?: Comment;
|
|
2213
2003
|
}
|
|
2214
|
-
|
|
2215
|
-
/** Comment info. */
|
|
2216
|
-
comment?: Comment;
|
|
2217
|
-
/** Whether this is the first comment publish. */
|
|
2218
|
-
firstPublish?: boolean;
|
|
2219
|
-
}
|
|
2220
|
-
export interface CommentHidden {
|
|
2221
|
-
comment?: Comment;
|
|
2222
|
-
}
|
|
2223
|
-
export interface QueryCommentsRequest {
|
|
2004
|
+
interface QueryCommentsRequest {
|
|
2224
2005
|
/**
|
|
2225
2006
|
* App ID to query comments for.
|
|
2226
2007
|
* @format GUID
|
|
@@ -2229,7 +2010,7 @@ export interface QueryCommentsRequest {
|
|
|
2229
2010
|
/** Query options. */
|
|
2230
2011
|
query: CursorQuery;
|
|
2231
2012
|
}
|
|
2232
|
-
|
|
2013
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
2233
2014
|
/**
|
|
2234
2015
|
* Cursor paging options.
|
|
2235
2016
|
*
|
|
@@ -2251,7 +2032,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
2251
2032
|
sort?: Sorting[];
|
|
2252
2033
|
}
|
|
2253
2034
|
/** @oneof */
|
|
2254
|
-
|
|
2035
|
+
interface CursorQueryPagingMethodOneOf {
|
|
2255
2036
|
/**
|
|
2256
2037
|
* Cursor paging options.
|
|
2257
2038
|
*
|
|
@@ -2259,7 +2040,7 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
2259
2040
|
*/
|
|
2260
2041
|
cursorPaging?: CursorPaging;
|
|
2261
2042
|
}
|
|
2262
|
-
|
|
2043
|
+
interface Sorting {
|
|
2263
2044
|
/**
|
|
2264
2045
|
* Name of the field to sort by.
|
|
2265
2046
|
* @maxLength 512
|
|
@@ -2268,13 +2049,13 @@ export interface Sorting {
|
|
|
2268
2049
|
/** Sort order. */
|
|
2269
2050
|
order?: SortOrderWithLiterals;
|
|
2270
2051
|
}
|
|
2271
|
-
|
|
2052
|
+
declare enum SortOrder {
|
|
2272
2053
|
ASC = "ASC",
|
|
2273
2054
|
DESC = "DESC"
|
|
2274
2055
|
}
|
|
2275
2056
|
/** @enumType */
|
|
2276
|
-
|
|
2277
|
-
|
|
2057
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
2058
|
+
interface CursorPaging {
|
|
2278
2059
|
/**
|
|
2279
2060
|
* Maximum number of items to return in the results.
|
|
2280
2061
|
* @max 100
|
|
@@ -2289,13 +2070,13 @@ export interface CursorPaging {
|
|
|
2289
2070
|
*/
|
|
2290
2071
|
cursor?: string | null;
|
|
2291
2072
|
}
|
|
2292
|
-
|
|
2073
|
+
interface QueryCommentsResponse {
|
|
2293
2074
|
/** Retrieved comments. */
|
|
2294
2075
|
comments?: Comment[];
|
|
2295
2076
|
/** Paging metadata. */
|
|
2296
2077
|
pagingMetadata?: CursorPagingMetadata;
|
|
2297
2078
|
}
|
|
2298
|
-
|
|
2079
|
+
interface CursorPagingMetadata {
|
|
2299
2080
|
/** Number of items returned in current page. */
|
|
2300
2081
|
count?: number | null;
|
|
2301
2082
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -2308,7 +2089,7 @@ export interface CursorPagingMetadata {
|
|
|
2308
2089
|
*/
|
|
2309
2090
|
hasNext?: boolean | null;
|
|
2310
2091
|
}
|
|
2311
|
-
|
|
2092
|
+
interface Cursors {
|
|
2312
2093
|
/**
|
|
2313
2094
|
* Cursor string pointing to the next page in the list of results.
|
|
2314
2095
|
* @maxLength 16000
|
|
@@ -2320,58 +2101,52 @@ export interface Cursors {
|
|
|
2320
2101
|
*/
|
|
2321
2102
|
prev?: string | null;
|
|
2322
2103
|
}
|
|
2323
|
-
|
|
2104
|
+
interface MarkCommentRequest {
|
|
2324
2105
|
/**
|
|
2325
2106
|
* ID of the comment to mark.
|
|
2326
2107
|
* @format GUID
|
|
2327
2108
|
*/
|
|
2328
2109
|
commentId: string;
|
|
2329
2110
|
}
|
|
2330
|
-
|
|
2111
|
+
interface MarkCommentResponse {
|
|
2331
2112
|
/** Marked comment. */
|
|
2332
2113
|
comment?: Comment;
|
|
2333
2114
|
}
|
|
2334
|
-
|
|
2335
|
-
comment?: Comment;
|
|
2336
|
-
}
|
|
2337
|
-
export interface UnmarkCommentRequest {
|
|
2115
|
+
interface UnmarkCommentRequest {
|
|
2338
2116
|
/**
|
|
2339
2117
|
* ID of the comment to unmark.
|
|
2340
2118
|
* @format GUID
|
|
2341
2119
|
*/
|
|
2342
2120
|
commentId: string;
|
|
2343
2121
|
}
|
|
2344
|
-
|
|
2122
|
+
interface UnmarkCommentResponse {
|
|
2345
2123
|
/** Unmarked comment. */
|
|
2346
2124
|
comment?: Comment;
|
|
2347
2125
|
}
|
|
2348
|
-
|
|
2349
|
-
comment?: Comment;
|
|
2350
|
-
}
|
|
2351
|
-
export interface HideCommentRequest {
|
|
2126
|
+
interface HideCommentRequest {
|
|
2352
2127
|
/**
|
|
2353
2128
|
* ID of the comment to hide.
|
|
2354
2129
|
* @format GUID
|
|
2355
2130
|
*/
|
|
2356
2131
|
commentId: string;
|
|
2357
2132
|
}
|
|
2358
|
-
|
|
2133
|
+
interface HideCommentResponse {
|
|
2359
2134
|
/** Hidden comment. */
|
|
2360
2135
|
comment?: Comment;
|
|
2361
2136
|
}
|
|
2362
|
-
|
|
2137
|
+
interface PublishCommentRequest {
|
|
2363
2138
|
/**
|
|
2364
2139
|
* ID of the comment to publish.
|
|
2365
2140
|
* @format GUID
|
|
2366
2141
|
*/
|
|
2367
2142
|
commentId: string;
|
|
2368
2143
|
}
|
|
2369
|
-
|
|
2144
|
+
interface PublishCommentResponse {
|
|
2370
2145
|
/** Published comment. */
|
|
2371
2146
|
comment?: Comment;
|
|
2372
2147
|
}
|
|
2373
2148
|
/** Count comments options. */
|
|
2374
|
-
|
|
2149
|
+
interface CountCommentsRequest {
|
|
2375
2150
|
/**
|
|
2376
2151
|
* App ID to count the comments of.
|
|
2377
2152
|
* @format GUID
|
|
@@ -2380,11 +2155,11 @@ export interface CountCommentsRequest {
|
|
|
2380
2155
|
/** Filter to identify the comments that need to be counted. */
|
|
2381
2156
|
filter?: Record<string, any> | null;
|
|
2382
2157
|
}
|
|
2383
|
-
|
|
2158
|
+
interface CountCommentsResponse {
|
|
2384
2159
|
/** Number of comments. */
|
|
2385
2160
|
count?: number;
|
|
2386
2161
|
}
|
|
2387
|
-
|
|
2162
|
+
interface ListCommentsByResourceRequest {
|
|
2388
2163
|
/**
|
|
2389
2164
|
* ID of the app from which the comments are listed.
|
|
2390
2165
|
* @format GUID
|
|
@@ -2416,7 +2191,7 @@ export interface ListCommentsByResourceRequest {
|
|
|
2416
2191
|
/** Cursor paging. */
|
|
2417
2192
|
cursorPaging?: ListCommentsByResourceCursorPaging;
|
|
2418
2193
|
}
|
|
2419
|
-
|
|
2194
|
+
interface CommentSort {
|
|
2420
2195
|
/** Sort order. */
|
|
2421
2196
|
order?: OrderWithLiterals;
|
|
2422
2197
|
/**
|
|
@@ -2426,7 +2201,7 @@ export interface CommentSort {
|
|
|
2426
2201
|
*/
|
|
2427
2202
|
keepMarkedInOriginalOrder?: boolean;
|
|
2428
2203
|
}
|
|
2429
|
-
|
|
2204
|
+
declare enum Order {
|
|
2430
2205
|
/** Unknown order. */
|
|
2431
2206
|
UNKNOWN_ORDER = "UNKNOWN_ORDER",
|
|
2432
2207
|
/** Oldest comments appear at the top of the list. */
|
|
@@ -2445,8 +2220,8 @@ export declare enum Order {
|
|
|
2445
2220
|
RATING_ASC = "RATING_ASC"
|
|
2446
2221
|
}
|
|
2447
2222
|
/** @enumType */
|
|
2448
|
-
|
|
2449
|
-
|
|
2223
|
+
type OrderWithLiterals = Order | 'UNKNOWN_ORDER' | 'OLDEST_FIRST' | 'NEWEST_FIRST' | 'REACTION_COUNT' | 'NET_VOTE_COUNT' | 'RATING' | 'NET_VOTE_COUNT_ASC' | 'RATING_ASC';
|
|
2224
|
+
interface ReplySort {
|
|
2450
2225
|
/** Sort order. */
|
|
2451
2226
|
order?: ReplySortOrderWithLiterals;
|
|
2452
2227
|
/**
|
|
@@ -2458,7 +2233,7 @@ export interface ReplySort {
|
|
|
2458
2233
|
*/
|
|
2459
2234
|
keepMarkedInOriginalOrder?: boolean;
|
|
2460
2235
|
}
|
|
2461
|
-
|
|
2236
|
+
declare enum ReplySortOrder {
|
|
2462
2237
|
/** Unknown order. */
|
|
2463
2238
|
UNKNOWN_ORDER = "UNKNOWN_ORDER",
|
|
2464
2239
|
/** Oldest comments appear at the top of the list. */
|
|
@@ -2469,8 +2244,8 @@ export declare enum ReplySortOrder {
|
|
|
2469
2244
|
REACTION_COUNT = "REACTION_COUNT"
|
|
2470
2245
|
}
|
|
2471
2246
|
/** @enumType */
|
|
2472
|
-
|
|
2473
|
-
|
|
2247
|
+
type ReplySortOrderWithLiterals = ReplySortOrder | 'UNKNOWN_ORDER' | 'OLDEST_FIRST' | 'NEWEST_FIRST' | 'REACTION_COUNT';
|
|
2248
|
+
interface ListCommentsByResourceCursorPaging {
|
|
2474
2249
|
/** Pointer to the next or previous page in the list of results. */
|
|
2475
2250
|
cursor?: string | null;
|
|
2476
2251
|
/**
|
|
@@ -2485,7 +2260,7 @@ export interface ListCommentsByResourceCursorPaging {
|
|
|
2485
2260
|
*/
|
|
2486
2261
|
repliesLimit?: number | null;
|
|
2487
2262
|
}
|
|
2488
|
-
|
|
2263
|
+
interface ListCommentsByResourceResponse {
|
|
2489
2264
|
/** Listed comments. */
|
|
2490
2265
|
comments?: Comment[];
|
|
2491
2266
|
/** Paging metadata. */
|
|
@@ -2493,13 +2268,13 @@ export interface ListCommentsByResourceResponse {
|
|
|
2493
2268
|
/** Listed comment replies. */
|
|
2494
2269
|
commentReplies?: Record<string, RepliesListResponse>;
|
|
2495
2270
|
}
|
|
2496
|
-
|
|
2271
|
+
interface RepliesListResponse {
|
|
2497
2272
|
/** Listed comment replies. */
|
|
2498
2273
|
replies?: Comment[];
|
|
2499
2274
|
/** Paging metadata. */
|
|
2500
2275
|
pagingMetadata?: CursorPagingMetadata;
|
|
2501
2276
|
}
|
|
2502
|
-
|
|
2277
|
+
interface GetCommentThreadRequest {
|
|
2503
2278
|
/**
|
|
2504
2279
|
* App ID.
|
|
2505
2280
|
* @maxLength 128
|
|
@@ -2517,7 +2292,7 @@ export interface GetCommentThreadRequest {
|
|
|
2517
2292
|
/** Reply sorting. */
|
|
2518
2293
|
replySort?: ReplySort;
|
|
2519
2294
|
}
|
|
2520
|
-
|
|
2295
|
+
interface GetCommentThreadResponse {
|
|
2521
2296
|
/** Retrieved replies. */
|
|
2522
2297
|
comments?: Comment[];
|
|
2523
2298
|
/** Paging metadata. */
|
|
@@ -2525,7 +2300,7 @@ export interface GetCommentThreadResponse {
|
|
|
2525
2300
|
/** Retrieved replies of a reply. */
|
|
2526
2301
|
commentReplies?: Record<string, RepliesListResponse>;
|
|
2527
2302
|
}
|
|
2528
|
-
|
|
2303
|
+
interface BulkPublishCommentRequest {
|
|
2529
2304
|
/**
|
|
2530
2305
|
* ID of the app where to publish the comment.
|
|
2531
2306
|
* @format GUID
|
|
@@ -2534,7 +2309,7 @@ export interface BulkPublishCommentRequest {
|
|
|
2534
2309
|
/** Filter to identify the comments that need to be published. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
|
|
2535
2310
|
filter: Record<string, any> | null;
|
|
2536
2311
|
}
|
|
2537
|
-
|
|
2312
|
+
interface BulkPublishCommentResponse {
|
|
2538
2313
|
/**
|
|
2539
2314
|
* Job ID.
|
|
2540
2315
|
*
|
|
@@ -2543,7 +2318,7 @@ export interface BulkPublishCommentResponse {
|
|
|
2543
2318
|
*/
|
|
2544
2319
|
jobId?: string;
|
|
2545
2320
|
}
|
|
2546
|
-
|
|
2321
|
+
interface BulkHideCommentRequest {
|
|
2547
2322
|
/**
|
|
2548
2323
|
* ID of the app where to hide the comments.
|
|
2549
2324
|
* @format GUID
|
|
@@ -2552,7 +2327,7 @@ export interface BulkHideCommentRequest {
|
|
|
2552
2327
|
/** Filter to identify the comments that need to be hidden. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
|
|
2553
2328
|
filter: Record<string, any> | null;
|
|
2554
2329
|
}
|
|
2555
|
-
|
|
2330
|
+
interface BulkHideCommentResponse {
|
|
2556
2331
|
/**
|
|
2557
2332
|
* Job ID.
|
|
2558
2333
|
*
|
|
@@ -2561,7 +2336,7 @@ export interface BulkHideCommentResponse {
|
|
|
2561
2336
|
*/
|
|
2562
2337
|
jobId?: string;
|
|
2563
2338
|
}
|
|
2564
|
-
|
|
2339
|
+
interface BulkDeleteCommentRequest {
|
|
2565
2340
|
/**
|
|
2566
2341
|
* ID of the app where to delete the comments.
|
|
2567
2342
|
* @format GUID
|
|
@@ -2570,7 +2345,7 @@ export interface BulkDeleteCommentRequest {
|
|
|
2570
2345
|
/** Filter to identify the comments that need to be deleted. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
|
|
2571
2346
|
filter: Record<string, any> | null;
|
|
2572
2347
|
}
|
|
2573
|
-
|
|
2348
|
+
interface BulkDeleteCommentResponse {
|
|
2574
2349
|
/**
|
|
2575
2350
|
* Job ID.
|
|
2576
2351
|
*
|
|
@@ -2579,7 +2354,7 @@ export interface BulkDeleteCommentResponse {
|
|
|
2579
2354
|
*/
|
|
2580
2355
|
jobId?: string;
|
|
2581
2356
|
}
|
|
2582
|
-
|
|
2357
|
+
interface BulkModerateDraftContentRequest {
|
|
2583
2358
|
/**
|
|
2584
2359
|
* ID of the app where to moderate the comments.
|
|
2585
2360
|
* @format GUID
|
|
@@ -2590,7 +2365,7 @@ export interface BulkModerateDraftContentRequest {
|
|
|
2590
2365
|
/** Action to do regarding draft content */
|
|
2591
2366
|
draftContentAction: ActionWithLiterals;
|
|
2592
2367
|
}
|
|
2593
|
-
|
|
2368
|
+
interface BulkModerateDraftContentResponse {
|
|
2594
2369
|
/**
|
|
2595
2370
|
* Job ID.
|
|
2596
2371
|
*
|
|
@@ -2599,7 +2374,7 @@ export interface BulkModerateDraftContentResponse {
|
|
|
2599
2374
|
*/
|
|
2600
2375
|
jobId?: string;
|
|
2601
2376
|
}
|
|
2602
|
-
|
|
2377
|
+
interface BulkMoveCommentByFilterRequest {
|
|
2603
2378
|
/**
|
|
2604
2379
|
* ID of the app from which to move the comments.
|
|
2605
2380
|
* @format GUID
|
|
@@ -2610,7 +2385,7 @@ export interface BulkMoveCommentByFilterRequest {
|
|
|
2610
2385
|
/** Where to move the comment. */
|
|
2611
2386
|
destination?: Destination;
|
|
2612
2387
|
}
|
|
2613
|
-
|
|
2388
|
+
interface Destination {
|
|
2614
2389
|
/**
|
|
2615
2390
|
* Context ID of where to move the comment to.
|
|
2616
2391
|
* @maxLength 128
|
|
@@ -2622,7 +2397,7 @@ export interface Destination {
|
|
|
2622
2397
|
*/
|
|
2623
2398
|
resourceId?: string;
|
|
2624
2399
|
}
|
|
2625
|
-
|
|
2400
|
+
interface BulkMoveCommentByFilterResponse {
|
|
2626
2401
|
/**
|
|
2627
2402
|
* Job ID.
|
|
2628
2403
|
*
|
|
@@ -2631,143 +2406,52 @@ export interface BulkMoveCommentByFilterResponse {
|
|
|
2631
2406
|
*/
|
|
2632
2407
|
jobId?: string;
|
|
2633
2408
|
}
|
|
2634
|
-
|
|
2635
|
-
|
|
2636
|
-
|
|
2637
|
-
|
|
2638
|
-
|
|
2639
|
-
|
|
2640
|
-
|
|
2641
|
-
|
|
2642
|
-
|
|
2643
|
-
|
|
2644
|
-
|
|
2645
|
-
|
|
2646
|
-
|
|
2647
|
-
|
|
2648
|
-
|
|
2649
|
-
|
|
2650
|
-
|
|
2651
|
-
|
|
2652
|
-
|
|
2653
|
-
|
|
2654
|
-
|
|
2655
|
-
|
|
2656
|
-
|
|
2657
|
-
|
|
2658
|
-
|
|
2659
|
-
|
|
2660
|
-
|
|
2661
|
-
|
|
2662
|
-
|
|
2663
|
-
|
|
2664
|
-
|
|
2665
|
-
|
|
2666
|
-
|
|
2667
|
-
|
|
2668
|
-
|
|
2669
|
-
|
|
2670
|
-
|
|
2671
|
-
}
|
|
2672
|
-
|
|
2673
|
-
|
|
2674
|
-
|
|
2675
|
-
|
|
2676
|
-
|
|
2677
|
-
|
|
2678
|
-
}
|
|
2679
|
-
|
|
2680
|
-
|
|
2681
|
-
|
|
2682
|
-
|
|
2683
|
-
}
|
|
2684
|
-
export interface RestoreInfo {
|
|
2685
|
-
deletedDate?: Date | null;
|
|
2686
|
-
}
|
|
2687
|
-
export interface EntityUpdatedEvent {
|
|
2688
|
-
/**
|
|
2689
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2690
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2691
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2692
|
-
*/
|
|
2693
|
-
currentEntityAsJson?: string;
|
|
2694
|
-
}
|
|
2695
|
-
export interface EntityDeletedEvent {
|
|
2696
|
-
/** Entity that was deleted. */
|
|
2697
|
-
deletedEntityAsJson?: string | null;
|
|
2698
|
-
}
|
|
2699
|
-
export interface ActionEvent {
|
|
2700
|
-
bodyAsJson?: string;
|
|
2701
|
-
}
|
|
2702
|
-
export interface MessageEnvelope {
|
|
2703
|
-
/**
|
|
2704
|
-
* App instance ID.
|
|
2705
|
-
* @format GUID
|
|
2706
|
-
*/
|
|
2707
|
-
instanceId?: string | null;
|
|
2708
|
-
/**
|
|
2709
|
-
* Event type.
|
|
2710
|
-
* @maxLength 150
|
|
2711
|
-
*/
|
|
2712
|
-
eventType?: string;
|
|
2713
|
-
/** The identification type and identity data. */
|
|
2714
|
-
identity?: IdentificationData;
|
|
2715
|
-
/** Stringify payload. */
|
|
2716
|
-
data?: string;
|
|
2717
|
-
}
|
|
2718
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2719
|
-
/**
|
|
2720
|
-
* ID of a site visitor that has not logged in to the site.
|
|
2721
|
-
* @format GUID
|
|
2722
|
-
*/
|
|
2723
|
-
anonymousVisitorId?: string;
|
|
2724
|
-
/**
|
|
2725
|
-
* ID of a site visitor that has logged in to the site.
|
|
2726
|
-
* @format GUID
|
|
2727
|
-
*/
|
|
2728
|
-
memberId?: string;
|
|
2729
|
-
/**
|
|
2730
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2731
|
-
* @format GUID
|
|
2732
|
-
*/
|
|
2733
|
-
wixUserId?: string;
|
|
2734
|
-
/**
|
|
2735
|
-
* ID of an app.
|
|
2736
|
-
* @format GUID
|
|
2737
|
-
*/
|
|
2738
|
-
appId?: string;
|
|
2739
|
-
/** @readonly */
|
|
2740
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2741
|
-
}
|
|
2742
|
-
/** @oneof */
|
|
2743
|
-
export interface IdentificationDataIdOneOf {
|
|
2744
|
-
/**
|
|
2745
|
-
* ID of a site visitor that has not logged in to the site.
|
|
2746
|
-
* @format GUID
|
|
2747
|
-
*/
|
|
2748
|
-
anonymousVisitorId?: string;
|
|
2749
|
-
/**
|
|
2750
|
-
* ID of a site visitor that has logged in to the site.
|
|
2751
|
-
* @format GUID
|
|
2752
|
-
*/
|
|
2753
|
-
memberId?: string;
|
|
2754
|
-
/**
|
|
2755
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2756
|
-
* @format GUID
|
|
2757
|
-
*/
|
|
2758
|
-
wixUserId?: string;
|
|
2759
|
-
/**
|
|
2760
|
-
* ID of an app.
|
|
2761
|
-
* @format GUID
|
|
2762
|
-
*/
|
|
2763
|
-
appId?: string;
|
|
2764
|
-
}
|
|
2765
|
-
export declare enum WebhookIdentityType {
|
|
2766
|
-
UNKNOWN = "UNKNOWN",
|
|
2767
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2768
|
-
MEMBER = "MEMBER",
|
|
2769
|
-
WIX_USER = "WIX_USER",
|
|
2770
|
-
APP = "APP"
|
|
2771
|
-
}
|
|
2772
|
-
/** @enumType */
|
|
2773
|
-
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2409
|
+
|
|
2410
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
2411
|
+
getUrl: (context: any) => string;
|
|
2412
|
+
httpMethod: K;
|
|
2413
|
+
path: string;
|
|
2414
|
+
pathParams: M;
|
|
2415
|
+
__requestType: T;
|
|
2416
|
+
__originalRequestType: S;
|
|
2417
|
+
__responseType: Q;
|
|
2418
|
+
__originalResponseType: R;
|
|
2419
|
+
};
|
|
2420
|
+
declare function createComment(): __PublicMethodMetaInfo<'POST', {}, CreateCommentRequest$1, CreateCommentRequest, CreateCommentResponse$1, CreateCommentResponse>;
|
|
2421
|
+
declare function getComment(): __PublicMethodMetaInfo<'GET', {
|
|
2422
|
+
commentId: string;
|
|
2423
|
+
}, GetCommentRequest$1, GetCommentRequest, GetCommentResponse$1, GetCommentResponse>;
|
|
2424
|
+
declare function updateComment(): __PublicMethodMetaInfo<'PATCH', {
|
|
2425
|
+
commentId: string;
|
|
2426
|
+
}, UpdateCommentRequest$1, UpdateCommentRequest, UpdateCommentResponse$1, UpdateCommentResponse>;
|
|
2427
|
+
declare function deleteComment(): __PublicMethodMetaInfo<'DELETE', {
|
|
2428
|
+
commentId: string;
|
|
2429
|
+
}, DeleteCommentRequest$1, DeleteCommentRequest, DeleteCommentResponse$1, DeleteCommentResponse>;
|
|
2430
|
+
declare function moderateDraftContent(): __PublicMethodMetaInfo<'POST', {
|
|
2431
|
+
commentId: string;
|
|
2432
|
+
}, ModerateDraftContentRequest$1, ModerateDraftContentRequest, ModerateDraftContentResponse$1, ModerateDraftContentResponse>;
|
|
2433
|
+
declare function queryComments(): __PublicMethodMetaInfo<'POST', {}, QueryCommentsRequest$1, QueryCommentsRequest, QueryCommentsResponse$1, QueryCommentsResponse>;
|
|
2434
|
+
declare function markComment(): __PublicMethodMetaInfo<'PUT', {
|
|
2435
|
+
commentId: string;
|
|
2436
|
+
}, MarkCommentRequest$1, MarkCommentRequest, MarkCommentResponse$1, MarkCommentResponse>;
|
|
2437
|
+
declare function unmarkComment(): __PublicMethodMetaInfo<'PUT', {
|
|
2438
|
+
commentId: string;
|
|
2439
|
+
}, UnmarkCommentRequest$1, UnmarkCommentRequest, UnmarkCommentResponse$1, UnmarkCommentResponse>;
|
|
2440
|
+
declare function hideComment(): __PublicMethodMetaInfo<'PUT', {
|
|
2441
|
+
commentId: string;
|
|
2442
|
+
}, HideCommentRequest$1, HideCommentRequest, HideCommentResponse$1, HideCommentResponse>;
|
|
2443
|
+
declare function publishComment(): __PublicMethodMetaInfo<'PUT', {
|
|
2444
|
+
commentId: string;
|
|
2445
|
+
}, PublishCommentRequest$1, PublishCommentRequest, PublishCommentResponse$1, PublishCommentResponse>;
|
|
2446
|
+
declare function countComments(): __PublicMethodMetaInfo<'POST', {}, CountCommentsRequest$1, CountCommentsRequest, CountCommentsResponse$1, CountCommentsResponse>;
|
|
2447
|
+
declare function listCommentsByResource(): __PublicMethodMetaInfo<'GET', {}, ListCommentsByResourceRequest$1, ListCommentsByResourceRequest, ListCommentsByResourceResponse$1, ListCommentsByResourceResponse>;
|
|
2448
|
+
declare function getCommentThread(): __PublicMethodMetaInfo<'GET', {
|
|
2449
|
+
commentId: string;
|
|
2450
|
+
}, GetCommentThreadRequest$1, GetCommentThreadRequest, GetCommentThreadResponse$1, GetCommentThreadResponse>;
|
|
2451
|
+
declare function bulkPublishComment(): __PublicMethodMetaInfo<'POST', {}, BulkPublishCommentRequest$1, BulkPublishCommentRequest, BulkPublishCommentResponse$1, BulkPublishCommentResponse>;
|
|
2452
|
+
declare function bulkHideComment(): __PublicMethodMetaInfo<'PUT', {}, BulkHideCommentRequest$1, BulkHideCommentRequest, BulkHideCommentResponse$1, BulkHideCommentResponse>;
|
|
2453
|
+
declare function bulkDeleteComment(): __PublicMethodMetaInfo<'PUT', {}, BulkDeleteCommentRequest$1, BulkDeleteCommentRequest, BulkDeleteCommentResponse$1, BulkDeleteCommentResponse>;
|
|
2454
|
+
declare function bulkModerateDraftContent(): __PublicMethodMetaInfo<'POST', {}, BulkModerateDraftContentRequest$1, BulkModerateDraftContentRequest, BulkModerateDraftContentResponse$1, BulkModerateDraftContentResponse>;
|
|
2455
|
+
declare function bulkMoveCommentByFilter(): __PublicMethodMetaInfo<'PUT', {}, BulkMoveCommentByFilterRequest$1, BulkMoveCommentByFilterRequest, BulkMoveCommentByFilterResponse$1, BulkMoveCommentByFilterResponse>;
|
|
2456
|
+
|
|
2457
|
+
export { type __PublicMethodMetaInfo, bulkDeleteComment, bulkHideComment, bulkModerateDraftContent, bulkMoveCommentByFilter, bulkPublishComment, countComments, createComment, deleteComment, getComment, getCommentThread, hideComment, listCommentsByResource, markComment, moderateDraftContent, publishComment, queryComments, unmarkComment, updateComment };
|