@wix/auto_sdk_blog_draft-posts 1.0.16 → 1.0.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/blog-v3-draft-draft-posts.context.d.ts +34 -0
- package/build/cjs/src/blog-v3-draft-draft-posts.context.js +78 -0
- package/build/cjs/src/blog-v3-draft-draft-posts.context.js.map +1 -0
- package/build/cjs/src/blog-v3-draft-draft-posts.http.d.ts +83 -0
- package/build/cjs/src/blog-v3-draft-draft-posts.http.js +1803 -0
- package/build/cjs/src/blog-v3-draft-draft-posts.http.js.map +1 -0
- package/build/cjs/src/blog-v3-draft-draft-posts.meta.d.ts +40 -0
- package/build/cjs/src/blog-v3-draft-draft-posts.meta.js +294 -0
- package/build/cjs/src/blog-v3-draft-draft-posts.meta.js.map +1 -0
- package/build/cjs/src/blog-v3-draft-draft-posts.public.d.ts +168 -0
- package/build/cjs/src/blog-v3-draft-draft-posts.public.js +339 -0
- package/build/cjs/src/blog-v3-draft-draft-posts.public.js.map +1 -0
- package/build/cjs/src/blog-v3-draft-draft-posts.types.d.ts +3049 -0
- package/build/cjs/src/blog-v3-draft-draft-posts.types.js +477 -0
- package/build/cjs/src/blog-v3-draft-draft-posts.types.js.map +1 -0
- package/build/{blog-v3-draft-draft-posts.universal-vVP72XfS.d.mts → cjs/src/blog-v3-draft-draft-posts.universal.d.ts} +558 -261
- package/build/cjs/src/blog-v3-draft-draft-posts.universal.js +1498 -0
- package/build/cjs/src/blog-v3-draft-draft-posts.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/blog-v3-draft-draft-posts.context.d.ts +34 -0
- package/build/es/src/blog-v3-draft-draft-posts.context.js +34 -0
- package/build/es/src/blog-v3-draft-draft-posts.context.js.map +1 -0
- package/build/es/src/blog-v3-draft-draft-posts.http.d.ts +83 -0
- package/build/es/src/blog-v3-draft-draft-posts.http.js +1786 -0
- package/build/es/src/blog-v3-draft-draft-posts.http.js.map +1 -0
- package/build/es/src/blog-v3-draft-draft-posts.meta.d.ts +40 -0
- package/build/es/src/blog-v3-draft-draft-posts.meta.js +254 -0
- package/build/es/src/blog-v3-draft-draft-posts.meta.js.map +1 -0
- package/build/es/src/blog-v3-draft-draft-posts.public.d.ts +168 -0
- package/build/es/src/blog-v3-draft-draft-posts.public.js +281 -0
- package/build/es/src/blog-v3-draft-draft-posts.public.js.map +1 -0
- package/build/es/src/blog-v3-draft-draft-posts.types.d.ts +3049 -0
- package/build/es/src/blog-v3-draft-draft-posts.types.js +474 -0
- package/build/es/src/blog-v3-draft-draft-posts.types.js.map +1 -0
- package/build/{blog-v3-draft-draft-posts.universal-vVP72XfS.d.ts → es/src/blog-v3-draft-draft-posts.universal.d.ts} +558 -261
- package/build/es/src/blog-v3-draft-draft-posts.universal.js +1457 -0
- package/build/es/src/blog-v3-draft-draft-posts.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.d.ts +34 -0
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.js +78 -0
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.js.map +1 -0
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.http.d.ts +83 -0
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.http.js +1803 -0
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.http.js.map +1 -0
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.meta.d.ts +40 -0
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.meta.js +294 -0
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.meta.js.map +1 -0
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.d.ts +168 -0
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.js +339 -0
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.js.map +1 -0
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.d.ts +3049 -0
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.js +477 -0
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.js.map +1 -0
- package/build/internal/{blog-v3-draft-draft-posts.universal-vVP72XfS.d.ts → cjs/src/blog-v3-draft-draft-posts.universal.d.ts} +558 -261
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.js +1498 -0
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/blog-v3-draft-draft-posts.context.d.ts +34 -0
- package/build/internal/es/src/blog-v3-draft-draft-posts.context.js +34 -0
- package/build/internal/es/src/blog-v3-draft-draft-posts.context.js.map +1 -0
- package/build/internal/es/src/blog-v3-draft-draft-posts.http.d.ts +83 -0
- package/build/internal/es/src/blog-v3-draft-draft-posts.http.js +1786 -0
- package/build/internal/es/src/blog-v3-draft-draft-posts.http.js.map +1 -0
- package/build/internal/es/src/blog-v3-draft-draft-posts.meta.d.ts +40 -0
- package/build/internal/es/src/blog-v3-draft-draft-posts.meta.js +254 -0
- package/build/internal/es/src/blog-v3-draft-draft-posts.meta.js.map +1 -0
- package/build/internal/es/src/blog-v3-draft-draft-posts.public.d.ts +168 -0
- package/build/internal/es/src/blog-v3-draft-draft-posts.public.js +281 -0
- package/build/internal/es/src/blog-v3-draft-draft-posts.public.js.map +1 -0
- package/build/internal/es/src/blog-v3-draft-draft-posts.types.d.ts +3049 -0
- package/build/internal/es/src/blog-v3-draft-draft-posts.types.js +474 -0
- package/build/internal/es/src/blog-v3-draft-draft-posts.types.js.map +1 -0
- package/build/internal/{blog-v3-draft-draft-posts.universal-vVP72XfS.d.mts → es/src/blog-v3-draft-draft-posts.universal.d.ts} +558 -261
- package/build/internal/es/src/blog-v3-draft-draft-posts.universal.js +1457 -0
- package/build/internal/es/src/blog-v3-draft-draft-posts.universal.js.map +1 -0
- package/package.json +13 -14
- package/build/index.d.mts +0 -193
- package/build/index.d.ts +0 -193
- package/build/index.js +0 -3411
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -3331
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -193
- package/build/internal/index.d.ts +0 -193
- package/build/internal/index.js +0 -3411
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -3331
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.d.mts +0 -2289
- package/build/internal/meta.d.ts +0 -2289
- package/build/internal/meta.js +0 -2057
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -2017
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.d.mts +0 -2289
- package/build/meta.d.ts +0 -2289
- package/build/meta.js +0 -2057
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -2017
- package/build/meta.mjs.map +0 -1
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
export interface DraftPost {
|
|
2
3
|
/**
|
|
3
4
|
* Draft post ID.
|
|
4
5
|
* @readonly
|
|
@@ -133,7 +134,7 @@ interface DraftPost {
|
|
|
133
134
|
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
|
134
135
|
previewTextParagraph?: number | null;
|
|
135
136
|
}
|
|
136
|
-
interface CoverMedia extends CoverMediaMediaOneOf {
|
|
137
|
+
export interface CoverMedia extends CoverMediaMediaOneOf {
|
|
137
138
|
/** Image url. */
|
|
138
139
|
image?: string;
|
|
139
140
|
/** Video url. */
|
|
@@ -164,13 +165,13 @@ interface CoverMedia extends CoverMediaMediaOneOf {
|
|
|
164
165
|
altText?: string | null;
|
|
165
166
|
}
|
|
166
167
|
/** @oneof */
|
|
167
|
-
interface CoverMediaMediaOneOf {
|
|
168
|
+
export interface CoverMediaMediaOneOf {
|
|
168
169
|
/** Image url. */
|
|
169
170
|
image?: string;
|
|
170
171
|
/** Video url. */
|
|
171
172
|
video?: string;
|
|
172
173
|
}
|
|
173
|
-
interface FocalPoint {
|
|
174
|
+
export interface FocalPoint {
|
|
174
175
|
/** X-coordinate of the focal point. */
|
|
175
176
|
x?: number;
|
|
176
177
|
/** Y-coordinate of the focal point. */
|
|
@@ -180,7 +181,7 @@ interface FocalPoint {
|
|
|
180
181
|
/** crop by width */
|
|
181
182
|
width?: number | null;
|
|
182
183
|
}
|
|
183
|
-
declare enum Origin {
|
|
184
|
+
export declare enum Origin {
|
|
184
185
|
UNKNOWN = "UNKNOWN",
|
|
185
186
|
/** Changed by admin */
|
|
186
187
|
ADMIN = "ADMIN",
|
|
@@ -253,7 +254,7 @@ declare enum Origin {
|
|
|
253
254
|
/** Saved automatically by AI tool. */
|
|
254
255
|
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
|
255
256
|
}
|
|
256
|
-
interface RichContent {
|
|
257
|
+
export interface RichContent {
|
|
257
258
|
/** Node objects representing a rich content document. */
|
|
258
259
|
nodes?: Node[];
|
|
259
260
|
/** Object metadata. */
|
|
@@ -261,7 +262,7 @@ interface RichContent {
|
|
|
261
262
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
262
263
|
documentStyle?: DocumentStyle;
|
|
263
264
|
}
|
|
264
|
-
interface Node extends NodeDataOneOf {
|
|
265
|
+
export interface Node extends NodeDataOneOf {
|
|
265
266
|
/** Data for a button node. */
|
|
266
267
|
buttonData?: ButtonData;
|
|
267
268
|
/** Data for a code block node. */
|
|
@@ -326,7 +327,7 @@ interface Node extends NodeDataOneOf {
|
|
|
326
327
|
style?: NodeStyle;
|
|
327
328
|
}
|
|
328
329
|
/** @oneof */
|
|
329
|
-
interface NodeDataOneOf {
|
|
330
|
+
export interface NodeDataOneOf {
|
|
330
331
|
/** Data for a button node. */
|
|
331
332
|
buttonData?: ButtonData;
|
|
332
333
|
/** Data for a code block node. */
|
|
@@ -382,7 +383,7 @@ interface NodeDataOneOf {
|
|
|
382
383
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
383
384
|
layoutCellData?: LayoutCellData;
|
|
384
385
|
}
|
|
385
|
-
declare enum NodeType {
|
|
386
|
+
export declare enum NodeType {
|
|
386
387
|
PARAGRAPH = "PARAGRAPH",
|
|
387
388
|
TEXT = "TEXT",
|
|
388
389
|
HEADING = "HEADING",
|
|
@@ -418,7 +419,7 @@ declare enum NodeType {
|
|
|
418
419
|
LAYOUT = "LAYOUT",
|
|
419
420
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
420
421
|
}
|
|
421
|
-
interface NodeStyle {
|
|
422
|
+
export interface NodeStyle {
|
|
422
423
|
/** The top padding value in pixels. */
|
|
423
424
|
paddingTop?: string | null;
|
|
424
425
|
/** The bottom padding value in pixels. */
|
|
@@ -426,7 +427,7 @@ interface NodeStyle {
|
|
|
426
427
|
/** The background color as a hexadecimal value. */
|
|
427
428
|
backgroundColor?: string | null;
|
|
428
429
|
}
|
|
429
|
-
interface ButtonData {
|
|
430
|
+
export interface ButtonData {
|
|
430
431
|
/** Styling for the button's container. */
|
|
431
432
|
containerData?: PluginContainerData;
|
|
432
433
|
/** The button type. */
|
|
@@ -438,7 +439,7 @@ interface ButtonData {
|
|
|
438
439
|
/** Button link details. */
|
|
439
440
|
link?: Link;
|
|
440
441
|
}
|
|
441
|
-
interface Border {
|
|
442
|
+
export interface Border {
|
|
442
443
|
/**
|
|
443
444
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
444
445
|
* @deprecated
|
|
@@ -450,7 +451,7 @@ interface Border {
|
|
|
450
451
|
*/
|
|
451
452
|
radius?: number | null;
|
|
452
453
|
}
|
|
453
|
-
interface Colors {
|
|
454
|
+
export interface Colors {
|
|
454
455
|
/**
|
|
455
456
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
456
457
|
* @deprecated
|
|
@@ -467,7 +468,7 @@ interface Colors {
|
|
|
467
468
|
*/
|
|
468
469
|
background?: string | null;
|
|
469
470
|
}
|
|
470
|
-
interface PluginContainerData {
|
|
471
|
+
export interface PluginContainerData {
|
|
471
472
|
/** The width of the node when it's displayed. */
|
|
472
473
|
width?: PluginContainerDataWidth;
|
|
473
474
|
/** The node's alignment within its container. */
|
|
@@ -479,7 +480,7 @@ interface PluginContainerData {
|
|
|
479
480
|
/** 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`. */
|
|
480
481
|
textWrap?: boolean | null;
|
|
481
482
|
}
|
|
482
|
-
declare enum WidthType {
|
|
483
|
+
export declare enum WidthType {
|
|
483
484
|
/** Width matches the content width */
|
|
484
485
|
CONTENT = "CONTENT",
|
|
485
486
|
/** Small Width */
|
|
@@ -489,7 +490,7 @@ declare enum WidthType {
|
|
|
489
490
|
/** coast-to-coast display */
|
|
490
491
|
FULL_WIDTH = "FULL_WIDTH"
|
|
491
492
|
}
|
|
492
|
-
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
493
|
+
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
493
494
|
/**
|
|
494
495
|
* One of the following predefined width options:
|
|
495
496
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -502,7 +503,7 @@ interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
|
502
503
|
custom?: string | null;
|
|
503
504
|
}
|
|
504
505
|
/** @oneof */
|
|
505
|
-
interface PluginContainerDataWidthDataOneOf {
|
|
506
|
+
export interface PluginContainerDataWidthDataOneOf {
|
|
506
507
|
/**
|
|
507
508
|
* One of the following predefined width options:
|
|
508
509
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -514,7 +515,7 @@ interface PluginContainerDataWidthDataOneOf {
|
|
|
514
515
|
/** A custom width value in pixels. */
|
|
515
516
|
custom?: string | null;
|
|
516
517
|
}
|
|
517
|
-
declare enum PluginContainerDataAlignment {
|
|
518
|
+
export declare enum PluginContainerDataAlignment {
|
|
518
519
|
/** Center Alignment */
|
|
519
520
|
CENTER = "CENTER",
|
|
520
521
|
/** Left Alignment */
|
|
@@ -522,7 +523,7 @@ declare enum PluginContainerDataAlignment {
|
|
|
522
523
|
/** Right Alignment */
|
|
523
524
|
RIGHT = "RIGHT"
|
|
524
525
|
}
|
|
525
|
-
interface Spoiler {
|
|
526
|
+
export interface Spoiler {
|
|
526
527
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
527
528
|
enabled?: boolean | null;
|
|
528
529
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -530,17 +531,17 @@ interface Spoiler {
|
|
|
530
531
|
/** The text for the button used to remove the spoiler cover. */
|
|
531
532
|
buttonText?: string | null;
|
|
532
533
|
}
|
|
533
|
-
interface Height {
|
|
534
|
+
export interface Height {
|
|
534
535
|
/** A custom height value in pixels. */
|
|
535
536
|
custom?: string | null;
|
|
536
537
|
}
|
|
537
|
-
declare enum ButtonDataType {
|
|
538
|
+
export declare enum ButtonDataType {
|
|
538
539
|
/** Regular link button */
|
|
539
540
|
LINK = "LINK",
|
|
540
541
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
541
542
|
ACTION = "ACTION"
|
|
542
543
|
}
|
|
543
|
-
interface Styles {
|
|
544
|
+
export interface Styles {
|
|
544
545
|
/**
|
|
545
546
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
546
547
|
* @deprecated
|
|
@@ -593,7 +594,7 @@ interface Styles {
|
|
|
593
594
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
594
595
|
buttonSize?: string | null;
|
|
595
596
|
}
|
|
596
|
-
interface Link extends LinkDataOneOf {
|
|
597
|
+
export interface Link extends LinkDataOneOf {
|
|
597
598
|
/** The absolute URL for the linked document. */
|
|
598
599
|
url?: string;
|
|
599
600
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -612,13 +613,13 @@ interface Link extends LinkDataOneOf {
|
|
|
612
613
|
customData?: string | null;
|
|
613
614
|
}
|
|
614
615
|
/** @oneof */
|
|
615
|
-
interface LinkDataOneOf {
|
|
616
|
+
export interface LinkDataOneOf {
|
|
616
617
|
/** The absolute URL for the linked document. */
|
|
617
618
|
url?: string;
|
|
618
619
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
619
620
|
anchor?: string;
|
|
620
621
|
}
|
|
621
|
-
declare enum Target {
|
|
622
|
+
export declare enum Target {
|
|
622
623
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
623
624
|
SELF = "SELF",
|
|
624
625
|
/** Opens the linked document in a new window or tab */
|
|
@@ -628,7 +629,7 @@ declare enum Target {
|
|
|
628
629
|
/** Opens the linked document in the full body of the window */
|
|
629
630
|
TOP = "TOP"
|
|
630
631
|
}
|
|
631
|
-
interface Rel {
|
|
632
|
+
export interface Rel {
|
|
632
633
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
633
634
|
nofollow?: boolean | null;
|
|
634
635
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -638,17 +639,17 @@ interface Rel {
|
|
|
638
639
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
639
640
|
noreferrer?: boolean | null;
|
|
640
641
|
}
|
|
641
|
-
interface CodeBlockData {
|
|
642
|
+
export interface CodeBlockData {
|
|
642
643
|
/** Styling for the code block's text. */
|
|
643
644
|
textStyle?: TextStyle;
|
|
644
645
|
}
|
|
645
|
-
interface TextStyle {
|
|
646
|
+
export interface TextStyle {
|
|
646
647
|
/** Text alignment. Defaults to `AUTO`. */
|
|
647
648
|
textAlignment?: TextAlignment;
|
|
648
649
|
/** 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. */
|
|
649
650
|
lineHeight?: string | null;
|
|
650
651
|
}
|
|
651
|
-
declare enum TextAlignment {
|
|
652
|
+
export declare enum TextAlignment {
|
|
652
653
|
/** browser default, eqivalent to `initial` */
|
|
653
654
|
AUTO = "AUTO",
|
|
654
655
|
/** Left align */
|
|
@@ -660,7 +661,7 @@ declare enum TextAlignment {
|
|
|
660
661
|
/** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
|
|
661
662
|
JUSTIFY = "JUSTIFY"
|
|
662
663
|
}
|
|
663
|
-
interface DividerData {
|
|
664
|
+
export interface DividerData {
|
|
664
665
|
/** Styling for the divider's container. */
|
|
665
666
|
containerData?: PluginContainerData;
|
|
666
667
|
/** Divider line style. */
|
|
@@ -670,7 +671,7 @@ interface DividerData {
|
|
|
670
671
|
/** Divider alignment. */
|
|
671
672
|
alignment?: Alignment;
|
|
672
673
|
}
|
|
673
|
-
declare enum LineStyle {
|
|
674
|
+
export declare enum LineStyle {
|
|
674
675
|
/** Single Line */
|
|
675
676
|
SINGLE = "SINGLE",
|
|
676
677
|
/** Double Line */
|
|
@@ -680,7 +681,7 @@ declare enum LineStyle {
|
|
|
680
681
|
/** Dotted Line */
|
|
681
682
|
DOTTED = "DOTTED"
|
|
682
683
|
}
|
|
683
|
-
declare enum Width {
|
|
684
|
+
export declare enum Width {
|
|
684
685
|
/** Large line */
|
|
685
686
|
LARGE = "LARGE",
|
|
686
687
|
/** Medium line */
|
|
@@ -688,7 +689,7 @@ declare enum Width {
|
|
|
688
689
|
/** Small line */
|
|
689
690
|
SMALL = "SMALL"
|
|
690
691
|
}
|
|
691
|
-
declare enum Alignment {
|
|
692
|
+
export declare enum Alignment {
|
|
692
693
|
/** Center alignment */
|
|
693
694
|
CENTER = "CENTER",
|
|
694
695
|
/** Left alignment */
|
|
@@ -696,7 +697,7 @@ declare enum Alignment {
|
|
|
696
697
|
/** Right alignment */
|
|
697
698
|
RIGHT = "RIGHT"
|
|
698
699
|
}
|
|
699
|
-
interface FileData {
|
|
700
|
+
export interface FileData {
|
|
700
701
|
/** Styling for the file's container. */
|
|
701
702
|
containerData?: PluginContainerData;
|
|
702
703
|
/** The source for the file's data. */
|
|
@@ -719,7 +720,7 @@ interface FileData {
|
|
|
719
720
|
/** File size in KB. */
|
|
720
721
|
sizeInKb?: string | null;
|
|
721
722
|
}
|
|
722
|
-
declare enum ViewMode {
|
|
723
|
+
export declare enum ViewMode {
|
|
723
724
|
/** No PDF view */
|
|
724
725
|
NONE = "NONE",
|
|
725
726
|
/** Full PDF view */
|
|
@@ -727,7 +728,7 @@ declare enum ViewMode {
|
|
|
727
728
|
/** Mini PDF view */
|
|
728
729
|
MINI = "MINI"
|
|
729
730
|
}
|
|
730
|
-
interface FileSource extends FileSourceDataOneOf {
|
|
731
|
+
export interface FileSource extends FileSourceDataOneOf {
|
|
731
732
|
/** The absolute URL for the file's source. */
|
|
732
733
|
url?: string | null;
|
|
733
734
|
/**
|
|
@@ -741,7 +742,7 @@ interface FileSource extends FileSourceDataOneOf {
|
|
|
741
742
|
private?: boolean | null;
|
|
742
743
|
}
|
|
743
744
|
/** @oneof */
|
|
744
|
-
interface FileSourceDataOneOf {
|
|
745
|
+
export interface FileSourceDataOneOf {
|
|
745
746
|
/** The absolute URL for the file's source. */
|
|
746
747
|
url?: string | null;
|
|
747
748
|
/**
|
|
@@ -752,7 +753,7 @@ interface FileSourceDataOneOf {
|
|
|
752
753
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
753
754
|
_id?: string | null;
|
|
754
755
|
}
|
|
755
|
-
interface PDFSettings {
|
|
756
|
+
export interface PDFSettings {
|
|
756
757
|
/**
|
|
757
758
|
* PDF view mode. One of the following:
|
|
758
759
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -765,7 +766,7 @@ interface PDFSettings {
|
|
|
765
766
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
766
767
|
disablePrint?: boolean | null;
|
|
767
768
|
}
|
|
768
|
-
interface GalleryData {
|
|
769
|
+
export interface GalleryData {
|
|
769
770
|
/** Styling for the gallery's container. */
|
|
770
771
|
containerData?: PluginContainerData;
|
|
771
772
|
/** The items in the gallery. */
|
|
@@ -777,7 +778,7 @@ interface GalleryData {
|
|
|
777
778
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
778
779
|
disableDownload?: boolean | null;
|
|
779
780
|
}
|
|
780
|
-
interface V1Media {
|
|
781
|
+
export interface V1Media {
|
|
781
782
|
/** The source for the media's data. */
|
|
782
783
|
src?: FileSource;
|
|
783
784
|
/** Media width in pixels. */
|
|
@@ -787,19 +788,19 @@ interface V1Media {
|
|
|
787
788
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
788
789
|
duration?: number | null;
|
|
789
790
|
}
|
|
790
|
-
interface Image {
|
|
791
|
+
export interface Image {
|
|
791
792
|
/** Image file details. */
|
|
792
793
|
media?: V1Media;
|
|
793
794
|
/** Link details for images that are links. */
|
|
794
795
|
link?: Link;
|
|
795
796
|
}
|
|
796
|
-
interface Video {
|
|
797
|
+
export interface Video {
|
|
797
798
|
/** Video file details. */
|
|
798
799
|
media?: V1Media;
|
|
799
800
|
/** Video thumbnail file details. */
|
|
800
801
|
thumbnail?: V1Media;
|
|
801
802
|
}
|
|
802
|
-
interface Item extends ItemDataOneOf {
|
|
803
|
+
export interface Item extends ItemDataOneOf {
|
|
803
804
|
/** An image item. */
|
|
804
805
|
image?: Image;
|
|
805
806
|
/** A video item. */
|
|
@@ -810,13 +811,13 @@ interface Item extends ItemDataOneOf {
|
|
|
810
811
|
altText?: string | null;
|
|
811
812
|
}
|
|
812
813
|
/** @oneof */
|
|
813
|
-
interface ItemDataOneOf {
|
|
814
|
+
export interface ItemDataOneOf {
|
|
814
815
|
/** An image item. */
|
|
815
816
|
image?: Image;
|
|
816
817
|
/** A video item. */
|
|
817
818
|
video?: Video;
|
|
818
819
|
}
|
|
819
|
-
interface GalleryOptions {
|
|
820
|
+
export interface GalleryOptions {
|
|
820
821
|
/** Gallery layout. */
|
|
821
822
|
layout?: Layout;
|
|
822
823
|
/** Styling for gallery items. */
|
|
@@ -824,7 +825,7 @@ interface GalleryOptions {
|
|
|
824
825
|
/** Styling for gallery thumbnail images. */
|
|
825
826
|
thumbnails?: Thumbnails;
|
|
826
827
|
}
|
|
827
|
-
declare enum LayoutType {
|
|
828
|
+
export declare enum LayoutType {
|
|
828
829
|
/** Collage type */
|
|
829
830
|
COLLAGE = "COLLAGE",
|
|
830
831
|
/** Masonry type */
|
|
@@ -846,19 +847,19 @@ declare enum LayoutType {
|
|
|
846
847
|
/** Fullsize images type */
|
|
847
848
|
FULLSIZE = "FULLSIZE"
|
|
848
849
|
}
|
|
849
|
-
declare enum Orientation {
|
|
850
|
+
export declare enum Orientation {
|
|
850
851
|
/** Rows Orientation */
|
|
851
852
|
ROWS = "ROWS",
|
|
852
853
|
/** Columns Orientation */
|
|
853
854
|
COLUMNS = "COLUMNS"
|
|
854
855
|
}
|
|
855
|
-
declare enum Crop {
|
|
856
|
+
export declare enum Crop {
|
|
856
857
|
/** Crop to fill */
|
|
857
858
|
FILL = "FILL",
|
|
858
859
|
/** Crop to fit */
|
|
859
860
|
FIT = "FIT"
|
|
860
861
|
}
|
|
861
|
-
declare enum ThumbnailsAlignment {
|
|
862
|
+
export declare enum ThumbnailsAlignment {
|
|
862
863
|
/** Top alignment */
|
|
863
864
|
TOP = "TOP",
|
|
864
865
|
/** Right alignment */
|
|
@@ -870,7 +871,7 @@ declare enum ThumbnailsAlignment {
|
|
|
870
871
|
/** No thumbnail */
|
|
871
872
|
NONE = "NONE"
|
|
872
873
|
}
|
|
873
|
-
interface Layout {
|
|
874
|
+
export interface Layout {
|
|
874
875
|
/** Gallery layout type. */
|
|
875
876
|
type?: LayoutType;
|
|
876
877
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -882,7 +883,7 @@ interface Layout {
|
|
|
882
883
|
/** The number of columns to display on mobile screens. */
|
|
883
884
|
mobileNumberOfColumns?: number | null;
|
|
884
885
|
}
|
|
885
|
-
interface ItemStyle {
|
|
886
|
+
export interface ItemStyle {
|
|
886
887
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
887
888
|
targetSize?: number | null;
|
|
888
889
|
/** Item ratio */
|
|
@@ -892,13 +893,13 @@ interface ItemStyle {
|
|
|
892
893
|
/** The spacing between items in pixels. */
|
|
893
894
|
spacing?: number | null;
|
|
894
895
|
}
|
|
895
|
-
interface Thumbnails {
|
|
896
|
+
export interface Thumbnails {
|
|
896
897
|
/** Thumbnail alignment. */
|
|
897
898
|
placement?: ThumbnailsAlignment;
|
|
898
899
|
/** Spacing between thumbnails in pixels. */
|
|
899
900
|
spacing?: number | null;
|
|
900
901
|
}
|
|
901
|
-
interface GIFData {
|
|
902
|
+
export interface GIFData {
|
|
902
903
|
/** Styling for the GIF's container. */
|
|
903
904
|
containerData?: PluginContainerData;
|
|
904
905
|
/** The source of the full size GIF. */
|
|
@@ -912,7 +913,7 @@ interface GIFData {
|
|
|
912
913
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
913
914
|
gifType?: GIFType;
|
|
914
915
|
}
|
|
915
|
-
interface GIF {
|
|
916
|
+
export interface GIF {
|
|
916
917
|
/**
|
|
917
918
|
* GIF format URL.
|
|
918
919
|
* @format WEB_URL
|
|
@@ -929,11 +930,11 @@ interface GIF {
|
|
|
929
930
|
*/
|
|
930
931
|
still?: string | null;
|
|
931
932
|
}
|
|
932
|
-
declare enum GIFType {
|
|
933
|
+
export declare enum GIFType {
|
|
933
934
|
NORMAL = "NORMAL",
|
|
934
935
|
STICKER = "STICKER"
|
|
935
936
|
}
|
|
936
|
-
interface HeadingData {
|
|
937
|
+
export interface HeadingData {
|
|
937
938
|
/** Heading level from 1-6. */
|
|
938
939
|
level?: number;
|
|
939
940
|
/** Styling for the heading text. */
|
|
@@ -941,7 +942,7 @@ interface HeadingData {
|
|
|
941
942
|
/** Indentation level from 1-4. */
|
|
942
943
|
indentation?: number | null;
|
|
943
944
|
}
|
|
944
|
-
interface HTMLData extends HTMLDataDataOneOf {
|
|
945
|
+
export interface HTMLData extends HTMLDataDataOneOf {
|
|
945
946
|
/** The URL for the HTML code for the node. */
|
|
946
947
|
url?: string;
|
|
947
948
|
/** The HTML code for the node. */
|
|
@@ -959,7 +960,7 @@ interface HTMLData extends HTMLDataDataOneOf {
|
|
|
959
960
|
autoHeight?: boolean | null;
|
|
960
961
|
}
|
|
961
962
|
/** @oneof */
|
|
962
|
-
interface HTMLDataDataOneOf {
|
|
963
|
+
export interface HTMLDataDataOneOf {
|
|
963
964
|
/** The URL for the HTML code for the node. */
|
|
964
965
|
url?: string;
|
|
965
966
|
/** The HTML code for the node. */
|
|
@@ -970,11 +971,11 @@ interface HTMLDataDataOneOf {
|
|
|
970
971
|
*/
|
|
971
972
|
isAdsense?: boolean | null;
|
|
972
973
|
}
|
|
973
|
-
declare enum Source {
|
|
974
|
+
export declare enum Source {
|
|
974
975
|
HTML = "HTML",
|
|
975
976
|
ADSENSE = "ADSENSE"
|
|
976
977
|
}
|
|
977
|
-
interface ImageData {
|
|
978
|
+
export interface ImageData {
|
|
978
979
|
/** Styling for the image's container. */
|
|
979
980
|
containerData?: PluginContainerData;
|
|
980
981
|
/** Image file details. */
|
|
@@ -997,7 +998,7 @@ interface ImageData {
|
|
|
997
998
|
/** Styling for the image. */
|
|
998
999
|
styles?: ImageDataStyles;
|
|
999
1000
|
}
|
|
1000
|
-
interface StylesBorder {
|
|
1001
|
+
export interface StylesBorder {
|
|
1001
1002
|
/** Border width in pixels. */
|
|
1002
1003
|
width?: number | null;
|
|
1003
1004
|
/**
|
|
@@ -1008,11 +1009,11 @@ interface StylesBorder {
|
|
|
1008
1009
|
/** Border radius in pixels. */
|
|
1009
1010
|
radius?: number | null;
|
|
1010
1011
|
}
|
|
1011
|
-
interface ImageDataStyles {
|
|
1012
|
+
export interface ImageDataStyles {
|
|
1012
1013
|
/** Border attributes. */
|
|
1013
1014
|
border?: StylesBorder;
|
|
1014
1015
|
}
|
|
1015
|
-
interface LinkPreviewData {
|
|
1016
|
+
export interface LinkPreviewData {
|
|
1016
1017
|
/** Styling for the link preview's container. */
|
|
1017
1018
|
containerData?: PluginContainerData;
|
|
1018
1019
|
/** Link details. */
|
|
@@ -1028,7 +1029,7 @@ interface LinkPreviewData {
|
|
|
1028
1029
|
/** Styling for the link preview. */
|
|
1029
1030
|
styles?: LinkPreviewDataStyles;
|
|
1030
1031
|
}
|
|
1031
|
-
declare enum Position {
|
|
1032
|
+
export declare enum Position {
|
|
1032
1033
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
1033
1034
|
START = "START",
|
|
1034
1035
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -1038,7 +1039,7 @@ declare enum Position {
|
|
|
1038
1039
|
/** Thumbnail hidden and not displayed */
|
|
1039
1040
|
HIDDEN = "HIDDEN"
|
|
1040
1041
|
}
|
|
1041
|
-
interface LinkPreviewDataStyles {
|
|
1042
|
+
export interface LinkPreviewDataStyles {
|
|
1042
1043
|
/**
|
|
1043
1044
|
* Background color as a hexadecimal value.
|
|
1044
1045
|
* @format COLOR_HEX
|
|
@@ -1071,13 +1072,13 @@ interface LinkPreviewDataStyles {
|
|
|
1071
1072
|
/** Position of thumbnail. Defaults to `START`. */
|
|
1072
1073
|
thumbnailPosition?: Position;
|
|
1073
1074
|
}
|
|
1074
|
-
interface MapData {
|
|
1075
|
+
export interface MapData {
|
|
1075
1076
|
/** Styling for the map's container. */
|
|
1076
1077
|
containerData?: PluginContainerData;
|
|
1077
1078
|
/** Map settings. */
|
|
1078
1079
|
mapSettings?: MapSettings;
|
|
1079
1080
|
}
|
|
1080
|
-
interface MapSettings {
|
|
1081
|
+
export interface MapSettings {
|
|
1081
1082
|
/** The address to display on the map. */
|
|
1082
1083
|
address?: string | null;
|
|
1083
1084
|
/** Sets whether the map is draggable. */
|
|
@@ -1101,7 +1102,7 @@ interface MapSettings {
|
|
|
1101
1102
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
1102
1103
|
mapType?: MapType;
|
|
1103
1104
|
}
|
|
1104
|
-
declare enum MapType {
|
|
1105
|
+
export declare enum MapType {
|
|
1105
1106
|
/** Roadmap map type */
|
|
1106
1107
|
ROADMAP = "ROADMAP",
|
|
1107
1108
|
/** Satellite map type */
|
|
@@ -1111,7 +1112,7 @@ declare enum MapType {
|
|
|
1111
1112
|
/** Terrain map type */
|
|
1112
1113
|
TERRAIN = "TERRAIN"
|
|
1113
1114
|
}
|
|
1114
|
-
interface ParagraphData {
|
|
1115
|
+
export interface ParagraphData {
|
|
1115
1116
|
/** Styling for the paragraph text. */
|
|
1116
1117
|
textStyle?: TextStyle;
|
|
1117
1118
|
/** Indentation level from 1-4. */
|
|
@@ -1119,7 +1120,7 @@ interface ParagraphData {
|
|
|
1119
1120
|
/** Paragraph level */
|
|
1120
1121
|
level?: number | null;
|
|
1121
1122
|
}
|
|
1122
|
-
interface PollData {
|
|
1123
|
+
export interface PollData {
|
|
1123
1124
|
/** Styling for the poll's container. */
|
|
1124
1125
|
containerData?: PluginContainerData;
|
|
1125
1126
|
/** Poll data. */
|
|
@@ -1129,7 +1130,7 @@ interface PollData {
|
|
|
1129
1130
|
/** Styling for the poll and voting options. */
|
|
1130
1131
|
design?: Design;
|
|
1131
1132
|
}
|
|
1132
|
-
declare enum ViewRole {
|
|
1133
|
+
export declare enum ViewRole {
|
|
1133
1134
|
/** Only Poll creator can view the results */
|
|
1134
1135
|
CREATOR = "CREATOR",
|
|
1135
1136
|
/** Anyone who voted can see the results */
|
|
@@ -1137,13 +1138,13 @@ declare enum ViewRole {
|
|
|
1137
1138
|
/** Anyone can see the results, even if one didn't vote */
|
|
1138
1139
|
EVERYONE = "EVERYONE"
|
|
1139
1140
|
}
|
|
1140
|
-
declare enum VoteRole {
|
|
1141
|
+
export declare enum VoteRole {
|
|
1141
1142
|
/** Logged in member */
|
|
1142
1143
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
1143
1144
|
/** Anyone */
|
|
1144
1145
|
ALL = "ALL"
|
|
1145
1146
|
}
|
|
1146
|
-
interface Permissions {
|
|
1147
|
+
export interface Permissions {
|
|
1147
1148
|
/** Sets who can view the poll results. */
|
|
1148
1149
|
view?: ViewRole;
|
|
1149
1150
|
/** Sets who can vote. */
|
|
@@ -1151,7 +1152,7 @@ interface Permissions {
|
|
|
1151
1152
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1152
1153
|
allowMultipleVotes?: boolean | null;
|
|
1153
1154
|
}
|
|
1154
|
-
interface Option {
|
|
1155
|
+
export interface Option {
|
|
1155
1156
|
/** Option ID. */
|
|
1156
1157
|
_id?: string | null;
|
|
1157
1158
|
/** Option title. */
|
|
@@ -1159,7 +1160,7 @@ interface Option {
|
|
|
1159
1160
|
/** The image displayed with the option. */
|
|
1160
1161
|
image?: V1Media;
|
|
1161
1162
|
}
|
|
1162
|
-
interface PollSettings {
|
|
1163
|
+
export interface PollSettings {
|
|
1163
1164
|
/** Permissions settings for voting. */
|
|
1164
1165
|
permissions?: Permissions;
|
|
1165
1166
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -1167,19 +1168,19 @@ interface PollSettings {
|
|
|
1167
1168
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
1168
1169
|
showVotesCount?: boolean | null;
|
|
1169
1170
|
}
|
|
1170
|
-
declare enum PollLayoutType {
|
|
1171
|
+
export declare enum PollLayoutType {
|
|
1171
1172
|
/** List */
|
|
1172
1173
|
LIST = "LIST",
|
|
1173
1174
|
/** Grid */
|
|
1174
1175
|
GRID = "GRID"
|
|
1175
1176
|
}
|
|
1176
|
-
declare enum PollLayoutDirection {
|
|
1177
|
+
export declare enum PollLayoutDirection {
|
|
1177
1178
|
/** Left-to-right */
|
|
1178
1179
|
LTR = "LTR",
|
|
1179
1180
|
/** Right-to-left */
|
|
1180
1181
|
RTL = "RTL"
|
|
1181
1182
|
}
|
|
1182
|
-
interface PollLayout {
|
|
1183
|
+
export interface PollLayout {
|
|
1183
1184
|
/** The layout for displaying the voting options. */
|
|
1184
1185
|
type?: PollLayoutType;
|
|
1185
1186
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -1187,11 +1188,11 @@ interface PollLayout {
|
|
|
1187
1188
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1188
1189
|
enableImage?: boolean | null;
|
|
1189
1190
|
}
|
|
1190
|
-
interface OptionLayout {
|
|
1191
|
+
export interface OptionLayout {
|
|
1191
1192
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
1192
1193
|
enableImage?: boolean | null;
|
|
1193
1194
|
}
|
|
1194
|
-
declare enum BackgroundType {
|
|
1195
|
+
export declare enum BackgroundType {
|
|
1195
1196
|
/** Color background type */
|
|
1196
1197
|
COLOR = "COLOR",
|
|
1197
1198
|
/** Image background type */
|
|
@@ -1199,7 +1200,7 @@ declare enum BackgroundType {
|
|
|
1199
1200
|
/** Gradiant background type */
|
|
1200
1201
|
GRADIENT = "GRADIENT"
|
|
1201
1202
|
}
|
|
1202
|
-
interface Gradient {
|
|
1203
|
+
export interface Gradient {
|
|
1203
1204
|
/** The gradient angle in degrees. */
|
|
1204
1205
|
angle?: number | null;
|
|
1205
1206
|
/**
|
|
@@ -1213,7 +1214,7 @@ interface Gradient {
|
|
|
1213
1214
|
*/
|
|
1214
1215
|
lastColor?: string | null;
|
|
1215
1216
|
}
|
|
1216
|
-
interface Background extends BackgroundBackgroundOneOf {
|
|
1217
|
+
export interface Background extends BackgroundBackgroundOneOf {
|
|
1217
1218
|
/**
|
|
1218
1219
|
* The background color as a hexademical value.
|
|
1219
1220
|
* @format COLOR_HEX
|
|
@@ -1227,7 +1228,7 @@ interface Background extends BackgroundBackgroundOneOf {
|
|
|
1227
1228
|
type?: BackgroundType;
|
|
1228
1229
|
}
|
|
1229
1230
|
/** @oneof */
|
|
1230
|
-
interface BackgroundBackgroundOneOf {
|
|
1231
|
+
export interface BackgroundBackgroundOneOf {
|
|
1231
1232
|
/**
|
|
1232
1233
|
* The background color as a hexademical value.
|
|
1233
1234
|
* @format COLOR_HEX
|
|
@@ -1238,17 +1239,17 @@ interface BackgroundBackgroundOneOf {
|
|
|
1238
1239
|
/** Details for a gradient background. */
|
|
1239
1240
|
gradient?: Gradient;
|
|
1240
1241
|
}
|
|
1241
|
-
interface PollDesign {
|
|
1242
|
+
export interface PollDesign {
|
|
1242
1243
|
/** Background styling. */
|
|
1243
1244
|
background?: Background;
|
|
1244
1245
|
/** Border radius in pixels. */
|
|
1245
1246
|
borderRadius?: number | null;
|
|
1246
1247
|
}
|
|
1247
|
-
interface OptionDesign {
|
|
1248
|
+
export interface OptionDesign {
|
|
1248
1249
|
/** Border radius in pixels. */
|
|
1249
1250
|
borderRadius?: number | null;
|
|
1250
1251
|
}
|
|
1251
|
-
interface Poll {
|
|
1252
|
+
export interface Poll {
|
|
1252
1253
|
/** Poll ID. */
|
|
1253
1254
|
_id?: string | null;
|
|
1254
1255
|
/** Poll title. */
|
|
@@ -1262,26 +1263,26 @@ interface Poll {
|
|
|
1262
1263
|
/** The poll's permissions and display settings. */
|
|
1263
1264
|
settings?: PollSettings;
|
|
1264
1265
|
}
|
|
1265
|
-
interface PollDataLayout {
|
|
1266
|
+
export interface PollDataLayout {
|
|
1266
1267
|
/** Poll layout settings. */
|
|
1267
1268
|
poll?: PollLayout;
|
|
1268
1269
|
/** Voting otpions layout settings. */
|
|
1269
1270
|
options?: OptionLayout;
|
|
1270
1271
|
}
|
|
1271
|
-
interface Design {
|
|
1272
|
+
export interface Design {
|
|
1272
1273
|
/** Styling for the poll. */
|
|
1273
1274
|
poll?: PollDesign;
|
|
1274
1275
|
/** Styling for voting options. */
|
|
1275
1276
|
options?: OptionDesign;
|
|
1276
1277
|
}
|
|
1277
|
-
interface TextData {
|
|
1278
|
+
export interface TextData {
|
|
1278
1279
|
/** The text to apply decorations to. */
|
|
1279
1280
|
text?: string;
|
|
1280
1281
|
/** The decorations to apply. */
|
|
1281
1282
|
decorations?: Decoration[];
|
|
1282
1283
|
}
|
|
1283
1284
|
/** Adds appearence changes to text */
|
|
1284
|
-
interface Decoration extends DecorationDataOneOf {
|
|
1285
|
+
export interface Decoration extends DecorationDataOneOf {
|
|
1285
1286
|
/** Data for an anchor link decoration. */
|
|
1286
1287
|
anchorData?: AnchorData;
|
|
1287
1288
|
/** Data for a color decoration. */
|
|
@@ -1306,7 +1307,7 @@ interface Decoration extends DecorationDataOneOf {
|
|
|
1306
1307
|
type?: DecorationType;
|
|
1307
1308
|
}
|
|
1308
1309
|
/** @oneof */
|
|
1309
|
-
interface DecorationDataOneOf {
|
|
1310
|
+
export interface DecorationDataOneOf {
|
|
1310
1311
|
/** Data for an anchor link decoration. */
|
|
1311
1312
|
anchorData?: AnchorData;
|
|
1312
1313
|
/** Data for a color decoration. */
|
|
@@ -1328,7 +1329,7 @@ interface DecorationDataOneOf {
|
|
|
1328
1329
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1329
1330
|
strikethroughData?: boolean | null;
|
|
1330
1331
|
}
|
|
1331
|
-
declare enum DecorationType {
|
|
1332
|
+
export declare enum DecorationType {
|
|
1332
1333
|
BOLD = "BOLD",
|
|
1333
1334
|
ITALIC = "ITALIC",
|
|
1334
1335
|
UNDERLINE = "UNDERLINE",
|
|
@@ -1341,21 +1342,21 @@ declare enum DecorationType {
|
|
|
1341
1342
|
EXTERNAL = "EXTERNAL",
|
|
1342
1343
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1343
1344
|
}
|
|
1344
|
-
interface AnchorData {
|
|
1345
|
+
export interface AnchorData {
|
|
1345
1346
|
/** The target node's ID. */
|
|
1346
1347
|
anchor?: string;
|
|
1347
1348
|
}
|
|
1348
|
-
interface ColorData {
|
|
1349
|
+
export interface ColorData {
|
|
1349
1350
|
/** The text's background color as a hexadecimal value. */
|
|
1350
1351
|
background?: string | null;
|
|
1351
1352
|
/** The text's foreground color as a hexadecimal value. */
|
|
1352
1353
|
foreground?: string | null;
|
|
1353
1354
|
}
|
|
1354
|
-
interface LinkData {
|
|
1355
|
+
export interface LinkData {
|
|
1355
1356
|
/** Link details. */
|
|
1356
1357
|
link?: Link;
|
|
1357
1358
|
}
|
|
1358
|
-
interface MentionData {
|
|
1359
|
+
export interface MentionData {
|
|
1359
1360
|
/** The mentioned user's name. */
|
|
1360
1361
|
name?: string;
|
|
1361
1362
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -1363,21 +1364,21 @@ interface MentionData {
|
|
|
1363
1364
|
/** Mentioned user's ID. */
|
|
1364
1365
|
_id?: string | null;
|
|
1365
1366
|
}
|
|
1366
|
-
interface FontSizeData {
|
|
1367
|
+
export interface FontSizeData {
|
|
1367
1368
|
/** The units used for the font size. */
|
|
1368
1369
|
unit?: FontType;
|
|
1369
1370
|
/** Font size value. */
|
|
1370
1371
|
value?: number | null;
|
|
1371
1372
|
}
|
|
1372
|
-
declare enum FontType {
|
|
1373
|
+
export declare enum FontType {
|
|
1373
1374
|
PX = "PX",
|
|
1374
1375
|
EM = "EM"
|
|
1375
1376
|
}
|
|
1376
|
-
interface SpoilerData {
|
|
1377
|
+
export interface SpoilerData {
|
|
1377
1378
|
/** Spoiler ID. */
|
|
1378
1379
|
_id?: string | null;
|
|
1379
1380
|
}
|
|
1380
|
-
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1381
|
+
export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1381
1382
|
/** Data for embedded Wix Bookings content. */
|
|
1382
1383
|
bookingData?: BookingData;
|
|
1383
1384
|
/** Data for embedded Wix Events content. */
|
|
@@ -1399,28 +1400,28 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1399
1400
|
image?: V1Media;
|
|
1400
1401
|
}
|
|
1401
1402
|
/** @oneof */
|
|
1402
|
-
interface AppEmbedDataAppDataOneOf {
|
|
1403
|
+
export interface AppEmbedDataAppDataOneOf {
|
|
1403
1404
|
/** Data for embedded Wix Bookings content. */
|
|
1404
1405
|
bookingData?: BookingData;
|
|
1405
1406
|
/** Data for embedded Wix Events content. */
|
|
1406
1407
|
eventData?: EventData;
|
|
1407
1408
|
}
|
|
1408
|
-
declare enum AppType {
|
|
1409
|
+
export declare enum AppType {
|
|
1409
1410
|
PRODUCT = "PRODUCT",
|
|
1410
1411
|
EVENT = "EVENT",
|
|
1411
1412
|
BOOKING = "BOOKING"
|
|
1412
1413
|
}
|
|
1413
|
-
interface BookingData {
|
|
1414
|
+
export interface BookingData {
|
|
1414
1415
|
/** Booking duration in minutes. */
|
|
1415
1416
|
durations?: string | null;
|
|
1416
1417
|
}
|
|
1417
|
-
interface EventData {
|
|
1418
|
+
export interface EventData {
|
|
1418
1419
|
/** Event schedule. */
|
|
1419
1420
|
scheduling?: string | null;
|
|
1420
1421
|
/** Event location. */
|
|
1421
1422
|
location?: string | null;
|
|
1422
1423
|
}
|
|
1423
|
-
interface VideoData {
|
|
1424
|
+
export interface VideoData {
|
|
1424
1425
|
/** Styling for the video's container. */
|
|
1425
1426
|
containerData?: PluginContainerData;
|
|
1426
1427
|
/** Video details. */
|
|
@@ -1434,7 +1435,7 @@ interface VideoData {
|
|
|
1434
1435
|
/** Video options. */
|
|
1435
1436
|
options?: PlaybackOptions;
|
|
1436
1437
|
}
|
|
1437
|
-
interface PlaybackOptions {
|
|
1438
|
+
export interface PlaybackOptions {
|
|
1438
1439
|
/** Sets whether the media will automatically start playing. */
|
|
1439
1440
|
autoPlay?: boolean | null;
|
|
1440
1441
|
/** Sets whether media's will be looped. */
|
|
@@ -1442,7 +1443,7 @@ interface PlaybackOptions {
|
|
|
1442
1443
|
/** Sets whether media's controls will be shown. */
|
|
1443
1444
|
showControls?: boolean | null;
|
|
1444
1445
|
}
|
|
1445
|
-
interface EmbedData {
|
|
1446
|
+
export interface EmbedData {
|
|
1446
1447
|
/** Styling for the oEmbed node's container. */
|
|
1447
1448
|
containerData?: PluginContainerData;
|
|
1448
1449
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -1450,7 +1451,7 @@ interface EmbedData {
|
|
|
1450
1451
|
/** Origin asset source. */
|
|
1451
1452
|
src?: string | null;
|
|
1452
1453
|
}
|
|
1453
|
-
interface Oembed {
|
|
1454
|
+
export interface Oembed {
|
|
1454
1455
|
/** The resource type. */
|
|
1455
1456
|
type?: string | null;
|
|
1456
1457
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -1482,7 +1483,7 @@ interface Oembed {
|
|
|
1482
1483
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
1483
1484
|
version?: string | null;
|
|
1484
1485
|
}
|
|
1485
|
-
interface CollapsibleListData {
|
|
1486
|
+
export interface CollapsibleListData {
|
|
1486
1487
|
/** Styling for the collapsible list's container. */
|
|
1487
1488
|
containerData?: PluginContainerData;
|
|
1488
1489
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -1494,7 +1495,7 @@ interface CollapsibleListData {
|
|
|
1494
1495
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1495
1496
|
isQapageData?: boolean | null;
|
|
1496
1497
|
}
|
|
1497
|
-
declare enum InitialExpandedItems {
|
|
1498
|
+
export declare enum InitialExpandedItems {
|
|
1498
1499
|
/** First item will be expended initally */
|
|
1499
1500
|
FIRST = "FIRST",
|
|
1500
1501
|
/** All items will expended initally */
|
|
@@ -1502,13 +1503,13 @@ declare enum InitialExpandedItems {
|
|
|
1502
1503
|
/** All items collapsed initally */
|
|
1503
1504
|
NONE = "NONE"
|
|
1504
1505
|
}
|
|
1505
|
-
declare enum Direction {
|
|
1506
|
+
export declare enum Direction {
|
|
1506
1507
|
/** Left-to-right */
|
|
1507
1508
|
LTR = "LTR",
|
|
1508
1509
|
/** Right-to-left */
|
|
1509
1510
|
RTL = "RTL"
|
|
1510
1511
|
}
|
|
1511
|
-
interface TableData {
|
|
1512
|
+
export interface TableData {
|
|
1512
1513
|
/** Styling for the table's container. */
|
|
1513
1514
|
containerData?: PluginContainerData;
|
|
1514
1515
|
/** The table's dimensions. */
|
|
@@ -1523,7 +1524,7 @@ interface TableData {
|
|
|
1523
1524
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1524
1525
|
columnHeader?: boolean | null;
|
|
1525
1526
|
}
|
|
1526
|
-
interface Dimensions {
|
|
1527
|
+
export interface Dimensions {
|
|
1527
1528
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
1528
1529
|
colsWidthRatio?: number[];
|
|
1529
1530
|
/** An array representing the height of each row in pixels. */
|
|
@@ -1531,13 +1532,13 @@ interface Dimensions {
|
|
|
1531
1532
|
/** An array representing the minimum width of each column in pixels. */
|
|
1532
1533
|
colsMinWidth?: number[];
|
|
1533
1534
|
}
|
|
1534
|
-
interface TableCellData {
|
|
1535
|
+
export interface TableCellData {
|
|
1535
1536
|
/** Styling for the cell's background color and text alignment. */
|
|
1536
1537
|
cellStyle?: CellStyle;
|
|
1537
1538
|
/** The cell's border colors. */
|
|
1538
1539
|
borderColors?: BorderColors;
|
|
1539
1540
|
}
|
|
1540
|
-
declare enum VerticalAlignment {
|
|
1541
|
+
export declare enum VerticalAlignment {
|
|
1541
1542
|
/** Top alignment */
|
|
1542
1543
|
TOP = "TOP",
|
|
1543
1544
|
/** Middle alignment */
|
|
@@ -1545,7 +1546,7 @@ declare enum VerticalAlignment {
|
|
|
1545
1546
|
/** Bottom alignment */
|
|
1546
1547
|
BOTTOM = "BOTTOM"
|
|
1547
1548
|
}
|
|
1548
|
-
interface CellStyle {
|
|
1549
|
+
export interface CellStyle {
|
|
1549
1550
|
/** Vertical alignment for the cell's text. */
|
|
1550
1551
|
verticalAlignment?: VerticalAlignment;
|
|
1551
1552
|
/**
|
|
@@ -1554,7 +1555,7 @@ interface CellStyle {
|
|
|
1554
1555
|
*/
|
|
1555
1556
|
backgroundColor?: string | null;
|
|
1556
1557
|
}
|
|
1557
|
-
interface BorderColors {
|
|
1558
|
+
export interface BorderColors {
|
|
1558
1559
|
/**
|
|
1559
1560
|
* Left border color as a hexadecimal value.
|
|
1560
1561
|
* @format COLOR_HEX
|
|
@@ -1582,7 +1583,7 @@ interface BorderColors {
|
|
|
1582
1583
|
*
|
|
1583
1584
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
1584
1585
|
*/
|
|
1585
|
-
declare enum NullValue {
|
|
1586
|
+
export declare enum NullValue {
|
|
1586
1587
|
/** Null value. */
|
|
1587
1588
|
NULL_VALUE = "NULL_VALUE"
|
|
1588
1589
|
}
|
|
@@ -1591,11 +1592,11 @@ declare enum NullValue {
|
|
|
1591
1592
|
*
|
|
1592
1593
|
* The JSON representation for `ListValue` is JSON array.
|
|
1593
1594
|
*/
|
|
1594
|
-
interface ListValue {
|
|
1595
|
+
export interface ListValue {
|
|
1595
1596
|
/** Repeated field of dynamically typed values. */
|
|
1596
1597
|
values?: any[];
|
|
1597
1598
|
}
|
|
1598
|
-
interface AudioData {
|
|
1599
|
+
export interface AudioData {
|
|
1599
1600
|
/** Styling for the audio node's container. */
|
|
1600
1601
|
containerData?: PluginContainerData;
|
|
1601
1602
|
/** Audio file details. */
|
|
@@ -1611,7 +1612,7 @@ interface AudioData {
|
|
|
1611
1612
|
/** An HTML version of the audio node. */
|
|
1612
1613
|
html?: string | null;
|
|
1613
1614
|
}
|
|
1614
|
-
interface OrderedListData {
|
|
1615
|
+
export interface OrderedListData {
|
|
1615
1616
|
/** Indentation level from 0-4. */
|
|
1616
1617
|
indentation?: number;
|
|
1617
1618
|
/** Offset level from 0-4. */
|
|
@@ -1619,24 +1620,24 @@ interface OrderedListData {
|
|
|
1619
1620
|
/** List start number. */
|
|
1620
1621
|
start?: number | null;
|
|
1621
1622
|
}
|
|
1622
|
-
interface BulletedListData {
|
|
1623
|
+
export interface BulletedListData {
|
|
1623
1624
|
/** Indentation level from 0-4. */
|
|
1624
1625
|
indentation?: number;
|
|
1625
1626
|
/** Offset level from 0-4. */
|
|
1626
1627
|
offset?: number | null;
|
|
1627
1628
|
}
|
|
1628
|
-
interface BlockquoteData {
|
|
1629
|
+
export interface BlockquoteData {
|
|
1629
1630
|
/** Indentation level from 1-4. */
|
|
1630
1631
|
indentation?: number;
|
|
1631
1632
|
}
|
|
1632
|
-
interface CaptionData {
|
|
1633
|
+
export interface CaptionData {
|
|
1633
1634
|
textStyle?: TextStyle;
|
|
1634
1635
|
}
|
|
1635
|
-
interface LayoutCellData {
|
|
1636
|
+
export interface LayoutCellData {
|
|
1636
1637
|
/** Size of the cell in 12 columns grid. */
|
|
1637
1638
|
colSpan?: number | null;
|
|
1638
1639
|
}
|
|
1639
|
-
interface Metadata {
|
|
1640
|
+
export interface Metadata {
|
|
1640
1641
|
/** Schema version. */
|
|
1641
1642
|
version?: number;
|
|
1642
1643
|
/**
|
|
@@ -1653,7 +1654,7 @@ interface Metadata {
|
|
|
1653
1654
|
/** Object ID. */
|
|
1654
1655
|
_id?: string | null;
|
|
1655
1656
|
}
|
|
1656
|
-
interface DocumentStyle {
|
|
1657
|
+
export interface DocumentStyle {
|
|
1657
1658
|
/** Styling for H1 nodes. */
|
|
1658
1659
|
headerOne?: TextNodeStyle;
|
|
1659
1660
|
/** Styling for H2 nodes. */
|
|
@@ -1673,7 +1674,7 @@ interface DocumentStyle {
|
|
|
1673
1674
|
/** Styling for code block nodes. */
|
|
1674
1675
|
codeBlock?: TextNodeStyle;
|
|
1675
1676
|
}
|
|
1676
|
-
interface TextNodeStyle {
|
|
1677
|
+
export interface TextNodeStyle {
|
|
1677
1678
|
/** The decorations to apply to the node. */
|
|
1678
1679
|
decorations?: Decoration[];
|
|
1679
1680
|
/** Padding and background color for the node. */
|
|
@@ -1681,7 +1682,7 @@ interface TextNodeStyle {
|
|
|
1681
1682
|
/** Line height for text in the node. */
|
|
1682
1683
|
lineHeight?: string | null;
|
|
1683
1684
|
}
|
|
1684
|
-
declare enum Status {
|
|
1685
|
+
export declare enum Status {
|
|
1685
1686
|
UNKNOWN = "UNKNOWN",
|
|
1686
1687
|
/** Status indicating the draft post is published. */
|
|
1687
1688
|
PUBLISHED = "PUBLISHED",
|
|
@@ -1694,7 +1695,7 @@ declare enum Status {
|
|
|
1694
1695
|
/** Status indicating the draft post is in review. */
|
|
1695
1696
|
IN_REVIEW = "IN_REVIEW"
|
|
1696
1697
|
}
|
|
1697
|
-
interface ModerationDetails {
|
|
1698
|
+
export interface ModerationDetails {
|
|
1698
1699
|
/**
|
|
1699
1700
|
* Member ID of the person submitting the draft post for review.
|
|
1700
1701
|
* @format GUID
|
|
@@ -1712,7 +1713,7 @@ interface ModerationDetails {
|
|
|
1712
1713
|
/** Date the post was approved or rejected. */
|
|
1713
1714
|
moderationDate?: Date | null;
|
|
1714
1715
|
}
|
|
1715
|
-
declare enum ModerationStatusStatus {
|
|
1716
|
+
export declare enum ModerationStatusStatus {
|
|
1716
1717
|
UNKNOWN = "UNKNOWN",
|
|
1717
1718
|
APPROVED = "APPROVED",
|
|
1718
1719
|
REJECTED = "REJECTED"
|
|
@@ -1722,13 +1723,13 @@ declare enum ModerationStatusStatus {
|
|
|
1722
1723
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
1723
1724
|
* 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.
|
|
1724
1725
|
*/
|
|
1725
|
-
interface SeoSchema {
|
|
1726
|
+
export interface SeoSchema {
|
|
1726
1727
|
/** SEO tag information. */
|
|
1727
1728
|
tags?: Tag[];
|
|
1728
1729
|
/** SEO general settings. */
|
|
1729
1730
|
settings?: Settings;
|
|
1730
1731
|
}
|
|
1731
|
-
interface Keyword {
|
|
1732
|
+
export interface Keyword {
|
|
1732
1733
|
/** Keyword value. */
|
|
1733
1734
|
term?: string;
|
|
1734
1735
|
/** Whether the keyword is the main focus keyword. */
|
|
@@ -1739,7 +1740,7 @@ interface Keyword {
|
|
|
1739
1740
|
*/
|
|
1740
1741
|
origin?: string | null;
|
|
1741
1742
|
}
|
|
1742
|
-
interface Tag {
|
|
1743
|
+
export interface Tag {
|
|
1743
1744
|
/**
|
|
1744
1745
|
* SEO tag type.
|
|
1745
1746
|
*
|
|
@@ -1761,7 +1762,7 @@ interface Tag {
|
|
|
1761
1762
|
/** Whether the tag is disabled. */
|
|
1762
1763
|
disabled?: boolean;
|
|
1763
1764
|
}
|
|
1764
|
-
interface Settings {
|
|
1765
|
+
export interface Settings {
|
|
1765
1766
|
/**
|
|
1766
1767
|
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
1767
1768
|
*
|
|
@@ -1775,7 +1776,7 @@ interface Settings {
|
|
|
1775
1776
|
*/
|
|
1776
1777
|
keywords?: Keyword[];
|
|
1777
1778
|
}
|
|
1778
|
-
interface Media extends MediaMediaOneOf {
|
|
1779
|
+
export interface Media extends MediaMediaOneOf {
|
|
1779
1780
|
/** Wix Media details. */
|
|
1780
1781
|
wixMedia?: WixMedia;
|
|
1781
1782
|
/** Embed media details. */
|
|
@@ -1792,19 +1793,19 @@ interface Media extends MediaMediaOneOf {
|
|
|
1792
1793
|
altText?: string | null;
|
|
1793
1794
|
}
|
|
1794
1795
|
/** @oneof */
|
|
1795
|
-
interface MediaMediaOneOf {
|
|
1796
|
+
export interface MediaMediaOneOf {
|
|
1796
1797
|
/** Wix Media details. */
|
|
1797
1798
|
wixMedia?: WixMedia;
|
|
1798
1799
|
/** Embed media details. */
|
|
1799
1800
|
embedMedia?: EmbedMedia;
|
|
1800
1801
|
}
|
|
1801
|
-
interface WixMedia {
|
|
1802
|
+
export interface WixMedia {
|
|
1802
1803
|
/** Image details. */
|
|
1803
1804
|
image?: string;
|
|
1804
1805
|
/** Video details. */
|
|
1805
1806
|
videoV2?: string;
|
|
1806
1807
|
}
|
|
1807
|
-
interface VideoResolution {
|
|
1808
|
+
export interface VideoResolution {
|
|
1808
1809
|
/** Video URL. */
|
|
1809
1810
|
url?: string;
|
|
1810
1811
|
/** Video height. */
|
|
@@ -1814,13 +1815,13 @@ interface VideoResolution {
|
|
|
1814
1815
|
/** Video format for example, mp4, hls. */
|
|
1815
1816
|
format?: string;
|
|
1816
1817
|
}
|
|
1817
|
-
interface EmbedMedia {
|
|
1818
|
+
export interface EmbedMedia {
|
|
1818
1819
|
/** Thumbnail details. */
|
|
1819
1820
|
thumbnail?: EmbedThumbnail;
|
|
1820
1821
|
/** Video details. */
|
|
1821
1822
|
video?: EmbedVideo;
|
|
1822
1823
|
}
|
|
1823
|
-
interface EmbedThumbnail {
|
|
1824
|
+
export interface EmbedThumbnail {
|
|
1824
1825
|
/**
|
|
1825
1826
|
* Thumbnail url.
|
|
1826
1827
|
* @maxLength 2000
|
|
@@ -1831,7 +1832,7 @@ interface EmbedThumbnail {
|
|
|
1831
1832
|
/** Thumbnail height. */
|
|
1832
1833
|
height?: number;
|
|
1833
1834
|
}
|
|
1834
|
-
interface EmbedVideo {
|
|
1835
|
+
export interface EmbedVideo {
|
|
1835
1836
|
/**
|
|
1836
1837
|
* Video url.
|
|
1837
1838
|
* @maxLength 2000
|
|
@@ -1842,7 +1843,7 @@ interface EmbedVideo {
|
|
|
1842
1843
|
/** Video height. */
|
|
1843
1844
|
height?: number;
|
|
1844
1845
|
}
|
|
1845
|
-
interface DraftPostTranslation {
|
|
1846
|
+
export interface DraftPostTranslation {
|
|
1846
1847
|
/**
|
|
1847
1848
|
* Post ID.
|
|
1848
1849
|
* @format GUID
|
|
@@ -1865,7 +1866,7 @@ interface DraftPostTranslation {
|
|
|
1865
1866
|
/** Post URL. */
|
|
1866
1867
|
url?: string;
|
|
1867
1868
|
}
|
|
1868
|
-
interface DraftCategoriesUpdated {
|
|
1869
|
+
export interface DraftCategoriesUpdated {
|
|
1869
1870
|
/**
|
|
1870
1871
|
* Draft post ID.
|
|
1871
1872
|
* @maxLength 38
|
|
@@ -1884,7 +1885,7 @@ interface DraftCategoriesUpdated {
|
|
|
1884
1885
|
*/
|
|
1885
1886
|
previousCategories?: string[];
|
|
1886
1887
|
}
|
|
1887
|
-
interface DraftTagsUpdated {
|
|
1888
|
+
export interface DraftTagsUpdated {
|
|
1888
1889
|
/**
|
|
1889
1890
|
* Draft post ID.
|
|
1890
1891
|
* @maxLength 38
|
|
@@ -1903,7 +1904,7 @@ interface DraftTagsUpdated {
|
|
|
1903
1904
|
*/
|
|
1904
1905
|
previousTags?: string[];
|
|
1905
1906
|
}
|
|
1906
|
-
interface GetDraftPostTotalsRequest {
|
|
1907
|
+
export interface GetDraftPostTotalsRequest {
|
|
1907
1908
|
/**
|
|
1908
1909
|
* Group results by fields (defaults to grouping by status).
|
|
1909
1910
|
* If, for example, grouping by language is passed, language values in response will be filled.
|
|
@@ -1917,17 +1918,17 @@ interface GetDraftPostTotalsRequest {
|
|
|
1917
1918
|
*/
|
|
1918
1919
|
language?: string | null;
|
|
1919
1920
|
}
|
|
1920
|
-
declare enum TotalDraftPostsGroupingField {
|
|
1921
|
+
export declare enum TotalDraftPostsGroupingField {
|
|
1921
1922
|
/** Groups results by status. */
|
|
1922
1923
|
STATUS = "STATUS",
|
|
1923
1924
|
/** Groups results by language. */
|
|
1924
1925
|
LANGUAGE = "LANGUAGE"
|
|
1925
1926
|
}
|
|
1926
|
-
interface GetDraftPostTotalsResponse {
|
|
1927
|
+
export interface GetDraftPostTotalsResponse {
|
|
1927
1928
|
/** Draft post totals. */
|
|
1928
1929
|
totalDraftPosts?: TotalDraftPosts[];
|
|
1929
1930
|
}
|
|
1930
|
-
interface TotalDraftPosts {
|
|
1931
|
+
export interface TotalDraftPosts {
|
|
1931
1932
|
/** Draft post totals in that group. */
|
|
1932
1933
|
total?: number;
|
|
1933
1934
|
/** Draft post status (only has value when grouping by status, otherwise null). */
|
|
@@ -1938,7 +1939,7 @@ interface TotalDraftPosts {
|
|
|
1938
1939
|
*/
|
|
1939
1940
|
language?: string | null;
|
|
1940
1941
|
}
|
|
1941
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1942
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1942
1943
|
createdEvent?: EntityCreatedEvent;
|
|
1943
1944
|
updatedEvent?: EntityUpdatedEvent;
|
|
1944
1945
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -1981,19 +1982,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1981
1982
|
entityEventSequence?: string | null;
|
|
1982
1983
|
}
|
|
1983
1984
|
/** @oneof */
|
|
1984
|
-
interface DomainEventBodyOneOf {
|
|
1985
|
+
export interface DomainEventBodyOneOf {
|
|
1985
1986
|
createdEvent?: EntityCreatedEvent;
|
|
1986
1987
|
updatedEvent?: EntityUpdatedEvent;
|
|
1987
1988
|
deletedEvent?: EntityDeletedEvent;
|
|
1988
1989
|
actionEvent?: ActionEvent;
|
|
1989
1990
|
}
|
|
1990
|
-
interface EntityCreatedEvent {
|
|
1991
|
+
export interface EntityCreatedEvent {
|
|
1991
1992
|
entity?: string;
|
|
1992
1993
|
}
|
|
1993
|
-
interface RestoreInfo {
|
|
1994
|
+
export interface RestoreInfo {
|
|
1994
1995
|
deletedDate?: Date | null;
|
|
1995
1996
|
}
|
|
1996
|
-
interface EntityUpdatedEvent {
|
|
1997
|
+
export interface EntityUpdatedEvent {
|
|
1997
1998
|
/**
|
|
1998
1999
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1999
2000
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -2001,14 +2002,14 @@ interface EntityUpdatedEvent {
|
|
|
2001
2002
|
*/
|
|
2002
2003
|
currentEntity?: string;
|
|
2003
2004
|
}
|
|
2004
|
-
interface EntityDeletedEvent {
|
|
2005
|
+
export interface EntityDeletedEvent {
|
|
2005
2006
|
/** Entity that was deleted */
|
|
2006
2007
|
deletedEntity?: string | null;
|
|
2007
2008
|
}
|
|
2008
|
-
interface ActionEvent {
|
|
2009
|
+
export interface ActionEvent {
|
|
2009
2010
|
body?: string;
|
|
2010
2011
|
}
|
|
2011
|
-
interface MessageEnvelope {
|
|
2012
|
+
export interface MessageEnvelope {
|
|
2012
2013
|
/**
|
|
2013
2014
|
* App instance ID.
|
|
2014
2015
|
* @format GUID
|
|
@@ -2024,7 +2025,7 @@ interface MessageEnvelope {
|
|
|
2024
2025
|
/** Stringify payload. */
|
|
2025
2026
|
data?: string;
|
|
2026
2027
|
}
|
|
2027
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2028
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2028
2029
|
/**
|
|
2029
2030
|
* ID of a site visitor that has not logged in to the site.
|
|
2030
2031
|
* @format GUID
|
|
@@ -2049,7 +2050,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
2049
2050
|
identityType?: WebhookIdentityType;
|
|
2050
2051
|
}
|
|
2051
2052
|
/** @oneof */
|
|
2052
|
-
interface IdentificationDataIdOneOf {
|
|
2053
|
+
export interface IdentificationDataIdOneOf {
|
|
2053
2054
|
/**
|
|
2054
2055
|
* ID of a site visitor that has not logged in to the site.
|
|
2055
2056
|
* @format GUID
|
|
@@ -2071,18 +2072,18 @@ interface IdentificationDataIdOneOf {
|
|
|
2071
2072
|
*/
|
|
2072
2073
|
appId?: string;
|
|
2073
2074
|
}
|
|
2074
|
-
declare enum WebhookIdentityType {
|
|
2075
|
+
export declare enum WebhookIdentityType {
|
|
2075
2076
|
UNKNOWN = "UNKNOWN",
|
|
2076
2077
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2077
2078
|
MEMBER = "MEMBER",
|
|
2078
2079
|
WIX_USER = "WIX_USER",
|
|
2079
2080
|
APP = "APP"
|
|
2080
2081
|
}
|
|
2081
|
-
interface InitialDraftPostsCopied {
|
|
2082
|
+
export interface InitialDraftPostsCopied {
|
|
2082
2083
|
/** Number of draft posts copied. */
|
|
2083
2084
|
count?: number;
|
|
2084
2085
|
}
|
|
2085
|
-
interface CreateDraftPostRequest {
|
|
2086
|
+
export interface CreateDraftPostRequest {
|
|
2086
2087
|
/** Draft post to create. */
|
|
2087
2088
|
draftPost: DraftPost;
|
|
2088
2089
|
/**
|
|
@@ -2099,7 +2100,7 @@ interface CreateDraftPostRequest {
|
|
|
2099
2100
|
*/
|
|
2100
2101
|
fieldsets?: Field[];
|
|
2101
2102
|
}
|
|
2102
|
-
declare enum Type {
|
|
2103
|
+
export declare enum Type {
|
|
2103
2104
|
UNKNOWN = "UNKNOWN",
|
|
2104
2105
|
/** Manually saved. */
|
|
2105
2106
|
MANUAL = "MANUAL",
|
|
@@ -2112,7 +2113,7 @@ declare enum Type {
|
|
|
2112
2113
|
/** Triggered by autosave when post created by AI tool. */
|
|
2113
2114
|
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
|
2114
2115
|
}
|
|
2115
|
-
declare enum Field {
|
|
2116
|
+
export declare enum Field {
|
|
2116
2117
|
/** Unknown field. */
|
|
2117
2118
|
UNKNOWN = "UNKNOWN",
|
|
2118
2119
|
/** Includes draft post preview URL. */
|
|
@@ -2124,11 +2125,11 @@ declare enum Field {
|
|
|
2124
2125
|
/** If the user has not set excerpt, returns the one autogenerated from content. */
|
|
2125
2126
|
GENERATED_EXCERPT = "GENERATED_EXCERPT"
|
|
2126
2127
|
}
|
|
2127
|
-
interface CreateDraftPostResponse {
|
|
2128
|
+
export interface CreateDraftPostResponse {
|
|
2128
2129
|
/** Created draft post info. */
|
|
2129
2130
|
draftPost?: DraftPost;
|
|
2130
2131
|
}
|
|
2131
|
-
interface BulkCreateDraftPostsRequest {
|
|
2132
|
+
export interface BulkCreateDraftPostsRequest {
|
|
2132
2133
|
/**
|
|
2133
2134
|
* Draft posts to create.
|
|
2134
2135
|
* @minSize 1
|
|
@@ -2147,19 +2148,19 @@ interface BulkCreateDraftPostsRequest {
|
|
|
2147
2148
|
*/
|
|
2148
2149
|
fieldsets?: Field[];
|
|
2149
2150
|
}
|
|
2150
|
-
interface BulkCreateDraftPostsResponse {
|
|
2151
|
+
export interface BulkCreateDraftPostsResponse {
|
|
2151
2152
|
/** Draft posts created by bulk action. */
|
|
2152
2153
|
results?: BulkDraftPostResult[];
|
|
2153
2154
|
/** Bulk action metadata. */
|
|
2154
2155
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2155
2156
|
}
|
|
2156
|
-
interface BulkDraftPostResult {
|
|
2157
|
+
export interface BulkDraftPostResult {
|
|
2157
2158
|
/** Bulk actions metadata for draft post. */
|
|
2158
2159
|
itemMetadata?: ItemMetadata;
|
|
2159
2160
|
/** Optional full draft post. */
|
|
2160
2161
|
item?: DraftPost;
|
|
2161
2162
|
}
|
|
2162
|
-
interface ItemMetadata {
|
|
2163
|
+
export interface ItemMetadata {
|
|
2163
2164
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2164
2165
|
_id?: string | null;
|
|
2165
2166
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
@@ -2169,7 +2170,7 @@ interface ItemMetadata {
|
|
|
2169
2170
|
/** Details about the error in case of failure. */
|
|
2170
2171
|
error?: ApplicationError;
|
|
2171
2172
|
}
|
|
2172
|
-
interface ApplicationError {
|
|
2173
|
+
export interface ApplicationError {
|
|
2173
2174
|
/** Error code. */
|
|
2174
2175
|
code?: string;
|
|
2175
2176
|
/** Description of the error. */
|
|
@@ -2177,7 +2178,7 @@ interface ApplicationError {
|
|
|
2177
2178
|
/** Data related to the error. */
|
|
2178
2179
|
data?: Record<string, any> | null;
|
|
2179
2180
|
}
|
|
2180
|
-
interface BulkActionMetadata {
|
|
2181
|
+
export interface BulkActionMetadata {
|
|
2181
2182
|
/** Number of items that were successfully processed. */
|
|
2182
2183
|
totalSuccesses?: number;
|
|
2183
2184
|
/** Number of items that couldn't be processed. */
|
|
@@ -2185,7 +2186,7 @@ interface BulkActionMetadata {
|
|
|
2185
2186
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
2186
2187
|
undetailedFailures?: number;
|
|
2187
2188
|
}
|
|
2188
|
-
interface BulkUpdateDraftPostsRequest {
|
|
2189
|
+
export interface BulkUpdateDraftPostsRequest {
|
|
2189
2190
|
/**
|
|
2190
2191
|
* Draft posts to update.
|
|
2191
2192
|
* @minSize 1
|
|
@@ -2210,13 +2211,13 @@ interface BulkUpdateDraftPostsRequest {
|
|
|
2210
2211
|
*/
|
|
2211
2212
|
fieldsets?: Field[];
|
|
2212
2213
|
}
|
|
2213
|
-
interface MaskedDraftPosts {
|
|
2214
|
+
export interface MaskedDraftPosts {
|
|
2214
2215
|
/** Draft post */
|
|
2215
2216
|
draftPost?: DraftPost;
|
|
2216
2217
|
/** Field mask of fields to update. */
|
|
2217
2218
|
fieldMask?: string[];
|
|
2218
2219
|
}
|
|
2219
|
-
declare enum Action {
|
|
2220
|
+
export declare enum Action {
|
|
2220
2221
|
/** Update the draft post. */
|
|
2221
2222
|
UPDATE = "UPDATE",
|
|
2222
2223
|
/** Update and publish a draft post. */
|
|
@@ -2232,15 +2233,15 @@ declare enum Action {
|
|
|
2232
2233
|
/** Update a post that's already been published. This creates and updates a draft version of the post. The original post is still published. */
|
|
2233
2234
|
UPDATE_PUBLICATION = "UPDATE_PUBLICATION"
|
|
2234
2235
|
}
|
|
2235
|
-
interface BulkUpdateDraftPostsResponse {
|
|
2236
|
+
export interface BulkUpdateDraftPostsResponse {
|
|
2236
2237
|
/** Draft posts updated by bulk action. */
|
|
2237
2238
|
results?: BulkDraftPostResult[];
|
|
2238
2239
|
/** Bulk action metadata. */
|
|
2239
2240
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2240
2241
|
}
|
|
2241
|
-
interface DraftPostOwnerChanged {
|
|
2242
|
+
export interface DraftPostOwnerChanged {
|
|
2242
2243
|
}
|
|
2243
|
-
interface ListDeletedDraftPostsRequest {
|
|
2244
|
+
export interface ListDeletedDraftPostsRequest {
|
|
2244
2245
|
/**
|
|
2245
2246
|
* Language filter.
|
|
2246
2247
|
*
|
|
@@ -2271,13 +2272,13 @@ interface ListDeletedDraftPostsRequest {
|
|
|
2271
2272
|
*/
|
|
2272
2273
|
draftPostIds?: string[];
|
|
2273
2274
|
}
|
|
2274
|
-
declare enum GetDraftPostsSort {
|
|
2275
|
+
export declare enum GetDraftPostsSort {
|
|
2275
2276
|
/** Sort by `editedDate` in descending order. */
|
|
2276
2277
|
EDITING_DATE_DESC = "EDITING_DATE_DESC",
|
|
2277
2278
|
/** Sort by `editedDate` in ascending order. */
|
|
2278
2279
|
EDITING_DATE_ASC = "EDITING_DATE_ASC"
|
|
2279
2280
|
}
|
|
2280
|
-
interface BlogPaging {
|
|
2281
|
+
export interface BlogPaging {
|
|
2281
2282
|
/**
|
|
2282
2283
|
* Number of items to skip in the current sort order.
|
|
2283
2284
|
*
|
|
@@ -2300,7 +2301,7 @@ interface BlogPaging {
|
|
|
2300
2301
|
*/
|
|
2301
2302
|
cursor?: string | null;
|
|
2302
2303
|
}
|
|
2303
|
-
interface ListDeletedDraftPostsResponse {
|
|
2304
|
+
export interface ListDeletedDraftPostsResponse {
|
|
2304
2305
|
/** List of draft posts. */
|
|
2305
2306
|
draftPosts?: DraftPost[];
|
|
2306
2307
|
/**
|
|
@@ -2319,7 +2320,7 @@ interface ListDeletedDraftPostsResponse {
|
|
|
2319
2320
|
/** Details on the paged set of results returned. */
|
|
2320
2321
|
pagingMetadata?: PagingMetadataV2;
|
|
2321
2322
|
}
|
|
2322
|
-
interface MetaData {
|
|
2323
|
+
export interface MetaData {
|
|
2323
2324
|
/** Number of items returned in this response. */
|
|
2324
2325
|
count?: number;
|
|
2325
2326
|
/** Requested offset. */
|
|
@@ -2332,7 +2333,7 @@ interface MetaData {
|
|
|
2332
2333
|
*/
|
|
2333
2334
|
cursor?: string | null;
|
|
2334
2335
|
}
|
|
2335
|
-
interface PagingMetadataV2 {
|
|
2336
|
+
export interface PagingMetadataV2 {
|
|
2336
2337
|
/** Number of items returned in the response. */
|
|
2337
2338
|
count?: number | null;
|
|
2338
2339
|
/** Offset that was requested. */
|
|
@@ -2344,7 +2345,7 @@ interface PagingMetadataV2 {
|
|
|
2344
2345
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
2345
2346
|
cursors?: Cursors;
|
|
2346
2347
|
}
|
|
2347
|
-
interface Cursors {
|
|
2348
|
+
export interface Cursors {
|
|
2348
2349
|
/**
|
|
2349
2350
|
* Cursor pointing to next page in the list of results.
|
|
2350
2351
|
* @maxLength 2000
|
|
@@ -2356,7 +2357,7 @@ interface Cursors {
|
|
|
2356
2357
|
*/
|
|
2357
2358
|
prev?: string | null;
|
|
2358
2359
|
}
|
|
2359
|
-
interface GetDraftPostRequest {
|
|
2360
|
+
export interface GetDraftPostRequest {
|
|
2360
2361
|
/**
|
|
2361
2362
|
* Draft post ID.
|
|
2362
2363
|
* @maxLength 38
|
|
@@ -2370,11 +2371,11 @@ interface GetDraftPostRequest {
|
|
|
2370
2371
|
*/
|
|
2371
2372
|
fieldsets?: Field[];
|
|
2372
2373
|
}
|
|
2373
|
-
interface GetDraftPostResponse {
|
|
2374
|
+
export interface GetDraftPostResponse {
|
|
2374
2375
|
/** Draft post info. */
|
|
2375
2376
|
draftPost?: DraftPost;
|
|
2376
2377
|
}
|
|
2377
|
-
interface UpdateDraftPostContentRequest extends UpdateDraftPostContentRequestDraftContentOneOf {
|
|
2378
|
+
export interface UpdateDraftPostContentRequest extends UpdateDraftPostContentRequestDraftContentOneOf {
|
|
2378
2379
|
/**
|
|
2379
2380
|
* DraftJs content to update.
|
|
2380
2381
|
* @maxLength 400000
|
|
@@ -2398,7 +2399,7 @@ interface UpdateDraftPostContentRequest extends UpdateDraftPostContentRequestDra
|
|
|
2398
2399
|
fieldsets?: Field[];
|
|
2399
2400
|
}
|
|
2400
2401
|
/** @oneof */
|
|
2401
|
-
interface UpdateDraftPostContentRequestDraftContentOneOf {
|
|
2402
|
+
export interface UpdateDraftPostContentRequestDraftContentOneOf {
|
|
2402
2403
|
/**
|
|
2403
2404
|
* DraftJs content to update.
|
|
2404
2405
|
* @maxLength 400000
|
|
@@ -2407,11 +2408,11 @@ interface UpdateDraftPostContentRequestDraftContentOneOf {
|
|
|
2407
2408
|
/** Draft Post rich content. */
|
|
2408
2409
|
richContent?: RichContent;
|
|
2409
2410
|
}
|
|
2410
|
-
interface UpdateDraftPostContentResponse {
|
|
2411
|
+
export interface UpdateDraftPostContentResponse {
|
|
2411
2412
|
/** Updated draft post info. */
|
|
2412
2413
|
draftPost?: DraftPost;
|
|
2413
2414
|
}
|
|
2414
|
-
interface UpdateDraftPostRequest {
|
|
2415
|
+
export interface UpdateDraftPostRequest {
|
|
2415
2416
|
/** Draft post to update. */
|
|
2416
2417
|
draftPost: DraftPost;
|
|
2417
2418
|
/**
|
|
@@ -2430,11 +2431,11 @@ interface UpdateDraftPostRequest {
|
|
|
2430
2431
|
*/
|
|
2431
2432
|
fieldsets?: Field[];
|
|
2432
2433
|
}
|
|
2433
|
-
interface UpdateDraftPostResponse {
|
|
2434
|
+
export interface UpdateDraftPostResponse {
|
|
2434
2435
|
/** Updated draft post info. */
|
|
2435
2436
|
draftPost?: DraftPost;
|
|
2436
2437
|
}
|
|
2437
|
-
interface DeleteDraftPostRequest {
|
|
2438
|
+
export interface DeleteDraftPostRequest {
|
|
2438
2439
|
/**
|
|
2439
2440
|
* Draft post ID.
|
|
2440
2441
|
* @maxLength 38
|
|
@@ -2447,18 +2448,18 @@ interface DeleteDraftPostRequest {
|
|
|
2447
2448
|
*/
|
|
2448
2449
|
permanent?: boolean;
|
|
2449
2450
|
}
|
|
2450
|
-
interface DeleteDraftPostResponse {
|
|
2451
|
+
export interface DeleteDraftPostResponse {
|
|
2451
2452
|
}
|
|
2452
|
-
interface RemoveFromTrashBinRequest {
|
|
2453
|
+
export interface RemoveFromTrashBinRequest {
|
|
2453
2454
|
/**
|
|
2454
2455
|
* Draft post ID.
|
|
2455
2456
|
* @maxLength 38
|
|
2456
2457
|
*/
|
|
2457
2458
|
draftPostId: string;
|
|
2458
2459
|
}
|
|
2459
|
-
interface RemoveFromTrashBinResponse {
|
|
2460
|
+
export interface RemoveFromTrashBinResponse {
|
|
2460
2461
|
}
|
|
2461
|
-
interface BulkDeleteDraftPostsRequest {
|
|
2462
|
+
export interface BulkDeleteDraftPostsRequest {
|
|
2462
2463
|
/**
|
|
2463
2464
|
* Post IDs.
|
|
2464
2465
|
* @minSize 1
|
|
@@ -2469,13 +2470,13 @@ interface BulkDeleteDraftPostsRequest {
|
|
|
2469
2470
|
/** Should delete bypassing the trash-bin. */
|
|
2470
2471
|
permanent?: boolean;
|
|
2471
2472
|
}
|
|
2472
|
-
interface BulkDeleteDraftPostsResponse {
|
|
2473
|
+
export interface BulkDeleteDraftPostsResponse {
|
|
2473
2474
|
/** Bulk action results. */
|
|
2474
2475
|
results?: BulkDraftPostResult[];
|
|
2475
2476
|
/** Bulk action metadata. */
|
|
2476
2477
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2477
2478
|
}
|
|
2478
|
-
interface ListDraftPostsRequest {
|
|
2479
|
+
export interface ListDraftPostsRequest {
|
|
2479
2480
|
/**
|
|
2480
2481
|
* Draft post status filter.
|
|
2481
2482
|
*
|
|
@@ -2506,35 +2507,35 @@ interface ListDraftPostsRequest {
|
|
|
2506
2507
|
*/
|
|
2507
2508
|
fieldsets?: Field[];
|
|
2508
2509
|
}
|
|
2509
|
-
interface ListDraftPostsResponse {
|
|
2510
|
+
export interface ListDraftPostsResponse {
|
|
2510
2511
|
/** List of draft posts. */
|
|
2511
2512
|
draftPosts?: DraftPost[];
|
|
2512
2513
|
/** Details on the paged set of results returned. */
|
|
2513
2514
|
metaData?: MetaData;
|
|
2514
2515
|
}
|
|
2515
|
-
interface GetDeletedDraftPostRequest {
|
|
2516
|
+
export interface GetDeletedDraftPostRequest {
|
|
2516
2517
|
/**
|
|
2517
2518
|
* Draft post ID.
|
|
2518
2519
|
* @maxLength 38
|
|
2519
2520
|
*/
|
|
2520
2521
|
draftPostId: string;
|
|
2521
2522
|
}
|
|
2522
|
-
interface GetDeletedDraftPostResponse {
|
|
2523
|
+
export interface GetDeletedDraftPostResponse {
|
|
2523
2524
|
/** Draft post info. */
|
|
2524
2525
|
draftPost?: DraftPost;
|
|
2525
2526
|
}
|
|
2526
|
-
interface RestoreFromTrashBinRequest {
|
|
2527
|
+
export interface RestoreFromTrashBinRequest {
|
|
2527
2528
|
/**
|
|
2528
2529
|
* Draft post ID.
|
|
2529
2530
|
* @maxLength 38
|
|
2530
2531
|
*/
|
|
2531
2532
|
draftPostId: string;
|
|
2532
2533
|
}
|
|
2533
|
-
interface RestoreFromTrashBinResponse {
|
|
2534
|
+
export interface RestoreFromTrashBinResponse {
|
|
2534
2535
|
/** Restored draft post info. */
|
|
2535
2536
|
draftPost?: DraftPost;
|
|
2536
2537
|
}
|
|
2537
|
-
interface QueryDraftPostsRequest {
|
|
2538
|
+
export interface QueryDraftPostsRequest {
|
|
2538
2539
|
/**
|
|
2539
2540
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
2540
2541
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
@@ -2545,7 +2546,7 @@ interface QueryDraftPostsRequest {
|
|
|
2545
2546
|
/** Query options. */
|
|
2546
2547
|
query?: PlatformQuery;
|
|
2547
2548
|
}
|
|
2548
|
-
interface Sorting {
|
|
2549
|
+
export interface Sorting {
|
|
2549
2550
|
/**
|
|
2550
2551
|
* Name of the field to sort by.
|
|
2551
2552
|
* @maxLength 512
|
|
@@ -2554,11 +2555,11 @@ interface Sorting {
|
|
|
2554
2555
|
/** Sort order. */
|
|
2555
2556
|
order?: SortOrder;
|
|
2556
2557
|
}
|
|
2557
|
-
declare enum SortOrder {
|
|
2558
|
+
export declare enum SortOrder {
|
|
2558
2559
|
ASC = "ASC",
|
|
2559
2560
|
DESC = "DESC"
|
|
2560
2561
|
}
|
|
2561
|
-
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
2562
|
+
export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
2562
2563
|
/** Paging options to limit and skip the number of items. */
|
|
2563
2564
|
paging?: Paging;
|
|
2564
2565
|
/** 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`. */
|
|
@@ -2580,13 +2581,13 @@ interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
|
2580
2581
|
sort?: Sorting[];
|
|
2581
2582
|
}
|
|
2582
2583
|
/** @oneof */
|
|
2583
|
-
interface PlatformQueryPagingMethodOneOf {
|
|
2584
|
+
export interface PlatformQueryPagingMethodOneOf {
|
|
2584
2585
|
/** Paging options to limit and skip the number of items. */
|
|
2585
2586
|
paging?: Paging;
|
|
2586
2587
|
/** 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`. */
|
|
2587
2588
|
cursorPaging?: CursorPaging;
|
|
2588
2589
|
}
|
|
2589
|
-
interface Paging {
|
|
2590
|
+
export interface Paging {
|
|
2590
2591
|
/**
|
|
2591
2592
|
* Number of items to load.
|
|
2592
2593
|
* @max 100
|
|
@@ -2595,7 +2596,7 @@ interface Paging {
|
|
|
2595
2596
|
/** Number of items to skip in the current sort order. */
|
|
2596
2597
|
offset?: number | null;
|
|
2597
2598
|
}
|
|
2598
|
-
interface CursorPaging {
|
|
2599
|
+
export interface CursorPaging {
|
|
2599
2600
|
/**
|
|
2600
2601
|
* Number of items to load.
|
|
2601
2602
|
* @max 100
|
|
@@ -2611,36 +2612,36 @@ interface CursorPaging {
|
|
|
2611
2612
|
*/
|
|
2612
2613
|
cursor?: string | null;
|
|
2613
2614
|
}
|
|
2614
|
-
interface QueryDraftPostsResponse {
|
|
2615
|
+
export interface QueryDraftPostsResponse {
|
|
2615
2616
|
/** List of posts. */
|
|
2616
2617
|
draftPosts?: DraftPost[];
|
|
2617
2618
|
/** Details on the paged set of results returned. */
|
|
2618
2619
|
pagingMetadata?: PagingMetadataV2;
|
|
2619
2620
|
}
|
|
2620
|
-
interface PublishDraftPostRequest {
|
|
2621
|
+
export interface PublishDraftPostRequest {
|
|
2621
2622
|
/**
|
|
2622
2623
|
* Draft post ID.
|
|
2623
2624
|
* @maxLength 38
|
|
2624
2625
|
*/
|
|
2625
2626
|
draftPostId: string;
|
|
2626
2627
|
}
|
|
2627
|
-
interface PublishDraftPostResponse {
|
|
2628
|
+
export interface PublishDraftPostResponse {
|
|
2628
2629
|
/**
|
|
2629
2630
|
* Published post ID.
|
|
2630
2631
|
* @format GUID
|
|
2631
2632
|
*/
|
|
2632
2633
|
postId?: string;
|
|
2633
2634
|
}
|
|
2634
|
-
interface UnpublishPostRequest {
|
|
2635
|
+
export interface UnpublishPostRequest {
|
|
2635
2636
|
/**
|
|
2636
2637
|
* Draft post ID.
|
|
2637
2638
|
* @maxLength 38
|
|
2638
2639
|
*/
|
|
2639
2640
|
draftPostId?: string;
|
|
2640
2641
|
}
|
|
2641
|
-
interface UnpublishPostResponse {
|
|
2642
|
+
export interface UnpublishPostResponse {
|
|
2642
2643
|
}
|
|
2643
|
-
interface TranslateCategoryRequest {
|
|
2644
|
+
export interface TranslateCategoryRequest {
|
|
2644
2645
|
/**
|
|
2645
2646
|
* Source category ID
|
|
2646
2647
|
* @format GUID
|
|
@@ -2652,13 +2653,13 @@ interface TranslateCategoryRequest {
|
|
|
2652
2653
|
*/
|
|
2653
2654
|
language?: string;
|
|
2654
2655
|
}
|
|
2655
|
-
interface TranslateCategoryResponse {
|
|
2656
|
+
export interface TranslateCategoryResponse {
|
|
2656
2657
|
/** Translated category */
|
|
2657
2658
|
category?: Category;
|
|
2658
2659
|
/** Other translations of returned category */
|
|
2659
2660
|
translations?: CategoryTranslation[];
|
|
2660
2661
|
}
|
|
2661
|
-
interface Category {
|
|
2662
|
+
export interface Category {
|
|
2662
2663
|
/**
|
|
2663
2664
|
* Category ID.
|
|
2664
2665
|
* @immutable
|
|
@@ -2726,7 +2727,7 @@ interface Category {
|
|
|
2726
2727
|
*/
|
|
2727
2728
|
_updatedDate?: Date | null;
|
|
2728
2729
|
}
|
|
2729
|
-
interface CategoryTranslation {
|
|
2730
|
+
export interface CategoryTranslation {
|
|
2730
2731
|
/**
|
|
2731
2732
|
* Category ID.
|
|
2732
2733
|
* @format GUID
|
|
@@ -2745,7 +2746,7 @@ interface CategoryTranslation {
|
|
|
2745
2746
|
/** URL of this category page. */
|
|
2746
2747
|
url?: string;
|
|
2747
2748
|
}
|
|
2748
|
-
interface TranslateDraftRequest {
|
|
2749
|
+
export interface TranslateDraftRequest {
|
|
2749
2750
|
/**
|
|
2750
2751
|
* Source post or draft ID
|
|
2751
2752
|
* @format GUID
|
|
@@ -2764,18 +2765,18 @@ interface TranslateDraftRequest {
|
|
|
2764
2765
|
*/
|
|
2765
2766
|
fieldsets?: Field[];
|
|
2766
2767
|
}
|
|
2767
|
-
interface TranslateDraftResponse {
|
|
2768
|
+
export interface TranslateDraftResponse {
|
|
2768
2769
|
/** Draft post. */
|
|
2769
2770
|
draftPost?: DraftPost;
|
|
2770
2771
|
}
|
|
2771
|
-
interface IsDraftPostAutoTranslatableRequest {
|
|
2772
|
+
export interface IsDraftPostAutoTranslatableRequest {
|
|
2772
2773
|
/**
|
|
2773
2774
|
* Source post or draft ID.
|
|
2774
2775
|
* @format GUID
|
|
2775
2776
|
*/
|
|
2776
2777
|
draftPostId?: string;
|
|
2777
2778
|
}
|
|
2778
|
-
interface IsDraftPostAutoTranslatableResponse {
|
|
2779
|
+
export interface IsDraftPostAutoTranslatableResponse {
|
|
2779
2780
|
/**
|
|
2780
2781
|
* Source draft post ID.
|
|
2781
2782
|
* @format GUID
|
|
@@ -2794,7 +2795,7 @@ interface IsDraftPostAutoTranslatableResponse {
|
|
|
2794
2795
|
/** Content text character count. */
|
|
2795
2796
|
contentTextCharacterCount?: number;
|
|
2796
2797
|
}
|
|
2797
|
-
interface UpdateDraftPostLanguageRequest {
|
|
2798
|
+
export interface UpdateDraftPostLanguageRequest {
|
|
2798
2799
|
/**
|
|
2799
2800
|
* Source draft post ID
|
|
2800
2801
|
* @format GUID
|
|
@@ -2814,11 +2815,11 @@ interface UpdateDraftPostLanguageRequest {
|
|
|
2814
2815
|
*/
|
|
2815
2816
|
fieldsets?: Field[];
|
|
2816
2817
|
}
|
|
2817
|
-
interface UpdateDraftPostLanguageResponse {
|
|
2818
|
+
export interface UpdateDraftPostLanguageResponse {
|
|
2818
2819
|
/** Draft post */
|
|
2819
2820
|
draftPost?: DraftPost;
|
|
2820
2821
|
}
|
|
2821
|
-
interface BulkUpdateDraftPostLanguageRequest {
|
|
2822
|
+
export interface BulkUpdateDraftPostLanguageRequest {
|
|
2822
2823
|
/**
|
|
2823
2824
|
* Source post or draft IDs
|
|
2824
2825
|
* @maxSize 50
|
|
@@ -2840,24 +2841,24 @@ interface BulkUpdateDraftPostLanguageRequest {
|
|
|
2840
2841
|
*/
|
|
2841
2842
|
fieldsets?: Field[];
|
|
2842
2843
|
}
|
|
2843
|
-
interface BulkUpdateDraftPostLanguageResponse {
|
|
2844
|
+
export interface BulkUpdateDraftPostLanguageResponse {
|
|
2844
2845
|
/** Bulk action results */
|
|
2845
2846
|
results?: BulkDraftPostResult[];
|
|
2846
2847
|
/** Bulk action metadata */
|
|
2847
2848
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2848
2849
|
}
|
|
2849
|
-
interface GetPostAmountsByLanguageRequest {
|
|
2850
|
+
export interface GetPostAmountsByLanguageRequest {
|
|
2850
2851
|
/**
|
|
2851
2852
|
* Post status to filter by
|
|
2852
2853
|
* @maxLength 100
|
|
2853
2854
|
*/
|
|
2854
2855
|
status?: string;
|
|
2855
2856
|
}
|
|
2856
|
-
interface GetPostAmountsByLanguageResponse {
|
|
2857
|
+
export interface GetPostAmountsByLanguageResponse {
|
|
2857
2858
|
/** Post amounts by language */
|
|
2858
2859
|
postAmountsByLanguage?: PostAmountByLanguage[];
|
|
2859
2860
|
}
|
|
2860
|
-
interface PostAmountByLanguage {
|
|
2861
|
+
export interface PostAmountByLanguage {
|
|
2861
2862
|
/**
|
|
2862
2863
|
* Post language code
|
|
2863
2864
|
* @format LANGUAGE_TAG
|
|
@@ -2871,7 +2872,7 @@ interface PostAmountByLanguage {
|
|
|
2871
2872
|
/** Post amount in that language */
|
|
2872
2873
|
postAmount?: number;
|
|
2873
2874
|
}
|
|
2874
|
-
interface BulkRevertToUnpublishedRequest {
|
|
2875
|
+
export interface BulkRevertToUnpublishedRequest {
|
|
2875
2876
|
/**
|
|
2876
2877
|
* Source post IDs.
|
|
2877
2878
|
* @minSize 1
|
|
@@ -2882,13 +2883,13 @@ interface BulkRevertToUnpublishedRequest {
|
|
|
2882
2883
|
/** Should full draft post be returned. */
|
|
2883
2884
|
returnFullEntity?: boolean;
|
|
2884
2885
|
}
|
|
2885
|
-
interface BulkRevertToUnpublishedResponse {
|
|
2886
|
+
export interface BulkRevertToUnpublishedResponse {
|
|
2886
2887
|
/** Bulk action results. */
|
|
2887
2888
|
results?: BulkDraftPostResult[];
|
|
2888
2889
|
/** Bulk action metadata. */
|
|
2889
2890
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2890
2891
|
}
|
|
2891
|
-
interface BulkRejectDraftPostRequest {
|
|
2892
|
+
export interface BulkRejectDraftPostRequest {
|
|
2892
2893
|
/**
|
|
2893
2894
|
* Source post IDs.
|
|
2894
2895
|
* @minSize 1
|
|
@@ -2899,13 +2900,13 @@ interface BulkRejectDraftPostRequest {
|
|
|
2899
2900
|
/** Should full draft post be returned. */
|
|
2900
2901
|
returnFullEntity?: boolean;
|
|
2901
2902
|
}
|
|
2902
|
-
interface BulkRejectDraftPostResponse {
|
|
2903
|
+
export interface BulkRejectDraftPostResponse {
|
|
2903
2904
|
/** Bulk action results. */
|
|
2904
2905
|
results?: BulkDraftPostResult[];
|
|
2905
2906
|
/** Bulk action metadata. */
|
|
2906
2907
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2907
2908
|
}
|
|
2908
|
-
interface RevertToUnpublishedRequest {
|
|
2909
|
+
export interface RevertToUnpublishedRequest {
|
|
2909
2910
|
/**
|
|
2910
2911
|
* Source post ID.
|
|
2911
2912
|
* @format GUID
|
|
@@ -2919,11 +2920,11 @@ interface RevertToUnpublishedRequest {
|
|
|
2919
2920
|
*/
|
|
2920
2921
|
fieldsets?: Field[];
|
|
2921
2922
|
}
|
|
2922
|
-
interface RevertToUnpublishedResponse {
|
|
2923
|
+
export interface RevertToUnpublishedResponse {
|
|
2923
2924
|
/** Updated post draft. */
|
|
2924
2925
|
draftPost?: DraftPost;
|
|
2925
2926
|
}
|
|
2926
|
-
interface RejectDraftPostRequest {
|
|
2927
|
+
export interface RejectDraftPostRequest {
|
|
2927
2928
|
/**
|
|
2928
2929
|
* Source post ID.
|
|
2929
2930
|
* @format GUID
|
|
@@ -2937,11 +2938,11 @@ interface RejectDraftPostRequest {
|
|
|
2937
2938
|
*/
|
|
2938
2939
|
fieldsets?: Field[];
|
|
2939
2940
|
}
|
|
2940
|
-
interface RejectDraftPostResponse {
|
|
2941
|
+
export interface RejectDraftPostResponse {
|
|
2941
2942
|
/** Draft post. */
|
|
2942
2943
|
draftPost?: DraftPost;
|
|
2943
2944
|
}
|
|
2944
|
-
interface ApproveDraftPostRequest {
|
|
2945
|
+
export interface ApproveDraftPostRequest {
|
|
2945
2946
|
/**
|
|
2946
2947
|
* Source post ID.
|
|
2947
2948
|
* @format GUID
|
|
@@ -2960,11 +2961,11 @@ interface ApproveDraftPostRequest {
|
|
|
2960
2961
|
*/
|
|
2961
2962
|
fieldsets?: Field[];
|
|
2962
2963
|
}
|
|
2963
|
-
interface ApproveDraftPostResponse {
|
|
2964
|
+
export interface ApproveDraftPostResponse {
|
|
2964
2965
|
/** Updated post draft. */
|
|
2965
2966
|
draftPost?: DraftPost;
|
|
2966
2967
|
}
|
|
2967
|
-
interface MarkPostAsInModerationRequest {
|
|
2968
|
+
export interface MarkPostAsInModerationRequest {
|
|
2968
2969
|
/**
|
|
2969
2970
|
* Source post ID.
|
|
2970
2971
|
* @maxLength 38
|
|
@@ -2978,11 +2979,11 @@ interface MarkPostAsInModerationRequest {
|
|
|
2978
2979
|
*/
|
|
2979
2980
|
fieldsets?: Field[];
|
|
2980
2981
|
}
|
|
2981
|
-
interface MarkPostAsInModerationResponse {
|
|
2982
|
+
export interface MarkPostAsInModerationResponse {
|
|
2982
2983
|
/** Updated post draft. */
|
|
2983
2984
|
draftPost?: DraftPost;
|
|
2984
2985
|
}
|
|
2985
|
-
interface BaseEventMetadata {
|
|
2986
|
+
export interface BaseEventMetadata {
|
|
2986
2987
|
/**
|
|
2987
2988
|
* App instance ID.
|
|
2988
2989
|
* @format GUID
|
|
@@ -2996,7 +2997,7 @@ interface BaseEventMetadata {
|
|
|
2996
2997
|
/** The identification type and identity data. */
|
|
2997
2998
|
identity?: IdentificationData;
|
|
2998
2999
|
}
|
|
2999
|
-
interface EventMetadata extends BaseEventMetadata {
|
|
3000
|
+
export interface EventMetadata extends BaseEventMetadata {
|
|
3000
3001
|
/**
|
|
3001
3002
|
* Unique event ID.
|
|
3002
3003
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -3034,19 +3035,104 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
3034
3035
|
*/
|
|
3035
3036
|
entityEventSequence?: string | null;
|
|
3036
3037
|
}
|
|
3037
|
-
interface DraftCreatedEnvelope {
|
|
3038
|
+
export interface DraftCreatedEnvelope {
|
|
3038
3039
|
entity: DraftPost;
|
|
3039
3040
|
metadata: EventMetadata;
|
|
3040
3041
|
}
|
|
3041
|
-
|
|
3042
|
+
/**
|
|
3043
|
+
* Triggered when a draft post is created.
|
|
3044
|
+
* @permissionScope Manage Blog
|
|
3045
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3046
|
+
* @permissionScope Read Draft Blog Posts
|
|
3047
|
+
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
|
3048
|
+
* @permissionScope Read Blog
|
|
3049
|
+
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
|
3050
|
+
* @permissionScope Manage Blog
|
|
3051
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3052
|
+
* @permissionScope Read Draft Blog Posts
|
|
3053
|
+
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
|
3054
|
+
* @permissionId BLOG.READ_ANY_DRAFT
|
|
3055
|
+
* @permissionId BLOG.READ-PUBLICATION
|
|
3056
|
+
* @webhook
|
|
3057
|
+
* @eventType wix.blog.v3.draft_created
|
|
3058
|
+
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.DraftPostService
|
|
3059
|
+
* @slug created
|
|
3060
|
+
*/
|
|
3061
|
+
export declare function onDraftCreated(handler: (event: DraftCreatedEnvelope) => void | Promise<void>): void;
|
|
3062
|
+
export interface DraftDeletedEnvelope {
|
|
3042
3063
|
entity: DraftPost;
|
|
3043
3064
|
metadata: EventMetadata;
|
|
3044
3065
|
}
|
|
3045
|
-
|
|
3066
|
+
/**
|
|
3067
|
+
* Triggered when a draft post is deleted.
|
|
3068
|
+
* @permissionScope Manage Blog
|
|
3069
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3070
|
+
* @permissionScope Read Draft Blog Posts
|
|
3071
|
+
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
|
3072
|
+
* @permissionScope Read Blog
|
|
3073
|
+
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
|
3074
|
+
* @permissionScope Manage Blog
|
|
3075
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3076
|
+
* @permissionScope Read Draft Blog Posts
|
|
3077
|
+
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
|
3078
|
+
* @permissionId BLOG.READ_ANY_DRAFT
|
|
3079
|
+
* @permissionId BLOG.READ-PUBLICATION
|
|
3080
|
+
* @webhook
|
|
3081
|
+
* @eventType wix.blog.v3.draft_deleted
|
|
3082
|
+
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.DraftPostService
|
|
3083
|
+
* @slug deleted
|
|
3084
|
+
*/
|
|
3085
|
+
export declare function onDraftDeleted(handler: (event: DraftDeletedEnvelope) => void | Promise<void>): void;
|
|
3086
|
+
export interface DraftUpdatedEnvelope {
|
|
3046
3087
|
entity: DraftPost;
|
|
3047
3088
|
metadata: EventMetadata;
|
|
3048
3089
|
}
|
|
3049
|
-
|
|
3090
|
+
/**
|
|
3091
|
+
* Triggered when a draft post is updated.
|
|
3092
|
+
* @permissionScope Manage Blog
|
|
3093
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3094
|
+
* @permissionScope Read Draft Blog Posts
|
|
3095
|
+
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
|
3096
|
+
* @permissionScope Read Blog
|
|
3097
|
+
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
|
3098
|
+
* @permissionScope Manage Blog
|
|
3099
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3100
|
+
* @permissionScope Read Draft Blog Posts
|
|
3101
|
+
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
|
3102
|
+
* @permissionId BLOG.READ_ANY_DRAFT
|
|
3103
|
+
* @permissionId BLOG.READ-PUBLICATION
|
|
3104
|
+
* @webhook
|
|
3105
|
+
* @eventType wix.blog.v3.draft_updated
|
|
3106
|
+
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.DraftPostService
|
|
3107
|
+
* @slug updated
|
|
3108
|
+
*/
|
|
3109
|
+
export declare function onDraftUpdated(handler: (event: DraftUpdatedEnvelope) => void | Promise<void>): void;
|
|
3110
|
+
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`;
|
|
3111
|
+
/**
|
|
3112
|
+
* Creates a draft post.
|
|
3113
|
+
*
|
|
3114
|
+
* For 3rd-party apps, `memberId` is a required field.
|
|
3115
|
+
*
|
|
3116
|
+
* In `categoryIds`, only categories that already exist will be added to the draft post. Including
|
|
3117
|
+
* `categoryIds` that do not exist will not return an error, but they will not be added to the `categoryIds` array.
|
|
3118
|
+
* If some of the categories exist, those will be added while those that do not exist will not be added to `categoryIds`.
|
|
3119
|
+
* You can check which categories are available with
|
|
3120
|
+
* 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)).
|
|
3121
|
+
* @param draftPost - Draft post to create.
|
|
3122
|
+
* @public
|
|
3123
|
+
* @requiredField draftPost
|
|
3124
|
+
* @requiredField draftPost.title
|
|
3125
|
+
* @param options - Options for creating a draft post.
|
|
3126
|
+
* @permissionId BLOG.CREATE-DRAFT
|
|
3127
|
+
* @permissionScope Manage Blog
|
|
3128
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3129
|
+
* @applicableIdentity APP
|
|
3130
|
+
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.CreateDraftPost
|
|
3131
|
+
*/
|
|
3132
|
+
export declare function createDraftPost(draftPost: NonNullablePaths<DraftPost, `title`>, options?: CreateDraftPostOptions): Promise<NonNullablePaths<CreateDraftPostResponse, {
|
|
3133
|
+
[P in DraftNonNullablePaths]: `draftPost.${P}`;
|
|
3134
|
+
}[DraftNonNullablePaths]>>;
|
|
3135
|
+
export interface CreateDraftPostOptions {
|
|
3050
3136
|
/**
|
|
3051
3137
|
* Whether the draft post should be published on creation.
|
|
3052
3138
|
*
|
|
@@ -3061,7 +3147,23 @@ interface CreateDraftPostOptions {
|
|
|
3061
3147
|
*/
|
|
3062
3148
|
fieldsets?: Field[];
|
|
3063
3149
|
}
|
|
3064
|
-
|
|
3150
|
+
/**
|
|
3151
|
+
* Creates multiple draft posts.
|
|
3152
|
+
* @param draftPosts - Draft posts to create.
|
|
3153
|
+
* @public
|
|
3154
|
+
* @requiredField draftPosts
|
|
3155
|
+
* @requiredField draftPosts.title
|
|
3156
|
+
* @param options - Options for creating multiple draft posts.
|
|
3157
|
+
* @permissionId BLOG.CREATE-DRAFT
|
|
3158
|
+
* @permissionScope Manage Blog
|
|
3159
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3160
|
+
* @applicableIdentity APP
|
|
3161
|
+
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.BulkCreateDraftPosts
|
|
3162
|
+
*/
|
|
3163
|
+
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` | {
|
|
3164
|
+
[P in DraftNonNullablePaths]: `results.${number}.item.${P}`;
|
|
3165
|
+
}[DraftNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
3166
|
+
export interface BulkCreateDraftPostsOptions {
|
|
3065
3167
|
/** Whether the draft post should be published after creation. */
|
|
3066
3168
|
publish?: boolean;
|
|
3067
3169
|
/** Whether to return the full created draft post entities in the response. */
|
|
@@ -3074,7 +3176,22 @@ interface BulkCreateDraftPostsOptions {
|
|
|
3074
3176
|
*/
|
|
3075
3177
|
fieldsets?: Field[];
|
|
3076
3178
|
}
|
|
3077
|
-
|
|
3179
|
+
/**
|
|
3180
|
+
* Updates multiple draft posts.
|
|
3181
|
+
* @public
|
|
3182
|
+
* @requiredField options.draftPosts.draftPost
|
|
3183
|
+
* @requiredField options.draftPosts.draftPost._id
|
|
3184
|
+
* @param options - Options for updating multiple draft posts.
|
|
3185
|
+
* @permissionId BLOG.EDIT-DRAFT
|
|
3186
|
+
* @permissionScope Manage Blog
|
|
3187
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3188
|
+
* @applicableIdentity APP
|
|
3189
|
+
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.BulkUpdateDraftPosts
|
|
3190
|
+
*/
|
|
3191
|
+
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` | {
|
|
3192
|
+
[P in DraftNonNullablePaths]: `results.${number}.item.${P}`;
|
|
3193
|
+
}[DraftNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
3194
|
+
export interface BulkUpdateDraftPostsOptions {
|
|
3078
3195
|
/**
|
|
3079
3196
|
* Draft posts to update.
|
|
3080
3197
|
* @minSize 1
|
|
@@ -3099,7 +3216,25 @@ interface BulkUpdateDraftPostsOptions {
|
|
|
3099
3216
|
*/
|
|
3100
3217
|
fieldsets?: Field[];
|
|
3101
3218
|
}
|
|
3102
|
-
|
|
3219
|
+
/**
|
|
3220
|
+
* Retrieves a list of up to 100 deleted draft posts.
|
|
3221
|
+
*
|
|
3222
|
+
* List Draft Posts runs with these defaults, which you can override:
|
|
3223
|
+
* - `editedDate` is sorted in descending order. In this case,`editedDate` implies the date the post was deleted.
|
|
3224
|
+
* - `paging.limit` is `50`.
|
|
3225
|
+
* - `paging.offset` is `0`.
|
|
3226
|
+
* @public
|
|
3227
|
+
* @param options - Options for listing deleted draft posts.
|
|
3228
|
+
* @permissionId BLOG.READ_DRAFT
|
|
3229
|
+
* @permissionScope Manage Blog
|
|
3230
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3231
|
+
* @applicableIdentity APP
|
|
3232
|
+
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.ListDeletedDraftPosts
|
|
3233
|
+
*/
|
|
3234
|
+
export declare function listDeletedDraftPosts(options?: ListDeletedDraftPostsOptions): Promise<NonNullablePaths<ListDeletedDraftPostsResponse, {
|
|
3235
|
+
[P in DraftNonNullablePaths]: `draftPosts.${number}.${P}`;
|
|
3236
|
+
}[DraftNonNullablePaths] | `metaData.count` | `metaData.offset` | `metaData.total`>>;
|
|
3237
|
+
export interface ListDeletedDraftPostsOptions {
|
|
3103
3238
|
/**
|
|
3104
3239
|
* Language filter.
|
|
3105
3240
|
*
|
|
@@ -3130,7 +3265,22 @@ interface ListDeletedDraftPostsOptions {
|
|
|
3130
3265
|
*/
|
|
3131
3266
|
draftPostIds?: string[];
|
|
3132
3267
|
}
|
|
3133
|
-
|
|
3268
|
+
/**
|
|
3269
|
+
* Retrieves a draft post by the provided ID.
|
|
3270
|
+
* @param draftPostId - Draft post ID.
|
|
3271
|
+
* @public
|
|
3272
|
+
* @requiredField draftPostId
|
|
3273
|
+
* @param options - Options for getting a draft post.
|
|
3274
|
+
* @permissionId BLOG.READ_DRAFT
|
|
3275
|
+
* @permissionScope Manage Blog
|
|
3276
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3277
|
+
* @applicableIdentity APP
|
|
3278
|
+
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.GetDraftPost
|
|
3279
|
+
*/
|
|
3280
|
+
export declare function getDraftPost(draftPostId: string, options?: GetDraftPostOptions): Promise<NonNullablePaths<GetDraftPostResponse, {
|
|
3281
|
+
[P in DraftNonNullablePaths]: `draftPost.${P}`;
|
|
3282
|
+
}[DraftNonNullablePaths]>>;
|
|
3283
|
+
export interface GetDraftPostOptions {
|
|
3134
3284
|
/**
|
|
3135
3285
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3136
3286
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
@@ -3139,7 +3289,24 @@ interface GetDraftPostOptions {
|
|
|
3139
3289
|
*/
|
|
3140
3290
|
fieldsets?: Field[];
|
|
3141
3291
|
}
|
|
3142
|
-
|
|
3292
|
+
/**
|
|
3293
|
+
* Updates a draft post.
|
|
3294
|
+
* @param _id - Draft post ID.
|
|
3295
|
+
* @public
|
|
3296
|
+
* @requiredField _id
|
|
3297
|
+
* @requiredField draftPost
|
|
3298
|
+
* @param options - Options for updating a draft post.
|
|
3299
|
+
* @param draftPost - Draft Post info.
|
|
3300
|
+
* @permissionId BLOG.EDIT-DRAFT
|
|
3301
|
+
* @permissionScope Manage Blog
|
|
3302
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3303
|
+
* @applicableIdentity APP
|
|
3304
|
+
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.UpdateDraftPost
|
|
3305
|
+
*/
|
|
3306
|
+
export declare function updateDraftPost(_id: string, draftPost: UpdateDraftPost, options?: UpdateDraftPostOptions): Promise<NonNullablePaths<UpdateDraftPostResponse, {
|
|
3307
|
+
[P in DraftNonNullablePaths]: `draftPost.${P}`;
|
|
3308
|
+
}[DraftNonNullablePaths]>>;
|
|
3309
|
+
export interface UpdateDraftPost {
|
|
3143
3310
|
/**
|
|
3144
3311
|
* Draft post ID.
|
|
3145
3312
|
* @readonly
|
|
@@ -3274,7 +3441,7 @@ interface UpdateDraftPost {
|
|
|
3274
3441
|
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
|
3275
3442
|
previewTextParagraph?: number | null;
|
|
3276
3443
|
}
|
|
3277
|
-
interface UpdateDraftPostOptions {
|
|
3444
|
+
export interface UpdateDraftPostOptions {
|
|
3278
3445
|
/**
|
|
3279
3446
|
* Action to perform on the post.
|
|
3280
3447
|
*
|
|
@@ -3291,7 +3458,23 @@ interface UpdateDraftPostOptions {
|
|
|
3291
3458
|
*/
|
|
3292
3459
|
fieldsets?: Field[];
|
|
3293
3460
|
}
|
|
3294
|
-
|
|
3461
|
+
/**
|
|
3462
|
+
* Moves a draft post to the trash bin.
|
|
3463
|
+
* 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.
|
|
3464
|
+
*
|
|
3465
|
+
* To permanently delete a post bypassing the trash bin, set the `permanent` field value to `true`. The post can't be restored after this.
|
|
3466
|
+
* @param draftPostId - Draft post ID.
|
|
3467
|
+
* @public
|
|
3468
|
+
* @requiredField draftPostId
|
|
3469
|
+
* @param options - Options for deleting a draft post.
|
|
3470
|
+
* @permissionId BLOG.DELETE-DRAFT
|
|
3471
|
+
* @permissionScope Manage Blog
|
|
3472
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3473
|
+
* @applicableIdentity APP
|
|
3474
|
+
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.DeleteDraftPost
|
|
3475
|
+
*/
|
|
3476
|
+
export declare function deleteDraftPost(draftPostId: string, options?: DeleteDraftPostOptions): Promise<void>;
|
|
3477
|
+
export interface DeleteDraftPostOptions {
|
|
3295
3478
|
/**
|
|
3296
3479
|
* Whether to bypass the trash bin and delete the post permanently.
|
|
3297
3480
|
*
|
|
@@ -3299,11 +3482,58 @@ interface DeleteDraftPostOptions {
|
|
|
3299
3482
|
*/
|
|
3300
3483
|
permanent?: boolean;
|
|
3301
3484
|
}
|
|
3302
|
-
|
|
3485
|
+
/**
|
|
3486
|
+
* Permanently deletes a draft post that is currently in the trash bin.
|
|
3487
|
+
*
|
|
3488
|
+
* This action is permanent and can't be reversed.
|
|
3489
|
+
* @param draftPostId - Draft post ID.
|
|
3490
|
+
* @public
|
|
3491
|
+
* @requiredField draftPostId
|
|
3492
|
+
* @permissionId BLOG.DELETE-DRAFT
|
|
3493
|
+
* @permissionScope Manage Blog
|
|
3494
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3495
|
+
* @applicableIdentity APP
|
|
3496
|
+
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.RemoveFromTrashBin
|
|
3497
|
+
*/
|
|
3498
|
+
export declare function removeFromTrashBin(draftPostId: string): Promise<void>;
|
|
3499
|
+
/**
|
|
3500
|
+
* Deletes multiple draft posts.
|
|
3501
|
+
* @param postIds - Post IDs.
|
|
3502
|
+
* @public
|
|
3503
|
+
* @requiredField postIds
|
|
3504
|
+
* @param options - Options for deleting multiple draft posts.
|
|
3505
|
+
* @permissionId BLOG.DELETE-DRAFT
|
|
3506
|
+
* @permissionScope Manage Blog
|
|
3507
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3508
|
+
* @applicableIdentity APP
|
|
3509
|
+
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.BulkDeleteDraftPosts
|
|
3510
|
+
*/
|
|
3511
|
+
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` | {
|
|
3512
|
+
[P in DraftNonNullablePaths]: `results.${number}.item.${P}`;
|
|
3513
|
+
}[DraftNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
3514
|
+
export interface BulkDeleteDraftPostsOptions {
|
|
3303
3515
|
/** Should delete bypassing the trash-bin. */
|
|
3304
3516
|
permanent?: boolean;
|
|
3305
3517
|
}
|
|
3306
|
-
|
|
3518
|
+
/**
|
|
3519
|
+
* Retrieves a list of up to 100 draft posts per request.
|
|
3520
|
+
*
|
|
3521
|
+
* List Draft Posts runs with these defaults, which you can override:
|
|
3522
|
+
* - `editedDate` is sorted in descending order.
|
|
3523
|
+
* - `paging.limit` is `50`.
|
|
3524
|
+
* - `paging.offset` is `0`.
|
|
3525
|
+
* @public
|
|
3526
|
+
* @param options - Options for listing multiple draft posts.
|
|
3527
|
+
* @permissionId BLOG.READ_DRAFT
|
|
3528
|
+
* @permissionScope Manage Blog
|
|
3529
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3530
|
+
* @applicableIdentity APP
|
|
3531
|
+
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.ListDraftPosts
|
|
3532
|
+
*/
|
|
3533
|
+
export declare function listDraftPosts(options?: ListDraftPostsOptions): Promise<NonNullablePaths<ListDraftPostsResponse, {
|
|
3534
|
+
[P in DraftNonNullablePaths]: `draftPosts.${number}.${P}`;
|
|
3535
|
+
}[DraftNonNullablePaths] | `metaData.count` | `metaData.offset` | `metaData.total`>>;
|
|
3536
|
+
export interface ListDraftPostsOptions {
|
|
3307
3537
|
/**
|
|
3308
3538
|
* Draft post status filter.
|
|
3309
3539
|
*
|
|
@@ -3334,7 +3564,59 @@ interface ListDraftPostsOptions {
|
|
|
3334
3564
|
*/
|
|
3335
3565
|
fieldsets?: Field[];
|
|
3336
3566
|
}
|
|
3337
|
-
|
|
3567
|
+
/**
|
|
3568
|
+
* Retrieves a deleted draft post from the trash bin by the provided ID.
|
|
3569
|
+
* @param draftPostId - Draft post ID.
|
|
3570
|
+
* @public
|
|
3571
|
+
* @requiredField draftPostId
|
|
3572
|
+
* @permissionId BLOG.READ_DRAFT
|
|
3573
|
+
* @permissionScope Manage Blog
|
|
3574
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3575
|
+
* @applicableIdentity APP
|
|
3576
|
+
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.GetDeletedDraftPost
|
|
3577
|
+
*/
|
|
3578
|
+
export declare function getDeletedDraftPost(draftPostId: string): Promise<NonNullablePaths<GetDeletedDraftPostResponse, {
|
|
3579
|
+
[P in DraftNonNullablePaths]: `draftPost.${P}`;
|
|
3580
|
+
}[DraftNonNullablePaths]>>;
|
|
3581
|
+
/**
|
|
3582
|
+
* Restores a deleted draft post from the trash bin by the provided ID.
|
|
3583
|
+
* @param draftPostId - Draft post ID.
|
|
3584
|
+
* @public
|
|
3585
|
+
* @requiredField draftPostId
|
|
3586
|
+
* @permissionId BLOG.EDIT-DRAFT
|
|
3587
|
+
* @permissionScope Manage Blog
|
|
3588
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3589
|
+
* @applicableIdentity APP
|
|
3590
|
+
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.RestoreFromTrashBin
|
|
3591
|
+
*/
|
|
3592
|
+
export declare function restoreFromTrashBin(draftPostId: string): Promise<NonNullablePaths<RestoreFromTrashBinResponse, {
|
|
3593
|
+
[P in DraftNonNullablePaths]: `draftPost.${P}`;
|
|
3594
|
+
}[DraftNonNullablePaths]>>;
|
|
3595
|
+
/**
|
|
3596
|
+
* Creates a query to retrieve a list of up to 100 draft posts.
|
|
3597
|
+
*
|
|
3598
|
+
*
|
|
3599
|
+
* The `queryDraftPosts()` function builds a query to retrieve a list of up to 100 draft posts, and returns a `DraftPostsQueryBuilder` object.
|
|
3600
|
+
*
|
|
3601
|
+
* The returned object contains the query definition, which is typically used to run the query using the `find()` function.
|
|
3602
|
+
*
|
|
3603
|
+
* 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.
|
|
3604
|
+
*
|
|
3605
|
+
* `queryDraftPosts()` runs with these `DraftPostsQueryBuilder` defaults that can be overridden:
|
|
3606
|
+
* - `limit(50)`
|
|
3607
|
+
* - `ascending('_id')`
|
|
3608
|
+
*
|
|
3609
|
+
* 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`.
|
|
3610
|
+
* @public
|
|
3611
|
+
* @param options - Options for querying draft posts.
|
|
3612
|
+
* @permissionScope Manage Blog
|
|
3613
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3614
|
+
* @permissionId BLOG.READ_DRAFT
|
|
3615
|
+
* @applicableIdentity APP
|
|
3616
|
+
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.QueryDraftPosts
|
|
3617
|
+
*/
|
|
3618
|
+
export declare function queryDraftPosts(options?: QueryDraftPostsOptions): DraftPostsQueryBuilder;
|
|
3619
|
+
export interface QueryDraftPostsOptions {
|
|
3338
3620
|
/**
|
|
3339
3621
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3340
3622
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
@@ -3350,13 +3632,13 @@ interface QueryCursorResult {
|
|
|
3350
3632
|
length: number;
|
|
3351
3633
|
pageSize: number;
|
|
3352
3634
|
}
|
|
3353
|
-
interface DraftPostsQueryResult extends QueryCursorResult {
|
|
3635
|
+
export interface DraftPostsQueryResult extends QueryCursorResult {
|
|
3354
3636
|
items: DraftPost[];
|
|
3355
3637
|
query: DraftPostsQueryBuilder;
|
|
3356
3638
|
next: () => Promise<DraftPostsQueryResult>;
|
|
3357
3639
|
prev: () => Promise<DraftPostsQueryResult>;
|
|
3358
3640
|
}
|
|
3359
|
-
interface DraftPostsQueryBuilder {
|
|
3641
|
+
export interface DraftPostsQueryBuilder {
|
|
3360
3642
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
3361
3643
|
* @param value - Value to compare against.
|
|
3362
3644
|
*/
|
|
@@ -3405,5 +3687,20 @@ interface DraftPostsQueryBuilder {
|
|
|
3405
3687
|
skipTo: (cursor: string) => DraftPostsQueryBuilder;
|
|
3406
3688
|
find: () => Promise<DraftPostsQueryResult>;
|
|
3407
3689
|
}
|
|
3408
|
-
|
|
3409
|
-
|
|
3690
|
+
/**
|
|
3691
|
+
* Publishes a draft post by ID. This creates a new post ([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))
|
|
3692
|
+
* with the data from the draft post.
|
|
3693
|
+
*
|
|
3694
|
+
* If the draft post was already published, the published post will be updated with the latest values
|
|
3695
|
+
* from the draft post.
|
|
3696
|
+
* @param draftPostId - Draft post ID.
|
|
3697
|
+
* @public
|
|
3698
|
+
* @requiredField draftPostId
|
|
3699
|
+
* @permissionId BLOG.PUBLISH-POST
|
|
3700
|
+
* @permissionScope Manage Blog
|
|
3701
|
+
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
|
3702
|
+
* @applicableIdentity APP
|
|
3703
|
+
* @fqn com.wixpress.npm.communities.platformized.blog.v3.DraftPostService.PublishDraftPost
|
|
3704
|
+
*/
|
|
3705
|
+
export declare function publishDraftPost(draftPostId: string): Promise<NonNullablePaths<PublishDraftPostResponse, `postId`>>;
|
|
3706
|
+
export {};
|