@wix/auto_sdk_blog_posts 1.0.18 → 1.0.20
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/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
|
@@ -168,7 +167,7 @@ export interface Post {
|
|
168
167
|
*/
|
169
168
|
referenceId?: string | null;
|
170
169
|
}
|
171
|
-
|
170
|
+
interface CoverMedia extends CoverMediaMediaOneOf {
|
172
171
|
/** Image url. */
|
173
172
|
image?: string;
|
174
173
|
/** Video url. */
|
@@ -194,13 +193,13 @@ export interface CoverMedia extends CoverMediaMediaOneOf {
|
|
194
193
|
altText?: string | null;
|
195
194
|
}
|
196
195
|
/** @oneof */
|
197
|
-
|
196
|
+
interface CoverMediaMediaOneOf {
|
198
197
|
/** Image url. */
|
199
198
|
image?: string;
|
200
199
|
/** Video url. */
|
201
200
|
video?: string;
|
202
201
|
}
|
203
|
-
|
202
|
+
interface FocalPoint {
|
204
203
|
/** X-coordinate of the focal point. */
|
205
204
|
x?: number;
|
206
205
|
/** Y-coordinate of the focal point. */
|
@@ -210,7 +209,7 @@ export interface FocalPoint {
|
|
210
209
|
/** crop by width */
|
211
210
|
width?: number | null;
|
212
211
|
}
|
213
|
-
|
212
|
+
interface PostCountInfo {
|
214
213
|
/**
|
215
214
|
* Total number of post comments
|
216
215
|
* @readonly
|
@@ -227,7 +226,7 @@ export interface PostCountInfo {
|
|
227
226
|
*/
|
228
227
|
views?: number;
|
229
228
|
}
|
230
|
-
|
229
|
+
interface Metrics {
|
231
230
|
/**
|
232
231
|
* Total number of post comments.
|
233
232
|
* @readonly
|
@@ -249,13 +248,13 @@ export interface Metrics {
|
|
249
248
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
250
249
|
* 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.
|
251
250
|
*/
|
252
|
-
|
251
|
+
interface SeoSchema {
|
253
252
|
/** SEO tag information. */
|
254
253
|
tags?: Tag[];
|
255
254
|
/** SEO general settings. */
|
256
255
|
settings?: Settings;
|
257
256
|
}
|
258
|
-
|
257
|
+
interface Keyword {
|
259
258
|
/** Keyword value. */
|
260
259
|
term?: string;
|
261
260
|
/** Whether the keyword is the main focus keyword. */
|
@@ -266,7 +265,7 @@ export interface Keyword {
|
|
266
265
|
*/
|
267
266
|
origin?: string | null;
|
268
267
|
}
|
269
|
-
|
268
|
+
interface Tag {
|
270
269
|
/**
|
271
270
|
* SEO tag type.
|
272
271
|
*
|
@@ -288,7 +287,7 @@ export interface Tag {
|
|
288
287
|
/** Whether the tag is disabled. */
|
289
288
|
disabled?: boolean;
|
290
289
|
}
|
291
|
-
|
290
|
+
interface Settings {
|
292
291
|
/**
|
293
292
|
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
294
293
|
*
|
@@ -302,7 +301,7 @@ export interface Settings {
|
|
302
301
|
*/
|
303
302
|
keywords?: Keyword[];
|
304
303
|
}
|
305
|
-
|
304
|
+
interface RichContent {
|
306
305
|
/** Node objects representing a rich content document. */
|
307
306
|
nodes?: Node[];
|
308
307
|
/** Object metadata. */
|
@@ -310,7 +309,7 @@ export interface RichContent {
|
|
310
309
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
311
310
|
documentStyle?: DocumentStyle;
|
312
311
|
}
|
313
|
-
|
312
|
+
interface Node extends NodeDataOneOf {
|
314
313
|
/** Data for a button node. */
|
315
314
|
buttonData?: ButtonData;
|
316
315
|
/** Data for a code block node. */
|
@@ -375,7 +374,7 @@ export interface Node extends NodeDataOneOf {
|
|
375
374
|
style?: NodeStyle;
|
376
375
|
}
|
377
376
|
/** @oneof */
|
378
|
-
|
377
|
+
interface NodeDataOneOf {
|
379
378
|
/** Data for a button node. */
|
380
379
|
buttonData?: ButtonData;
|
381
380
|
/** Data for a code block node. */
|
@@ -431,7 +430,7 @@ export interface NodeDataOneOf {
|
|
431
430
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
432
431
|
layoutCellData?: LayoutCellData;
|
433
432
|
}
|
434
|
-
|
433
|
+
declare enum NodeType {
|
435
434
|
PARAGRAPH = "PARAGRAPH",
|
436
435
|
TEXT = "TEXT",
|
437
436
|
HEADING = "HEADING",
|
@@ -467,7 +466,7 @@ export declare enum NodeType {
|
|
467
466
|
LAYOUT = "LAYOUT",
|
468
467
|
LAYOUT_CELL = "LAYOUT_CELL"
|
469
468
|
}
|
470
|
-
|
469
|
+
interface NodeStyle {
|
471
470
|
/** The top padding value in pixels. */
|
472
471
|
paddingTop?: string | null;
|
473
472
|
/** The bottom padding value in pixels. */
|
@@ -475,7 +474,7 @@ export interface NodeStyle {
|
|
475
474
|
/** The background color as a hexadecimal value. */
|
476
475
|
backgroundColor?: string | null;
|
477
476
|
}
|
478
|
-
|
477
|
+
interface ButtonData {
|
479
478
|
/** Styling for the button's container. */
|
480
479
|
containerData?: PluginContainerData;
|
481
480
|
/** The button type. */
|
@@ -487,13 +486,13 @@ export interface ButtonData {
|
|
487
486
|
/** Button link details. */
|
488
487
|
link?: Link;
|
489
488
|
}
|
490
|
-
|
489
|
+
interface Border {
|
491
490
|
/** Border width in pixels. */
|
492
491
|
width?: number | null;
|
493
492
|
/** Border radius in pixels. */
|
494
493
|
radius?: number | null;
|
495
494
|
}
|
496
|
-
|
495
|
+
interface Colors {
|
497
496
|
/** The text color as a hexadecimal value. */
|
498
497
|
text?: string | null;
|
499
498
|
/** The border color as a hexadecimal value. */
|
@@ -501,7 +500,7 @@ export interface Colors {
|
|
501
500
|
/** The background color as a hexadecimal value. */
|
502
501
|
background?: string | null;
|
503
502
|
}
|
504
|
-
|
503
|
+
interface PluginContainerData {
|
505
504
|
/** The width of the node when it's displayed. */
|
506
505
|
width?: PluginContainerDataWidth;
|
507
506
|
/** The node's alignment within its container. */
|
@@ -513,7 +512,7 @@ export interface PluginContainerData {
|
|
513
512
|
/** 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`. */
|
514
513
|
textWrap?: boolean | null;
|
515
514
|
}
|
516
|
-
|
515
|
+
declare enum WidthType {
|
517
516
|
/** Width matches the content width */
|
518
517
|
CONTENT = "CONTENT",
|
519
518
|
/** Small Width */
|
@@ -523,7 +522,7 @@ export declare enum WidthType {
|
|
523
522
|
/** coast-to-coast display */
|
524
523
|
FULL_WIDTH = "FULL_WIDTH"
|
525
524
|
}
|
526
|
-
|
525
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
527
526
|
/**
|
528
527
|
* One of the following predefined width options:
|
529
528
|
* `CONTENT`: The width of the container matches the content width.
|
@@ -536,7 +535,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
536
535
|
custom?: string | null;
|
537
536
|
}
|
538
537
|
/** @oneof */
|
539
|
-
|
538
|
+
interface PluginContainerDataWidthDataOneOf {
|
540
539
|
/**
|
541
540
|
* One of the following predefined width options:
|
542
541
|
* `CONTENT`: The width of the container matches the content width.
|
@@ -548,7 +547,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
548
547
|
/** A custom width value in pixels. */
|
549
548
|
custom?: string | null;
|
550
549
|
}
|
551
|
-
|
550
|
+
declare enum PluginContainerDataAlignment {
|
552
551
|
/** Center Alignment */
|
553
552
|
CENTER = "CENTER",
|
554
553
|
/** Left Alignment */
|
@@ -556,7 +555,7 @@ export declare enum PluginContainerDataAlignment {
|
|
556
555
|
/** Right Alignment */
|
557
556
|
RIGHT = "RIGHT"
|
558
557
|
}
|
559
|
-
|
558
|
+
interface Spoiler {
|
560
559
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
561
560
|
enabled?: boolean | null;
|
562
561
|
/** The description displayed on top of the spoiler cover. */
|
@@ -564,23 +563,23 @@ export interface Spoiler {
|
|
564
563
|
/** The text for the button used to remove the spoiler cover. */
|
565
564
|
buttonText?: string | null;
|
566
565
|
}
|
567
|
-
|
566
|
+
interface Height {
|
568
567
|
/** A custom height value in pixels. */
|
569
568
|
custom?: string | null;
|
570
569
|
}
|
571
|
-
|
570
|
+
declare enum Type {
|
572
571
|
/** Regular link button */
|
573
572
|
LINK = "LINK",
|
574
573
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
575
574
|
ACTION = "ACTION"
|
576
575
|
}
|
577
|
-
|
576
|
+
interface Styles {
|
578
577
|
/** Border attributes. */
|
579
578
|
border?: Border;
|
580
579
|
/** Color attributes. */
|
581
580
|
colors?: Colors;
|
582
581
|
}
|
583
|
-
|
582
|
+
interface Link extends LinkDataOneOf {
|
584
583
|
/** The absolute URL for the linked document. */
|
585
584
|
url?: string;
|
586
585
|
/** The target node's ID. Used for linking to another node in this object. */
|
@@ -599,13 +598,13 @@ export interface Link extends LinkDataOneOf {
|
|
599
598
|
customData?: string | null;
|
600
599
|
}
|
601
600
|
/** @oneof */
|
602
|
-
|
601
|
+
interface LinkDataOneOf {
|
603
602
|
/** The absolute URL for the linked document. */
|
604
603
|
url?: string;
|
605
604
|
/** The target node's ID. Used for linking to another node in this object. */
|
606
605
|
anchor?: string;
|
607
606
|
}
|
608
|
-
|
607
|
+
declare enum Target {
|
609
608
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
610
609
|
SELF = "SELF",
|
611
610
|
/** Opens the linked document in a new window or tab */
|
@@ -615,7 +614,7 @@ export declare enum Target {
|
|
615
614
|
/** Opens the linked document in the full body of the window */
|
616
615
|
TOP = "TOP"
|
617
616
|
}
|
618
|
-
|
617
|
+
interface Rel {
|
619
618
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
620
619
|
nofollow?: boolean | null;
|
621
620
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
@@ -625,17 +624,17 @@ export interface Rel {
|
|
625
624
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
626
625
|
noreferrer?: boolean | null;
|
627
626
|
}
|
628
|
-
|
627
|
+
interface CodeBlockData {
|
629
628
|
/** Styling for the code block's text. */
|
630
629
|
textStyle?: TextStyle;
|
631
630
|
}
|
632
|
-
|
631
|
+
interface TextStyle {
|
633
632
|
/** Text alignment. Defaults to `AUTO`. */
|
634
633
|
textAlignment?: TextAlignment;
|
635
634
|
/** 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. */
|
636
635
|
lineHeight?: string | null;
|
637
636
|
}
|
638
|
-
|
637
|
+
declare enum TextAlignment {
|
639
638
|
/** browser default, eqivalent to `initial` */
|
640
639
|
AUTO = "AUTO",
|
641
640
|
/** Left align */
|
@@ -647,7 +646,7 @@ export declare enum TextAlignment {
|
|
647
646
|
/** 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 */
|
648
647
|
JUSTIFY = "JUSTIFY"
|
649
648
|
}
|
650
|
-
|
649
|
+
interface DividerData {
|
651
650
|
/** Styling for the divider's container. */
|
652
651
|
containerData?: PluginContainerData;
|
653
652
|
/** Divider line style. */
|
@@ -657,7 +656,7 @@ export interface DividerData {
|
|
657
656
|
/** Divider alignment. */
|
658
657
|
alignment?: Alignment;
|
659
658
|
}
|
660
|
-
|
659
|
+
declare enum LineStyle {
|
661
660
|
/** Single Line */
|
662
661
|
SINGLE = "SINGLE",
|
663
662
|
/** Double Line */
|
@@ -667,7 +666,7 @@ export declare enum LineStyle {
|
|
667
666
|
/** Dotted Line */
|
668
667
|
DOTTED = "DOTTED"
|
669
668
|
}
|
670
|
-
|
669
|
+
declare enum Width {
|
671
670
|
/** Large line */
|
672
671
|
LARGE = "LARGE",
|
673
672
|
/** Medium line */
|
@@ -675,7 +674,7 @@ export declare enum Width {
|
|
675
674
|
/** Small line */
|
676
675
|
SMALL = "SMALL"
|
677
676
|
}
|
678
|
-
|
677
|
+
declare enum Alignment {
|
679
678
|
/** Center alignment */
|
680
679
|
CENTER = "CENTER",
|
681
680
|
/** Left alignment */
|
@@ -683,7 +682,7 @@ export declare enum Alignment {
|
|
683
682
|
/** Right alignment */
|
684
683
|
RIGHT = "RIGHT"
|
685
684
|
}
|
686
|
-
|
685
|
+
interface FileData {
|
687
686
|
/** Styling for the file's container. */
|
688
687
|
containerData?: PluginContainerData;
|
689
688
|
/** The source for the file's data. */
|
@@ -706,7 +705,7 @@ export interface FileData {
|
|
706
705
|
/** File size in KB. */
|
707
706
|
sizeInKb?: string | null;
|
708
707
|
}
|
709
|
-
|
708
|
+
declare enum ViewMode {
|
710
709
|
/** No PDF view */
|
711
710
|
NONE = "NONE",
|
712
711
|
/** Full PDF view */
|
@@ -714,7 +713,7 @@ export declare enum ViewMode {
|
|
714
713
|
/** Mini PDF view */
|
715
714
|
MINI = "MINI"
|
716
715
|
}
|
717
|
-
|
716
|
+
interface FileSource extends FileSourceDataOneOf {
|
718
717
|
/** The absolute URL for the file's source. */
|
719
718
|
url?: string | null;
|
720
719
|
/**
|
@@ -728,7 +727,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
728
727
|
private?: boolean | null;
|
729
728
|
}
|
730
729
|
/** @oneof */
|
731
|
-
|
730
|
+
interface FileSourceDataOneOf {
|
732
731
|
/** The absolute URL for the file's source. */
|
733
732
|
url?: string | null;
|
734
733
|
/**
|
@@ -739,7 +738,7 @@ export interface FileSourceDataOneOf {
|
|
739
738
|
/** An ID that's resolved to a URL by a resolver function. */
|
740
739
|
_id?: string | null;
|
741
740
|
}
|
742
|
-
|
741
|
+
interface PDFSettings {
|
743
742
|
/**
|
744
743
|
* PDF view mode. One of the following:
|
745
744
|
* `NONE` : The PDF isn't displayed.
|
@@ -752,7 +751,7 @@ export interface PDFSettings {
|
|
752
751
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
753
752
|
disablePrint?: boolean | null;
|
754
753
|
}
|
755
|
-
|
754
|
+
interface GalleryData {
|
756
755
|
/** Styling for the gallery's container. */
|
757
756
|
containerData?: PluginContainerData;
|
758
757
|
/** The items in the gallery. */
|
@@ -764,7 +763,7 @@ export interface GalleryData {
|
|
764
763
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
765
764
|
disableDownload?: boolean | null;
|
766
765
|
}
|
767
|
-
|
766
|
+
interface V1Media {
|
768
767
|
/** The source for the media's data. */
|
769
768
|
src?: FileSource;
|
770
769
|
/** Media width in pixels. */
|
@@ -774,19 +773,19 @@ export interface V1Media {
|
|
774
773
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
775
774
|
duration?: number | null;
|
776
775
|
}
|
777
|
-
|
776
|
+
interface Image {
|
778
777
|
/** Image file details. */
|
779
778
|
media?: V1Media;
|
780
779
|
/** Link details for images that are links. */
|
781
780
|
link?: Link;
|
782
781
|
}
|
783
|
-
|
782
|
+
interface Video {
|
784
783
|
/** Video file details. */
|
785
784
|
media?: V1Media;
|
786
785
|
/** Video thumbnail file details. */
|
787
786
|
thumbnail?: V1Media;
|
788
787
|
}
|
789
|
-
|
788
|
+
interface Item extends ItemDataOneOf {
|
790
789
|
/** An image item. */
|
791
790
|
image?: Image;
|
792
791
|
/** A video item. */
|
@@ -797,13 +796,13 @@ export interface Item extends ItemDataOneOf {
|
|
797
796
|
altText?: string | null;
|
798
797
|
}
|
799
798
|
/** @oneof */
|
800
|
-
|
799
|
+
interface ItemDataOneOf {
|
801
800
|
/** An image item. */
|
802
801
|
image?: Image;
|
803
802
|
/** A video item. */
|
804
803
|
video?: Video;
|
805
804
|
}
|
806
|
-
|
805
|
+
interface GalleryOptions {
|
807
806
|
/** Gallery layout. */
|
808
807
|
layout?: Layout;
|
809
808
|
/** Styling for gallery items. */
|
@@ -811,7 +810,7 @@ export interface GalleryOptions {
|
|
811
810
|
/** Styling for gallery thumbnail images. */
|
812
811
|
thumbnails?: Thumbnails;
|
813
812
|
}
|
814
|
-
|
813
|
+
declare enum LayoutType {
|
815
814
|
/** Collage type */
|
816
815
|
COLLAGE = "COLLAGE",
|
817
816
|
/** Masonry type */
|
@@ -833,19 +832,19 @@ export declare enum LayoutType {
|
|
833
832
|
/** Fullsize images type */
|
834
833
|
FULLSIZE = "FULLSIZE"
|
835
834
|
}
|
836
|
-
|
835
|
+
declare enum Orientation {
|
837
836
|
/** Rows Orientation */
|
838
837
|
ROWS = "ROWS",
|
839
838
|
/** Columns Orientation */
|
840
839
|
COLUMNS = "COLUMNS"
|
841
840
|
}
|
842
|
-
|
841
|
+
declare enum Crop {
|
843
842
|
/** Crop to fill */
|
844
843
|
FILL = "FILL",
|
845
844
|
/** Crop to fit */
|
846
845
|
FIT = "FIT"
|
847
846
|
}
|
848
|
-
|
847
|
+
declare enum ThumbnailsAlignment {
|
849
848
|
/** Top alignment */
|
850
849
|
TOP = "TOP",
|
851
850
|
/** Right alignment */
|
@@ -857,7 +856,7 @@ export declare enum ThumbnailsAlignment {
|
|
857
856
|
/** No thumbnail */
|
858
857
|
NONE = "NONE"
|
859
858
|
}
|
860
|
-
|
859
|
+
interface Layout {
|
861
860
|
/** Gallery layout type. */
|
862
861
|
type?: LayoutType;
|
863
862
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
@@ -869,7 +868,7 @@ export interface Layout {
|
|
869
868
|
/** The number of columns to display on mobile screens. */
|
870
869
|
mobileNumberOfColumns?: number | null;
|
871
870
|
}
|
872
|
-
|
871
|
+
interface ItemStyle {
|
873
872
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
874
873
|
targetSize?: number | null;
|
875
874
|
/** Item ratio */
|
@@ -879,13 +878,13 @@ export interface ItemStyle {
|
|
879
878
|
/** The spacing between items in pixels. */
|
880
879
|
spacing?: number | null;
|
881
880
|
}
|
882
|
-
|
881
|
+
interface Thumbnails {
|
883
882
|
/** Thumbnail alignment. */
|
884
883
|
placement?: ThumbnailsAlignment;
|
885
884
|
/** Spacing between thumbnails in pixels. */
|
886
885
|
spacing?: number | null;
|
887
886
|
}
|
888
|
-
|
887
|
+
interface GIFData {
|
889
888
|
/** Styling for the GIF's container. */
|
890
889
|
containerData?: PluginContainerData;
|
891
890
|
/** The source of the full size GIF. */
|
@@ -899,7 +898,7 @@ export interface GIFData {
|
|
899
898
|
/** Type of GIF (Sticker or GIF). Defaults to `GIF`. */
|
900
899
|
gifType?: GIFType;
|
901
900
|
}
|
902
|
-
|
901
|
+
interface GIF {
|
903
902
|
/**
|
904
903
|
* GIF format URL.
|
905
904
|
* @format WEB_URL
|
@@ -916,11 +915,11 @@ export interface GIF {
|
|
916
915
|
*/
|
917
916
|
still?: string | null;
|
918
917
|
}
|
919
|
-
|
918
|
+
declare enum GIFType {
|
920
919
|
GIF = "GIF",
|
921
920
|
STICKER = "STICKER"
|
922
921
|
}
|
923
|
-
|
922
|
+
interface HeadingData {
|
924
923
|
/** Heading level from 1-6. */
|
925
924
|
level?: number;
|
926
925
|
/** Styling for the heading text. */
|
@@ -928,7 +927,7 @@ export interface HeadingData {
|
|
928
927
|
/** Indentation level from 1-4. */
|
929
928
|
indentation?: number | null;
|
930
929
|
}
|
931
|
-
|
930
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
932
931
|
/** The URL for the HTML code for the node. */
|
933
932
|
url?: string;
|
934
933
|
/** The HTML code for the node. */
|
@@ -946,7 +945,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
946
945
|
autoHeight?: boolean | null;
|
947
946
|
}
|
948
947
|
/** @oneof */
|
949
|
-
|
948
|
+
interface HTMLDataDataOneOf {
|
950
949
|
/** The URL for the HTML code for the node. */
|
951
950
|
url?: string;
|
952
951
|
/** The HTML code for the node. */
|
@@ -957,11 +956,11 @@ export interface HTMLDataDataOneOf {
|
|
957
956
|
*/
|
958
957
|
isAdsense?: boolean | null;
|
959
958
|
}
|
960
|
-
|
959
|
+
declare enum Source {
|
961
960
|
HTML = "HTML",
|
962
961
|
ADSENSE = "ADSENSE"
|
963
962
|
}
|
964
|
-
|
963
|
+
interface ImageData {
|
965
964
|
/** Styling for the image's container. */
|
966
965
|
containerData?: PluginContainerData;
|
967
966
|
/** Image file details. */
|
@@ -980,7 +979,7 @@ export interface ImageData {
|
|
980
979
|
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
981
980
|
disableDownload?: boolean | null;
|
982
981
|
}
|
983
|
-
|
982
|
+
interface StylesBorder {
|
984
983
|
/** Border width in pixels. */
|
985
984
|
width?: number | null;
|
986
985
|
/**
|
@@ -991,11 +990,11 @@ export interface StylesBorder {
|
|
991
990
|
/** Border radius in pixels. */
|
992
991
|
radius?: number | null;
|
993
992
|
}
|
994
|
-
|
993
|
+
interface ImageDataStyles {
|
995
994
|
/** Border attributes. */
|
996
995
|
border?: StylesBorder;
|
997
996
|
}
|
998
|
-
|
997
|
+
interface LinkPreviewData {
|
999
998
|
/** Styling for the link preview's container. */
|
1000
999
|
containerData?: PluginContainerData;
|
1001
1000
|
/** Link details. */
|
@@ -1009,7 +1008,7 @@ export interface LinkPreviewData {
|
|
1009
1008
|
/** The preview content as HTML. */
|
1010
1009
|
html?: string | null;
|
1011
1010
|
}
|
1012
|
-
|
1011
|
+
declare enum Position {
|
1013
1012
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
1014
1013
|
START = "START",
|
1015
1014
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
@@ -1019,7 +1018,7 @@ export declare enum Position {
|
|
1019
1018
|
/** Thumbnail hidden and not displayed */
|
1020
1019
|
HIDDEN = "HIDDEN"
|
1021
1020
|
}
|
1022
|
-
|
1021
|
+
interface LinkPreviewDataStyles {
|
1023
1022
|
/**
|
1024
1023
|
* Background color as a hexadecimal value.
|
1025
1024
|
* @format COLOR_HEX
|
@@ -1052,13 +1051,13 @@ export interface LinkPreviewDataStyles {
|
|
1052
1051
|
/** Position of thumbnail. Defaults to `START`. */
|
1053
1052
|
thumbnailPosition?: Position;
|
1054
1053
|
}
|
1055
|
-
|
1054
|
+
interface MapData {
|
1056
1055
|
/** Styling for the map's container. */
|
1057
1056
|
containerData?: PluginContainerData;
|
1058
1057
|
/** Map settings. */
|
1059
1058
|
mapSettings?: MapSettings;
|
1060
1059
|
}
|
1061
|
-
|
1060
|
+
interface MapSettings {
|
1062
1061
|
/** The address to display on the map. */
|
1063
1062
|
address?: string | null;
|
1064
1063
|
/** Sets whether the map is draggable. */
|
@@ -1082,7 +1081,7 @@ export interface MapSettings {
|
|
1082
1081
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
1083
1082
|
mapType?: MapType;
|
1084
1083
|
}
|
1085
|
-
|
1084
|
+
declare enum MapType {
|
1086
1085
|
/** Roadmap map type */
|
1087
1086
|
ROADMAP = "ROADMAP",
|
1088
1087
|
/** Satellite map type */
|
@@ -1092,7 +1091,7 @@ export declare enum MapType {
|
|
1092
1091
|
/** Terrain map type */
|
1093
1092
|
TERRAIN = "TERRAIN"
|
1094
1093
|
}
|
1095
|
-
|
1094
|
+
interface ParagraphData {
|
1096
1095
|
/** Styling for the paragraph text. */
|
1097
1096
|
textStyle?: TextStyle;
|
1098
1097
|
/** Indentation level from 1-4. */
|
@@ -1100,7 +1099,7 @@ export interface ParagraphData {
|
|
1100
1099
|
/** Paragraph level */
|
1101
1100
|
level?: number | null;
|
1102
1101
|
}
|
1103
|
-
|
1102
|
+
interface PollData {
|
1104
1103
|
/** Styling for the poll's container. */
|
1105
1104
|
containerData?: PluginContainerData;
|
1106
1105
|
/** Poll data. */
|
@@ -1110,7 +1109,7 @@ export interface PollData {
|
|
1110
1109
|
/** Styling for the poll and voting options. */
|
1111
1110
|
design?: Design;
|
1112
1111
|
}
|
1113
|
-
|
1112
|
+
declare enum ViewRole {
|
1114
1113
|
/** Only Poll creator can view the results */
|
1115
1114
|
CREATOR = "CREATOR",
|
1116
1115
|
/** Anyone who voted can see the results */
|
@@ -1118,13 +1117,13 @@ export declare enum ViewRole {
|
|
1118
1117
|
/** Anyone can see the results, even if one didn't vote */
|
1119
1118
|
EVERYONE = "EVERYONE"
|
1120
1119
|
}
|
1121
|
-
|
1120
|
+
declare enum VoteRole {
|
1122
1121
|
/** Logged in member */
|
1123
1122
|
SITE_MEMBERS = "SITE_MEMBERS",
|
1124
1123
|
/** Anyone */
|
1125
1124
|
ALL = "ALL"
|
1126
1125
|
}
|
1127
|
-
|
1126
|
+
interface Permissions {
|
1128
1127
|
/** Sets who can view the poll results. */
|
1129
1128
|
view?: ViewRole;
|
1130
1129
|
/** Sets who can vote. */
|
@@ -1132,7 +1131,7 @@ export interface Permissions {
|
|
1132
1131
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
1133
1132
|
allowMultipleVotes?: boolean | null;
|
1134
1133
|
}
|
1135
|
-
|
1134
|
+
interface Option {
|
1136
1135
|
/** Option ID. */
|
1137
1136
|
_id?: string | null;
|
1138
1137
|
/** Option title. */
|
@@ -1140,7 +1139,7 @@ export interface Option {
|
|
1140
1139
|
/** The image displayed with the option. */
|
1141
1140
|
image?: V1Media;
|
1142
1141
|
}
|
1143
|
-
|
1142
|
+
interface PollSettings {
|
1144
1143
|
/** Permissions settings for voting. */
|
1145
1144
|
permissions?: Permissions;
|
1146
1145
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
@@ -1148,19 +1147,19 @@ export interface PollSettings {
|
|
1148
1147
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
1149
1148
|
showVotesCount?: boolean | null;
|
1150
1149
|
}
|
1151
|
-
|
1150
|
+
declare enum PollLayoutType {
|
1152
1151
|
/** List */
|
1153
1152
|
LIST = "LIST",
|
1154
1153
|
/** Grid */
|
1155
1154
|
GRID = "GRID"
|
1156
1155
|
}
|
1157
|
-
|
1156
|
+
declare enum PollLayoutDirection {
|
1158
1157
|
/** Left-to-right */
|
1159
1158
|
LTR = "LTR",
|
1160
1159
|
/** Right-to-left */
|
1161
1160
|
RTL = "RTL"
|
1162
1161
|
}
|
1163
|
-
|
1162
|
+
interface PollLayout {
|
1164
1163
|
/** The layout for displaying the voting options. */
|
1165
1164
|
type?: PollLayoutType;
|
1166
1165
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
@@ -1168,11 +1167,11 @@ export interface PollLayout {
|
|
1168
1167
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
1169
1168
|
enableImage?: boolean | null;
|
1170
1169
|
}
|
1171
|
-
|
1170
|
+
interface OptionLayout {
|
1172
1171
|
/** Sets whether to display option images. Defaults to `false`. */
|
1173
1172
|
enableImage?: boolean | null;
|
1174
1173
|
}
|
1175
|
-
|
1174
|
+
declare enum BackgroundType {
|
1176
1175
|
/** Color background type */
|
1177
1176
|
COLOR = "COLOR",
|
1178
1177
|
/** Image background type */
|
@@ -1180,7 +1179,7 @@ export declare enum BackgroundType {
|
|
1180
1179
|
/** Gradiant background type */
|
1181
1180
|
GRADIENT = "GRADIENT"
|
1182
1181
|
}
|
1183
|
-
|
1182
|
+
interface Gradient {
|
1184
1183
|
/** The gradient angle in degrees. */
|
1185
1184
|
angle?: number | null;
|
1186
1185
|
/**
|
@@ -1194,7 +1193,7 @@ export interface Gradient {
|
|
1194
1193
|
*/
|
1195
1194
|
lastColor?: string | null;
|
1196
1195
|
}
|
1197
|
-
|
1196
|
+
interface Background extends BackgroundBackgroundOneOf {
|
1198
1197
|
/**
|
1199
1198
|
* The background color as a hexademical value.
|
1200
1199
|
* @format COLOR_HEX
|
@@ -1208,7 +1207,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
1208
1207
|
type?: BackgroundType;
|
1209
1208
|
}
|
1210
1209
|
/** @oneof */
|
1211
|
-
|
1210
|
+
interface BackgroundBackgroundOneOf {
|
1212
1211
|
/**
|
1213
1212
|
* The background color as a hexademical value.
|
1214
1213
|
* @format COLOR_HEX
|
@@ -1219,17 +1218,17 @@ export interface BackgroundBackgroundOneOf {
|
|
1219
1218
|
/** Details for a gradient background. */
|
1220
1219
|
gradient?: Gradient;
|
1221
1220
|
}
|
1222
|
-
|
1221
|
+
interface PollDesign {
|
1223
1222
|
/** Background styling. */
|
1224
1223
|
background?: Background;
|
1225
1224
|
/** Border radius in pixels. */
|
1226
1225
|
borderRadius?: number | null;
|
1227
1226
|
}
|
1228
|
-
|
1227
|
+
interface OptionDesign {
|
1229
1228
|
/** Border radius in pixels. */
|
1230
1229
|
borderRadius?: number | null;
|
1231
1230
|
}
|
1232
|
-
|
1231
|
+
interface Poll {
|
1233
1232
|
/** Poll ID. */
|
1234
1233
|
_id?: string | null;
|
1235
1234
|
/** Poll title. */
|
@@ -1243,26 +1242,26 @@ export interface Poll {
|
|
1243
1242
|
/** The poll's permissions and display settings. */
|
1244
1243
|
settings?: PollSettings;
|
1245
1244
|
}
|
1246
|
-
|
1245
|
+
interface PollDataLayout {
|
1247
1246
|
/** Poll layout settings. */
|
1248
1247
|
poll?: PollLayout;
|
1249
1248
|
/** Voting otpions layout settings. */
|
1250
1249
|
options?: OptionLayout;
|
1251
1250
|
}
|
1252
|
-
|
1251
|
+
interface Design {
|
1253
1252
|
/** Styling for the poll. */
|
1254
1253
|
poll?: PollDesign;
|
1255
1254
|
/** Styling for voting options. */
|
1256
1255
|
options?: OptionDesign;
|
1257
1256
|
}
|
1258
|
-
|
1257
|
+
interface TextData {
|
1259
1258
|
/** The text to apply decorations to. */
|
1260
1259
|
text?: string;
|
1261
1260
|
/** The decorations to apply. */
|
1262
1261
|
decorations?: Decoration[];
|
1263
1262
|
}
|
1264
1263
|
/** Adds appearence changes to text */
|
1265
|
-
|
1264
|
+
interface Decoration extends DecorationDataOneOf {
|
1266
1265
|
/** Data for an anchor link decoration. */
|
1267
1266
|
anchorData?: AnchorData;
|
1268
1267
|
/** Data for a color decoration. */
|
@@ -1285,7 +1284,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
1285
1284
|
type?: DecorationType;
|
1286
1285
|
}
|
1287
1286
|
/** @oneof */
|
1288
|
-
|
1287
|
+
interface DecorationDataOneOf {
|
1289
1288
|
/** Data for an anchor link decoration. */
|
1290
1289
|
anchorData?: AnchorData;
|
1291
1290
|
/** Data for a color decoration. */
|
@@ -1305,7 +1304,7 @@ export interface DecorationDataOneOf {
|
|
1305
1304
|
/** Data for a spoiler decoration. */
|
1306
1305
|
spoilerData?: SpoilerData;
|
1307
1306
|
}
|
1308
|
-
|
1307
|
+
declare enum DecorationType {
|
1309
1308
|
BOLD = "BOLD",
|
1310
1309
|
ITALIC = "ITALIC",
|
1311
1310
|
UNDERLINE = "UNDERLINE",
|
@@ -1317,21 +1316,21 @@ export declare enum DecorationType {
|
|
1317
1316
|
FONT_SIZE = "FONT_SIZE",
|
1318
1317
|
EXTERNAL = "EXTERNAL"
|
1319
1318
|
}
|
1320
|
-
|
1319
|
+
interface AnchorData {
|
1321
1320
|
/** The target node's ID. */
|
1322
1321
|
anchor?: string;
|
1323
1322
|
}
|
1324
|
-
|
1323
|
+
interface ColorData {
|
1325
1324
|
/** The text's background color as a hexadecimal value. */
|
1326
1325
|
background?: string | null;
|
1327
1326
|
/** The text's foreground color as a hexadecimal value. */
|
1328
1327
|
foreground?: string | null;
|
1329
1328
|
}
|
1330
|
-
|
1329
|
+
interface LinkData {
|
1331
1330
|
/** Link details. */
|
1332
1331
|
link?: Link;
|
1333
1332
|
}
|
1334
|
-
|
1333
|
+
interface MentionData {
|
1335
1334
|
/** The mentioned user's name. */
|
1336
1335
|
name?: string;
|
1337
1336
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
@@ -1339,21 +1338,21 @@ export interface MentionData {
|
|
1339
1338
|
/** Mentioned user's ID. */
|
1340
1339
|
_id?: string | null;
|
1341
1340
|
}
|
1342
|
-
|
1341
|
+
interface FontSizeData {
|
1343
1342
|
/** The units used for the font size. */
|
1344
1343
|
unit?: FontType;
|
1345
1344
|
/** Font size value. */
|
1346
1345
|
value?: number | null;
|
1347
1346
|
}
|
1348
|
-
|
1347
|
+
declare enum FontType {
|
1349
1348
|
PX = "PX",
|
1350
1349
|
EM = "EM"
|
1351
1350
|
}
|
1352
|
-
|
1351
|
+
interface SpoilerData {
|
1353
1352
|
/** Spoiler ID. */
|
1354
1353
|
_id?: string | null;
|
1355
1354
|
}
|
1356
|
-
|
1355
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
1357
1356
|
/** Data for embedded Wix Bookings content. */
|
1358
1357
|
bookingData?: BookingData;
|
1359
1358
|
/** Data for embedded Wix Events content. */
|
@@ -1375,28 +1374,28 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1375
1374
|
image?: V1Media;
|
1376
1375
|
}
|
1377
1376
|
/** @oneof */
|
1378
|
-
|
1377
|
+
interface AppEmbedDataAppDataOneOf {
|
1379
1378
|
/** Data for embedded Wix Bookings content. */
|
1380
1379
|
bookingData?: BookingData;
|
1381
1380
|
/** Data for embedded Wix Events content. */
|
1382
1381
|
eventData?: EventData;
|
1383
1382
|
}
|
1384
|
-
|
1383
|
+
declare enum AppType {
|
1385
1384
|
PRODUCT = "PRODUCT",
|
1386
1385
|
EVENT = "EVENT",
|
1387
1386
|
BOOKING = "BOOKING"
|
1388
1387
|
}
|
1389
|
-
|
1388
|
+
interface BookingData {
|
1390
1389
|
/** Booking duration in minutes. */
|
1391
1390
|
durations?: string | null;
|
1392
1391
|
}
|
1393
|
-
|
1392
|
+
interface EventData {
|
1394
1393
|
/** Event schedule. */
|
1395
1394
|
scheduling?: string | null;
|
1396
1395
|
/** Event location. */
|
1397
1396
|
location?: string | null;
|
1398
1397
|
}
|
1399
|
-
|
1398
|
+
interface VideoData {
|
1400
1399
|
/** Styling for the video's container. */
|
1401
1400
|
containerData?: PluginContainerData;
|
1402
1401
|
/** Video details. */
|
@@ -1410,7 +1409,7 @@ export interface VideoData {
|
|
1410
1409
|
/** Video options. */
|
1411
1410
|
options?: PlaybackOptions;
|
1412
1411
|
}
|
1413
|
-
|
1412
|
+
interface PlaybackOptions {
|
1414
1413
|
/** Sets whether the media will automatically start playing. */
|
1415
1414
|
autoPlay?: boolean | null;
|
1416
1415
|
/** Sets whether media's will be looped. */
|
@@ -1418,7 +1417,7 @@ export interface PlaybackOptions {
|
|
1418
1417
|
/** Sets whether media's controls will be shown. */
|
1419
1418
|
showControls?: boolean | null;
|
1420
1419
|
}
|
1421
|
-
|
1420
|
+
interface EmbedData {
|
1422
1421
|
/** Styling for the oEmbed node's container. */
|
1423
1422
|
containerData?: PluginContainerData;
|
1424
1423
|
/** An [oEmbed](https://www.oembed.com) object. */
|
@@ -1426,7 +1425,7 @@ export interface EmbedData {
|
|
1426
1425
|
/** Origin asset source. */
|
1427
1426
|
src?: string | null;
|
1428
1427
|
}
|
1429
|
-
|
1428
|
+
interface Oembed {
|
1430
1429
|
/** The resource type. */
|
1431
1430
|
type?: string | null;
|
1432
1431
|
/** The width of the resource specified in the `url` property in pixels. */
|
@@ -1458,7 +1457,7 @@ export interface Oembed {
|
|
1458
1457
|
/** The oEmbed version number. This value must be `1.0`. */
|
1459
1458
|
version?: string | null;
|
1460
1459
|
}
|
1461
|
-
|
1460
|
+
interface CollapsibleListData {
|
1462
1461
|
/** Styling for the collapsible list's container. */
|
1463
1462
|
containerData?: PluginContainerData;
|
1464
1463
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
@@ -1470,7 +1469,7 @@ export interface CollapsibleListData {
|
|
1470
1469
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
1471
1470
|
isQapageData?: boolean | null;
|
1472
1471
|
}
|
1473
|
-
|
1472
|
+
declare enum InitialExpandedItems {
|
1474
1473
|
/** First item will be expended initally */
|
1475
1474
|
FIRST = "FIRST",
|
1476
1475
|
/** All items will expended initally */
|
@@ -1478,13 +1477,13 @@ export declare enum InitialExpandedItems {
|
|
1478
1477
|
/** All items collapsed initally */
|
1479
1478
|
NONE = "NONE"
|
1480
1479
|
}
|
1481
|
-
|
1480
|
+
declare enum Direction {
|
1482
1481
|
/** Left-to-right */
|
1483
1482
|
LTR = "LTR",
|
1484
1483
|
/** Right-to-left */
|
1485
1484
|
RTL = "RTL"
|
1486
1485
|
}
|
1487
|
-
|
1486
|
+
interface TableData {
|
1488
1487
|
/** Styling for the table's container. */
|
1489
1488
|
containerData?: PluginContainerData;
|
1490
1489
|
/** The table's dimensions. */
|
@@ -1499,7 +1498,7 @@ export interface TableData {
|
|
1499
1498
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
1500
1499
|
columnHeader?: boolean | null;
|
1501
1500
|
}
|
1502
|
-
|
1501
|
+
interface Dimensions {
|
1503
1502
|
/** An array representing relative width of each column in relation to the other columns. */
|
1504
1503
|
colsWidthRatio?: number[];
|
1505
1504
|
/** An array representing the height of each row in pixels. */
|
@@ -1507,13 +1506,13 @@ export interface Dimensions {
|
|
1507
1506
|
/** An array representing the minimum width of each column in pixels. */
|
1508
1507
|
colsMinWidth?: number[];
|
1509
1508
|
}
|
1510
|
-
|
1509
|
+
interface TableCellData {
|
1511
1510
|
/** Styling for the cell's background color and text alignment. */
|
1512
1511
|
cellStyle?: CellStyle;
|
1513
1512
|
/** The cell's border colors. */
|
1514
1513
|
borderColors?: BorderColors;
|
1515
1514
|
}
|
1516
|
-
|
1515
|
+
declare enum VerticalAlignment {
|
1517
1516
|
/** Top alignment */
|
1518
1517
|
TOP = "TOP",
|
1519
1518
|
/** Middle alignment */
|
@@ -1521,7 +1520,7 @@ export declare enum VerticalAlignment {
|
|
1521
1520
|
/** Bottom alignment */
|
1522
1521
|
BOTTOM = "BOTTOM"
|
1523
1522
|
}
|
1524
|
-
|
1523
|
+
interface CellStyle {
|
1525
1524
|
/** Vertical alignment for the cell's text. */
|
1526
1525
|
verticalAlignment?: VerticalAlignment;
|
1527
1526
|
/**
|
@@ -1530,7 +1529,7 @@ export interface CellStyle {
|
|
1530
1529
|
*/
|
1531
1530
|
backgroundColor?: string | null;
|
1532
1531
|
}
|
1533
|
-
|
1532
|
+
interface BorderColors {
|
1534
1533
|
/**
|
1535
1534
|
* Left border color as a hexadecimal value.
|
1536
1535
|
* @format COLOR_HEX
|
@@ -1558,7 +1557,7 @@ export interface BorderColors {
|
|
1558
1557
|
*
|
1559
1558
|
* The JSON representation for `NullValue` is JSON `null`.
|
1560
1559
|
*/
|
1561
|
-
|
1560
|
+
declare enum NullValue {
|
1562
1561
|
/** Null value. */
|
1563
1562
|
NULL_VALUE = "NULL_VALUE"
|
1564
1563
|
}
|
@@ -1567,11 +1566,11 @@ export declare enum NullValue {
|
|
1567
1566
|
*
|
1568
1567
|
* The JSON representation for `ListValue` is JSON array.
|
1569
1568
|
*/
|
1570
|
-
|
1569
|
+
interface ListValue {
|
1571
1570
|
/** Repeated field of dynamically typed values. */
|
1572
1571
|
values?: any[];
|
1573
1572
|
}
|
1574
|
-
|
1573
|
+
interface AudioData {
|
1575
1574
|
/** Styling for the audio node's container. */
|
1576
1575
|
containerData?: PluginContainerData;
|
1577
1576
|
/** Audio file details. */
|
@@ -1587,7 +1586,7 @@ export interface AudioData {
|
|
1587
1586
|
/** An HTML version of the audio node. */
|
1588
1587
|
html?: string | null;
|
1589
1588
|
}
|
1590
|
-
|
1589
|
+
interface OrderedListData {
|
1591
1590
|
/** Indentation level from 0-4. */
|
1592
1591
|
indentation?: number;
|
1593
1592
|
/** Offset level from 0-4. */
|
@@ -1595,24 +1594,24 @@ export interface OrderedListData {
|
|
1595
1594
|
/** List start number. */
|
1596
1595
|
start?: number | null;
|
1597
1596
|
}
|
1598
|
-
|
1597
|
+
interface BulletedListData {
|
1599
1598
|
/** Indentation level from 0-4. */
|
1600
1599
|
indentation?: number;
|
1601
1600
|
/** Offset level from 0-4. */
|
1602
1601
|
offset?: number | null;
|
1603
1602
|
}
|
1604
|
-
|
1603
|
+
interface BlockquoteData {
|
1605
1604
|
/** Indentation level from 1-4. */
|
1606
1605
|
indentation?: number;
|
1607
1606
|
}
|
1608
|
-
|
1607
|
+
interface CaptionData {
|
1609
1608
|
textStyle?: TextStyle;
|
1610
1609
|
}
|
1611
|
-
|
1610
|
+
interface LayoutCellData {
|
1612
1611
|
/** Size of the cell in 12 columns grid. */
|
1613
1612
|
colSpan?: number | null;
|
1614
1613
|
}
|
1615
|
-
|
1614
|
+
interface Metadata {
|
1616
1615
|
/** Schema version. */
|
1617
1616
|
version?: number;
|
1618
1617
|
/**
|
@@ -1629,7 +1628,7 @@ export interface Metadata {
|
|
1629
1628
|
/** Object ID. */
|
1630
1629
|
_id?: string | null;
|
1631
1630
|
}
|
1632
|
-
|
1631
|
+
interface DocumentStyle {
|
1633
1632
|
/** Styling for H1 nodes. */
|
1634
1633
|
headerOne?: TextNodeStyle;
|
1635
1634
|
/** Styling for H2 nodes. */
|
@@ -1649,7 +1648,7 @@ export interface DocumentStyle {
|
|
1649
1648
|
/** Styling for code block nodes. */
|
1650
1649
|
codeBlock?: TextNodeStyle;
|
1651
1650
|
}
|
1652
|
-
|
1651
|
+
interface TextNodeStyle {
|
1653
1652
|
/** The decorations to apply to the node. */
|
1654
1653
|
decorations?: Decoration[];
|
1655
1654
|
/** Padding and background color for the node. */
|
@@ -1657,7 +1656,7 @@ export interface TextNodeStyle {
|
|
1657
1656
|
/** Line height for text in the node. */
|
1658
1657
|
lineHeight?: string | null;
|
1659
1658
|
}
|
1660
|
-
|
1659
|
+
interface ModerationDetails {
|
1661
1660
|
/**
|
1662
1661
|
* Member ID of the person submitting the draft post for review.
|
1663
1662
|
* @format GUID
|
@@ -1675,12 +1674,12 @@ export interface ModerationDetails {
|
|
1675
1674
|
/** Date the post was approved or rejected. */
|
1676
1675
|
moderationDate?: Date | null;
|
1677
1676
|
}
|
1678
|
-
|
1677
|
+
declare enum ModerationStatusStatus {
|
1679
1678
|
UNKNOWN = "UNKNOWN",
|
1680
1679
|
APPROVED = "APPROVED",
|
1681
1680
|
REJECTED = "REJECTED"
|
1682
1681
|
}
|
1683
|
-
|
1682
|
+
interface Media extends MediaMediaOneOf {
|
1684
1683
|
/** Wix Media details. */
|
1685
1684
|
wixMedia?: WixMedia;
|
1686
1685
|
/** Embed media details. */
|
@@ -1697,19 +1696,19 @@ export interface Media extends MediaMediaOneOf {
|
|
1697
1696
|
altText?: string | null;
|
1698
1697
|
}
|
1699
1698
|
/** @oneof */
|
1700
|
-
|
1699
|
+
interface MediaMediaOneOf {
|
1701
1700
|
/** Wix Media details. */
|
1702
1701
|
wixMedia?: WixMedia;
|
1703
1702
|
/** Embed media details. */
|
1704
1703
|
embedMedia?: EmbedMedia;
|
1705
1704
|
}
|
1706
|
-
|
1705
|
+
interface WixMedia {
|
1707
1706
|
/** Image details. */
|
1708
1707
|
image?: string;
|
1709
1708
|
/** Video details. */
|
1710
1709
|
videoV2?: string;
|
1711
1710
|
}
|
1712
|
-
|
1711
|
+
interface VideoResolution {
|
1713
1712
|
/** Video URL. */
|
1714
1713
|
url?: string;
|
1715
1714
|
/** Video height. */
|
@@ -1719,13 +1718,13 @@ export interface VideoResolution {
|
|
1719
1718
|
/** Video format for example, mp4, hls. */
|
1720
1719
|
format?: string;
|
1721
1720
|
}
|
1722
|
-
|
1721
|
+
interface EmbedMedia {
|
1723
1722
|
/** Thumbnail details. */
|
1724
1723
|
thumbnail?: EmbedThumbnail;
|
1725
1724
|
/** Video details. */
|
1726
1725
|
video?: EmbedVideo;
|
1727
1726
|
}
|
1728
|
-
|
1727
|
+
interface EmbedThumbnail {
|
1729
1728
|
/**
|
1730
1729
|
* Thumbnail url.
|
1731
1730
|
* @maxLength 2000
|
@@ -1736,7 +1735,7 @@ export interface EmbedThumbnail {
|
|
1736
1735
|
/** Thumbnail height. */
|
1737
1736
|
height?: number;
|
1738
1737
|
}
|
1739
|
-
|
1738
|
+
interface EmbedVideo {
|
1740
1739
|
/**
|
1741
1740
|
* Video url.
|
1742
1741
|
* @maxLength 2000
|
@@ -1747,7 +1746,7 @@ export interface EmbedVideo {
|
|
1747
1746
|
/** Video height. */
|
1748
1747
|
height?: number;
|
1749
1748
|
}
|
1750
|
-
|
1749
|
+
interface PostTranslation {
|
1751
1750
|
/**
|
1752
1751
|
* Post ID.
|
1753
1752
|
* @format GUID
|
@@ -1768,7 +1767,7 @@ export interface PostTranslation {
|
|
1768
1767
|
/** Post URL. */
|
1769
1768
|
url?: string;
|
1770
1769
|
}
|
1771
|
-
|
1770
|
+
interface PostCategoriesUpdated {
|
1772
1771
|
/**
|
1773
1772
|
* ID of the post which counters were updated.
|
1774
1773
|
* @format GUID
|
@@ -1787,7 +1786,7 @@ export interface PostCategoriesUpdated {
|
|
1787
1786
|
*/
|
1788
1787
|
previousCategories?: string[];
|
1789
1788
|
}
|
1790
|
-
|
1789
|
+
interface PostTagsUpdated {
|
1791
1790
|
/**
|
1792
1791
|
* ID of the post which counters were updated.
|
1793
1792
|
* @format GUID
|
@@ -1806,7 +1805,7 @@ export interface PostTagsUpdated {
|
|
1806
1805
|
*/
|
1807
1806
|
previousTags?: string[];
|
1808
1807
|
}
|
1809
|
-
|
1808
|
+
interface ScheduledPostPublished {
|
1810
1809
|
/**
|
1811
1810
|
* ID of the scheduled post which was published.
|
1812
1811
|
* @format GUID
|
@@ -1814,7 +1813,7 @@ export interface ScheduledPostPublished {
|
|
1814
1813
|
postId?: string;
|
1815
1814
|
}
|
1816
1815
|
/** Get Blog Publications Count Stats request */
|
1817
|
-
|
1816
|
+
interface QueryPublicationsCountStatsRequest {
|
1818
1817
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1819
1818
|
rangeStart?: Date | null;
|
1820
1819
|
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
@@ -1837,25 +1836,25 @@ export interface QueryPublicationsCountStatsRequest {
|
|
1837
1836
|
*/
|
1838
1837
|
timeZone?: string | null;
|
1839
1838
|
}
|
1840
|
-
|
1839
|
+
declare enum QueryPublicationsCountStatsRequestOrder {
|
1841
1840
|
UNKNOWN = "UNKNOWN",
|
1842
1841
|
OLDEST = "OLDEST",
|
1843
1842
|
NEWEST = "NEWEST"
|
1844
1843
|
}
|
1845
1844
|
/** Get Blog Publications Count Stats response */
|
1846
|
-
|
1845
|
+
interface QueryPublicationsCountStatsResponse {
|
1847
1846
|
/** Chronologically ordered list of publications. */
|
1848
1847
|
stats?: PeriodPublicationsCount[];
|
1849
1848
|
}
|
1850
1849
|
/** Publications count for a specific time period */
|
1851
|
-
|
1850
|
+
interface PeriodPublicationsCount {
|
1852
1851
|
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1853
1852
|
periodStart?: Date | null;
|
1854
1853
|
/** Number of posts published during this month. */
|
1855
1854
|
publicationsCount?: number;
|
1856
1855
|
}
|
1857
1856
|
/** Get Blog Post Count Stats request */
|
1858
|
-
|
1857
|
+
interface QueryPostCountStatsRequest {
|
1859
1858
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1860
1859
|
rangeStart?: Date | null;
|
1861
1860
|
/**
|
@@ -1886,24 +1885,24 @@ export interface QueryPostCountStatsRequest {
|
|
1886
1885
|
*/
|
1887
1886
|
timeZone?: string | null;
|
1888
1887
|
}
|
1889
|
-
|
1888
|
+
declare enum Order {
|
1890
1889
|
UNKNOWN = "UNKNOWN",
|
1891
1890
|
OLDEST = "OLDEST",
|
1892
1891
|
NEWEST = "NEWEST"
|
1893
1892
|
}
|
1894
1893
|
/** Get Blog Post Count Stats response */
|
1895
|
-
|
1894
|
+
interface QueryPostCountStatsResponse {
|
1896
1895
|
/** List of published post counts by month. */
|
1897
1896
|
stats?: PeriodPostCount[];
|
1898
1897
|
}
|
1899
1898
|
/** Post count for a specific time period */
|
1900
|
-
|
1899
|
+
interface PeriodPostCount {
|
1901
1900
|
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1902
1901
|
periodStart?: Date | null;
|
1903
1902
|
/** Number of posts published during this month. */
|
1904
1903
|
postCount?: number;
|
1905
1904
|
}
|
1906
|
-
|
1905
|
+
interface GetTotalPublicationsRequest {
|
1907
1906
|
/**
|
1908
1907
|
* Language filter
|
1909
1908
|
* @minLength 2
|
@@ -1911,11 +1910,11 @@ export interface GetTotalPublicationsRequest {
|
|
1911
1910
|
*/
|
1912
1911
|
language?: string | null;
|
1913
1912
|
}
|
1914
|
-
|
1913
|
+
interface GetTotalPublicationsResponse {
|
1915
1914
|
/** Total amount of publications. */
|
1916
1915
|
total?: number;
|
1917
1916
|
}
|
1918
|
-
|
1917
|
+
interface GetTotalPostsRequest {
|
1919
1918
|
/**
|
1920
1919
|
* Language filter.
|
1921
1920
|
*
|
@@ -1925,11 +1924,11 @@ export interface GetTotalPostsRequest {
|
|
1925
1924
|
*/
|
1926
1925
|
language?: string | null;
|
1927
1926
|
}
|
1928
|
-
|
1927
|
+
interface GetTotalPostsResponse {
|
1929
1928
|
/** Total amount of published posts. */
|
1930
1929
|
total?: number;
|
1931
1930
|
}
|
1932
|
-
|
1931
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
1933
1932
|
createdEvent?: EntityCreatedEvent;
|
1934
1933
|
updatedEvent?: EntityUpdatedEvent;
|
1935
1934
|
deletedEvent?: EntityDeletedEvent;
|
@@ -1972,19 +1971,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1972
1971
|
entityEventSequence?: string | null;
|
1973
1972
|
}
|
1974
1973
|
/** @oneof */
|
1975
|
-
|
1974
|
+
interface DomainEventBodyOneOf {
|
1976
1975
|
createdEvent?: EntityCreatedEvent;
|
1977
1976
|
updatedEvent?: EntityUpdatedEvent;
|
1978
1977
|
deletedEvent?: EntityDeletedEvent;
|
1979
1978
|
actionEvent?: ActionEvent;
|
1980
1979
|
}
|
1981
|
-
|
1980
|
+
interface EntityCreatedEvent {
|
1982
1981
|
entity?: string;
|
1983
1982
|
}
|
1984
|
-
|
1983
|
+
interface RestoreInfo {
|
1985
1984
|
deletedDate?: Date | null;
|
1986
1985
|
}
|
1987
|
-
|
1986
|
+
interface EntityUpdatedEvent {
|
1988
1987
|
/**
|
1989
1988
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
1990
1989
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
@@ -1992,14 +1991,14 @@ export interface EntityUpdatedEvent {
|
|
1992
1991
|
*/
|
1993
1992
|
currentEntity?: string;
|
1994
1993
|
}
|
1995
|
-
|
1994
|
+
interface EntityDeletedEvent {
|
1996
1995
|
/** Entity that was deleted */
|
1997
1996
|
deletedEntity?: string | null;
|
1998
1997
|
}
|
1999
|
-
|
1998
|
+
interface ActionEvent {
|
2000
1999
|
body?: string;
|
2001
2000
|
}
|
2002
|
-
|
2001
|
+
interface MessageEnvelope {
|
2003
2002
|
/**
|
2004
2003
|
* App instance ID.
|
2005
2004
|
* @format GUID
|
@@ -2015,7 +2014,7 @@ export interface MessageEnvelope {
|
|
2015
2014
|
/** Stringify payload. */
|
2016
2015
|
data?: string;
|
2017
2016
|
}
|
2018
|
-
|
2017
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
2019
2018
|
/**
|
2020
2019
|
* ID of a site visitor that has not logged in to the site.
|
2021
2020
|
* @format GUID
|
@@ -2040,7 +2039,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2040
2039
|
identityType?: WebhookIdentityType;
|
2041
2040
|
}
|
2042
2041
|
/** @oneof */
|
2043
|
-
|
2042
|
+
interface IdentificationDataIdOneOf {
|
2044
2043
|
/**
|
2045
2044
|
* ID of a site visitor that has not logged in to the site.
|
2046
2045
|
* @format GUID
|
@@ -2062,14 +2061,14 @@ export interface IdentificationDataIdOneOf {
|
|
2062
2061
|
*/
|
2063
2062
|
appId?: string;
|
2064
2063
|
}
|
2065
|
-
|
2064
|
+
declare enum WebhookIdentityType {
|
2066
2065
|
UNKNOWN = "UNKNOWN",
|
2067
2066
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
2068
2067
|
MEMBER = "MEMBER",
|
2069
2068
|
WIX_USER = "WIX_USER",
|
2070
2069
|
APP = "APP"
|
2071
2070
|
}
|
2072
|
-
|
2071
|
+
interface ListTemplatesRequest {
|
2073
2072
|
/**
|
2074
2073
|
* Filter post templates by given template category ids
|
2075
2074
|
* @maxSize 50
|
@@ -2088,13 +2087,13 @@ export interface ListTemplatesRequest {
|
|
2088
2087
|
/** Pagination options. */
|
2089
2088
|
paging?: BlogPaging;
|
2090
2089
|
}
|
2091
|
-
|
2090
|
+
declare enum GetPostTemplatesSort {
|
2092
2091
|
/** Sort by ascending publishing date. */
|
2093
2092
|
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
2094
2093
|
/** Sort by descending publishing date. */
|
2095
2094
|
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
2096
2095
|
}
|
2097
|
-
|
2096
|
+
interface BlogPaging {
|
2098
2097
|
/**
|
2099
2098
|
* Number of items to skip in the current sort order.
|
2100
2099
|
*
|
@@ -2117,7 +2116,7 @@ export interface BlogPaging {
|
|
2117
2116
|
*/
|
2118
2117
|
cursor?: string | null;
|
2119
2118
|
}
|
2120
|
-
|
2119
|
+
interface ListTemplatesResponse {
|
2121
2120
|
/** Available post templates */
|
2122
2121
|
postTemplates?: Post[];
|
2123
2122
|
/** Details on the paged set of posts templates returned. */
|
@@ -2125,7 +2124,7 @@ export interface ListTemplatesResponse {
|
|
2125
2124
|
/** Post template categories. This value is returned empty unless asked explicitly */
|
2126
2125
|
templateCategories?: Category[];
|
2127
2126
|
}
|
2128
|
-
|
2127
|
+
interface MetaData {
|
2129
2128
|
/** Number of items returned in this response. */
|
2130
2129
|
count?: number;
|
2131
2130
|
/** Requested offset. */
|
@@ -2138,7 +2137,7 @@ export interface MetaData {
|
|
2138
2137
|
*/
|
2139
2138
|
cursor?: string | null;
|
2140
2139
|
}
|
2141
|
-
|
2140
|
+
interface Category {
|
2142
2141
|
/**
|
2143
2142
|
* Category ID.
|
2144
2143
|
* @immutable
|
@@ -2206,7 +2205,7 @@ export interface Category {
|
|
2206
2205
|
*/
|
2207
2206
|
_updatedDate?: Date | null;
|
2208
2207
|
}
|
2209
|
-
|
2208
|
+
interface CategoryTranslation {
|
2210
2209
|
/**
|
2211
2210
|
* Category ID.
|
2212
2211
|
* @format GUID
|
@@ -2225,29 +2224,29 @@ export interface CategoryTranslation {
|
|
2225
2224
|
/** URL of this category page. */
|
2226
2225
|
url?: string;
|
2227
2226
|
}
|
2228
|
-
|
2227
|
+
interface GetTemplateRequest {
|
2229
2228
|
/**
|
2230
2229
|
* Post template id
|
2231
2230
|
* @format GUID
|
2232
2231
|
*/
|
2233
2232
|
postTemplateId?: string;
|
2234
2233
|
}
|
2235
|
-
|
2234
|
+
interface GetTemplateResponse {
|
2236
2235
|
/** Post template */
|
2237
2236
|
postTemplate?: Post;
|
2238
2237
|
}
|
2239
|
-
|
2238
|
+
interface CreateDraftPostFromTemplateRequest {
|
2240
2239
|
/**
|
2241
2240
|
* Post template id
|
2242
2241
|
* @format GUID
|
2243
2242
|
*/
|
2244
2243
|
postTemplateId?: string;
|
2245
2244
|
}
|
2246
|
-
|
2245
|
+
interface CreateDraftPostFromTemplateResponse {
|
2247
2246
|
/** Created draft post */
|
2248
2247
|
draftPost?: DraftPost;
|
2249
2248
|
}
|
2250
|
-
|
2249
|
+
interface DraftPost {
|
2251
2250
|
/**
|
2252
2251
|
* Draft post ID.
|
2253
2252
|
* @readonly
|
@@ -2382,7 +2381,7 @@ export interface DraftPost {
|
|
2382
2381
|
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
2383
2382
|
previewTextParagraph?: number | null;
|
2384
2383
|
}
|
2385
|
-
|
2384
|
+
declare enum Origin {
|
2386
2385
|
UNKNOWN = "UNKNOWN",
|
2387
2386
|
/** Changed by admin */
|
2388
2387
|
ADMIN = "ADMIN",
|
@@ -2455,7 +2454,7 @@ export declare enum Origin {
|
|
2455
2454
|
/** Saved automatically by AI tool. */
|
2456
2455
|
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
2457
2456
|
}
|
2458
|
-
|
2457
|
+
declare enum Status {
|
2459
2458
|
UNKNOWN = "UNKNOWN",
|
2460
2459
|
/** Status indicating the draft post is published. */
|
2461
2460
|
PUBLISHED = "PUBLISHED",
|
@@ -2468,7 +2467,7 @@ export declare enum Status {
|
|
2468
2467
|
/** Status indicating the draft post is in review. */
|
2469
2468
|
IN_REVIEW = "IN_REVIEW"
|
2470
2469
|
}
|
2471
|
-
|
2470
|
+
interface DraftPostTranslation {
|
2472
2471
|
/**
|
2473
2472
|
* Post ID.
|
2474
2473
|
* @format GUID
|
@@ -2491,18 +2490,18 @@ export interface DraftPostTranslation {
|
|
2491
2490
|
/** Post URL. */
|
2492
2491
|
url?: string;
|
2493
2492
|
}
|
2494
|
-
|
2493
|
+
interface GetTotalLikesPerMemberRequest {
|
2495
2494
|
/**
|
2496
2495
|
* Member ID.
|
2497
2496
|
* @format GUID
|
2498
2497
|
*/
|
2499
2498
|
memberId?: string;
|
2500
2499
|
}
|
2501
|
-
|
2500
|
+
interface GetTotalLikesPerMemberResponse {
|
2502
2501
|
/** The total number of likes of the member. */
|
2503
2502
|
total?: number;
|
2504
2503
|
}
|
2505
|
-
|
2504
|
+
interface PostLiked extends PostLikedInitiatorOneOf {
|
2506
2505
|
/**
|
2507
2506
|
* Member ID of person who liked the post (only returned when the member was logged in when liking the post).
|
2508
2507
|
* @format GUID
|
@@ -2520,7 +2519,7 @@ export interface PostLiked extends PostLikedInitiatorOneOf {
|
|
2520
2519
|
postId?: string;
|
2521
2520
|
}
|
2522
2521
|
/** @oneof */
|
2523
|
-
|
2522
|
+
interface PostLikedInitiatorOneOf {
|
2524
2523
|
/**
|
2525
2524
|
* Member ID of person who liked the post (only returned when the member was logged in when liking the post).
|
2526
2525
|
* @format GUID
|
@@ -2532,7 +2531,7 @@ export interface PostLikedInitiatorOneOf {
|
|
2532
2531
|
*/
|
2533
2532
|
anonymousVisitorId?: string | null;
|
2534
2533
|
}
|
2535
|
-
|
2534
|
+
interface PostUnliked extends PostUnlikedInitiatorOneOf {
|
2536
2535
|
/**
|
2537
2536
|
* Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
|
2538
2537
|
* @format GUID
|
@@ -2550,7 +2549,7 @@ export interface PostUnliked extends PostUnlikedInitiatorOneOf {
|
|
2550
2549
|
postId?: string;
|
2551
2550
|
}
|
2552
2551
|
/** @oneof */
|
2553
|
-
|
2552
|
+
interface PostUnlikedInitiatorOneOf {
|
2554
2553
|
/**
|
2555
2554
|
* Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
|
2556
2555
|
* @format GUID
|
@@ -2562,7 +2561,7 @@ export interface PostUnlikedInitiatorOneOf {
|
|
2562
2561
|
*/
|
2563
2562
|
anonymousVisitorId?: string | null;
|
2564
2563
|
}
|
2565
|
-
|
2564
|
+
interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
2566
2565
|
/**
|
2567
2566
|
* Member ID of person who triggered the counter update
|
2568
2567
|
* @format GUID
|
@@ -2584,7 +2583,7 @@ export interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
|
2584
2583
|
counter?: number;
|
2585
2584
|
}
|
2586
2585
|
/** @oneof */
|
2587
|
-
|
2586
|
+
interface PostCountersUpdatedInitiatorOneOf {
|
2588
2587
|
/**
|
2589
2588
|
* Member ID of person who triggered the counter update
|
2590
2589
|
* @format GUID
|
@@ -2596,7 +2595,7 @@ export interface PostCountersUpdatedInitiatorOneOf {
|
|
2596
2595
|
*/
|
2597
2596
|
anonymousVisitorId?: string | null;
|
2598
2597
|
}
|
2599
|
-
|
2598
|
+
declare enum Field {
|
2600
2599
|
/** Undefined field. */
|
2601
2600
|
UNKNOWN = "UNKNOWN",
|
2602
2601
|
/** Total comments field. */
|
@@ -2608,13 +2607,13 @@ export declare enum Field {
|
|
2608
2607
|
/** Rating count field. */
|
2609
2608
|
RATING_COUNT = "RATING_COUNT"
|
2610
2609
|
}
|
2611
|
-
|
2610
|
+
interface PostOwnerChanged {
|
2612
2611
|
}
|
2613
|
-
|
2612
|
+
interface InitialPostsCopied {
|
2614
2613
|
/** Number of posts copied. */
|
2615
2614
|
count?: number;
|
2616
2615
|
}
|
2617
|
-
|
2616
|
+
interface GetPostRequest {
|
2618
2617
|
/**
|
2619
2618
|
* Post ID.
|
2620
2619
|
* @minLength 1
|
@@ -2629,7 +2628,7 @@ export interface GetPostRequest {
|
|
2629
2628
|
*/
|
2630
2629
|
fieldsets?: PostFieldField[];
|
2631
2630
|
}
|
2632
|
-
|
2631
|
+
declare enum PostFieldField {
|
2633
2632
|
UNKNOWN = "UNKNOWN",
|
2634
2633
|
/** Includes post URL when present. */
|
2635
2634
|
URL = "URL",
|
@@ -2646,11 +2645,11 @@ export declare enum PostFieldField {
|
|
2646
2645
|
/** Includes post reference ID field. */
|
2647
2646
|
REFERENCE_ID = "REFERENCE_ID"
|
2648
2647
|
}
|
2649
|
-
|
2648
|
+
interface GetPostResponse {
|
2650
2649
|
/** Retrieved post info. */
|
2651
2650
|
post?: Post;
|
2652
2651
|
}
|
2653
|
-
|
2652
|
+
interface GetPostBySlugRequest {
|
2654
2653
|
/**
|
2655
2654
|
* Slug of the post to retrieve.
|
2656
2655
|
* @minLength 1
|
@@ -2665,11 +2664,11 @@ export interface GetPostBySlugRequest {
|
|
2665
2664
|
*/
|
2666
2665
|
fieldsets?: PostFieldField[];
|
2667
2666
|
}
|
2668
|
-
|
2667
|
+
interface GetPostBySlugResponse {
|
2669
2668
|
/** Retrieved post info. */
|
2670
2669
|
post?: Post;
|
2671
2670
|
}
|
2672
|
-
|
2671
|
+
interface ListPostsRequest {
|
2673
2672
|
/**
|
2674
2673
|
* Whether to return only featured posts.
|
2675
2674
|
*
|
@@ -2733,7 +2732,7 @@ export interface ListPostsRequest {
|
|
2733
2732
|
*/
|
2734
2733
|
fieldsets?: PostFieldField[];
|
2735
2734
|
}
|
2736
|
-
|
2735
|
+
declare enum GetPostsSort {
|
2737
2736
|
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
2738
2737
|
FEED = "FEED",
|
2739
2738
|
/** Ordered by `firstPublishedDate` in ascending order. */
|
@@ -2749,13 +2748,13 @@ export declare enum GetPostsSort {
|
|
2749
2748
|
/** Ordered by `title` in descending order. */
|
2750
2749
|
TITLE_DESC = "TITLE_DESC"
|
2751
2750
|
}
|
2752
|
-
|
2751
|
+
interface ListPostsResponse {
|
2753
2752
|
/** List of retrieved posts. */
|
2754
2753
|
posts?: Post[];
|
2755
2754
|
/** Details on the paged set of results returned. */
|
2756
2755
|
metaData?: MetaData;
|
2757
2756
|
}
|
2758
|
-
|
2757
|
+
interface QueryPostsRequest {
|
2759
2758
|
/** Query options. */
|
2760
2759
|
query?: PlatformQuery;
|
2761
2760
|
/**
|
@@ -2766,7 +2765,7 @@ export interface QueryPostsRequest {
|
|
2766
2765
|
*/
|
2767
2766
|
fieldsets?: PostFieldField[];
|
2768
2767
|
}
|
2769
|
-
|
2768
|
+
interface Sorting {
|
2770
2769
|
/**
|
2771
2770
|
* Name of the field to sort by.
|
2772
2771
|
* @maxLength 512
|
@@ -2775,11 +2774,11 @@ export interface Sorting {
|
|
2775
2774
|
/** Sort order. */
|
2776
2775
|
order?: SortOrder;
|
2777
2776
|
}
|
2778
|
-
|
2777
|
+
declare enum SortOrder {
|
2779
2778
|
ASC = "ASC",
|
2780
2779
|
DESC = "DESC"
|
2781
2780
|
}
|
2782
|
-
|
2781
|
+
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
2783
2782
|
/** Paging options to limit and skip the number of items. */
|
2784
2783
|
paging?: Paging;
|
2785
2784
|
/** 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`. */
|
@@ -2801,13 +2800,13 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
2801
2800
|
sort?: Sorting[];
|
2802
2801
|
}
|
2803
2802
|
/** @oneof */
|
2804
|
-
|
2803
|
+
interface PlatformQueryPagingMethodOneOf {
|
2805
2804
|
/** Paging options to limit and skip the number of items. */
|
2806
2805
|
paging?: Paging;
|
2807
2806
|
/** 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
2807
|
cursorPaging?: CursorPaging;
|
2809
2808
|
}
|
2810
|
-
|
2809
|
+
interface Paging {
|
2811
2810
|
/**
|
2812
2811
|
* Number of items to load.
|
2813
2812
|
* @max 100
|
@@ -2816,7 +2815,7 @@ export interface Paging {
|
|
2816
2815
|
/** Number of items to skip in the current sort order. */
|
2817
2816
|
offset?: number | null;
|
2818
2817
|
}
|
2819
|
-
|
2818
|
+
interface CursorPaging {
|
2820
2819
|
/**
|
2821
2820
|
* Number of items to load.
|
2822
2821
|
* @max 100
|
@@ -2832,13 +2831,13 @@ export interface CursorPaging {
|
|
2832
2831
|
*/
|
2833
2832
|
cursor?: string | null;
|
2834
2833
|
}
|
2835
|
-
|
2834
|
+
interface QueryPostsResponse {
|
2836
2835
|
/** List of retrieved posts. */
|
2837
2836
|
posts?: Post[];
|
2838
2837
|
/** Details on the paged set of results returned. */
|
2839
2838
|
pagingMetadata?: PagingMetadataV2;
|
2840
2839
|
}
|
2841
|
-
|
2840
|
+
interface PagingMetadataV2 {
|
2842
2841
|
/** Number of items returned in the response. */
|
2843
2842
|
count?: number | null;
|
2844
2843
|
/** Offset that was requested. */
|
@@ -2850,7 +2849,7 @@ export interface PagingMetadataV2 {
|
|
2850
2849
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
2851
2850
|
cursors?: Cursors;
|
2852
2851
|
}
|
2853
|
-
|
2852
|
+
interface Cursors {
|
2854
2853
|
/**
|
2855
2854
|
* Cursor pointing to next page in the list of results.
|
2856
2855
|
* @maxLength 2000
|
@@ -2862,7 +2861,7 @@ export interface Cursors {
|
|
2862
2861
|
*/
|
2863
2862
|
prev?: string | null;
|
2864
2863
|
}
|
2865
|
-
|
2864
|
+
interface GetPostMetricsRequest {
|
2866
2865
|
/**
|
2867
2866
|
* Post ID to retrieve metrics for.
|
2868
2867
|
* @minLength 1
|
@@ -2870,11 +2869,11 @@ export interface GetPostMetricsRequest {
|
|
2870
2869
|
*/
|
2871
2870
|
postId: string;
|
2872
2871
|
}
|
2873
|
-
|
2872
|
+
interface GetPostMetricsResponse {
|
2874
2873
|
/** Retrieved post metrics. */
|
2875
2874
|
metrics?: Metrics;
|
2876
2875
|
}
|
2877
|
-
|
2876
|
+
interface BulkGetPostMetricsRequest {
|
2878
2877
|
/**
|
2879
2878
|
* Post IDs.
|
2880
2879
|
* @maxSize 500
|
@@ -2882,11 +2881,11 @@ export interface BulkGetPostMetricsRequest {
|
|
2882
2881
|
*/
|
2883
2882
|
postIds?: string[];
|
2884
2883
|
}
|
2885
|
-
|
2884
|
+
interface BulkGetPostMetricsResponse {
|
2886
2885
|
/** Map of post.id to metrics */
|
2887
2886
|
metrics?: Record<string, Metrics>;
|
2888
2887
|
}
|
2889
|
-
|
2888
|
+
interface ViewPostRequest {
|
2890
2889
|
/**
|
2891
2890
|
* Post ID.
|
2892
2891
|
* @minLength 1
|
@@ -2894,11 +2893,11 @@ export interface ViewPostRequest {
|
|
2894
2893
|
*/
|
2895
2894
|
postId?: string;
|
2896
2895
|
}
|
2897
|
-
|
2896
|
+
interface ViewPostResponse {
|
2898
2897
|
/** Total number of post views */
|
2899
2898
|
views?: number;
|
2900
2899
|
}
|
2901
|
-
|
2900
|
+
interface LikePostRequest {
|
2902
2901
|
/**
|
2903
2902
|
* Post ID.
|
2904
2903
|
* @minLength 1
|
@@ -2913,11 +2912,11 @@ export interface LikePostRequest {
|
|
2913
2912
|
*/
|
2914
2913
|
fieldsets?: PostFieldField[];
|
2915
2914
|
}
|
2916
|
-
|
2915
|
+
interface LikePostResponse {
|
2917
2916
|
/** Post info. */
|
2918
2917
|
post?: Post;
|
2919
2918
|
}
|
2920
|
-
|
2919
|
+
interface UnlikePostRequest {
|
2921
2920
|
/**
|
2922
2921
|
* Post ID.
|
2923
2922
|
* @minLength 1
|
@@ -2932,11 +2931,11 @@ export interface UnlikePostRequest {
|
|
2932
2931
|
*/
|
2933
2932
|
fieldsets?: PostFieldField[];
|
2934
2933
|
}
|
2935
|
-
|
2934
|
+
interface UnlikePostResponse {
|
2936
2935
|
/** Post info. */
|
2937
2936
|
post?: Post;
|
2938
2937
|
}
|
2939
|
-
|
2938
|
+
interface PinPostRequest {
|
2940
2939
|
/**
|
2941
2940
|
* Post ID.
|
2942
2941
|
* @minLength 1
|
@@ -2951,11 +2950,11 @@ export interface PinPostRequest {
|
|
2951
2950
|
*/
|
2952
2951
|
fieldsets?: PostFieldField[];
|
2953
2952
|
}
|
2954
|
-
|
2953
|
+
interface PinPostResponse {
|
2955
2954
|
/** Post info. */
|
2956
2955
|
post?: Post;
|
2957
2956
|
}
|
2958
|
-
|
2957
|
+
interface UnpinPostRequest {
|
2959
2958
|
/**
|
2960
2959
|
* Post ID.
|
2961
2960
|
* @minLength 1
|
@@ -2970,11 +2969,11 @@ export interface UnpinPostRequest {
|
|
2970
2969
|
*/
|
2971
2970
|
fieldsets?: PostFieldField[];
|
2972
2971
|
}
|
2973
|
-
|
2972
|
+
interface UnpinPostResponse {
|
2974
2973
|
/** Post info. */
|
2975
2974
|
post?: Post;
|
2976
2975
|
}
|
2977
|
-
|
2976
|
+
interface ListPostsArchiveRequest {
|
2978
2977
|
/**
|
2979
2978
|
* Month
|
2980
2979
|
* @min 1
|
@@ -3011,7 +3010,7 @@ export interface ListPostsArchiveRequest {
|
|
3011
3010
|
*/
|
3012
3011
|
fieldsets?: PostFieldField[];
|
3013
3012
|
}
|
3014
|
-
|
3013
|
+
interface ListPostsArchiveResponse {
|
3015
3014
|
/** List of posts. */
|
3016
3015
|
posts?: Post[];
|
3017
3016
|
/** Details on the paged set of results returned. */
|
@@ -3019,7 +3018,7 @@ export interface ListPostsArchiveResponse {
|
|
3019
3018
|
/** Details on the paged set of results returned. */
|
3020
3019
|
pagingMetadata?: PagingMetadataV2;
|
3021
3020
|
}
|
3022
|
-
|
3021
|
+
interface BulkGetPostReactionsRequest {
|
3023
3022
|
/**
|
3024
3023
|
* Post IDs.
|
3025
3024
|
* @maxSize 500
|
@@ -3027,18 +3026,18 @@ export interface BulkGetPostReactionsRequest {
|
|
3027
3026
|
*/
|
3028
3027
|
postIds?: string[];
|
3029
3028
|
}
|
3030
|
-
|
3029
|
+
interface BulkGetPostReactionsResponse {
|
3031
3030
|
/** Map of post.id to reactions */
|
3032
3031
|
reactionsMap?: Record<string, Reactions>;
|
3033
3032
|
}
|
3034
|
-
|
3033
|
+
interface Reactions {
|
3035
3034
|
/**
|
3036
3035
|
* Is post liked by the current user
|
3037
3036
|
* @readonly
|
3038
3037
|
*/
|
3039
3038
|
liked?: boolean;
|
3040
3039
|
}
|
3041
|
-
|
3040
|
+
interface ListDemoPostsRequest {
|
3042
3041
|
/**
|
3043
3042
|
* Whether to return only featured posts.
|
3044
3043
|
*
|
@@ -3125,35 +3124,35 @@ export interface ListDemoPostsRequest {
|
|
3125
3124
|
*/
|
3126
3125
|
fieldsets?: PostFieldField[];
|
3127
3126
|
}
|
3128
|
-
|
3127
|
+
interface ListDemoPostsResponse {
|
3129
3128
|
/** List of posts. */
|
3130
3129
|
posts?: Post[];
|
3131
3130
|
/** Details on the paged set of results returned. */
|
3132
3131
|
metaData?: MetaData;
|
3133
3132
|
}
|
3134
|
-
|
3133
|
+
interface ConvertDraftJsToRichContentRequest {
|
3135
3134
|
/** DraftJs content to convert to Rich content. */
|
3136
3135
|
content?: Record<string, any> | null;
|
3137
3136
|
}
|
3138
|
-
|
3137
|
+
interface ConvertDraftJsToRichContentResponse {
|
3139
3138
|
/**
|
3140
3139
|
* Rich content converted from DraftJs content.
|
3141
3140
|
* @maxLength 2000000
|
3142
3141
|
*/
|
3143
3142
|
richContent?: string;
|
3144
3143
|
}
|
3145
|
-
|
3144
|
+
interface ConvertRichContentToDraftJsRequest {
|
3146
3145
|
/**
|
3147
3146
|
* Rich content to convert to DraftJs content.
|
3148
3147
|
* @maxLength 2000000
|
3149
3148
|
*/
|
3150
3149
|
richContent?: string;
|
3151
3150
|
}
|
3152
|
-
|
3151
|
+
interface ConvertRichContentToDraftJsResponse {
|
3153
3152
|
/** DraftJs content converted from Rich content. */
|
3154
3153
|
content?: Record<string, any> | null;
|
3155
3154
|
}
|
3156
|
-
|
3155
|
+
interface OldBlogMigratedEvent {
|
3157
3156
|
/**
|
3158
3157
|
* Instance id of new version of blog
|
3159
3158
|
* @format GUID
|
@@ -3165,7 +3164,7 @@ export interface OldBlogMigratedEvent {
|
|
3165
3164
|
*/
|
3166
3165
|
oldBlogInstanceId?: string;
|
3167
3166
|
}
|
3168
|
-
|
3167
|
+
interface BaseEventMetadata {
|
3169
3168
|
/**
|
3170
3169
|
* App instance ID.
|
3171
3170
|
* @format GUID
|
@@ -3179,7 +3178,7 @@ export interface BaseEventMetadata {
|
|
3179
3178
|
/** The identification type and identity data. */
|
3180
3179
|
identity?: IdentificationData;
|
3181
3180
|
}
|
3182
|
-
|
3181
|
+
interface EventMetadata extends BaseEventMetadata {
|
3183
3182
|
/**
|
3184
3183
|
* Unique event ID.
|
3185
3184
|
* Allows clients to ignore duplicate webhooks.
|
@@ -3217,127 +3216,27 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
3217
3216
|
*/
|
3218
3217
|
entityEventSequence?: string | null;
|
3219
3218
|
}
|
3220
|
-
|
3219
|
+
interface PostCreatedEnvelope {
|
3221
3220
|
entity: Post;
|
3222
3221
|
metadata: EventMetadata;
|
3223
3222
|
}
|
3224
|
-
|
3225
|
-
* Triggered when a post is created.
|
3226
|
-
* @permissionScope Read Blog
|
3227
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3228
|
-
* @permissionScope Manage Blog
|
3229
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3230
|
-
* @permissionScope Read Draft Blog Posts
|
3231
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3232
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3233
|
-
* @webhook
|
3234
|
-
* @eventType wix.blog.v3.post_created
|
3235
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3236
|
-
* @slug created
|
3237
|
-
*/
|
3238
|
-
export declare function onPostCreated(handler: (event: PostCreatedEnvelope) => void | Promise<void>): void;
|
3239
|
-
export interface PostDeletedEnvelope {
|
3223
|
+
interface PostDeletedEnvelope {
|
3240
3224
|
entity: Post;
|
3241
3225
|
metadata: EventMetadata;
|
3242
3226
|
}
|
3243
|
-
|
3244
|
-
* Triggered when a post is deleted.
|
3245
|
-
* @permissionScope Read Blog
|
3246
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3247
|
-
* @permissionScope Manage Blog
|
3248
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3249
|
-
* @permissionScope Read Draft Blog Posts
|
3250
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3251
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3252
|
-
* @webhook
|
3253
|
-
* @eventType wix.blog.v3.post_deleted
|
3254
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3255
|
-
* @slug deleted
|
3256
|
-
*/
|
3257
|
-
export declare function onPostDeleted(handler: (event: PostDeletedEnvelope) => void | Promise<void>): void;
|
3258
|
-
export interface PostLikedEnvelope {
|
3227
|
+
interface PostLikedEnvelope {
|
3259
3228
|
data: PostLiked;
|
3260
3229
|
metadata: EventMetadata;
|
3261
3230
|
}
|
3262
|
-
|
3263
|
-
* Triggered when a post is liked.
|
3264
|
-
* @permissionScope Read Blog
|
3265
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3266
|
-
* @permissionScope Manage Blog
|
3267
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3268
|
-
* @permissionScope Read Draft Blog Posts
|
3269
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3270
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3271
|
-
* @webhook
|
3272
|
-
* @eventType wix.blog.v3.post_liked
|
3273
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3274
|
-
* @slug liked
|
3275
|
-
*/
|
3276
|
-
export declare function onPostLiked(handler: (event: PostLikedEnvelope) => void | Promise<void>): void;
|
3277
|
-
export interface PostUnlikedEnvelope {
|
3231
|
+
interface PostUnlikedEnvelope {
|
3278
3232
|
data: PostUnliked;
|
3279
3233
|
metadata: EventMetadata;
|
3280
3234
|
}
|
3281
|
-
|
3282
|
-
* Triggered when a post is unliked.
|
3283
|
-
* @permissionScope Read Blog
|
3284
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3285
|
-
* @permissionScope Manage Blog
|
3286
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3287
|
-
* @permissionScope Read Draft Blog Posts
|
3288
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3289
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3290
|
-
* @webhook
|
3291
|
-
* @eventType wix.blog.v3.post_unliked
|
3292
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3293
|
-
* @slug unliked
|
3294
|
-
*/
|
3295
|
-
export declare function onPostUnliked(handler: (event: PostUnlikedEnvelope) => void | Promise<void>): void;
|
3296
|
-
export interface PostUpdatedEnvelope {
|
3235
|
+
interface PostUpdatedEnvelope {
|
3297
3236
|
entity: Post;
|
3298
3237
|
metadata: EventMetadata;
|
3299
3238
|
}
|
3300
|
-
|
3301
|
-
* Triggered when a post is updated.
|
3302
|
-
* @permissionScope Read Blog
|
3303
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3304
|
-
* @permissionScope Manage Blog
|
3305
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3306
|
-
* @permissionScope Read Draft Blog Posts
|
3307
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3308
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3309
|
-
* @webhook
|
3310
|
-
* @eventType wix.blog.v3.post_updated
|
3311
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3312
|
-
* @slug updated
|
3313
|
-
*/
|
3314
|
-
export declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | Promise<void>): void;
|
3315
|
-
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`;
|
3316
|
-
/**
|
3317
|
-
* Retrieves the number of published posts per month within a specified time range.
|
3318
|
-
*
|
3319
|
-
* The time range is set using the `rangeStart` and `months` properties.
|
3320
|
-
* The time range always starts on the 1st day of the month set in `rangeStart` and
|
3321
|
-
* includes the number of `months` following `rangeStart`.
|
3322
|
-
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
|
3323
|
-
* 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.
|
3324
|
-
* > 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.
|
3325
|
-
* @public
|
3326
|
-
* @documentationMaturity preview
|
3327
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3328
|
-
* @permissionScope Read Blog
|
3329
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3330
|
-
* @permissionScope Manage Blog
|
3331
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3332
|
-
* @permissionScope Read Draft Blog Posts
|
3333
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3334
|
-
* @applicableIdentity APP
|
3335
|
-
* @applicableIdentity VISITOR
|
3336
|
-
* @returns Get Blog Post Count Stats response
|
3337
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.QueryPostCountStats
|
3338
|
-
*/
|
3339
|
-
export declare function queryPostCountStats(options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`>>;
|
3340
|
-
export interface QueryPostCountStatsOptions {
|
3239
|
+
interface QueryPostCountStatsOptions {
|
3341
3240
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
3342
3241
|
rangeStart?: Date | null;
|
3343
3242
|
/**
|
@@ -3368,23 +3267,7 @@ export interface QueryPostCountStatsOptions {
|
|
3368
3267
|
*/
|
3369
3268
|
timeZone?: string | null;
|
3370
3269
|
}
|
3371
|
-
|
3372
|
-
* Retrieves the total amount of published posts of the blog.
|
3373
|
-
* @public
|
3374
|
-
* @documentationMaturity preview
|
3375
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3376
|
-
* @permissionScope Read Blog
|
3377
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3378
|
-
* @permissionScope Manage Blog
|
3379
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3380
|
-
* @permissionScope Read Draft Blog Posts
|
3381
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3382
|
-
* @applicableIdentity APP
|
3383
|
-
* @applicableIdentity VISITOR
|
3384
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
|
3385
|
-
*/
|
3386
|
-
export declare function getTotalPosts(options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`>>;
|
3387
|
-
export interface GetTotalPostsOptions {
|
3270
|
+
interface GetTotalPostsOptions {
|
3388
3271
|
/**
|
3389
3272
|
* Language filter.
|
3390
3273
|
*
|
@@ -3394,25 +3277,7 @@ export interface GetTotalPostsOptions {
|
|
3394
3277
|
*/
|
3395
3278
|
language?: string | null;
|
3396
3279
|
}
|
3397
|
-
|
3398
|
-
* Retrieves a post by the specified ID.
|
3399
|
-
* @param postId - Post ID.
|
3400
|
-
* @public
|
3401
|
-
* @requiredField postId
|
3402
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3403
|
-
* @permissionScope Read Blog
|
3404
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3405
|
-
* @permissionScope Manage Blog
|
3406
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3407
|
-
* @permissionScope Read Draft Blog Posts
|
3408
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3409
|
-
* @applicableIdentity APP
|
3410
|
-
* @applicableIdentity VISITOR
|
3411
|
-
* @returns Retrieved post info.
|
3412
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
3413
|
-
*/
|
3414
|
-
export declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<Post, PostNonNullablePaths>>;
|
3415
|
-
export interface GetPostOptions {
|
3280
|
+
interface GetPostOptions {
|
3416
3281
|
/**
|
3417
3282
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3418
3283
|
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
@@ -3421,31 +3286,7 @@ export interface GetPostOptions {
|
|
3421
3286
|
*/
|
3422
3287
|
fieldsets?: PostFieldField[];
|
3423
3288
|
}
|
3424
|
-
|
3425
|
-
* Retrieves a post with the provided slug.
|
3426
|
-
*
|
3427
|
-
* The slug is the end of a post's URL that refers to a specific post.
|
3428
|
-
* For example, if a post's URL is `https:/example.com/blog/post/my-post-slug`,
|
3429
|
-
* the slug is `my-post-slug`. The slug is case-sensitive, and is generally derived from the post title,
|
3430
|
-
* unless specified otherwise.
|
3431
|
-
* @param slug - Slug of the post to retrieve.
|
3432
|
-
* @public
|
3433
|
-
* @requiredField slug
|
3434
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3435
|
-
* @permissionScope Read Blog
|
3436
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3437
|
-
* @permissionScope Manage Blog
|
3438
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3439
|
-
* @permissionScope Read Draft Blog Posts
|
3440
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3441
|
-
* @applicableIdentity APP
|
3442
|
-
* @applicableIdentity VISITOR
|
3443
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
3444
|
-
*/
|
3445
|
-
export declare function getPostBySlug(slug: string, options?: GetPostBySlugOptions): Promise<NonNullablePaths<GetPostBySlugResponse, {
|
3446
|
-
[P in PostNonNullablePaths]: `post.${P}`;
|
3447
|
-
}[PostNonNullablePaths]>>;
|
3448
|
-
export interface GetPostBySlugOptions {
|
3289
|
+
interface GetPostBySlugOptions {
|
3449
3290
|
/**
|
3450
3291
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3451
3292
|
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
@@ -3454,29 +3295,7 @@ export interface GetPostBySlugOptions {
|
|
3454
3295
|
*/
|
3455
3296
|
fieldsets?: PostFieldField[];
|
3456
3297
|
}
|
3457
|
-
|
3458
|
-
* Retrieves a list of up to 100 published posts per request.
|
3459
|
-
*
|
3460
|
-
* List Posts runs with these defaults, which you can override:
|
3461
|
-
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
3462
|
-
* - `paging.limit` is `50`.
|
3463
|
-
* - `paging.offset` is `0`.
|
3464
|
-
* @public
|
3465
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3466
|
-
* @permissionScope Read Blog
|
3467
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3468
|
-
* @permissionScope Manage Blog
|
3469
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3470
|
-
* @permissionScope Read Draft Blog Posts
|
3471
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3472
|
-
* @applicableIdentity APP
|
3473
|
-
* @applicableIdentity VISITOR
|
3474
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
3475
|
-
*/
|
3476
|
-
export declare function listPosts(options?: ListPostsOptions): Promise<NonNullablePaths<ListPostsResponse, {
|
3477
|
-
[P in PostNonNullablePaths]: `posts.${number}.${P}`;
|
3478
|
-
}[PostNonNullablePaths] | `metaData.count` | `metaData.offset` | `metaData.total`>>;
|
3479
|
-
export interface ListPostsOptions {
|
3298
|
+
interface ListPostsOptions {
|
3480
3299
|
/**
|
3481
3300
|
* Whether to return only featured posts.
|
3482
3301
|
*
|
@@ -3540,37 +3359,7 @@ export interface ListPostsOptions {
|
|
3540
3359
|
*/
|
3541
3360
|
fieldsets?: PostFieldField[];
|
3542
3361
|
}
|
3543
|
-
|
3544
|
-
* Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
|
3545
|
-
*
|
3546
|
-
* Query Posts runs with these defaults, which you can override:
|
3547
|
-
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
3548
|
-
* - `paging.limit` is `50`.
|
3549
|
-
* - `paging.offset` is `0`.
|
3550
|
-
*
|
3551
|
-
* For field support for filters and sorting, see
|
3552
|
-
* [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
|
3553
|
-
*
|
3554
|
-
* To learn about working with _Query_ endpoints, see
|
3555
|
-
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
3556
|
-
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
|
3557
|
-
* [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
3558
|
-
* For a detailed list of supported filters and sortable fields, see
|
3559
|
-
* [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
|
3560
|
-
* @public
|
3561
|
-
* @permissionScope Read Blog
|
3562
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3563
|
-
* @permissionScope Manage Blog
|
3564
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3565
|
-
* @permissionScope Read Draft Blog Posts
|
3566
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3567
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3568
|
-
* @applicableIdentity APP
|
3569
|
-
* @applicableIdentity VISITOR
|
3570
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
3571
|
-
*/
|
3572
|
-
export declare function queryPosts(options?: QueryPostsOptions): PostsQueryBuilder;
|
3573
|
-
export interface QueryPostsOptions {
|
3362
|
+
interface QueryPostsOptions {
|
3574
3363
|
/**
|
3575
3364
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3576
3365
|
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
@@ -3586,13 +3375,13 @@ interface QueryCursorResult {
|
|
3586
3375
|
length: number;
|
3587
3376
|
pageSize: number;
|
3588
3377
|
}
|
3589
|
-
|
3378
|
+
interface PostsQueryResult extends QueryCursorResult {
|
3590
3379
|
items: Post[];
|
3591
3380
|
query: PostsQueryBuilder;
|
3592
3381
|
next: () => Promise<PostsQueryResult>;
|
3593
3382
|
prev: () => Promise<PostsQueryResult>;
|
3594
3383
|
}
|
3595
|
-
|
3384
|
+
interface PostsQueryBuilder {
|
3596
3385
|
/** @param propertyName - Property whose value is compared with `value`.
|
3597
3386
|
* @param value - Value to compare against.
|
3598
3387
|
*/
|
@@ -3641,23 +3430,5 @@ export interface PostsQueryBuilder {
|
|
3641
3430
|
skipTo: (cursor: string) => PostsQueryBuilder;
|
3642
3431
|
find: () => Promise<PostsQueryResult>;
|
3643
3432
|
}
|
3644
|
-
|
3645
|
-
|
3646
|
-
*
|
3647
|
-
* A post's metrics include the comments, likes, and views the post receives.
|
3648
|
-
* @param postId - Post ID to retrieve metrics for.
|
3649
|
-
* @public
|
3650
|
-
* @requiredField postId
|
3651
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3652
|
-
* @permissionScope Read Blog
|
3653
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3654
|
-
* @permissionScope Manage Blog
|
3655
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3656
|
-
* @permissionScope Read Draft Blog Posts
|
3657
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3658
|
-
* @applicableIdentity APP
|
3659
|
-
* @applicableIdentity VISITOR
|
3660
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostMetrics
|
3661
|
-
*/
|
3662
|
-
export declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`>>;
|
3663
|
-
export {};
|
3433
|
+
|
3434
|
+
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 };
|