@wix/auto_sdk_blog_draft-posts 1.0.24 → 1.0.26
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/blog-v3-draft-draft-posts.universal.d.ts → cjs/blog-v3-draft-draft-posts.universal-yk8zFFHT.d.ts} +311 -644
- package/build/cjs/index.d.ts +195 -1
- package/build/cjs/index.js +3441 -15
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +2359 -1
- package/build/cjs/meta.js +2054 -15
- package/build/cjs/meta.js.map +1 -1
- package/build/{internal/es/src/blog-v3-draft-draft-posts.universal.d.ts → es/blog-v3-draft-draft-posts.universal-yk8zFFHT.d.mts} +311 -644
- package/build/es/index.d.mts +195 -0
- package/build/es/index.mjs +3364 -0
- package/build/es/index.mjs.map +1 -0
- package/build/es/{src/blog-v3-draft-draft-posts.types.d.ts → meta.d.mts} +263 -1025
- package/build/es/meta.mjs +2017 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/{cjs/src/blog-v3-draft-draft-posts.universal.d.ts → internal/cjs/blog-v3-draft-draft-posts.universal-yk8zFFHT.d.ts} +311 -644
- package/build/internal/cjs/index.d.ts +195 -1
- package/build/internal/cjs/index.js +3441 -15
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +2359 -1
- package/build/internal/cjs/meta.js +2054 -15
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/{es/src/blog-v3-draft-draft-posts.universal.d.ts → internal/es/blog-v3-draft-draft-posts.universal-yk8zFFHT.d.mts} +311 -644
- package/build/internal/es/index.d.mts +195 -0
- package/build/internal/es/index.mjs +3364 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/{cjs/src/blog-v3-draft-draft-posts.types.d.ts → internal/es/meta.d.mts} +263 -1025
- package/build/internal/es/meta.mjs +2017 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +9 -8
- 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/src/blog-v3-draft-draft-posts.context.d.ts +0 -34
- package/build/cjs/src/blog-v3-draft-draft-posts.context.js +0 -78
- package/build/cjs/src/blog-v3-draft-draft-posts.context.js.map +0 -1
- package/build/cjs/src/blog-v3-draft-draft-posts.http.d.ts +0 -83
- package/build/cjs/src/blog-v3-draft-draft-posts.http.js +0 -1803
- package/build/cjs/src/blog-v3-draft-draft-posts.http.js.map +0 -1
- package/build/cjs/src/blog-v3-draft-draft-posts.meta.d.ts +0 -40
- package/build/cjs/src/blog-v3-draft-draft-posts.meta.js +0 -294
- package/build/cjs/src/blog-v3-draft-draft-posts.meta.js.map +0 -1
- package/build/cjs/src/blog-v3-draft-draft-posts.public.d.ts +0 -168
- package/build/cjs/src/blog-v3-draft-draft-posts.public.js +0 -339
- package/build/cjs/src/blog-v3-draft-draft-posts.public.js.map +0 -1
- package/build/cjs/src/blog-v3-draft-draft-posts.types.js +0 -477
- package/build/cjs/src/blog-v3-draft-draft-posts.types.js.map +0 -1
- package/build/cjs/src/blog-v3-draft-draft-posts.universal.js +0 -1506
- package/build/cjs/src/blog-v3-draft-draft-posts.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/blog-v3-draft-draft-posts.context.d.ts +0 -34
- package/build/es/src/blog-v3-draft-draft-posts.context.js +0 -34
- package/build/es/src/blog-v3-draft-draft-posts.context.js.map +0 -1
- package/build/es/src/blog-v3-draft-draft-posts.http.d.ts +0 -83
- package/build/es/src/blog-v3-draft-draft-posts.http.js +0 -1786
- package/build/es/src/blog-v3-draft-draft-posts.http.js.map +0 -1
- package/build/es/src/blog-v3-draft-draft-posts.meta.d.ts +0 -40
- package/build/es/src/blog-v3-draft-draft-posts.meta.js +0 -254
- package/build/es/src/blog-v3-draft-draft-posts.meta.js.map +0 -1
- package/build/es/src/blog-v3-draft-draft-posts.public.d.ts +0 -168
- package/build/es/src/blog-v3-draft-draft-posts.public.js +0 -281
- package/build/es/src/blog-v3-draft-draft-posts.public.js.map +0 -1
- package/build/es/src/blog-v3-draft-draft-posts.types.js +0 -474
- package/build/es/src/blog-v3-draft-draft-posts.types.js.map +0 -1
- package/build/es/src/blog-v3-draft-draft-posts.universal.js +0 -1465
- package/build/es/src/blog-v3-draft-draft-posts.universal.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/src/blog-v3-draft-draft-posts.context.d.ts +0 -34
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.js +0 -78
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.http.d.ts +0 -83
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.http.js +0 -1803
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.http.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.meta.d.ts +0 -40
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.meta.js +0 -294
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.meta.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.d.ts +0 -168
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.js +0 -339
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.d.ts +0 -3121
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.js +0 -477
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.js +0 -1506
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.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/blog-v3-draft-draft-posts.context.d.ts +0 -34
- package/build/internal/es/src/blog-v3-draft-draft-posts.context.js +0 -34
- package/build/internal/es/src/blog-v3-draft-draft-posts.context.js.map +0 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.http.d.ts +0 -83
- package/build/internal/es/src/blog-v3-draft-draft-posts.http.js +0 -1786
- package/build/internal/es/src/blog-v3-draft-draft-posts.http.js.map +0 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.meta.d.ts +0 -40
- package/build/internal/es/src/blog-v3-draft-draft-posts.meta.js +0 -254
- package/build/internal/es/src/blog-v3-draft-draft-posts.meta.js.map +0 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.public.d.ts +0 -168
- package/build/internal/es/src/blog-v3-draft-draft-posts.public.js +0 -281
- package/build/internal/es/src/blog-v3-draft-draft-posts.public.js.map +0 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.types.d.ts +0 -3121
- package/build/internal/es/src/blog-v3-draft-draft-posts.types.js +0 -474
- package/build/internal/es/src/blog-v3-draft-draft-posts.types.js.map +0 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.universal.js +0 -1465
- package/build/internal/es/src/blog-v3-draft-draft-posts.universal.js.map +0 -1
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export interface DraftPost {
|
|
1
|
+
interface DraftPost {
|
|
3
2
|
/**
|
|
4
3
|
* Draft post ID.
|
|
5
4
|
* @readonly
|
|
@@ -134,7 +133,7 @@ export interface DraftPost {
|
|
|
134
133
|
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
|
135
134
|
previewTextParagraph?: number | null;
|
|
136
135
|
}
|
|
137
|
-
|
|
136
|
+
interface CoverMedia extends CoverMediaMediaOneOf {
|
|
138
137
|
/** Image url. */
|
|
139
138
|
image?: string;
|
|
140
139
|
/** Video url. */
|
|
@@ -165,13 +164,13 @@ export interface CoverMedia extends CoverMediaMediaOneOf {
|
|
|
165
164
|
altText?: string | null;
|
|
166
165
|
}
|
|
167
166
|
/** @oneof */
|
|
168
|
-
|
|
167
|
+
interface CoverMediaMediaOneOf {
|
|
169
168
|
/** Image url. */
|
|
170
169
|
image?: string;
|
|
171
170
|
/** Video url. */
|
|
172
171
|
video?: string;
|
|
173
172
|
}
|
|
174
|
-
|
|
173
|
+
interface FocalPoint {
|
|
175
174
|
/** X-coordinate of the focal point. */
|
|
176
175
|
x?: number;
|
|
177
176
|
/** Y-coordinate of the focal point. */
|
|
@@ -181,7 +180,7 @@ export interface FocalPoint {
|
|
|
181
180
|
/** crop by width */
|
|
182
181
|
width?: number | null;
|
|
183
182
|
}
|
|
184
|
-
|
|
183
|
+
declare enum Origin {
|
|
185
184
|
UNKNOWN = "UNKNOWN",
|
|
186
185
|
/** Changed by admin */
|
|
187
186
|
ADMIN = "ADMIN",
|
|
@@ -255,8 +254,8 @@ export declare enum Origin {
|
|
|
255
254
|
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
|
256
255
|
}
|
|
257
256
|
/** @enumType */
|
|
258
|
-
|
|
259
|
-
|
|
257
|
+
type OriginWithLiterals = Origin | 'UNKNOWN' | 'ADMIN' | 'ADD_CATEGORIES' | 'AUTO_SAVE' | 'COPY_TEMPLATE' | 'IMPORT' | 'IMPORT_BULK' | 'IMPORT_HTML' | 'IMPORT_PATCH' | 'LANGUAGE_CHANGE' | 'MANUAL_SAVE' | 'MIGRATION' | 'MODERATION' | 'MOVE_TO_TRASH' | 'PRICING_PLANS_CHANGE' | 'PROVISION' | 'PUBLISH' | 'REASSIGN_OWNER' | 'REBLOG' | 'RESTORE' | 'REVERT_TO_DRAFT' | 'TRANSLATION' | 'UNPUBLISH' | 'UNSCHEDULE' | 'NEW_EDIT_SESSION' | 'SCHEDULING_SERVICE_SCHEDULE' | 'SCHEDULING_SERVICE_UNSCHEDULE' | 'SCHEDULING_SERVICE_PUBLISH' | 'SCHEDULE' | 'REMOVE_FROM_MODERATION' | 'REJECT_FROM_MODERATION' | 'APPROVE_IN_MODERATION' | 'DELETE_TAG' | 'PIN' | 'UNPIN' | 'AI_AUTO_SAVE';
|
|
258
|
+
interface RichContent {
|
|
260
259
|
/** Node objects representing a rich content document. */
|
|
261
260
|
nodes?: Node[];
|
|
262
261
|
/** Object metadata. */
|
|
@@ -264,7 +263,7 @@ export interface RichContent {
|
|
|
264
263
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
265
264
|
documentStyle?: DocumentStyle;
|
|
266
265
|
}
|
|
267
|
-
|
|
266
|
+
interface Node extends NodeDataOneOf {
|
|
268
267
|
/** Data for a button node. */
|
|
269
268
|
buttonData?: ButtonData;
|
|
270
269
|
/** Data for a code block node. */
|
|
@@ -329,7 +328,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
329
328
|
style?: NodeStyle;
|
|
330
329
|
}
|
|
331
330
|
/** @oneof */
|
|
332
|
-
|
|
331
|
+
interface NodeDataOneOf {
|
|
333
332
|
/** Data for a button node. */
|
|
334
333
|
buttonData?: ButtonData;
|
|
335
334
|
/** Data for a code block node. */
|
|
@@ -385,7 +384,7 @@ export interface NodeDataOneOf {
|
|
|
385
384
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
386
385
|
layoutCellData?: LayoutCellData;
|
|
387
386
|
}
|
|
388
|
-
|
|
387
|
+
declare enum NodeType {
|
|
389
388
|
PARAGRAPH = "PARAGRAPH",
|
|
390
389
|
TEXT = "TEXT",
|
|
391
390
|
HEADING = "HEADING",
|
|
@@ -422,8 +421,8 @@ export declare enum NodeType {
|
|
|
422
421
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
423
422
|
}
|
|
424
423
|
/** @enumType */
|
|
425
|
-
|
|
426
|
-
|
|
424
|
+
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';
|
|
425
|
+
interface NodeStyle {
|
|
427
426
|
/** The top padding value in pixels. */
|
|
428
427
|
paddingTop?: string | null;
|
|
429
428
|
/** The bottom padding value in pixels. */
|
|
@@ -431,7 +430,7 @@ export interface NodeStyle {
|
|
|
431
430
|
/** The background color as a hexadecimal value. */
|
|
432
431
|
backgroundColor?: string | null;
|
|
433
432
|
}
|
|
434
|
-
|
|
433
|
+
interface ButtonData {
|
|
435
434
|
/** Styling for the button's container. */
|
|
436
435
|
containerData?: PluginContainerData;
|
|
437
436
|
/** The button type. */
|
|
@@ -443,7 +442,7 @@ export interface ButtonData {
|
|
|
443
442
|
/** Button link details. */
|
|
444
443
|
link?: Link;
|
|
445
444
|
}
|
|
446
|
-
|
|
445
|
+
interface Border {
|
|
447
446
|
/**
|
|
448
447
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
449
448
|
* @deprecated
|
|
@@ -455,7 +454,7 @@ export interface Border {
|
|
|
455
454
|
*/
|
|
456
455
|
radius?: number | null;
|
|
457
456
|
}
|
|
458
|
-
|
|
457
|
+
interface Colors {
|
|
459
458
|
/**
|
|
460
459
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
461
460
|
* @deprecated
|
|
@@ -472,7 +471,7 @@ export interface Colors {
|
|
|
472
471
|
*/
|
|
473
472
|
background?: string | null;
|
|
474
473
|
}
|
|
475
|
-
|
|
474
|
+
interface PluginContainerData {
|
|
476
475
|
/** The width of the node when it's displayed. */
|
|
477
476
|
width?: PluginContainerDataWidth;
|
|
478
477
|
/** The node's alignment within its container. */
|
|
@@ -484,7 +483,7 @@ export interface PluginContainerData {
|
|
|
484
483
|
/** 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`. */
|
|
485
484
|
textWrap?: boolean | null;
|
|
486
485
|
}
|
|
487
|
-
|
|
486
|
+
declare enum WidthType {
|
|
488
487
|
/** Width matches the content width */
|
|
489
488
|
CONTENT = "CONTENT",
|
|
490
489
|
/** Small Width */
|
|
@@ -495,8 +494,8 @@ export declare enum WidthType {
|
|
|
495
494
|
FULL_WIDTH = "FULL_WIDTH"
|
|
496
495
|
}
|
|
497
496
|
/** @enumType */
|
|
498
|
-
|
|
499
|
-
|
|
497
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
498
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
500
499
|
/**
|
|
501
500
|
* One of the following predefined width options:
|
|
502
501
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -509,7 +508,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
509
508
|
custom?: string | null;
|
|
510
509
|
}
|
|
511
510
|
/** @oneof */
|
|
512
|
-
|
|
511
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
513
512
|
/**
|
|
514
513
|
* One of the following predefined width options:
|
|
515
514
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -521,7 +520,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
521
520
|
/** A custom width value in pixels. */
|
|
522
521
|
custom?: string | null;
|
|
523
522
|
}
|
|
524
|
-
|
|
523
|
+
declare enum PluginContainerDataAlignment {
|
|
525
524
|
/** Center Alignment */
|
|
526
525
|
CENTER = "CENTER",
|
|
527
526
|
/** Left Alignment */
|
|
@@ -530,8 +529,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
530
529
|
RIGHT = "RIGHT"
|
|
531
530
|
}
|
|
532
531
|
/** @enumType */
|
|
533
|
-
|
|
534
|
-
|
|
532
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
533
|
+
interface Spoiler {
|
|
535
534
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
536
535
|
enabled?: boolean | null;
|
|
537
536
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -539,19 +538,19 @@ export interface Spoiler {
|
|
|
539
538
|
/** The text for the button used to remove the spoiler cover. */
|
|
540
539
|
buttonText?: string | null;
|
|
541
540
|
}
|
|
542
|
-
|
|
541
|
+
interface Height {
|
|
543
542
|
/** A custom height value in pixels. */
|
|
544
543
|
custom?: string | null;
|
|
545
544
|
}
|
|
546
|
-
|
|
545
|
+
declare enum ButtonDataType {
|
|
547
546
|
/** Regular link button */
|
|
548
547
|
LINK = "LINK",
|
|
549
548
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
550
549
|
ACTION = "ACTION"
|
|
551
550
|
}
|
|
552
551
|
/** @enumType */
|
|
553
|
-
|
|
554
|
-
|
|
552
|
+
type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
553
|
+
interface Styles {
|
|
555
554
|
/**
|
|
556
555
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
557
556
|
* @deprecated
|
|
@@ -604,7 +603,7 @@ export interface Styles {
|
|
|
604
603
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
605
604
|
buttonSize?: string | null;
|
|
606
605
|
}
|
|
607
|
-
|
|
606
|
+
interface Link extends LinkDataOneOf {
|
|
608
607
|
/** The absolute URL for the linked document. */
|
|
609
608
|
url?: string;
|
|
610
609
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -623,13 +622,13 @@ export interface Link extends LinkDataOneOf {
|
|
|
623
622
|
customData?: string | null;
|
|
624
623
|
}
|
|
625
624
|
/** @oneof */
|
|
626
|
-
|
|
625
|
+
interface LinkDataOneOf {
|
|
627
626
|
/** The absolute URL for the linked document. */
|
|
628
627
|
url?: string;
|
|
629
628
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
630
629
|
anchor?: string;
|
|
631
630
|
}
|
|
632
|
-
|
|
631
|
+
declare enum Target {
|
|
633
632
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
634
633
|
SELF = "SELF",
|
|
635
634
|
/** Opens the linked document in a new window or tab */
|
|
@@ -640,8 +639,8 @@ export declare enum Target {
|
|
|
640
639
|
TOP = "TOP"
|
|
641
640
|
}
|
|
642
641
|
/** @enumType */
|
|
643
|
-
|
|
644
|
-
|
|
642
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
643
|
+
interface Rel {
|
|
645
644
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
646
645
|
nofollow?: boolean | null;
|
|
647
646
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -651,17 +650,17 @@ export interface Rel {
|
|
|
651
650
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
652
651
|
noreferrer?: boolean | null;
|
|
653
652
|
}
|
|
654
|
-
|
|
653
|
+
interface CodeBlockData {
|
|
655
654
|
/** Styling for the code block's text. */
|
|
656
655
|
textStyle?: TextStyle;
|
|
657
656
|
}
|
|
658
|
-
|
|
657
|
+
interface TextStyle {
|
|
659
658
|
/** Text alignment. Defaults to `AUTO`. */
|
|
660
659
|
textAlignment?: TextAlignmentWithLiterals;
|
|
661
660
|
/** 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. */
|
|
662
661
|
lineHeight?: string | null;
|
|
663
662
|
}
|
|
664
|
-
|
|
663
|
+
declare enum TextAlignment {
|
|
665
664
|
/** browser default, eqivalent to `initial` */
|
|
666
665
|
AUTO = "AUTO",
|
|
667
666
|
/** Left align */
|
|
@@ -674,8 +673,8 @@ export declare enum TextAlignment {
|
|
|
674
673
|
JUSTIFY = "JUSTIFY"
|
|
675
674
|
}
|
|
676
675
|
/** @enumType */
|
|
677
|
-
|
|
678
|
-
|
|
676
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
677
|
+
interface DividerData {
|
|
679
678
|
/** Styling for the divider's container. */
|
|
680
679
|
containerData?: PluginContainerData;
|
|
681
680
|
/** Divider line style. */
|
|
@@ -685,7 +684,7 @@ export interface DividerData {
|
|
|
685
684
|
/** Divider alignment. */
|
|
686
685
|
alignment?: AlignmentWithLiterals;
|
|
687
686
|
}
|
|
688
|
-
|
|
687
|
+
declare enum LineStyle {
|
|
689
688
|
/** Single Line */
|
|
690
689
|
SINGLE = "SINGLE",
|
|
691
690
|
/** Double Line */
|
|
@@ -696,8 +695,8 @@ export declare enum LineStyle {
|
|
|
696
695
|
DOTTED = "DOTTED"
|
|
697
696
|
}
|
|
698
697
|
/** @enumType */
|
|
699
|
-
|
|
700
|
-
|
|
698
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
699
|
+
declare enum Width {
|
|
701
700
|
/** Large line */
|
|
702
701
|
LARGE = "LARGE",
|
|
703
702
|
/** Medium line */
|
|
@@ -706,8 +705,8 @@ export declare enum Width {
|
|
|
706
705
|
SMALL = "SMALL"
|
|
707
706
|
}
|
|
708
707
|
/** @enumType */
|
|
709
|
-
|
|
710
|
-
|
|
708
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
709
|
+
declare enum Alignment {
|
|
711
710
|
/** Center alignment */
|
|
712
711
|
CENTER = "CENTER",
|
|
713
712
|
/** Left alignment */
|
|
@@ -716,8 +715,8 @@ export declare enum Alignment {
|
|
|
716
715
|
RIGHT = "RIGHT"
|
|
717
716
|
}
|
|
718
717
|
/** @enumType */
|
|
719
|
-
|
|
720
|
-
|
|
718
|
+
type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
719
|
+
interface FileData {
|
|
721
720
|
/** Styling for the file's container. */
|
|
722
721
|
containerData?: PluginContainerData;
|
|
723
722
|
/** The source for the file's data. */
|
|
@@ -740,7 +739,7 @@ export interface FileData {
|
|
|
740
739
|
/** File size in KB. */
|
|
741
740
|
sizeInKb?: string | null;
|
|
742
741
|
}
|
|
743
|
-
|
|
742
|
+
declare enum ViewMode {
|
|
744
743
|
/** No PDF view */
|
|
745
744
|
NONE = "NONE",
|
|
746
745
|
/** Full PDF view */
|
|
@@ -749,8 +748,8 @@ export declare enum ViewMode {
|
|
|
749
748
|
MINI = "MINI"
|
|
750
749
|
}
|
|
751
750
|
/** @enumType */
|
|
752
|
-
|
|
753
|
-
|
|
751
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
752
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
754
753
|
/** The absolute URL for the file's source. */
|
|
755
754
|
url?: string | null;
|
|
756
755
|
/**
|
|
@@ -764,7 +763,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
764
763
|
private?: boolean | null;
|
|
765
764
|
}
|
|
766
765
|
/** @oneof */
|
|
767
|
-
|
|
766
|
+
interface FileSourceDataOneOf {
|
|
768
767
|
/** The absolute URL for the file's source. */
|
|
769
768
|
url?: string | null;
|
|
770
769
|
/**
|
|
@@ -775,7 +774,7 @@ export interface FileSourceDataOneOf {
|
|
|
775
774
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
776
775
|
id?: string | null;
|
|
777
776
|
}
|
|
778
|
-
|
|
777
|
+
interface PDFSettings {
|
|
779
778
|
/**
|
|
780
779
|
* PDF view mode. One of the following:
|
|
781
780
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -788,7 +787,7 @@ export interface PDFSettings {
|
|
|
788
787
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
789
788
|
disablePrint?: boolean | null;
|
|
790
789
|
}
|
|
791
|
-
|
|
790
|
+
interface GalleryData {
|
|
792
791
|
/** Styling for the gallery's container. */
|
|
793
792
|
containerData?: PluginContainerData;
|
|
794
793
|
/** The items in the gallery. */
|
|
@@ -800,7 +799,7 @@ export interface GalleryData {
|
|
|
800
799
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
801
800
|
disableDownload?: boolean | null;
|
|
802
801
|
}
|
|
803
|
-
|
|
802
|
+
interface V1Media {
|
|
804
803
|
/** The source for the media's data. */
|
|
805
804
|
src?: FileSource;
|
|
806
805
|
/** Media width in pixels. */
|
|
@@ -810,19 +809,19 @@ export interface V1Media {
|
|
|
810
809
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
811
810
|
duration?: number | null;
|
|
812
811
|
}
|
|
813
|
-
|
|
812
|
+
interface Image {
|
|
814
813
|
/** Image file details. */
|
|
815
814
|
media?: V1Media;
|
|
816
815
|
/** Link details for images that are links. */
|
|
817
816
|
link?: Link;
|
|
818
817
|
}
|
|
819
|
-
|
|
818
|
+
interface Video {
|
|
820
819
|
/** Video file details. */
|
|
821
820
|
media?: V1Media;
|
|
822
821
|
/** Video thumbnail file details. */
|
|
823
822
|
thumbnail?: V1Media;
|
|
824
823
|
}
|
|
825
|
-
|
|
824
|
+
interface Item extends ItemDataOneOf {
|
|
826
825
|
/** An image item. */
|
|
827
826
|
image?: Image;
|
|
828
827
|
/** A video item. */
|
|
@@ -833,13 +832,13 @@ export interface Item extends ItemDataOneOf {
|
|
|
833
832
|
altText?: string | null;
|
|
834
833
|
}
|
|
835
834
|
/** @oneof */
|
|
836
|
-
|
|
835
|
+
interface ItemDataOneOf {
|
|
837
836
|
/** An image item. */
|
|
838
837
|
image?: Image;
|
|
839
838
|
/** A video item. */
|
|
840
839
|
video?: Video;
|
|
841
840
|
}
|
|
842
|
-
|
|
841
|
+
interface GalleryOptions {
|
|
843
842
|
/** Gallery layout. */
|
|
844
843
|
layout?: Layout;
|
|
845
844
|
/** Styling for gallery items. */
|
|
@@ -847,7 +846,7 @@ export interface GalleryOptions {
|
|
|
847
846
|
/** Styling for gallery thumbnail images. */
|
|
848
847
|
thumbnails?: Thumbnails;
|
|
849
848
|
}
|
|
850
|
-
|
|
849
|
+
declare enum LayoutType {
|
|
851
850
|
/** Collage type */
|
|
852
851
|
COLLAGE = "COLLAGE",
|
|
853
852
|
/** Masonry type */
|
|
@@ -870,24 +869,24 @@ export declare enum LayoutType {
|
|
|
870
869
|
FULLSIZE = "FULLSIZE"
|
|
871
870
|
}
|
|
872
871
|
/** @enumType */
|
|
873
|
-
|
|
874
|
-
|
|
872
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
873
|
+
declare enum Orientation {
|
|
875
874
|
/** Rows Orientation */
|
|
876
875
|
ROWS = "ROWS",
|
|
877
876
|
/** Columns Orientation */
|
|
878
877
|
COLUMNS = "COLUMNS"
|
|
879
878
|
}
|
|
880
879
|
/** @enumType */
|
|
881
|
-
|
|
882
|
-
|
|
880
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
881
|
+
declare enum Crop {
|
|
883
882
|
/** Crop to fill */
|
|
884
883
|
FILL = "FILL",
|
|
885
884
|
/** Crop to fit */
|
|
886
885
|
FIT = "FIT"
|
|
887
886
|
}
|
|
888
887
|
/** @enumType */
|
|
889
|
-
|
|
890
|
-
|
|
888
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
889
|
+
declare enum ThumbnailsAlignment {
|
|
891
890
|
/** Top alignment */
|
|
892
891
|
TOP = "TOP",
|
|
893
892
|
/** Right alignment */
|
|
@@ -900,8 +899,8 @@ export declare enum ThumbnailsAlignment {
|
|
|
900
899
|
NONE = "NONE"
|
|
901
900
|
}
|
|
902
901
|
/** @enumType */
|
|
903
|
-
|
|
904
|
-
|
|
902
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
903
|
+
interface Layout {
|
|
905
904
|
/** Gallery layout type. */
|
|
906
905
|
type?: LayoutTypeWithLiterals;
|
|
907
906
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -913,7 +912,7 @@ export interface Layout {
|
|
|
913
912
|
/** The number of columns to display on mobile screens. */
|
|
914
913
|
mobileNumberOfColumns?: number | null;
|
|
915
914
|
}
|
|
916
|
-
|
|
915
|
+
interface ItemStyle {
|
|
917
916
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
918
917
|
targetSize?: number | null;
|
|
919
918
|
/** Item ratio */
|
|
@@ -923,13 +922,13 @@ export interface ItemStyle {
|
|
|
923
922
|
/** The spacing between items in pixels. */
|
|
924
923
|
spacing?: number | null;
|
|
925
924
|
}
|
|
926
|
-
|
|
925
|
+
interface Thumbnails {
|
|
927
926
|
/** Thumbnail alignment. */
|
|
928
927
|
placement?: ThumbnailsAlignmentWithLiterals;
|
|
929
928
|
/** Spacing between thumbnails in pixels. */
|
|
930
929
|
spacing?: number | null;
|
|
931
930
|
}
|
|
932
|
-
|
|
931
|
+
interface GIFData {
|
|
933
932
|
/** Styling for the GIF's container. */
|
|
934
933
|
containerData?: PluginContainerData;
|
|
935
934
|
/** The source of the full size GIF. */
|
|
@@ -943,7 +942,7 @@ export interface GIFData {
|
|
|
943
942
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
944
943
|
gifType?: GIFTypeWithLiterals;
|
|
945
944
|
}
|
|
946
|
-
|
|
945
|
+
interface GIF {
|
|
947
946
|
/**
|
|
948
947
|
* GIF format URL.
|
|
949
948
|
* @format WEB_URL
|
|
@@ -960,13 +959,13 @@ export interface GIF {
|
|
|
960
959
|
*/
|
|
961
960
|
still?: string | null;
|
|
962
961
|
}
|
|
963
|
-
|
|
962
|
+
declare enum GIFType {
|
|
964
963
|
NORMAL = "NORMAL",
|
|
965
964
|
STICKER = "STICKER"
|
|
966
965
|
}
|
|
967
966
|
/** @enumType */
|
|
968
|
-
|
|
969
|
-
|
|
967
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
968
|
+
interface HeadingData {
|
|
970
969
|
/** Heading level from 1-6. */
|
|
971
970
|
level?: number;
|
|
972
971
|
/** Styling for the heading text. */
|
|
@@ -974,7 +973,7 @@ export interface HeadingData {
|
|
|
974
973
|
/** Indentation level from 1-4. */
|
|
975
974
|
indentation?: number | null;
|
|
976
975
|
}
|
|
977
|
-
|
|
976
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
978
977
|
/** The URL for the HTML code for the node. */
|
|
979
978
|
url?: string;
|
|
980
979
|
/** The HTML code for the node. */
|
|
@@ -992,7 +991,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
992
991
|
autoHeight?: boolean | null;
|
|
993
992
|
}
|
|
994
993
|
/** @oneof */
|
|
995
|
-
|
|
994
|
+
interface HTMLDataDataOneOf {
|
|
996
995
|
/** The URL for the HTML code for the node. */
|
|
997
996
|
url?: string;
|
|
998
997
|
/** The HTML code for the node. */
|
|
@@ -1003,13 +1002,13 @@ export interface HTMLDataDataOneOf {
|
|
|
1003
1002
|
*/
|
|
1004
1003
|
isAdsense?: boolean | null;
|
|
1005
1004
|
}
|
|
1006
|
-
|
|
1005
|
+
declare enum Source {
|
|
1007
1006
|
HTML = "HTML",
|
|
1008
1007
|
ADSENSE = "ADSENSE"
|
|
1009
1008
|
}
|
|
1010
1009
|
/** @enumType */
|
|
1011
|
-
|
|
1012
|
-
|
|
1010
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
1011
|
+
interface ImageData {
|
|
1013
1012
|
/** Styling for the image's container. */
|
|
1014
1013
|
containerData?: PluginContainerData;
|
|
1015
1014
|
/** Image file details. */
|
|
@@ -1032,7 +1031,7 @@ export interface ImageData {
|
|
|
1032
1031
|
/** Styling for the image. */
|
|
1033
1032
|
styles?: ImageDataStyles;
|
|
1034
1033
|
}
|
|
1035
|
-
|
|
1034
|
+
interface StylesBorder {
|
|
1036
1035
|
/** Border width in pixels. */
|
|
1037
1036
|
width?: number | null;
|
|
1038
1037
|
/**
|
|
@@ -1043,11 +1042,11 @@ export interface StylesBorder {
|
|
|
1043
1042
|
/** Border radius in pixels. */
|
|
1044
1043
|
radius?: number | null;
|
|
1045
1044
|
}
|
|
1046
|
-
|
|
1045
|
+
interface ImageDataStyles {
|
|
1047
1046
|
/** Border attributes. */
|
|
1048
1047
|
border?: StylesBorder;
|
|
1049
1048
|
}
|
|
1050
|
-
|
|
1049
|
+
interface LinkPreviewData {
|
|
1051
1050
|
/** Styling for the link preview's container. */
|
|
1052
1051
|
containerData?: PluginContainerData;
|
|
1053
1052
|
/** Link details. */
|
|
@@ -1063,7 +1062,7 @@ export interface LinkPreviewData {
|
|
|
1063
1062
|
/** Styling for the link preview. */
|
|
1064
1063
|
styles?: LinkPreviewDataStyles;
|
|
1065
1064
|
}
|
|
1066
|
-
|
|
1065
|
+
declare enum Position {
|
|
1067
1066
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
1068
1067
|
START = "START",
|
|
1069
1068
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -1074,8 +1073,8 @@ export declare enum Position {
|
|
|
1074
1073
|
HIDDEN = "HIDDEN"
|
|
1075
1074
|
}
|
|
1076
1075
|
/** @enumType */
|
|
1077
|
-
|
|
1078
|
-
|
|
1076
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
1077
|
+
interface LinkPreviewDataStyles {
|
|
1079
1078
|
/**
|
|
1080
1079
|
* Background color as a hexadecimal value.
|
|
1081
1080
|
* @format COLOR_HEX
|
|
@@ -1108,13 +1107,13 @@ export interface LinkPreviewDataStyles {
|
|
|
1108
1107
|
/** Position of thumbnail. Defaults to `START`. */
|
|
1109
1108
|
thumbnailPosition?: PositionWithLiterals;
|
|
1110
1109
|
}
|
|
1111
|
-
|
|
1110
|
+
interface MapData {
|
|
1112
1111
|
/** Styling for the map's container. */
|
|
1113
1112
|
containerData?: PluginContainerData;
|
|
1114
1113
|
/** Map settings. */
|
|
1115
1114
|
mapSettings?: MapSettings;
|
|
1116
1115
|
}
|
|
1117
|
-
|
|
1116
|
+
interface MapSettings {
|
|
1118
1117
|
/** The address to display on the map. */
|
|
1119
1118
|
address?: string | null;
|
|
1120
1119
|
/** Sets whether the map is draggable. */
|
|
@@ -1138,7 +1137,7 @@ export interface MapSettings {
|
|
|
1138
1137
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
1139
1138
|
mapType?: MapTypeWithLiterals;
|
|
1140
1139
|
}
|
|
1141
|
-
|
|
1140
|
+
declare enum MapType {
|
|
1142
1141
|
/** Roadmap map type */
|
|
1143
1142
|
ROADMAP = "ROADMAP",
|
|
1144
1143
|
/** Satellite map type */
|
|
@@ -1149,8 +1148,8 @@ export declare enum MapType {
|
|
|
1149
1148
|
TERRAIN = "TERRAIN"
|
|
1150
1149
|
}
|
|
1151
1150
|
/** @enumType */
|
|
1152
|
-
|
|
1153
|
-
|
|
1151
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
1152
|
+
interface ParagraphData {
|
|
1154
1153
|
/** Styling for the paragraph text. */
|
|
1155
1154
|
textStyle?: TextStyle;
|
|
1156
1155
|
/** Indentation level from 1-4. */
|
|
@@ -1158,7 +1157,7 @@ export interface ParagraphData {
|
|
|
1158
1157
|
/** Paragraph level */
|
|
1159
1158
|
level?: number | null;
|
|
1160
1159
|
}
|
|
1161
|
-
|
|
1160
|
+
interface PollData {
|
|
1162
1161
|
/** Styling for the poll's container. */
|
|
1163
1162
|
containerData?: PluginContainerData;
|
|
1164
1163
|
/** Poll data. */
|
|
@@ -1168,7 +1167,7 @@ export interface PollData {
|
|
|
1168
1167
|
/** Styling for the poll and voting options. */
|
|
1169
1168
|
design?: Design;
|
|
1170
1169
|
}
|
|
1171
|
-
|
|
1170
|
+
declare enum ViewRole {
|
|
1172
1171
|
/** Only Poll creator can view the results */
|
|
1173
1172
|
CREATOR = "CREATOR",
|
|
1174
1173
|
/** Anyone who voted can see the results */
|
|
@@ -1177,16 +1176,16 @@ export declare enum ViewRole {
|
|
|
1177
1176
|
EVERYONE = "EVERYONE"
|
|
1178
1177
|
}
|
|
1179
1178
|
/** @enumType */
|
|
1180
|
-
|
|
1181
|
-
|
|
1179
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
1180
|
+
declare enum VoteRole {
|
|
1182
1181
|
/** Logged in member */
|
|
1183
1182
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
1184
1183
|
/** Anyone */
|
|
1185
1184
|
ALL = "ALL"
|
|
1186
1185
|
}
|
|
1187
1186
|
/** @enumType */
|
|
1188
|
-
|
|
1189
|
-
|
|
1187
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
1188
|
+
interface Permissions {
|
|
1190
1189
|
/** Sets who can view the poll results. */
|
|
1191
1190
|
view?: ViewRoleWithLiterals;
|
|
1192
1191
|
/** Sets who can vote. */
|
|
@@ -1194,7 +1193,7 @@ export interface Permissions {
|
|
|
1194
1193
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1195
1194
|
allowMultipleVotes?: boolean | null;
|
|
1196
1195
|
}
|
|
1197
|
-
|
|
1196
|
+
interface Option {
|
|
1198
1197
|
/** Option ID. */
|
|
1199
1198
|
id?: string | null;
|
|
1200
1199
|
/** Option title. */
|
|
@@ -1202,7 +1201,7 @@ export interface Option {
|
|
|
1202
1201
|
/** The image displayed with the option. */
|
|
1203
1202
|
image?: V1Media;
|
|
1204
1203
|
}
|
|
1205
|
-
|
|
1204
|
+
interface PollSettings {
|
|
1206
1205
|
/** Permissions settings for voting. */
|
|
1207
1206
|
permissions?: Permissions;
|
|
1208
1207
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -1210,23 +1209,23 @@ export interface PollSettings {
|
|
|
1210
1209
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
1211
1210
|
showVotesCount?: boolean | null;
|
|
1212
1211
|
}
|
|
1213
|
-
|
|
1212
|
+
declare enum PollLayoutType {
|
|
1214
1213
|
/** List */
|
|
1215
1214
|
LIST = "LIST",
|
|
1216
1215
|
/** Grid */
|
|
1217
1216
|
GRID = "GRID"
|
|
1218
1217
|
}
|
|
1219
1218
|
/** @enumType */
|
|
1220
|
-
|
|
1221
|
-
|
|
1219
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
1220
|
+
declare enum PollLayoutDirection {
|
|
1222
1221
|
/** Left-to-right */
|
|
1223
1222
|
LTR = "LTR",
|
|
1224
1223
|
/** Right-to-left */
|
|
1225
1224
|
RTL = "RTL"
|
|
1226
1225
|
}
|
|
1227
1226
|
/** @enumType */
|
|
1228
|
-
|
|
1229
|
-
|
|
1227
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
1228
|
+
interface PollLayout {
|
|
1230
1229
|
/** The layout for displaying the voting options. */
|
|
1231
1230
|
type?: PollLayoutTypeWithLiterals;
|
|
1232
1231
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -1234,11 +1233,11 @@ export interface PollLayout {
|
|
|
1234
1233
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1235
1234
|
enableImage?: boolean | null;
|
|
1236
1235
|
}
|
|
1237
|
-
|
|
1236
|
+
interface OptionLayout {
|
|
1238
1237
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
1239
1238
|
enableImage?: boolean | null;
|
|
1240
1239
|
}
|
|
1241
|
-
|
|
1240
|
+
declare enum BackgroundType {
|
|
1242
1241
|
/** Color background type */
|
|
1243
1242
|
COLOR = "COLOR",
|
|
1244
1243
|
/** Image background type */
|
|
@@ -1247,8 +1246,8 @@ export declare enum BackgroundType {
|
|
|
1247
1246
|
GRADIENT = "GRADIENT"
|
|
1248
1247
|
}
|
|
1249
1248
|
/** @enumType */
|
|
1250
|
-
|
|
1251
|
-
|
|
1249
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
1250
|
+
interface Gradient {
|
|
1252
1251
|
/** The gradient angle in degrees. */
|
|
1253
1252
|
angle?: number | null;
|
|
1254
1253
|
/**
|
|
@@ -1262,7 +1261,7 @@ export interface Gradient {
|
|
|
1262
1261
|
*/
|
|
1263
1262
|
lastColor?: string | null;
|
|
1264
1263
|
}
|
|
1265
|
-
|
|
1264
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
1266
1265
|
/**
|
|
1267
1266
|
* The background color as a hexademical value.
|
|
1268
1267
|
* @format COLOR_HEX
|
|
@@ -1276,7 +1275,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1276
1275
|
type?: BackgroundTypeWithLiterals;
|
|
1277
1276
|
}
|
|
1278
1277
|
/** @oneof */
|
|
1279
|
-
|
|
1278
|
+
interface BackgroundBackgroundOneOf {
|
|
1280
1279
|
/**
|
|
1281
1280
|
* The background color as a hexademical value.
|
|
1282
1281
|
* @format COLOR_HEX
|
|
@@ -1287,17 +1286,17 @@ export interface BackgroundBackgroundOneOf {
|
|
|
1287
1286
|
/** Details for a gradient background. */
|
|
1288
1287
|
gradient?: Gradient;
|
|
1289
1288
|
}
|
|
1290
|
-
|
|
1289
|
+
interface PollDesign {
|
|
1291
1290
|
/** Background styling. */
|
|
1292
1291
|
background?: Background;
|
|
1293
1292
|
/** Border radius in pixels. */
|
|
1294
1293
|
borderRadius?: number | null;
|
|
1295
1294
|
}
|
|
1296
|
-
|
|
1295
|
+
interface OptionDesign {
|
|
1297
1296
|
/** Border radius in pixels. */
|
|
1298
1297
|
borderRadius?: number | null;
|
|
1299
1298
|
}
|
|
1300
|
-
|
|
1299
|
+
interface Poll {
|
|
1301
1300
|
/** Poll ID. */
|
|
1302
1301
|
id?: string | null;
|
|
1303
1302
|
/** Poll title. */
|
|
@@ -1311,26 +1310,26 @@ export interface Poll {
|
|
|
1311
1310
|
/** The poll's permissions and display settings. */
|
|
1312
1311
|
settings?: PollSettings;
|
|
1313
1312
|
}
|
|
1314
|
-
|
|
1313
|
+
interface PollDataLayout {
|
|
1315
1314
|
/** Poll layout settings. */
|
|
1316
1315
|
poll?: PollLayout;
|
|
1317
1316
|
/** Voting otpions layout settings. */
|
|
1318
1317
|
options?: OptionLayout;
|
|
1319
1318
|
}
|
|
1320
|
-
|
|
1319
|
+
interface Design {
|
|
1321
1320
|
/** Styling for the poll. */
|
|
1322
1321
|
poll?: PollDesign;
|
|
1323
1322
|
/** Styling for voting options. */
|
|
1324
1323
|
options?: OptionDesign;
|
|
1325
1324
|
}
|
|
1326
|
-
|
|
1325
|
+
interface TextData {
|
|
1327
1326
|
/** The text to apply decorations to. */
|
|
1328
1327
|
text?: string;
|
|
1329
1328
|
/** The decorations to apply. */
|
|
1330
1329
|
decorations?: Decoration[];
|
|
1331
1330
|
}
|
|
1332
1331
|
/** Adds appearence changes to text */
|
|
1333
|
-
|
|
1332
|
+
interface Decoration extends DecorationDataOneOf {
|
|
1334
1333
|
/** Data for an anchor link decoration. */
|
|
1335
1334
|
anchorData?: AnchorData;
|
|
1336
1335
|
/** Data for a color decoration. */
|
|
@@ -1355,7 +1354,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
1355
1354
|
type?: DecorationTypeWithLiterals;
|
|
1356
1355
|
}
|
|
1357
1356
|
/** @oneof */
|
|
1358
|
-
|
|
1357
|
+
interface DecorationDataOneOf {
|
|
1359
1358
|
/** Data for an anchor link decoration. */
|
|
1360
1359
|
anchorData?: AnchorData;
|
|
1361
1360
|
/** Data for a color decoration. */
|
|
@@ -1377,7 +1376,7 @@ export interface DecorationDataOneOf {
|
|
|
1377
1376
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1378
1377
|
strikethroughData?: boolean | null;
|
|
1379
1378
|
}
|
|
1380
|
-
|
|
1379
|
+
declare enum DecorationType {
|
|
1381
1380
|
BOLD = "BOLD",
|
|
1382
1381
|
ITALIC = "ITALIC",
|
|
1383
1382
|
UNDERLINE = "UNDERLINE",
|
|
@@ -1391,22 +1390,22 @@ export declare enum DecorationType {
|
|
|
1391
1390
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1392
1391
|
}
|
|
1393
1392
|
/** @enumType */
|
|
1394
|
-
|
|
1395
|
-
|
|
1393
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
1394
|
+
interface AnchorData {
|
|
1396
1395
|
/** The target node's ID. */
|
|
1397
1396
|
anchor?: string;
|
|
1398
1397
|
}
|
|
1399
|
-
|
|
1398
|
+
interface ColorData {
|
|
1400
1399
|
/** The text's background color as a hexadecimal value. */
|
|
1401
1400
|
background?: string | null;
|
|
1402
1401
|
/** The text's foreground color as a hexadecimal value. */
|
|
1403
1402
|
foreground?: string | null;
|
|
1404
1403
|
}
|
|
1405
|
-
|
|
1404
|
+
interface LinkData {
|
|
1406
1405
|
/** Link details. */
|
|
1407
1406
|
link?: Link;
|
|
1408
1407
|
}
|
|
1409
|
-
|
|
1408
|
+
interface MentionData {
|
|
1410
1409
|
/** The mentioned user's name. */
|
|
1411
1410
|
name?: string;
|
|
1412
1411
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -1414,23 +1413,23 @@ export interface MentionData {
|
|
|
1414
1413
|
/** Mentioned user's ID. */
|
|
1415
1414
|
id?: string | null;
|
|
1416
1415
|
}
|
|
1417
|
-
|
|
1416
|
+
interface FontSizeData {
|
|
1418
1417
|
/** The units used for the font size. */
|
|
1419
1418
|
unit?: FontTypeWithLiterals;
|
|
1420
1419
|
/** Font size value. */
|
|
1421
1420
|
value?: number | null;
|
|
1422
1421
|
}
|
|
1423
|
-
|
|
1422
|
+
declare enum FontType {
|
|
1424
1423
|
PX = "PX",
|
|
1425
1424
|
EM = "EM"
|
|
1426
1425
|
}
|
|
1427
1426
|
/** @enumType */
|
|
1428
|
-
|
|
1429
|
-
|
|
1427
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
1428
|
+
interface SpoilerData {
|
|
1430
1429
|
/** Spoiler ID. */
|
|
1431
1430
|
id?: string | null;
|
|
1432
1431
|
}
|
|
1433
|
-
|
|
1432
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1434
1433
|
/** Data for embedded Wix Bookings content. */
|
|
1435
1434
|
bookingData?: BookingData;
|
|
1436
1435
|
/** Data for embedded Wix Events content. */
|
|
@@ -1452,30 +1451,30 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1452
1451
|
image?: V1Media;
|
|
1453
1452
|
}
|
|
1454
1453
|
/** @oneof */
|
|
1455
|
-
|
|
1454
|
+
interface AppEmbedDataAppDataOneOf {
|
|
1456
1455
|
/** Data for embedded Wix Bookings content. */
|
|
1457
1456
|
bookingData?: BookingData;
|
|
1458
1457
|
/** Data for embedded Wix Events content. */
|
|
1459
1458
|
eventData?: EventData;
|
|
1460
1459
|
}
|
|
1461
|
-
|
|
1460
|
+
declare enum AppType {
|
|
1462
1461
|
PRODUCT = "PRODUCT",
|
|
1463
1462
|
EVENT = "EVENT",
|
|
1464
1463
|
BOOKING = "BOOKING"
|
|
1465
1464
|
}
|
|
1466
1465
|
/** @enumType */
|
|
1467
|
-
|
|
1468
|
-
|
|
1466
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
1467
|
+
interface BookingData {
|
|
1469
1468
|
/** Booking duration in minutes. */
|
|
1470
1469
|
durations?: string | null;
|
|
1471
1470
|
}
|
|
1472
|
-
|
|
1471
|
+
interface EventData {
|
|
1473
1472
|
/** Event schedule. */
|
|
1474
1473
|
scheduling?: string | null;
|
|
1475
1474
|
/** Event location. */
|
|
1476
1475
|
location?: string | null;
|
|
1477
1476
|
}
|
|
1478
|
-
|
|
1477
|
+
interface VideoData {
|
|
1479
1478
|
/** Styling for the video's container. */
|
|
1480
1479
|
containerData?: PluginContainerData;
|
|
1481
1480
|
/** Video details. */
|
|
@@ -1489,7 +1488,7 @@ export interface VideoData {
|
|
|
1489
1488
|
/** Video options. */
|
|
1490
1489
|
options?: PlaybackOptions;
|
|
1491
1490
|
}
|
|
1492
|
-
|
|
1491
|
+
interface PlaybackOptions {
|
|
1493
1492
|
/** Sets whether the media will automatically start playing. */
|
|
1494
1493
|
autoPlay?: boolean | null;
|
|
1495
1494
|
/** Sets whether media's will be looped. */
|
|
@@ -1497,7 +1496,7 @@ export interface PlaybackOptions {
|
|
|
1497
1496
|
/** Sets whether media's controls will be shown. */
|
|
1498
1497
|
showControls?: boolean | null;
|
|
1499
1498
|
}
|
|
1500
|
-
|
|
1499
|
+
interface EmbedData {
|
|
1501
1500
|
/** Styling for the oEmbed node's container. */
|
|
1502
1501
|
containerData?: PluginContainerData;
|
|
1503
1502
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -1505,7 +1504,7 @@ export interface EmbedData {
|
|
|
1505
1504
|
/** Origin asset source. */
|
|
1506
1505
|
src?: string | null;
|
|
1507
1506
|
}
|
|
1508
|
-
|
|
1507
|
+
interface Oembed {
|
|
1509
1508
|
/** The resource type. */
|
|
1510
1509
|
type?: string | null;
|
|
1511
1510
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -1537,7 +1536,7 @@ export interface Oembed {
|
|
|
1537
1536
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
1538
1537
|
version?: string | null;
|
|
1539
1538
|
}
|
|
1540
|
-
|
|
1539
|
+
interface CollapsibleListData {
|
|
1541
1540
|
/** Styling for the collapsible list's container. */
|
|
1542
1541
|
containerData?: PluginContainerData;
|
|
1543
1542
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -1549,7 +1548,7 @@ export interface CollapsibleListData {
|
|
|
1549
1548
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1550
1549
|
isQapageData?: boolean | null;
|
|
1551
1550
|
}
|
|
1552
|
-
|
|
1551
|
+
declare enum InitialExpandedItems {
|
|
1553
1552
|
/** First item will be expended initally */
|
|
1554
1553
|
FIRST = "FIRST",
|
|
1555
1554
|
/** All items will expended initally */
|
|
@@ -1558,16 +1557,16 @@ export declare enum InitialExpandedItems {
|
|
|
1558
1557
|
NONE = "NONE"
|
|
1559
1558
|
}
|
|
1560
1559
|
/** @enumType */
|
|
1561
|
-
|
|
1562
|
-
|
|
1560
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
1561
|
+
declare enum Direction {
|
|
1563
1562
|
/** Left-to-right */
|
|
1564
1563
|
LTR = "LTR",
|
|
1565
1564
|
/** Right-to-left */
|
|
1566
1565
|
RTL = "RTL"
|
|
1567
1566
|
}
|
|
1568
1567
|
/** @enumType */
|
|
1569
|
-
|
|
1570
|
-
|
|
1568
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
1569
|
+
interface TableData {
|
|
1571
1570
|
/** Styling for the table's container. */
|
|
1572
1571
|
containerData?: PluginContainerData;
|
|
1573
1572
|
/** The table's dimensions. */
|
|
@@ -1582,7 +1581,7 @@ export interface TableData {
|
|
|
1582
1581
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1583
1582
|
columnHeader?: boolean | null;
|
|
1584
1583
|
}
|
|
1585
|
-
|
|
1584
|
+
interface Dimensions {
|
|
1586
1585
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
1587
1586
|
colsWidthRatio?: number[];
|
|
1588
1587
|
/** An array representing the height of each row in pixels. */
|
|
@@ -1590,13 +1589,13 @@ export interface Dimensions {
|
|
|
1590
1589
|
/** An array representing the minimum width of each column in pixels. */
|
|
1591
1590
|
colsMinWidth?: number[];
|
|
1592
1591
|
}
|
|
1593
|
-
|
|
1592
|
+
interface TableCellData {
|
|
1594
1593
|
/** Styling for the cell's background color and text alignment. */
|
|
1595
1594
|
cellStyle?: CellStyle;
|
|
1596
1595
|
/** The cell's border colors. */
|
|
1597
1596
|
borderColors?: BorderColors;
|
|
1598
1597
|
}
|
|
1599
|
-
|
|
1598
|
+
declare enum VerticalAlignment {
|
|
1600
1599
|
/** Top alignment */
|
|
1601
1600
|
TOP = "TOP",
|
|
1602
1601
|
/** Middle alignment */
|
|
@@ -1605,8 +1604,8 @@ export declare enum VerticalAlignment {
|
|
|
1605
1604
|
BOTTOM = "BOTTOM"
|
|
1606
1605
|
}
|
|
1607
1606
|
/** @enumType */
|
|
1608
|
-
|
|
1609
|
-
|
|
1607
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
1608
|
+
interface CellStyle {
|
|
1610
1609
|
/** Vertical alignment for the cell's text. */
|
|
1611
1610
|
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
1612
1611
|
/**
|
|
@@ -1615,7 +1614,7 @@ export interface CellStyle {
|
|
|
1615
1614
|
*/
|
|
1616
1615
|
backgroundColor?: string | null;
|
|
1617
1616
|
}
|
|
1618
|
-
|
|
1617
|
+
interface BorderColors {
|
|
1619
1618
|
/**
|
|
1620
1619
|
* Left border color as a hexadecimal value.
|
|
1621
1620
|
* @format COLOR_HEX
|
|
@@ -1643,22 +1642,20 @@ export interface BorderColors {
|
|
|
1643
1642
|
*
|
|
1644
1643
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
1645
1644
|
*/
|
|
1646
|
-
|
|
1645
|
+
declare enum NullValue {
|
|
1647
1646
|
/** Null value. */
|
|
1648
1647
|
NULL_VALUE = "NULL_VALUE"
|
|
1649
1648
|
}
|
|
1650
|
-
/** @enumType */
|
|
1651
|
-
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
1652
1649
|
/**
|
|
1653
1650
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
1654
1651
|
*
|
|
1655
1652
|
* The JSON representation for `ListValue` is JSON array.
|
|
1656
1653
|
*/
|
|
1657
|
-
|
|
1654
|
+
interface ListValue {
|
|
1658
1655
|
/** Repeated field of dynamically typed values. */
|
|
1659
1656
|
values?: any[];
|
|
1660
1657
|
}
|
|
1661
|
-
|
|
1658
|
+
interface AudioData {
|
|
1662
1659
|
/** Styling for the audio node's container. */
|
|
1663
1660
|
containerData?: PluginContainerData;
|
|
1664
1661
|
/** Audio file details. */
|
|
@@ -1674,7 +1671,7 @@ export interface AudioData {
|
|
|
1674
1671
|
/** An HTML version of the audio node. */
|
|
1675
1672
|
html?: string | null;
|
|
1676
1673
|
}
|
|
1677
|
-
|
|
1674
|
+
interface OrderedListData {
|
|
1678
1675
|
/** Indentation level from 0-4. */
|
|
1679
1676
|
indentation?: number;
|
|
1680
1677
|
/** Offset level from 0-4. */
|
|
@@ -1682,24 +1679,24 @@ export interface OrderedListData {
|
|
|
1682
1679
|
/** List start number. */
|
|
1683
1680
|
start?: number | null;
|
|
1684
1681
|
}
|
|
1685
|
-
|
|
1682
|
+
interface BulletedListData {
|
|
1686
1683
|
/** Indentation level from 0-4. */
|
|
1687
1684
|
indentation?: number;
|
|
1688
1685
|
/** Offset level from 0-4. */
|
|
1689
1686
|
offset?: number | null;
|
|
1690
1687
|
}
|
|
1691
|
-
|
|
1688
|
+
interface BlockquoteData {
|
|
1692
1689
|
/** Indentation level from 1-4. */
|
|
1693
1690
|
indentation?: number;
|
|
1694
1691
|
}
|
|
1695
|
-
|
|
1692
|
+
interface CaptionData {
|
|
1696
1693
|
textStyle?: TextStyle;
|
|
1697
1694
|
}
|
|
1698
|
-
|
|
1695
|
+
interface LayoutCellData {
|
|
1699
1696
|
/** Size of the cell in 12 columns grid. */
|
|
1700
1697
|
colSpan?: number | null;
|
|
1701
1698
|
}
|
|
1702
|
-
|
|
1699
|
+
interface Metadata {
|
|
1703
1700
|
/** Schema version. */
|
|
1704
1701
|
version?: number;
|
|
1705
1702
|
/**
|
|
@@ -1716,7 +1713,7 @@ export interface Metadata {
|
|
|
1716
1713
|
/** Object ID. */
|
|
1717
1714
|
_id?: string | null;
|
|
1718
1715
|
}
|
|
1719
|
-
|
|
1716
|
+
interface DocumentStyle {
|
|
1720
1717
|
/** Styling for H1 nodes. */
|
|
1721
1718
|
headerOne?: TextNodeStyle;
|
|
1722
1719
|
/** Styling for H2 nodes. */
|
|
@@ -1736,7 +1733,7 @@ export interface DocumentStyle {
|
|
|
1736
1733
|
/** Styling for code block nodes. */
|
|
1737
1734
|
codeBlock?: TextNodeStyle;
|
|
1738
1735
|
}
|
|
1739
|
-
|
|
1736
|
+
interface TextNodeStyle {
|
|
1740
1737
|
/** The decorations to apply to the node. */
|
|
1741
1738
|
decorations?: Decoration[];
|
|
1742
1739
|
/** Padding and background color for the node. */
|
|
@@ -1744,7 +1741,7 @@ export interface TextNodeStyle {
|
|
|
1744
1741
|
/** Line height for text in the node. */
|
|
1745
1742
|
lineHeight?: string | null;
|
|
1746
1743
|
}
|
|
1747
|
-
|
|
1744
|
+
declare enum Status {
|
|
1748
1745
|
UNKNOWN = "UNKNOWN",
|
|
1749
1746
|
/** Status indicating the draft post is published. */
|
|
1750
1747
|
PUBLISHED = "PUBLISHED",
|
|
@@ -1758,8 +1755,8 @@ export declare enum Status {
|
|
|
1758
1755
|
IN_REVIEW = "IN_REVIEW"
|
|
1759
1756
|
}
|
|
1760
1757
|
/** @enumType */
|
|
1761
|
-
|
|
1762
|
-
|
|
1758
|
+
type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
|
|
1759
|
+
interface ModerationDetails {
|
|
1763
1760
|
/**
|
|
1764
1761
|
* Member ID of the person submitting the draft post for review.
|
|
1765
1762
|
* @format GUID
|
|
@@ -1777,25 +1774,25 @@ export interface ModerationDetails {
|
|
|
1777
1774
|
/** Date the post was approved or rejected. */
|
|
1778
1775
|
moderationDate?: Date | null;
|
|
1779
1776
|
}
|
|
1780
|
-
|
|
1777
|
+
declare enum ModerationStatusStatus {
|
|
1781
1778
|
UNKNOWN = "UNKNOWN",
|
|
1782
1779
|
APPROVED = "APPROVED",
|
|
1783
1780
|
REJECTED = "REJECTED"
|
|
1784
1781
|
}
|
|
1785
1782
|
/** @enumType */
|
|
1786
|
-
|
|
1783
|
+
type ModerationStatusStatusWithLiterals = ModerationStatusStatus | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
|
|
1787
1784
|
/**
|
|
1788
1785
|
* The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
|
|
1789
1786
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
1790
1787
|
* This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
|
|
1791
1788
|
*/
|
|
1792
|
-
|
|
1789
|
+
interface SeoSchema {
|
|
1793
1790
|
/** SEO tag information. */
|
|
1794
1791
|
tags?: Tag[];
|
|
1795
1792
|
/** SEO general settings. */
|
|
1796
1793
|
settings?: Settings;
|
|
1797
1794
|
}
|
|
1798
|
-
|
|
1795
|
+
interface Keyword {
|
|
1799
1796
|
/** Keyword value. */
|
|
1800
1797
|
term?: string;
|
|
1801
1798
|
/** Whether the keyword is the main focus keyword. */
|
|
@@ -1806,7 +1803,7 @@ export interface Keyword {
|
|
|
1806
1803
|
*/
|
|
1807
1804
|
origin?: string | null;
|
|
1808
1805
|
}
|
|
1809
|
-
|
|
1806
|
+
interface Tag {
|
|
1810
1807
|
/**
|
|
1811
1808
|
* SEO tag type.
|
|
1812
1809
|
*
|
|
@@ -1828,7 +1825,7 @@ export interface Tag {
|
|
|
1828
1825
|
/** Whether the tag is disabled. */
|
|
1829
1826
|
disabled?: boolean;
|
|
1830
1827
|
}
|
|
1831
|
-
|
|
1828
|
+
interface Settings {
|
|
1832
1829
|
/**
|
|
1833
1830
|
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
1834
1831
|
*
|
|
@@ -1842,7 +1839,7 @@ export interface Settings {
|
|
|
1842
1839
|
*/
|
|
1843
1840
|
keywords?: Keyword[];
|
|
1844
1841
|
}
|
|
1845
|
-
|
|
1842
|
+
interface Media extends MediaMediaOneOf {
|
|
1846
1843
|
/** Wix Media details. */
|
|
1847
1844
|
wixMedia?: WixMedia;
|
|
1848
1845
|
/** Embed media details. */
|
|
@@ -1859,19 +1856,19 @@ export interface Media extends MediaMediaOneOf {
|
|
|
1859
1856
|
altText?: string | null;
|
|
1860
1857
|
}
|
|
1861
1858
|
/** @oneof */
|
|
1862
|
-
|
|
1859
|
+
interface MediaMediaOneOf {
|
|
1863
1860
|
/** Wix Media details. */
|
|
1864
1861
|
wixMedia?: WixMedia;
|
|
1865
1862
|
/** Embed media details. */
|
|
1866
1863
|
embedMedia?: EmbedMedia;
|
|
1867
1864
|
}
|
|
1868
|
-
|
|
1865
|
+
interface WixMedia {
|
|
1869
1866
|
/** Image details. */
|
|
1870
1867
|
image?: string;
|
|
1871
1868
|
/** Video details. */
|
|
1872
1869
|
videoV2?: string;
|
|
1873
1870
|
}
|
|
1874
|
-
|
|
1871
|
+
interface VideoResolution {
|
|
1875
1872
|
/** Video URL. */
|
|
1876
1873
|
url?: string;
|
|
1877
1874
|
/** Video height. */
|
|
@@ -1881,13 +1878,13 @@ export interface VideoResolution {
|
|
|
1881
1878
|
/** Video format for example, mp4, hls. */
|
|
1882
1879
|
format?: string;
|
|
1883
1880
|
}
|
|
1884
|
-
|
|
1881
|
+
interface EmbedMedia {
|
|
1885
1882
|
/** Thumbnail details. */
|
|
1886
1883
|
thumbnail?: EmbedThumbnail;
|
|
1887
1884
|
/** Video details. */
|
|
1888
1885
|
video?: EmbedVideo;
|
|
1889
1886
|
}
|
|
1890
|
-
|
|
1887
|
+
interface EmbedThumbnail {
|
|
1891
1888
|
/**
|
|
1892
1889
|
* Thumbnail url.
|
|
1893
1890
|
* @maxLength 2000
|
|
@@ -1898,7 +1895,7 @@ export interface EmbedThumbnail {
|
|
|
1898
1895
|
/** Thumbnail height. */
|
|
1899
1896
|
height?: number;
|
|
1900
1897
|
}
|
|
1901
|
-
|
|
1898
|
+
interface EmbedVideo {
|
|
1902
1899
|
/**
|
|
1903
1900
|
* Video url.
|
|
1904
1901
|
* @maxLength 2000
|
|
@@ -1909,7 +1906,7 @@ export interface EmbedVideo {
|
|
|
1909
1906
|
/** Video height. */
|
|
1910
1907
|
height?: number;
|
|
1911
1908
|
}
|
|
1912
|
-
|
|
1909
|
+
interface DraftPostTranslation {
|
|
1913
1910
|
/**
|
|
1914
1911
|
* Post ID.
|
|
1915
1912
|
* @format GUID
|
|
@@ -1932,7 +1929,7 @@ export interface DraftPostTranslation {
|
|
|
1932
1929
|
/** Post URL. */
|
|
1933
1930
|
url?: string;
|
|
1934
1931
|
}
|
|
1935
|
-
|
|
1932
|
+
interface DraftCategoriesUpdated {
|
|
1936
1933
|
/**
|
|
1937
1934
|
* Draft post ID.
|
|
1938
1935
|
* @maxLength 38
|
|
@@ -1951,7 +1948,7 @@ export interface DraftCategoriesUpdated {
|
|
|
1951
1948
|
*/
|
|
1952
1949
|
previousCategories?: string[];
|
|
1953
1950
|
}
|
|
1954
|
-
|
|
1951
|
+
interface DraftTagsUpdated {
|
|
1955
1952
|
/**
|
|
1956
1953
|
* Draft post ID.
|
|
1957
1954
|
* @maxLength 38
|
|
@@ -1970,7 +1967,7 @@ export interface DraftTagsUpdated {
|
|
|
1970
1967
|
*/
|
|
1971
1968
|
previousTags?: string[];
|
|
1972
1969
|
}
|
|
1973
|
-
|
|
1970
|
+
interface GetDraftPostTotalsRequest {
|
|
1974
1971
|
/**
|
|
1975
1972
|
* Group results by fields (defaults to grouping by status).
|
|
1976
1973
|
* If, for example, grouping by language is passed, language values in response will be filled.
|
|
@@ -1984,19 +1981,19 @@ export interface GetDraftPostTotalsRequest {
|
|
|
1984
1981
|
*/
|
|
1985
1982
|
language?: string | null;
|
|
1986
1983
|
}
|
|
1987
|
-
|
|
1984
|
+
declare enum TotalDraftPostsGroupingField {
|
|
1988
1985
|
/** Groups results by status. */
|
|
1989
1986
|
STATUS = "STATUS",
|
|
1990
1987
|
/** Groups results by language. */
|
|
1991
1988
|
LANGUAGE = "LANGUAGE"
|
|
1992
1989
|
}
|
|
1993
1990
|
/** @enumType */
|
|
1994
|
-
|
|
1995
|
-
|
|
1991
|
+
type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
|
|
1992
|
+
interface GetDraftPostTotalsResponse {
|
|
1996
1993
|
/** Draft post totals. */
|
|
1997
1994
|
totalDraftPosts?: TotalDraftPosts[];
|
|
1998
1995
|
}
|
|
1999
|
-
|
|
1996
|
+
interface TotalDraftPosts {
|
|
2000
1997
|
/** Draft post totals in that group. */
|
|
2001
1998
|
total?: number;
|
|
2002
1999
|
/** Draft post status (only has value when grouping by status, otherwise null). */
|
|
@@ -2007,7 +2004,7 @@ export interface TotalDraftPosts {
|
|
|
2007
2004
|
*/
|
|
2008
2005
|
language?: string | null;
|
|
2009
2006
|
}
|
|
2010
|
-
|
|
2007
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
2011
2008
|
createdEvent?: EntityCreatedEvent;
|
|
2012
2009
|
updatedEvent?: EntityUpdatedEvent;
|
|
2013
2010
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -2042,19 +2039,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2042
2039
|
entityEventSequence?: string | null;
|
|
2043
2040
|
}
|
|
2044
2041
|
/** @oneof */
|
|
2045
|
-
|
|
2042
|
+
interface DomainEventBodyOneOf {
|
|
2046
2043
|
createdEvent?: EntityCreatedEvent;
|
|
2047
2044
|
updatedEvent?: EntityUpdatedEvent;
|
|
2048
2045
|
deletedEvent?: EntityDeletedEvent;
|
|
2049
2046
|
actionEvent?: ActionEvent;
|
|
2050
2047
|
}
|
|
2051
|
-
|
|
2048
|
+
interface EntityCreatedEvent {
|
|
2052
2049
|
entity?: string;
|
|
2053
2050
|
}
|
|
2054
|
-
|
|
2051
|
+
interface RestoreInfo {
|
|
2055
2052
|
deletedDate?: Date | null;
|
|
2056
2053
|
}
|
|
2057
|
-
|
|
2054
|
+
interface EntityUpdatedEvent {
|
|
2058
2055
|
/**
|
|
2059
2056
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2060
2057
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -2062,14 +2059,14 @@ export interface EntityUpdatedEvent {
|
|
|
2062
2059
|
*/
|
|
2063
2060
|
currentEntity?: string;
|
|
2064
2061
|
}
|
|
2065
|
-
|
|
2062
|
+
interface EntityDeletedEvent {
|
|
2066
2063
|
/** Entity that was deleted. */
|
|
2067
2064
|
deletedEntity?: string | null;
|
|
2068
2065
|
}
|
|
2069
|
-
|
|
2066
|
+
interface ActionEvent {
|
|
2070
2067
|
body?: string;
|
|
2071
2068
|
}
|
|
2072
|
-
|
|
2069
|
+
interface MessageEnvelope {
|
|
2073
2070
|
/**
|
|
2074
2071
|
* App instance ID.
|
|
2075
2072
|
* @format GUID
|
|
@@ -2085,7 +2082,7 @@ export interface MessageEnvelope {
|
|
|
2085
2082
|
/** Stringify payload. */
|
|
2086
2083
|
data?: string;
|
|
2087
2084
|
}
|
|
2088
|
-
|
|
2085
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2089
2086
|
/**
|
|
2090
2087
|
* ID of a site visitor that has not logged in to the site.
|
|
2091
2088
|
* @format GUID
|
|
@@ -2110,7 +2107,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
2110
2107
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2111
2108
|
}
|
|
2112
2109
|
/** @oneof */
|
|
2113
|
-
|
|
2110
|
+
interface IdentificationDataIdOneOf {
|
|
2114
2111
|
/**
|
|
2115
2112
|
* ID of a site visitor that has not logged in to the site.
|
|
2116
2113
|
* @format GUID
|
|
@@ -2132,7 +2129,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
2132
2129
|
*/
|
|
2133
2130
|
appId?: string;
|
|
2134
2131
|
}
|
|
2135
|
-
|
|
2132
|
+
declare enum WebhookIdentityType {
|
|
2136
2133
|
UNKNOWN = "UNKNOWN",
|
|
2137
2134
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2138
2135
|
MEMBER = "MEMBER",
|
|
@@ -2140,12 +2137,12 @@ export declare enum WebhookIdentityType {
|
|
|
2140
2137
|
APP = "APP"
|
|
2141
2138
|
}
|
|
2142
2139
|
/** @enumType */
|
|
2143
|
-
|
|
2144
|
-
|
|
2140
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2141
|
+
interface InitialDraftPostsCopied {
|
|
2145
2142
|
/** Number of draft posts copied. */
|
|
2146
2143
|
count?: number;
|
|
2147
2144
|
}
|
|
2148
|
-
|
|
2145
|
+
interface CreateDraftPostRequest {
|
|
2149
2146
|
/** Draft post to create. */
|
|
2150
2147
|
draftPost: DraftPost;
|
|
2151
2148
|
/**
|
|
@@ -2162,7 +2159,7 @@ export interface CreateDraftPostRequest {
|
|
|
2162
2159
|
*/
|
|
2163
2160
|
fieldsets?: FieldWithLiterals[];
|
|
2164
2161
|
}
|
|
2165
|
-
|
|
2162
|
+
declare enum Type {
|
|
2166
2163
|
UNKNOWN = "UNKNOWN",
|
|
2167
2164
|
/** Manually saved. */
|
|
2168
2165
|
MANUAL = "MANUAL",
|
|
@@ -2175,9 +2172,7 @@ export declare enum Type {
|
|
|
2175
2172
|
/** Triggered by autosave when post created by AI tool. */
|
|
2176
2173
|
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
|
2177
2174
|
}
|
|
2178
|
-
|
|
2179
|
-
export type TypeWithLiterals = Type | 'UNKNOWN' | 'MANUAL' | 'AUTO_SAVE' | 'PROVISIONING' | 'IMPORT' | 'AI_AUTO_SAVE';
|
|
2180
|
-
export declare enum Field {
|
|
2175
|
+
declare enum Field {
|
|
2181
2176
|
/** Unknown field. */
|
|
2182
2177
|
UNKNOWN = "UNKNOWN",
|
|
2183
2178
|
/** Includes draft post preview URL. */
|
|
@@ -2190,12 +2185,12 @@ export declare enum Field {
|
|
|
2190
2185
|
GENERATED_EXCERPT = "GENERATED_EXCERPT"
|
|
2191
2186
|
}
|
|
2192
2187
|
/** @enumType */
|
|
2193
|
-
|
|
2194
|
-
|
|
2188
|
+
type FieldWithLiterals = Field | 'UNKNOWN' | 'URL' | 'CONTENT' | 'RICH_CONTENT' | 'GENERATED_EXCERPT';
|
|
2189
|
+
interface CreateDraftPostResponse {
|
|
2195
2190
|
/** Created draft post info. */
|
|
2196
2191
|
draftPost?: DraftPost;
|
|
2197
2192
|
}
|
|
2198
|
-
|
|
2193
|
+
interface BulkCreateDraftPostsRequest {
|
|
2199
2194
|
/**
|
|
2200
2195
|
* Draft posts to create.
|
|
2201
2196
|
* @minSize 1
|
|
@@ -2214,19 +2209,19 @@ export interface BulkCreateDraftPostsRequest {
|
|
|
2214
2209
|
*/
|
|
2215
2210
|
fieldsets?: FieldWithLiterals[];
|
|
2216
2211
|
}
|
|
2217
|
-
|
|
2212
|
+
interface BulkCreateDraftPostsResponse {
|
|
2218
2213
|
/** Draft posts created by bulk action. */
|
|
2219
2214
|
results?: BulkDraftPostResult[];
|
|
2220
2215
|
/** Bulk action metadata. */
|
|
2221
2216
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2222
2217
|
}
|
|
2223
|
-
|
|
2218
|
+
interface BulkDraftPostResult {
|
|
2224
2219
|
/** Bulk actions metadata for draft post. */
|
|
2225
2220
|
itemMetadata?: ItemMetadata;
|
|
2226
2221
|
/** Optional full draft post. */
|
|
2227
2222
|
item?: DraftPost;
|
|
2228
2223
|
}
|
|
2229
|
-
|
|
2224
|
+
interface ItemMetadata {
|
|
2230
2225
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2231
2226
|
_id?: string | null;
|
|
2232
2227
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
@@ -2236,7 +2231,7 @@ export interface ItemMetadata {
|
|
|
2236
2231
|
/** Details about the error in case of failure. */
|
|
2237
2232
|
error?: ApplicationError;
|
|
2238
2233
|
}
|
|
2239
|
-
|
|
2234
|
+
interface ApplicationError {
|
|
2240
2235
|
/** Error code. */
|
|
2241
2236
|
code?: string;
|
|
2242
2237
|
/** Description of the error. */
|
|
@@ -2244,7 +2239,7 @@ export interface ApplicationError {
|
|
|
2244
2239
|
/** Data related to the error. */
|
|
2245
2240
|
data?: Record<string, any> | null;
|
|
2246
2241
|
}
|
|
2247
|
-
|
|
2242
|
+
interface BulkActionMetadata {
|
|
2248
2243
|
/** Number of items that were successfully processed. */
|
|
2249
2244
|
totalSuccesses?: number;
|
|
2250
2245
|
/** Number of items that couldn't be processed. */
|
|
@@ -2252,7 +2247,7 @@ export interface BulkActionMetadata {
|
|
|
2252
2247
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
2253
2248
|
undetailedFailures?: number;
|
|
2254
2249
|
}
|
|
2255
|
-
|
|
2250
|
+
interface BulkUpdateDraftPostsRequest {
|
|
2256
2251
|
/**
|
|
2257
2252
|
* Draft posts to update.
|
|
2258
2253
|
* @minSize 1
|
|
@@ -2277,13 +2272,13 @@ export interface BulkUpdateDraftPostsRequest {
|
|
|
2277
2272
|
*/
|
|
2278
2273
|
fieldsets?: FieldWithLiterals[];
|
|
2279
2274
|
}
|
|
2280
|
-
|
|
2275
|
+
interface MaskedDraftPosts {
|
|
2281
2276
|
/** Draft post */
|
|
2282
2277
|
draftPost?: DraftPost;
|
|
2283
2278
|
/** Field mask of fields to update. */
|
|
2284
2279
|
fieldMask?: string[];
|
|
2285
2280
|
}
|
|
2286
|
-
|
|
2281
|
+
declare enum Action {
|
|
2287
2282
|
/** Update the draft post. */
|
|
2288
2283
|
UPDATE = "UPDATE",
|
|
2289
2284
|
/** Update and publish a draft post. */
|
|
@@ -2300,16 +2295,16 @@ export declare enum Action {
|
|
|
2300
2295
|
UPDATE_PUBLICATION = "UPDATE_PUBLICATION"
|
|
2301
2296
|
}
|
|
2302
2297
|
/** @enumType */
|
|
2303
|
-
|
|
2304
|
-
|
|
2298
|
+
type ActionWithLiterals = Action | 'UPDATE' | 'UPDATE_PUBLISH' | 'UPDATE_SCHEDULE' | 'UPDATE_REVERT_TO_DRAFT' | 'UPDATE_CANCEL_SCHEDULE' | 'UPDATE_REJECT' | 'UPDATE_PUBLICATION';
|
|
2299
|
+
interface BulkUpdateDraftPostsResponse {
|
|
2305
2300
|
/** Draft posts updated by bulk action. */
|
|
2306
2301
|
results?: BulkDraftPostResult[];
|
|
2307
2302
|
/** Bulk action metadata. */
|
|
2308
2303
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2309
2304
|
}
|
|
2310
|
-
|
|
2305
|
+
interface DraftPostOwnerChanged {
|
|
2311
2306
|
}
|
|
2312
|
-
|
|
2307
|
+
interface ListDeletedDraftPostsRequest {
|
|
2313
2308
|
/**
|
|
2314
2309
|
* Language filter.
|
|
2315
2310
|
*
|
|
@@ -2340,15 +2335,15 @@ export interface ListDeletedDraftPostsRequest {
|
|
|
2340
2335
|
*/
|
|
2341
2336
|
draftPostIds?: string[];
|
|
2342
2337
|
}
|
|
2343
|
-
|
|
2338
|
+
declare enum GetDraftPostsSort {
|
|
2344
2339
|
/** Sort by `editedDate` in descending order. */
|
|
2345
2340
|
EDITING_DATE_DESC = "EDITING_DATE_DESC",
|
|
2346
2341
|
/** Sort by `editedDate` in ascending order. */
|
|
2347
2342
|
EDITING_DATE_ASC = "EDITING_DATE_ASC"
|
|
2348
2343
|
}
|
|
2349
2344
|
/** @enumType */
|
|
2350
|
-
|
|
2351
|
-
|
|
2345
|
+
type GetDraftPostsSortWithLiterals = GetDraftPostsSort | 'EDITING_DATE_DESC' | 'EDITING_DATE_ASC';
|
|
2346
|
+
interface BlogPaging {
|
|
2352
2347
|
/**
|
|
2353
2348
|
* Number of items to skip in the current sort order.
|
|
2354
2349
|
*
|
|
@@ -2371,7 +2366,7 @@ export interface BlogPaging {
|
|
|
2371
2366
|
*/
|
|
2372
2367
|
cursor?: string | null;
|
|
2373
2368
|
}
|
|
2374
|
-
|
|
2369
|
+
interface ListDeletedDraftPostsResponse {
|
|
2375
2370
|
/** List of draft posts. */
|
|
2376
2371
|
draftPosts?: DraftPost[];
|
|
2377
2372
|
/**
|
|
@@ -2390,7 +2385,7 @@ export interface ListDeletedDraftPostsResponse {
|
|
|
2390
2385
|
/** Details on the paged set of results returned. */
|
|
2391
2386
|
pagingMetadata?: PagingMetadataV2;
|
|
2392
2387
|
}
|
|
2393
|
-
|
|
2388
|
+
interface MetaData {
|
|
2394
2389
|
/** Number of items returned in this response. */
|
|
2395
2390
|
count?: number;
|
|
2396
2391
|
/** Requested offset. */
|
|
@@ -2403,7 +2398,7 @@ export interface MetaData {
|
|
|
2403
2398
|
*/
|
|
2404
2399
|
cursor?: string | null;
|
|
2405
2400
|
}
|
|
2406
|
-
|
|
2401
|
+
interface PagingMetadataV2 {
|
|
2407
2402
|
/** Number of items returned in the response. */
|
|
2408
2403
|
count?: number | null;
|
|
2409
2404
|
/** Offset that was requested. */
|
|
@@ -2415,7 +2410,7 @@ export interface PagingMetadataV2 {
|
|
|
2415
2410
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
2416
2411
|
cursors?: Cursors;
|
|
2417
2412
|
}
|
|
2418
|
-
|
|
2413
|
+
interface Cursors {
|
|
2419
2414
|
/**
|
|
2420
2415
|
* Cursor pointing to next page in the list of results.
|
|
2421
2416
|
* @maxLength 2000
|
|
@@ -2427,7 +2422,7 @@ export interface Cursors {
|
|
|
2427
2422
|
*/
|
|
2428
2423
|
prev?: string | null;
|
|
2429
2424
|
}
|
|
2430
|
-
|
|
2425
|
+
interface GetDraftPostRequest {
|
|
2431
2426
|
/**
|
|
2432
2427
|
* Draft post ID.
|
|
2433
2428
|
* @maxLength 38
|
|
@@ -2441,11 +2436,11 @@ export interface GetDraftPostRequest {
|
|
|
2441
2436
|
*/
|
|
2442
2437
|
fieldsets?: FieldWithLiterals[];
|
|
2443
2438
|
}
|
|
2444
|
-
|
|
2439
|
+
interface GetDraftPostResponse {
|
|
2445
2440
|
/** Draft post info. */
|
|
2446
2441
|
draftPost?: DraftPost;
|
|
2447
2442
|
}
|
|
2448
|
-
|
|
2443
|
+
interface UpdateDraftPostContentRequest extends UpdateDraftPostContentRequestDraftContentOneOf {
|
|
2449
2444
|
/**
|
|
2450
2445
|
* DraftJs content to update.
|
|
2451
2446
|
* @maxLength 400000
|
|
@@ -2469,7 +2464,7 @@ export interface UpdateDraftPostContentRequest extends UpdateDraftPostContentReq
|
|
|
2469
2464
|
fieldsets?: FieldWithLiterals[];
|
|
2470
2465
|
}
|
|
2471
2466
|
/** @oneof */
|
|
2472
|
-
|
|
2467
|
+
interface UpdateDraftPostContentRequestDraftContentOneOf {
|
|
2473
2468
|
/**
|
|
2474
2469
|
* DraftJs content to update.
|
|
2475
2470
|
* @maxLength 400000
|
|
@@ -2478,11 +2473,11 @@ export interface UpdateDraftPostContentRequestDraftContentOneOf {
|
|
|
2478
2473
|
/** Draft Post rich content. */
|
|
2479
2474
|
richContent?: RichContent;
|
|
2480
2475
|
}
|
|
2481
|
-
|
|
2476
|
+
interface UpdateDraftPostContentResponse {
|
|
2482
2477
|
/** Updated draft post info. */
|
|
2483
2478
|
draftPost?: DraftPost;
|
|
2484
2479
|
}
|
|
2485
|
-
|
|
2480
|
+
interface UpdateDraftPostRequest {
|
|
2486
2481
|
/** Draft post to update. */
|
|
2487
2482
|
draftPost: DraftPost;
|
|
2488
2483
|
/**
|
|
@@ -2501,11 +2496,11 @@ export interface UpdateDraftPostRequest {
|
|
|
2501
2496
|
*/
|
|
2502
2497
|
fieldsets?: FieldWithLiterals[];
|
|
2503
2498
|
}
|
|
2504
|
-
|
|
2499
|
+
interface UpdateDraftPostResponse {
|
|
2505
2500
|
/** Updated draft post info. */
|
|
2506
2501
|
draftPost?: DraftPost;
|
|
2507
2502
|
}
|
|
2508
|
-
|
|
2503
|
+
interface DeleteDraftPostRequest {
|
|
2509
2504
|
/**
|
|
2510
2505
|
* Draft post ID.
|
|
2511
2506
|
* @maxLength 38
|
|
@@ -2518,18 +2513,18 @@ export interface DeleteDraftPostRequest {
|
|
|
2518
2513
|
*/
|
|
2519
2514
|
permanent?: boolean;
|
|
2520
2515
|
}
|
|
2521
|
-
|
|
2516
|
+
interface DeleteDraftPostResponse {
|
|
2522
2517
|
}
|
|
2523
|
-
|
|
2518
|
+
interface RemoveFromTrashBinRequest {
|
|
2524
2519
|
/**
|
|
2525
2520
|
* Draft post ID.
|
|
2526
2521
|
* @maxLength 38
|
|
2527
2522
|
*/
|
|
2528
2523
|
draftPostId: string;
|
|
2529
2524
|
}
|
|
2530
|
-
|
|
2525
|
+
interface RemoveFromTrashBinResponse {
|
|
2531
2526
|
}
|
|
2532
|
-
|
|
2527
|
+
interface BulkDeleteDraftPostsRequest {
|
|
2533
2528
|
/**
|
|
2534
2529
|
* Post IDs.
|
|
2535
2530
|
* @minSize 1
|
|
@@ -2540,13 +2535,13 @@ export interface BulkDeleteDraftPostsRequest {
|
|
|
2540
2535
|
/** Should delete bypassing the trash-bin. */
|
|
2541
2536
|
permanent?: boolean;
|
|
2542
2537
|
}
|
|
2543
|
-
|
|
2538
|
+
interface BulkDeleteDraftPostsResponse {
|
|
2544
2539
|
/** Bulk action results. */
|
|
2545
2540
|
results?: BulkDraftPostResult[];
|
|
2546
2541
|
/** Bulk action metadata. */
|
|
2547
2542
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2548
2543
|
}
|
|
2549
|
-
|
|
2544
|
+
interface ListDraftPostsRequest {
|
|
2550
2545
|
/**
|
|
2551
2546
|
* Draft post status filter.
|
|
2552
2547
|
*
|
|
@@ -2577,35 +2572,35 @@ export interface ListDraftPostsRequest {
|
|
|
2577
2572
|
*/
|
|
2578
2573
|
fieldsets?: FieldWithLiterals[];
|
|
2579
2574
|
}
|
|
2580
|
-
|
|
2575
|
+
interface ListDraftPostsResponse {
|
|
2581
2576
|
/** List of draft posts. */
|
|
2582
2577
|
draftPosts?: DraftPost[];
|
|
2583
2578
|
/** Details on the paged set of results returned. */
|
|
2584
2579
|
metaData?: MetaData;
|
|
2585
2580
|
}
|
|
2586
|
-
|
|
2581
|
+
interface GetDeletedDraftPostRequest {
|
|
2587
2582
|
/**
|
|
2588
2583
|
* Draft post ID.
|
|
2589
2584
|
* @maxLength 38
|
|
2590
2585
|
*/
|
|
2591
2586
|
draftPostId: string;
|
|
2592
2587
|
}
|
|
2593
|
-
|
|
2588
|
+
interface GetDeletedDraftPostResponse {
|
|
2594
2589
|
/** Draft post info. */
|
|
2595
2590
|
draftPost?: DraftPost;
|
|
2596
2591
|
}
|
|
2597
|
-
|
|
2592
|
+
interface RestoreFromTrashBinRequest {
|
|
2598
2593
|
/**
|
|
2599
2594
|
* Draft post ID.
|
|
2600
2595
|
* @maxLength 38
|
|
2601
2596
|
*/
|
|
2602
2597
|
draftPostId: string;
|
|
2603
2598
|
}
|
|
2604
|
-
|
|
2599
|
+
interface RestoreFromTrashBinResponse {
|
|
2605
2600
|
/** Restored draft post info. */
|
|
2606
2601
|
draftPost?: DraftPost;
|
|
2607
2602
|
}
|
|
2608
|
-
|
|
2603
|
+
interface QueryDraftPostsRequest {
|
|
2609
2604
|
/**
|
|
2610
2605
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
2611
2606
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
@@ -2616,7 +2611,7 @@ export interface QueryDraftPostsRequest {
|
|
|
2616
2611
|
/** Query options. */
|
|
2617
2612
|
query?: PlatformQuery;
|
|
2618
2613
|
}
|
|
2619
|
-
|
|
2614
|
+
interface Sorting {
|
|
2620
2615
|
/**
|
|
2621
2616
|
* Name of the field to sort by.
|
|
2622
2617
|
* @maxLength 512
|
|
@@ -2625,13 +2620,13 @@ export interface Sorting {
|
|
|
2625
2620
|
/** Sort order. */
|
|
2626
2621
|
order?: SortOrderWithLiterals;
|
|
2627
2622
|
}
|
|
2628
|
-
|
|
2623
|
+
declare enum SortOrder {
|
|
2629
2624
|
ASC = "ASC",
|
|
2630
2625
|
DESC = "DESC"
|
|
2631
2626
|
}
|
|
2632
2627
|
/** @enumType */
|
|
2633
|
-
|
|
2634
|
-
|
|
2628
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
2629
|
+
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
2635
2630
|
/** Paging options to limit and skip the number of items. */
|
|
2636
2631
|
paging?: Paging;
|
|
2637
2632
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
@@ -2653,13 +2648,13 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
|
2653
2648
|
sort?: Sorting[];
|
|
2654
2649
|
}
|
|
2655
2650
|
/** @oneof */
|
|
2656
|
-
|
|
2651
|
+
interface PlatformQueryPagingMethodOneOf {
|
|
2657
2652
|
/** Paging options to limit and skip the number of items. */
|
|
2658
2653
|
paging?: Paging;
|
|
2659
2654
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
2660
2655
|
cursorPaging?: CursorPaging;
|
|
2661
2656
|
}
|
|
2662
|
-
|
|
2657
|
+
interface Paging {
|
|
2663
2658
|
/**
|
|
2664
2659
|
* Number of items to load.
|
|
2665
2660
|
* @max 100
|
|
@@ -2668,7 +2663,7 @@ export interface Paging {
|
|
|
2668
2663
|
/** Number of items to skip in the current sort order. */
|
|
2669
2664
|
offset?: number | null;
|
|
2670
2665
|
}
|
|
2671
|
-
|
|
2666
|
+
interface CursorPaging {
|
|
2672
2667
|
/**
|
|
2673
2668
|
* Number of items to load.
|
|
2674
2669
|
* @max 100
|
|
@@ -2684,36 +2679,36 @@ export interface CursorPaging {
|
|
|
2684
2679
|
*/
|
|
2685
2680
|
cursor?: string | null;
|
|
2686
2681
|
}
|
|
2687
|
-
|
|
2682
|
+
interface QueryDraftPostsResponse {
|
|
2688
2683
|
/** List of posts. */
|
|
2689
2684
|
draftPosts?: DraftPost[];
|
|
2690
2685
|
/** Details on the paged set of results returned. */
|
|
2691
2686
|
pagingMetadata?: PagingMetadataV2;
|
|
2692
2687
|
}
|
|
2693
|
-
|
|
2688
|
+
interface PublishDraftPostRequest {
|
|
2694
2689
|
/**
|
|
2695
2690
|
* Draft post ID.
|
|
2696
2691
|
* @maxLength 38
|
|
2697
2692
|
*/
|
|
2698
2693
|
draftPostId: string;
|
|
2699
2694
|
}
|
|
2700
|
-
|
|
2695
|
+
interface PublishDraftPostResponse {
|
|
2701
2696
|
/**
|
|
2702
2697
|
* Published post ID.
|
|
2703
2698
|
* @format GUID
|
|
2704
2699
|
*/
|
|
2705
2700
|
postId?: string;
|
|
2706
2701
|
}
|
|
2707
|
-
|
|
2702
|
+
interface UnpublishPostRequest {
|
|
2708
2703
|
/**
|
|
2709
2704
|
* Draft post ID.
|
|
2710
2705
|
* @maxLength 38
|
|
2711
2706
|
*/
|
|
2712
2707
|
draftPostId?: string;
|
|
2713
2708
|
}
|
|
2714
|
-
|
|
2709
|
+
interface UnpublishPostResponse {
|
|
2715
2710
|
}
|
|
2716
|
-
|
|
2711
|
+
interface TranslateCategoryRequest {
|
|
2717
2712
|
/**
|
|
2718
2713
|
* Source category ID
|
|
2719
2714
|
* @format GUID
|
|
@@ -2725,13 +2720,13 @@ export interface TranslateCategoryRequest {
|
|
|
2725
2720
|
*/
|
|
2726
2721
|
language?: string;
|
|
2727
2722
|
}
|
|
2728
|
-
|
|
2723
|
+
interface TranslateCategoryResponse {
|
|
2729
2724
|
/** Translated category */
|
|
2730
2725
|
category?: Category;
|
|
2731
2726
|
/** Other translations of returned category */
|
|
2732
2727
|
translations?: CategoryTranslation[];
|
|
2733
2728
|
}
|
|
2734
|
-
|
|
2729
|
+
interface Category {
|
|
2735
2730
|
/**
|
|
2736
2731
|
* Category ID.
|
|
2737
2732
|
* @immutable
|
|
@@ -2799,7 +2794,7 @@ export interface Category {
|
|
|
2799
2794
|
*/
|
|
2800
2795
|
_updatedDate?: Date | null;
|
|
2801
2796
|
}
|
|
2802
|
-
|
|
2797
|
+
interface CategoryTranslation {
|
|
2803
2798
|
/**
|
|
2804
2799
|
* Category ID.
|
|
2805
2800
|
* @format GUID
|
|
@@ -2818,7 +2813,7 @@ export interface CategoryTranslation {
|
|
|
2818
2813
|
/** URL of this category page. */
|
|
2819
2814
|
url?: string;
|
|
2820
2815
|
}
|
|
2821
|
-
|
|
2816
|
+
interface TranslateDraftRequest {
|
|
2822
2817
|
/**
|
|
2823
2818
|
* Source post or draft ID
|
|
2824
2819
|
* @format GUID
|
|
@@ -2837,18 +2832,18 @@ export interface TranslateDraftRequest {
|
|
|
2837
2832
|
*/
|
|
2838
2833
|
fieldsets?: FieldWithLiterals[];
|
|
2839
2834
|
}
|
|
2840
|
-
|
|
2835
|
+
interface TranslateDraftResponse {
|
|
2841
2836
|
/** Draft post. */
|
|
2842
2837
|
draftPost?: DraftPost;
|
|
2843
2838
|
}
|
|
2844
|
-
|
|
2839
|
+
interface IsDraftPostAutoTranslatableRequest {
|
|
2845
2840
|
/**
|
|
2846
2841
|
* Source post or draft ID.
|
|
2847
2842
|
* @format GUID
|
|
2848
2843
|
*/
|
|
2849
2844
|
draftPostId?: string;
|
|
2850
2845
|
}
|
|
2851
|
-
|
|
2846
|
+
interface IsDraftPostAutoTranslatableResponse {
|
|
2852
2847
|
/**
|
|
2853
2848
|
* Source draft post ID.
|
|
2854
2849
|
* @format GUID
|
|
@@ -2867,7 +2862,7 @@ export interface IsDraftPostAutoTranslatableResponse {
|
|
|
2867
2862
|
/** Content text character count. */
|
|
2868
2863
|
contentTextCharacterCount?: number;
|
|
2869
2864
|
}
|
|
2870
|
-
|
|
2865
|
+
interface UpdateDraftPostLanguageRequest {
|
|
2871
2866
|
/**
|
|
2872
2867
|
* Source draft post ID
|
|
2873
2868
|
* @format GUID
|
|
@@ -2887,11 +2882,11 @@ export interface UpdateDraftPostLanguageRequest {
|
|
|
2887
2882
|
*/
|
|
2888
2883
|
fieldsets?: FieldWithLiterals[];
|
|
2889
2884
|
}
|
|
2890
|
-
|
|
2885
|
+
interface UpdateDraftPostLanguageResponse {
|
|
2891
2886
|
/** Draft post */
|
|
2892
2887
|
draftPost?: DraftPost;
|
|
2893
2888
|
}
|
|
2894
|
-
|
|
2889
|
+
interface BulkUpdateDraftPostLanguageRequest {
|
|
2895
2890
|
/**
|
|
2896
2891
|
* Source post or draft IDs
|
|
2897
2892
|
* @maxSize 50
|
|
@@ -2913,24 +2908,24 @@ export interface BulkUpdateDraftPostLanguageRequest {
|
|
|
2913
2908
|
*/
|
|
2914
2909
|
fieldsets?: FieldWithLiterals[];
|
|
2915
2910
|
}
|
|
2916
|
-
|
|
2911
|
+
interface BulkUpdateDraftPostLanguageResponse {
|
|
2917
2912
|
/** Bulk action results */
|
|
2918
2913
|
results?: BulkDraftPostResult[];
|
|
2919
2914
|
/** Bulk action metadata */
|
|
2920
2915
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2921
2916
|
}
|
|
2922
|
-
|
|
2917
|
+
interface GetPostAmountsByLanguageRequest {
|
|
2923
2918
|
/**
|
|
2924
2919
|
* Post status to filter by
|
|
2925
2920
|
* @maxLength 100
|
|
2926
2921
|
*/
|
|
2927
2922
|
status?: string;
|
|
2928
2923
|
}
|
|
2929
|
-
|
|
2924
|
+
interface GetPostAmountsByLanguageResponse {
|
|
2930
2925
|
/** Post amounts by language */
|
|
2931
2926
|
postAmountsByLanguage?: PostAmountByLanguage[];
|
|
2932
2927
|
}
|
|
2933
|
-
|
|
2928
|
+
interface PostAmountByLanguage {
|
|
2934
2929
|
/**
|
|
2935
2930
|
* Post language code
|
|
2936
2931
|
* @format LANGUAGE_TAG
|
|
@@ -2944,7 +2939,7 @@ export interface PostAmountByLanguage {
|
|
|
2944
2939
|
/** Post amount in that language */
|
|
2945
2940
|
postAmount?: number;
|
|
2946
2941
|
}
|
|
2947
|
-
|
|
2942
|
+
interface BulkRevertToUnpublishedRequest {
|
|
2948
2943
|
/**
|
|
2949
2944
|
* Source post IDs.
|
|
2950
2945
|
* @minSize 1
|
|
@@ -2955,13 +2950,13 @@ export interface BulkRevertToUnpublishedRequest {
|
|
|
2955
2950
|
/** Should full draft post be returned. */
|
|
2956
2951
|
returnFullEntity?: boolean;
|
|
2957
2952
|
}
|
|
2958
|
-
|
|
2953
|
+
interface BulkRevertToUnpublishedResponse {
|
|
2959
2954
|
/** Bulk action results. */
|
|
2960
2955
|
results?: BulkDraftPostResult[];
|
|
2961
2956
|
/** Bulk action metadata. */
|
|
2962
2957
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2963
2958
|
}
|
|
2964
|
-
|
|
2959
|
+
interface BulkRejectDraftPostRequest {
|
|
2965
2960
|
/**
|
|
2966
2961
|
* Source post IDs.
|
|
2967
2962
|
* @minSize 1
|
|
@@ -2972,13 +2967,13 @@ export interface BulkRejectDraftPostRequest {
|
|
|
2972
2967
|
/** Should full draft post be returned. */
|
|
2973
2968
|
returnFullEntity?: boolean;
|
|
2974
2969
|
}
|
|
2975
|
-
|
|
2970
|
+
interface BulkRejectDraftPostResponse {
|
|
2976
2971
|
/** Bulk action results. */
|
|
2977
2972
|
results?: BulkDraftPostResult[];
|
|
2978
2973
|
/** Bulk action metadata. */
|
|
2979
2974
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2980
2975
|
}
|
|
2981
|
-
|
|
2976
|
+
interface RevertToUnpublishedRequest {
|
|
2982
2977
|
/**
|
|
2983
2978
|
* Source post ID.
|
|
2984
2979
|
* @format GUID
|
|
@@ -2992,11 +2987,11 @@ export interface RevertToUnpublishedRequest {
|
|
|
2992
2987
|
*/
|
|
2993
2988
|
fieldsets?: FieldWithLiterals[];
|
|
2994
2989
|
}
|
|
2995
|
-
|
|
2990
|
+
interface RevertToUnpublishedResponse {
|
|
2996
2991
|
/** Updated post draft. */
|
|
2997
2992
|
draftPost?: DraftPost;
|
|
2998
2993
|
}
|
|
2999
|
-
|
|
2994
|
+
interface RejectDraftPostRequest {
|
|
3000
2995
|
/**
|
|
3001
2996
|
* Source post ID.
|
|
3002
2997
|
* @format GUID
|
|
@@ -3010,11 +3005,11 @@ export interface RejectDraftPostRequest {
|
|
|
3010
3005
|
*/
|
|
3011
3006
|
fieldsets?: FieldWithLiterals[];
|
|
3012
3007
|
}
|
|
3013
|
-
|
|
3008
|
+
interface RejectDraftPostResponse {
|
|
3014
3009
|
/** Draft post. */
|
|
3015
3010
|
draftPost?: DraftPost;
|
|
3016
3011
|
}
|
|
3017
|
-
|
|
3012
|
+
interface ApproveDraftPostRequest {
|
|
3018
3013
|
/**
|
|
3019
3014
|
* Source post ID.
|
|
3020
3015
|
* @format GUID
|
|
@@ -3033,11 +3028,11 @@ export interface ApproveDraftPostRequest {
|
|
|
3033
3028
|
*/
|
|
3034
3029
|
fieldsets?: FieldWithLiterals[];
|
|
3035
3030
|
}
|
|
3036
|
-
|
|
3031
|
+
interface ApproveDraftPostResponse {
|
|
3037
3032
|
/** Updated post draft. */
|
|
3038
3033
|
draftPost?: DraftPost;
|
|
3039
3034
|
}
|
|
3040
|
-
|
|
3035
|
+
interface MarkPostAsInModerationRequest {
|
|
3041
3036
|
/**
|
|
3042
3037
|
* Source post ID.
|
|
3043
3038
|
* @maxLength 38
|
|
@@ -3051,11 +3046,11 @@ export interface MarkPostAsInModerationRequest {
|
|
|
3051
3046
|
*/
|
|
3052
3047
|
fieldsets?: FieldWithLiterals[];
|
|
3053
3048
|
}
|
|
3054
|
-
|
|
3049
|
+
interface MarkPostAsInModerationResponse {
|
|
3055
3050
|
/** Updated post draft. */
|
|
3056
3051
|
draftPost?: DraftPost;
|
|
3057
3052
|
}
|
|
3058
|
-
|
|
3053
|
+
interface BaseEventMetadata {
|
|
3059
3054
|
/**
|
|
3060
3055
|
* App instance ID.
|
|
3061
3056
|
* @format GUID
|
|
@@ -3069,7 +3064,7 @@ export interface BaseEventMetadata {
|
|
|
3069
3064
|
/** The identification type and identity data. */
|
|
3070
3065
|
identity?: IdentificationData;
|
|
3071
3066
|
}
|
|
3072
|
-
|
|
3067
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
3073
3068
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3074
3069
|
_id?: string;
|
|
3075
3070
|
/**
|
|
@@ -3099,118 +3094,19 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
3099
3094
|
*/
|
|
3100
3095
|
entityEventSequence?: string | null;
|
|
3101
3096
|
}
|
|
3102
|
-
|
|
3097
|
+
interface DraftCreatedEnvelope {
|
|
3103
3098
|
entity: DraftPost;
|
|
3104
3099
|
metadata: EventMetadata;
|
|
3105
3100
|
}
|
|
3106
|
-
|
|
3107
|
-
* Triggered when a draft post is created.
|
|
3108
|
-
* @permissionScope Manage Blog
|
|
3109
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3110
|
-
* @permissionScope Manage Blog
|
|
3111
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3112
|
-
* @permissionScope Read Draft Blog Posts
|
|
3113
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
|
3114
|
-
* @permissionScope Read Blog
|
|
3115
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
|
3116
|
-
* @permissionScope Manage Blog
|
|
3117
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3118
|
-
* @permissionScope Manage Blog
|
|
3119
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3120
|
-
* @permissionScope Read Draft Blog Posts
|
|
3121
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
|
3122
|
-
* @permissionId BLOG.READ_ANY_DRAFT
|
|
3123
|
-
* @permissionId BLOG.READ-PUBLICATION
|
|
3124
|
-
* @webhook
|
|
3125
|
-
* @eventType wix.blog.v3.draft_created
|
|
3126
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.DraftPostService
|
|
3127
|
-
* @slug created
|
|
3128
|
-
*/
|
|
3129
|
-
export declare function onDraftCreated(handler: (event: DraftCreatedEnvelope) => void | Promise<void>): void;
|
|
3130
|
-
export interface DraftDeletedEnvelope {
|
|
3101
|
+
interface DraftDeletedEnvelope {
|
|
3131
3102
|
entity: DraftPost;
|
|
3132
3103
|
metadata: EventMetadata;
|
|
3133
3104
|
}
|
|
3134
|
-
|
|
3135
|
-
* Triggered when a draft post is deleted.
|
|
3136
|
-
* @permissionScope Manage Blog
|
|
3137
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3138
|
-
* @permissionScope Manage Blog
|
|
3139
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3140
|
-
* @permissionScope Read Draft Blog Posts
|
|
3141
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
|
3142
|
-
* @permissionScope Read Blog
|
|
3143
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
|
3144
|
-
* @permissionScope Manage Blog
|
|
3145
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3146
|
-
* @permissionScope Manage Blog
|
|
3147
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3148
|
-
* @permissionScope Read Draft Blog Posts
|
|
3149
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
|
3150
|
-
* @permissionId BLOG.READ_ANY_DRAFT
|
|
3151
|
-
* @permissionId BLOG.READ-PUBLICATION
|
|
3152
|
-
* @webhook
|
|
3153
|
-
* @eventType wix.blog.v3.draft_deleted
|
|
3154
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.DraftPostService
|
|
3155
|
-
* @slug deleted
|
|
3156
|
-
*/
|
|
3157
|
-
export declare function onDraftDeleted(handler: (event: DraftDeletedEnvelope) => void | Promise<void>): void;
|
|
3158
|
-
export interface DraftUpdatedEnvelope {
|
|
3105
|
+
interface DraftUpdatedEnvelope {
|
|
3159
3106
|
entity: DraftPost;
|
|
3160
3107
|
metadata: EventMetadata;
|
|
3161
3108
|
}
|
|
3162
|
-
|
|
3163
|
-
* Triggered when a draft post is updated.
|
|
3164
|
-
* @permissionScope Manage Blog
|
|
3165
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3166
|
-
* @permissionScope Manage Blog
|
|
3167
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3168
|
-
* @permissionScope Read Draft Blog Posts
|
|
3169
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
|
3170
|
-
* @permissionScope Read Blog
|
|
3171
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
|
3172
|
-
* @permissionScope Manage Blog
|
|
3173
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3174
|
-
* @permissionScope Manage Blog
|
|
3175
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3176
|
-
* @permissionScope Read Draft Blog Posts
|
|
3177
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
|
3178
|
-
* @permissionId BLOG.READ_ANY_DRAFT
|
|
3179
|
-
* @permissionId BLOG.READ-PUBLICATION
|
|
3180
|
-
* @webhook
|
|
3181
|
-
* @eventType wix.blog.v3.draft_updated
|
|
3182
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.DraftPostService
|
|
3183
|
-
* @slug updated
|
|
3184
|
-
*/
|
|
3185
|
-
export declare function onDraftUpdated(handler: (event: DraftUpdatedEnvelope) => void | Promise<void>): void;
|
|
3186
|
-
type DraftNonNullablePaths = `_id` | `title` | `categoryIds` | `hashtags` | `minutesToRead` | `tagIds` | `relatedPostIds` | `pricingPlanIds` | `status` | `moderationDetails.submittedBy` | `moderationDetails.status` | `hasUnpublishedChanges` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `media.embedMedia.thumbnail.url` | `media.embedMedia.thumbnail.width` | `media.embedMedia.thumbnail.height` | `media.embedMedia.video.url` | `media.embedMedia.video.width` | `media.embedMedia.video.height` | `media.displayed` | `media.custom`;
|
|
3187
|
-
/**
|
|
3188
|
-
* Creates a draft post.
|
|
3189
|
-
*
|
|
3190
|
-
* For 3rd-party apps, `memberId` is a required field.
|
|
3191
|
-
*
|
|
3192
|
-
* In `categoryIds`, only categories that already exist will be added to the draft post. Including
|
|
3193
|
-
* `categoryIds` that do not exist will not return an error, but they will not be added to the `categoryIds` array.
|
|
3194
|
-
* If some of the categories exist, those will be added while those that do not exist will not be added to `categoryIds`.
|
|
3195
|
-
* You can check which categories are available with
|
|
3196
|
-
* List Categories ([SDK](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/list-categories) | [REST](https://dev.wix.com/docs/rest/business-solutions/blog/category/list-categories)).
|
|
3197
|
-
* @param draftPost - Draft post to create.
|
|
3198
|
-
* @public
|
|
3199
|
-
* @requiredField draftPost
|
|
3200
|
-
* @requiredField draftPost.title
|
|
3201
|
-
* @param options - Options for creating a draft post.
|
|
3202
|
-
* @permissionId BLOG.CREATE-DRAFT
|
|
3203
|
-
* @permissionScope Manage Blog
|
|
3204
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3205
|
-
* @permissionScope Manage Blog
|
|
3206
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3207
|
-
* @applicableIdentity APP
|
|
3208
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.CreateDraftPost
|
|
3209
|
-
*/
|
|
3210
|
-
export declare function createDraftPost(draftPost: NonNullablePaths<DraftPost, `title`>, options?: CreateDraftPostOptions): Promise<NonNullablePaths<CreateDraftPostResponse, {
|
|
3211
|
-
[P in DraftNonNullablePaths]: `draftPost.${P}`;
|
|
3212
|
-
}[DraftNonNullablePaths]>>;
|
|
3213
|
-
export interface CreateDraftPostOptions {
|
|
3109
|
+
interface CreateDraftPostOptions {
|
|
3214
3110
|
/**
|
|
3215
3111
|
* Whether the draft post should be published on creation.
|
|
3216
3112
|
*
|
|
@@ -3225,25 +3121,7 @@ export interface CreateDraftPostOptions {
|
|
|
3225
3121
|
*/
|
|
3226
3122
|
fieldsets?: FieldWithLiterals[];
|
|
3227
3123
|
}
|
|
3228
|
-
|
|
3229
|
-
* Creates multiple draft posts.
|
|
3230
|
-
* @param draftPosts - Draft posts to create.
|
|
3231
|
-
* @public
|
|
3232
|
-
* @requiredField draftPosts
|
|
3233
|
-
* @requiredField draftPosts.title
|
|
3234
|
-
* @param options - Options for creating multiple draft posts.
|
|
3235
|
-
* @permissionId BLOG.CREATE-DRAFT
|
|
3236
|
-
* @permissionScope Manage Blog
|
|
3237
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3238
|
-
* @permissionScope Manage Blog
|
|
3239
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3240
|
-
* @applicableIdentity APP
|
|
3241
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.BulkCreateDraftPosts
|
|
3242
|
-
*/
|
|
3243
|
-
export declare function bulkCreateDraftPosts(draftPosts: NonNullablePaths<DraftPost, `title`>[], options?: BulkCreateDraftPostsOptions): Promise<NonNullablePaths<BulkCreateDraftPostsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
3244
|
-
[P in DraftNonNullablePaths]: `results.${number}.item.${P}`;
|
|
3245
|
-
}[DraftNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
3246
|
-
export interface BulkCreateDraftPostsOptions {
|
|
3124
|
+
interface BulkCreateDraftPostsOptions {
|
|
3247
3125
|
/** Whether the draft post should be published after creation. */
|
|
3248
3126
|
publish?: boolean;
|
|
3249
3127
|
/** Whether to return the full created draft post entities in the response. */
|
|
@@ -3256,24 +3134,7 @@ export interface BulkCreateDraftPostsOptions {
|
|
|
3256
3134
|
*/
|
|
3257
3135
|
fieldsets?: FieldWithLiterals[];
|
|
3258
3136
|
}
|
|
3259
|
-
|
|
3260
|
-
* Updates multiple draft posts.
|
|
3261
|
-
* @public
|
|
3262
|
-
* @requiredField options.draftPosts.draftPost
|
|
3263
|
-
* @requiredField options.draftPosts.draftPost._id
|
|
3264
|
-
* @param options - Options for updating multiple draft posts.
|
|
3265
|
-
* @permissionId BLOG.EDIT-DRAFT
|
|
3266
|
-
* @permissionScope Manage Blog
|
|
3267
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3268
|
-
* @permissionScope Manage Blog
|
|
3269
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3270
|
-
* @applicableIdentity APP
|
|
3271
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.BulkUpdateDraftPosts
|
|
3272
|
-
*/
|
|
3273
|
-
export declare function bulkUpdateDraftPosts(options?: NonNullablePaths<BulkUpdateDraftPostsOptions, `draftPosts.${number}.draftPost` | `draftPosts.${number}.draftPost._id`>): Promise<NonNullablePaths<BulkUpdateDraftPostsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
3274
|
-
[P in DraftNonNullablePaths]: `results.${number}.item.${P}`;
|
|
3275
|
-
}[DraftNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
3276
|
-
export interface BulkUpdateDraftPostsOptions {
|
|
3137
|
+
interface BulkUpdateDraftPostsOptions {
|
|
3277
3138
|
/**
|
|
3278
3139
|
* Draft posts to update.
|
|
3279
3140
|
* @minSize 1
|
|
@@ -3298,27 +3159,7 @@ export interface BulkUpdateDraftPostsOptions {
|
|
|
3298
3159
|
*/
|
|
3299
3160
|
fieldsets?: FieldWithLiterals[];
|
|
3300
3161
|
}
|
|
3301
|
-
|
|
3302
|
-
* Retrieves a list of up to 100 deleted draft posts.
|
|
3303
|
-
*
|
|
3304
|
-
* List Draft Posts runs with these defaults, which you can override:
|
|
3305
|
-
* - `editedDate` is sorted in descending order. In this case,`editedDate` implies the date the post was deleted.
|
|
3306
|
-
* - `paging.limit` is `50`.
|
|
3307
|
-
* - `paging.offset` is `0`.
|
|
3308
|
-
* @public
|
|
3309
|
-
* @param options - Options for listing deleted draft posts.
|
|
3310
|
-
* @permissionId BLOG.READ_DRAFT
|
|
3311
|
-
* @permissionScope Manage Blog
|
|
3312
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3313
|
-
* @permissionScope Manage Blog
|
|
3314
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3315
|
-
* @applicableIdentity APP
|
|
3316
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.ListDeletedDraftPosts
|
|
3317
|
-
*/
|
|
3318
|
-
export declare function listDeletedDraftPosts(options?: ListDeletedDraftPostsOptions): Promise<NonNullablePaths<ListDeletedDraftPostsResponse, {
|
|
3319
|
-
[P in DraftNonNullablePaths]: `draftPosts.${number}.${P}`;
|
|
3320
|
-
}[DraftNonNullablePaths] | `metaData.count` | `metaData.offset` | `metaData.total`>>;
|
|
3321
|
-
export interface ListDeletedDraftPostsOptions {
|
|
3162
|
+
interface ListDeletedDraftPostsOptions {
|
|
3322
3163
|
/**
|
|
3323
3164
|
* Language filter.
|
|
3324
3165
|
*
|
|
@@ -3349,24 +3190,7 @@ export interface ListDeletedDraftPostsOptions {
|
|
|
3349
3190
|
*/
|
|
3350
3191
|
draftPostIds?: string[];
|
|
3351
3192
|
}
|
|
3352
|
-
|
|
3353
|
-
* Retrieves a draft post by the provided ID.
|
|
3354
|
-
* @param draftPostId - Draft post ID.
|
|
3355
|
-
* @public
|
|
3356
|
-
* @requiredField draftPostId
|
|
3357
|
-
* @param options - Options for getting a draft post.
|
|
3358
|
-
* @permissionId BLOG.READ_DRAFT
|
|
3359
|
-
* @permissionScope Manage Blog
|
|
3360
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3361
|
-
* @permissionScope Manage Blog
|
|
3362
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3363
|
-
* @applicableIdentity APP
|
|
3364
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.GetDraftPost
|
|
3365
|
-
*/
|
|
3366
|
-
export declare function getDraftPost(draftPostId: string, options?: GetDraftPostOptions): Promise<NonNullablePaths<GetDraftPostResponse, {
|
|
3367
|
-
[P in DraftNonNullablePaths]: `draftPost.${P}`;
|
|
3368
|
-
}[DraftNonNullablePaths]>>;
|
|
3369
|
-
export interface GetDraftPostOptions {
|
|
3193
|
+
interface GetDraftPostOptions {
|
|
3370
3194
|
/**
|
|
3371
3195
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3372
3196
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
@@ -3375,26 +3199,7 @@ export interface GetDraftPostOptions {
|
|
|
3375
3199
|
*/
|
|
3376
3200
|
fieldsets?: FieldWithLiterals[];
|
|
3377
3201
|
}
|
|
3378
|
-
|
|
3379
|
-
* Updates a draft post.
|
|
3380
|
-
* @param _id - Draft post ID.
|
|
3381
|
-
* @public
|
|
3382
|
-
* @requiredField _id
|
|
3383
|
-
* @requiredField draftPost
|
|
3384
|
-
* @param options - Options for updating a draft post.
|
|
3385
|
-
* @param draftPost - Draft Post info.
|
|
3386
|
-
* @permissionId BLOG.EDIT-DRAFT
|
|
3387
|
-
* @permissionScope Manage Blog
|
|
3388
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3389
|
-
* @permissionScope Manage Blog
|
|
3390
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3391
|
-
* @applicableIdentity APP
|
|
3392
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.UpdateDraftPost
|
|
3393
|
-
*/
|
|
3394
|
-
export declare function updateDraftPost(_id: string, draftPost: UpdateDraftPost, options?: UpdateDraftPostOptions): Promise<NonNullablePaths<UpdateDraftPostResponse, {
|
|
3395
|
-
[P in DraftNonNullablePaths]: `draftPost.${P}`;
|
|
3396
|
-
}[DraftNonNullablePaths]>>;
|
|
3397
|
-
export interface UpdateDraftPost {
|
|
3202
|
+
interface UpdateDraftPost {
|
|
3398
3203
|
/**
|
|
3399
3204
|
* Draft post ID.
|
|
3400
3205
|
* @readonly
|
|
@@ -3529,7 +3334,7 @@ export interface UpdateDraftPost {
|
|
|
3529
3334
|
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
|
3530
3335
|
previewTextParagraph?: number | null;
|
|
3531
3336
|
}
|
|
3532
|
-
|
|
3337
|
+
interface UpdateDraftPostOptions {
|
|
3533
3338
|
/**
|
|
3534
3339
|
* Action to perform on the post.
|
|
3535
3340
|
*
|
|
@@ -3546,25 +3351,7 @@ export interface UpdateDraftPostOptions {
|
|
|
3546
3351
|
*/
|
|
3547
3352
|
fieldsets?: FieldWithLiterals[];
|
|
3548
3353
|
}
|
|
3549
|
-
|
|
3550
|
-
* Moves a draft post to the trash bin.
|
|
3551
|
-
* A published post can also be deleted by the `post.id`. See the Posts API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/blog/posts/) | [REST](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/post-object)) for more information about posts.
|
|
3552
|
-
*
|
|
3553
|
-
* To permanently delete a post bypassing the trash bin, set the `permanent` field value to `true`. The post can't be restored after this.
|
|
3554
|
-
* @param draftPostId - Draft post ID.
|
|
3555
|
-
* @public
|
|
3556
|
-
* @requiredField draftPostId
|
|
3557
|
-
* @param options - Options for deleting a draft post.
|
|
3558
|
-
* @permissionId BLOG.DELETE-DRAFT
|
|
3559
|
-
* @permissionScope Manage Blog
|
|
3560
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3561
|
-
* @permissionScope Manage Blog
|
|
3562
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3563
|
-
* @applicableIdentity APP
|
|
3564
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.DeleteDraftPost
|
|
3565
|
-
*/
|
|
3566
|
-
export declare function deleteDraftPost(draftPostId: string, options?: DeleteDraftPostOptions): Promise<void>;
|
|
3567
|
-
export interface DeleteDraftPostOptions {
|
|
3354
|
+
interface DeleteDraftPostOptions {
|
|
3568
3355
|
/**
|
|
3569
3356
|
* Whether to bypass the trash bin and delete the post permanently.
|
|
3570
3357
|
*
|
|
@@ -3572,64 +3359,11 @@ export interface DeleteDraftPostOptions {
|
|
|
3572
3359
|
*/
|
|
3573
3360
|
permanent?: boolean;
|
|
3574
3361
|
}
|
|
3575
|
-
|
|
3576
|
-
* Permanently deletes a draft post that is currently in the trash bin.
|
|
3577
|
-
*
|
|
3578
|
-
* This action is permanent and can't be reversed.
|
|
3579
|
-
* @param draftPostId - Draft post ID.
|
|
3580
|
-
* @public
|
|
3581
|
-
* @requiredField draftPostId
|
|
3582
|
-
* @permissionId BLOG.DELETE-DRAFT
|
|
3583
|
-
* @permissionScope Manage Blog
|
|
3584
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3585
|
-
* @permissionScope Manage Blog
|
|
3586
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3587
|
-
* @applicableIdentity APP
|
|
3588
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.RemoveFromTrashBin
|
|
3589
|
-
*/
|
|
3590
|
-
export declare function removeFromTrashBin(draftPostId: string): Promise<void>;
|
|
3591
|
-
/**
|
|
3592
|
-
* Deletes multiple draft posts.
|
|
3593
|
-
* @param postIds - Post IDs.
|
|
3594
|
-
* @public
|
|
3595
|
-
* @requiredField postIds
|
|
3596
|
-
* @param options - Options for deleting multiple draft posts.
|
|
3597
|
-
* @permissionId BLOG.DELETE-DRAFT
|
|
3598
|
-
* @permissionScope Manage Blog
|
|
3599
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3600
|
-
* @permissionScope Manage Blog
|
|
3601
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3602
|
-
* @applicableIdentity APP
|
|
3603
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.BulkDeleteDraftPosts
|
|
3604
|
-
*/
|
|
3605
|
-
export declare function bulkDeleteDraftPosts(postIds: string[], options?: BulkDeleteDraftPostsOptions): Promise<NonNullablePaths<BulkDeleteDraftPostsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
3606
|
-
[P in DraftNonNullablePaths]: `results.${number}.item.${P}`;
|
|
3607
|
-
}[DraftNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
3608
|
-
export interface BulkDeleteDraftPostsOptions {
|
|
3362
|
+
interface BulkDeleteDraftPostsOptions {
|
|
3609
3363
|
/** Should delete bypassing the trash-bin. */
|
|
3610
3364
|
permanent?: boolean;
|
|
3611
3365
|
}
|
|
3612
|
-
|
|
3613
|
-
* Retrieves a list of up to 100 draft posts per request.
|
|
3614
|
-
*
|
|
3615
|
-
* List Draft Posts runs with these defaults, which you can override:
|
|
3616
|
-
* - `editedDate` is sorted in descending order.
|
|
3617
|
-
* - `paging.limit` is `50`.
|
|
3618
|
-
* - `paging.offset` is `0`.
|
|
3619
|
-
* @public
|
|
3620
|
-
* @param options - Options for listing multiple draft posts.
|
|
3621
|
-
* @permissionId BLOG.READ_DRAFT
|
|
3622
|
-
* @permissionScope Manage Blog
|
|
3623
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3624
|
-
* @permissionScope Manage Blog
|
|
3625
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3626
|
-
* @applicableIdentity APP
|
|
3627
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.ListDraftPosts
|
|
3628
|
-
*/
|
|
3629
|
-
export declare function listDraftPosts(options?: ListDraftPostsOptions): Promise<NonNullablePaths<ListDraftPostsResponse, {
|
|
3630
|
-
[P in DraftNonNullablePaths]: `draftPosts.${number}.${P}`;
|
|
3631
|
-
}[DraftNonNullablePaths] | `metaData.count` | `metaData.offset` | `metaData.total`>>;
|
|
3632
|
-
export interface ListDraftPostsOptions {
|
|
3366
|
+
interface ListDraftPostsOptions {
|
|
3633
3367
|
/**
|
|
3634
3368
|
* Draft post status filter.
|
|
3635
3369
|
*
|
|
@@ -3660,65 +3394,7 @@ export interface ListDraftPostsOptions {
|
|
|
3660
3394
|
*/
|
|
3661
3395
|
fieldsets?: FieldWithLiterals[];
|
|
3662
3396
|
}
|
|
3663
|
-
|
|
3664
|
-
* Retrieves a deleted draft post from the trash bin by the provided ID.
|
|
3665
|
-
* @param draftPostId - Draft post ID.
|
|
3666
|
-
* @public
|
|
3667
|
-
* @requiredField draftPostId
|
|
3668
|
-
* @permissionId BLOG.READ_DRAFT
|
|
3669
|
-
* @permissionScope Manage Blog
|
|
3670
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3671
|
-
* @permissionScope Manage Blog
|
|
3672
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3673
|
-
* @applicableIdentity APP
|
|
3674
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.GetDeletedDraftPost
|
|
3675
|
-
*/
|
|
3676
|
-
export declare function getDeletedDraftPost(draftPostId: string): Promise<NonNullablePaths<GetDeletedDraftPostResponse, {
|
|
3677
|
-
[P in DraftNonNullablePaths]: `draftPost.${P}`;
|
|
3678
|
-
}[DraftNonNullablePaths]>>;
|
|
3679
|
-
/**
|
|
3680
|
-
* Restores a deleted draft post from the trash bin by the provided ID.
|
|
3681
|
-
* @param draftPostId - Draft post ID.
|
|
3682
|
-
* @public
|
|
3683
|
-
* @requiredField draftPostId
|
|
3684
|
-
* @permissionId BLOG.EDIT-DRAFT
|
|
3685
|
-
* @permissionScope Manage Blog
|
|
3686
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3687
|
-
* @permissionScope Manage Blog
|
|
3688
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3689
|
-
* @applicableIdentity APP
|
|
3690
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.RestoreFromTrashBin
|
|
3691
|
-
*/
|
|
3692
|
-
export declare function restoreFromTrashBin(draftPostId: string): Promise<NonNullablePaths<RestoreFromTrashBinResponse, {
|
|
3693
|
-
[P in DraftNonNullablePaths]: `draftPost.${P}`;
|
|
3694
|
-
}[DraftNonNullablePaths]>>;
|
|
3695
|
-
/**
|
|
3696
|
-
* Creates a query to retrieve a list of up to 100 draft posts.
|
|
3697
|
-
*
|
|
3698
|
-
*
|
|
3699
|
-
* The `queryDraftPosts()` function builds a query to retrieve a list of up to 100 draft posts, and returns a `DraftPostsQueryBuilder` object.
|
|
3700
|
-
*
|
|
3701
|
-
* The returned object contains the query definition, which is typically used to run the query using the `find()` function.
|
|
3702
|
-
*
|
|
3703
|
-
* You can refine the query by chaining `DraftPostsQueryBuilder` functions onto the query. `DraftPostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryDraftPosts()` returns.
|
|
3704
|
-
*
|
|
3705
|
-
* `queryDraftPosts()` runs with these `DraftPostsQueryBuilder` defaults that can be overridden:
|
|
3706
|
-
* - `limit(50)`
|
|
3707
|
-
* - `ascending('_id')`
|
|
3708
|
-
*
|
|
3709
|
-
* The following `DraftPostsQueryBuilder` functions are supported for `queryDraftPosts()`. For a full description of the Draft Posts object, see the object returned for the `items` property in `DraftPostsQueryResult`.
|
|
3710
|
-
* @public
|
|
3711
|
-
* @param options - Options for querying draft posts.
|
|
3712
|
-
* @permissionScope Manage Blog
|
|
3713
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3714
|
-
* @permissionScope Manage Blog
|
|
3715
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3716
|
-
* @permissionId BLOG.READ_DRAFT
|
|
3717
|
-
* @applicableIdentity APP
|
|
3718
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.QueryDraftPosts
|
|
3719
|
-
*/
|
|
3720
|
-
export declare function queryDraftPosts(options?: QueryDraftPostsOptions): DraftPostsQueryBuilder;
|
|
3721
|
-
export interface QueryDraftPostsOptions {
|
|
3397
|
+
interface QueryDraftPostsOptions {
|
|
3722
3398
|
/**
|
|
3723
3399
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3724
3400
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
@@ -3734,13 +3410,13 @@ interface QueryCursorResult {
|
|
|
3734
3410
|
length: number;
|
|
3735
3411
|
pageSize: number;
|
|
3736
3412
|
}
|
|
3737
|
-
|
|
3413
|
+
interface DraftPostsQueryResult extends QueryCursorResult {
|
|
3738
3414
|
items: DraftPost[];
|
|
3739
3415
|
query: DraftPostsQueryBuilder;
|
|
3740
3416
|
next: () => Promise<DraftPostsQueryResult>;
|
|
3741
3417
|
prev: () => Promise<DraftPostsQueryResult>;
|
|
3742
3418
|
}
|
|
3743
|
-
|
|
3419
|
+
interface DraftPostsQueryBuilder {
|
|
3744
3420
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
3745
3421
|
* @param value - Value to compare against.
|
|
3746
3422
|
*/
|
|
@@ -3752,23 +3428,31 @@ export interface DraftPostsQueryBuilder {
|
|
|
3752
3428
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
3753
3429
|
* @param value - Value to compare against.
|
|
3754
3430
|
*/
|
|
3755
|
-
ge: (propertyName: 'minutesToRead' | 'editedDate' | 'scheduledPublishDate', value: any) => DraftPostsQueryBuilder;
|
|
3431
|
+
ge: (propertyName: 'title' | 'excerpt' | 'minutesToRead' | 'editedDate' | 'scheduledPublishDate', value: any) => DraftPostsQueryBuilder;
|
|
3756
3432
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
3757
3433
|
* @param value - Value to compare against.
|
|
3758
3434
|
*/
|
|
3759
|
-
gt: (propertyName: 'minutesToRead' | 'editedDate' | 'scheduledPublishDate', value: any) => DraftPostsQueryBuilder;
|
|
3435
|
+
gt: (propertyName: 'title' | 'excerpt' | 'minutesToRead' | 'editedDate' | 'scheduledPublishDate', value: any) => DraftPostsQueryBuilder;
|
|
3760
3436
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
3761
3437
|
* @param value - Value to compare against.
|
|
3762
3438
|
*/
|
|
3763
|
-
le: (propertyName: 'minutesToRead' | 'editedDate' | 'scheduledPublishDate', value: any) => DraftPostsQueryBuilder;
|
|
3439
|
+
le: (propertyName: 'title' | 'excerpt' | 'minutesToRead' | 'editedDate' | 'scheduledPublishDate', value: any) => DraftPostsQueryBuilder;
|
|
3764
3440
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
3765
3441
|
* @param value - Value to compare against.
|
|
3766
3442
|
*/
|
|
3767
|
-
lt: (propertyName: 'minutesToRead' | 'editedDate' | 'scheduledPublishDate', value: any) => DraftPostsQueryBuilder;
|
|
3443
|
+
lt: (propertyName: 'title' | 'excerpt' | 'minutesToRead' | 'editedDate' | 'scheduledPublishDate', value: any) => DraftPostsQueryBuilder;
|
|
3768
3444
|
/** @param propertyName - Property whose value is compared with `string`.
|
|
3769
3445
|
* @param string - String to compare against. Case-insensitive.
|
|
3770
3446
|
*/
|
|
3771
3447
|
startsWith: (propertyName: 'title' | 'excerpt', value: string) => DraftPostsQueryBuilder;
|
|
3448
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
3449
|
+
* @param values - List of values to compare against.
|
|
3450
|
+
*/
|
|
3451
|
+
hasSome: (propertyName: string, value: any[]) => DraftPostsQueryBuilder;
|
|
3452
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
3453
|
+
* @param values - List of values to compare against.
|
|
3454
|
+
*/
|
|
3455
|
+
hasAll: (propertyName: string, value: any[]) => DraftPostsQueryBuilder;
|
|
3772
3456
|
in: (propertyName: '_id' | 'title' | 'excerpt' | 'minutesToRead' | 'translationId' | 'language' | 'status' | 'editedDate' | 'scheduledPublishDate', value: any) => DraftPostsQueryBuilder;
|
|
3773
3457
|
exists: (propertyName: 'title' | 'excerpt' | 'translationId' | 'language', value: boolean) => DraftPostsQueryBuilder;
|
|
3774
3458
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
@@ -3781,22 +3465,5 @@ export interface DraftPostsQueryBuilder {
|
|
|
3781
3465
|
skipTo: (cursor: string) => DraftPostsQueryBuilder;
|
|
3782
3466
|
find: () => Promise<DraftPostsQueryResult>;
|
|
3783
3467
|
}
|
|
3784
|
-
|
|
3785
|
-
|
|
3786
|
-
* with the data from the draft post.
|
|
3787
|
-
*
|
|
3788
|
-
* If the draft post was already published, the published post will be updated with the latest values
|
|
3789
|
-
* from the draft post.
|
|
3790
|
-
* @param draftPostId - Draft post ID.
|
|
3791
|
-
* @public
|
|
3792
|
-
* @requiredField draftPostId
|
|
3793
|
-
* @permissionId BLOG.PUBLISH-POST
|
|
3794
|
-
* @permissionScope Manage Blog
|
|
3795
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3796
|
-
* @permissionScope Manage Blog
|
|
3797
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
3798
|
-
* @applicableIdentity APP
|
|
3799
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.PublishDraftPost
|
|
3800
|
-
*/
|
|
3801
|
-
export declare function publishDraftPost(draftPostId: string): Promise<NonNullablePaths<PublishDraftPostResponse, `postId`>>;
|
|
3802
|
-
export {};
|
|
3468
|
+
|
|
3469
|
+
export { AppType as $, Alignment as A, type BulkCreateDraftPostsOptions as B, type CreateDraftPostOptions as C, type DraftPost as D, ThumbnailsAlignment as E, GIFType as F, type GetDraftPostOptions as G, Position as H, ViewRole as I, VoteRole as J, PollLayoutType as K, type ListDeletedDraftPostsOptions as L, MapType as M, NodeType as N, Origin as O, type PublishDraftPostResponse as P, type QueryDraftPostsOptions as Q, type RestoreFromTrashBinResponse as R, Source as S, Target as T, type UpdateDraftPost as U, ViewMode as V, WidthType as W, PollLayoutDirection as X, BackgroundType as Y, DecorationType as Z, FontType as _, type CreateDraftPostResponse as a, type Permissions as a$, InitialExpandedItems as a0, Direction as a1, VerticalAlignment as a2, NullValue as a3, Status as a4, ModerationStatusStatus as a5, TotalDraftPostsGroupingField as a6, WebhookIdentityType as a7, Type as a8, Field as a9, type FileSource as aA, type FileSourceDataOneOf as aB, type PDFSettings as aC, type GalleryData as aD, type V1Media as aE, type Image as aF, type Video as aG, type Item as aH, type ItemDataOneOf as aI, type GalleryOptions as aJ, type Layout as aK, type ItemStyle as aL, type Thumbnails as aM, type GIFData as aN, type GIF as aO, type HeadingData as aP, type HTMLData as aQ, type HTMLDataDataOneOf as aR, type ImageData as aS, type StylesBorder as aT, type ImageDataStyles as aU, type LinkPreviewData as aV, type LinkPreviewDataStyles as aW, type MapData as aX, type MapSettings as aY, type ParagraphData as aZ, type PollData as a_, Action as aa, GetDraftPostsSort as ab, SortOrder as ac, type CoverMedia as ad, type CoverMediaMediaOneOf as ae, type FocalPoint as af, type RichContent as ag, type Node as ah, type NodeDataOneOf as ai, type NodeStyle as aj, type ButtonData as ak, type Border as al, type Colors as am, type PluginContainerData as an, type PluginContainerDataWidth as ao, type PluginContainerDataWidthDataOneOf as ap, type Spoiler as aq, type Height as ar, type Styles as as, type Link as at, type LinkDataOneOf as au, type Rel as av, type CodeBlockData as aw, type TextStyle as ax, type DividerData as ay, type FileData as az, type BulkCreateDraftPostsResponse as b, type DomainEvent as b$, type Option as b0, type PollSettings as b1, type PollLayout as b2, type OptionLayout as b3, type Gradient as b4, type Background as b5, type BackgroundBackgroundOneOf as b6, type PollDesign as b7, type OptionDesign as b8, type Poll as b9, type AudioData as bA, type OrderedListData as bB, type BulletedListData as bC, type BlockquoteData as bD, type CaptionData as bE, type LayoutCellData as bF, type Metadata as bG, type DocumentStyle as bH, type TextNodeStyle as bI, type ModerationDetails as bJ, type SeoSchema as bK, type Keyword as bL, type Tag as bM, type Settings as bN, type Media as bO, type MediaMediaOneOf as bP, type WixMedia as bQ, type VideoResolution as bR, type EmbedMedia as bS, type EmbedThumbnail as bT, type EmbedVideo as bU, type DraftPostTranslation as bV, type DraftCategoriesUpdated as bW, type DraftTagsUpdated as bX, type GetDraftPostTotalsRequest as bY, type GetDraftPostTotalsResponse as bZ, type TotalDraftPosts as b_, type PollDataLayout as ba, type Design as bb, type TextData as bc, type Decoration as bd, type DecorationDataOneOf as be, type AnchorData as bf, type ColorData as bg, type LinkData as bh, type MentionData as bi, type FontSizeData as bj, type SpoilerData as bk, type AppEmbedData as bl, type AppEmbedDataAppDataOneOf as bm, type BookingData as bn, type EventData as bo, type VideoData as bp, type PlaybackOptions as bq, type EmbedData as br, type Oembed as bs, type CollapsibleListData as bt, type TableData as bu, type Dimensions as bv, type TableCellData as bw, type CellStyle as bx, type BorderColors as by, type ListValue as bz, type BulkUpdateDraftPostsOptions as c, type BulkRevertToUnpublishedResponse as c$, type DomainEventBodyOneOf as c0, type EntityCreatedEvent as c1, type RestoreInfo as c2, type EntityUpdatedEvent as c3, type EntityDeletedEvent as c4, type ActionEvent as c5, type MessageEnvelope as c6, type IdentificationData as c7, type IdentificationDataIdOneOf as c8, type InitialDraftPostsCopied as c9, type RestoreFromTrashBinRequest as cA, type QueryDraftPostsRequest as cB, type Sorting as cC, type PlatformQuery as cD, type PlatformQueryPagingMethodOneOf as cE, type Paging as cF, type CursorPaging as cG, type QueryDraftPostsResponse as cH, type PublishDraftPostRequest as cI, type UnpublishPostRequest as cJ, type UnpublishPostResponse as cK, type TranslateCategoryRequest as cL, type TranslateCategoryResponse as cM, type Category as cN, type CategoryTranslation as cO, type TranslateDraftRequest as cP, type TranslateDraftResponse as cQ, type IsDraftPostAutoTranslatableRequest as cR, type IsDraftPostAutoTranslatableResponse as cS, type UpdateDraftPostLanguageRequest as cT, type UpdateDraftPostLanguageResponse as cU, type BulkUpdateDraftPostLanguageRequest as cV, type BulkUpdateDraftPostLanguageResponse as cW, type GetPostAmountsByLanguageRequest as cX, type GetPostAmountsByLanguageResponse as cY, type PostAmountByLanguage as cZ, type BulkRevertToUnpublishedRequest as c_, type CreateDraftPostRequest as ca, type BulkCreateDraftPostsRequest as cb, type BulkDraftPostResult as cc, type ItemMetadata as cd, type ApplicationError as ce, type BulkActionMetadata as cf, type BulkUpdateDraftPostsRequest as cg, type MaskedDraftPosts as ch, type DraftPostOwnerChanged as ci, type ListDeletedDraftPostsRequest as cj, type BlogPaging as ck, type MetaData as cl, type PagingMetadataV2 as cm, type Cursors as cn, type GetDraftPostRequest as co, type UpdateDraftPostContentRequest as cp, type UpdateDraftPostContentRequestDraftContentOneOf as cq, type UpdateDraftPostContentResponse as cr, type UpdateDraftPostRequest as cs, type DeleteDraftPostRequest as ct, type DeleteDraftPostResponse as cu, type RemoveFromTrashBinRequest as cv, type RemoveFromTrashBinResponse as cw, type BulkDeleteDraftPostsRequest as cx, type ListDraftPostsRequest as cy, type GetDeletedDraftPostRequest as cz, type BulkUpdateDraftPostsResponse as d, type BulkRejectDraftPostRequest as d0, type BulkRejectDraftPostResponse as d1, type RevertToUnpublishedRequest as d2, type RevertToUnpublishedResponse as d3, type RejectDraftPostRequest as d4, type RejectDraftPostResponse as d5, type ApproveDraftPostRequest as d6, type ApproveDraftPostResponse as d7, type MarkPostAsInModerationRequest as d8, type MarkPostAsInModerationResponse as d9, type BaseEventMetadata as da, type EventMetadata as db, type DraftPostsQueryResult as dc, type ListDeletedDraftPostsResponse as e, type GetDraftPostResponse as f, type UpdateDraftPostOptions as g, type UpdateDraftPostResponse as h, type DeleteDraftPostOptions as i, type BulkDeleteDraftPostsOptions as j, type BulkDeleteDraftPostsResponse as k, type ListDraftPostsOptions as l, type ListDraftPostsResponse as m, type GetDeletedDraftPostResponse as n, type DraftPostsQueryBuilder as o, type DraftCreatedEnvelope as p, type DraftDeletedEnvelope as q, type DraftUpdatedEnvelope as r, PluginContainerDataAlignment as s, ButtonDataType as t, TextAlignment as u, LineStyle as v, Width as w, LayoutType as x, Orientation as y, Crop as z };
|