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