@wix/auto_sdk_blog_posts 1.0.18 → 1.0.19
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-CEsWp0Fx.d.mts} +256 -485
- package/build/{es/src/blog-v3-post-posts.universal.d.ts → blog-v3-post-posts.universal-CEsWp0Fx.d.ts} +256 -485
- package/build/index.d.mts +130 -0
- package/build/index.d.ts +130 -0
- package/build/index.js +1975 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +1899 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{cjs/src/blog-v3-post-posts.universal.d.ts → blog-v3-post-posts.universal-nU7XoyIE.d.mts} +256 -485
- package/build/internal/{es/src/blog-v3-post-posts.universal.d.ts → blog-v3-post-posts.universal-nU7XoyIE.d.ts} +256 -485
- package/build/internal/index.d.mts +130 -0
- package/build/internal/index.d.ts +130 -0
- package/build/internal/index.js +1975 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +1899 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/{es/src/blog-v3-post-posts.types.d.ts → internal/meta.d.mts} +238 -1375
- package/build/internal/{cjs/src/blog-v3-post-posts.types.d.ts → meta.d.ts} +238 -1375
- package/build/internal/meta.js +1002 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +969 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{cjs/src/blog-v3-post-posts.types.d.ts → meta.d.mts} +238 -1375
- package/build/{internal/es/src/blog-v3-post-posts.types.d.ts → meta.d.ts} +238 -1375
- package/build/meta.js +1002 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +969 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/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 -59
- package/build/cjs/src/blog-v3-post-posts.http.js +0 -892
- 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 -99
- 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 -966
- 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/package.json +0 -3
- 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 -59
- package/build/es/src/blog-v3-post-posts.http.js +0 -882
- 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 -99
- 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 -933
- package/build/es/src/blog-v3-post-posts.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/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 -59
- package/build/internal/cjs/src/blog-v3-post-posts.http.js +0 -892
- 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 -99
- 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.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 -966
- 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 -59
- package/build/internal/es/src/blog-v3-post-posts.http.js +0 -882
- 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 -99
- 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.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 -933
- 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",
|
@@ -474,7 +473,7 @@ export declare enum NodeType {
|
|
474
473
|
LAYOUT = "LAYOUT",
|
475
474
|
LAYOUT_CELL = "LAYOUT_CELL"
|
476
475
|
}
|
477
|
-
|
476
|
+
interface NodeStyle {
|
478
477
|
/** The top padding value in pixels. */
|
479
478
|
paddingTop?: string | null;
|
480
479
|
/** The bottom padding value in pixels. */
|
@@ -482,7 +481,7 @@ export interface NodeStyle {
|
|
482
481
|
/** The background color as a hexadecimal value. */
|
483
482
|
backgroundColor?: string | null;
|
484
483
|
}
|
485
|
-
|
484
|
+
interface ButtonData {
|
486
485
|
/** Styling for the button's container. */
|
487
486
|
containerData?: PluginContainerData;
|
488
487
|
/** The button type. */
|
@@ -494,13 +493,13 @@ export interface ButtonData {
|
|
494
493
|
/** Button link details. */
|
495
494
|
link?: Link;
|
496
495
|
}
|
497
|
-
|
496
|
+
interface Border {
|
498
497
|
/** Border width in pixels. */
|
499
498
|
width?: number | null;
|
500
499
|
/** Border radius in pixels. */
|
501
500
|
radius?: number | null;
|
502
501
|
}
|
503
|
-
|
502
|
+
interface Colors {
|
504
503
|
/** The text color as a hexadecimal value. */
|
505
504
|
text?: string | null;
|
506
505
|
/** The border color as a hexadecimal value. */
|
@@ -508,7 +507,7 @@ export interface Colors {
|
|
508
507
|
/** The background color as a hexadecimal value. */
|
509
508
|
background?: string | null;
|
510
509
|
}
|
511
|
-
|
510
|
+
interface PluginContainerData {
|
512
511
|
/** The width of the node when it's displayed. */
|
513
512
|
width?: PluginContainerDataWidth;
|
514
513
|
/** The node's alignment within its container. */
|
@@ -520,7 +519,7 @@ export interface PluginContainerData {
|
|
520
519
|
/** 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`. */
|
521
520
|
textWrap?: boolean | null;
|
522
521
|
}
|
523
|
-
|
522
|
+
declare enum WidthType {
|
524
523
|
/** Width matches the content width */
|
525
524
|
CONTENT = "CONTENT",
|
526
525
|
/** Small Width */
|
@@ -530,7 +529,7 @@ export declare enum WidthType {
|
|
530
529
|
/** coast-to-coast display */
|
531
530
|
FULL_WIDTH = "FULL_WIDTH"
|
532
531
|
}
|
533
|
-
|
532
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
534
533
|
/**
|
535
534
|
* One of the following predefined width options:
|
536
535
|
* `CONTENT`: The width of the container matches the content width.
|
@@ -543,7 +542,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
543
542
|
custom?: string | null;
|
544
543
|
}
|
545
544
|
/** @oneof */
|
546
|
-
|
545
|
+
interface PluginContainerDataWidthDataOneOf {
|
547
546
|
/**
|
548
547
|
* One of the following predefined width options:
|
549
548
|
* `CONTENT`: The width of the container matches the content width.
|
@@ -555,7 +554,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
555
554
|
/** A custom width value in pixels. */
|
556
555
|
custom?: string | null;
|
557
556
|
}
|
558
|
-
|
557
|
+
declare enum PluginContainerDataAlignment {
|
559
558
|
/** Center Alignment */
|
560
559
|
CENTER = "CENTER",
|
561
560
|
/** Left Alignment */
|
@@ -563,7 +562,7 @@ export declare enum PluginContainerDataAlignment {
|
|
563
562
|
/** Right Alignment */
|
564
563
|
RIGHT = "RIGHT"
|
565
564
|
}
|
566
|
-
|
565
|
+
interface Spoiler {
|
567
566
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
568
567
|
enabled?: boolean | null;
|
569
568
|
/** The description displayed on top of the spoiler cover. */
|
@@ -571,23 +570,23 @@ export interface Spoiler {
|
|
571
570
|
/** The text for the button used to remove the spoiler cover. */
|
572
571
|
buttonText?: string | null;
|
573
572
|
}
|
574
|
-
|
573
|
+
interface Height {
|
575
574
|
/** A custom height value in pixels. */
|
576
575
|
custom?: string | null;
|
577
576
|
}
|
578
|
-
|
577
|
+
declare enum Type {
|
579
578
|
/** Regular link button */
|
580
579
|
LINK = "LINK",
|
581
580
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
582
581
|
ACTION = "ACTION"
|
583
582
|
}
|
584
|
-
|
583
|
+
interface Styles {
|
585
584
|
/** Border attributes. */
|
586
585
|
border?: Border;
|
587
586
|
/** Color attributes. */
|
588
587
|
colors?: Colors;
|
589
588
|
}
|
590
|
-
|
589
|
+
interface Link extends LinkDataOneOf {
|
591
590
|
/** The absolute URL for the linked document. */
|
592
591
|
url?: string;
|
593
592
|
/** The target node's ID. Used for linking to another node in this object. */
|
@@ -606,13 +605,13 @@ export interface Link extends LinkDataOneOf {
|
|
606
605
|
customData?: string | null;
|
607
606
|
}
|
608
607
|
/** @oneof */
|
609
|
-
|
608
|
+
interface LinkDataOneOf {
|
610
609
|
/** The absolute URL for the linked document. */
|
611
610
|
url?: string;
|
612
611
|
/** The target node's ID. Used for linking to another node in this object. */
|
613
612
|
anchor?: string;
|
614
613
|
}
|
615
|
-
|
614
|
+
declare enum Target {
|
616
615
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
617
616
|
SELF = "SELF",
|
618
617
|
/** Opens the linked document in a new window or tab */
|
@@ -622,7 +621,7 @@ export declare enum Target {
|
|
622
621
|
/** Opens the linked document in the full body of the window */
|
623
622
|
TOP = "TOP"
|
624
623
|
}
|
625
|
-
|
624
|
+
interface Rel {
|
626
625
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
627
626
|
nofollow?: boolean | null;
|
628
627
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
@@ -632,17 +631,17 @@ export interface Rel {
|
|
632
631
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
633
632
|
noreferrer?: boolean | null;
|
634
633
|
}
|
635
|
-
|
634
|
+
interface CodeBlockData {
|
636
635
|
/** Styling for the code block's text. */
|
637
636
|
textStyle?: TextStyle;
|
638
637
|
}
|
639
|
-
|
638
|
+
interface TextStyle {
|
640
639
|
/** Text alignment. Defaults to `AUTO`. */
|
641
640
|
textAlignment?: TextAlignment;
|
642
641
|
/** 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. */
|
643
642
|
lineHeight?: string | null;
|
644
643
|
}
|
645
|
-
|
644
|
+
declare enum TextAlignment {
|
646
645
|
/** browser default, eqivalent to `initial` */
|
647
646
|
AUTO = "AUTO",
|
648
647
|
/** Left align */
|
@@ -654,7 +653,7 @@ export declare enum TextAlignment {
|
|
654
653
|
/** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
|
655
654
|
JUSTIFY = "JUSTIFY"
|
656
655
|
}
|
657
|
-
|
656
|
+
interface DividerData {
|
658
657
|
/** Styling for the divider's container. */
|
659
658
|
containerData?: PluginContainerData;
|
660
659
|
/** Divider line style. */
|
@@ -664,7 +663,7 @@ export interface DividerData {
|
|
664
663
|
/** Divider alignment. */
|
665
664
|
alignment?: Alignment;
|
666
665
|
}
|
667
|
-
|
666
|
+
declare enum LineStyle {
|
668
667
|
/** Single Line */
|
669
668
|
SINGLE = "SINGLE",
|
670
669
|
/** Double Line */
|
@@ -674,7 +673,7 @@ export declare enum LineStyle {
|
|
674
673
|
/** Dotted Line */
|
675
674
|
DOTTED = "DOTTED"
|
676
675
|
}
|
677
|
-
|
676
|
+
declare enum Width {
|
678
677
|
/** Large line */
|
679
678
|
LARGE = "LARGE",
|
680
679
|
/** Medium line */
|
@@ -682,7 +681,7 @@ export declare enum Width {
|
|
682
681
|
/** Small line */
|
683
682
|
SMALL = "SMALL"
|
684
683
|
}
|
685
|
-
|
684
|
+
declare enum Alignment {
|
686
685
|
/** Center alignment */
|
687
686
|
CENTER = "CENTER",
|
688
687
|
/** Left alignment */
|
@@ -690,7 +689,7 @@ export declare enum Alignment {
|
|
690
689
|
/** Right alignment */
|
691
690
|
RIGHT = "RIGHT"
|
692
691
|
}
|
693
|
-
|
692
|
+
interface FileData {
|
694
693
|
/** Styling for the file's container. */
|
695
694
|
containerData?: PluginContainerData;
|
696
695
|
/** The source for the file's data. */
|
@@ -713,7 +712,7 @@ export interface FileData {
|
|
713
712
|
/** File size in KB. */
|
714
713
|
sizeInKb?: string | null;
|
715
714
|
}
|
716
|
-
|
715
|
+
declare enum ViewMode {
|
717
716
|
/** No PDF view */
|
718
717
|
NONE = "NONE",
|
719
718
|
/** Full PDF view */
|
@@ -721,7 +720,7 @@ export declare enum ViewMode {
|
|
721
720
|
/** Mini PDF view */
|
722
721
|
MINI = "MINI"
|
723
722
|
}
|
724
|
-
|
723
|
+
interface FileSource extends FileSourceDataOneOf {
|
725
724
|
/** The absolute URL for the file's source. */
|
726
725
|
url?: string | null;
|
727
726
|
/**
|
@@ -735,7 +734,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
735
734
|
private?: boolean | null;
|
736
735
|
}
|
737
736
|
/** @oneof */
|
738
|
-
|
737
|
+
interface FileSourceDataOneOf {
|
739
738
|
/** The absolute URL for the file's source. */
|
740
739
|
url?: string | null;
|
741
740
|
/**
|
@@ -746,7 +745,7 @@ export interface FileSourceDataOneOf {
|
|
746
745
|
/** An ID that's resolved to a URL by a resolver function. */
|
747
746
|
_id?: string | null;
|
748
747
|
}
|
749
|
-
|
748
|
+
interface PDFSettings {
|
750
749
|
/**
|
751
750
|
* PDF view mode. One of the following:
|
752
751
|
* `NONE` : The PDF isn't displayed.
|
@@ -759,7 +758,7 @@ export interface PDFSettings {
|
|
759
758
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
760
759
|
disablePrint?: boolean | null;
|
761
760
|
}
|
762
|
-
|
761
|
+
interface GalleryData {
|
763
762
|
/** Styling for the gallery's container. */
|
764
763
|
containerData?: PluginContainerData;
|
765
764
|
/** The items in the gallery. */
|
@@ -771,7 +770,7 @@ export interface GalleryData {
|
|
771
770
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
772
771
|
disableDownload?: boolean | null;
|
773
772
|
}
|
774
|
-
|
773
|
+
interface V1Media {
|
775
774
|
/** The source for the media's data. */
|
776
775
|
src?: FileSource;
|
777
776
|
/** Media width in pixels. */
|
@@ -781,19 +780,19 @@ export interface V1Media {
|
|
781
780
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
782
781
|
duration?: number | null;
|
783
782
|
}
|
784
|
-
|
783
|
+
interface Image {
|
785
784
|
/** Image file details. */
|
786
785
|
media?: V1Media;
|
787
786
|
/** Link details for images that are links. */
|
788
787
|
link?: Link;
|
789
788
|
}
|
790
|
-
|
789
|
+
interface Video {
|
791
790
|
/** Video file details. */
|
792
791
|
media?: V1Media;
|
793
792
|
/** Video thumbnail file details. */
|
794
793
|
thumbnail?: V1Media;
|
795
794
|
}
|
796
|
-
|
795
|
+
interface Item extends ItemDataOneOf {
|
797
796
|
/** An image item. */
|
798
797
|
image?: Image;
|
799
798
|
/** A video item. */
|
@@ -804,13 +803,13 @@ export interface Item extends ItemDataOneOf {
|
|
804
803
|
altText?: string | null;
|
805
804
|
}
|
806
805
|
/** @oneof */
|
807
|
-
|
806
|
+
interface ItemDataOneOf {
|
808
807
|
/** An image item. */
|
809
808
|
image?: Image;
|
810
809
|
/** A video item. */
|
811
810
|
video?: Video;
|
812
811
|
}
|
813
|
-
|
812
|
+
interface GalleryOptions {
|
814
813
|
/** Gallery layout. */
|
815
814
|
layout?: Layout;
|
816
815
|
/** Styling for gallery items. */
|
@@ -818,7 +817,7 @@ export interface GalleryOptions {
|
|
818
817
|
/** Styling for gallery thumbnail images. */
|
819
818
|
thumbnails?: Thumbnails;
|
820
819
|
}
|
821
|
-
|
820
|
+
declare enum LayoutType {
|
822
821
|
/** Collage type */
|
823
822
|
COLLAGE = "COLLAGE",
|
824
823
|
/** Masonry type */
|
@@ -840,19 +839,19 @@ export declare enum LayoutType {
|
|
840
839
|
/** Fullsize images type */
|
841
840
|
FULLSIZE = "FULLSIZE"
|
842
841
|
}
|
843
|
-
|
842
|
+
declare enum Orientation {
|
844
843
|
/** Rows Orientation */
|
845
844
|
ROWS = "ROWS",
|
846
845
|
/** Columns Orientation */
|
847
846
|
COLUMNS = "COLUMNS"
|
848
847
|
}
|
849
|
-
|
848
|
+
declare enum Crop {
|
850
849
|
/** Crop to fill */
|
851
850
|
FILL = "FILL",
|
852
851
|
/** Crop to fit */
|
853
852
|
FIT = "FIT"
|
854
853
|
}
|
855
|
-
|
854
|
+
declare enum ThumbnailsAlignment {
|
856
855
|
/** Top alignment */
|
857
856
|
TOP = "TOP",
|
858
857
|
/** Right alignment */
|
@@ -864,7 +863,7 @@ export declare enum ThumbnailsAlignment {
|
|
864
863
|
/** No thumbnail */
|
865
864
|
NONE = "NONE"
|
866
865
|
}
|
867
|
-
|
866
|
+
interface Layout {
|
868
867
|
/** Gallery layout type. */
|
869
868
|
type?: LayoutType;
|
870
869
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
@@ -876,7 +875,7 @@ export interface Layout {
|
|
876
875
|
/** The number of columns to display on mobile screens. */
|
877
876
|
mobileNumberOfColumns?: number | null;
|
878
877
|
}
|
879
|
-
|
878
|
+
interface ItemStyle {
|
880
879
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
881
880
|
targetSize?: number | null;
|
882
881
|
/** Item ratio */
|
@@ -886,13 +885,13 @@ export interface ItemStyle {
|
|
886
885
|
/** The spacing between items in pixels. */
|
887
886
|
spacing?: number | null;
|
888
887
|
}
|
889
|
-
|
888
|
+
interface Thumbnails {
|
890
889
|
/** Thumbnail alignment. */
|
891
890
|
placement?: ThumbnailsAlignment;
|
892
891
|
/** Spacing between thumbnails in pixels. */
|
893
892
|
spacing?: number | null;
|
894
893
|
}
|
895
|
-
|
894
|
+
interface GIFData {
|
896
895
|
/** Styling for the GIF's container. */
|
897
896
|
containerData?: PluginContainerData;
|
898
897
|
/** The source of the full size GIF. */
|
@@ -906,7 +905,7 @@ export interface GIFData {
|
|
906
905
|
/** Type of GIF (Sticker or GIF). Defaults to `GIF`. */
|
907
906
|
gifType?: GIFType;
|
908
907
|
}
|
909
|
-
|
908
|
+
interface GIF {
|
910
909
|
/**
|
911
910
|
* GIF format URL.
|
912
911
|
* @format WEB_URL
|
@@ -923,11 +922,11 @@ export interface GIF {
|
|
923
922
|
*/
|
924
923
|
still?: string | null;
|
925
924
|
}
|
926
|
-
|
925
|
+
declare enum GIFType {
|
927
926
|
GIF = "GIF",
|
928
927
|
STICKER = "STICKER"
|
929
928
|
}
|
930
|
-
|
929
|
+
interface HeadingData {
|
931
930
|
/** Heading level from 1-6. */
|
932
931
|
level?: number;
|
933
932
|
/** Styling for the heading text. */
|
@@ -935,7 +934,7 @@ export interface HeadingData {
|
|
935
934
|
/** Indentation level from 1-4. */
|
936
935
|
indentation?: number | null;
|
937
936
|
}
|
938
|
-
|
937
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
939
938
|
/** The URL for the HTML code for the node. */
|
940
939
|
url?: string;
|
941
940
|
/** The HTML code for the node. */
|
@@ -953,7 +952,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
953
952
|
autoHeight?: boolean | null;
|
954
953
|
}
|
955
954
|
/** @oneof */
|
956
|
-
|
955
|
+
interface HTMLDataDataOneOf {
|
957
956
|
/** The URL for the HTML code for the node. */
|
958
957
|
url?: string;
|
959
958
|
/** The HTML code for the node. */
|
@@ -964,11 +963,11 @@ export interface HTMLDataDataOneOf {
|
|
964
963
|
*/
|
965
964
|
isAdsense?: boolean | null;
|
966
965
|
}
|
967
|
-
|
966
|
+
declare enum Source {
|
968
967
|
HTML = "HTML",
|
969
968
|
ADSENSE = "ADSENSE"
|
970
969
|
}
|
971
|
-
|
970
|
+
interface ImageData {
|
972
971
|
/** Styling for the image's container. */
|
973
972
|
containerData?: PluginContainerData;
|
974
973
|
/** Image file details. */
|
@@ -987,7 +986,7 @@ export interface ImageData {
|
|
987
986
|
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
988
987
|
disableDownload?: boolean | null;
|
989
988
|
}
|
990
|
-
|
989
|
+
interface StylesBorder {
|
991
990
|
/** Border width in pixels. */
|
992
991
|
width?: number | null;
|
993
992
|
/**
|
@@ -998,11 +997,11 @@ export interface StylesBorder {
|
|
998
997
|
/** Border radius in pixels. */
|
999
998
|
radius?: number | null;
|
1000
999
|
}
|
1001
|
-
|
1000
|
+
interface ImageDataStyles {
|
1002
1001
|
/** Border attributes. */
|
1003
1002
|
border?: StylesBorder;
|
1004
1003
|
}
|
1005
|
-
|
1004
|
+
interface LinkPreviewData {
|
1006
1005
|
/** Styling for the link preview's container. */
|
1007
1006
|
containerData?: PluginContainerData;
|
1008
1007
|
/** Link details. */
|
@@ -1016,7 +1015,7 @@ export interface LinkPreviewData {
|
|
1016
1015
|
/** The preview content as HTML. */
|
1017
1016
|
html?: string | null;
|
1018
1017
|
}
|
1019
|
-
|
1018
|
+
declare enum Position {
|
1020
1019
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
1021
1020
|
START = "START",
|
1022
1021
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
@@ -1026,7 +1025,7 @@ export declare enum Position {
|
|
1026
1025
|
/** Thumbnail hidden and not displayed */
|
1027
1026
|
HIDDEN = "HIDDEN"
|
1028
1027
|
}
|
1029
|
-
|
1028
|
+
interface LinkPreviewDataStyles {
|
1030
1029
|
/**
|
1031
1030
|
* Background color as a hexadecimal value.
|
1032
1031
|
* @format COLOR_HEX
|
@@ -1059,13 +1058,13 @@ export interface LinkPreviewDataStyles {
|
|
1059
1058
|
/** Position of thumbnail. Defaults to `START`. */
|
1060
1059
|
thumbnailPosition?: Position;
|
1061
1060
|
}
|
1062
|
-
|
1061
|
+
interface MapData {
|
1063
1062
|
/** Styling for the map's container. */
|
1064
1063
|
containerData?: PluginContainerData;
|
1065
1064
|
/** Map settings. */
|
1066
1065
|
mapSettings?: MapSettings;
|
1067
1066
|
}
|
1068
|
-
|
1067
|
+
interface MapSettings {
|
1069
1068
|
/** The address to display on the map. */
|
1070
1069
|
address?: string | null;
|
1071
1070
|
/** Sets whether the map is draggable. */
|
@@ -1089,7 +1088,7 @@ export interface MapSettings {
|
|
1089
1088
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
1090
1089
|
mapType?: MapType;
|
1091
1090
|
}
|
1092
|
-
|
1091
|
+
declare enum MapType {
|
1093
1092
|
/** Roadmap map type */
|
1094
1093
|
ROADMAP = "ROADMAP",
|
1095
1094
|
/** Satellite map type */
|
@@ -1099,7 +1098,7 @@ export declare enum MapType {
|
|
1099
1098
|
/** Terrain map type */
|
1100
1099
|
TERRAIN = "TERRAIN"
|
1101
1100
|
}
|
1102
|
-
|
1101
|
+
interface ParagraphData {
|
1103
1102
|
/** Styling for the paragraph text. */
|
1104
1103
|
textStyle?: TextStyle;
|
1105
1104
|
/** Indentation level from 1-4. */
|
@@ -1107,7 +1106,7 @@ export interface ParagraphData {
|
|
1107
1106
|
/** Paragraph level */
|
1108
1107
|
level?: number | null;
|
1109
1108
|
}
|
1110
|
-
|
1109
|
+
interface PollData {
|
1111
1110
|
/** Styling for the poll's container. */
|
1112
1111
|
containerData?: PluginContainerData;
|
1113
1112
|
/** Poll data. */
|
@@ -1117,7 +1116,7 @@ export interface PollData {
|
|
1117
1116
|
/** Styling for the poll and voting options. */
|
1118
1117
|
design?: Design;
|
1119
1118
|
}
|
1120
|
-
|
1119
|
+
declare enum ViewRole {
|
1121
1120
|
/** Only Poll creator can view the results */
|
1122
1121
|
CREATOR = "CREATOR",
|
1123
1122
|
/** Anyone who voted can see the results */
|
@@ -1125,13 +1124,13 @@ export declare enum ViewRole {
|
|
1125
1124
|
/** Anyone can see the results, even if one didn't vote */
|
1126
1125
|
EVERYONE = "EVERYONE"
|
1127
1126
|
}
|
1128
|
-
|
1127
|
+
declare enum VoteRole {
|
1129
1128
|
/** Logged in member */
|
1130
1129
|
SITE_MEMBERS = "SITE_MEMBERS",
|
1131
1130
|
/** Anyone */
|
1132
1131
|
ALL = "ALL"
|
1133
1132
|
}
|
1134
|
-
|
1133
|
+
interface Permissions {
|
1135
1134
|
/** Sets who can view the poll results. */
|
1136
1135
|
view?: ViewRole;
|
1137
1136
|
/** Sets who can vote. */
|
@@ -1139,7 +1138,7 @@ export interface Permissions {
|
|
1139
1138
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
1140
1139
|
allowMultipleVotes?: boolean | null;
|
1141
1140
|
}
|
1142
|
-
|
1141
|
+
interface Option {
|
1143
1142
|
/** Option ID. */
|
1144
1143
|
_id?: string | null;
|
1145
1144
|
/** Option title. */
|
@@ -1147,7 +1146,7 @@ export interface Option {
|
|
1147
1146
|
/** The image displayed with the option. */
|
1148
1147
|
image?: V1Media;
|
1149
1148
|
}
|
1150
|
-
|
1149
|
+
interface PollSettings {
|
1151
1150
|
/** Permissions settings for voting. */
|
1152
1151
|
permissions?: Permissions;
|
1153
1152
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
@@ -1155,19 +1154,19 @@ export interface PollSettings {
|
|
1155
1154
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
1156
1155
|
showVotesCount?: boolean | null;
|
1157
1156
|
}
|
1158
|
-
|
1157
|
+
declare enum PollLayoutType {
|
1159
1158
|
/** List */
|
1160
1159
|
LIST = "LIST",
|
1161
1160
|
/** Grid */
|
1162
1161
|
GRID = "GRID"
|
1163
1162
|
}
|
1164
|
-
|
1163
|
+
declare enum PollLayoutDirection {
|
1165
1164
|
/** Left-to-right */
|
1166
1165
|
LTR = "LTR",
|
1167
1166
|
/** Right-to-left */
|
1168
1167
|
RTL = "RTL"
|
1169
1168
|
}
|
1170
|
-
|
1169
|
+
interface PollLayout {
|
1171
1170
|
/** The layout for displaying the voting options. */
|
1172
1171
|
type?: PollLayoutType;
|
1173
1172
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
@@ -1175,11 +1174,11 @@ export interface PollLayout {
|
|
1175
1174
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
1176
1175
|
enableImage?: boolean | null;
|
1177
1176
|
}
|
1178
|
-
|
1177
|
+
interface OptionLayout {
|
1179
1178
|
/** Sets whether to display option images. Defaults to `false`. */
|
1180
1179
|
enableImage?: boolean | null;
|
1181
1180
|
}
|
1182
|
-
|
1181
|
+
declare enum BackgroundType {
|
1183
1182
|
/** Color background type */
|
1184
1183
|
COLOR = "COLOR",
|
1185
1184
|
/** Image background type */
|
@@ -1187,7 +1186,7 @@ export declare enum BackgroundType {
|
|
1187
1186
|
/** Gradiant background type */
|
1188
1187
|
GRADIENT = "GRADIENT"
|
1189
1188
|
}
|
1190
|
-
|
1189
|
+
interface Gradient {
|
1191
1190
|
/** The gradient angle in degrees. */
|
1192
1191
|
angle?: number | null;
|
1193
1192
|
/**
|
@@ -1201,7 +1200,7 @@ export interface Gradient {
|
|
1201
1200
|
*/
|
1202
1201
|
lastColor?: string | null;
|
1203
1202
|
}
|
1204
|
-
|
1203
|
+
interface Background extends BackgroundBackgroundOneOf {
|
1205
1204
|
/**
|
1206
1205
|
* The background color as a hexademical value.
|
1207
1206
|
* @format COLOR_HEX
|
@@ -1215,7 +1214,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
1215
1214
|
type?: BackgroundType;
|
1216
1215
|
}
|
1217
1216
|
/** @oneof */
|
1218
|
-
|
1217
|
+
interface BackgroundBackgroundOneOf {
|
1219
1218
|
/**
|
1220
1219
|
* The background color as a hexademical value.
|
1221
1220
|
* @format COLOR_HEX
|
@@ -1226,17 +1225,17 @@ export interface BackgroundBackgroundOneOf {
|
|
1226
1225
|
/** Details for a gradient background. */
|
1227
1226
|
gradient?: Gradient;
|
1228
1227
|
}
|
1229
|
-
|
1228
|
+
interface PollDesign {
|
1230
1229
|
/** Background styling. */
|
1231
1230
|
background?: Background;
|
1232
1231
|
/** Border radius in pixels. */
|
1233
1232
|
borderRadius?: number | null;
|
1234
1233
|
}
|
1235
|
-
|
1234
|
+
interface OptionDesign {
|
1236
1235
|
/** Border radius in pixels. */
|
1237
1236
|
borderRadius?: number | null;
|
1238
1237
|
}
|
1239
|
-
|
1238
|
+
interface Poll {
|
1240
1239
|
/** Poll ID. */
|
1241
1240
|
_id?: string | null;
|
1242
1241
|
/** Poll title. */
|
@@ -1250,26 +1249,26 @@ export interface Poll {
|
|
1250
1249
|
/** The poll's permissions and display settings. */
|
1251
1250
|
settings?: PollSettings;
|
1252
1251
|
}
|
1253
|
-
|
1252
|
+
interface PollDataLayout {
|
1254
1253
|
/** Poll layout settings. */
|
1255
1254
|
poll?: PollLayout;
|
1256
1255
|
/** Voting otpions layout settings. */
|
1257
1256
|
options?: OptionLayout;
|
1258
1257
|
}
|
1259
|
-
|
1258
|
+
interface Design {
|
1260
1259
|
/** Styling for the poll. */
|
1261
1260
|
poll?: PollDesign;
|
1262
1261
|
/** Styling for voting options. */
|
1263
1262
|
options?: OptionDesign;
|
1264
1263
|
}
|
1265
|
-
|
1264
|
+
interface TextData {
|
1266
1265
|
/** The text to apply decorations to. */
|
1267
1266
|
text?: string;
|
1268
1267
|
/** The decorations to apply. */
|
1269
1268
|
decorations?: Decoration[];
|
1270
1269
|
}
|
1271
1270
|
/** Adds appearence changes to text */
|
1272
|
-
|
1271
|
+
interface Decoration extends DecorationDataOneOf {
|
1273
1272
|
/** Data for an anchor link decoration. */
|
1274
1273
|
anchorData?: AnchorData;
|
1275
1274
|
/** Data for a color decoration. */
|
@@ -1292,7 +1291,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
1292
1291
|
type?: DecorationType;
|
1293
1292
|
}
|
1294
1293
|
/** @oneof */
|
1295
|
-
|
1294
|
+
interface DecorationDataOneOf {
|
1296
1295
|
/** Data for an anchor link decoration. */
|
1297
1296
|
anchorData?: AnchorData;
|
1298
1297
|
/** Data for a color decoration. */
|
@@ -1312,7 +1311,7 @@ export interface DecorationDataOneOf {
|
|
1312
1311
|
/** Data for a spoiler decoration. */
|
1313
1312
|
spoilerData?: SpoilerData;
|
1314
1313
|
}
|
1315
|
-
|
1314
|
+
declare enum DecorationType {
|
1316
1315
|
BOLD = "BOLD",
|
1317
1316
|
ITALIC = "ITALIC",
|
1318
1317
|
UNDERLINE = "UNDERLINE",
|
@@ -1324,21 +1323,21 @@ export declare enum DecorationType {
|
|
1324
1323
|
FONT_SIZE = "FONT_SIZE",
|
1325
1324
|
EXTERNAL = "EXTERNAL"
|
1326
1325
|
}
|
1327
|
-
|
1326
|
+
interface AnchorData {
|
1328
1327
|
/** The target node's ID. */
|
1329
1328
|
anchor?: string;
|
1330
1329
|
}
|
1331
|
-
|
1330
|
+
interface ColorData {
|
1332
1331
|
/** The text's background color as a hexadecimal value. */
|
1333
1332
|
background?: string | null;
|
1334
1333
|
/** The text's foreground color as a hexadecimal value. */
|
1335
1334
|
foreground?: string | null;
|
1336
1335
|
}
|
1337
|
-
|
1336
|
+
interface LinkData {
|
1338
1337
|
/** Link details. */
|
1339
1338
|
link?: Link;
|
1340
1339
|
}
|
1341
|
-
|
1340
|
+
interface MentionData {
|
1342
1341
|
/** The mentioned user's name. */
|
1343
1342
|
name?: string;
|
1344
1343
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
@@ -1346,21 +1345,21 @@ export interface MentionData {
|
|
1346
1345
|
/** Mentioned user's ID. */
|
1347
1346
|
_id?: string | null;
|
1348
1347
|
}
|
1349
|
-
|
1348
|
+
interface FontSizeData {
|
1350
1349
|
/** The units used for the font size. */
|
1351
1350
|
unit?: FontType;
|
1352
1351
|
/** Font size value. */
|
1353
1352
|
value?: number | null;
|
1354
1353
|
}
|
1355
|
-
|
1354
|
+
declare enum FontType {
|
1356
1355
|
PX = "PX",
|
1357
1356
|
EM = "EM"
|
1358
1357
|
}
|
1359
|
-
|
1358
|
+
interface SpoilerData {
|
1360
1359
|
/** Spoiler ID. */
|
1361
1360
|
_id?: string | null;
|
1362
1361
|
}
|
1363
|
-
|
1362
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
1364
1363
|
/** Data for embedded Wix Bookings content. */
|
1365
1364
|
bookingData?: BookingData;
|
1366
1365
|
/** Data for embedded Wix Events content. */
|
@@ -1382,28 +1381,28 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1382
1381
|
image?: V1Media;
|
1383
1382
|
}
|
1384
1383
|
/** @oneof */
|
1385
|
-
|
1384
|
+
interface AppEmbedDataAppDataOneOf {
|
1386
1385
|
/** Data for embedded Wix Bookings content. */
|
1387
1386
|
bookingData?: BookingData;
|
1388
1387
|
/** Data for embedded Wix Events content. */
|
1389
1388
|
eventData?: EventData;
|
1390
1389
|
}
|
1391
|
-
|
1390
|
+
declare enum AppType {
|
1392
1391
|
PRODUCT = "PRODUCT",
|
1393
1392
|
EVENT = "EVENT",
|
1394
1393
|
BOOKING = "BOOKING"
|
1395
1394
|
}
|
1396
|
-
|
1395
|
+
interface BookingData {
|
1397
1396
|
/** Booking duration in minutes. */
|
1398
1397
|
durations?: string | null;
|
1399
1398
|
}
|
1400
|
-
|
1399
|
+
interface EventData {
|
1401
1400
|
/** Event schedule. */
|
1402
1401
|
scheduling?: string | null;
|
1403
1402
|
/** Event location. */
|
1404
1403
|
location?: string | null;
|
1405
1404
|
}
|
1406
|
-
|
1405
|
+
interface VideoData {
|
1407
1406
|
/** Styling for the video's container. */
|
1408
1407
|
containerData?: PluginContainerData;
|
1409
1408
|
/** Video details. */
|
@@ -1417,7 +1416,7 @@ export interface VideoData {
|
|
1417
1416
|
/** Video options. */
|
1418
1417
|
options?: PlaybackOptions;
|
1419
1418
|
}
|
1420
|
-
|
1419
|
+
interface PlaybackOptions {
|
1421
1420
|
/** Sets whether the media will automatically start playing. */
|
1422
1421
|
autoPlay?: boolean | null;
|
1423
1422
|
/** Sets whether media's will be looped. */
|
@@ -1425,7 +1424,7 @@ export interface PlaybackOptions {
|
|
1425
1424
|
/** Sets whether media's controls will be shown. */
|
1426
1425
|
showControls?: boolean | null;
|
1427
1426
|
}
|
1428
|
-
|
1427
|
+
interface EmbedData {
|
1429
1428
|
/** Styling for the oEmbed node's container. */
|
1430
1429
|
containerData?: PluginContainerData;
|
1431
1430
|
/** An [oEmbed](https://www.oembed.com) object. */
|
@@ -1433,7 +1432,7 @@ export interface EmbedData {
|
|
1433
1432
|
/** Origin asset source. */
|
1434
1433
|
src?: string | null;
|
1435
1434
|
}
|
1436
|
-
|
1435
|
+
interface Oembed {
|
1437
1436
|
/** The resource type. */
|
1438
1437
|
type?: string | null;
|
1439
1438
|
/** The width of the resource specified in the `url` property in pixels. */
|
@@ -1465,7 +1464,7 @@ export interface Oembed {
|
|
1465
1464
|
/** The oEmbed version number. This value must be `1.0`. */
|
1466
1465
|
version?: string | null;
|
1467
1466
|
}
|
1468
|
-
|
1467
|
+
interface CollapsibleListData {
|
1469
1468
|
/** Styling for the collapsible list's container. */
|
1470
1469
|
containerData?: PluginContainerData;
|
1471
1470
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
@@ -1477,7 +1476,7 @@ export interface CollapsibleListData {
|
|
1477
1476
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
1478
1477
|
isQapageData?: boolean | null;
|
1479
1478
|
}
|
1480
|
-
|
1479
|
+
declare enum InitialExpandedItems {
|
1481
1480
|
/** First item will be expended initally */
|
1482
1481
|
FIRST = "FIRST",
|
1483
1482
|
/** All items will expended initally */
|
@@ -1485,13 +1484,13 @@ export declare enum InitialExpandedItems {
|
|
1485
1484
|
/** All items collapsed initally */
|
1486
1485
|
NONE = "NONE"
|
1487
1486
|
}
|
1488
|
-
|
1487
|
+
declare enum Direction {
|
1489
1488
|
/** Left-to-right */
|
1490
1489
|
LTR = "LTR",
|
1491
1490
|
/** Right-to-left */
|
1492
1491
|
RTL = "RTL"
|
1493
1492
|
}
|
1494
|
-
|
1493
|
+
interface TableData {
|
1495
1494
|
/** Styling for the table's container. */
|
1496
1495
|
containerData?: PluginContainerData;
|
1497
1496
|
/** The table's dimensions. */
|
@@ -1506,7 +1505,7 @@ export interface TableData {
|
|
1506
1505
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
1507
1506
|
columnHeader?: boolean | null;
|
1508
1507
|
}
|
1509
|
-
|
1508
|
+
interface Dimensions {
|
1510
1509
|
/** An array representing relative width of each column in relation to the other columns. */
|
1511
1510
|
colsWidthRatio?: number[];
|
1512
1511
|
/** An array representing the height of each row in pixels. */
|
@@ -1514,13 +1513,13 @@ export interface Dimensions {
|
|
1514
1513
|
/** An array representing the minimum width of each column in pixels. */
|
1515
1514
|
colsMinWidth?: number[];
|
1516
1515
|
}
|
1517
|
-
|
1516
|
+
interface TableCellData {
|
1518
1517
|
/** Styling for the cell's background color and text alignment. */
|
1519
1518
|
cellStyle?: CellStyle;
|
1520
1519
|
/** The cell's border colors. */
|
1521
1520
|
borderColors?: BorderColors;
|
1522
1521
|
}
|
1523
|
-
|
1522
|
+
declare enum VerticalAlignment {
|
1524
1523
|
/** Top alignment */
|
1525
1524
|
TOP = "TOP",
|
1526
1525
|
/** Middle alignment */
|
@@ -1528,7 +1527,7 @@ export declare enum VerticalAlignment {
|
|
1528
1527
|
/** Bottom alignment */
|
1529
1528
|
BOTTOM = "BOTTOM"
|
1530
1529
|
}
|
1531
|
-
|
1530
|
+
interface CellStyle {
|
1532
1531
|
/** Vertical alignment for the cell's text. */
|
1533
1532
|
verticalAlignment?: VerticalAlignment;
|
1534
1533
|
/**
|
@@ -1537,7 +1536,7 @@ export interface CellStyle {
|
|
1537
1536
|
*/
|
1538
1537
|
backgroundColor?: string | null;
|
1539
1538
|
}
|
1540
|
-
|
1539
|
+
interface BorderColors {
|
1541
1540
|
/**
|
1542
1541
|
* Left border color as a hexadecimal value.
|
1543
1542
|
* @format COLOR_HEX
|
@@ -1565,7 +1564,7 @@ export interface BorderColors {
|
|
1565
1564
|
*
|
1566
1565
|
* The JSON representation for `NullValue` is JSON `null`.
|
1567
1566
|
*/
|
1568
|
-
|
1567
|
+
declare enum NullValue {
|
1569
1568
|
/** Null value. */
|
1570
1569
|
NULL_VALUE = "NULL_VALUE"
|
1571
1570
|
}
|
@@ -1574,11 +1573,11 @@ export declare enum NullValue {
|
|
1574
1573
|
*
|
1575
1574
|
* The JSON representation for `ListValue` is JSON array.
|
1576
1575
|
*/
|
1577
|
-
|
1576
|
+
interface ListValue {
|
1578
1577
|
/** Repeated field of dynamically typed values. */
|
1579
1578
|
values?: any[];
|
1580
1579
|
}
|
1581
|
-
|
1580
|
+
interface AudioData {
|
1582
1581
|
/** Styling for the audio node's container. */
|
1583
1582
|
containerData?: PluginContainerData;
|
1584
1583
|
/** Audio file details. */
|
@@ -1594,7 +1593,7 @@ export interface AudioData {
|
|
1594
1593
|
/** An HTML version of the audio node. */
|
1595
1594
|
html?: string | null;
|
1596
1595
|
}
|
1597
|
-
|
1596
|
+
interface OrderedListData {
|
1598
1597
|
/** Indentation level from 0-4. */
|
1599
1598
|
indentation?: number;
|
1600
1599
|
/** Offset level from 0-4. */
|
@@ -1602,24 +1601,24 @@ export interface OrderedListData {
|
|
1602
1601
|
/** List start number. */
|
1603
1602
|
start?: number | null;
|
1604
1603
|
}
|
1605
|
-
|
1604
|
+
interface BulletedListData {
|
1606
1605
|
/** Indentation level from 0-4. */
|
1607
1606
|
indentation?: number;
|
1608
1607
|
/** Offset level from 0-4. */
|
1609
1608
|
offset?: number | null;
|
1610
1609
|
}
|
1611
|
-
|
1610
|
+
interface BlockquoteData {
|
1612
1611
|
/** Indentation level from 1-4. */
|
1613
1612
|
indentation?: number;
|
1614
1613
|
}
|
1615
|
-
|
1614
|
+
interface CaptionData {
|
1616
1615
|
textStyle?: TextStyle;
|
1617
1616
|
}
|
1618
|
-
|
1617
|
+
interface LayoutCellData {
|
1619
1618
|
/** Size of the cell in 12 columns grid. */
|
1620
1619
|
colSpan?: number | null;
|
1621
1620
|
}
|
1622
|
-
|
1621
|
+
interface Metadata {
|
1623
1622
|
/** Schema version. */
|
1624
1623
|
version?: number;
|
1625
1624
|
/**
|
@@ -1636,7 +1635,7 @@ export interface Metadata {
|
|
1636
1635
|
/** Object ID. */
|
1637
1636
|
_id?: string | null;
|
1638
1637
|
}
|
1639
|
-
|
1638
|
+
interface DocumentStyle {
|
1640
1639
|
/** Styling for H1 nodes. */
|
1641
1640
|
headerOne?: TextNodeStyle;
|
1642
1641
|
/** Styling for H2 nodes. */
|
@@ -1656,7 +1655,7 @@ export interface DocumentStyle {
|
|
1656
1655
|
/** Styling for code block nodes. */
|
1657
1656
|
codeBlock?: TextNodeStyle;
|
1658
1657
|
}
|
1659
|
-
|
1658
|
+
interface TextNodeStyle {
|
1660
1659
|
/** The decorations to apply to the node. */
|
1661
1660
|
decorations?: Decoration[];
|
1662
1661
|
/** Padding and background color for the node. */
|
@@ -1664,7 +1663,7 @@ export interface TextNodeStyle {
|
|
1664
1663
|
/** Line height for text in the node. */
|
1665
1664
|
lineHeight?: string | null;
|
1666
1665
|
}
|
1667
|
-
|
1666
|
+
interface ModerationDetails {
|
1668
1667
|
/**
|
1669
1668
|
* Member ID of the person submitting the draft post for review.
|
1670
1669
|
* @format GUID
|
@@ -1682,12 +1681,12 @@ export interface ModerationDetails {
|
|
1682
1681
|
/** Date the post was approved or rejected. */
|
1683
1682
|
moderationDate?: Date | null;
|
1684
1683
|
}
|
1685
|
-
|
1684
|
+
declare enum ModerationStatusStatus {
|
1686
1685
|
UNKNOWN = "UNKNOWN",
|
1687
1686
|
APPROVED = "APPROVED",
|
1688
1687
|
REJECTED = "REJECTED"
|
1689
1688
|
}
|
1690
|
-
|
1689
|
+
interface Media extends MediaMediaOneOf {
|
1691
1690
|
/** Wix Media details. */
|
1692
1691
|
wixMedia?: WixMedia;
|
1693
1692
|
/** Embed media details. */
|
@@ -1704,19 +1703,19 @@ export interface Media extends MediaMediaOneOf {
|
|
1704
1703
|
altText?: string | null;
|
1705
1704
|
}
|
1706
1705
|
/** @oneof */
|
1707
|
-
|
1706
|
+
interface MediaMediaOneOf {
|
1708
1707
|
/** Wix Media details. */
|
1709
1708
|
wixMedia?: WixMedia;
|
1710
1709
|
/** Embed media details. */
|
1711
1710
|
embedMedia?: EmbedMedia;
|
1712
1711
|
}
|
1713
|
-
|
1712
|
+
interface WixMedia {
|
1714
1713
|
/** Image details. */
|
1715
1714
|
image?: string;
|
1716
1715
|
/** Video details. */
|
1717
1716
|
videoV2?: string;
|
1718
1717
|
}
|
1719
|
-
|
1718
|
+
interface VideoResolution {
|
1720
1719
|
/** Video URL. */
|
1721
1720
|
url?: string;
|
1722
1721
|
/** Video height. */
|
@@ -1726,13 +1725,13 @@ export interface VideoResolution {
|
|
1726
1725
|
/** Video format for example, mp4, hls. */
|
1727
1726
|
format?: string;
|
1728
1727
|
}
|
1729
|
-
|
1728
|
+
interface EmbedMedia {
|
1730
1729
|
/** Thumbnail details. */
|
1731
1730
|
thumbnail?: EmbedThumbnail;
|
1732
1731
|
/** Video details. */
|
1733
1732
|
video?: EmbedVideo;
|
1734
1733
|
}
|
1735
|
-
|
1734
|
+
interface EmbedThumbnail {
|
1736
1735
|
/**
|
1737
1736
|
* Thumbnail url.
|
1738
1737
|
* @maxLength 2000
|
@@ -1743,7 +1742,7 @@ export interface EmbedThumbnail {
|
|
1743
1742
|
/** Thumbnail height. */
|
1744
1743
|
height?: number;
|
1745
1744
|
}
|
1746
|
-
|
1745
|
+
interface EmbedVideo {
|
1747
1746
|
/**
|
1748
1747
|
* Video url.
|
1749
1748
|
* @maxLength 2000
|
@@ -1754,7 +1753,7 @@ export interface EmbedVideo {
|
|
1754
1753
|
/** Video height. */
|
1755
1754
|
height?: number;
|
1756
1755
|
}
|
1757
|
-
|
1756
|
+
interface PostTranslation {
|
1758
1757
|
/**
|
1759
1758
|
* Post ID.
|
1760
1759
|
* @format GUID
|
@@ -1775,7 +1774,7 @@ export interface PostTranslation {
|
|
1775
1774
|
/** Post URL. */
|
1776
1775
|
url?: string;
|
1777
1776
|
}
|
1778
|
-
|
1777
|
+
interface PostCategoriesUpdated {
|
1779
1778
|
/**
|
1780
1779
|
* ID of the post which counters were updated.
|
1781
1780
|
* @format GUID
|
@@ -1794,7 +1793,7 @@ export interface PostCategoriesUpdated {
|
|
1794
1793
|
*/
|
1795
1794
|
previousCategories?: string[];
|
1796
1795
|
}
|
1797
|
-
|
1796
|
+
interface PostTagsUpdated {
|
1798
1797
|
/**
|
1799
1798
|
* ID of the post which counters were updated.
|
1800
1799
|
* @format GUID
|
@@ -1813,7 +1812,7 @@ export interface PostTagsUpdated {
|
|
1813
1812
|
*/
|
1814
1813
|
previousTags?: string[];
|
1815
1814
|
}
|
1816
|
-
|
1815
|
+
interface ScheduledPostPublished {
|
1817
1816
|
/**
|
1818
1817
|
* ID of the scheduled post which was published.
|
1819
1818
|
* @format GUID
|
@@ -1821,7 +1820,7 @@ export interface ScheduledPostPublished {
|
|
1821
1820
|
postId?: string;
|
1822
1821
|
}
|
1823
1822
|
/** Get Blog Publications Count Stats request */
|
1824
|
-
|
1823
|
+
interface QueryPublicationsCountStatsRequest {
|
1825
1824
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1826
1825
|
rangeStart?: Date | null;
|
1827
1826
|
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
@@ -1844,25 +1843,25 @@ export interface QueryPublicationsCountStatsRequest {
|
|
1844
1843
|
*/
|
1845
1844
|
timeZone?: string | null;
|
1846
1845
|
}
|
1847
|
-
|
1846
|
+
declare enum QueryPublicationsCountStatsRequestOrder {
|
1848
1847
|
UNKNOWN = "UNKNOWN",
|
1849
1848
|
OLDEST = "OLDEST",
|
1850
1849
|
NEWEST = "NEWEST"
|
1851
1850
|
}
|
1852
1851
|
/** Get Blog Publications Count Stats response */
|
1853
|
-
|
1852
|
+
interface QueryPublicationsCountStatsResponse {
|
1854
1853
|
/** Chronologically ordered list of publications. */
|
1855
1854
|
stats?: PeriodPublicationsCount[];
|
1856
1855
|
}
|
1857
1856
|
/** Publications count for a specific time period */
|
1858
|
-
|
1857
|
+
interface PeriodPublicationsCount {
|
1859
1858
|
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1860
1859
|
periodStart?: Date | null;
|
1861
1860
|
/** Number of posts published during this month. */
|
1862
1861
|
publicationsCount?: number;
|
1863
1862
|
}
|
1864
1863
|
/** Get Blog Post Count Stats request */
|
1865
|
-
|
1864
|
+
interface QueryPostCountStatsRequest {
|
1866
1865
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1867
1866
|
rangeStart?: Date | null;
|
1868
1867
|
/**
|
@@ -1893,24 +1892,24 @@ export interface QueryPostCountStatsRequest {
|
|
1893
1892
|
*/
|
1894
1893
|
timeZone?: string | null;
|
1895
1894
|
}
|
1896
|
-
|
1895
|
+
declare enum Order {
|
1897
1896
|
UNKNOWN = "UNKNOWN",
|
1898
1897
|
OLDEST = "OLDEST",
|
1899
1898
|
NEWEST = "NEWEST"
|
1900
1899
|
}
|
1901
1900
|
/** Get Blog Post Count Stats response */
|
1902
|
-
|
1901
|
+
interface QueryPostCountStatsResponse {
|
1903
1902
|
/** List of published post counts by month. */
|
1904
1903
|
stats?: PeriodPostCount[];
|
1905
1904
|
}
|
1906
1905
|
/** Post count for a specific time period */
|
1907
|
-
|
1906
|
+
interface PeriodPostCount {
|
1908
1907
|
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1909
1908
|
periodStart?: Date | null;
|
1910
1909
|
/** Number of posts published during this month. */
|
1911
1910
|
postCount?: number;
|
1912
1911
|
}
|
1913
|
-
|
1912
|
+
interface GetTotalPublicationsRequest {
|
1914
1913
|
/**
|
1915
1914
|
* Language filter
|
1916
1915
|
* @minLength 2
|
@@ -1918,11 +1917,11 @@ export interface GetTotalPublicationsRequest {
|
|
1918
1917
|
*/
|
1919
1918
|
language?: string | null;
|
1920
1919
|
}
|
1921
|
-
|
1920
|
+
interface GetTotalPublicationsResponse {
|
1922
1921
|
/** Total amount of publications. */
|
1923
1922
|
total?: number;
|
1924
1923
|
}
|
1925
|
-
|
1924
|
+
interface GetTotalPostsRequest {
|
1926
1925
|
/**
|
1927
1926
|
* Language filter.
|
1928
1927
|
*
|
@@ -1932,11 +1931,11 @@ export interface GetTotalPostsRequest {
|
|
1932
1931
|
*/
|
1933
1932
|
language?: string | null;
|
1934
1933
|
}
|
1935
|
-
|
1934
|
+
interface GetTotalPostsResponse {
|
1936
1935
|
/** Total amount of published posts. */
|
1937
1936
|
total?: number;
|
1938
1937
|
}
|
1939
|
-
|
1938
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
1940
1939
|
createdEvent?: EntityCreatedEvent;
|
1941
1940
|
updatedEvent?: EntityUpdatedEvent;
|
1942
1941
|
deletedEvent?: EntityDeletedEvent;
|
@@ -1979,19 +1978,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1979
1978
|
entityEventSequence?: string | null;
|
1980
1979
|
}
|
1981
1980
|
/** @oneof */
|
1982
|
-
|
1981
|
+
interface DomainEventBodyOneOf {
|
1983
1982
|
createdEvent?: EntityCreatedEvent;
|
1984
1983
|
updatedEvent?: EntityUpdatedEvent;
|
1985
1984
|
deletedEvent?: EntityDeletedEvent;
|
1986
1985
|
actionEvent?: ActionEvent;
|
1987
1986
|
}
|
1988
|
-
|
1987
|
+
interface EntityCreatedEvent {
|
1989
1988
|
entity?: string;
|
1990
1989
|
}
|
1991
|
-
|
1990
|
+
interface RestoreInfo {
|
1992
1991
|
deletedDate?: Date | null;
|
1993
1992
|
}
|
1994
|
-
|
1993
|
+
interface EntityUpdatedEvent {
|
1995
1994
|
/**
|
1996
1995
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
1997
1996
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
@@ -1999,14 +1998,14 @@ export interface EntityUpdatedEvent {
|
|
1999
1998
|
*/
|
2000
1999
|
currentEntity?: string;
|
2001
2000
|
}
|
2002
|
-
|
2001
|
+
interface EntityDeletedEvent {
|
2003
2002
|
/** Entity that was deleted */
|
2004
2003
|
deletedEntity?: string | null;
|
2005
2004
|
}
|
2006
|
-
|
2005
|
+
interface ActionEvent {
|
2007
2006
|
body?: string;
|
2008
2007
|
}
|
2009
|
-
|
2008
|
+
interface MessageEnvelope {
|
2010
2009
|
/**
|
2011
2010
|
* App instance ID.
|
2012
2011
|
* @format GUID
|
@@ -2022,7 +2021,7 @@ export interface MessageEnvelope {
|
|
2022
2021
|
/** Stringify payload. */
|
2023
2022
|
data?: string;
|
2024
2023
|
}
|
2025
|
-
|
2024
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
2026
2025
|
/**
|
2027
2026
|
* ID of a site visitor that has not logged in to the site.
|
2028
2027
|
* @format GUID
|
@@ -2047,7 +2046,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2047
2046
|
identityType?: WebhookIdentityType;
|
2048
2047
|
}
|
2049
2048
|
/** @oneof */
|
2050
|
-
|
2049
|
+
interface IdentificationDataIdOneOf {
|
2051
2050
|
/**
|
2052
2051
|
* ID of a site visitor that has not logged in to the site.
|
2053
2052
|
* @format GUID
|
@@ -2069,14 +2068,14 @@ export interface IdentificationDataIdOneOf {
|
|
2069
2068
|
*/
|
2070
2069
|
appId?: string;
|
2071
2070
|
}
|
2072
|
-
|
2071
|
+
declare enum WebhookIdentityType {
|
2073
2072
|
UNKNOWN = "UNKNOWN",
|
2074
2073
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
2075
2074
|
MEMBER = "MEMBER",
|
2076
2075
|
WIX_USER = "WIX_USER",
|
2077
2076
|
APP = "APP"
|
2078
2077
|
}
|
2079
|
-
|
2078
|
+
interface ListTemplatesRequest {
|
2080
2079
|
/**
|
2081
2080
|
* Filter post templates by given template category ids
|
2082
2081
|
* @maxSize 50
|
@@ -2095,13 +2094,13 @@ export interface ListTemplatesRequest {
|
|
2095
2094
|
/** Pagination options. */
|
2096
2095
|
paging?: BlogPaging;
|
2097
2096
|
}
|
2098
|
-
|
2097
|
+
declare enum GetPostTemplatesSort {
|
2099
2098
|
/** Sort by ascending publishing date. */
|
2100
2099
|
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
2101
2100
|
/** Sort by descending publishing date. */
|
2102
2101
|
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
2103
2102
|
}
|
2104
|
-
|
2103
|
+
interface BlogPaging {
|
2105
2104
|
/**
|
2106
2105
|
* Number of items to skip in the current sort order.
|
2107
2106
|
*
|
@@ -2124,7 +2123,7 @@ export interface BlogPaging {
|
|
2124
2123
|
*/
|
2125
2124
|
cursor?: string | null;
|
2126
2125
|
}
|
2127
|
-
|
2126
|
+
interface ListTemplatesResponse {
|
2128
2127
|
/** Available post templates */
|
2129
2128
|
postTemplates?: Post[];
|
2130
2129
|
/** Details on the paged set of posts templates returned. */
|
@@ -2132,7 +2131,7 @@ export interface ListTemplatesResponse {
|
|
2132
2131
|
/** Post template categories. This value is returned empty unless asked explicitly */
|
2133
2132
|
templateCategories?: Category[];
|
2134
2133
|
}
|
2135
|
-
|
2134
|
+
interface MetaData {
|
2136
2135
|
/** Number of items returned in this response. */
|
2137
2136
|
count?: number;
|
2138
2137
|
/** Requested offset. */
|
@@ -2145,7 +2144,7 @@ export interface MetaData {
|
|
2145
2144
|
*/
|
2146
2145
|
cursor?: string | null;
|
2147
2146
|
}
|
2148
|
-
|
2147
|
+
interface Category {
|
2149
2148
|
/**
|
2150
2149
|
* Category ID.
|
2151
2150
|
* @immutable
|
@@ -2213,7 +2212,7 @@ export interface Category {
|
|
2213
2212
|
*/
|
2214
2213
|
_updatedDate?: Date | null;
|
2215
2214
|
}
|
2216
|
-
|
2215
|
+
interface CategoryTranslation {
|
2217
2216
|
/**
|
2218
2217
|
* Category ID.
|
2219
2218
|
* @format GUID
|
@@ -2232,29 +2231,29 @@ export interface CategoryTranslation {
|
|
2232
2231
|
/** URL of this category page. */
|
2233
2232
|
url?: string;
|
2234
2233
|
}
|
2235
|
-
|
2234
|
+
interface GetTemplateRequest {
|
2236
2235
|
/**
|
2237
2236
|
* Post template id
|
2238
2237
|
* @format GUID
|
2239
2238
|
*/
|
2240
2239
|
postTemplateId?: string;
|
2241
2240
|
}
|
2242
|
-
|
2241
|
+
interface GetTemplateResponse {
|
2243
2242
|
/** Post template */
|
2244
2243
|
postTemplate?: Post;
|
2245
2244
|
}
|
2246
|
-
|
2245
|
+
interface CreateDraftPostFromTemplateRequest {
|
2247
2246
|
/**
|
2248
2247
|
* Post template id
|
2249
2248
|
* @format GUID
|
2250
2249
|
*/
|
2251
2250
|
postTemplateId?: string;
|
2252
2251
|
}
|
2253
|
-
|
2252
|
+
interface CreateDraftPostFromTemplateResponse {
|
2254
2253
|
/** Created draft post */
|
2255
2254
|
draftPost?: DraftPost;
|
2256
2255
|
}
|
2257
|
-
|
2256
|
+
interface DraftPost {
|
2258
2257
|
/**
|
2259
2258
|
* Draft post ID.
|
2260
2259
|
* @readonly
|
@@ -2389,7 +2388,7 @@ export interface DraftPost {
|
|
2389
2388
|
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
2390
2389
|
previewTextParagraph?: number | null;
|
2391
2390
|
}
|
2392
|
-
|
2391
|
+
declare enum Origin {
|
2393
2392
|
UNKNOWN = "UNKNOWN",
|
2394
2393
|
/** Changed by admin */
|
2395
2394
|
ADMIN = "ADMIN",
|
@@ -2462,7 +2461,7 @@ export declare enum Origin {
|
|
2462
2461
|
/** Saved automatically by AI tool. */
|
2463
2462
|
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
2464
2463
|
}
|
2465
|
-
|
2464
|
+
declare enum Status {
|
2466
2465
|
UNKNOWN = "UNKNOWN",
|
2467
2466
|
/** Status indicating the draft post is published. */
|
2468
2467
|
PUBLISHED = "PUBLISHED",
|
@@ -2475,7 +2474,7 @@ export declare enum Status {
|
|
2475
2474
|
/** Status indicating the draft post is in review. */
|
2476
2475
|
IN_REVIEW = "IN_REVIEW"
|
2477
2476
|
}
|
2478
|
-
|
2477
|
+
interface DraftPostTranslation {
|
2479
2478
|
/**
|
2480
2479
|
* Post ID.
|
2481
2480
|
* @format GUID
|
@@ -2498,18 +2497,18 @@ export interface DraftPostTranslation {
|
|
2498
2497
|
/** Post URL. */
|
2499
2498
|
url?: string;
|
2500
2499
|
}
|
2501
|
-
|
2500
|
+
interface GetTotalLikesPerMemberRequest {
|
2502
2501
|
/**
|
2503
2502
|
* Member ID.
|
2504
2503
|
* @format GUID
|
2505
2504
|
*/
|
2506
2505
|
memberId?: string;
|
2507
2506
|
}
|
2508
|
-
|
2507
|
+
interface GetTotalLikesPerMemberResponse {
|
2509
2508
|
/** The total number of likes of the member. */
|
2510
2509
|
total?: number;
|
2511
2510
|
}
|
2512
|
-
|
2511
|
+
interface PostLiked extends PostLikedInitiatorOneOf {
|
2513
2512
|
/**
|
2514
2513
|
* Member ID of person who liked the post (only returned when the member was logged in when liking the post).
|
2515
2514
|
* @format GUID
|
@@ -2527,7 +2526,7 @@ export interface PostLiked extends PostLikedInitiatorOneOf {
|
|
2527
2526
|
postId?: string;
|
2528
2527
|
}
|
2529
2528
|
/** @oneof */
|
2530
|
-
|
2529
|
+
interface PostLikedInitiatorOneOf {
|
2531
2530
|
/**
|
2532
2531
|
* Member ID of person who liked the post (only returned when the member was logged in when liking the post).
|
2533
2532
|
* @format GUID
|
@@ -2539,7 +2538,7 @@ export interface PostLikedInitiatorOneOf {
|
|
2539
2538
|
*/
|
2540
2539
|
anonymousVisitorId?: string | null;
|
2541
2540
|
}
|
2542
|
-
|
2541
|
+
interface PostUnliked extends PostUnlikedInitiatorOneOf {
|
2543
2542
|
/**
|
2544
2543
|
* Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
|
2545
2544
|
* @format GUID
|
@@ -2557,7 +2556,7 @@ export interface PostUnliked extends PostUnlikedInitiatorOneOf {
|
|
2557
2556
|
postId?: string;
|
2558
2557
|
}
|
2559
2558
|
/** @oneof */
|
2560
|
-
|
2559
|
+
interface PostUnlikedInitiatorOneOf {
|
2561
2560
|
/**
|
2562
2561
|
* Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
|
2563
2562
|
* @format GUID
|
@@ -2569,7 +2568,7 @@ export interface PostUnlikedInitiatorOneOf {
|
|
2569
2568
|
*/
|
2570
2569
|
anonymousVisitorId?: string | null;
|
2571
2570
|
}
|
2572
|
-
|
2571
|
+
interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
2573
2572
|
/**
|
2574
2573
|
* Member ID of person who triggered the counter update
|
2575
2574
|
* @format GUID
|
@@ -2591,7 +2590,7 @@ export interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
|
2591
2590
|
counter?: number;
|
2592
2591
|
}
|
2593
2592
|
/** @oneof */
|
2594
|
-
|
2593
|
+
interface PostCountersUpdatedInitiatorOneOf {
|
2595
2594
|
/**
|
2596
2595
|
* Member ID of person who triggered the counter update
|
2597
2596
|
* @format GUID
|
@@ -2603,7 +2602,7 @@ export interface PostCountersUpdatedInitiatorOneOf {
|
|
2603
2602
|
*/
|
2604
2603
|
anonymousVisitorId?: string | null;
|
2605
2604
|
}
|
2606
|
-
|
2605
|
+
declare enum Field {
|
2607
2606
|
/** Undefined field. */
|
2608
2607
|
UNKNOWN = "UNKNOWN",
|
2609
2608
|
/** Total comments field. */
|
@@ -2615,13 +2614,13 @@ export declare enum Field {
|
|
2615
2614
|
/** Rating count field. */
|
2616
2615
|
RATING_COUNT = "RATING_COUNT"
|
2617
2616
|
}
|
2618
|
-
|
2617
|
+
interface PostOwnerChanged {
|
2619
2618
|
}
|
2620
|
-
|
2619
|
+
interface InitialPostsCopied {
|
2621
2620
|
/** Number of posts copied. */
|
2622
2621
|
count?: number;
|
2623
2622
|
}
|
2624
|
-
|
2623
|
+
interface GetPostRequest {
|
2625
2624
|
/**
|
2626
2625
|
* Post ID.
|
2627
2626
|
* @minLength 1
|
@@ -2636,7 +2635,7 @@ export interface GetPostRequest {
|
|
2636
2635
|
*/
|
2637
2636
|
fieldsets?: PostFieldField[];
|
2638
2637
|
}
|
2639
|
-
|
2638
|
+
declare enum PostFieldField {
|
2640
2639
|
UNKNOWN = "UNKNOWN",
|
2641
2640
|
/** Includes post URL when present. */
|
2642
2641
|
URL = "URL",
|
@@ -2653,11 +2652,11 @@ export declare enum PostFieldField {
|
|
2653
2652
|
/** Includes post reference ID field. */
|
2654
2653
|
REFERENCE_ID = "REFERENCE_ID"
|
2655
2654
|
}
|
2656
|
-
|
2655
|
+
interface GetPostResponse {
|
2657
2656
|
/** Retrieved post info. */
|
2658
2657
|
post?: Post;
|
2659
2658
|
}
|
2660
|
-
|
2659
|
+
interface GetPostBySlugRequest {
|
2661
2660
|
/**
|
2662
2661
|
* Slug of the post to retrieve.
|
2663
2662
|
* @minLength 1
|
@@ -2672,11 +2671,11 @@ export interface GetPostBySlugRequest {
|
|
2672
2671
|
*/
|
2673
2672
|
fieldsets?: PostFieldField[];
|
2674
2673
|
}
|
2675
|
-
|
2674
|
+
interface GetPostBySlugResponse {
|
2676
2675
|
/** Retrieved post info. */
|
2677
2676
|
post?: Post;
|
2678
2677
|
}
|
2679
|
-
|
2678
|
+
interface ListPostsRequest {
|
2680
2679
|
/**
|
2681
2680
|
* Whether to return only featured posts.
|
2682
2681
|
*
|
@@ -2740,7 +2739,7 @@ export interface ListPostsRequest {
|
|
2740
2739
|
*/
|
2741
2740
|
fieldsets?: PostFieldField[];
|
2742
2741
|
}
|
2743
|
-
|
2742
|
+
declare enum GetPostsSort {
|
2744
2743
|
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
2745
2744
|
FEED = "FEED",
|
2746
2745
|
/** Ordered by `firstPublishedDate` in ascending order. */
|
@@ -2756,13 +2755,13 @@ export declare enum GetPostsSort {
|
|
2756
2755
|
/** Ordered by `title` in descending order. */
|
2757
2756
|
TITLE_DESC = "TITLE_DESC"
|
2758
2757
|
}
|
2759
|
-
|
2758
|
+
interface ListPostsResponse {
|
2760
2759
|
/** List of retrieved posts. */
|
2761
2760
|
posts?: Post[];
|
2762
2761
|
/** Details on the paged set of results returned. */
|
2763
2762
|
metaData?: MetaData;
|
2764
2763
|
}
|
2765
|
-
|
2764
|
+
interface QueryPostsRequest {
|
2766
2765
|
/** Query options. */
|
2767
2766
|
query?: PlatformQuery;
|
2768
2767
|
/**
|
@@ -2773,7 +2772,7 @@ export interface QueryPostsRequest {
|
|
2773
2772
|
*/
|
2774
2773
|
fieldsets?: PostFieldField[];
|
2775
2774
|
}
|
2776
|
-
|
2775
|
+
interface Sorting {
|
2777
2776
|
/**
|
2778
2777
|
* Name of the field to sort by.
|
2779
2778
|
* @maxLength 512
|
@@ -2782,11 +2781,11 @@ export interface Sorting {
|
|
2782
2781
|
/** Sort order. */
|
2783
2782
|
order?: SortOrder;
|
2784
2783
|
}
|
2785
|
-
|
2784
|
+
declare enum SortOrder {
|
2786
2785
|
ASC = "ASC",
|
2787
2786
|
DESC = "DESC"
|
2788
2787
|
}
|
2789
|
-
|
2788
|
+
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
2790
2789
|
/** Paging options to limit and skip the number of items. */
|
2791
2790
|
paging?: Paging;
|
2792
2791
|
/** 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`. */
|
@@ -2808,13 +2807,13 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
2808
2807
|
sort?: Sorting[];
|
2809
2808
|
}
|
2810
2809
|
/** @oneof */
|
2811
|
-
|
2810
|
+
interface PlatformQueryPagingMethodOneOf {
|
2812
2811
|
/** Paging options to limit and skip the number of items. */
|
2813
2812
|
paging?: Paging;
|
2814
2813
|
/** 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`. */
|
2815
2814
|
cursorPaging?: CursorPaging;
|
2816
2815
|
}
|
2817
|
-
|
2816
|
+
interface Paging {
|
2818
2817
|
/**
|
2819
2818
|
* Number of items to load.
|
2820
2819
|
* @max 100
|
@@ -2823,7 +2822,7 @@ export interface Paging {
|
|
2823
2822
|
/** Number of items to skip in the current sort order. */
|
2824
2823
|
offset?: number | null;
|
2825
2824
|
}
|
2826
|
-
|
2825
|
+
interface CursorPaging {
|
2827
2826
|
/**
|
2828
2827
|
* Number of items to load.
|
2829
2828
|
* @max 100
|
@@ -2839,13 +2838,13 @@ export interface CursorPaging {
|
|
2839
2838
|
*/
|
2840
2839
|
cursor?: string | null;
|
2841
2840
|
}
|
2842
|
-
|
2841
|
+
interface QueryPostsResponse {
|
2843
2842
|
/** List of retrieved posts. */
|
2844
2843
|
posts?: Post[];
|
2845
2844
|
/** Details on the paged set of results returned. */
|
2846
2845
|
pagingMetadata?: PagingMetadataV2;
|
2847
2846
|
}
|
2848
|
-
|
2847
|
+
interface PagingMetadataV2 {
|
2849
2848
|
/** Number of items returned in the response. */
|
2850
2849
|
count?: number | null;
|
2851
2850
|
/** Offset that was requested. */
|
@@ -2857,7 +2856,7 @@ export interface PagingMetadataV2 {
|
|
2857
2856
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
2858
2857
|
cursors?: Cursors;
|
2859
2858
|
}
|
2860
|
-
|
2859
|
+
interface Cursors {
|
2861
2860
|
/**
|
2862
2861
|
* Cursor pointing to next page in the list of results.
|
2863
2862
|
* @maxLength 2000
|
@@ -2869,7 +2868,7 @@ export interface Cursors {
|
|
2869
2868
|
*/
|
2870
2869
|
prev?: string | null;
|
2871
2870
|
}
|
2872
|
-
|
2871
|
+
interface GetPostMetricsRequest {
|
2873
2872
|
/**
|
2874
2873
|
* Post ID to retrieve metrics for.
|
2875
2874
|
* @minLength 1
|
@@ -2877,11 +2876,11 @@ export interface GetPostMetricsRequest {
|
|
2877
2876
|
*/
|
2878
2877
|
postId: string;
|
2879
2878
|
}
|
2880
|
-
|
2879
|
+
interface GetPostMetricsResponse {
|
2881
2880
|
/** Retrieved post metrics. */
|
2882
2881
|
metrics?: Metrics;
|
2883
2882
|
}
|
2884
|
-
|
2883
|
+
interface BulkGetPostMetricsRequest {
|
2885
2884
|
/**
|
2886
2885
|
* Post IDs.
|
2887
2886
|
* @maxSize 500
|
@@ -2889,11 +2888,11 @@ export interface BulkGetPostMetricsRequest {
|
|
2889
2888
|
*/
|
2890
2889
|
postIds?: string[];
|
2891
2890
|
}
|
2892
|
-
|
2891
|
+
interface BulkGetPostMetricsResponse {
|
2893
2892
|
/** Map of post.id to metrics */
|
2894
2893
|
metrics?: Record<string, Metrics>;
|
2895
2894
|
}
|
2896
|
-
|
2895
|
+
interface ViewPostRequest {
|
2897
2896
|
/**
|
2898
2897
|
* Post ID.
|
2899
2898
|
* @minLength 1
|
@@ -2901,11 +2900,11 @@ export interface ViewPostRequest {
|
|
2901
2900
|
*/
|
2902
2901
|
postId?: string;
|
2903
2902
|
}
|
2904
|
-
|
2903
|
+
interface ViewPostResponse {
|
2905
2904
|
/** Total number of post views */
|
2906
2905
|
views?: number;
|
2907
2906
|
}
|
2908
|
-
|
2907
|
+
interface LikePostRequest {
|
2909
2908
|
/**
|
2910
2909
|
* Post ID.
|
2911
2910
|
* @minLength 1
|
@@ -2920,11 +2919,11 @@ export interface LikePostRequest {
|
|
2920
2919
|
*/
|
2921
2920
|
fieldsets?: PostFieldField[];
|
2922
2921
|
}
|
2923
|
-
|
2922
|
+
interface LikePostResponse {
|
2924
2923
|
/** Post info. */
|
2925
2924
|
post?: Post;
|
2926
2925
|
}
|
2927
|
-
|
2926
|
+
interface UnlikePostRequest {
|
2928
2927
|
/**
|
2929
2928
|
* Post ID.
|
2930
2929
|
* @minLength 1
|
@@ -2939,11 +2938,11 @@ export interface UnlikePostRequest {
|
|
2939
2938
|
*/
|
2940
2939
|
fieldsets?: PostFieldField[];
|
2941
2940
|
}
|
2942
|
-
|
2941
|
+
interface UnlikePostResponse {
|
2943
2942
|
/** Post info. */
|
2944
2943
|
post?: Post;
|
2945
2944
|
}
|
2946
|
-
|
2945
|
+
interface PinPostRequest {
|
2947
2946
|
/**
|
2948
2947
|
* Post ID.
|
2949
2948
|
* @minLength 1
|
@@ -2958,11 +2957,11 @@ export interface PinPostRequest {
|
|
2958
2957
|
*/
|
2959
2958
|
fieldsets?: PostFieldField[];
|
2960
2959
|
}
|
2961
|
-
|
2960
|
+
interface PinPostResponse {
|
2962
2961
|
/** Post info. */
|
2963
2962
|
post?: Post;
|
2964
2963
|
}
|
2965
|
-
|
2964
|
+
interface UnpinPostRequest {
|
2966
2965
|
/**
|
2967
2966
|
* Post ID.
|
2968
2967
|
* @minLength 1
|
@@ -2977,11 +2976,11 @@ export interface UnpinPostRequest {
|
|
2977
2976
|
*/
|
2978
2977
|
fieldsets?: PostFieldField[];
|
2979
2978
|
}
|
2980
|
-
|
2979
|
+
interface UnpinPostResponse {
|
2981
2980
|
/** Post info. */
|
2982
2981
|
post?: Post;
|
2983
2982
|
}
|
2984
|
-
|
2983
|
+
interface ListPostsArchiveRequest {
|
2985
2984
|
/**
|
2986
2985
|
* Month
|
2987
2986
|
* @min 1
|
@@ -3018,7 +3017,7 @@ export interface ListPostsArchiveRequest {
|
|
3018
3017
|
*/
|
3019
3018
|
fieldsets?: PostFieldField[];
|
3020
3019
|
}
|
3021
|
-
|
3020
|
+
interface ListPostsArchiveResponse {
|
3022
3021
|
/** List of posts. */
|
3023
3022
|
posts?: Post[];
|
3024
3023
|
/** Details on the paged set of results returned. */
|
@@ -3026,7 +3025,7 @@ export interface ListPostsArchiveResponse {
|
|
3026
3025
|
/** Details on the paged set of results returned. */
|
3027
3026
|
pagingMetadata?: PagingMetadataV2;
|
3028
3027
|
}
|
3029
|
-
|
3028
|
+
interface BulkGetPostReactionsRequest {
|
3030
3029
|
/**
|
3031
3030
|
* Post IDs.
|
3032
3031
|
* @maxSize 500
|
@@ -3034,18 +3033,18 @@ export interface BulkGetPostReactionsRequest {
|
|
3034
3033
|
*/
|
3035
3034
|
postIds?: string[];
|
3036
3035
|
}
|
3037
|
-
|
3036
|
+
interface BulkGetPostReactionsResponse {
|
3038
3037
|
/** Map of post.id to reactions */
|
3039
3038
|
reactionsMap?: Record<string, Reactions>;
|
3040
3039
|
}
|
3041
|
-
|
3040
|
+
interface Reactions {
|
3042
3041
|
/**
|
3043
3042
|
* Is post liked by the current user
|
3044
3043
|
* @readonly
|
3045
3044
|
*/
|
3046
3045
|
liked?: boolean;
|
3047
3046
|
}
|
3048
|
-
|
3047
|
+
interface ListDemoPostsRequest {
|
3049
3048
|
/**
|
3050
3049
|
* Whether to return only featured posts.
|
3051
3050
|
*
|
@@ -3132,35 +3131,35 @@ export interface ListDemoPostsRequest {
|
|
3132
3131
|
*/
|
3133
3132
|
fieldsets?: PostFieldField[];
|
3134
3133
|
}
|
3135
|
-
|
3134
|
+
interface ListDemoPostsResponse {
|
3136
3135
|
/** List of posts. */
|
3137
3136
|
posts?: Post[];
|
3138
3137
|
/** Details on the paged set of results returned. */
|
3139
3138
|
metaData?: MetaData;
|
3140
3139
|
}
|
3141
|
-
|
3140
|
+
interface ConvertDraftJsToRichContentRequest {
|
3142
3141
|
/** DraftJs content to convert to Rich content. */
|
3143
3142
|
content?: Record<string, any> | null;
|
3144
3143
|
}
|
3145
|
-
|
3144
|
+
interface ConvertDraftJsToRichContentResponse {
|
3146
3145
|
/**
|
3147
3146
|
* Rich content converted from DraftJs content.
|
3148
3147
|
* @maxLength 2000000
|
3149
3148
|
*/
|
3150
3149
|
richContent?: string;
|
3151
3150
|
}
|
3152
|
-
|
3151
|
+
interface ConvertRichContentToDraftJsRequest {
|
3153
3152
|
/**
|
3154
3153
|
* Rich content to convert to DraftJs content.
|
3155
3154
|
* @maxLength 2000000
|
3156
3155
|
*/
|
3157
3156
|
richContent?: string;
|
3158
3157
|
}
|
3159
|
-
|
3158
|
+
interface ConvertRichContentToDraftJsResponse {
|
3160
3159
|
/** DraftJs content converted from Rich content. */
|
3161
3160
|
content?: Record<string, any> | null;
|
3162
3161
|
}
|
3163
|
-
|
3162
|
+
interface OldBlogMigratedEvent {
|
3164
3163
|
/**
|
3165
3164
|
* Instance id of new version of blog
|
3166
3165
|
* @format GUID
|
@@ -3172,7 +3171,7 @@ export interface OldBlogMigratedEvent {
|
|
3172
3171
|
*/
|
3173
3172
|
oldBlogInstanceId?: string;
|
3174
3173
|
}
|
3175
|
-
|
3174
|
+
interface BaseEventMetadata {
|
3176
3175
|
/**
|
3177
3176
|
* App instance ID.
|
3178
3177
|
* @format GUID
|
@@ -3186,7 +3185,7 @@ export interface BaseEventMetadata {
|
|
3186
3185
|
/** The identification type and identity data. */
|
3187
3186
|
identity?: IdentificationData;
|
3188
3187
|
}
|
3189
|
-
|
3188
|
+
interface EventMetadata extends BaseEventMetadata {
|
3190
3189
|
/**
|
3191
3190
|
* Unique event ID.
|
3192
3191
|
* Allows clients to ignore duplicate webhooks.
|
@@ -3224,127 +3223,27 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
3224
3223
|
*/
|
3225
3224
|
entityEventSequence?: string | null;
|
3226
3225
|
}
|
3227
|
-
|
3226
|
+
interface PostCreatedEnvelope {
|
3228
3227
|
entity: Post;
|
3229
3228
|
metadata: EventMetadata;
|
3230
3229
|
}
|
3231
|
-
|
3232
|
-
* Triggered when a post is created.
|
3233
|
-
* @permissionScope Read Blog
|
3234
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3235
|
-
* @permissionScope Manage Blog
|
3236
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3237
|
-
* @permissionScope Read Draft Blog Posts
|
3238
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3239
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3240
|
-
* @webhook
|
3241
|
-
* @eventType wix.blog.v3.post_created
|
3242
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3243
|
-
* @slug created
|
3244
|
-
*/
|
3245
|
-
export declare function onPostCreated(handler: (event: PostCreatedEnvelope) => void | Promise<void>): void;
|
3246
|
-
export interface PostDeletedEnvelope {
|
3230
|
+
interface PostDeletedEnvelope {
|
3247
3231
|
entity: Post;
|
3248
3232
|
metadata: EventMetadata;
|
3249
3233
|
}
|
3250
|
-
|
3251
|
-
* Triggered when a post is deleted.
|
3252
|
-
* @permissionScope Read Blog
|
3253
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3254
|
-
* @permissionScope Manage Blog
|
3255
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3256
|
-
* @permissionScope Read Draft Blog Posts
|
3257
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3258
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3259
|
-
* @webhook
|
3260
|
-
* @eventType wix.blog.v3.post_deleted
|
3261
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3262
|
-
* @slug deleted
|
3263
|
-
*/
|
3264
|
-
export declare function onPostDeleted(handler: (event: PostDeletedEnvelope) => void | Promise<void>): void;
|
3265
|
-
export interface PostLikedEnvelope {
|
3234
|
+
interface PostLikedEnvelope {
|
3266
3235
|
data: PostLiked;
|
3267
3236
|
metadata: EventMetadata;
|
3268
3237
|
}
|
3269
|
-
|
3270
|
-
* Triggered when a post is liked.
|
3271
|
-
* @permissionScope Read Blog
|
3272
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3273
|
-
* @permissionScope Manage Blog
|
3274
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3275
|
-
* @permissionScope Read Draft Blog Posts
|
3276
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3277
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3278
|
-
* @webhook
|
3279
|
-
* @eventType wix.blog.v3.post_liked
|
3280
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3281
|
-
* @slug liked
|
3282
|
-
*/
|
3283
|
-
export declare function onPostLiked(handler: (event: PostLikedEnvelope) => void | Promise<void>): void;
|
3284
|
-
export interface PostUnlikedEnvelope {
|
3238
|
+
interface PostUnlikedEnvelope {
|
3285
3239
|
data: PostUnliked;
|
3286
3240
|
metadata: EventMetadata;
|
3287
3241
|
}
|
3288
|
-
|
3289
|
-
* Triggered when a post is unliked.
|
3290
|
-
* @permissionScope Read Blog
|
3291
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3292
|
-
* @permissionScope Manage Blog
|
3293
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3294
|
-
* @permissionScope Read Draft Blog Posts
|
3295
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3296
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3297
|
-
* @webhook
|
3298
|
-
* @eventType wix.blog.v3.post_unliked
|
3299
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3300
|
-
* @slug unliked
|
3301
|
-
*/
|
3302
|
-
export declare function onPostUnliked(handler: (event: PostUnlikedEnvelope) => void | Promise<void>): void;
|
3303
|
-
export interface PostUpdatedEnvelope {
|
3242
|
+
interface PostUpdatedEnvelope {
|
3304
3243
|
entity: Post;
|
3305
3244
|
metadata: EventMetadata;
|
3306
3245
|
}
|
3307
|
-
|
3308
|
-
* Triggered when a post is updated.
|
3309
|
-
* @permissionScope Read Blog
|
3310
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3311
|
-
* @permissionScope Manage Blog
|
3312
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3313
|
-
* @permissionScope Read Draft Blog Posts
|
3314
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3315
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3316
|
-
* @webhook
|
3317
|
-
* @eventType wix.blog.v3.post_updated
|
3318
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3319
|
-
* @slug updated
|
3320
|
-
*/
|
3321
|
-
export declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | Promise<void>): void;
|
3322
|
-
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` | `richContent.nodes` | `richContent.nodes.${number}.buttonData.containerData.width.size` | `richContent.nodes.${number}.buttonData.containerData.alignment` | `richContent.nodes.${number}.buttonData.type` | `richContent.nodes.${number}.buttonData.link.url` | `richContent.nodes.${number}.buttonData.link.anchor` | `richContent.nodes.${number}.buttonData.link.target` | `richContent.nodes.${number}.codeBlockData.textStyle.textAlignment` | `richContent.nodes.${number}.dividerData.lineStyle` | `richContent.nodes.${number}.dividerData.width` | `richContent.nodes.${number}.dividerData.alignment` | `richContent.nodes.${number}.fileData.pdfSettings.viewMode` | `richContent.nodes.${number}.galleryData.items` | `richContent.nodes.${number}.galleryData.options.layout.type` | `richContent.nodes.${number}.galleryData.options.layout.orientation` | `richContent.nodes.${number}.galleryData.options.item.crop` | `richContent.nodes.${number}.galleryData.options.thumbnails.placement` | `richContent.nodes.${number}.gifData.height` | `richContent.nodes.${number}.gifData.width` | `richContent.nodes.${number}.gifData.gifType` | `richContent.nodes.${number}.headingData.level` | `richContent.nodes.${number}.htmlData.url` | `richContent.nodes.${number}.htmlData.html` | `richContent.nodes.${number}.htmlData.source` | `richContent.nodes.${number}.mapData.mapSettings.mapType` | `richContent.nodes.${number}.pollData.poll.options` | `richContent.nodes.${number}.pollData.poll.settings.permissions.view` | `richContent.nodes.${number}.pollData.poll.settings.permissions.vote` | `richContent.nodes.${number}.pollData.layout.poll.type` | `richContent.nodes.${number}.pollData.layout.poll.direction` | `richContent.nodes.${number}.pollData.design.poll.background.type` | `richContent.nodes.${number}.textData.text` | `richContent.nodes.${number}.textData.decorations` | `richContent.nodes.${number}.textData.decorations.${number}.anchorData.anchor` | `richContent.nodes.${number}.textData.decorations.${number}.mentionData.name` | `richContent.nodes.${number}.textData.decorations.${number}.mentionData.slug` | `richContent.nodes.${number}.textData.decorations.${number}.fontSizeData.unit` | `richContent.nodes.${number}.textData.decorations.${number}.type` | `richContent.nodes.${number}.appEmbedData.type` | `richContent.nodes.${number}.collapsibleListData.initialExpandedItems` | `richContent.nodes.${number}.collapsibleListData.direction` | `richContent.nodes.${number}.tableData.dimensions.colsWidthRatio` | `richContent.nodes.${number}.tableData.dimensions.rowsHeight` | `richContent.nodes.${number}.tableData.dimensions.colsMinWidth` | `richContent.nodes.${number}.tableCellData.cellStyle.verticalAlignment` | `richContent.nodes.${number}.orderedListData.indentation` | `richContent.nodes.${number}.bulletedListData.indentation` | `richContent.nodes.${number}.blockquoteData.indentation` | `richContent.nodes.${number}.type` | `richContent.nodes.${number}._id` | `richContent.nodes.${number}.nodes` | `richContent.metadata.version` | `richContent.documentStyle.headerOne.decorations` | `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`;
|
3323
|
-
/**
|
3324
|
-
* Retrieves the number of published posts per month within a specified time range.
|
3325
|
-
*
|
3326
|
-
* The time range is set using the `rangeStart` and `months` properties.
|
3327
|
-
* The time range always starts on the 1st day of the month set in `rangeStart` and
|
3328
|
-
* includes the number of `months` following `rangeStart`.
|
3329
|
-
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
3330
|
-
* the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range always ends on the last day of the month.
|
3331
|
-
* > Note: If there are no published posts in a month within the time range, 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.
|
3332
|
-
* @public
|
3333
|
-
* @documentationMaturity preview
|
3334
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3335
|
-
* @permissionScope Read Blog
|
3336
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3337
|
-
* @permissionScope Manage Blog
|
3338
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3339
|
-
* @permissionScope Read Draft Blog Posts
|
3340
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3341
|
-
* @applicableIdentity APP
|
3342
|
-
* @applicableIdentity VISITOR
|
3343
|
-
* @returns Get Blog Post Count Stats response
|
3344
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.QueryPostCountStats
|
3345
|
-
*/
|
3346
|
-
export declare function queryPostCountStats(options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`>>;
|
3347
|
-
export interface QueryPostCountStatsOptions {
|
3246
|
+
interface QueryPostCountStatsOptions {
|
3348
3247
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
3349
3248
|
rangeStart?: Date | null;
|
3350
3249
|
/**
|
@@ -3375,23 +3274,7 @@ export interface QueryPostCountStatsOptions {
|
|
3375
3274
|
*/
|
3376
3275
|
timeZone?: string | null;
|
3377
3276
|
}
|
3378
|
-
|
3379
|
-
* Retrieves the total amount of published posts of the blog.
|
3380
|
-
* @public
|
3381
|
-
* @documentationMaturity preview
|
3382
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3383
|
-
* @permissionScope Read Blog
|
3384
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3385
|
-
* @permissionScope Manage Blog
|
3386
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3387
|
-
* @permissionScope Read Draft Blog Posts
|
3388
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3389
|
-
* @applicableIdentity APP
|
3390
|
-
* @applicableIdentity VISITOR
|
3391
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
3392
|
-
*/
|
3393
|
-
export declare function getTotalPosts(options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`>>;
|
3394
|
-
export interface GetTotalPostsOptions {
|
3277
|
+
interface GetTotalPostsOptions {
|
3395
3278
|
/**
|
3396
3279
|
* Language filter.
|
3397
3280
|
*
|
@@ -3401,25 +3284,7 @@ export interface GetTotalPostsOptions {
|
|
3401
3284
|
*/
|
3402
3285
|
language?: string | null;
|
3403
3286
|
}
|
3404
|
-
|
3405
|
-
* Retrieves a post by the specified ID.
|
3406
|
-
* @param postId - Post ID.
|
3407
|
-
* @public
|
3408
|
-
* @requiredField postId
|
3409
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3410
|
-
* @permissionScope Read Blog
|
3411
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3412
|
-
* @permissionScope Manage Blog
|
3413
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3414
|
-
* @permissionScope Read Draft Blog Posts
|
3415
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3416
|
-
* @applicableIdentity APP
|
3417
|
-
* @applicableIdentity VISITOR
|
3418
|
-
* @returns Retrieved post info.
|
3419
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
3420
|
-
*/
|
3421
|
-
export declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<Post, PostNonNullablePaths>>;
|
3422
|
-
export interface GetPostOptions {
|
3287
|
+
interface GetPostOptions {
|
3423
3288
|
/**
|
3424
3289
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3425
3290
|
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
@@ -3428,31 +3293,7 @@ export interface GetPostOptions {
|
|
3428
3293
|
*/
|
3429
3294
|
fieldsets?: PostFieldField[];
|
3430
3295
|
}
|
3431
|
-
|
3432
|
-
* Retrieves a post with the provided slug.
|
3433
|
-
*
|
3434
|
-
* The slug is the end of a post's URL that refers to a specific post.
|
3435
|
-
* For example, if a post's URL is `https:/example.com/blog/post/my-post-slug`,
|
3436
|
-
* the slug is `my-post-slug`. The slug is case-sensitive, and is generally derived from the post title,
|
3437
|
-
* unless specified otherwise.
|
3438
|
-
* @param slug - Slug of the post to retrieve.
|
3439
|
-
* @public
|
3440
|
-
* @requiredField slug
|
3441
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3442
|
-
* @permissionScope Read Blog
|
3443
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3444
|
-
* @permissionScope Manage Blog
|
3445
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3446
|
-
* @permissionScope Read Draft Blog Posts
|
3447
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3448
|
-
* @applicableIdentity APP
|
3449
|
-
* @applicableIdentity VISITOR
|
3450
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
3451
|
-
*/
|
3452
|
-
export declare function getPostBySlug(slug: string, options?: GetPostBySlugOptions): Promise<NonNullablePaths<GetPostBySlugResponse, {
|
3453
|
-
[P in PostNonNullablePaths]: `post.${P}`;
|
3454
|
-
}[PostNonNullablePaths]>>;
|
3455
|
-
export interface GetPostBySlugOptions {
|
3296
|
+
interface GetPostBySlugOptions {
|
3456
3297
|
/**
|
3457
3298
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3458
3299
|
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
@@ -3461,29 +3302,7 @@ export interface GetPostBySlugOptions {
|
|
3461
3302
|
*/
|
3462
3303
|
fieldsets?: PostFieldField[];
|
3463
3304
|
}
|
3464
|
-
|
3465
|
-
* Retrieves a list of up to 100 published posts per request.
|
3466
|
-
*
|
3467
|
-
* List Posts runs with these defaults, which you can override:
|
3468
|
-
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
3469
|
-
* - `paging.limit` is `50`.
|
3470
|
-
* - `paging.offset` is `0`.
|
3471
|
-
* @public
|
3472
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3473
|
-
* @permissionScope Read Blog
|
3474
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3475
|
-
* @permissionScope Manage Blog
|
3476
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3477
|
-
* @permissionScope Read Draft Blog Posts
|
3478
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3479
|
-
* @applicableIdentity APP
|
3480
|
-
* @applicableIdentity VISITOR
|
3481
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
3482
|
-
*/
|
3483
|
-
export declare function listPosts(options?: ListPostsOptions): Promise<NonNullablePaths<ListPostsResponse, {
|
3484
|
-
[P in PostNonNullablePaths]: `posts.${number}.${P}`;
|
3485
|
-
}[PostNonNullablePaths] | `metaData.count` | `metaData.offset` | `metaData.total`>>;
|
3486
|
-
export interface ListPostsOptions {
|
3305
|
+
interface ListPostsOptions {
|
3487
3306
|
/**
|
3488
3307
|
* Whether to return only featured posts.
|
3489
3308
|
*
|
@@ -3547,37 +3366,7 @@ export interface ListPostsOptions {
|
|
3547
3366
|
*/
|
3548
3367
|
fieldsets?: PostFieldField[];
|
3549
3368
|
}
|
3550
|
-
|
3551
|
-
* Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
|
3552
|
-
*
|
3553
|
-
* Query Posts runs with these defaults, which you can override:
|
3554
|
-
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
3555
|
-
* - `paging.limit` is `50`.
|
3556
|
-
* - `paging.offset` is `0`.
|
3557
|
-
*
|
3558
|
-
* For field support for filters and sorting, see
|
3559
|
-
* [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
|
3560
|
-
*
|
3561
|
-
* To learn about working with _Query_ endpoints, see
|
3562
|
-
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
3563
|
-
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
|
3564
|
-
* [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
3565
|
-
* For a detailed list of supported filters and sortable fields, see
|
3566
|
-
* [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
|
3567
|
-
* @public
|
3568
|
-
* @permissionScope Read Blog
|
3569
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3570
|
-
* @permissionScope Manage Blog
|
3571
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3572
|
-
* @permissionScope Read Draft Blog Posts
|
3573
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3574
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3575
|
-
* @applicableIdentity APP
|
3576
|
-
* @applicableIdentity VISITOR
|
3577
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
3578
|
-
*/
|
3579
|
-
export declare function queryPosts(options?: QueryPostsOptions): PostsQueryBuilder;
|
3580
|
-
export interface QueryPostsOptions {
|
3369
|
+
interface QueryPostsOptions {
|
3581
3370
|
/**
|
3582
3371
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3583
3372
|
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
@@ -3593,13 +3382,13 @@ interface QueryCursorResult {
|
|
3593
3382
|
length: number;
|
3594
3383
|
pageSize: number;
|
3595
3384
|
}
|
3596
|
-
|
3385
|
+
interface PostsQueryResult extends QueryCursorResult {
|
3597
3386
|
items: Post[];
|
3598
3387
|
query: PostsQueryBuilder;
|
3599
3388
|
next: () => Promise<PostsQueryResult>;
|
3600
3389
|
prev: () => Promise<PostsQueryResult>;
|
3601
3390
|
}
|
3602
|
-
|
3391
|
+
interface PostsQueryBuilder {
|
3603
3392
|
/** @param propertyName - Property whose value is compared with `value`.
|
3604
3393
|
* @param value - Value to compare against.
|
3605
3394
|
*/
|
@@ -3648,23 +3437,5 @@ export interface PostsQueryBuilder {
|
|
3648
3437
|
skipTo: (cursor: string) => PostsQueryBuilder;
|
3649
3438
|
find: () => Promise<PostsQueryResult>;
|
3650
3439
|
}
|
3651
|
-
|
3652
|
-
|
3653
|
-
*
|
3654
|
-
* A post's metrics include the comments, likes, and views the post receives.
|
3655
|
-
* @param postId - Post ID to retrieve metrics for.
|
3656
|
-
* @public
|
3657
|
-
* @requiredField postId
|
3658
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3659
|
-
* @permissionScope Read Blog
|
3660
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3661
|
-
* @permissionScope Manage Blog
|
3662
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3663
|
-
* @permissionScope Read Draft Blog Posts
|
3664
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3665
|
-
* @applicableIdentity APP
|
3666
|
-
* @applicableIdentity VISITOR
|
3667
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostMetrics
|
3668
|
-
*/
|
3669
|
-
export declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`>>;
|
3670
|
-
export {};
|
3440
|
+
|
3441
|
+
export { SortOrder as $, Alignment as A, BackgroundType as B, Crop as C, DecorationType as D, ModerationStatusStatus as E, FontType as F, type GetTotalPostsOptions as G, QueryPublicationsCountStatsRequestOrder as H, InitialExpandedItems as I, Order as J, WebhookIdentityType as K, type ListPostsOptions as L, MapType as M, NodeType as N, Orientation as O, type PostsQueryBuilder as P, type QueryPostCountStatsOptions as Q, GetPostTemplatesSort as R, Source as S, Type as T, Origin as U, ViewMode as V, WidthType as W, Status as X, Field as Y, PostFieldField as Z, GetPostsSort as _, type QueryPostCountStatsResponse as a, type Background as a$, type Post as a0, type CoverMedia as a1, type CoverMediaMediaOneOf as a2, type FocalPoint as a3, type PostCountInfo as a4, type Metrics as a5, type SeoSchema as a6, type Keyword as a7, type Tag as a8, type Settings as a9, type Video as aA, type Item as aB, type ItemDataOneOf as aC, type GalleryOptions as aD, type Layout as aE, type ItemStyle as aF, type Thumbnails as aG, type GIFData as aH, type GIF as aI, type HeadingData as aJ, type HTMLData as aK, type HTMLDataDataOneOf as aL, type ImageData as aM, type StylesBorder as aN, type ImageDataStyles as aO, type LinkPreviewData as aP, type LinkPreviewDataStyles as aQ, type MapData as aR, type MapSettings as aS, type ParagraphData as aT, type PollData as aU, type Permissions as aV, type Option as aW, type PollSettings as aX, type PollLayout as aY, type OptionLayout as aZ, type Gradient as a_, type RichContent as aa, type Node as ab, type NodeDataOneOf as ac, type NodeStyle as ad, type ButtonData as ae, type Border as af, type Colors as ag, type PluginContainerData as ah, type PluginContainerDataWidth as ai, type PluginContainerDataWidthDataOneOf as aj, type Spoiler as ak, type Height as al, type Styles as am, type Link as an, type LinkDataOneOf as ao, type Rel as ap, type CodeBlockData as aq, type TextStyle as ar, type DividerData as as, type FileData as at, type FileSource as au, type FileSourceDataOneOf as av, type PDFSettings as aw, type GalleryData as ax, type V1Media as ay, type Image as az, type GetTotalPostsResponse as b, type EntityUpdatedEvent as b$, type BackgroundBackgroundOneOf as b0, type PollDesign as b1, type OptionDesign as b2, type Poll as b3, type PollDataLayout as b4, type Design as b5, type TextData as b6, type Decoration as b7, type DecorationDataOneOf as b8, type AnchorData as b9, type Metadata as bA, type DocumentStyle as bB, type TextNodeStyle as bC, type ModerationDetails as bD, type Media as bE, type MediaMediaOneOf as bF, type WixMedia as bG, type VideoResolution as bH, type EmbedMedia as bI, type EmbedThumbnail as bJ, type EmbedVideo as bK, type PostTranslation as bL, type PostCategoriesUpdated as bM, type PostTagsUpdated as bN, type ScheduledPostPublished as bO, type QueryPublicationsCountStatsRequest as bP, type QueryPublicationsCountStatsResponse as bQ, type PeriodPublicationsCount as bR, type QueryPostCountStatsRequest as bS, type PeriodPostCount as bT, type GetTotalPublicationsRequest as bU, type GetTotalPublicationsResponse as bV, type GetTotalPostsRequest as bW, type DomainEvent as bX, type DomainEventBodyOneOf as bY, type EntityCreatedEvent as bZ, type RestoreInfo as b_, type ColorData as ba, type LinkData as bb, type MentionData as bc, type FontSizeData as bd, type SpoilerData as be, type AppEmbedData as bf, type AppEmbedDataAppDataOneOf as bg, type BookingData as bh, type EventData as bi, type VideoData as bj, type PlaybackOptions as bk, type EmbedData as bl, type Oembed as bm, type CollapsibleListData as bn, type TableData as bo, type Dimensions as bp, type TableCellData as bq, type CellStyle as br, type BorderColors as bs, type ListValue as bt, type AudioData as bu, type OrderedListData as bv, type BulletedListData as bw, type BlockquoteData as bx, type CaptionData as by, type LayoutCellData as bz, type GetPostOptions as c, type OldBlogMigratedEvent as c$, type EntityDeletedEvent as c0, type ActionEvent as c1, type MessageEnvelope as c2, type IdentificationData as c3, type IdentificationDataIdOneOf as c4, type ListTemplatesRequest as c5, type BlogPaging as c6, type ListTemplatesResponse as c7, type MetaData as c8, type Category as c9, type QueryPostsResponse as cA, type PagingMetadataV2 as cB, type Cursors as cC, type GetPostMetricsRequest as cD, type BulkGetPostMetricsRequest as cE, type BulkGetPostMetricsResponse as cF, type ViewPostRequest as cG, type ViewPostResponse as cH, type LikePostRequest as cI, type LikePostResponse as cJ, type UnlikePostRequest as cK, type UnlikePostResponse as cL, type PinPostRequest as cM, type PinPostResponse as cN, type UnpinPostRequest as cO, type UnpinPostResponse as cP, type ListPostsArchiveRequest as cQ, type ListPostsArchiveResponse as cR, type BulkGetPostReactionsRequest as cS, type BulkGetPostReactionsResponse as cT, type Reactions as cU, type ListDemoPostsRequest as cV, type ListDemoPostsResponse as cW, type ConvertDraftJsToRichContentRequest as cX, type ConvertDraftJsToRichContentResponse as cY, type ConvertRichContentToDraftJsRequest as cZ, type ConvertRichContentToDraftJsResponse as c_, type CategoryTranslation as ca, type GetTemplateRequest as cb, type GetTemplateResponse as cc, type CreateDraftPostFromTemplateRequest as cd, type CreateDraftPostFromTemplateResponse as ce, type DraftPost as cf, type DraftPostTranslation as cg, type GetTotalLikesPerMemberRequest as ch, type GetTotalLikesPerMemberResponse as ci, type PostLiked as cj, type PostLikedInitiatorOneOf as ck, type PostUnliked as cl, type PostUnlikedInitiatorOneOf as cm, type PostCountersUpdated as cn, type PostCountersUpdatedInitiatorOneOf as co, type PostOwnerChanged as cp, type InitialPostsCopied as cq, type GetPostRequest as cr, type GetPostBySlugRequest as cs, type ListPostsRequest as ct, type QueryPostsRequest as cu, type Sorting as cv, type PlatformQuery as cw, type PlatformQueryPagingMethodOneOf as cx, type Paging as cy, type CursorPaging as cz, type GetPostResponse as d, type BaseEventMetadata as d0, type EventMetadata as d1, type PostCreatedEnvelope as d2, type PostDeletedEnvelope as d3, type PostLikedEnvelope as d4, type PostUnlikedEnvelope as d5, type PostUpdatedEnvelope as d6, type PostsQueryResult as d7, type GetPostBySlugOptions as e, type GetPostBySlugResponse as f, type ListPostsResponse as g, type QueryPostsOptions as h, type GetPostMetricsResponse as i, PluginContainerDataAlignment as j, Target as k, TextAlignment as l, LineStyle as m, Width as n, LayoutType as o, ThumbnailsAlignment as p, GIFType as q, Position as r, ViewRole as s, VoteRole as t, PollLayoutType as u, PollLayoutDirection as v, AppType as w, Direction as x, VerticalAlignment as y, NullValue as z };
|