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