@wix/auto_sdk_blog_posts 1.0.31 → 1.0.33
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/{src/blog-v3-post-posts.universal.d.ts → blog-v3-post-posts.universal-hTPKKRYx.d.ts} +299 -563
- package/build/cjs/index.d.ts +127 -1
- package/build/cjs/index.js +1967 -15
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +2160 -1
- package/build/cjs/meta.js +999 -15
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{src/blog-v3-post-posts.universal.d.ts → blog-v3-post-posts.universal-hTPKKRYx.d.mts} +299 -563
- package/build/es/index.d.mts +127 -0
- package/build/es/index.mjs +1894 -0
- package/build/es/index.mjs.map +1 -0
- package/build/es/{src/blog-v3-post-posts.types.d.ts → meta.d.mts} +259 -1412
- package/build/es/meta.mjs +969 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/internal/cjs/{src/blog-v3-post-posts.universal.d.ts → blog-v3-post-posts.universal-D8MomLjA.d.ts} +299 -563
- package/build/internal/cjs/index.d.ts +127 -1
- package/build/internal/cjs/index.js +1967 -15
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +2160 -1
- package/build/internal/cjs/meta.js +999 -15
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/{src/blog-v3-post-posts.universal.d.ts → blog-v3-post-posts.universal-D8MomLjA.d.mts} +299 -563
- package/build/internal/es/index.d.mts +127 -0
- package/build/internal/es/index.mjs +1894 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/{cjs/src/blog-v3-post-posts.types.d.ts → internal/es/meta.d.mts} +259 -1412
- package/build/internal/es/meta.mjs +969 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +9 -8
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.context.d.ts +0 -37
- package/build/cjs/src/blog-v3-post-posts.context.js +0 -82
- package/build/cjs/src/blog-v3-post-posts.context.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.http.d.ts +0 -61
- package/build/cjs/src/blog-v3-post-posts.http.js +0 -894
- package/build/cjs/src/blog-v3-post-posts.http.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.meta.d.ts +0 -25
- package/build/cjs/src/blog-v3-post-posts.meta.js +0 -161
- package/build/cjs/src/blog-v3-post-posts.meta.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.public.d.ts +0 -106
- package/build/cjs/src/blog-v3-post-posts.public.js +0 -320
- package/build/cjs/src/blog-v3-post-posts.public.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.types.js +0 -485
- package/build/cjs/src/blog-v3-post-posts.types.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.universal.js +0 -974
- package/build/cjs/src/blog-v3-post-posts.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/blog-v3-post-posts.context.d.ts +0 -37
- package/build/es/src/blog-v3-post-posts.context.js +0 -37
- package/build/es/src/blog-v3-post-posts.context.js.map +0 -1
- package/build/es/src/blog-v3-post-posts.http.d.ts +0 -61
- package/build/es/src/blog-v3-post-posts.http.js +0 -884
- package/build/es/src/blog-v3-post-posts.http.js.map +0 -1
- package/build/es/src/blog-v3-post-posts.meta.d.ts +0 -25
- package/build/es/src/blog-v3-post-posts.meta.js +0 -128
- package/build/es/src/blog-v3-post-posts.meta.js.map +0 -1
- package/build/es/src/blog-v3-post-posts.public.d.ts +0 -106
- package/build/es/src/blog-v3-post-posts.public.js +0 -268
- package/build/es/src/blog-v3-post-posts.public.js.map +0 -1
- package/build/es/src/blog-v3-post-posts.types.js +0 -482
- package/build/es/src/blog-v3-post-posts.types.js.map +0 -1
- package/build/es/src/blog-v3-post-posts.universal.js +0 -941
- package/build/es/src/blog-v3-post-posts.universal.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.context.d.ts +0 -37
- package/build/internal/cjs/src/blog-v3-post-posts.context.js +0 -82
- package/build/internal/cjs/src/blog-v3-post-posts.context.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.http.d.ts +0 -61
- package/build/internal/cjs/src/blog-v3-post-posts.http.js +0 -894
- package/build/internal/cjs/src/blog-v3-post-posts.http.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.meta.d.ts +0 -25
- package/build/internal/cjs/src/blog-v3-post-posts.meta.js +0 -161
- package/build/internal/cjs/src/blog-v3-post-posts.meta.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.public.d.ts +0 -106
- package/build/internal/cjs/src/blog-v3-post-posts.public.js +0 -320
- package/build/internal/cjs/src/blog-v3-post-posts.public.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.types.d.ts +0 -3313
- package/build/internal/cjs/src/blog-v3-post-posts.types.js +0 -485
- package/build/internal/cjs/src/blog-v3-post-posts.types.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.universal.js +0 -974
- package/build/internal/cjs/src/blog-v3-post-posts.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.context.d.ts +0 -37
- package/build/internal/es/src/blog-v3-post-posts.context.js +0 -37
- package/build/internal/es/src/blog-v3-post-posts.context.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.http.d.ts +0 -61
- package/build/internal/es/src/blog-v3-post-posts.http.js +0 -884
- package/build/internal/es/src/blog-v3-post-posts.http.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.meta.d.ts +0 -25
- package/build/internal/es/src/blog-v3-post-posts.meta.js +0 -128
- package/build/internal/es/src/blog-v3-post-posts.meta.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.public.d.ts +0 -106
- package/build/internal/es/src/blog-v3-post-posts.public.js +0 -268
- package/build/internal/es/src/blog-v3-post-posts.public.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.types.d.ts +0 -3313
- package/build/internal/es/src/blog-v3-post-posts.types.js +0 -482
- package/build/internal/es/src/blog-v3-post-posts.types.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.universal.js +0 -941
- package/build/internal/es/src/blog-v3-post-posts.universal.js.map +0 -1
@@ -1,5 +1,4 @@
|
|
1
|
-
|
2
|
-
export interface Post {
|
1
|
+
interface Post {
|
3
2
|
/**
|
4
3
|
* Post ID.
|
5
4
|
* @readonly
|
@@ -175,7 +174,7 @@ export interface Post {
|
|
175
174
|
*/
|
176
175
|
referenceId?: string | null;
|
177
176
|
}
|
178
|
-
|
177
|
+
interface CoverMedia extends CoverMediaMediaOneOf {
|
179
178
|
/** Image url. */
|
180
179
|
image?: string;
|
181
180
|
/** Video url. */
|
@@ -201,13 +200,13 @@ export interface CoverMedia extends CoverMediaMediaOneOf {
|
|
201
200
|
altText?: string | null;
|
202
201
|
}
|
203
202
|
/** @oneof */
|
204
|
-
|
203
|
+
interface CoverMediaMediaOneOf {
|
205
204
|
/** Image url. */
|
206
205
|
image?: string;
|
207
206
|
/** Video url. */
|
208
207
|
video?: string;
|
209
208
|
}
|
210
|
-
|
209
|
+
interface FocalPoint {
|
211
210
|
/** X-coordinate of the focal point. */
|
212
211
|
x?: number;
|
213
212
|
/** Y-coordinate of the focal point. */
|
@@ -217,7 +216,7 @@ export interface FocalPoint {
|
|
217
216
|
/** crop by width */
|
218
217
|
width?: number | null;
|
219
218
|
}
|
220
|
-
|
219
|
+
interface PostCountInfo {
|
221
220
|
/**
|
222
221
|
* Total number of post comments
|
223
222
|
* @readonly
|
@@ -234,7 +233,7 @@ export interface PostCountInfo {
|
|
234
233
|
*/
|
235
234
|
views?: number;
|
236
235
|
}
|
237
|
-
|
236
|
+
interface Metrics {
|
238
237
|
/**
|
239
238
|
* Total number of post comments.
|
240
239
|
* @readonly
|
@@ -256,13 +255,13 @@ export interface Metrics {
|
|
256
255
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
257
256
|
* 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.
|
258
257
|
*/
|
259
|
-
|
258
|
+
interface SeoSchema {
|
260
259
|
/** SEO tag information. */
|
261
260
|
tags?: Tag[];
|
262
261
|
/** SEO general settings. */
|
263
262
|
settings?: Settings;
|
264
263
|
}
|
265
|
-
|
264
|
+
interface Keyword {
|
266
265
|
/** Keyword value. */
|
267
266
|
term?: string;
|
268
267
|
/** Whether the keyword is the main focus keyword. */
|
@@ -273,7 +272,7 @@ export interface Keyword {
|
|
273
272
|
*/
|
274
273
|
origin?: string | null;
|
275
274
|
}
|
276
|
-
|
275
|
+
interface Tag {
|
277
276
|
/**
|
278
277
|
* SEO tag type.
|
279
278
|
*
|
@@ -295,7 +294,7 @@ export interface Tag {
|
|
295
294
|
/** Whether the tag is disabled. */
|
296
295
|
disabled?: boolean;
|
297
296
|
}
|
298
|
-
|
297
|
+
interface Settings {
|
299
298
|
/**
|
300
299
|
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
301
300
|
*
|
@@ -309,7 +308,7 @@ export interface Settings {
|
|
309
308
|
*/
|
310
309
|
keywords?: Keyword[];
|
311
310
|
}
|
312
|
-
|
311
|
+
interface RichContent {
|
313
312
|
/** Node objects representing a rich content document. */
|
314
313
|
nodes?: Node[];
|
315
314
|
/** Object metadata. */
|
@@ -317,7 +316,7 @@ export interface RichContent {
|
|
317
316
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
318
317
|
documentStyle?: DocumentStyle;
|
319
318
|
}
|
320
|
-
|
319
|
+
interface Node extends NodeDataOneOf {
|
321
320
|
/** Data for a button node. */
|
322
321
|
buttonData?: ButtonData;
|
323
322
|
/** Data for a code block node. */
|
@@ -382,7 +381,7 @@ export interface Node extends NodeDataOneOf {
|
|
382
381
|
style?: NodeStyle;
|
383
382
|
}
|
384
383
|
/** @oneof */
|
385
|
-
|
384
|
+
interface NodeDataOneOf {
|
386
385
|
/** Data for a button node. */
|
387
386
|
buttonData?: ButtonData;
|
388
387
|
/** Data for a code block node. */
|
@@ -438,7 +437,7 @@ export interface NodeDataOneOf {
|
|
438
437
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
439
438
|
layoutCellData?: LayoutCellData;
|
440
439
|
}
|
441
|
-
|
440
|
+
declare enum NodeType {
|
442
441
|
PARAGRAPH = "PARAGRAPH",
|
443
442
|
TEXT = "TEXT",
|
444
443
|
HEADING = "HEADING",
|
@@ -475,8 +474,8 @@ export declare enum NodeType {
|
|
475
474
|
LAYOUT_CELL = "LAYOUT_CELL"
|
476
475
|
}
|
477
476
|
/** @enumType */
|
478
|
-
|
479
|
-
|
477
|
+
type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
|
478
|
+
interface NodeStyle {
|
480
479
|
/** The top padding value in pixels. */
|
481
480
|
paddingTop?: string | null;
|
482
481
|
/** The bottom padding value in pixels. */
|
@@ -484,7 +483,7 @@ export interface NodeStyle {
|
|
484
483
|
/** The background color as a hexadecimal value. */
|
485
484
|
backgroundColor?: string | null;
|
486
485
|
}
|
487
|
-
|
486
|
+
interface ButtonData {
|
488
487
|
/** Styling for the button's container. */
|
489
488
|
containerData?: PluginContainerData;
|
490
489
|
/** The button type. */
|
@@ -496,13 +495,13 @@ export interface ButtonData {
|
|
496
495
|
/** Button link details. */
|
497
496
|
link?: Link;
|
498
497
|
}
|
499
|
-
|
498
|
+
interface Border {
|
500
499
|
/** Border width in pixels. */
|
501
500
|
width?: number | null;
|
502
501
|
/** Border radius in pixels. */
|
503
502
|
radius?: number | null;
|
504
503
|
}
|
505
|
-
|
504
|
+
interface Colors {
|
506
505
|
/** The text color as a hexadecimal value. */
|
507
506
|
text?: string | null;
|
508
507
|
/** The border color as a hexadecimal value. */
|
@@ -510,7 +509,7 @@ export interface Colors {
|
|
510
509
|
/** The background color as a hexadecimal value. */
|
511
510
|
background?: string | null;
|
512
511
|
}
|
513
|
-
|
512
|
+
interface PluginContainerData {
|
514
513
|
/** The width of the node when it's displayed. */
|
515
514
|
width?: PluginContainerDataWidth;
|
516
515
|
/** The node's alignment within its container. */
|
@@ -522,7 +521,7 @@ export interface PluginContainerData {
|
|
522
521
|
/** 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`. */
|
523
522
|
textWrap?: boolean | null;
|
524
523
|
}
|
525
|
-
|
524
|
+
declare enum WidthType {
|
526
525
|
/** Width matches the content width */
|
527
526
|
CONTENT = "CONTENT",
|
528
527
|
/** Small Width */
|
@@ -533,8 +532,8 @@ export declare enum WidthType {
|
|
533
532
|
FULL_WIDTH = "FULL_WIDTH"
|
534
533
|
}
|
535
534
|
/** @enumType */
|
536
|
-
|
537
|
-
|
535
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
536
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
538
537
|
/**
|
539
538
|
* One of the following predefined width options:
|
540
539
|
* `CONTENT`: The width of the container matches the content width.
|
@@ -547,7 +546,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
547
546
|
custom?: string | null;
|
548
547
|
}
|
549
548
|
/** @oneof */
|
550
|
-
|
549
|
+
interface PluginContainerDataWidthDataOneOf {
|
551
550
|
/**
|
552
551
|
* One of the following predefined width options:
|
553
552
|
* `CONTENT`: The width of the container matches the content width.
|
@@ -559,7 +558,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
559
558
|
/** A custom width value in pixels. */
|
560
559
|
custom?: string | null;
|
561
560
|
}
|
562
|
-
|
561
|
+
declare enum PluginContainerDataAlignment {
|
563
562
|
/** Center Alignment */
|
564
563
|
CENTER = "CENTER",
|
565
564
|
/** Left Alignment */
|
@@ -568,8 +567,8 @@ export declare enum PluginContainerDataAlignment {
|
|
568
567
|
RIGHT = "RIGHT"
|
569
568
|
}
|
570
569
|
/** @enumType */
|
571
|
-
|
572
|
-
|
570
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
571
|
+
interface Spoiler {
|
573
572
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
574
573
|
enabled?: boolean | null;
|
575
574
|
/** The description displayed on top of the spoiler cover. */
|
@@ -577,25 +576,25 @@ export interface Spoiler {
|
|
577
576
|
/** The text for the button used to remove the spoiler cover. */
|
578
577
|
buttonText?: string | null;
|
579
578
|
}
|
580
|
-
|
579
|
+
interface Height {
|
581
580
|
/** A custom height value in pixels. */
|
582
581
|
custom?: string | null;
|
583
582
|
}
|
584
|
-
|
583
|
+
declare enum Type {
|
585
584
|
/** Regular link button */
|
586
585
|
LINK = "LINK",
|
587
586
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
588
587
|
ACTION = "ACTION"
|
589
588
|
}
|
590
589
|
/** @enumType */
|
591
|
-
|
592
|
-
|
590
|
+
type TypeWithLiterals = Type | 'LINK' | 'ACTION';
|
591
|
+
interface Styles {
|
593
592
|
/** Border attributes. */
|
594
593
|
border?: Border;
|
595
594
|
/** Color attributes. */
|
596
595
|
colors?: Colors;
|
597
596
|
}
|
598
|
-
|
597
|
+
interface Link extends LinkDataOneOf {
|
599
598
|
/** The absolute URL for the linked document. */
|
600
599
|
url?: string;
|
601
600
|
/** The target node's ID. Used for linking to another node in this object. */
|
@@ -614,13 +613,13 @@ export interface Link extends LinkDataOneOf {
|
|
614
613
|
customData?: string | null;
|
615
614
|
}
|
616
615
|
/** @oneof */
|
617
|
-
|
616
|
+
interface LinkDataOneOf {
|
618
617
|
/** The absolute URL for the linked document. */
|
619
618
|
url?: string;
|
620
619
|
/** The target node's ID. Used for linking to another node in this object. */
|
621
620
|
anchor?: string;
|
622
621
|
}
|
623
|
-
|
622
|
+
declare enum Target {
|
624
623
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
625
624
|
SELF = "SELF",
|
626
625
|
/** Opens the linked document in a new window or tab */
|
@@ -631,8 +630,8 @@ export declare enum Target {
|
|
631
630
|
TOP = "TOP"
|
632
631
|
}
|
633
632
|
/** @enumType */
|
634
|
-
|
635
|
-
|
633
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
634
|
+
interface Rel {
|
636
635
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
637
636
|
nofollow?: boolean | null;
|
638
637
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
@@ -642,17 +641,17 @@ export interface Rel {
|
|
642
641
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
643
642
|
noreferrer?: boolean | null;
|
644
643
|
}
|
645
|
-
|
644
|
+
interface CodeBlockData {
|
646
645
|
/** Styling for the code block's text. */
|
647
646
|
textStyle?: TextStyle;
|
648
647
|
}
|
649
|
-
|
648
|
+
interface TextStyle {
|
650
649
|
/** Text alignment. Defaults to `AUTO`. */
|
651
650
|
textAlignment?: TextAlignmentWithLiterals;
|
652
651
|
/** 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. */
|
653
652
|
lineHeight?: string | null;
|
654
653
|
}
|
655
|
-
|
654
|
+
declare enum TextAlignment {
|
656
655
|
/** browser default, eqivalent to `initial` */
|
657
656
|
AUTO = "AUTO",
|
658
657
|
/** Left align */
|
@@ -665,8 +664,8 @@ export declare enum TextAlignment {
|
|
665
664
|
JUSTIFY = "JUSTIFY"
|
666
665
|
}
|
667
666
|
/** @enumType */
|
668
|
-
|
669
|
-
|
667
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
668
|
+
interface DividerData {
|
670
669
|
/** Styling for the divider's container. */
|
671
670
|
containerData?: PluginContainerData;
|
672
671
|
/** Divider line style. */
|
@@ -676,7 +675,7 @@ export interface DividerData {
|
|
676
675
|
/** Divider alignment. */
|
677
676
|
alignment?: AlignmentWithLiterals;
|
678
677
|
}
|
679
|
-
|
678
|
+
declare enum LineStyle {
|
680
679
|
/** Single Line */
|
681
680
|
SINGLE = "SINGLE",
|
682
681
|
/** Double Line */
|
@@ -687,8 +686,8 @@ export declare enum LineStyle {
|
|
687
686
|
DOTTED = "DOTTED"
|
688
687
|
}
|
689
688
|
/** @enumType */
|
690
|
-
|
691
|
-
|
689
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
690
|
+
declare enum Width {
|
692
691
|
/** Large line */
|
693
692
|
LARGE = "LARGE",
|
694
693
|
/** Medium line */
|
@@ -697,8 +696,8 @@ export declare enum Width {
|
|
697
696
|
SMALL = "SMALL"
|
698
697
|
}
|
699
698
|
/** @enumType */
|
700
|
-
|
701
|
-
|
699
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
700
|
+
declare enum Alignment {
|
702
701
|
/** Center alignment */
|
703
702
|
CENTER = "CENTER",
|
704
703
|
/** Left alignment */
|
@@ -707,8 +706,8 @@ export declare enum Alignment {
|
|
707
706
|
RIGHT = "RIGHT"
|
708
707
|
}
|
709
708
|
/** @enumType */
|
710
|
-
|
711
|
-
|
709
|
+
type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
710
|
+
interface FileData {
|
712
711
|
/** Styling for the file's container. */
|
713
712
|
containerData?: PluginContainerData;
|
714
713
|
/** The source for the file's data. */
|
@@ -731,7 +730,7 @@ export interface FileData {
|
|
731
730
|
/** File size in KB. */
|
732
731
|
sizeInKb?: string | null;
|
733
732
|
}
|
734
|
-
|
733
|
+
declare enum ViewMode {
|
735
734
|
/** No PDF view */
|
736
735
|
NONE = "NONE",
|
737
736
|
/** Full PDF view */
|
@@ -740,8 +739,8 @@ export declare enum ViewMode {
|
|
740
739
|
MINI = "MINI"
|
741
740
|
}
|
742
741
|
/** @enumType */
|
743
|
-
|
744
|
-
|
742
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
743
|
+
interface FileSource extends FileSourceDataOneOf {
|
745
744
|
/** The absolute URL for the file's source. */
|
746
745
|
url?: string | null;
|
747
746
|
/**
|
@@ -755,7 +754,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
755
754
|
private?: boolean | null;
|
756
755
|
}
|
757
756
|
/** @oneof */
|
758
|
-
|
757
|
+
interface FileSourceDataOneOf {
|
759
758
|
/** The absolute URL for the file's source. */
|
760
759
|
url?: string | null;
|
761
760
|
/**
|
@@ -766,7 +765,7 @@ export interface FileSourceDataOneOf {
|
|
766
765
|
/** An ID that's resolved to a URL by a resolver function. */
|
767
766
|
id?: string | null;
|
768
767
|
}
|
769
|
-
|
768
|
+
interface PDFSettings {
|
770
769
|
/**
|
771
770
|
* PDF view mode. One of the following:
|
772
771
|
* `NONE` : The PDF isn't displayed.
|
@@ -779,7 +778,7 @@ export interface PDFSettings {
|
|
779
778
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
780
779
|
disablePrint?: boolean | null;
|
781
780
|
}
|
782
|
-
|
781
|
+
interface GalleryData {
|
783
782
|
/** Styling for the gallery's container. */
|
784
783
|
containerData?: PluginContainerData;
|
785
784
|
/** The items in the gallery. */
|
@@ -791,7 +790,7 @@ export interface GalleryData {
|
|
791
790
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
792
791
|
disableDownload?: boolean | null;
|
793
792
|
}
|
794
|
-
|
793
|
+
interface V1Media {
|
795
794
|
/** The source for the media's data. */
|
796
795
|
src?: FileSource;
|
797
796
|
/** Media width in pixels. */
|
@@ -801,19 +800,19 @@ export interface V1Media {
|
|
801
800
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
802
801
|
duration?: number | null;
|
803
802
|
}
|
804
|
-
|
803
|
+
interface Image {
|
805
804
|
/** Image file details. */
|
806
805
|
media?: V1Media;
|
807
806
|
/** Link details for images that are links. */
|
808
807
|
link?: Link;
|
809
808
|
}
|
810
|
-
|
809
|
+
interface Video {
|
811
810
|
/** Video file details. */
|
812
811
|
media?: V1Media;
|
813
812
|
/** Video thumbnail file details. */
|
814
813
|
thumbnail?: V1Media;
|
815
814
|
}
|
816
|
-
|
815
|
+
interface Item extends ItemDataOneOf {
|
817
816
|
/** An image item. */
|
818
817
|
image?: Image;
|
819
818
|
/** A video item. */
|
@@ -824,13 +823,13 @@ export interface Item extends ItemDataOneOf {
|
|
824
823
|
altText?: string | null;
|
825
824
|
}
|
826
825
|
/** @oneof */
|
827
|
-
|
826
|
+
interface ItemDataOneOf {
|
828
827
|
/** An image item. */
|
829
828
|
image?: Image;
|
830
829
|
/** A video item. */
|
831
830
|
video?: Video;
|
832
831
|
}
|
833
|
-
|
832
|
+
interface GalleryOptions {
|
834
833
|
/** Gallery layout. */
|
835
834
|
layout?: Layout;
|
836
835
|
/** Styling for gallery items. */
|
@@ -838,7 +837,7 @@ export interface GalleryOptions {
|
|
838
837
|
/** Styling for gallery thumbnail images. */
|
839
838
|
thumbnails?: Thumbnails;
|
840
839
|
}
|
841
|
-
|
840
|
+
declare enum LayoutType {
|
842
841
|
/** Collage type */
|
843
842
|
COLLAGE = "COLLAGE",
|
844
843
|
/** Masonry type */
|
@@ -861,24 +860,24 @@ export declare enum LayoutType {
|
|
861
860
|
FULLSIZE = "FULLSIZE"
|
862
861
|
}
|
863
862
|
/** @enumType */
|
864
|
-
|
865
|
-
|
863
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
864
|
+
declare enum Orientation {
|
866
865
|
/** Rows Orientation */
|
867
866
|
ROWS = "ROWS",
|
868
867
|
/** Columns Orientation */
|
869
868
|
COLUMNS = "COLUMNS"
|
870
869
|
}
|
871
870
|
/** @enumType */
|
872
|
-
|
873
|
-
|
871
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
872
|
+
declare enum Crop {
|
874
873
|
/** Crop to fill */
|
875
874
|
FILL = "FILL",
|
876
875
|
/** Crop to fit */
|
877
876
|
FIT = "FIT"
|
878
877
|
}
|
879
878
|
/** @enumType */
|
880
|
-
|
881
|
-
|
879
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
880
|
+
declare enum ThumbnailsAlignment {
|
882
881
|
/** Top alignment */
|
883
882
|
TOP = "TOP",
|
884
883
|
/** Right alignment */
|
@@ -891,8 +890,8 @@ export declare enum ThumbnailsAlignment {
|
|
891
890
|
NONE = "NONE"
|
892
891
|
}
|
893
892
|
/** @enumType */
|
894
|
-
|
895
|
-
|
893
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
894
|
+
interface Layout {
|
896
895
|
/** Gallery layout type. */
|
897
896
|
type?: LayoutTypeWithLiterals;
|
898
897
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
@@ -904,7 +903,7 @@ export interface Layout {
|
|
904
903
|
/** The number of columns to display on mobile screens. */
|
905
904
|
mobileNumberOfColumns?: number | null;
|
906
905
|
}
|
907
|
-
|
906
|
+
interface ItemStyle {
|
908
907
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
909
908
|
targetSize?: number | null;
|
910
909
|
/** Item ratio */
|
@@ -914,13 +913,13 @@ export interface ItemStyle {
|
|
914
913
|
/** The spacing between items in pixels. */
|
915
914
|
spacing?: number | null;
|
916
915
|
}
|
917
|
-
|
916
|
+
interface Thumbnails {
|
918
917
|
/** Thumbnail alignment. */
|
919
918
|
placement?: ThumbnailsAlignmentWithLiterals;
|
920
919
|
/** Spacing between thumbnails in pixels. */
|
921
920
|
spacing?: number | null;
|
922
921
|
}
|
923
|
-
|
922
|
+
interface GIFData {
|
924
923
|
/** Styling for the GIF's container. */
|
925
924
|
containerData?: PluginContainerData;
|
926
925
|
/** The source of the full size GIF. */
|
@@ -934,7 +933,7 @@ export interface GIFData {
|
|
934
933
|
/** Type of GIF (Sticker or GIF). Defaults to `GIF`. */
|
935
934
|
gifType?: GIFTypeWithLiterals;
|
936
935
|
}
|
937
|
-
|
936
|
+
interface GIF {
|
938
937
|
/**
|
939
938
|
* GIF format URL.
|
940
939
|
* @format WEB_URL
|
@@ -951,13 +950,13 @@ export interface GIF {
|
|
951
950
|
*/
|
952
951
|
still?: string | null;
|
953
952
|
}
|
954
|
-
|
953
|
+
declare enum GIFType {
|
955
954
|
GIF = "GIF",
|
956
955
|
STICKER = "STICKER"
|
957
956
|
}
|
958
957
|
/** @enumType */
|
959
|
-
|
960
|
-
|
958
|
+
type GIFTypeWithLiterals = GIFType | 'GIF' | 'STICKER';
|
959
|
+
interface HeadingData {
|
961
960
|
/** Heading level from 1-6. */
|
962
961
|
level?: number;
|
963
962
|
/** Styling for the heading text. */
|
@@ -965,7 +964,7 @@ export interface HeadingData {
|
|
965
964
|
/** Indentation level from 1-4. */
|
966
965
|
indentation?: number | null;
|
967
966
|
}
|
968
|
-
|
967
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
969
968
|
/** The URL for the HTML code for the node. */
|
970
969
|
url?: string;
|
971
970
|
/** The HTML code for the node. */
|
@@ -983,7 +982,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
983
982
|
autoHeight?: boolean | null;
|
984
983
|
}
|
985
984
|
/** @oneof */
|
986
|
-
|
985
|
+
interface HTMLDataDataOneOf {
|
987
986
|
/** The URL for the HTML code for the node. */
|
988
987
|
url?: string;
|
989
988
|
/** The HTML code for the node. */
|
@@ -994,13 +993,13 @@ export interface HTMLDataDataOneOf {
|
|
994
993
|
*/
|
995
994
|
isAdsense?: boolean | null;
|
996
995
|
}
|
997
|
-
|
996
|
+
declare enum Source {
|
998
997
|
HTML = "HTML",
|
999
998
|
ADSENSE = "ADSENSE"
|
1000
999
|
}
|
1001
1000
|
/** @enumType */
|
1002
|
-
|
1003
|
-
|
1001
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
1002
|
+
interface ImageData {
|
1004
1003
|
/** Styling for the image's container. */
|
1005
1004
|
containerData?: PluginContainerData;
|
1006
1005
|
/** Image file details. */
|
@@ -1019,7 +1018,7 @@ export interface ImageData {
|
|
1019
1018
|
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
1020
1019
|
disableDownload?: boolean | null;
|
1021
1020
|
}
|
1022
|
-
|
1021
|
+
interface StylesBorder {
|
1023
1022
|
/** Border width in pixels. */
|
1024
1023
|
width?: number | null;
|
1025
1024
|
/**
|
@@ -1030,11 +1029,11 @@ export interface StylesBorder {
|
|
1030
1029
|
/** Border radius in pixels. */
|
1031
1030
|
radius?: number | null;
|
1032
1031
|
}
|
1033
|
-
|
1032
|
+
interface ImageDataStyles {
|
1034
1033
|
/** Border attributes. */
|
1035
1034
|
border?: StylesBorder;
|
1036
1035
|
}
|
1037
|
-
|
1036
|
+
interface LinkPreviewData {
|
1038
1037
|
/** Styling for the link preview's container. */
|
1039
1038
|
containerData?: PluginContainerData;
|
1040
1039
|
/** Link details. */
|
@@ -1048,7 +1047,7 @@ export interface LinkPreviewData {
|
|
1048
1047
|
/** The preview content as HTML. */
|
1049
1048
|
html?: string | null;
|
1050
1049
|
}
|
1051
|
-
|
1050
|
+
declare enum Position {
|
1052
1051
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
1053
1052
|
START = "START",
|
1054
1053
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
@@ -1059,8 +1058,8 @@ export declare enum Position {
|
|
1059
1058
|
HIDDEN = "HIDDEN"
|
1060
1059
|
}
|
1061
1060
|
/** @enumType */
|
1062
|
-
|
1063
|
-
|
1061
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
1062
|
+
interface LinkPreviewDataStyles {
|
1064
1063
|
/**
|
1065
1064
|
* Background color as a hexadecimal value.
|
1066
1065
|
* @format COLOR_HEX
|
@@ -1093,13 +1092,13 @@ export interface LinkPreviewDataStyles {
|
|
1093
1092
|
/** Position of thumbnail. Defaults to `START`. */
|
1094
1093
|
thumbnailPosition?: PositionWithLiterals;
|
1095
1094
|
}
|
1096
|
-
|
1095
|
+
interface MapData {
|
1097
1096
|
/** Styling for the map's container. */
|
1098
1097
|
containerData?: PluginContainerData;
|
1099
1098
|
/** Map settings. */
|
1100
1099
|
mapSettings?: MapSettings;
|
1101
1100
|
}
|
1102
|
-
|
1101
|
+
interface MapSettings {
|
1103
1102
|
/** The address to display on the map. */
|
1104
1103
|
address?: string | null;
|
1105
1104
|
/** Sets whether the map is draggable. */
|
@@ -1123,7 +1122,7 @@ export interface MapSettings {
|
|
1123
1122
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
1124
1123
|
mapType?: MapTypeWithLiterals;
|
1125
1124
|
}
|
1126
|
-
|
1125
|
+
declare enum MapType {
|
1127
1126
|
/** Roadmap map type */
|
1128
1127
|
ROADMAP = "ROADMAP",
|
1129
1128
|
/** Satellite map type */
|
@@ -1134,8 +1133,8 @@ export declare enum MapType {
|
|
1134
1133
|
TERRAIN = "TERRAIN"
|
1135
1134
|
}
|
1136
1135
|
/** @enumType */
|
1137
|
-
|
1138
|
-
|
1136
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
1137
|
+
interface ParagraphData {
|
1139
1138
|
/** Styling for the paragraph text. */
|
1140
1139
|
textStyle?: TextStyle;
|
1141
1140
|
/** Indentation level from 1-4. */
|
@@ -1143,7 +1142,7 @@ export interface ParagraphData {
|
|
1143
1142
|
/** Paragraph level */
|
1144
1143
|
level?: number | null;
|
1145
1144
|
}
|
1146
|
-
|
1145
|
+
interface PollData {
|
1147
1146
|
/** Styling for the poll's container. */
|
1148
1147
|
containerData?: PluginContainerData;
|
1149
1148
|
/** Poll data. */
|
@@ -1153,7 +1152,7 @@ export interface PollData {
|
|
1153
1152
|
/** Styling for the poll and voting options. */
|
1154
1153
|
design?: Design;
|
1155
1154
|
}
|
1156
|
-
|
1155
|
+
declare enum ViewRole {
|
1157
1156
|
/** Only Poll creator can view the results */
|
1158
1157
|
CREATOR = "CREATOR",
|
1159
1158
|
/** Anyone who voted can see the results */
|
@@ -1162,16 +1161,16 @@ export declare enum ViewRole {
|
|
1162
1161
|
EVERYONE = "EVERYONE"
|
1163
1162
|
}
|
1164
1163
|
/** @enumType */
|
1165
|
-
|
1166
|
-
|
1164
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
1165
|
+
declare enum VoteRole {
|
1167
1166
|
/** Logged in member */
|
1168
1167
|
SITE_MEMBERS = "SITE_MEMBERS",
|
1169
1168
|
/** Anyone */
|
1170
1169
|
ALL = "ALL"
|
1171
1170
|
}
|
1172
1171
|
/** @enumType */
|
1173
|
-
|
1174
|
-
|
1172
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
1173
|
+
interface Permissions {
|
1175
1174
|
/** Sets who can view the poll results. */
|
1176
1175
|
view?: ViewRoleWithLiterals;
|
1177
1176
|
/** Sets who can vote. */
|
@@ -1179,7 +1178,7 @@ export interface Permissions {
|
|
1179
1178
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
1180
1179
|
allowMultipleVotes?: boolean | null;
|
1181
1180
|
}
|
1182
|
-
|
1181
|
+
interface Option {
|
1183
1182
|
/** Option ID. */
|
1184
1183
|
id?: string | null;
|
1185
1184
|
/** Option title. */
|
@@ -1187,7 +1186,7 @@ export interface Option {
|
|
1187
1186
|
/** The image displayed with the option. */
|
1188
1187
|
image?: V1Media;
|
1189
1188
|
}
|
1190
|
-
|
1189
|
+
interface PollSettings {
|
1191
1190
|
/** Permissions settings for voting. */
|
1192
1191
|
permissions?: Permissions;
|
1193
1192
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
@@ -1195,23 +1194,23 @@ export interface PollSettings {
|
|
1195
1194
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
1196
1195
|
showVotesCount?: boolean | null;
|
1197
1196
|
}
|
1198
|
-
|
1197
|
+
declare enum PollLayoutType {
|
1199
1198
|
/** List */
|
1200
1199
|
LIST = "LIST",
|
1201
1200
|
/** Grid */
|
1202
1201
|
GRID = "GRID"
|
1203
1202
|
}
|
1204
1203
|
/** @enumType */
|
1205
|
-
|
1206
|
-
|
1204
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
1205
|
+
declare enum PollLayoutDirection {
|
1207
1206
|
/** Left-to-right */
|
1208
1207
|
LTR = "LTR",
|
1209
1208
|
/** Right-to-left */
|
1210
1209
|
RTL = "RTL"
|
1211
1210
|
}
|
1212
1211
|
/** @enumType */
|
1213
|
-
|
1214
|
-
|
1212
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
1213
|
+
interface PollLayout {
|
1215
1214
|
/** The layout for displaying the voting options. */
|
1216
1215
|
type?: PollLayoutTypeWithLiterals;
|
1217
1216
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
@@ -1219,11 +1218,11 @@ export interface PollLayout {
|
|
1219
1218
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
1220
1219
|
enableImage?: boolean | null;
|
1221
1220
|
}
|
1222
|
-
|
1221
|
+
interface OptionLayout {
|
1223
1222
|
/** Sets whether to display option images. Defaults to `false`. */
|
1224
1223
|
enableImage?: boolean | null;
|
1225
1224
|
}
|
1226
|
-
|
1225
|
+
declare enum BackgroundType {
|
1227
1226
|
/** Color background type */
|
1228
1227
|
COLOR = "COLOR",
|
1229
1228
|
/** Image background type */
|
@@ -1232,8 +1231,8 @@ export declare enum BackgroundType {
|
|
1232
1231
|
GRADIENT = "GRADIENT"
|
1233
1232
|
}
|
1234
1233
|
/** @enumType */
|
1235
|
-
|
1236
|
-
|
1234
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
1235
|
+
interface Gradient {
|
1237
1236
|
/** The gradient angle in degrees. */
|
1238
1237
|
angle?: number | null;
|
1239
1238
|
/**
|
@@ -1247,7 +1246,7 @@ export interface Gradient {
|
|
1247
1246
|
*/
|
1248
1247
|
lastColor?: string | null;
|
1249
1248
|
}
|
1250
|
-
|
1249
|
+
interface Background extends BackgroundBackgroundOneOf {
|
1251
1250
|
/**
|
1252
1251
|
* The background color as a hexademical value.
|
1253
1252
|
* @format COLOR_HEX
|
@@ -1261,7 +1260,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
1261
1260
|
type?: BackgroundTypeWithLiterals;
|
1262
1261
|
}
|
1263
1262
|
/** @oneof */
|
1264
|
-
|
1263
|
+
interface BackgroundBackgroundOneOf {
|
1265
1264
|
/**
|
1266
1265
|
* The background color as a hexademical value.
|
1267
1266
|
* @format COLOR_HEX
|
@@ -1272,17 +1271,17 @@ export interface BackgroundBackgroundOneOf {
|
|
1272
1271
|
/** Details for a gradient background. */
|
1273
1272
|
gradient?: Gradient;
|
1274
1273
|
}
|
1275
|
-
|
1274
|
+
interface PollDesign {
|
1276
1275
|
/** Background styling. */
|
1277
1276
|
background?: Background;
|
1278
1277
|
/** Border radius in pixels. */
|
1279
1278
|
borderRadius?: number | null;
|
1280
1279
|
}
|
1281
|
-
|
1280
|
+
interface OptionDesign {
|
1282
1281
|
/** Border radius in pixels. */
|
1283
1282
|
borderRadius?: number | null;
|
1284
1283
|
}
|
1285
|
-
|
1284
|
+
interface Poll {
|
1286
1285
|
/** Poll ID. */
|
1287
1286
|
id?: string | null;
|
1288
1287
|
/** Poll title. */
|
@@ -1296,26 +1295,26 @@ export interface Poll {
|
|
1296
1295
|
/** The poll's permissions and display settings. */
|
1297
1296
|
settings?: PollSettings;
|
1298
1297
|
}
|
1299
|
-
|
1298
|
+
interface PollDataLayout {
|
1300
1299
|
/** Poll layout settings. */
|
1301
1300
|
poll?: PollLayout;
|
1302
1301
|
/** Voting otpions layout settings. */
|
1303
1302
|
options?: OptionLayout;
|
1304
1303
|
}
|
1305
|
-
|
1304
|
+
interface Design {
|
1306
1305
|
/** Styling for the poll. */
|
1307
1306
|
poll?: PollDesign;
|
1308
1307
|
/** Styling for voting options. */
|
1309
1308
|
options?: OptionDesign;
|
1310
1309
|
}
|
1311
|
-
|
1310
|
+
interface TextData {
|
1312
1311
|
/** The text to apply decorations to. */
|
1313
1312
|
text?: string;
|
1314
1313
|
/** The decorations to apply. */
|
1315
1314
|
decorations?: Decoration[];
|
1316
1315
|
}
|
1317
1316
|
/** Adds appearence changes to text */
|
1318
|
-
|
1317
|
+
interface Decoration extends DecorationDataOneOf {
|
1319
1318
|
/** Data for an anchor link decoration. */
|
1320
1319
|
anchorData?: AnchorData;
|
1321
1320
|
/** Data for a color decoration. */
|
@@ -1338,7 +1337,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
1338
1337
|
type?: DecorationTypeWithLiterals;
|
1339
1338
|
}
|
1340
1339
|
/** @oneof */
|
1341
|
-
|
1340
|
+
interface DecorationDataOneOf {
|
1342
1341
|
/** Data for an anchor link decoration. */
|
1343
1342
|
anchorData?: AnchorData;
|
1344
1343
|
/** Data for a color decoration. */
|
@@ -1358,7 +1357,7 @@ export interface DecorationDataOneOf {
|
|
1358
1357
|
/** Data for a spoiler decoration. */
|
1359
1358
|
spoilerData?: SpoilerData;
|
1360
1359
|
}
|
1361
|
-
|
1360
|
+
declare enum DecorationType {
|
1362
1361
|
BOLD = "BOLD",
|
1363
1362
|
ITALIC = "ITALIC",
|
1364
1363
|
UNDERLINE = "UNDERLINE",
|
@@ -1371,22 +1370,22 @@ export declare enum DecorationType {
|
|
1371
1370
|
EXTERNAL = "EXTERNAL"
|
1372
1371
|
}
|
1373
1372
|
/** @enumType */
|
1374
|
-
|
1375
|
-
|
1373
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL';
|
1374
|
+
interface AnchorData {
|
1376
1375
|
/** The target node's ID. */
|
1377
1376
|
anchor?: string;
|
1378
1377
|
}
|
1379
|
-
|
1378
|
+
interface ColorData {
|
1380
1379
|
/** The text's background color as a hexadecimal value. */
|
1381
1380
|
background?: string | null;
|
1382
1381
|
/** The text's foreground color as a hexadecimal value. */
|
1383
1382
|
foreground?: string | null;
|
1384
1383
|
}
|
1385
|
-
|
1384
|
+
interface LinkData {
|
1386
1385
|
/** Link details. */
|
1387
1386
|
link?: Link;
|
1388
1387
|
}
|
1389
|
-
|
1388
|
+
interface MentionData {
|
1390
1389
|
/** The mentioned user's name. */
|
1391
1390
|
name?: string;
|
1392
1391
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
@@ -1394,23 +1393,23 @@ export interface MentionData {
|
|
1394
1393
|
/** Mentioned user's ID. */
|
1395
1394
|
id?: string | null;
|
1396
1395
|
}
|
1397
|
-
|
1396
|
+
interface FontSizeData {
|
1398
1397
|
/** The units used for the font size. */
|
1399
1398
|
unit?: FontTypeWithLiterals;
|
1400
1399
|
/** Font size value. */
|
1401
1400
|
value?: number | null;
|
1402
1401
|
}
|
1403
|
-
|
1402
|
+
declare enum FontType {
|
1404
1403
|
PX = "PX",
|
1405
1404
|
EM = "EM"
|
1406
1405
|
}
|
1407
1406
|
/** @enumType */
|
1408
|
-
|
1409
|
-
|
1407
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
1408
|
+
interface SpoilerData {
|
1410
1409
|
/** Spoiler ID. */
|
1411
1410
|
id?: string | null;
|
1412
1411
|
}
|
1413
|
-
|
1412
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
1414
1413
|
/** Data for embedded Wix Bookings content. */
|
1415
1414
|
bookingData?: BookingData;
|
1416
1415
|
/** Data for embedded Wix Events content. */
|
@@ -1432,30 +1431,30 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1432
1431
|
image?: V1Media;
|
1433
1432
|
}
|
1434
1433
|
/** @oneof */
|
1435
|
-
|
1434
|
+
interface AppEmbedDataAppDataOneOf {
|
1436
1435
|
/** Data for embedded Wix Bookings content. */
|
1437
1436
|
bookingData?: BookingData;
|
1438
1437
|
/** Data for embedded Wix Events content. */
|
1439
1438
|
eventData?: EventData;
|
1440
1439
|
}
|
1441
|
-
|
1440
|
+
declare enum AppType {
|
1442
1441
|
PRODUCT = "PRODUCT",
|
1443
1442
|
EVENT = "EVENT",
|
1444
1443
|
BOOKING = "BOOKING"
|
1445
1444
|
}
|
1446
1445
|
/** @enumType */
|
1447
|
-
|
1448
|
-
|
1446
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
1447
|
+
interface BookingData {
|
1449
1448
|
/** Booking duration in minutes. */
|
1450
1449
|
durations?: string | null;
|
1451
1450
|
}
|
1452
|
-
|
1451
|
+
interface EventData {
|
1453
1452
|
/** Event schedule. */
|
1454
1453
|
scheduling?: string | null;
|
1455
1454
|
/** Event location. */
|
1456
1455
|
location?: string | null;
|
1457
1456
|
}
|
1458
|
-
|
1457
|
+
interface VideoData {
|
1459
1458
|
/** Styling for the video's container. */
|
1460
1459
|
containerData?: PluginContainerData;
|
1461
1460
|
/** Video details. */
|
@@ -1469,7 +1468,7 @@ export interface VideoData {
|
|
1469
1468
|
/** Video options. */
|
1470
1469
|
options?: PlaybackOptions;
|
1471
1470
|
}
|
1472
|
-
|
1471
|
+
interface PlaybackOptions {
|
1473
1472
|
/** Sets whether the media will automatically start playing. */
|
1474
1473
|
autoPlay?: boolean | null;
|
1475
1474
|
/** Sets whether media's will be looped. */
|
@@ -1477,7 +1476,7 @@ export interface PlaybackOptions {
|
|
1477
1476
|
/** Sets whether media's controls will be shown. */
|
1478
1477
|
showControls?: boolean | null;
|
1479
1478
|
}
|
1480
|
-
|
1479
|
+
interface EmbedData {
|
1481
1480
|
/** Styling for the oEmbed node's container. */
|
1482
1481
|
containerData?: PluginContainerData;
|
1483
1482
|
/** An [oEmbed](https://www.oembed.com) object. */
|
@@ -1485,7 +1484,7 @@ export interface EmbedData {
|
|
1485
1484
|
/** Origin asset source. */
|
1486
1485
|
src?: string | null;
|
1487
1486
|
}
|
1488
|
-
|
1487
|
+
interface Oembed {
|
1489
1488
|
/** The resource type. */
|
1490
1489
|
type?: string | null;
|
1491
1490
|
/** The width of the resource specified in the `url` property in pixels. */
|
@@ -1517,7 +1516,7 @@ export interface Oembed {
|
|
1517
1516
|
/** The oEmbed version number. This value must be `1.0`. */
|
1518
1517
|
version?: string | null;
|
1519
1518
|
}
|
1520
|
-
|
1519
|
+
interface CollapsibleListData {
|
1521
1520
|
/** Styling for the collapsible list's container. */
|
1522
1521
|
containerData?: PluginContainerData;
|
1523
1522
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
@@ -1529,7 +1528,7 @@ export interface CollapsibleListData {
|
|
1529
1528
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
1530
1529
|
isQapageData?: boolean | null;
|
1531
1530
|
}
|
1532
|
-
|
1531
|
+
declare enum InitialExpandedItems {
|
1533
1532
|
/** First item will be expended initally */
|
1534
1533
|
FIRST = "FIRST",
|
1535
1534
|
/** All items will expended initally */
|
@@ -1538,16 +1537,16 @@ export declare enum InitialExpandedItems {
|
|
1538
1537
|
NONE = "NONE"
|
1539
1538
|
}
|
1540
1539
|
/** @enumType */
|
1541
|
-
|
1542
|
-
|
1540
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
1541
|
+
declare enum Direction {
|
1543
1542
|
/** Left-to-right */
|
1544
1543
|
LTR = "LTR",
|
1545
1544
|
/** Right-to-left */
|
1546
1545
|
RTL = "RTL"
|
1547
1546
|
}
|
1548
1547
|
/** @enumType */
|
1549
|
-
|
1550
|
-
|
1548
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
1549
|
+
interface TableData {
|
1551
1550
|
/** Styling for the table's container. */
|
1552
1551
|
containerData?: PluginContainerData;
|
1553
1552
|
/** The table's dimensions. */
|
@@ -1562,7 +1561,7 @@ export interface TableData {
|
|
1562
1561
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
1563
1562
|
columnHeader?: boolean | null;
|
1564
1563
|
}
|
1565
|
-
|
1564
|
+
interface Dimensions {
|
1566
1565
|
/** An array representing relative width of each column in relation to the other columns. */
|
1567
1566
|
colsWidthRatio?: number[];
|
1568
1567
|
/** An array representing the height of each row in pixels. */
|
@@ -1570,13 +1569,13 @@ export interface Dimensions {
|
|
1570
1569
|
/** An array representing the minimum width of each column in pixels. */
|
1571
1570
|
colsMinWidth?: number[];
|
1572
1571
|
}
|
1573
|
-
|
1572
|
+
interface TableCellData {
|
1574
1573
|
/** Styling for the cell's background color and text alignment. */
|
1575
1574
|
cellStyle?: CellStyle;
|
1576
1575
|
/** The cell's border colors. */
|
1577
1576
|
borderColors?: BorderColors;
|
1578
1577
|
}
|
1579
|
-
|
1578
|
+
declare enum VerticalAlignment {
|
1580
1579
|
/** Top alignment */
|
1581
1580
|
TOP = "TOP",
|
1582
1581
|
/** Middle alignment */
|
@@ -1585,8 +1584,8 @@ export declare enum VerticalAlignment {
|
|
1585
1584
|
BOTTOM = "BOTTOM"
|
1586
1585
|
}
|
1587
1586
|
/** @enumType */
|
1588
|
-
|
1589
|
-
|
1587
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
1588
|
+
interface CellStyle {
|
1590
1589
|
/** Vertical alignment for the cell's text. */
|
1591
1590
|
verticalAlignment?: VerticalAlignmentWithLiterals;
|
1592
1591
|
/**
|
@@ -1595,7 +1594,7 @@ export interface CellStyle {
|
|
1595
1594
|
*/
|
1596
1595
|
backgroundColor?: string | null;
|
1597
1596
|
}
|
1598
|
-
|
1597
|
+
interface BorderColors {
|
1599
1598
|
/**
|
1600
1599
|
* Left border color as a hexadecimal value.
|
1601
1600
|
* @format COLOR_HEX
|
@@ -1623,22 +1622,20 @@ export interface BorderColors {
|
|
1623
1622
|
*
|
1624
1623
|
* The JSON representation for `NullValue` is JSON `null`.
|
1625
1624
|
*/
|
1626
|
-
|
1625
|
+
declare enum NullValue {
|
1627
1626
|
/** Null value. */
|
1628
1627
|
NULL_VALUE = "NULL_VALUE"
|
1629
1628
|
}
|
1630
|
-
/** @enumType */
|
1631
|
-
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
1632
1629
|
/**
|
1633
1630
|
* `ListValue` is a wrapper around a repeated field of values.
|
1634
1631
|
*
|
1635
1632
|
* The JSON representation for `ListValue` is JSON array.
|
1636
1633
|
*/
|
1637
|
-
|
1634
|
+
interface ListValue {
|
1638
1635
|
/** Repeated field of dynamically typed values. */
|
1639
1636
|
values?: any[];
|
1640
1637
|
}
|
1641
|
-
|
1638
|
+
interface AudioData {
|
1642
1639
|
/** Styling for the audio node's container. */
|
1643
1640
|
containerData?: PluginContainerData;
|
1644
1641
|
/** Audio file details. */
|
@@ -1654,7 +1651,7 @@ export interface AudioData {
|
|
1654
1651
|
/** An HTML version of the audio node. */
|
1655
1652
|
html?: string | null;
|
1656
1653
|
}
|
1657
|
-
|
1654
|
+
interface OrderedListData {
|
1658
1655
|
/** Indentation level from 0-4. */
|
1659
1656
|
indentation?: number;
|
1660
1657
|
/** Offset level from 0-4. */
|
@@ -1662,24 +1659,24 @@ export interface OrderedListData {
|
|
1662
1659
|
/** List start number. */
|
1663
1660
|
start?: number | null;
|
1664
1661
|
}
|
1665
|
-
|
1662
|
+
interface BulletedListData {
|
1666
1663
|
/** Indentation level from 0-4. */
|
1667
1664
|
indentation?: number;
|
1668
1665
|
/** Offset level from 0-4. */
|
1669
1666
|
offset?: number | null;
|
1670
1667
|
}
|
1671
|
-
|
1668
|
+
interface BlockquoteData {
|
1672
1669
|
/** Indentation level from 1-4. */
|
1673
1670
|
indentation?: number;
|
1674
1671
|
}
|
1675
|
-
|
1672
|
+
interface CaptionData {
|
1676
1673
|
textStyle?: TextStyle;
|
1677
1674
|
}
|
1678
|
-
|
1675
|
+
interface LayoutCellData {
|
1679
1676
|
/** Size of the cell in 12 columns grid. */
|
1680
1677
|
colSpan?: number | null;
|
1681
1678
|
}
|
1682
|
-
|
1679
|
+
interface Metadata {
|
1683
1680
|
/** Schema version. */
|
1684
1681
|
version?: number;
|
1685
1682
|
/**
|
@@ -1696,7 +1693,7 @@ export interface Metadata {
|
|
1696
1693
|
/** Object ID. */
|
1697
1694
|
_id?: string | null;
|
1698
1695
|
}
|
1699
|
-
|
1696
|
+
interface DocumentStyle {
|
1700
1697
|
/** Styling for H1 nodes. */
|
1701
1698
|
headerOne?: TextNodeStyle;
|
1702
1699
|
/** Styling for H2 nodes. */
|
@@ -1716,7 +1713,7 @@ export interface DocumentStyle {
|
|
1716
1713
|
/** Styling for code block nodes. */
|
1717
1714
|
codeBlock?: TextNodeStyle;
|
1718
1715
|
}
|
1719
|
-
|
1716
|
+
interface TextNodeStyle {
|
1720
1717
|
/** The decorations to apply to the node. */
|
1721
1718
|
decorations?: Decoration[];
|
1722
1719
|
/** Padding and background color for the node. */
|
@@ -1724,7 +1721,7 @@ export interface TextNodeStyle {
|
|
1724
1721
|
/** Line height for text in the node. */
|
1725
1722
|
lineHeight?: string | null;
|
1726
1723
|
}
|
1727
|
-
|
1724
|
+
interface ModerationDetails {
|
1728
1725
|
/**
|
1729
1726
|
* Member ID of the person submitting the draft post for review.
|
1730
1727
|
* @format GUID
|
@@ -1742,14 +1739,14 @@ export interface ModerationDetails {
|
|
1742
1739
|
/** Date the post was approved or rejected. */
|
1743
1740
|
moderationDate?: Date | null;
|
1744
1741
|
}
|
1745
|
-
|
1742
|
+
declare enum ModerationStatusStatus {
|
1746
1743
|
UNKNOWN = "UNKNOWN",
|
1747
1744
|
APPROVED = "APPROVED",
|
1748
1745
|
REJECTED = "REJECTED"
|
1749
1746
|
}
|
1750
1747
|
/** @enumType */
|
1751
|
-
|
1752
|
-
|
1748
|
+
type ModerationStatusStatusWithLiterals = ModerationStatusStatus | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
|
1749
|
+
interface Media extends MediaMediaOneOf {
|
1753
1750
|
/** Wix Media details. */
|
1754
1751
|
wixMedia?: WixMedia;
|
1755
1752
|
/** Embed media details. */
|
@@ -1766,19 +1763,19 @@ export interface Media extends MediaMediaOneOf {
|
|
1766
1763
|
altText?: string | null;
|
1767
1764
|
}
|
1768
1765
|
/** @oneof */
|
1769
|
-
|
1766
|
+
interface MediaMediaOneOf {
|
1770
1767
|
/** Wix Media details. */
|
1771
1768
|
wixMedia?: WixMedia;
|
1772
1769
|
/** Embed media details. */
|
1773
1770
|
embedMedia?: EmbedMedia;
|
1774
1771
|
}
|
1775
|
-
|
1772
|
+
interface WixMedia {
|
1776
1773
|
/** Image details. */
|
1777
1774
|
image?: string;
|
1778
1775
|
/** Video details. */
|
1779
1776
|
videoV2?: string;
|
1780
1777
|
}
|
1781
|
-
|
1778
|
+
interface VideoResolution {
|
1782
1779
|
/** Video URL. */
|
1783
1780
|
url?: string;
|
1784
1781
|
/** Video height. */
|
@@ -1788,13 +1785,13 @@ export interface VideoResolution {
|
|
1788
1785
|
/** Video format for example, mp4, hls. */
|
1789
1786
|
format?: string;
|
1790
1787
|
}
|
1791
|
-
|
1788
|
+
interface EmbedMedia {
|
1792
1789
|
/** Thumbnail details. */
|
1793
1790
|
thumbnail?: EmbedThumbnail;
|
1794
1791
|
/** Video details. */
|
1795
1792
|
video?: EmbedVideo;
|
1796
1793
|
}
|
1797
|
-
|
1794
|
+
interface EmbedThumbnail {
|
1798
1795
|
/**
|
1799
1796
|
* Thumbnail url.
|
1800
1797
|
* @maxLength 2000
|
@@ -1805,7 +1802,7 @@ export interface EmbedThumbnail {
|
|
1805
1802
|
/** Thumbnail height. */
|
1806
1803
|
height?: number;
|
1807
1804
|
}
|
1808
|
-
|
1805
|
+
interface EmbedVideo {
|
1809
1806
|
/**
|
1810
1807
|
* Video url.
|
1811
1808
|
* @maxLength 2000
|
@@ -1816,7 +1813,7 @@ export interface EmbedVideo {
|
|
1816
1813
|
/** Video height. */
|
1817
1814
|
height?: number;
|
1818
1815
|
}
|
1819
|
-
|
1816
|
+
interface PostTranslation {
|
1820
1817
|
/**
|
1821
1818
|
* Post ID.
|
1822
1819
|
* @format GUID
|
@@ -1837,7 +1834,7 @@ export interface PostTranslation {
|
|
1837
1834
|
/** Post URL. */
|
1838
1835
|
url?: string;
|
1839
1836
|
}
|
1840
|
-
|
1837
|
+
interface PostCategoriesUpdated {
|
1841
1838
|
/**
|
1842
1839
|
* ID of the post which counters were updated.
|
1843
1840
|
* @format GUID
|
@@ -1856,7 +1853,7 @@ export interface PostCategoriesUpdated {
|
|
1856
1853
|
*/
|
1857
1854
|
previousCategories?: string[];
|
1858
1855
|
}
|
1859
|
-
|
1856
|
+
interface PostTagsUpdated {
|
1860
1857
|
/**
|
1861
1858
|
* ID of the post which counters were updated.
|
1862
1859
|
* @format GUID
|
@@ -1875,7 +1872,7 @@ export interface PostTagsUpdated {
|
|
1875
1872
|
*/
|
1876
1873
|
previousTags?: string[];
|
1877
1874
|
}
|
1878
|
-
|
1875
|
+
interface ScheduledPostPublished {
|
1879
1876
|
/**
|
1880
1877
|
* ID of the scheduled post which was published.
|
1881
1878
|
* @format GUID
|
@@ -1883,7 +1880,7 @@ export interface ScheduledPostPublished {
|
|
1883
1880
|
postId?: string;
|
1884
1881
|
}
|
1885
1882
|
/** Get Blog Publications Count Stats request */
|
1886
|
-
|
1883
|
+
interface QueryPublicationsCountStatsRequest {
|
1887
1884
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1888
1885
|
rangeStart?: Date | null;
|
1889
1886
|
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
@@ -1906,27 +1903,27 @@ export interface QueryPublicationsCountStatsRequest {
|
|
1906
1903
|
*/
|
1907
1904
|
timeZone?: string | null;
|
1908
1905
|
}
|
1909
|
-
|
1906
|
+
declare enum QueryPublicationsCountStatsRequestOrder {
|
1910
1907
|
UNKNOWN = "UNKNOWN",
|
1911
1908
|
OLDEST = "OLDEST",
|
1912
1909
|
NEWEST = "NEWEST"
|
1913
1910
|
}
|
1914
1911
|
/** @enumType */
|
1915
|
-
|
1912
|
+
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
1916
1913
|
/** Get Blog Publications Count Stats response */
|
1917
|
-
|
1914
|
+
interface QueryPublicationsCountStatsResponse {
|
1918
1915
|
/** Chronologically ordered list of publications. */
|
1919
1916
|
stats?: PeriodPublicationsCount[];
|
1920
1917
|
}
|
1921
1918
|
/** Publications count for a specific time period */
|
1922
|
-
|
1919
|
+
interface PeriodPublicationsCount {
|
1923
1920
|
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1924
1921
|
periodStart?: Date | null;
|
1925
1922
|
/** Number of posts published during this month. */
|
1926
1923
|
publicationsCount?: number;
|
1927
1924
|
}
|
1928
1925
|
/** Get Blog Post Count Stats request */
|
1929
|
-
|
1926
|
+
interface QueryPostCountStatsRequest {
|
1930
1927
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1931
1928
|
rangeStart?: Date | null;
|
1932
1929
|
/**
|
@@ -1957,26 +1954,26 @@ export interface QueryPostCountStatsRequest {
|
|
1957
1954
|
*/
|
1958
1955
|
timeZone?: string | null;
|
1959
1956
|
}
|
1960
|
-
|
1957
|
+
declare enum Order {
|
1961
1958
|
UNKNOWN = "UNKNOWN",
|
1962
1959
|
OLDEST = "OLDEST",
|
1963
1960
|
NEWEST = "NEWEST"
|
1964
1961
|
}
|
1965
1962
|
/** @enumType */
|
1966
|
-
|
1963
|
+
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
1967
1964
|
/** Get Blog Post Count Stats response */
|
1968
|
-
|
1965
|
+
interface QueryPostCountStatsResponse {
|
1969
1966
|
/** List of published post counts by month. */
|
1970
1967
|
stats?: PeriodPostCount[];
|
1971
1968
|
}
|
1972
1969
|
/** Post count for a specific time period */
|
1973
|
-
|
1970
|
+
interface PeriodPostCount {
|
1974
1971
|
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1975
1972
|
periodStart?: Date | null;
|
1976
1973
|
/** Number of posts published during this month. */
|
1977
1974
|
postCount?: number;
|
1978
1975
|
}
|
1979
|
-
|
1976
|
+
interface GetTotalPublicationsRequest {
|
1980
1977
|
/**
|
1981
1978
|
* Language filter
|
1982
1979
|
* @minLength 2
|
@@ -1984,11 +1981,11 @@ export interface GetTotalPublicationsRequest {
|
|
1984
1981
|
*/
|
1985
1982
|
language?: string | null;
|
1986
1983
|
}
|
1987
|
-
|
1984
|
+
interface GetTotalPublicationsResponse {
|
1988
1985
|
/** Total amount of publications. */
|
1989
1986
|
total?: number;
|
1990
1987
|
}
|
1991
|
-
|
1988
|
+
interface GetTotalPostsRequest {
|
1992
1989
|
/**
|
1993
1990
|
* Language filter.
|
1994
1991
|
*
|
@@ -1998,11 +1995,11 @@ export interface GetTotalPostsRequest {
|
|
1998
1995
|
*/
|
1999
1996
|
language?: string | null;
|
2000
1997
|
}
|
2001
|
-
|
1998
|
+
interface GetTotalPostsResponse {
|
2002
1999
|
/** Total amount of published posts. */
|
2003
2000
|
total?: number;
|
2004
2001
|
}
|
2005
|
-
|
2002
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
2006
2003
|
createdEvent?: EntityCreatedEvent;
|
2007
2004
|
updatedEvent?: EntityUpdatedEvent;
|
2008
2005
|
deletedEvent?: EntityDeletedEvent;
|
@@ -2045,19 +2042,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
2045
2042
|
entityEventSequence?: string | null;
|
2046
2043
|
}
|
2047
2044
|
/** @oneof */
|
2048
|
-
|
2045
|
+
interface DomainEventBodyOneOf {
|
2049
2046
|
createdEvent?: EntityCreatedEvent;
|
2050
2047
|
updatedEvent?: EntityUpdatedEvent;
|
2051
2048
|
deletedEvent?: EntityDeletedEvent;
|
2052
2049
|
actionEvent?: ActionEvent;
|
2053
2050
|
}
|
2054
|
-
|
2051
|
+
interface EntityCreatedEvent {
|
2055
2052
|
entity?: string;
|
2056
2053
|
}
|
2057
|
-
|
2054
|
+
interface RestoreInfo {
|
2058
2055
|
deletedDate?: Date | null;
|
2059
2056
|
}
|
2060
|
-
|
2057
|
+
interface EntityUpdatedEvent {
|
2061
2058
|
/**
|
2062
2059
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
2063
2060
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
@@ -2065,14 +2062,14 @@ export interface EntityUpdatedEvent {
|
|
2065
2062
|
*/
|
2066
2063
|
currentEntity?: string;
|
2067
2064
|
}
|
2068
|
-
|
2065
|
+
interface EntityDeletedEvent {
|
2069
2066
|
/** Entity that was deleted */
|
2070
2067
|
deletedEntity?: string | null;
|
2071
2068
|
}
|
2072
|
-
|
2069
|
+
interface ActionEvent {
|
2073
2070
|
body?: string;
|
2074
2071
|
}
|
2075
|
-
|
2072
|
+
interface MessageEnvelope {
|
2076
2073
|
/**
|
2077
2074
|
* App instance ID.
|
2078
2075
|
* @format GUID
|
@@ -2088,7 +2085,7 @@ export interface MessageEnvelope {
|
|
2088
2085
|
/** Stringify payload. */
|
2089
2086
|
data?: string;
|
2090
2087
|
}
|
2091
|
-
|
2088
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
2092
2089
|
/**
|
2093
2090
|
* ID of a site visitor that has not logged in to the site.
|
2094
2091
|
* @format GUID
|
@@ -2113,7 +2110,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2113
2110
|
identityType?: WebhookIdentityTypeWithLiterals;
|
2114
2111
|
}
|
2115
2112
|
/** @oneof */
|
2116
|
-
|
2113
|
+
interface IdentificationDataIdOneOf {
|
2117
2114
|
/**
|
2118
2115
|
* ID of a site visitor that has not logged in to the site.
|
2119
2116
|
* @format GUID
|
@@ -2135,7 +2132,7 @@ export interface IdentificationDataIdOneOf {
|
|
2135
2132
|
*/
|
2136
2133
|
appId?: string;
|
2137
2134
|
}
|
2138
|
-
|
2135
|
+
declare enum WebhookIdentityType {
|
2139
2136
|
UNKNOWN = "UNKNOWN",
|
2140
2137
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
2141
2138
|
MEMBER = "MEMBER",
|
@@ -2143,8 +2140,8 @@ export declare enum WebhookIdentityType {
|
|
2143
2140
|
APP = "APP"
|
2144
2141
|
}
|
2145
2142
|
/** @enumType */
|
2146
|
-
|
2147
|
-
|
2143
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
2144
|
+
interface ListTemplatesRequest {
|
2148
2145
|
/**
|
2149
2146
|
* Filter post templates by given template category ids
|
2150
2147
|
* @maxSize 50
|
@@ -2163,15 +2160,15 @@ export interface ListTemplatesRequest {
|
|
2163
2160
|
/** Pagination options. */
|
2164
2161
|
paging?: BlogPaging;
|
2165
2162
|
}
|
2166
|
-
|
2163
|
+
declare enum GetPostTemplatesSort {
|
2167
2164
|
/** Sort by ascending publishing date. */
|
2168
2165
|
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
2169
2166
|
/** Sort by descending publishing date. */
|
2170
2167
|
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
2171
2168
|
}
|
2172
2169
|
/** @enumType */
|
2173
|
-
|
2174
|
-
|
2170
|
+
type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
|
2171
|
+
interface BlogPaging {
|
2175
2172
|
/**
|
2176
2173
|
* Number of items to skip in the current sort order.
|
2177
2174
|
*
|
@@ -2194,7 +2191,7 @@ export interface BlogPaging {
|
|
2194
2191
|
*/
|
2195
2192
|
cursor?: string | null;
|
2196
2193
|
}
|
2197
|
-
|
2194
|
+
interface ListTemplatesResponse {
|
2198
2195
|
/** Available post templates */
|
2199
2196
|
postTemplates?: Post[];
|
2200
2197
|
/** Details on the paged set of posts templates returned. */
|
@@ -2202,7 +2199,7 @@ export interface ListTemplatesResponse {
|
|
2202
2199
|
/** Post template categories. This value is returned empty unless asked explicitly */
|
2203
2200
|
templateCategories?: Category[];
|
2204
2201
|
}
|
2205
|
-
|
2202
|
+
interface MetaData {
|
2206
2203
|
/** Number of items returned in this response. */
|
2207
2204
|
count?: number;
|
2208
2205
|
/** Requested offset. */
|
@@ -2215,7 +2212,7 @@ export interface MetaData {
|
|
2215
2212
|
*/
|
2216
2213
|
cursor?: string | null;
|
2217
2214
|
}
|
2218
|
-
|
2215
|
+
interface Category {
|
2219
2216
|
/**
|
2220
2217
|
* Category ID.
|
2221
2218
|
* @immutable
|
@@ -2283,7 +2280,7 @@ export interface Category {
|
|
2283
2280
|
*/
|
2284
2281
|
_updatedDate?: Date | null;
|
2285
2282
|
}
|
2286
|
-
|
2283
|
+
interface CategoryTranslation {
|
2287
2284
|
/**
|
2288
2285
|
* Category ID.
|
2289
2286
|
* @format GUID
|
@@ -2302,29 +2299,29 @@ export interface CategoryTranslation {
|
|
2302
2299
|
/** URL of this category page. */
|
2303
2300
|
url?: string;
|
2304
2301
|
}
|
2305
|
-
|
2302
|
+
interface GetTemplateRequest {
|
2306
2303
|
/**
|
2307
2304
|
* Post template id
|
2308
2305
|
* @format GUID
|
2309
2306
|
*/
|
2310
2307
|
postTemplateId?: string;
|
2311
2308
|
}
|
2312
|
-
|
2309
|
+
interface GetTemplateResponse {
|
2313
2310
|
/** Post template */
|
2314
2311
|
postTemplate?: Post;
|
2315
2312
|
}
|
2316
|
-
|
2313
|
+
interface CreateDraftPostFromTemplateRequest {
|
2317
2314
|
/**
|
2318
2315
|
* Post template id
|
2319
2316
|
* @format GUID
|
2320
2317
|
*/
|
2321
2318
|
postTemplateId?: string;
|
2322
2319
|
}
|
2323
|
-
|
2320
|
+
interface CreateDraftPostFromTemplateResponse {
|
2324
2321
|
/** Created draft post */
|
2325
2322
|
draftPost?: DraftPost;
|
2326
2323
|
}
|
2327
|
-
|
2324
|
+
interface DraftPost {
|
2328
2325
|
/**
|
2329
2326
|
* Draft post ID.
|
2330
2327
|
* @readonly
|
@@ -2459,7 +2456,7 @@ export interface DraftPost {
|
|
2459
2456
|
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
2460
2457
|
previewTextParagraph?: number | null;
|
2461
2458
|
}
|
2462
|
-
|
2459
|
+
declare enum Origin {
|
2463
2460
|
UNKNOWN = "UNKNOWN",
|
2464
2461
|
/** Changed by admin */
|
2465
2462
|
ADMIN = "ADMIN",
|
@@ -2532,9 +2529,7 @@ export declare enum Origin {
|
|
2532
2529
|
/** Saved automatically by AI tool. */
|
2533
2530
|
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
2534
2531
|
}
|
2535
|
-
|
2536
|
-
export type OriginWithLiterals = Origin | 'UNKNOWN' | 'ADMIN' | 'ADD_CATEGORIES' | 'AUTO_SAVE' | 'COPY_TEMPLATE' | 'IMPORT' | 'IMPORT_BULK' | 'IMPORT_HTML' | 'IMPORT_PATCH' | 'LANGUAGE_CHANGE' | 'MANUAL_SAVE' | 'MIGRATION' | 'MODERATION' | 'MOVE_TO_TRASH' | 'PRICING_PLANS_CHANGE' | 'PROVISION' | 'PUBLISH' | 'REASSIGN_OWNER' | 'REBLOG' | 'RESTORE' | 'REVERT_TO_DRAFT' | 'TRANSLATION' | 'UNPUBLISH' | 'UNSCHEDULE' | 'NEW_EDIT_SESSION' | 'SCHEDULING_SERVICE_SCHEDULE' | 'SCHEDULING_SERVICE_UNSCHEDULE' | 'SCHEDULING_SERVICE_PUBLISH' | 'SCHEDULE' | 'REMOVE_FROM_MODERATION' | 'REJECT_FROM_MODERATION' | 'APPROVE_IN_MODERATION' | 'DELETE_TAG' | 'PIN' | 'UNPIN' | 'AI_AUTO_SAVE';
|
2537
|
-
export declare enum Status {
|
2532
|
+
declare enum Status {
|
2538
2533
|
UNKNOWN = "UNKNOWN",
|
2539
2534
|
/** Status indicating the draft post is published. */
|
2540
2535
|
PUBLISHED = "PUBLISHED",
|
@@ -2548,8 +2543,8 @@ export declare enum Status {
|
|
2548
2543
|
IN_REVIEW = "IN_REVIEW"
|
2549
2544
|
}
|
2550
2545
|
/** @enumType */
|
2551
|
-
|
2552
|
-
|
2546
|
+
type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
|
2547
|
+
interface DraftPostTranslation {
|
2553
2548
|
/**
|
2554
2549
|
* Post ID.
|
2555
2550
|
* @format GUID
|
@@ -2572,18 +2567,18 @@ export interface DraftPostTranslation {
|
|
2572
2567
|
/** Post URL. */
|
2573
2568
|
url?: string;
|
2574
2569
|
}
|
2575
|
-
|
2570
|
+
interface GetTotalLikesPerMemberRequest {
|
2576
2571
|
/**
|
2577
2572
|
* Member ID.
|
2578
2573
|
* @format GUID
|
2579
2574
|
*/
|
2580
2575
|
memberId?: string;
|
2581
2576
|
}
|
2582
|
-
|
2577
|
+
interface GetTotalLikesPerMemberResponse {
|
2583
2578
|
/** The total number of likes of the member. */
|
2584
2579
|
total?: number;
|
2585
2580
|
}
|
2586
|
-
|
2581
|
+
interface PostLiked extends PostLikedInitiatorOneOf {
|
2587
2582
|
/**
|
2588
2583
|
* Member ID of person who liked the post (only returned when the member was logged in when liking the post).
|
2589
2584
|
* @format GUID
|
@@ -2601,7 +2596,7 @@ export interface PostLiked extends PostLikedInitiatorOneOf {
|
|
2601
2596
|
postId?: string;
|
2602
2597
|
}
|
2603
2598
|
/** @oneof */
|
2604
|
-
|
2599
|
+
interface PostLikedInitiatorOneOf {
|
2605
2600
|
/**
|
2606
2601
|
* Member ID of person who liked the post (only returned when the member was logged in when liking the post).
|
2607
2602
|
* @format GUID
|
@@ -2613,7 +2608,7 @@ export interface PostLikedInitiatorOneOf {
|
|
2613
2608
|
*/
|
2614
2609
|
anonymousVisitorId?: string | null;
|
2615
2610
|
}
|
2616
|
-
|
2611
|
+
interface PostUnliked extends PostUnlikedInitiatorOneOf {
|
2617
2612
|
/**
|
2618
2613
|
* Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
|
2619
2614
|
* @format GUID
|
@@ -2631,7 +2626,7 @@ export interface PostUnliked extends PostUnlikedInitiatorOneOf {
|
|
2631
2626
|
postId?: string;
|
2632
2627
|
}
|
2633
2628
|
/** @oneof */
|
2634
|
-
|
2629
|
+
interface PostUnlikedInitiatorOneOf {
|
2635
2630
|
/**
|
2636
2631
|
* Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
|
2637
2632
|
* @format GUID
|
@@ -2643,7 +2638,7 @@ export interface PostUnlikedInitiatorOneOf {
|
|
2643
2638
|
*/
|
2644
2639
|
anonymousVisitorId?: string | null;
|
2645
2640
|
}
|
2646
|
-
|
2641
|
+
interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
2647
2642
|
/**
|
2648
2643
|
* Member ID of person who triggered the counter update
|
2649
2644
|
* @format GUID
|
@@ -2665,7 +2660,7 @@ export interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
|
2665
2660
|
counter?: number;
|
2666
2661
|
}
|
2667
2662
|
/** @oneof */
|
2668
|
-
|
2663
|
+
interface PostCountersUpdatedInitiatorOneOf {
|
2669
2664
|
/**
|
2670
2665
|
* Member ID of person who triggered the counter update
|
2671
2666
|
* @format GUID
|
@@ -2677,7 +2672,7 @@ export interface PostCountersUpdatedInitiatorOneOf {
|
|
2677
2672
|
*/
|
2678
2673
|
anonymousVisitorId?: string | null;
|
2679
2674
|
}
|
2680
|
-
|
2675
|
+
declare enum Field {
|
2681
2676
|
/** Undefined field. */
|
2682
2677
|
UNKNOWN = "UNKNOWN",
|
2683
2678
|
/** Total comments field. */
|
@@ -2690,14 +2685,14 @@ export declare enum Field {
|
|
2690
2685
|
RATING_COUNT = "RATING_COUNT"
|
2691
2686
|
}
|
2692
2687
|
/** @enumType */
|
2693
|
-
|
2694
|
-
|
2688
|
+
type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
|
2689
|
+
interface PostOwnerChanged {
|
2695
2690
|
}
|
2696
|
-
|
2691
|
+
interface InitialPostsCopied {
|
2697
2692
|
/** Number of posts copied. */
|
2698
2693
|
count?: number;
|
2699
2694
|
}
|
2700
|
-
|
2695
|
+
interface GetPostRequest {
|
2701
2696
|
/**
|
2702
2697
|
* Post ID.
|
2703
2698
|
* @minLength 1
|
@@ -2712,7 +2707,7 @@ export interface GetPostRequest {
|
|
2712
2707
|
*/
|
2713
2708
|
fieldsets?: PostFieldFieldWithLiterals[];
|
2714
2709
|
}
|
2715
|
-
|
2710
|
+
declare enum PostFieldField {
|
2716
2711
|
UNKNOWN = "UNKNOWN",
|
2717
2712
|
/** Includes post URL when present. */
|
2718
2713
|
URL = "URL",
|
@@ -2730,12 +2725,12 @@ export declare enum PostFieldField {
|
|
2730
2725
|
REFERENCE_ID = "REFERENCE_ID"
|
2731
2726
|
}
|
2732
2727
|
/** @enumType */
|
2733
|
-
|
2734
|
-
|
2728
|
+
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
2729
|
+
interface GetPostResponse {
|
2735
2730
|
/** Retrieved post info. */
|
2736
2731
|
post?: Post;
|
2737
2732
|
}
|
2738
|
-
|
2733
|
+
interface GetPostBySlugRequest {
|
2739
2734
|
/**
|
2740
2735
|
* Slug of the post to retrieve.
|
2741
2736
|
* @minLength 1
|
@@ -2750,11 +2745,11 @@ export interface GetPostBySlugRequest {
|
|
2750
2745
|
*/
|
2751
2746
|
fieldsets?: PostFieldFieldWithLiterals[];
|
2752
2747
|
}
|
2753
|
-
|
2748
|
+
interface GetPostBySlugResponse {
|
2754
2749
|
/** Retrieved post info. */
|
2755
2750
|
post?: Post;
|
2756
2751
|
}
|
2757
|
-
|
2752
|
+
interface ListPostsRequest {
|
2758
2753
|
/**
|
2759
2754
|
* Whether to return only featured posts.
|
2760
2755
|
*
|
@@ -2818,7 +2813,7 @@ export interface ListPostsRequest {
|
|
2818
2813
|
*/
|
2819
2814
|
fieldsets?: PostFieldFieldWithLiterals[];
|
2820
2815
|
}
|
2821
|
-
|
2816
|
+
declare enum GetPostsSort {
|
2822
2817
|
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
2823
2818
|
FEED = "FEED",
|
2824
2819
|
/** Ordered by `firstPublishedDate` in ascending order. */
|
@@ -2835,14 +2830,14 @@ export declare enum GetPostsSort {
|
|
2835
2830
|
TITLE_DESC = "TITLE_DESC"
|
2836
2831
|
}
|
2837
2832
|
/** @enumType */
|
2838
|
-
|
2839
|
-
|
2833
|
+
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
2834
|
+
interface ListPostsResponse {
|
2840
2835
|
/** List of retrieved posts. */
|
2841
2836
|
posts?: Post[];
|
2842
2837
|
/** Details on the paged set of results returned. */
|
2843
2838
|
metaData?: MetaData;
|
2844
2839
|
}
|
2845
|
-
|
2840
|
+
interface QueryPostsRequest {
|
2846
2841
|
/** Query options. */
|
2847
2842
|
query?: PlatformQuery;
|
2848
2843
|
/**
|
@@ -2853,7 +2848,7 @@ export interface QueryPostsRequest {
|
|
2853
2848
|
*/
|
2854
2849
|
fieldsets?: PostFieldFieldWithLiterals[];
|
2855
2850
|
}
|
2856
|
-
|
2851
|
+
interface Sorting {
|
2857
2852
|
/**
|
2858
2853
|
* Name of the field to sort by.
|
2859
2854
|
* @maxLength 512
|
@@ -2862,13 +2857,13 @@ export interface Sorting {
|
|
2862
2857
|
/** Sort order. */
|
2863
2858
|
order?: SortOrderWithLiterals;
|
2864
2859
|
}
|
2865
|
-
|
2860
|
+
declare enum SortOrder {
|
2866
2861
|
ASC = "ASC",
|
2867
2862
|
DESC = "DESC"
|
2868
2863
|
}
|
2869
2864
|
/** @enumType */
|
2870
|
-
|
2871
|
-
|
2865
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
2866
|
+
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
2872
2867
|
/** Paging options to limit and skip the number of items. */
|
2873
2868
|
paging?: Paging;
|
2874
2869
|
/** 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`. */
|
@@ -2890,13 +2885,13 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
2890
2885
|
sort?: Sorting[];
|
2891
2886
|
}
|
2892
2887
|
/** @oneof */
|
2893
|
-
|
2888
|
+
interface PlatformQueryPagingMethodOneOf {
|
2894
2889
|
/** Paging options to limit and skip the number of items. */
|
2895
2890
|
paging?: Paging;
|
2896
2891
|
/** 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`. */
|
2897
2892
|
cursorPaging?: CursorPaging;
|
2898
2893
|
}
|
2899
|
-
|
2894
|
+
interface Paging {
|
2900
2895
|
/**
|
2901
2896
|
* Number of items to load.
|
2902
2897
|
* @max 100
|
@@ -2905,7 +2900,7 @@ export interface Paging {
|
|
2905
2900
|
/** Number of items to skip in the current sort order. */
|
2906
2901
|
offset?: number | null;
|
2907
2902
|
}
|
2908
|
-
|
2903
|
+
interface CursorPaging {
|
2909
2904
|
/**
|
2910
2905
|
* Number of items to load.
|
2911
2906
|
* @max 100
|
@@ -2921,13 +2916,13 @@ export interface CursorPaging {
|
|
2921
2916
|
*/
|
2922
2917
|
cursor?: string | null;
|
2923
2918
|
}
|
2924
|
-
|
2919
|
+
interface QueryPostsResponse {
|
2925
2920
|
/** List of retrieved posts. */
|
2926
2921
|
posts?: Post[];
|
2927
2922
|
/** Details on the paged set of results returned. */
|
2928
2923
|
pagingMetadata?: PagingMetadataV2;
|
2929
2924
|
}
|
2930
|
-
|
2925
|
+
interface PagingMetadataV2 {
|
2931
2926
|
/** Number of items returned in the response. */
|
2932
2927
|
count?: number | null;
|
2933
2928
|
/** Offset that was requested. */
|
@@ -2939,7 +2934,7 @@ export interface PagingMetadataV2 {
|
|
2939
2934
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
2940
2935
|
cursors?: Cursors;
|
2941
2936
|
}
|
2942
|
-
|
2937
|
+
interface Cursors {
|
2943
2938
|
/**
|
2944
2939
|
* Cursor pointing to next page in the list of results.
|
2945
2940
|
* @maxLength 2000
|
@@ -2951,7 +2946,7 @@ export interface Cursors {
|
|
2951
2946
|
*/
|
2952
2947
|
prev?: string | null;
|
2953
2948
|
}
|
2954
|
-
|
2949
|
+
interface GetPostMetricsRequest {
|
2955
2950
|
/**
|
2956
2951
|
* Post ID to retrieve metrics for.
|
2957
2952
|
* @minLength 1
|
@@ -2959,11 +2954,11 @@ export interface GetPostMetricsRequest {
|
|
2959
2954
|
*/
|
2960
2955
|
postId: string;
|
2961
2956
|
}
|
2962
|
-
|
2957
|
+
interface GetPostMetricsResponse {
|
2963
2958
|
/** Retrieved post metrics. */
|
2964
2959
|
metrics?: Metrics;
|
2965
2960
|
}
|
2966
|
-
|
2961
|
+
interface BulkGetPostMetricsRequest {
|
2967
2962
|
/**
|
2968
2963
|
* Post IDs.
|
2969
2964
|
* @maxSize 500
|
@@ -2971,11 +2966,11 @@ export interface BulkGetPostMetricsRequest {
|
|
2971
2966
|
*/
|
2972
2967
|
postIds?: string[];
|
2973
2968
|
}
|
2974
|
-
|
2969
|
+
interface BulkGetPostMetricsResponse {
|
2975
2970
|
/** Map of post.id to metrics */
|
2976
2971
|
metrics?: Record<string, Metrics>;
|
2977
2972
|
}
|
2978
|
-
|
2973
|
+
interface ViewPostRequest {
|
2979
2974
|
/**
|
2980
2975
|
* Post ID.
|
2981
2976
|
* @minLength 1
|
@@ -2983,11 +2978,11 @@ export interface ViewPostRequest {
|
|
2983
2978
|
*/
|
2984
2979
|
postId?: string;
|
2985
2980
|
}
|
2986
|
-
|
2981
|
+
interface ViewPostResponse {
|
2987
2982
|
/** Total number of post views */
|
2988
2983
|
views?: number;
|
2989
2984
|
}
|
2990
|
-
|
2985
|
+
interface LikePostRequest {
|
2991
2986
|
/**
|
2992
2987
|
* Post ID.
|
2993
2988
|
* @minLength 1
|
@@ -3002,11 +2997,11 @@ export interface LikePostRequest {
|
|
3002
2997
|
*/
|
3003
2998
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3004
2999
|
}
|
3005
|
-
|
3000
|
+
interface LikePostResponse {
|
3006
3001
|
/** Post info. */
|
3007
3002
|
post?: Post;
|
3008
3003
|
}
|
3009
|
-
|
3004
|
+
interface UnlikePostRequest {
|
3010
3005
|
/**
|
3011
3006
|
* Post ID.
|
3012
3007
|
* @minLength 1
|
@@ -3021,11 +3016,11 @@ export interface UnlikePostRequest {
|
|
3021
3016
|
*/
|
3022
3017
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3023
3018
|
}
|
3024
|
-
|
3019
|
+
interface UnlikePostResponse {
|
3025
3020
|
/** Post info. */
|
3026
3021
|
post?: Post;
|
3027
3022
|
}
|
3028
|
-
|
3023
|
+
interface PinPostRequest {
|
3029
3024
|
/**
|
3030
3025
|
* Post ID.
|
3031
3026
|
* @minLength 1
|
@@ -3040,11 +3035,11 @@ export interface PinPostRequest {
|
|
3040
3035
|
*/
|
3041
3036
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3042
3037
|
}
|
3043
|
-
|
3038
|
+
interface PinPostResponse {
|
3044
3039
|
/** Post info. */
|
3045
3040
|
post?: Post;
|
3046
3041
|
}
|
3047
|
-
|
3042
|
+
interface UnpinPostRequest {
|
3048
3043
|
/**
|
3049
3044
|
* Post ID.
|
3050
3045
|
* @minLength 1
|
@@ -3059,11 +3054,11 @@ export interface UnpinPostRequest {
|
|
3059
3054
|
*/
|
3060
3055
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3061
3056
|
}
|
3062
|
-
|
3057
|
+
interface UnpinPostResponse {
|
3063
3058
|
/** Post info. */
|
3064
3059
|
post?: Post;
|
3065
3060
|
}
|
3066
|
-
|
3061
|
+
interface ListPostsArchiveRequest {
|
3067
3062
|
/**
|
3068
3063
|
* Month
|
3069
3064
|
* @min 1
|
@@ -3100,7 +3095,7 @@ export interface ListPostsArchiveRequest {
|
|
3100
3095
|
*/
|
3101
3096
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3102
3097
|
}
|
3103
|
-
|
3098
|
+
interface ListPostsArchiveResponse {
|
3104
3099
|
/** List of posts. */
|
3105
3100
|
posts?: Post[];
|
3106
3101
|
/** Details on the paged set of results returned. */
|
@@ -3108,7 +3103,7 @@ export interface ListPostsArchiveResponse {
|
|
3108
3103
|
/** Details on the paged set of results returned. */
|
3109
3104
|
pagingMetadata?: PagingMetadataV2;
|
3110
3105
|
}
|
3111
|
-
|
3106
|
+
interface BulkGetPostReactionsRequest {
|
3112
3107
|
/**
|
3113
3108
|
* Post IDs.
|
3114
3109
|
* @maxSize 500
|
@@ -3116,18 +3111,18 @@ export interface BulkGetPostReactionsRequest {
|
|
3116
3111
|
*/
|
3117
3112
|
postIds?: string[];
|
3118
3113
|
}
|
3119
|
-
|
3114
|
+
interface BulkGetPostReactionsResponse {
|
3120
3115
|
/** Map of post.id to reactions */
|
3121
3116
|
reactionsMap?: Record<string, Reactions>;
|
3122
3117
|
}
|
3123
|
-
|
3118
|
+
interface Reactions {
|
3124
3119
|
/**
|
3125
3120
|
* Is post liked by the current user
|
3126
3121
|
* @readonly
|
3127
3122
|
*/
|
3128
3123
|
liked?: boolean;
|
3129
3124
|
}
|
3130
|
-
|
3125
|
+
interface ListDemoPostsRequest {
|
3131
3126
|
/**
|
3132
3127
|
* Whether to return only featured posts.
|
3133
3128
|
*
|
@@ -3214,35 +3209,35 @@ export interface ListDemoPostsRequest {
|
|
3214
3209
|
*/
|
3215
3210
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3216
3211
|
}
|
3217
|
-
|
3212
|
+
interface ListDemoPostsResponse {
|
3218
3213
|
/** List of posts. */
|
3219
3214
|
posts?: Post[];
|
3220
3215
|
/** Details on the paged set of results returned. */
|
3221
3216
|
metaData?: MetaData;
|
3222
3217
|
}
|
3223
|
-
|
3218
|
+
interface ConvertDraftJsToRichContentRequest {
|
3224
3219
|
/** DraftJs content to convert to Rich content. */
|
3225
3220
|
content?: Record<string, any> | null;
|
3226
3221
|
}
|
3227
|
-
|
3222
|
+
interface ConvertDraftJsToRichContentResponse {
|
3228
3223
|
/**
|
3229
3224
|
* Rich content converted from DraftJs content.
|
3230
3225
|
* @maxLength 2000000
|
3231
3226
|
*/
|
3232
3227
|
richContent?: string;
|
3233
3228
|
}
|
3234
|
-
|
3229
|
+
interface ConvertRichContentToDraftJsRequest {
|
3235
3230
|
/**
|
3236
3231
|
* Rich content to convert to DraftJs content.
|
3237
3232
|
* @maxLength 2000000
|
3238
3233
|
*/
|
3239
3234
|
richContent?: string;
|
3240
3235
|
}
|
3241
|
-
|
3236
|
+
interface ConvertRichContentToDraftJsResponse {
|
3242
3237
|
/** DraftJs content converted from Rich content. */
|
3243
3238
|
content?: Record<string, any> | null;
|
3244
3239
|
}
|
3245
|
-
|
3240
|
+
interface OldBlogMigratedEvent {
|
3246
3241
|
/**
|
3247
3242
|
* Instance id of new version of blog
|
3248
3243
|
* @format GUID
|
@@ -3254,7 +3249,7 @@ export interface OldBlogMigratedEvent {
|
|
3254
3249
|
*/
|
3255
3250
|
oldBlogInstanceId?: string;
|
3256
3251
|
}
|
3257
|
-
|
3252
|
+
interface BaseEventMetadata {
|
3258
3253
|
/**
|
3259
3254
|
* App instance ID.
|
3260
3255
|
* @format GUID
|
@@ -3268,7 +3263,7 @@ export interface BaseEventMetadata {
|
|
3268
3263
|
/** The identification type and identity data. */
|
3269
3264
|
identity?: IdentificationData;
|
3270
3265
|
}
|
3271
|
-
|
3266
|
+
interface EventMetadata extends BaseEventMetadata {
|
3272
3267
|
/**
|
3273
3268
|
* Unique event ID.
|
3274
3269
|
* Allows clients to ignore duplicate webhooks.
|
@@ -3306,139 +3301,27 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
3306
3301
|
*/
|
3307
3302
|
entityEventSequence?: string | null;
|
3308
3303
|
}
|
3309
|
-
|
3304
|
+
interface PostCreatedEnvelope {
|
3310
3305
|
entity: Post;
|
3311
3306
|
metadata: EventMetadata;
|
3312
3307
|
}
|
3313
|
-
|
3314
|
-
* Triggered when a post is created.
|
3315
|
-
* @permissionScope Read Blog
|
3316
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3317
|
-
* @permissionScope Manage Blog
|
3318
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3319
|
-
* @permissionScope Manage Blog
|
3320
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3321
|
-
* @permissionScope Read Draft Blog Posts
|
3322
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3323
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3324
|
-
* @webhook
|
3325
|
-
* @eventType wix.blog.v3.post_created
|
3326
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3327
|
-
* @slug created
|
3328
|
-
*/
|
3329
|
-
export declare function onPostCreated(handler: (event: PostCreatedEnvelope) => void | Promise<void>): void;
|
3330
|
-
export interface PostDeletedEnvelope {
|
3308
|
+
interface PostDeletedEnvelope {
|
3331
3309
|
entity: Post;
|
3332
3310
|
metadata: EventMetadata;
|
3333
3311
|
}
|
3334
|
-
|
3335
|
-
* Triggered when a post is deleted.
|
3336
|
-
* @permissionScope Read Blog
|
3337
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3338
|
-
* @permissionScope Manage Blog
|
3339
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3340
|
-
* @permissionScope Manage Blog
|
3341
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3342
|
-
* @permissionScope Read Draft Blog Posts
|
3343
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3344
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3345
|
-
* @webhook
|
3346
|
-
* @eventType wix.blog.v3.post_deleted
|
3347
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3348
|
-
* @slug deleted
|
3349
|
-
*/
|
3350
|
-
export declare function onPostDeleted(handler: (event: PostDeletedEnvelope) => void | Promise<void>): void;
|
3351
|
-
export interface PostLikedEnvelope {
|
3312
|
+
interface PostLikedEnvelope {
|
3352
3313
|
data: PostLiked;
|
3353
3314
|
metadata: EventMetadata;
|
3354
3315
|
}
|
3355
|
-
|
3356
|
-
* Triggered when a post is liked.
|
3357
|
-
* @permissionScope Read Blog
|
3358
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3359
|
-
* @permissionScope Manage Blog
|
3360
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3361
|
-
* @permissionScope Manage Blog
|
3362
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3363
|
-
* @permissionScope Read Draft Blog Posts
|
3364
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3365
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3366
|
-
* @webhook
|
3367
|
-
* @eventType wix.blog.v3.post_liked
|
3368
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3369
|
-
* @slug liked
|
3370
|
-
*/
|
3371
|
-
export declare function onPostLiked(handler: (event: PostLikedEnvelope) => void | Promise<void>): void;
|
3372
|
-
export interface PostUnlikedEnvelope {
|
3316
|
+
interface PostUnlikedEnvelope {
|
3373
3317
|
data: PostUnliked;
|
3374
3318
|
metadata: EventMetadata;
|
3375
3319
|
}
|
3376
|
-
|
3377
|
-
* Triggered when a post is unliked.
|
3378
|
-
* @permissionScope Read Blog
|
3379
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3380
|
-
* @permissionScope Manage Blog
|
3381
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3382
|
-
* @permissionScope Manage Blog
|
3383
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3384
|
-
* @permissionScope Read Draft Blog Posts
|
3385
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3386
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3387
|
-
* @webhook
|
3388
|
-
* @eventType wix.blog.v3.post_unliked
|
3389
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3390
|
-
* @slug unliked
|
3391
|
-
*/
|
3392
|
-
export declare function onPostUnliked(handler: (event: PostUnlikedEnvelope) => void | Promise<void>): void;
|
3393
|
-
export interface PostUpdatedEnvelope {
|
3320
|
+
interface PostUpdatedEnvelope {
|
3394
3321
|
entity: Post;
|
3395
3322
|
metadata: EventMetadata;
|
3396
3323
|
}
|
3397
|
-
|
3398
|
-
* Triggered when a post is updated.
|
3399
|
-
* @permissionScope Read Blog
|
3400
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3401
|
-
* @permissionScope Manage Blog
|
3402
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3403
|
-
* @permissionScope Manage Blog
|
3404
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3405
|
-
* @permissionScope Read Draft Blog Posts
|
3406
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3407
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3408
|
-
* @webhook
|
3409
|
-
* @eventType wix.blog.v3.post_updated
|
3410
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3411
|
-
* @slug updated
|
3412
|
-
*/
|
3413
|
-
export declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | Promise<void>): void;
|
3414
|
-
type PostNonNullablePaths = `_id` | `title` | `excerpt` | `slug` | `featured` | `pinned` | `categoryIds` | `coverMedia.enabled` | `coverMedia.displayed` | `coverMedia.custom` | `memberId` | `hashtags` | `commentingEnabled` | `minutesToRead` | `tagIds` | `relatedPostIds` | `pricingPlanIds` | `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` | `preview` | `moderationDetails.submittedBy` | `moderationDetails.status` | `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` | `hasUnpublishedChanges`;
|
3415
|
-
/**
|
3416
|
-
* Retrieves the number of published posts per month within a specified time range.
|
3417
|
-
*
|
3418
|
-
*
|
3419
|
-
* The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
|
3420
|
-
*
|
3421
|
-
* You can set the time range using the `rangeStart` and `months` properties. The time range always starts on the 1st day of the month set in `rangeStart` and includes the number of `months` following `rangeStart`. For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`, the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range ends on the last day of the month.
|
3422
|
-
*
|
3423
|
-
* >**Note:** If there are no published posts in a specific month, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
|
3424
|
-
* @public
|
3425
|
-
* @param options - Options specifying time frame, sort, and filter.
|
3426
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3427
|
-
* @permissionScope Read Blog
|
3428
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3429
|
-
* @permissionScope Manage Blog
|
3430
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3431
|
-
* @permissionScope Manage Blog
|
3432
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3433
|
-
* @permissionScope Read Draft Blog Posts
|
3434
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3435
|
-
* @applicableIdentity APP
|
3436
|
-
* @applicableIdentity VISITOR
|
3437
|
-
* @returns Get Blog Post Count Stats response
|
3438
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.QueryPostCountStats
|
3439
|
-
*/
|
3440
|
-
export declare function queryPostCountStats(options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`>>;
|
3441
|
-
export interface QueryPostCountStatsOptions {
|
3324
|
+
interface QueryPostCountStatsOptions {
|
3442
3325
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
3443
3326
|
rangeStart?: Date | null;
|
3444
3327
|
/**
|
@@ -3469,25 +3352,7 @@ export interface QueryPostCountStatsOptions {
|
|
3469
3352
|
*/
|
3470
3353
|
timeZone?: string | null;
|
3471
3354
|
}
|
3472
|
-
|
3473
|
-
* Retrieves the total amount of published posts of the blog.
|
3474
|
-
* @public
|
3475
|
-
* @param options - Language Options.
|
3476
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3477
|
-
* @permissionScope Read Blog
|
3478
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3479
|
-
* @permissionScope Manage Blog
|
3480
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3481
|
-
* @permissionScope Manage Blog
|
3482
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3483
|
-
* @permissionScope Read Draft Blog Posts
|
3484
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3485
|
-
* @applicableIdentity APP
|
3486
|
-
* @applicableIdentity VISITOR
|
3487
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
3488
|
-
*/
|
3489
|
-
export declare function getTotalPosts(options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`>>;
|
3490
|
-
export interface GetTotalPostsOptions {
|
3355
|
+
interface GetTotalPostsOptions {
|
3491
3356
|
/**
|
3492
3357
|
* Language filter.
|
3493
3358
|
*
|
@@ -3497,29 +3362,7 @@ export interface GetTotalPostsOptions {
|
|
3497
3362
|
*/
|
3498
3363
|
language?: string | null;
|
3499
3364
|
}
|
3500
|
-
|
3501
|
-
* Retrieves a post by the specified ID.
|
3502
|
-
* @param postId - Post ID.
|
3503
|
-
* @public
|
3504
|
-
* @requiredField postId
|
3505
|
-
* @param options - Options specifying which fields to return.
|
3506
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3507
|
-
* @permissionScope Read Blog
|
3508
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3509
|
-
* @permissionScope Manage Blog
|
3510
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3511
|
-
* @permissionScope Manage Blog
|
3512
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3513
|
-
* @permissionScope Read Draft Blog Posts
|
3514
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3515
|
-
* @applicableIdentity APP
|
3516
|
-
* @applicableIdentity VISITOR
|
3517
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
3518
|
-
*/
|
3519
|
-
export declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<GetPostResponse, {
|
3520
|
-
[P in PostNonNullablePaths]: `post.${P}`;
|
3521
|
-
}[PostNonNullablePaths]>>;
|
3522
|
-
export interface GetPostOptions {
|
3365
|
+
interface GetPostOptions {
|
3523
3366
|
/**
|
3524
3367
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3525
3368
|
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
@@ -3528,34 +3371,7 @@ export interface GetPostOptions {
|
|
3528
3371
|
*/
|
3529
3372
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3530
3373
|
}
|
3531
|
-
|
3532
|
-
* Retrieves a post with the provided slug.
|
3533
|
-
*
|
3534
|
-
* The slug is the end of a post's URL that refers to a specific post.
|
3535
|
-
* For example, if a post's URL is `https:/example.com/blog/post/my-post-slug`,
|
3536
|
-
* the slug is `my-post-slug`. The slug is case-sensitive, and is generally derived from the post title,
|
3537
|
-
* unless specified otherwise.
|
3538
|
-
* @param slug - Slug of the post to retrieve.
|
3539
|
-
* @public
|
3540
|
-
* @requiredField slug
|
3541
|
-
* @param options - Options specifying which fields to return.
|
3542
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3543
|
-
* @permissionScope Read Blog
|
3544
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3545
|
-
* @permissionScope Manage Blog
|
3546
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3547
|
-
* @permissionScope Manage Blog
|
3548
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3549
|
-
* @permissionScope Read Draft Blog Posts
|
3550
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3551
|
-
* @applicableIdentity APP
|
3552
|
-
* @applicableIdentity VISITOR
|
3553
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
3554
|
-
*/
|
3555
|
-
export declare function getPostBySlug(slug: string, options?: GetPostBySlugOptions): Promise<NonNullablePaths<GetPostBySlugResponse, {
|
3556
|
-
[P in PostNonNullablePaths]: `post.${P}`;
|
3557
|
-
}[PostNonNullablePaths]>>;
|
3558
|
-
export interface GetPostBySlugOptions {
|
3374
|
+
interface GetPostBySlugOptions {
|
3559
3375
|
/**
|
3560
3376
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3561
3377
|
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
@@ -3564,32 +3380,7 @@ export interface GetPostBySlugOptions {
|
|
3564
3380
|
*/
|
3565
3381
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3566
3382
|
}
|
3567
|
-
|
3568
|
-
* Retrieves a list of up to 100 published posts per request.
|
3569
|
-
*
|
3570
|
-
* List Posts runs with these defaults, which you can override:
|
3571
|
-
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
3572
|
-
* - `paging.limit` is `50`.
|
3573
|
-
* - `paging.offset` is `0`.
|
3574
|
-
* @public
|
3575
|
-
* @param options - Sort, filter, and paging options.
|
3576
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3577
|
-
* @permissionScope Read Blog
|
3578
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3579
|
-
* @permissionScope Manage Blog
|
3580
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3581
|
-
* @permissionScope Manage Blog
|
3582
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3583
|
-
* @permissionScope Read Draft Blog Posts
|
3584
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3585
|
-
* @applicableIdentity APP
|
3586
|
-
* @applicableIdentity VISITOR
|
3587
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
3588
|
-
*/
|
3589
|
-
export declare function listPosts(options?: ListPostsOptions): Promise<NonNullablePaths<ListPostsResponse, {
|
3590
|
-
[P in PostNonNullablePaths]: `posts.${number}.${P}`;
|
3591
|
-
}[PostNonNullablePaths] | `metaData.count` | `metaData.offset` | `metaData.total`>>;
|
3592
|
-
export interface ListPostsOptions {
|
3383
|
+
interface ListPostsOptions {
|
3593
3384
|
/**
|
3594
3385
|
* Whether to return only featured posts.
|
3595
3386
|
*
|
@@ -3653,42 +3444,7 @@ export interface ListPostsOptions {
|
|
3653
3444
|
*/
|
3654
3445
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3655
3446
|
}
|
3656
|
-
|
3657
|
-
* Creates a query to retrieve a list of posts.
|
3658
|
-
*
|
3659
|
-
*
|
3660
|
-
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
3661
|
-
*
|
3662
|
-
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
3663
|
-
*
|
3664
|
-
* You can refine the query by chaining `PostsQueryBuilder` functions onto the query. `PostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryPosts()` returns.
|
3665
|
-
*
|
3666
|
-
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
|
3667
|
-
* + `limit(50)`
|
3668
|
-
* + `descending('firstPublishedDate')`
|
3669
|
-
*
|
3670
|
-
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
3671
|
-
*
|
3672
|
-
* To learn how to query posts, refer to the table below.
|
3673
|
-
*
|
3674
|
-
* The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the `items` property in `PostsQueryResult`.
|
3675
|
-
* @public
|
3676
|
-
* @param options - Options specifying which fields to return.
|
3677
|
-
* @permissionScope Read Blog
|
3678
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3679
|
-
* @permissionScope Manage Blog
|
3680
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3681
|
-
* @permissionScope Manage Blog
|
3682
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3683
|
-
* @permissionScope Read Draft Blog Posts
|
3684
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3685
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3686
|
-
* @applicableIdentity APP
|
3687
|
-
* @applicableIdentity VISITOR
|
3688
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
3689
|
-
*/
|
3690
|
-
export declare function queryPosts(options?: QueryPostsOptions): PostsQueryBuilder;
|
3691
|
-
export interface QueryPostsOptions {
|
3447
|
+
interface QueryPostsOptions {
|
3692
3448
|
/**
|
3693
3449
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3694
3450
|
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
@@ -3704,13 +3460,13 @@ interface QueryCursorResult {
|
|
3704
3460
|
length: number;
|
3705
3461
|
pageSize: number;
|
3706
3462
|
}
|
3707
|
-
|
3463
|
+
interface PostsQueryResult extends QueryCursorResult {
|
3708
3464
|
items: Post[];
|
3709
3465
|
query: PostsQueryBuilder;
|
3710
3466
|
next: () => Promise<PostsQueryResult>;
|
3711
3467
|
prev: () => Promise<PostsQueryResult>;
|
3712
3468
|
}
|
3713
|
-
|
3469
|
+
interface PostsQueryBuilder {
|
3714
3470
|
/** @param propertyName - Property whose value is compared with `value`.
|
3715
3471
|
* @param value - Value to compare against.
|
3716
3472
|
*/
|
@@ -3722,19 +3478,19 @@ export interface PostsQueryBuilder {
|
|
3722
3478
|
/** @param propertyName - Property whose value is compared with `value`.
|
3723
3479
|
* @param value - Value to compare against.
|
3724
3480
|
*/
|
3725
|
-
ge: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
|
3481
|
+
ge: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
|
3726
3482
|
/** @param propertyName - Property whose value is compared with `value`.
|
3727
3483
|
* @param value - Value to compare against.
|
3728
3484
|
*/
|
3729
|
-
gt: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
|
3485
|
+
gt: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
|
3730
3486
|
/** @param propertyName - Property whose value is compared with `value`.
|
3731
3487
|
* @param value - Value to compare against.
|
3732
3488
|
*/
|
3733
|
-
le: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
|
3489
|
+
le: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
|
3734
3490
|
/** @param propertyName - Property whose value is compared with `value`.
|
3735
3491
|
* @param value - Value to compare against.
|
3736
3492
|
*/
|
3737
|
-
lt: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
|
3493
|
+
lt: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
|
3738
3494
|
/** @param propertyName - Property whose value is compared with `string`.
|
3739
3495
|
* @param string - String to compare against. Case-insensitive.
|
3740
3496
|
*/
|
@@ -3759,25 +3515,5 @@ export interface PostsQueryBuilder {
|
|
3759
3515
|
skipTo: (cursor: string) => PostsQueryBuilder;
|
3760
3516
|
find: () => Promise<PostsQueryResult>;
|
3761
3517
|
}
|
3762
|
-
|
3763
|
-
|
3764
|
-
*
|
3765
|
-
* A post's metrics include the comments, likes, and views the post receives.
|
3766
|
-
* @param postId - Post ID to retrieve metrics for.
|
3767
|
-
* @public
|
3768
|
-
* @requiredField postId
|
3769
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3770
|
-
* @permissionScope Read Blog
|
3771
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3772
|
-
* @permissionScope Manage Blog
|
3773
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3774
|
-
* @permissionScope Manage Blog
|
3775
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3776
|
-
* @permissionScope Read Draft Blog Posts
|
3777
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3778
|
-
* @applicableIdentity APP
|
3779
|
-
* @applicableIdentity VISITOR
|
3780
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostMetrics
|
3781
|
-
*/
|
3782
|
-
export declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`>>;
|
3783
|
-
export {};
|
3518
|
+
|
3519
|
+
export { Origin as $, Alignment as A, PollLayoutDirection as B, Crop as C, BackgroundType as D, DecorationType as E, FontType as F, type GetTotalPostsOptions as G, AppType as H, InitialExpandedItems as I, Direction as J, VerticalAlignment as K, type ListPostsOptions as L, MapType as M, NodeType as N, Orientation as O, type Post as P, type QueryPostCountStatsOptions as Q, NullValue as R, Source as S, Type as T, ModerationStatusStatus as U, ViewMode as V, WidthType as W, QueryPublicationsCountStatsRequestOrder as X, Order as Y, WebhookIdentityType as Z, GetPostTemplatesSort as _, type QueryPostCountStatsResponse as a, type PollSettings as a$, Status as a0, Field as a1, PostFieldField as a2, GetPostsSort as a3, SortOrder as a4, type CoverMedia as a5, type CoverMediaMediaOneOf as a6, type FocalPoint as a7, type PostCountInfo as a8, type Metrics as a9, type PDFSettings as aA, type GalleryData as aB, type V1Media as aC, type Image as aD, type Video as aE, type Item as aF, type ItemDataOneOf as aG, type GalleryOptions as aH, type Layout as aI, type ItemStyle as aJ, type Thumbnails as aK, type GIFData as aL, type GIF as aM, type HeadingData as aN, type HTMLData as aO, type HTMLDataDataOneOf as aP, type ImageData as aQ, type StylesBorder as aR, type ImageDataStyles as aS, type LinkPreviewData as aT, type LinkPreviewDataStyles as aU, type MapData as aV, type MapSettings as aW, type ParagraphData as aX, type PollData as aY, type Permissions as aZ, type Option as a_, type SeoSchema as aa, type Keyword as ab, type Tag as ac, type Settings as ad, type RichContent as ae, type Node as af, type NodeDataOneOf as ag, type NodeStyle as ah, type ButtonData as ai, type Border as aj, type Colors as ak, type PluginContainerData as al, type PluginContainerDataWidth as am, type PluginContainerDataWidthDataOneOf as an, type Spoiler as ao, type Height as ap, type Styles as aq, type Link as ar, type LinkDataOneOf as as, type Rel as at, type CodeBlockData as au, type TextStyle as av, type DividerData as aw, type FileData as ax, type FileSource as ay, type FileSourceDataOneOf as az, type GetTotalPostsResponse as b, type DomainEvent as b$, type PollLayout as b0, type OptionLayout as b1, type Gradient as b2, type Background as b3, type BackgroundBackgroundOneOf as b4, type PollDesign as b5, type OptionDesign as b6, type Poll as b7, type PollDataLayout as b8, type Design as b9, type BulletedListData as bA, type BlockquoteData as bB, type CaptionData as bC, type LayoutCellData as bD, type Metadata as bE, type DocumentStyle as bF, type TextNodeStyle as bG, type ModerationDetails as bH, type Media as bI, type MediaMediaOneOf as bJ, type WixMedia as bK, type VideoResolution as bL, type EmbedMedia as bM, type EmbedThumbnail as bN, type EmbedVideo as bO, type PostTranslation as bP, type PostCategoriesUpdated as bQ, type PostTagsUpdated as bR, type ScheduledPostPublished as bS, type QueryPublicationsCountStatsRequest as bT, type QueryPublicationsCountStatsResponse as bU, type PeriodPublicationsCount as bV, type QueryPostCountStatsRequest as bW, type PeriodPostCount as bX, type GetTotalPublicationsRequest as bY, type GetTotalPublicationsResponse as bZ, type GetTotalPostsRequest as b_, type TextData as ba, type Decoration as bb, type DecorationDataOneOf as bc, type AnchorData as bd, type ColorData as be, type LinkData as bf, type MentionData as bg, type FontSizeData as bh, type SpoilerData as bi, type AppEmbedData as bj, type AppEmbedDataAppDataOneOf as bk, type BookingData as bl, type EventData as bm, type VideoData as bn, type PlaybackOptions as bo, type EmbedData as bp, type Oembed as bq, type CollapsibleListData as br, type TableData as bs, type Dimensions as bt, type TableCellData as bu, type CellStyle as bv, type BorderColors as bw, type ListValue as bx, type AudioData as by, type OrderedListData as bz, type GetPostOptions as c, type ListDemoPostsResponse as c$, type DomainEventBodyOneOf as c0, type EntityCreatedEvent as c1, type RestoreInfo as c2, type EntityUpdatedEvent as c3, type EntityDeletedEvent as c4, type ActionEvent as c5, type MessageEnvelope as c6, type IdentificationData as c7, type IdentificationDataIdOneOf as c8, type ListTemplatesRequest as c9, type Sorting as cA, type PlatformQuery as cB, type PlatformQueryPagingMethodOneOf as cC, type Paging as cD, type CursorPaging as cE, type QueryPostsResponse as cF, type PagingMetadataV2 as cG, type Cursors as cH, type GetPostMetricsRequest as cI, type BulkGetPostMetricsRequest as cJ, type BulkGetPostMetricsResponse as cK, type ViewPostRequest as cL, type ViewPostResponse as cM, type LikePostRequest as cN, type LikePostResponse as cO, type UnlikePostRequest as cP, type UnlikePostResponse as cQ, type PinPostRequest as cR, type PinPostResponse as cS, type UnpinPostRequest as cT, type UnpinPostResponse as cU, type ListPostsArchiveRequest as cV, type ListPostsArchiveResponse as cW, type BulkGetPostReactionsRequest as cX, type BulkGetPostReactionsResponse as cY, type Reactions as cZ, type ListDemoPostsRequest as c_, type BlogPaging as ca, type ListTemplatesResponse as cb, type MetaData as cc, type Category as cd, type CategoryTranslation as ce, type GetTemplateRequest as cf, type GetTemplateResponse as cg, type CreateDraftPostFromTemplateRequest as ch, type CreateDraftPostFromTemplateResponse as ci, type DraftPost as cj, type DraftPostTranslation as ck, type GetTotalLikesPerMemberRequest as cl, type GetTotalLikesPerMemberResponse as cm, type PostLiked as cn, type PostLikedInitiatorOneOf as co, type PostUnliked as cp, type PostUnlikedInitiatorOneOf as cq, type PostCountersUpdated as cr, type PostCountersUpdatedInitiatorOneOf as cs, type PostOwnerChanged as ct, type InitialPostsCopied as cu, type GetPostRequest as cv, type GetPostResponse as cw, type GetPostBySlugRequest as cx, type ListPostsRequest as cy, type QueryPostsRequest as cz, type GetPostBySlugOptions as d, type ConvertDraftJsToRichContentRequest as d0, type ConvertDraftJsToRichContentResponse as d1, type ConvertRichContentToDraftJsRequest as d2, type ConvertRichContentToDraftJsResponse as d3, type OldBlogMigratedEvent as d4, type BaseEventMetadata as d5, type EventMetadata as d6, type PostsQueryResult as d7, type GetPostBySlugResponse as e, type ListPostsResponse as f, type QueryPostsOptions as g, type PostsQueryBuilder as h, type GetPostMetricsResponse as i, type PostCreatedEnvelope as j, type PostDeletedEnvelope as k, type PostLikedEnvelope as l, type PostUnlikedEnvelope as m, type PostUpdatedEnvelope as n, PluginContainerDataAlignment as o, Target as p, TextAlignment as q, LineStyle as r, Width as s, LayoutType as t, ThumbnailsAlignment as u, GIFType as v, Position as w, ViewRole as x, VoteRole as y, PollLayoutType as z };
|