@wix/auto_sdk_blog_posts 1.0.31 → 1.0.32
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{cjs/src/blog-v3-post-posts.universal.d.ts → blog-v3-post-posts.universal-hTPKKRYx.d.mts} +299 -563
- package/build/{es/src/blog-v3-post-posts.universal.d.ts → blog-v3-post-posts.universal-hTPKKRYx.d.ts} +299 -563
- package/build/index.d.mts +127 -0
- package/build/index.d.ts +127 -0
- package/build/index.js +1970 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +1894 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{cjs/src/blog-v3-post-posts.universal.d.ts → blog-v3-post-posts.universal-D8MomLjA.d.mts} +299 -563
- package/build/internal/{es/src/blog-v3-post-posts.universal.d.ts → blog-v3-post-posts.universal-D8MomLjA.d.ts} +299 -563
- package/build/internal/index.d.mts +127 -0
- package/build/internal/index.d.ts +127 -0
- package/build/internal/index.js +1970 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +1894 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/{es/src/blog-v3-post-posts.types.d.ts → internal/meta.d.mts} +259 -1412
- package/build/internal/{cjs/src/blog-v3-post-posts.types.d.ts → meta.d.ts} +259 -1412
- package/build/internal/meta.js +1002 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +969 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{cjs/src/blog-v3-post-posts.types.d.ts → meta.d.mts} +259 -1412
- package/build/{internal/es/src/blog-v3-post-posts.types.d.ts → meta.d.ts} +259 -1412
- package/build/meta.js +1002 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +969 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.context.d.ts +0 -37
- package/build/cjs/src/blog-v3-post-posts.context.js +0 -82
- package/build/cjs/src/blog-v3-post-posts.context.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.http.d.ts +0 -61
- package/build/cjs/src/blog-v3-post-posts.http.js +0 -894
- package/build/cjs/src/blog-v3-post-posts.http.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.meta.d.ts +0 -25
- package/build/cjs/src/blog-v3-post-posts.meta.js +0 -161
- package/build/cjs/src/blog-v3-post-posts.meta.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.public.d.ts +0 -106
- package/build/cjs/src/blog-v3-post-posts.public.js +0 -320
- package/build/cjs/src/blog-v3-post-posts.public.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.types.js +0 -485
- package/build/cjs/src/blog-v3-post-posts.types.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.universal.js +0 -974
- package/build/cjs/src/blog-v3-post-posts.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/blog-v3-post-posts.context.d.ts +0 -37
- package/build/es/src/blog-v3-post-posts.context.js +0 -37
- package/build/es/src/blog-v3-post-posts.context.js.map +0 -1
- package/build/es/src/blog-v3-post-posts.http.d.ts +0 -61
- package/build/es/src/blog-v3-post-posts.http.js +0 -884
- package/build/es/src/blog-v3-post-posts.http.js.map +0 -1
- package/build/es/src/blog-v3-post-posts.meta.d.ts +0 -25
- package/build/es/src/blog-v3-post-posts.meta.js +0 -128
- package/build/es/src/blog-v3-post-posts.meta.js.map +0 -1
- package/build/es/src/blog-v3-post-posts.public.d.ts +0 -106
- package/build/es/src/blog-v3-post-posts.public.js +0 -268
- package/build/es/src/blog-v3-post-posts.public.js.map +0 -1
- package/build/es/src/blog-v3-post-posts.types.js +0 -482
- package/build/es/src/blog-v3-post-posts.types.js.map +0 -1
- package/build/es/src/blog-v3-post-posts.universal.js +0 -941
- package/build/es/src/blog-v3-post-posts.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.context.d.ts +0 -37
- package/build/internal/cjs/src/blog-v3-post-posts.context.js +0 -82
- package/build/internal/cjs/src/blog-v3-post-posts.context.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.http.d.ts +0 -61
- package/build/internal/cjs/src/blog-v3-post-posts.http.js +0 -894
- package/build/internal/cjs/src/blog-v3-post-posts.http.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.meta.d.ts +0 -25
- package/build/internal/cjs/src/blog-v3-post-posts.meta.js +0 -161
- package/build/internal/cjs/src/blog-v3-post-posts.meta.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.public.d.ts +0 -106
- package/build/internal/cjs/src/blog-v3-post-posts.public.js +0 -320
- package/build/internal/cjs/src/blog-v3-post-posts.public.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.types.js +0 -485
- package/build/internal/cjs/src/blog-v3-post-posts.types.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.universal.js +0 -974
- package/build/internal/cjs/src/blog-v3-post-posts.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.context.d.ts +0 -37
- package/build/internal/es/src/blog-v3-post-posts.context.js +0 -37
- package/build/internal/es/src/blog-v3-post-posts.context.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.http.d.ts +0 -61
- package/build/internal/es/src/blog-v3-post-posts.http.js +0 -884
- package/build/internal/es/src/blog-v3-post-posts.http.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.meta.d.ts +0 -25
- package/build/internal/es/src/blog-v3-post-posts.meta.js +0 -128
- package/build/internal/es/src/blog-v3-post-posts.meta.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.public.d.ts +0 -106
- package/build/internal/es/src/blog-v3-post-posts.public.js +0 -268
- package/build/internal/es/src/blog-v3-post-posts.public.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.types.js +0 -482
- package/build/internal/es/src/blog-v3-post-posts.types.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.universal.js +0 -941
- package/build/internal/es/src/blog-v3-post-posts.universal.js.map +0 -1
@@ -1,5 +1,4 @@
|
|
1
|
-
|
2
|
-
export interface Post {
|
1
|
+
interface Post {
|
3
2
|
/**
|
4
3
|
* Post ID.
|
5
4
|
* @readonly
|
@@ -168,7 +167,7 @@ export interface Post {
|
|
168
167
|
*/
|
169
168
|
referenceId?: string | null;
|
170
169
|
}
|
171
|
-
|
170
|
+
interface CoverMedia extends CoverMediaMediaOneOf {
|
172
171
|
/** Image url. */
|
173
172
|
image?: string;
|
174
173
|
/** Video url. */
|
@@ -194,13 +193,13 @@ export interface CoverMedia extends CoverMediaMediaOneOf {
|
|
194
193
|
altText?: string | null;
|
195
194
|
}
|
196
195
|
/** @oneof */
|
197
|
-
|
196
|
+
interface CoverMediaMediaOneOf {
|
198
197
|
/** Image url. */
|
199
198
|
image?: string;
|
200
199
|
/** Video url. */
|
201
200
|
video?: string;
|
202
201
|
}
|
203
|
-
|
202
|
+
interface FocalPoint {
|
204
203
|
/** X-coordinate of the focal point. */
|
205
204
|
x?: number;
|
206
205
|
/** Y-coordinate of the focal point. */
|
@@ -210,7 +209,7 @@ export interface FocalPoint {
|
|
210
209
|
/** crop by width */
|
211
210
|
width?: number | null;
|
212
211
|
}
|
213
|
-
|
212
|
+
interface PostCountInfo {
|
214
213
|
/**
|
215
214
|
* Total number of post comments
|
216
215
|
* @readonly
|
@@ -227,7 +226,7 @@ export interface PostCountInfo {
|
|
227
226
|
*/
|
228
227
|
views?: number;
|
229
228
|
}
|
230
|
-
|
229
|
+
interface Metrics {
|
231
230
|
/**
|
232
231
|
* Total number of post comments.
|
233
232
|
* @readonly
|
@@ -249,13 +248,13 @@ export interface Metrics {
|
|
249
248
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
250
249
|
* This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
|
251
250
|
*/
|
252
|
-
|
251
|
+
interface SeoSchema {
|
253
252
|
/** SEO tag information. */
|
254
253
|
tags?: Tag[];
|
255
254
|
/** SEO general settings. */
|
256
255
|
settings?: Settings;
|
257
256
|
}
|
258
|
-
|
257
|
+
interface Keyword {
|
259
258
|
/** Keyword value. */
|
260
259
|
term?: string;
|
261
260
|
/** Whether the keyword is the main focus keyword. */
|
@@ -266,7 +265,7 @@ export interface Keyword {
|
|
266
265
|
*/
|
267
266
|
origin?: string | null;
|
268
267
|
}
|
269
|
-
|
268
|
+
interface Tag {
|
270
269
|
/**
|
271
270
|
* SEO tag type.
|
272
271
|
*
|
@@ -288,7 +287,7 @@ export interface Tag {
|
|
288
287
|
/** Whether the tag is disabled. */
|
289
288
|
disabled?: boolean;
|
290
289
|
}
|
291
|
-
|
290
|
+
interface Settings {
|
292
291
|
/**
|
293
292
|
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
294
293
|
*
|
@@ -302,7 +301,7 @@ export interface Settings {
|
|
302
301
|
*/
|
303
302
|
keywords?: Keyword[];
|
304
303
|
}
|
305
|
-
|
304
|
+
interface RichContent {
|
306
305
|
/** Node objects representing a rich content document. */
|
307
306
|
nodes?: Node[];
|
308
307
|
/** Object metadata. */
|
@@ -310,7 +309,7 @@ export interface RichContent {
|
|
310
309
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
311
310
|
documentStyle?: DocumentStyle;
|
312
311
|
}
|
313
|
-
|
312
|
+
interface Node extends NodeDataOneOf {
|
314
313
|
/** Data for a button node. */
|
315
314
|
buttonData?: ButtonData;
|
316
315
|
/** Data for a code block node. */
|
@@ -375,7 +374,7 @@ export interface Node extends NodeDataOneOf {
|
|
375
374
|
style?: NodeStyle;
|
376
375
|
}
|
377
376
|
/** @oneof */
|
378
|
-
|
377
|
+
interface NodeDataOneOf {
|
379
378
|
/** Data for a button node. */
|
380
379
|
buttonData?: ButtonData;
|
381
380
|
/** Data for a code block node. */
|
@@ -431,7 +430,7 @@ export interface NodeDataOneOf {
|
|
431
430
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
432
431
|
layoutCellData?: LayoutCellData;
|
433
432
|
}
|
434
|
-
|
433
|
+
declare enum NodeType {
|
435
434
|
PARAGRAPH = "PARAGRAPH",
|
436
435
|
TEXT = "TEXT",
|
437
436
|
HEADING = "HEADING",
|
@@ -468,8 +467,8 @@ export declare enum NodeType {
|
|
468
467
|
LAYOUT_CELL = "LAYOUT_CELL"
|
469
468
|
}
|
470
469
|
/** @enumType */
|
471
|
-
|
472
|
-
|
470
|
+
type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
|
471
|
+
interface NodeStyle {
|
473
472
|
/** The top padding value in pixels. */
|
474
473
|
paddingTop?: string | null;
|
475
474
|
/** The bottom padding value in pixels. */
|
@@ -477,7 +476,7 @@ export interface NodeStyle {
|
|
477
476
|
/** The background color as a hexadecimal value. */
|
478
477
|
backgroundColor?: string | null;
|
479
478
|
}
|
480
|
-
|
479
|
+
interface ButtonData {
|
481
480
|
/** Styling for the button's container. */
|
482
481
|
containerData?: PluginContainerData;
|
483
482
|
/** The button type. */
|
@@ -489,13 +488,13 @@ export interface ButtonData {
|
|
489
488
|
/** Button link details. */
|
490
489
|
link?: Link;
|
491
490
|
}
|
492
|
-
|
491
|
+
interface Border {
|
493
492
|
/** Border width in pixels. */
|
494
493
|
width?: number | null;
|
495
494
|
/** Border radius in pixels. */
|
496
495
|
radius?: number | null;
|
497
496
|
}
|
498
|
-
|
497
|
+
interface Colors {
|
499
498
|
/** The text color as a hexadecimal value. */
|
500
499
|
text?: string | null;
|
501
500
|
/** The border color as a hexadecimal value. */
|
@@ -503,7 +502,7 @@ export interface Colors {
|
|
503
502
|
/** The background color as a hexadecimal value. */
|
504
503
|
background?: string | null;
|
505
504
|
}
|
506
|
-
|
505
|
+
interface PluginContainerData {
|
507
506
|
/** The width of the node when it's displayed. */
|
508
507
|
width?: PluginContainerDataWidth;
|
509
508
|
/** The node's alignment within its container. */
|
@@ -515,7 +514,7 @@ export interface PluginContainerData {
|
|
515
514
|
/** 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`. */
|
516
515
|
textWrap?: boolean | null;
|
517
516
|
}
|
518
|
-
|
517
|
+
declare enum WidthType {
|
519
518
|
/** Width matches the content width */
|
520
519
|
CONTENT = "CONTENT",
|
521
520
|
/** Small Width */
|
@@ -526,8 +525,8 @@ export declare enum WidthType {
|
|
526
525
|
FULL_WIDTH = "FULL_WIDTH"
|
527
526
|
}
|
528
527
|
/** @enumType */
|
529
|
-
|
530
|
-
|
528
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
529
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
531
530
|
/**
|
532
531
|
* One of the following predefined width options:
|
533
532
|
* `CONTENT`: The width of the container matches the content width.
|
@@ -540,7 +539,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
540
539
|
custom?: string | null;
|
541
540
|
}
|
542
541
|
/** @oneof */
|
543
|
-
|
542
|
+
interface PluginContainerDataWidthDataOneOf {
|
544
543
|
/**
|
545
544
|
* One of the following predefined width options:
|
546
545
|
* `CONTENT`: The width of the container matches the content width.
|
@@ -552,7 +551,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
552
551
|
/** A custom width value in pixels. */
|
553
552
|
custom?: string | null;
|
554
553
|
}
|
555
|
-
|
554
|
+
declare enum PluginContainerDataAlignment {
|
556
555
|
/** Center Alignment */
|
557
556
|
CENTER = "CENTER",
|
558
557
|
/** Left Alignment */
|
@@ -561,8 +560,8 @@ export declare enum PluginContainerDataAlignment {
|
|
561
560
|
RIGHT = "RIGHT"
|
562
561
|
}
|
563
562
|
/** @enumType */
|
564
|
-
|
565
|
-
|
563
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
564
|
+
interface Spoiler {
|
566
565
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
567
566
|
enabled?: boolean | null;
|
568
567
|
/** The description displayed on top of the spoiler cover. */
|
@@ -570,25 +569,25 @@ export interface Spoiler {
|
|
570
569
|
/** The text for the button used to remove the spoiler cover. */
|
571
570
|
buttonText?: string | null;
|
572
571
|
}
|
573
|
-
|
572
|
+
interface Height {
|
574
573
|
/** A custom height value in pixels. */
|
575
574
|
custom?: string | null;
|
576
575
|
}
|
577
|
-
|
576
|
+
declare enum Type {
|
578
577
|
/** Regular link button */
|
579
578
|
LINK = "LINK",
|
580
579
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
581
580
|
ACTION = "ACTION"
|
582
581
|
}
|
583
582
|
/** @enumType */
|
584
|
-
|
585
|
-
|
583
|
+
type TypeWithLiterals = Type | 'LINK' | 'ACTION';
|
584
|
+
interface Styles {
|
586
585
|
/** Border attributes. */
|
587
586
|
border?: Border;
|
588
587
|
/** Color attributes. */
|
589
588
|
colors?: Colors;
|
590
589
|
}
|
591
|
-
|
590
|
+
interface Link extends LinkDataOneOf {
|
592
591
|
/** The absolute URL for the linked document. */
|
593
592
|
url?: string;
|
594
593
|
/** The target node's ID. Used for linking to another node in this object. */
|
@@ -607,13 +606,13 @@ export interface Link extends LinkDataOneOf {
|
|
607
606
|
customData?: string | null;
|
608
607
|
}
|
609
608
|
/** @oneof */
|
610
|
-
|
609
|
+
interface LinkDataOneOf {
|
611
610
|
/** The absolute URL for the linked document. */
|
612
611
|
url?: string;
|
613
612
|
/** The target node's ID. Used for linking to another node in this object. */
|
614
613
|
anchor?: string;
|
615
614
|
}
|
616
|
-
|
615
|
+
declare enum Target {
|
617
616
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
618
617
|
SELF = "SELF",
|
619
618
|
/** Opens the linked document in a new window or tab */
|
@@ -624,8 +623,8 @@ export declare enum Target {
|
|
624
623
|
TOP = "TOP"
|
625
624
|
}
|
626
625
|
/** @enumType */
|
627
|
-
|
628
|
-
|
626
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
627
|
+
interface Rel {
|
629
628
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
630
629
|
nofollow?: boolean | null;
|
631
630
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
@@ -635,17 +634,17 @@ export interface Rel {
|
|
635
634
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
636
635
|
noreferrer?: boolean | null;
|
637
636
|
}
|
638
|
-
|
637
|
+
interface CodeBlockData {
|
639
638
|
/** Styling for the code block's text. */
|
640
639
|
textStyle?: TextStyle;
|
641
640
|
}
|
642
|
-
|
641
|
+
interface TextStyle {
|
643
642
|
/** Text alignment. Defaults to `AUTO`. */
|
644
643
|
textAlignment?: TextAlignmentWithLiterals;
|
645
644
|
/** 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. */
|
646
645
|
lineHeight?: string | null;
|
647
646
|
}
|
648
|
-
|
647
|
+
declare enum TextAlignment {
|
649
648
|
/** browser default, eqivalent to `initial` */
|
650
649
|
AUTO = "AUTO",
|
651
650
|
/** Left align */
|
@@ -658,8 +657,8 @@ export declare enum TextAlignment {
|
|
658
657
|
JUSTIFY = "JUSTIFY"
|
659
658
|
}
|
660
659
|
/** @enumType */
|
661
|
-
|
662
|
-
|
660
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
661
|
+
interface DividerData {
|
663
662
|
/** Styling for the divider's container. */
|
664
663
|
containerData?: PluginContainerData;
|
665
664
|
/** Divider line style. */
|
@@ -669,7 +668,7 @@ export interface DividerData {
|
|
669
668
|
/** Divider alignment. */
|
670
669
|
alignment?: AlignmentWithLiterals;
|
671
670
|
}
|
672
|
-
|
671
|
+
declare enum LineStyle {
|
673
672
|
/** Single Line */
|
674
673
|
SINGLE = "SINGLE",
|
675
674
|
/** Double Line */
|
@@ -680,8 +679,8 @@ export declare enum LineStyle {
|
|
680
679
|
DOTTED = "DOTTED"
|
681
680
|
}
|
682
681
|
/** @enumType */
|
683
|
-
|
684
|
-
|
682
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
683
|
+
declare enum Width {
|
685
684
|
/** Large line */
|
686
685
|
LARGE = "LARGE",
|
687
686
|
/** Medium line */
|
@@ -690,8 +689,8 @@ export declare enum Width {
|
|
690
689
|
SMALL = "SMALL"
|
691
690
|
}
|
692
691
|
/** @enumType */
|
693
|
-
|
694
|
-
|
692
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
693
|
+
declare enum Alignment {
|
695
694
|
/** Center alignment */
|
696
695
|
CENTER = "CENTER",
|
697
696
|
/** Left alignment */
|
@@ -700,8 +699,8 @@ export declare enum Alignment {
|
|
700
699
|
RIGHT = "RIGHT"
|
701
700
|
}
|
702
701
|
/** @enumType */
|
703
|
-
|
704
|
-
|
702
|
+
type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
703
|
+
interface FileData {
|
705
704
|
/** Styling for the file's container. */
|
706
705
|
containerData?: PluginContainerData;
|
707
706
|
/** The source for the file's data. */
|
@@ -724,7 +723,7 @@ export interface FileData {
|
|
724
723
|
/** File size in KB. */
|
725
724
|
sizeInKb?: string | null;
|
726
725
|
}
|
727
|
-
|
726
|
+
declare enum ViewMode {
|
728
727
|
/** No PDF view */
|
729
728
|
NONE = "NONE",
|
730
729
|
/** Full PDF view */
|
@@ -733,8 +732,8 @@ export declare enum ViewMode {
|
|
733
732
|
MINI = "MINI"
|
734
733
|
}
|
735
734
|
/** @enumType */
|
736
|
-
|
737
|
-
|
735
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
736
|
+
interface FileSource extends FileSourceDataOneOf {
|
738
737
|
/** The absolute URL for the file's source. */
|
739
738
|
url?: string | null;
|
740
739
|
/**
|
@@ -748,7 +747,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
748
747
|
private?: boolean | null;
|
749
748
|
}
|
750
749
|
/** @oneof */
|
751
|
-
|
750
|
+
interface FileSourceDataOneOf {
|
752
751
|
/** The absolute URL for the file's source. */
|
753
752
|
url?: string | null;
|
754
753
|
/**
|
@@ -759,7 +758,7 @@ export interface FileSourceDataOneOf {
|
|
759
758
|
/** An ID that's resolved to a URL by a resolver function. */
|
760
759
|
id?: string | null;
|
761
760
|
}
|
762
|
-
|
761
|
+
interface PDFSettings {
|
763
762
|
/**
|
764
763
|
* PDF view mode. One of the following:
|
765
764
|
* `NONE` : The PDF isn't displayed.
|
@@ -772,7 +771,7 @@ export interface PDFSettings {
|
|
772
771
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
773
772
|
disablePrint?: boolean | null;
|
774
773
|
}
|
775
|
-
|
774
|
+
interface GalleryData {
|
776
775
|
/** Styling for the gallery's container. */
|
777
776
|
containerData?: PluginContainerData;
|
778
777
|
/** The items in the gallery. */
|
@@ -784,7 +783,7 @@ export interface GalleryData {
|
|
784
783
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
785
784
|
disableDownload?: boolean | null;
|
786
785
|
}
|
787
|
-
|
786
|
+
interface V1Media {
|
788
787
|
/** The source for the media's data. */
|
789
788
|
src?: FileSource;
|
790
789
|
/** Media width in pixels. */
|
@@ -794,19 +793,19 @@ export interface V1Media {
|
|
794
793
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
795
794
|
duration?: number | null;
|
796
795
|
}
|
797
|
-
|
796
|
+
interface Image {
|
798
797
|
/** Image file details. */
|
799
798
|
media?: V1Media;
|
800
799
|
/** Link details for images that are links. */
|
801
800
|
link?: Link;
|
802
801
|
}
|
803
|
-
|
802
|
+
interface Video {
|
804
803
|
/** Video file details. */
|
805
804
|
media?: V1Media;
|
806
805
|
/** Video thumbnail file details. */
|
807
806
|
thumbnail?: V1Media;
|
808
807
|
}
|
809
|
-
|
808
|
+
interface Item extends ItemDataOneOf {
|
810
809
|
/** An image item. */
|
811
810
|
image?: Image;
|
812
811
|
/** A video item. */
|
@@ -817,13 +816,13 @@ export interface Item extends ItemDataOneOf {
|
|
817
816
|
altText?: string | null;
|
818
817
|
}
|
819
818
|
/** @oneof */
|
820
|
-
|
819
|
+
interface ItemDataOneOf {
|
821
820
|
/** An image item. */
|
822
821
|
image?: Image;
|
823
822
|
/** A video item. */
|
824
823
|
video?: Video;
|
825
824
|
}
|
826
|
-
|
825
|
+
interface GalleryOptions {
|
827
826
|
/** Gallery layout. */
|
828
827
|
layout?: Layout;
|
829
828
|
/** Styling for gallery items. */
|
@@ -831,7 +830,7 @@ export interface GalleryOptions {
|
|
831
830
|
/** Styling for gallery thumbnail images. */
|
832
831
|
thumbnails?: Thumbnails;
|
833
832
|
}
|
834
|
-
|
833
|
+
declare enum LayoutType {
|
835
834
|
/** Collage type */
|
836
835
|
COLLAGE = "COLLAGE",
|
837
836
|
/** Masonry type */
|
@@ -854,24 +853,24 @@ export declare enum LayoutType {
|
|
854
853
|
FULLSIZE = "FULLSIZE"
|
855
854
|
}
|
856
855
|
/** @enumType */
|
857
|
-
|
858
|
-
|
856
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
857
|
+
declare enum Orientation {
|
859
858
|
/** Rows Orientation */
|
860
859
|
ROWS = "ROWS",
|
861
860
|
/** Columns Orientation */
|
862
861
|
COLUMNS = "COLUMNS"
|
863
862
|
}
|
864
863
|
/** @enumType */
|
865
|
-
|
866
|
-
|
864
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
865
|
+
declare enum Crop {
|
867
866
|
/** Crop to fill */
|
868
867
|
FILL = "FILL",
|
869
868
|
/** Crop to fit */
|
870
869
|
FIT = "FIT"
|
871
870
|
}
|
872
871
|
/** @enumType */
|
873
|
-
|
874
|
-
|
872
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
873
|
+
declare enum ThumbnailsAlignment {
|
875
874
|
/** Top alignment */
|
876
875
|
TOP = "TOP",
|
877
876
|
/** Right alignment */
|
@@ -884,8 +883,8 @@ export declare enum ThumbnailsAlignment {
|
|
884
883
|
NONE = "NONE"
|
885
884
|
}
|
886
885
|
/** @enumType */
|
887
|
-
|
888
|
-
|
886
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
887
|
+
interface Layout {
|
889
888
|
/** Gallery layout type. */
|
890
889
|
type?: LayoutTypeWithLiterals;
|
891
890
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
@@ -897,7 +896,7 @@ export interface Layout {
|
|
897
896
|
/** The number of columns to display on mobile screens. */
|
898
897
|
mobileNumberOfColumns?: number | null;
|
899
898
|
}
|
900
|
-
|
899
|
+
interface ItemStyle {
|
901
900
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
902
901
|
targetSize?: number | null;
|
903
902
|
/** Item ratio */
|
@@ -907,13 +906,13 @@ export interface ItemStyle {
|
|
907
906
|
/** The spacing between items in pixels. */
|
908
907
|
spacing?: number | null;
|
909
908
|
}
|
910
|
-
|
909
|
+
interface Thumbnails {
|
911
910
|
/** Thumbnail alignment. */
|
912
911
|
placement?: ThumbnailsAlignmentWithLiterals;
|
913
912
|
/** Spacing between thumbnails in pixels. */
|
914
913
|
spacing?: number | null;
|
915
914
|
}
|
916
|
-
|
915
|
+
interface GIFData {
|
917
916
|
/** Styling for the GIF's container. */
|
918
917
|
containerData?: PluginContainerData;
|
919
918
|
/** The source of the full size GIF. */
|
@@ -927,7 +926,7 @@ export interface GIFData {
|
|
927
926
|
/** Type of GIF (Sticker or GIF). Defaults to `GIF`. */
|
928
927
|
gifType?: GIFTypeWithLiterals;
|
929
928
|
}
|
930
|
-
|
929
|
+
interface GIF {
|
931
930
|
/**
|
932
931
|
* GIF format URL.
|
933
932
|
* @format WEB_URL
|
@@ -944,13 +943,13 @@ export interface GIF {
|
|
944
943
|
*/
|
945
944
|
still?: string | null;
|
946
945
|
}
|
947
|
-
|
946
|
+
declare enum GIFType {
|
948
947
|
GIF = "GIF",
|
949
948
|
STICKER = "STICKER"
|
950
949
|
}
|
951
950
|
/** @enumType */
|
952
|
-
|
953
|
-
|
951
|
+
type GIFTypeWithLiterals = GIFType | 'GIF' | 'STICKER';
|
952
|
+
interface HeadingData {
|
954
953
|
/** Heading level from 1-6. */
|
955
954
|
level?: number;
|
956
955
|
/** Styling for the heading text. */
|
@@ -958,7 +957,7 @@ export interface HeadingData {
|
|
958
957
|
/** Indentation level from 1-4. */
|
959
958
|
indentation?: number | null;
|
960
959
|
}
|
961
|
-
|
960
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
962
961
|
/** The URL for the HTML code for the node. */
|
963
962
|
url?: string;
|
964
963
|
/** The HTML code for the node. */
|
@@ -976,7 +975,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
976
975
|
autoHeight?: boolean | null;
|
977
976
|
}
|
978
977
|
/** @oneof */
|
979
|
-
|
978
|
+
interface HTMLDataDataOneOf {
|
980
979
|
/** The URL for the HTML code for the node. */
|
981
980
|
url?: string;
|
982
981
|
/** The HTML code for the node. */
|
@@ -987,13 +986,13 @@ export interface HTMLDataDataOneOf {
|
|
987
986
|
*/
|
988
987
|
isAdsense?: boolean | null;
|
989
988
|
}
|
990
|
-
|
989
|
+
declare enum Source {
|
991
990
|
HTML = "HTML",
|
992
991
|
ADSENSE = "ADSENSE"
|
993
992
|
}
|
994
993
|
/** @enumType */
|
995
|
-
|
996
|
-
|
994
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
995
|
+
interface ImageData {
|
997
996
|
/** Styling for the image's container. */
|
998
997
|
containerData?: PluginContainerData;
|
999
998
|
/** Image file details. */
|
@@ -1012,7 +1011,7 @@ export interface ImageData {
|
|
1012
1011
|
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
1013
1012
|
disableDownload?: boolean | null;
|
1014
1013
|
}
|
1015
|
-
|
1014
|
+
interface StylesBorder {
|
1016
1015
|
/** Border width in pixels. */
|
1017
1016
|
width?: number | null;
|
1018
1017
|
/**
|
@@ -1023,11 +1022,11 @@ export interface StylesBorder {
|
|
1023
1022
|
/** Border radius in pixels. */
|
1024
1023
|
radius?: number | null;
|
1025
1024
|
}
|
1026
|
-
|
1025
|
+
interface ImageDataStyles {
|
1027
1026
|
/** Border attributes. */
|
1028
1027
|
border?: StylesBorder;
|
1029
1028
|
}
|
1030
|
-
|
1029
|
+
interface LinkPreviewData {
|
1031
1030
|
/** Styling for the link preview's container. */
|
1032
1031
|
containerData?: PluginContainerData;
|
1033
1032
|
/** Link details. */
|
@@ -1041,7 +1040,7 @@ export interface LinkPreviewData {
|
|
1041
1040
|
/** The preview content as HTML. */
|
1042
1041
|
html?: string | null;
|
1043
1042
|
}
|
1044
|
-
|
1043
|
+
declare enum Position {
|
1045
1044
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
1046
1045
|
START = "START",
|
1047
1046
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
@@ -1052,8 +1051,8 @@ export declare enum Position {
|
|
1052
1051
|
HIDDEN = "HIDDEN"
|
1053
1052
|
}
|
1054
1053
|
/** @enumType */
|
1055
|
-
|
1056
|
-
|
1054
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
1055
|
+
interface LinkPreviewDataStyles {
|
1057
1056
|
/**
|
1058
1057
|
* Background color as a hexadecimal value.
|
1059
1058
|
* @format COLOR_HEX
|
@@ -1086,13 +1085,13 @@ export interface LinkPreviewDataStyles {
|
|
1086
1085
|
/** Position of thumbnail. Defaults to `START`. */
|
1087
1086
|
thumbnailPosition?: PositionWithLiterals;
|
1088
1087
|
}
|
1089
|
-
|
1088
|
+
interface MapData {
|
1090
1089
|
/** Styling for the map's container. */
|
1091
1090
|
containerData?: PluginContainerData;
|
1092
1091
|
/** Map settings. */
|
1093
1092
|
mapSettings?: MapSettings;
|
1094
1093
|
}
|
1095
|
-
|
1094
|
+
interface MapSettings {
|
1096
1095
|
/** The address to display on the map. */
|
1097
1096
|
address?: string | null;
|
1098
1097
|
/** Sets whether the map is draggable. */
|
@@ -1116,7 +1115,7 @@ export interface MapSettings {
|
|
1116
1115
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
1117
1116
|
mapType?: MapTypeWithLiterals;
|
1118
1117
|
}
|
1119
|
-
|
1118
|
+
declare enum MapType {
|
1120
1119
|
/** Roadmap map type */
|
1121
1120
|
ROADMAP = "ROADMAP",
|
1122
1121
|
/** Satellite map type */
|
@@ -1127,8 +1126,8 @@ export declare enum MapType {
|
|
1127
1126
|
TERRAIN = "TERRAIN"
|
1128
1127
|
}
|
1129
1128
|
/** @enumType */
|
1130
|
-
|
1131
|
-
|
1129
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
1130
|
+
interface ParagraphData {
|
1132
1131
|
/** Styling for the paragraph text. */
|
1133
1132
|
textStyle?: TextStyle;
|
1134
1133
|
/** Indentation level from 1-4. */
|
@@ -1136,7 +1135,7 @@ export interface ParagraphData {
|
|
1136
1135
|
/** Paragraph level */
|
1137
1136
|
level?: number | null;
|
1138
1137
|
}
|
1139
|
-
|
1138
|
+
interface PollData {
|
1140
1139
|
/** Styling for the poll's container. */
|
1141
1140
|
containerData?: PluginContainerData;
|
1142
1141
|
/** Poll data. */
|
@@ -1146,7 +1145,7 @@ export interface PollData {
|
|
1146
1145
|
/** Styling for the poll and voting options. */
|
1147
1146
|
design?: Design;
|
1148
1147
|
}
|
1149
|
-
|
1148
|
+
declare enum ViewRole {
|
1150
1149
|
/** Only Poll creator can view the results */
|
1151
1150
|
CREATOR = "CREATOR",
|
1152
1151
|
/** Anyone who voted can see the results */
|
@@ -1155,16 +1154,16 @@ export declare enum ViewRole {
|
|
1155
1154
|
EVERYONE = "EVERYONE"
|
1156
1155
|
}
|
1157
1156
|
/** @enumType */
|
1158
|
-
|
1159
|
-
|
1157
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
1158
|
+
declare enum VoteRole {
|
1160
1159
|
/** Logged in member */
|
1161
1160
|
SITE_MEMBERS = "SITE_MEMBERS",
|
1162
1161
|
/** Anyone */
|
1163
1162
|
ALL = "ALL"
|
1164
1163
|
}
|
1165
1164
|
/** @enumType */
|
1166
|
-
|
1167
|
-
|
1165
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
1166
|
+
interface Permissions {
|
1168
1167
|
/** Sets who can view the poll results. */
|
1169
1168
|
view?: ViewRoleWithLiterals;
|
1170
1169
|
/** Sets who can vote. */
|
@@ -1172,7 +1171,7 @@ export interface Permissions {
|
|
1172
1171
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
1173
1172
|
allowMultipleVotes?: boolean | null;
|
1174
1173
|
}
|
1175
|
-
|
1174
|
+
interface Option {
|
1176
1175
|
/** Option ID. */
|
1177
1176
|
id?: string | null;
|
1178
1177
|
/** Option title. */
|
@@ -1180,7 +1179,7 @@ export interface Option {
|
|
1180
1179
|
/** The image displayed with the option. */
|
1181
1180
|
image?: V1Media;
|
1182
1181
|
}
|
1183
|
-
|
1182
|
+
interface PollSettings {
|
1184
1183
|
/** Permissions settings for voting. */
|
1185
1184
|
permissions?: Permissions;
|
1186
1185
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
@@ -1188,23 +1187,23 @@ export interface PollSettings {
|
|
1188
1187
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
1189
1188
|
showVotesCount?: boolean | null;
|
1190
1189
|
}
|
1191
|
-
|
1190
|
+
declare enum PollLayoutType {
|
1192
1191
|
/** List */
|
1193
1192
|
LIST = "LIST",
|
1194
1193
|
/** Grid */
|
1195
1194
|
GRID = "GRID"
|
1196
1195
|
}
|
1197
1196
|
/** @enumType */
|
1198
|
-
|
1199
|
-
|
1197
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
1198
|
+
declare enum PollLayoutDirection {
|
1200
1199
|
/** Left-to-right */
|
1201
1200
|
LTR = "LTR",
|
1202
1201
|
/** Right-to-left */
|
1203
1202
|
RTL = "RTL"
|
1204
1203
|
}
|
1205
1204
|
/** @enumType */
|
1206
|
-
|
1207
|
-
|
1205
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
1206
|
+
interface PollLayout {
|
1208
1207
|
/** The layout for displaying the voting options. */
|
1209
1208
|
type?: PollLayoutTypeWithLiterals;
|
1210
1209
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
@@ -1212,11 +1211,11 @@ export interface PollLayout {
|
|
1212
1211
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
1213
1212
|
enableImage?: boolean | null;
|
1214
1213
|
}
|
1215
|
-
|
1214
|
+
interface OptionLayout {
|
1216
1215
|
/** Sets whether to display option images. Defaults to `false`. */
|
1217
1216
|
enableImage?: boolean | null;
|
1218
1217
|
}
|
1219
|
-
|
1218
|
+
declare enum BackgroundType {
|
1220
1219
|
/** Color background type */
|
1221
1220
|
COLOR = "COLOR",
|
1222
1221
|
/** Image background type */
|
@@ -1225,8 +1224,8 @@ export declare enum BackgroundType {
|
|
1225
1224
|
GRADIENT = "GRADIENT"
|
1226
1225
|
}
|
1227
1226
|
/** @enumType */
|
1228
|
-
|
1229
|
-
|
1227
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
1228
|
+
interface Gradient {
|
1230
1229
|
/** The gradient angle in degrees. */
|
1231
1230
|
angle?: number | null;
|
1232
1231
|
/**
|
@@ -1240,7 +1239,7 @@ export interface Gradient {
|
|
1240
1239
|
*/
|
1241
1240
|
lastColor?: string | null;
|
1242
1241
|
}
|
1243
|
-
|
1242
|
+
interface Background extends BackgroundBackgroundOneOf {
|
1244
1243
|
/**
|
1245
1244
|
* The background color as a hexademical value.
|
1246
1245
|
* @format COLOR_HEX
|
@@ -1254,7 +1253,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
1254
1253
|
type?: BackgroundTypeWithLiterals;
|
1255
1254
|
}
|
1256
1255
|
/** @oneof */
|
1257
|
-
|
1256
|
+
interface BackgroundBackgroundOneOf {
|
1258
1257
|
/**
|
1259
1258
|
* The background color as a hexademical value.
|
1260
1259
|
* @format COLOR_HEX
|
@@ -1265,17 +1264,17 @@ export interface BackgroundBackgroundOneOf {
|
|
1265
1264
|
/** Details for a gradient background. */
|
1266
1265
|
gradient?: Gradient;
|
1267
1266
|
}
|
1268
|
-
|
1267
|
+
interface PollDesign {
|
1269
1268
|
/** Background styling. */
|
1270
1269
|
background?: Background;
|
1271
1270
|
/** Border radius in pixels. */
|
1272
1271
|
borderRadius?: number | null;
|
1273
1272
|
}
|
1274
|
-
|
1273
|
+
interface OptionDesign {
|
1275
1274
|
/** Border radius in pixels. */
|
1276
1275
|
borderRadius?: number | null;
|
1277
1276
|
}
|
1278
|
-
|
1277
|
+
interface Poll {
|
1279
1278
|
/** Poll ID. */
|
1280
1279
|
id?: string | null;
|
1281
1280
|
/** Poll title. */
|
@@ -1289,26 +1288,26 @@ export interface Poll {
|
|
1289
1288
|
/** The poll's permissions and display settings. */
|
1290
1289
|
settings?: PollSettings;
|
1291
1290
|
}
|
1292
|
-
|
1291
|
+
interface PollDataLayout {
|
1293
1292
|
/** Poll layout settings. */
|
1294
1293
|
poll?: PollLayout;
|
1295
1294
|
/** Voting otpions layout settings. */
|
1296
1295
|
options?: OptionLayout;
|
1297
1296
|
}
|
1298
|
-
|
1297
|
+
interface Design {
|
1299
1298
|
/** Styling for the poll. */
|
1300
1299
|
poll?: PollDesign;
|
1301
1300
|
/** Styling for voting options. */
|
1302
1301
|
options?: OptionDesign;
|
1303
1302
|
}
|
1304
|
-
|
1303
|
+
interface TextData {
|
1305
1304
|
/** The text to apply decorations to. */
|
1306
1305
|
text?: string;
|
1307
1306
|
/** The decorations to apply. */
|
1308
1307
|
decorations?: Decoration[];
|
1309
1308
|
}
|
1310
1309
|
/** Adds appearence changes to text */
|
1311
|
-
|
1310
|
+
interface Decoration extends DecorationDataOneOf {
|
1312
1311
|
/** Data for an anchor link decoration. */
|
1313
1312
|
anchorData?: AnchorData;
|
1314
1313
|
/** Data for a color decoration. */
|
@@ -1331,7 +1330,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
1331
1330
|
type?: DecorationTypeWithLiterals;
|
1332
1331
|
}
|
1333
1332
|
/** @oneof */
|
1334
|
-
|
1333
|
+
interface DecorationDataOneOf {
|
1335
1334
|
/** Data for an anchor link decoration. */
|
1336
1335
|
anchorData?: AnchorData;
|
1337
1336
|
/** Data for a color decoration. */
|
@@ -1351,7 +1350,7 @@ export interface DecorationDataOneOf {
|
|
1351
1350
|
/** Data for a spoiler decoration. */
|
1352
1351
|
spoilerData?: SpoilerData;
|
1353
1352
|
}
|
1354
|
-
|
1353
|
+
declare enum DecorationType {
|
1355
1354
|
BOLD = "BOLD",
|
1356
1355
|
ITALIC = "ITALIC",
|
1357
1356
|
UNDERLINE = "UNDERLINE",
|
@@ -1364,22 +1363,22 @@ export declare enum DecorationType {
|
|
1364
1363
|
EXTERNAL = "EXTERNAL"
|
1365
1364
|
}
|
1366
1365
|
/** @enumType */
|
1367
|
-
|
1368
|
-
|
1366
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL';
|
1367
|
+
interface AnchorData {
|
1369
1368
|
/** The target node's ID. */
|
1370
1369
|
anchor?: string;
|
1371
1370
|
}
|
1372
|
-
|
1371
|
+
interface ColorData {
|
1373
1372
|
/** The text's background color as a hexadecimal value. */
|
1374
1373
|
background?: string | null;
|
1375
1374
|
/** The text's foreground color as a hexadecimal value. */
|
1376
1375
|
foreground?: string | null;
|
1377
1376
|
}
|
1378
|
-
|
1377
|
+
interface LinkData {
|
1379
1378
|
/** Link details. */
|
1380
1379
|
link?: Link;
|
1381
1380
|
}
|
1382
|
-
|
1381
|
+
interface MentionData {
|
1383
1382
|
/** The mentioned user's name. */
|
1384
1383
|
name?: string;
|
1385
1384
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
@@ -1387,23 +1386,23 @@ export interface MentionData {
|
|
1387
1386
|
/** Mentioned user's ID. */
|
1388
1387
|
id?: string | null;
|
1389
1388
|
}
|
1390
|
-
|
1389
|
+
interface FontSizeData {
|
1391
1390
|
/** The units used for the font size. */
|
1392
1391
|
unit?: FontTypeWithLiterals;
|
1393
1392
|
/** Font size value. */
|
1394
1393
|
value?: number | null;
|
1395
1394
|
}
|
1396
|
-
|
1395
|
+
declare enum FontType {
|
1397
1396
|
PX = "PX",
|
1398
1397
|
EM = "EM"
|
1399
1398
|
}
|
1400
1399
|
/** @enumType */
|
1401
|
-
|
1402
|
-
|
1400
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
1401
|
+
interface SpoilerData {
|
1403
1402
|
/** Spoiler ID. */
|
1404
1403
|
id?: string | null;
|
1405
1404
|
}
|
1406
|
-
|
1405
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
1407
1406
|
/** Data for embedded Wix Bookings content. */
|
1408
1407
|
bookingData?: BookingData;
|
1409
1408
|
/** Data for embedded Wix Events content. */
|
@@ -1425,30 +1424,30 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1425
1424
|
image?: V1Media;
|
1426
1425
|
}
|
1427
1426
|
/** @oneof */
|
1428
|
-
|
1427
|
+
interface AppEmbedDataAppDataOneOf {
|
1429
1428
|
/** Data for embedded Wix Bookings content. */
|
1430
1429
|
bookingData?: BookingData;
|
1431
1430
|
/** Data for embedded Wix Events content. */
|
1432
1431
|
eventData?: EventData;
|
1433
1432
|
}
|
1434
|
-
|
1433
|
+
declare enum AppType {
|
1435
1434
|
PRODUCT = "PRODUCT",
|
1436
1435
|
EVENT = "EVENT",
|
1437
1436
|
BOOKING = "BOOKING"
|
1438
1437
|
}
|
1439
1438
|
/** @enumType */
|
1440
|
-
|
1441
|
-
|
1439
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
1440
|
+
interface BookingData {
|
1442
1441
|
/** Booking duration in minutes. */
|
1443
1442
|
durations?: string | null;
|
1444
1443
|
}
|
1445
|
-
|
1444
|
+
interface EventData {
|
1446
1445
|
/** Event schedule. */
|
1447
1446
|
scheduling?: string | null;
|
1448
1447
|
/** Event location. */
|
1449
1448
|
location?: string | null;
|
1450
1449
|
}
|
1451
|
-
|
1450
|
+
interface VideoData {
|
1452
1451
|
/** Styling for the video's container. */
|
1453
1452
|
containerData?: PluginContainerData;
|
1454
1453
|
/** Video details. */
|
@@ -1462,7 +1461,7 @@ export interface VideoData {
|
|
1462
1461
|
/** Video options. */
|
1463
1462
|
options?: PlaybackOptions;
|
1464
1463
|
}
|
1465
|
-
|
1464
|
+
interface PlaybackOptions {
|
1466
1465
|
/** Sets whether the media will automatically start playing. */
|
1467
1466
|
autoPlay?: boolean | null;
|
1468
1467
|
/** Sets whether media's will be looped. */
|
@@ -1470,7 +1469,7 @@ export interface PlaybackOptions {
|
|
1470
1469
|
/** Sets whether media's controls will be shown. */
|
1471
1470
|
showControls?: boolean | null;
|
1472
1471
|
}
|
1473
|
-
|
1472
|
+
interface EmbedData {
|
1474
1473
|
/** Styling for the oEmbed node's container. */
|
1475
1474
|
containerData?: PluginContainerData;
|
1476
1475
|
/** An [oEmbed](https://www.oembed.com) object. */
|
@@ -1478,7 +1477,7 @@ export interface EmbedData {
|
|
1478
1477
|
/** Origin asset source. */
|
1479
1478
|
src?: string | null;
|
1480
1479
|
}
|
1481
|
-
|
1480
|
+
interface Oembed {
|
1482
1481
|
/** The resource type. */
|
1483
1482
|
type?: string | null;
|
1484
1483
|
/** The width of the resource specified in the `url` property in pixels. */
|
@@ -1510,7 +1509,7 @@ export interface Oembed {
|
|
1510
1509
|
/** The oEmbed version number. This value must be `1.0`. */
|
1511
1510
|
version?: string | null;
|
1512
1511
|
}
|
1513
|
-
|
1512
|
+
interface CollapsibleListData {
|
1514
1513
|
/** Styling for the collapsible list's container. */
|
1515
1514
|
containerData?: PluginContainerData;
|
1516
1515
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
@@ -1522,7 +1521,7 @@ export interface CollapsibleListData {
|
|
1522
1521
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
1523
1522
|
isQapageData?: boolean | null;
|
1524
1523
|
}
|
1525
|
-
|
1524
|
+
declare enum InitialExpandedItems {
|
1526
1525
|
/** First item will be expended initally */
|
1527
1526
|
FIRST = "FIRST",
|
1528
1527
|
/** All items will expended initally */
|
@@ -1531,16 +1530,16 @@ export declare enum InitialExpandedItems {
|
|
1531
1530
|
NONE = "NONE"
|
1532
1531
|
}
|
1533
1532
|
/** @enumType */
|
1534
|
-
|
1535
|
-
|
1533
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
1534
|
+
declare enum Direction {
|
1536
1535
|
/** Left-to-right */
|
1537
1536
|
LTR = "LTR",
|
1538
1537
|
/** Right-to-left */
|
1539
1538
|
RTL = "RTL"
|
1540
1539
|
}
|
1541
1540
|
/** @enumType */
|
1542
|
-
|
1543
|
-
|
1541
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
1542
|
+
interface TableData {
|
1544
1543
|
/** Styling for the table's container. */
|
1545
1544
|
containerData?: PluginContainerData;
|
1546
1545
|
/** The table's dimensions. */
|
@@ -1555,7 +1554,7 @@ export interface TableData {
|
|
1555
1554
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
1556
1555
|
columnHeader?: boolean | null;
|
1557
1556
|
}
|
1558
|
-
|
1557
|
+
interface Dimensions {
|
1559
1558
|
/** An array representing relative width of each column in relation to the other columns. */
|
1560
1559
|
colsWidthRatio?: number[];
|
1561
1560
|
/** An array representing the height of each row in pixels. */
|
@@ -1563,13 +1562,13 @@ export interface Dimensions {
|
|
1563
1562
|
/** An array representing the minimum width of each column in pixels. */
|
1564
1563
|
colsMinWidth?: number[];
|
1565
1564
|
}
|
1566
|
-
|
1565
|
+
interface TableCellData {
|
1567
1566
|
/** Styling for the cell's background color and text alignment. */
|
1568
1567
|
cellStyle?: CellStyle;
|
1569
1568
|
/** The cell's border colors. */
|
1570
1569
|
borderColors?: BorderColors;
|
1571
1570
|
}
|
1572
|
-
|
1571
|
+
declare enum VerticalAlignment {
|
1573
1572
|
/** Top alignment */
|
1574
1573
|
TOP = "TOP",
|
1575
1574
|
/** Middle alignment */
|
@@ -1578,8 +1577,8 @@ export declare enum VerticalAlignment {
|
|
1578
1577
|
BOTTOM = "BOTTOM"
|
1579
1578
|
}
|
1580
1579
|
/** @enumType */
|
1581
|
-
|
1582
|
-
|
1580
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
1581
|
+
interface CellStyle {
|
1583
1582
|
/** Vertical alignment for the cell's text. */
|
1584
1583
|
verticalAlignment?: VerticalAlignmentWithLiterals;
|
1585
1584
|
/**
|
@@ -1588,7 +1587,7 @@ export interface CellStyle {
|
|
1588
1587
|
*/
|
1589
1588
|
backgroundColor?: string | null;
|
1590
1589
|
}
|
1591
|
-
|
1590
|
+
interface BorderColors {
|
1592
1591
|
/**
|
1593
1592
|
* Left border color as a hexadecimal value.
|
1594
1593
|
* @format COLOR_HEX
|
@@ -1616,22 +1615,20 @@ export interface BorderColors {
|
|
1616
1615
|
*
|
1617
1616
|
* The JSON representation for `NullValue` is JSON `null`.
|
1618
1617
|
*/
|
1619
|
-
|
1618
|
+
declare enum NullValue {
|
1620
1619
|
/** Null value. */
|
1621
1620
|
NULL_VALUE = "NULL_VALUE"
|
1622
1621
|
}
|
1623
|
-
/** @enumType */
|
1624
|
-
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
1625
1622
|
/**
|
1626
1623
|
* `ListValue` is a wrapper around a repeated field of values.
|
1627
1624
|
*
|
1628
1625
|
* The JSON representation for `ListValue` is JSON array.
|
1629
1626
|
*/
|
1630
|
-
|
1627
|
+
interface ListValue {
|
1631
1628
|
/** Repeated field of dynamically typed values. */
|
1632
1629
|
values?: any[];
|
1633
1630
|
}
|
1634
|
-
|
1631
|
+
interface AudioData {
|
1635
1632
|
/** Styling for the audio node's container. */
|
1636
1633
|
containerData?: PluginContainerData;
|
1637
1634
|
/** Audio file details. */
|
@@ -1647,7 +1644,7 @@ export interface AudioData {
|
|
1647
1644
|
/** An HTML version of the audio node. */
|
1648
1645
|
html?: string | null;
|
1649
1646
|
}
|
1650
|
-
|
1647
|
+
interface OrderedListData {
|
1651
1648
|
/** Indentation level from 0-4. */
|
1652
1649
|
indentation?: number;
|
1653
1650
|
/** Offset level from 0-4. */
|
@@ -1655,24 +1652,24 @@ export interface OrderedListData {
|
|
1655
1652
|
/** List start number. */
|
1656
1653
|
start?: number | null;
|
1657
1654
|
}
|
1658
|
-
|
1655
|
+
interface BulletedListData {
|
1659
1656
|
/** Indentation level from 0-4. */
|
1660
1657
|
indentation?: number;
|
1661
1658
|
/** Offset level from 0-4. */
|
1662
1659
|
offset?: number | null;
|
1663
1660
|
}
|
1664
|
-
|
1661
|
+
interface BlockquoteData {
|
1665
1662
|
/** Indentation level from 1-4. */
|
1666
1663
|
indentation?: number;
|
1667
1664
|
}
|
1668
|
-
|
1665
|
+
interface CaptionData {
|
1669
1666
|
textStyle?: TextStyle;
|
1670
1667
|
}
|
1671
|
-
|
1668
|
+
interface LayoutCellData {
|
1672
1669
|
/** Size of the cell in 12 columns grid. */
|
1673
1670
|
colSpan?: number | null;
|
1674
1671
|
}
|
1675
|
-
|
1672
|
+
interface Metadata {
|
1676
1673
|
/** Schema version. */
|
1677
1674
|
version?: number;
|
1678
1675
|
/**
|
@@ -1689,7 +1686,7 @@ export interface Metadata {
|
|
1689
1686
|
/** Object ID. */
|
1690
1687
|
_id?: string | null;
|
1691
1688
|
}
|
1692
|
-
|
1689
|
+
interface DocumentStyle {
|
1693
1690
|
/** Styling for H1 nodes. */
|
1694
1691
|
headerOne?: TextNodeStyle;
|
1695
1692
|
/** Styling for H2 nodes. */
|
@@ -1709,7 +1706,7 @@ export interface DocumentStyle {
|
|
1709
1706
|
/** Styling for code block nodes. */
|
1710
1707
|
codeBlock?: TextNodeStyle;
|
1711
1708
|
}
|
1712
|
-
|
1709
|
+
interface TextNodeStyle {
|
1713
1710
|
/** The decorations to apply to the node. */
|
1714
1711
|
decorations?: Decoration[];
|
1715
1712
|
/** Padding and background color for the node. */
|
@@ -1717,7 +1714,7 @@ export interface TextNodeStyle {
|
|
1717
1714
|
/** Line height for text in the node. */
|
1718
1715
|
lineHeight?: string | null;
|
1719
1716
|
}
|
1720
|
-
|
1717
|
+
interface ModerationDetails {
|
1721
1718
|
/**
|
1722
1719
|
* Member ID of the person submitting the draft post for review.
|
1723
1720
|
* @format GUID
|
@@ -1735,14 +1732,14 @@ export interface ModerationDetails {
|
|
1735
1732
|
/** Date the post was approved or rejected. */
|
1736
1733
|
moderationDate?: Date | null;
|
1737
1734
|
}
|
1738
|
-
|
1735
|
+
declare enum ModerationStatusStatus {
|
1739
1736
|
UNKNOWN = "UNKNOWN",
|
1740
1737
|
APPROVED = "APPROVED",
|
1741
1738
|
REJECTED = "REJECTED"
|
1742
1739
|
}
|
1743
1740
|
/** @enumType */
|
1744
|
-
|
1745
|
-
|
1741
|
+
type ModerationStatusStatusWithLiterals = ModerationStatusStatus | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
|
1742
|
+
interface Media extends MediaMediaOneOf {
|
1746
1743
|
/** Wix Media details. */
|
1747
1744
|
wixMedia?: WixMedia;
|
1748
1745
|
/** Embed media details. */
|
@@ -1759,19 +1756,19 @@ export interface Media extends MediaMediaOneOf {
|
|
1759
1756
|
altText?: string | null;
|
1760
1757
|
}
|
1761
1758
|
/** @oneof */
|
1762
|
-
|
1759
|
+
interface MediaMediaOneOf {
|
1763
1760
|
/** Wix Media details. */
|
1764
1761
|
wixMedia?: WixMedia;
|
1765
1762
|
/** Embed media details. */
|
1766
1763
|
embedMedia?: EmbedMedia;
|
1767
1764
|
}
|
1768
|
-
|
1765
|
+
interface WixMedia {
|
1769
1766
|
/** Image details. */
|
1770
1767
|
image?: string;
|
1771
1768
|
/** Video details. */
|
1772
1769
|
videoV2?: string;
|
1773
1770
|
}
|
1774
|
-
|
1771
|
+
interface VideoResolution {
|
1775
1772
|
/** Video URL. */
|
1776
1773
|
url?: string;
|
1777
1774
|
/** Video height. */
|
@@ -1781,13 +1778,13 @@ export interface VideoResolution {
|
|
1781
1778
|
/** Video format for example, mp4, hls. */
|
1782
1779
|
format?: string;
|
1783
1780
|
}
|
1784
|
-
|
1781
|
+
interface EmbedMedia {
|
1785
1782
|
/** Thumbnail details. */
|
1786
1783
|
thumbnail?: EmbedThumbnail;
|
1787
1784
|
/** Video details. */
|
1788
1785
|
video?: EmbedVideo;
|
1789
1786
|
}
|
1790
|
-
|
1787
|
+
interface EmbedThumbnail {
|
1791
1788
|
/**
|
1792
1789
|
* Thumbnail url.
|
1793
1790
|
* @maxLength 2000
|
@@ -1798,7 +1795,7 @@ export interface EmbedThumbnail {
|
|
1798
1795
|
/** Thumbnail height. */
|
1799
1796
|
height?: number;
|
1800
1797
|
}
|
1801
|
-
|
1798
|
+
interface EmbedVideo {
|
1802
1799
|
/**
|
1803
1800
|
* Video url.
|
1804
1801
|
* @maxLength 2000
|
@@ -1809,7 +1806,7 @@ export interface EmbedVideo {
|
|
1809
1806
|
/** Video height. */
|
1810
1807
|
height?: number;
|
1811
1808
|
}
|
1812
|
-
|
1809
|
+
interface PostTranslation {
|
1813
1810
|
/**
|
1814
1811
|
* Post ID.
|
1815
1812
|
* @format GUID
|
@@ -1830,7 +1827,7 @@ export interface PostTranslation {
|
|
1830
1827
|
/** Post URL. */
|
1831
1828
|
url?: string;
|
1832
1829
|
}
|
1833
|
-
|
1830
|
+
interface PostCategoriesUpdated {
|
1834
1831
|
/**
|
1835
1832
|
* ID of the post which counters were updated.
|
1836
1833
|
* @format GUID
|
@@ -1849,7 +1846,7 @@ export interface PostCategoriesUpdated {
|
|
1849
1846
|
*/
|
1850
1847
|
previousCategories?: string[];
|
1851
1848
|
}
|
1852
|
-
|
1849
|
+
interface PostTagsUpdated {
|
1853
1850
|
/**
|
1854
1851
|
* ID of the post which counters were updated.
|
1855
1852
|
* @format GUID
|
@@ -1868,7 +1865,7 @@ export interface PostTagsUpdated {
|
|
1868
1865
|
*/
|
1869
1866
|
previousTags?: string[];
|
1870
1867
|
}
|
1871
|
-
|
1868
|
+
interface ScheduledPostPublished {
|
1872
1869
|
/**
|
1873
1870
|
* ID of the scheduled post which was published.
|
1874
1871
|
* @format GUID
|
@@ -1876,7 +1873,7 @@ export interface ScheduledPostPublished {
|
|
1876
1873
|
postId?: string;
|
1877
1874
|
}
|
1878
1875
|
/** Get Blog Publications Count Stats request */
|
1879
|
-
|
1876
|
+
interface QueryPublicationsCountStatsRequest {
|
1880
1877
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1881
1878
|
rangeStart?: Date | null;
|
1882
1879
|
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
@@ -1899,27 +1896,27 @@ export interface QueryPublicationsCountStatsRequest {
|
|
1899
1896
|
*/
|
1900
1897
|
timeZone?: string | null;
|
1901
1898
|
}
|
1902
|
-
|
1899
|
+
declare enum QueryPublicationsCountStatsRequestOrder {
|
1903
1900
|
UNKNOWN = "UNKNOWN",
|
1904
1901
|
OLDEST = "OLDEST",
|
1905
1902
|
NEWEST = "NEWEST"
|
1906
1903
|
}
|
1907
1904
|
/** @enumType */
|
1908
|
-
|
1905
|
+
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
1909
1906
|
/** Get Blog Publications Count Stats response */
|
1910
|
-
|
1907
|
+
interface QueryPublicationsCountStatsResponse {
|
1911
1908
|
/** Chronologically ordered list of publications. */
|
1912
1909
|
stats?: PeriodPublicationsCount[];
|
1913
1910
|
}
|
1914
1911
|
/** Publications count for a specific time period */
|
1915
|
-
|
1912
|
+
interface PeriodPublicationsCount {
|
1916
1913
|
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1917
1914
|
periodStart?: Date | null;
|
1918
1915
|
/** Number of posts published during this month. */
|
1919
1916
|
publicationsCount?: number;
|
1920
1917
|
}
|
1921
1918
|
/** Get Blog Post Count Stats request */
|
1922
|
-
|
1919
|
+
interface QueryPostCountStatsRequest {
|
1923
1920
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1924
1921
|
rangeStart?: Date | null;
|
1925
1922
|
/**
|
@@ -1950,26 +1947,26 @@ export interface QueryPostCountStatsRequest {
|
|
1950
1947
|
*/
|
1951
1948
|
timeZone?: string | null;
|
1952
1949
|
}
|
1953
|
-
|
1950
|
+
declare enum Order {
|
1954
1951
|
UNKNOWN = "UNKNOWN",
|
1955
1952
|
OLDEST = "OLDEST",
|
1956
1953
|
NEWEST = "NEWEST"
|
1957
1954
|
}
|
1958
1955
|
/** @enumType */
|
1959
|
-
|
1956
|
+
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
1960
1957
|
/** Get Blog Post Count Stats response */
|
1961
|
-
|
1958
|
+
interface QueryPostCountStatsResponse {
|
1962
1959
|
/** List of published post counts by month. */
|
1963
1960
|
stats?: PeriodPostCount[];
|
1964
1961
|
}
|
1965
1962
|
/** Post count for a specific time period */
|
1966
|
-
|
1963
|
+
interface PeriodPostCount {
|
1967
1964
|
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1968
1965
|
periodStart?: Date | null;
|
1969
1966
|
/** Number of posts published during this month. */
|
1970
1967
|
postCount?: number;
|
1971
1968
|
}
|
1972
|
-
|
1969
|
+
interface GetTotalPublicationsRequest {
|
1973
1970
|
/**
|
1974
1971
|
* Language filter
|
1975
1972
|
* @minLength 2
|
@@ -1977,11 +1974,11 @@ export interface GetTotalPublicationsRequest {
|
|
1977
1974
|
*/
|
1978
1975
|
language?: string | null;
|
1979
1976
|
}
|
1980
|
-
|
1977
|
+
interface GetTotalPublicationsResponse {
|
1981
1978
|
/** Total amount of publications. */
|
1982
1979
|
total?: number;
|
1983
1980
|
}
|
1984
|
-
|
1981
|
+
interface GetTotalPostsRequest {
|
1985
1982
|
/**
|
1986
1983
|
* Language filter.
|
1987
1984
|
*
|
@@ -1991,11 +1988,11 @@ export interface GetTotalPostsRequest {
|
|
1991
1988
|
*/
|
1992
1989
|
language?: string | null;
|
1993
1990
|
}
|
1994
|
-
|
1991
|
+
interface GetTotalPostsResponse {
|
1995
1992
|
/** Total amount of published posts. */
|
1996
1993
|
total?: number;
|
1997
1994
|
}
|
1998
|
-
|
1995
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
1999
1996
|
createdEvent?: EntityCreatedEvent;
|
2000
1997
|
updatedEvent?: EntityUpdatedEvent;
|
2001
1998
|
deletedEvent?: EntityDeletedEvent;
|
@@ -2038,19 +2035,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
2038
2035
|
entityEventSequence?: string | null;
|
2039
2036
|
}
|
2040
2037
|
/** @oneof */
|
2041
|
-
|
2038
|
+
interface DomainEventBodyOneOf {
|
2042
2039
|
createdEvent?: EntityCreatedEvent;
|
2043
2040
|
updatedEvent?: EntityUpdatedEvent;
|
2044
2041
|
deletedEvent?: EntityDeletedEvent;
|
2045
2042
|
actionEvent?: ActionEvent;
|
2046
2043
|
}
|
2047
|
-
|
2044
|
+
interface EntityCreatedEvent {
|
2048
2045
|
entity?: string;
|
2049
2046
|
}
|
2050
|
-
|
2047
|
+
interface RestoreInfo {
|
2051
2048
|
deletedDate?: Date | null;
|
2052
2049
|
}
|
2053
|
-
|
2050
|
+
interface EntityUpdatedEvent {
|
2054
2051
|
/**
|
2055
2052
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
2056
2053
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
@@ -2058,14 +2055,14 @@ export interface EntityUpdatedEvent {
|
|
2058
2055
|
*/
|
2059
2056
|
currentEntity?: string;
|
2060
2057
|
}
|
2061
|
-
|
2058
|
+
interface EntityDeletedEvent {
|
2062
2059
|
/** Entity that was deleted */
|
2063
2060
|
deletedEntity?: string | null;
|
2064
2061
|
}
|
2065
|
-
|
2062
|
+
interface ActionEvent {
|
2066
2063
|
body?: string;
|
2067
2064
|
}
|
2068
|
-
|
2065
|
+
interface MessageEnvelope {
|
2069
2066
|
/**
|
2070
2067
|
* App instance ID.
|
2071
2068
|
* @format GUID
|
@@ -2081,7 +2078,7 @@ export interface MessageEnvelope {
|
|
2081
2078
|
/** Stringify payload. */
|
2082
2079
|
data?: string;
|
2083
2080
|
}
|
2084
|
-
|
2081
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
2085
2082
|
/**
|
2086
2083
|
* ID of a site visitor that has not logged in to the site.
|
2087
2084
|
* @format GUID
|
@@ -2106,7 +2103,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2106
2103
|
identityType?: WebhookIdentityTypeWithLiterals;
|
2107
2104
|
}
|
2108
2105
|
/** @oneof */
|
2109
|
-
|
2106
|
+
interface IdentificationDataIdOneOf {
|
2110
2107
|
/**
|
2111
2108
|
* ID of a site visitor that has not logged in to the site.
|
2112
2109
|
* @format GUID
|
@@ -2128,7 +2125,7 @@ export interface IdentificationDataIdOneOf {
|
|
2128
2125
|
*/
|
2129
2126
|
appId?: string;
|
2130
2127
|
}
|
2131
|
-
|
2128
|
+
declare enum WebhookIdentityType {
|
2132
2129
|
UNKNOWN = "UNKNOWN",
|
2133
2130
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
2134
2131
|
MEMBER = "MEMBER",
|
@@ -2136,8 +2133,8 @@ export declare enum WebhookIdentityType {
|
|
2136
2133
|
APP = "APP"
|
2137
2134
|
}
|
2138
2135
|
/** @enumType */
|
2139
|
-
|
2140
|
-
|
2136
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
2137
|
+
interface ListTemplatesRequest {
|
2141
2138
|
/**
|
2142
2139
|
* Filter post templates by given template category ids
|
2143
2140
|
* @maxSize 50
|
@@ -2156,15 +2153,15 @@ export interface ListTemplatesRequest {
|
|
2156
2153
|
/** Pagination options. */
|
2157
2154
|
paging?: BlogPaging;
|
2158
2155
|
}
|
2159
|
-
|
2156
|
+
declare enum GetPostTemplatesSort {
|
2160
2157
|
/** Sort by ascending publishing date. */
|
2161
2158
|
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
2162
2159
|
/** Sort by descending publishing date. */
|
2163
2160
|
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
2164
2161
|
}
|
2165
2162
|
/** @enumType */
|
2166
|
-
|
2167
|
-
|
2163
|
+
type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
|
2164
|
+
interface BlogPaging {
|
2168
2165
|
/**
|
2169
2166
|
* Number of items to skip in the current sort order.
|
2170
2167
|
*
|
@@ -2187,7 +2184,7 @@ export interface BlogPaging {
|
|
2187
2184
|
*/
|
2188
2185
|
cursor?: string | null;
|
2189
2186
|
}
|
2190
|
-
|
2187
|
+
interface ListTemplatesResponse {
|
2191
2188
|
/** Available post templates */
|
2192
2189
|
postTemplates?: Post[];
|
2193
2190
|
/** Details on the paged set of posts templates returned. */
|
@@ -2195,7 +2192,7 @@ export interface ListTemplatesResponse {
|
|
2195
2192
|
/** Post template categories. This value is returned empty unless asked explicitly */
|
2196
2193
|
templateCategories?: Category[];
|
2197
2194
|
}
|
2198
|
-
|
2195
|
+
interface MetaData {
|
2199
2196
|
/** Number of items returned in this response. */
|
2200
2197
|
count?: number;
|
2201
2198
|
/** Requested offset. */
|
@@ -2208,7 +2205,7 @@ export interface MetaData {
|
|
2208
2205
|
*/
|
2209
2206
|
cursor?: string | null;
|
2210
2207
|
}
|
2211
|
-
|
2208
|
+
interface Category {
|
2212
2209
|
/**
|
2213
2210
|
* Category ID.
|
2214
2211
|
* @immutable
|
@@ -2276,7 +2273,7 @@ export interface Category {
|
|
2276
2273
|
*/
|
2277
2274
|
_updatedDate?: Date | null;
|
2278
2275
|
}
|
2279
|
-
|
2276
|
+
interface CategoryTranslation {
|
2280
2277
|
/**
|
2281
2278
|
* Category ID.
|
2282
2279
|
* @format GUID
|
@@ -2295,29 +2292,29 @@ export interface CategoryTranslation {
|
|
2295
2292
|
/** URL of this category page. */
|
2296
2293
|
url?: string;
|
2297
2294
|
}
|
2298
|
-
|
2295
|
+
interface GetTemplateRequest {
|
2299
2296
|
/**
|
2300
2297
|
* Post template id
|
2301
2298
|
* @format GUID
|
2302
2299
|
*/
|
2303
2300
|
postTemplateId?: string;
|
2304
2301
|
}
|
2305
|
-
|
2302
|
+
interface GetTemplateResponse {
|
2306
2303
|
/** Post template */
|
2307
2304
|
postTemplate?: Post;
|
2308
2305
|
}
|
2309
|
-
|
2306
|
+
interface CreateDraftPostFromTemplateRequest {
|
2310
2307
|
/**
|
2311
2308
|
* Post template id
|
2312
2309
|
* @format GUID
|
2313
2310
|
*/
|
2314
2311
|
postTemplateId?: string;
|
2315
2312
|
}
|
2316
|
-
|
2313
|
+
interface CreateDraftPostFromTemplateResponse {
|
2317
2314
|
/** Created draft post */
|
2318
2315
|
draftPost?: DraftPost;
|
2319
2316
|
}
|
2320
|
-
|
2317
|
+
interface DraftPost {
|
2321
2318
|
/**
|
2322
2319
|
* Draft post ID.
|
2323
2320
|
* @readonly
|
@@ -2452,7 +2449,7 @@ export interface DraftPost {
|
|
2452
2449
|
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
2453
2450
|
previewTextParagraph?: number | null;
|
2454
2451
|
}
|
2455
|
-
|
2452
|
+
declare enum Origin {
|
2456
2453
|
UNKNOWN = "UNKNOWN",
|
2457
2454
|
/** Changed by admin */
|
2458
2455
|
ADMIN = "ADMIN",
|
@@ -2525,9 +2522,7 @@ export declare enum Origin {
|
|
2525
2522
|
/** Saved automatically by AI tool. */
|
2526
2523
|
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
2527
2524
|
}
|
2528
|
-
|
2529
|
-
export type OriginWithLiterals = Origin | 'UNKNOWN' | 'ADMIN' | 'ADD_CATEGORIES' | 'AUTO_SAVE' | 'COPY_TEMPLATE' | 'IMPORT' | 'IMPORT_BULK' | 'IMPORT_HTML' | 'IMPORT_PATCH' | 'LANGUAGE_CHANGE' | 'MANUAL_SAVE' | 'MIGRATION' | 'MODERATION' | 'MOVE_TO_TRASH' | 'PRICING_PLANS_CHANGE' | 'PROVISION' | 'PUBLISH' | 'REASSIGN_OWNER' | 'REBLOG' | 'RESTORE' | 'REVERT_TO_DRAFT' | 'TRANSLATION' | 'UNPUBLISH' | 'UNSCHEDULE' | 'NEW_EDIT_SESSION' | 'SCHEDULING_SERVICE_SCHEDULE' | 'SCHEDULING_SERVICE_UNSCHEDULE' | 'SCHEDULING_SERVICE_PUBLISH' | 'SCHEDULE' | 'REMOVE_FROM_MODERATION' | 'REJECT_FROM_MODERATION' | 'APPROVE_IN_MODERATION' | 'DELETE_TAG' | 'PIN' | 'UNPIN' | 'AI_AUTO_SAVE';
|
2530
|
-
export declare enum Status {
|
2525
|
+
declare enum Status {
|
2531
2526
|
UNKNOWN = "UNKNOWN",
|
2532
2527
|
/** Status indicating the draft post is published. */
|
2533
2528
|
PUBLISHED = "PUBLISHED",
|
@@ -2541,8 +2536,8 @@ export declare enum Status {
|
|
2541
2536
|
IN_REVIEW = "IN_REVIEW"
|
2542
2537
|
}
|
2543
2538
|
/** @enumType */
|
2544
|
-
|
2545
|
-
|
2539
|
+
type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
|
2540
|
+
interface DraftPostTranslation {
|
2546
2541
|
/**
|
2547
2542
|
* Post ID.
|
2548
2543
|
* @format GUID
|
@@ -2565,18 +2560,18 @@ export interface DraftPostTranslation {
|
|
2565
2560
|
/** Post URL. */
|
2566
2561
|
url?: string;
|
2567
2562
|
}
|
2568
|
-
|
2563
|
+
interface GetTotalLikesPerMemberRequest {
|
2569
2564
|
/**
|
2570
2565
|
* Member ID.
|
2571
2566
|
* @format GUID
|
2572
2567
|
*/
|
2573
2568
|
memberId?: string;
|
2574
2569
|
}
|
2575
|
-
|
2570
|
+
interface GetTotalLikesPerMemberResponse {
|
2576
2571
|
/** The total number of likes of the member. */
|
2577
2572
|
total?: number;
|
2578
2573
|
}
|
2579
|
-
|
2574
|
+
interface PostLiked extends PostLikedInitiatorOneOf {
|
2580
2575
|
/**
|
2581
2576
|
* Member ID of person who liked the post (only returned when the member was logged in when liking the post).
|
2582
2577
|
* @format GUID
|
@@ -2594,7 +2589,7 @@ export interface PostLiked extends PostLikedInitiatorOneOf {
|
|
2594
2589
|
postId?: string;
|
2595
2590
|
}
|
2596
2591
|
/** @oneof */
|
2597
|
-
|
2592
|
+
interface PostLikedInitiatorOneOf {
|
2598
2593
|
/**
|
2599
2594
|
* Member ID of person who liked the post (only returned when the member was logged in when liking the post).
|
2600
2595
|
* @format GUID
|
@@ -2606,7 +2601,7 @@ export interface PostLikedInitiatorOneOf {
|
|
2606
2601
|
*/
|
2607
2602
|
anonymousVisitorId?: string | null;
|
2608
2603
|
}
|
2609
|
-
|
2604
|
+
interface PostUnliked extends PostUnlikedInitiatorOneOf {
|
2610
2605
|
/**
|
2611
2606
|
* Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
|
2612
2607
|
* @format GUID
|
@@ -2624,7 +2619,7 @@ export interface PostUnliked extends PostUnlikedInitiatorOneOf {
|
|
2624
2619
|
postId?: string;
|
2625
2620
|
}
|
2626
2621
|
/** @oneof */
|
2627
|
-
|
2622
|
+
interface PostUnlikedInitiatorOneOf {
|
2628
2623
|
/**
|
2629
2624
|
* Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
|
2630
2625
|
* @format GUID
|
@@ -2636,7 +2631,7 @@ export interface PostUnlikedInitiatorOneOf {
|
|
2636
2631
|
*/
|
2637
2632
|
anonymousVisitorId?: string | null;
|
2638
2633
|
}
|
2639
|
-
|
2634
|
+
interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
2640
2635
|
/**
|
2641
2636
|
* Member ID of person who triggered the counter update
|
2642
2637
|
* @format GUID
|
@@ -2658,7 +2653,7 @@ export interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
|
2658
2653
|
counter?: number;
|
2659
2654
|
}
|
2660
2655
|
/** @oneof */
|
2661
|
-
|
2656
|
+
interface PostCountersUpdatedInitiatorOneOf {
|
2662
2657
|
/**
|
2663
2658
|
* Member ID of person who triggered the counter update
|
2664
2659
|
* @format GUID
|
@@ -2670,7 +2665,7 @@ export interface PostCountersUpdatedInitiatorOneOf {
|
|
2670
2665
|
*/
|
2671
2666
|
anonymousVisitorId?: string | null;
|
2672
2667
|
}
|
2673
|
-
|
2668
|
+
declare enum Field {
|
2674
2669
|
/** Undefined field. */
|
2675
2670
|
UNKNOWN = "UNKNOWN",
|
2676
2671
|
/** Total comments field. */
|
@@ -2683,14 +2678,14 @@ export declare enum Field {
|
|
2683
2678
|
RATING_COUNT = "RATING_COUNT"
|
2684
2679
|
}
|
2685
2680
|
/** @enumType */
|
2686
|
-
|
2687
|
-
|
2681
|
+
type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
|
2682
|
+
interface PostOwnerChanged {
|
2688
2683
|
}
|
2689
|
-
|
2684
|
+
interface InitialPostsCopied {
|
2690
2685
|
/** Number of posts copied. */
|
2691
2686
|
count?: number;
|
2692
2687
|
}
|
2693
|
-
|
2688
|
+
interface GetPostRequest {
|
2694
2689
|
/**
|
2695
2690
|
* Post ID.
|
2696
2691
|
* @minLength 1
|
@@ -2705,7 +2700,7 @@ export interface GetPostRequest {
|
|
2705
2700
|
*/
|
2706
2701
|
fieldsets?: PostFieldFieldWithLiterals[];
|
2707
2702
|
}
|
2708
|
-
|
2703
|
+
declare enum PostFieldField {
|
2709
2704
|
UNKNOWN = "UNKNOWN",
|
2710
2705
|
/** Includes post URL when present. */
|
2711
2706
|
URL = "URL",
|
@@ -2723,12 +2718,12 @@ export declare enum PostFieldField {
|
|
2723
2718
|
REFERENCE_ID = "REFERENCE_ID"
|
2724
2719
|
}
|
2725
2720
|
/** @enumType */
|
2726
|
-
|
2727
|
-
|
2721
|
+
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
2722
|
+
interface GetPostResponse {
|
2728
2723
|
/** Retrieved post info. */
|
2729
2724
|
post?: Post;
|
2730
2725
|
}
|
2731
|
-
|
2726
|
+
interface GetPostBySlugRequest {
|
2732
2727
|
/**
|
2733
2728
|
* Slug of the post to retrieve.
|
2734
2729
|
* @minLength 1
|
@@ -2743,11 +2738,11 @@ export interface GetPostBySlugRequest {
|
|
2743
2738
|
*/
|
2744
2739
|
fieldsets?: PostFieldFieldWithLiterals[];
|
2745
2740
|
}
|
2746
|
-
|
2741
|
+
interface GetPostBySlugResponse {
|
2747
2742
|
/** Retrieved post info. */
|
2748
2743
|
post?: Post;
|
2749
2744
|
}
|
2750
|
-
|
2745
|
+
interface ListPostsRequest {
|
2751
2746
|
/**
|
2752
2747
|
* Whether to return only featured posts.
|
2753
2748
|
*
|
@@ -2811,7 +2806,7 @@ export interface ListPostsRequest {
|
|
2811
2806
|
*/
|
2812
2807
|
fieldsets?: PostFieldFieldWithLiterals[];
|
2813
2808
|
}
|
2814
|
-
|
2809
|
+
declare enum GetPostsSort {
|
2815
2810
|
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
2816
2811
|
FEED = "FEED",
|
2817
2812
|
/** Ordered by `firstPublishedDate` in ascending order. */
|
@@ -2828,14 +2823,14 @@ export declare enum GetPostsSort {
|
|
2828
2823
|
TITLE_DESC = "TITLE_DESC"
|
2829
2824
|
}
|
2830
2825
|
/** @enumType */
|
2831
|
-
|
2832
|
-
|
2826
|
+
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
2827
|
+
interface ListPostsResponse {
|
2833
2828
|
/** List of retrieved posts. */
|
2834
2829
|
posts?: Post[];
|
2835
2830
|
/** Details on the paged set of results returned. */
|
2836
2831
|
metaData?: MetaData;
|
2837
2832
|
}
|
2838
|
-
|
2833
|
+
interface QueryPostsRequest {
|
2839
2834
|
/** Query options. */
|
2840
2835
|
query?: PlatformQuery;
|
2841
2836
|
/**
|
@@ -2846,7 +2841,7 @@ export interface QueryPostsRequest {
|
|
2846
2841
|
*/
|
2847
2842
|
fieldsets?: PostFieldFieldWithLiterals[];
|
2848
2843
|
}
|
2849
|
-
|
2844
|
+
interface Sorting {
|
2850
2845
|
/**
|
2851
2846
|
* Name of the field to sort by.
|
2852
2847
|
* @maxLength 512
|
@@ -2855,13 +2850,13 @@ export interface Sorting {
|
|
2855
2850
|
/** Sort order. */
|
2856
2851
|
order?: SortOrderWithLiterals;
|
2857
2852
|
}
|
2858
|
-
|
2853
|
+
declare enum SortOrder {
|
2859
2854
|
ASC = "ASC",
|
2860
2855
|
DESC = "DESC"
|
2861
2856
|
}
|
2862
2857
|
/** @enumType */
|
2863
|
-
|
2864
|
-
|
2858
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
2859
|
+
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
2865
2860
|
/** Paging options to limit and skip the number of items. */
|
2866
2861
|
paging?: Paging;
|
2867
2862
|
/** 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`. */
|
@@ -2883,13 +2878,13 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
2883
2878
|
sort?: Sorting[];
|
2884
2879
|
}
|
2885
2880
|
/** @oneof */
|
2886
|
-
|
2881
|
+
interface PlatformQueryPagingMethodOneOf {
|
2887
2882
|
/** Paging options to limit and skip the number of items. */
|
2888
2883
|
paging?: Paging;
|
2889
2884
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
2890
2885
|
cursorPaging?: CursorPaging;
|
2891
2886
|
}
|
2892
|
-
|
2887
|
+
interface Paging {
|
2893
2888
|
/**
|
2894
2889
|
* Number of items to load.
|
2895
2890
|
* @max 100
|
@@ -2898,7 +2893,7 @@ export interface Paging {
|
|
2898
2893
|
/** Number of items to skip in the current sort order. */
|
2899
2894
|
offset?: number | null;
|
2900
2895
|
}
|
2901
|
-
|
2896
|
+
interface CursorPaging {
|
2902
2897
|
/**
|
2903
2898
|
* Number of items to load.
|
2904
2899
|
* @max 100
|
@@ -2914,13 +2909,13 @@ export interface CursorPaging {
|
|
2914
2909
|
*/
|
2915
2910
|
cursor?: string | null;
|
2916
2911
|
}
|
2917
|
-
|
2912
|
+
interface QueryPostsResponse {
|
2918
2913
|
/** List of retrieved posts. */
|
2919
2914
|
posts?: Post[];
|
2920
2915
|
/** Details on the paged set of results returned. */
|
2921
2916
|
pagingMetadata?: PagingMetadataV2;
|
2922
2917
|
}
|
2923
|
-
|
2918
|
+
interface PagingMetadataV2 {
|
2924
2919
|
/** Number of items returned in the response. */
|
2925
2920
|
count?: number | null;
|
2926
2921
|
/** Offset that was requested. */
|
@@ -2932,7 +2927,7 @@ export interface PagingMetadataV2 {
|
|
2932
2927
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
2933
2928
|
cursors?: Cursors;
|
2934
2929
|
}
|
2935
|
-
|
2930
|
+
interface Cursors {
|
2936
2931
|
/**
|
2937
2932
|
* Cursor pointing to next page in the list of results.
|
2938
2933
|
* @maxLength 2000
|
@@ -2944,7 +2939,7 @@ export interface Cursors {
|
|
2944
2939
|
*/
|
2945
2940
|
prev?: string | null;
|
2946
2941
|
}
|
2947
|
-
|
2942
|
+
interface GetPostMetricsRequest {
|
2948
2943
|
/**
|
2949
2944
|
* Post ID to retrieve metrics for.
|
2950
2945
|
* @minLength 1
|
@@ -2952,11 +2947,11 @@ export interface GetPostMetricsRequest {
|
|
2952
2947
|
*/
|
2953
2948
|
postId: string;
|
2954
2949
|
}
|
2955
|
-
|
2950
|
+
interface GetPostMetricsResponse {
|
2956
2951
|
/** Retrieved post metrics. */
|
2957
2952
|
metrics?: Metrics;
|
2958
2953
|
}
|
2959
|
-
|
2954
|
+
interface BulkGetPostMetricsRequest {
|
2960
2955
|
/**
|
2961
2956
|
* Post IDs.
|
2962
2957
|
* @maxSize 500
|
@@ -2964,11 +2959,11 @@ export interface BulkGetPostMetricsRequest {
|
|
2964
2959
|
*/
|
2965
2960
|
postIds?: string[];
|
2966
2961
|
}
|
2967
|
-
|
2962
|
+
interface BulkGetPostMetricsResponse {
|
2968
2963
|
/** Map of post.id to metrics */
|
2969
2964
|
metrics?: Record<string, Metrics>;
|
2970
2965
|
}
|
2971
|
-
|
2966
|
+
interface ViewPostRequest {
|
2972
2967
|
/**
|
2973
2968
|
* Post ID.
|
2974
2969
|
* @minLength 1
|
@@ -2976,11 +2971,11 @@ export interface ViewPostRequest {
|
|
2976
2971
|
*/
|
2977
2972
|
postId?: string;
|
2978
2973
|
}
|
2979
|
-
|
2974
|
+
interface ViewPostResponse {
|
2980
2975
|
/** Total number of post views */
|
2981
2976
|
views?: number;
|
2982
2977
|
}
|
2983
|
-
|
2978
|
+
interface LikePostRequest {
|
2984
2979
|
/**
|
2985
2980
|
* Post ID.
|
2986
2981
|
* @minLength 1
|
@@ -2995,11 +2990,11 @@ export interface LikePostRequest {
|
|
2995
2990
|
*/
|
2996
2991
|
fieldsets?: PostFieldFieldWithLiterals[];
|
2997
2992
|
}
|
2998
|
-
|
2993
|
+
interface LikePostResponse {
|
2999
2994
|
/** Post info. */
|
3000
2995
|
post?: Post;
|
3001
2996
|
}
|
3002
|
-
|
2997
|
+
interface UnlikePostRequest {
|
3003
2998
|
/**
|
3004
2999
|
* Post ID.
|
3005
3000
|
* @minLength 1
|
@@ -3014,11 +3009,11 @@ export interface UnlikePostRequest {
|
|
3014
3009
|
*/
|
3015
3010
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3016
3011
|
}
|
3017
|
-
|
3012
|
+
interface UnlikePostResponse {
|
3018
3013
|
/** Post info. */
|
3019
3014
|
post?: Post;
|
3020
3015
|
}
|
3021
|
-
|
3016
|
+
interface PinPostRequest {
|
3022
3017
|
/**
|
3023
3018
|
* Post ID.
|
3024
3019
|
* @minLength 1
|
@@ -3033,11 +3028,11 @@ export interface PinPostRequest {
|
|
3033
3028
|
*/
|
3034
3029
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3035
3030
|
}
|
3036
|
-
|
3031
|
+
interface PinPostResponse {
|
3037
3032
|
/** Post info. */
|
3038
3033
|
post?: Post;
|
3039
3034
|
}
|
3040
|
-
|
3035
|
+
interface UnpinPostRequest {
|
3041
3036
|
/**
|
3042
3037
|
* Post ID.
|
3043
3038
|
* @minLength 1
|
@@ -3052,11 +3047,11 @@ export interface UnpinPostRequest {
|
|
3052
3047
|
*/
|
3053
3048
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3054
3049
|
}
|
3055
|
-
|
3050
|
+
interface UnpinPostResponse {
|
3056
3051
|
/** Post info. */
|
3057
3052
|
post?: Post;
|
3058
3053
|
}
|
3059
|
-
|
3054
|
+
interface ListPostsArchiveRequest {
|
3060
3055
|
/**
|
3061
3056
|
* Month
|
3062
3057
|
* @min 1
|
@@ -3093,7 +3088,7 @@ export interface ListPostsArchiveRequest {
|
|
3093
3088
|
*/
|
3094
3089
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3095
3090
|
}
|
3096
|
-
|
3091
|
+
interface ListPostsArchiveResponse {
|
3097
3092
|
/** List of posts. */
|
3098
3093
|
posts?: Post[];
|
3099
3094
|
/** Details on the paged set of results returned. */
|
@@ -3101,7 +3096,7 @@ export interface ListPostsArchiveResponse {
|
|
3101
3096
|
/** Details on the paged set of results returned. */
|
3102
3097
|
pagingMetadata?: PagingMetadataV2;
|
3103
3098
|
}
|
3104
|
-
|
3099
|
+
interface BulkGetPostReactionsRequest {
|
3105
3100
|
/**
|
3106
3101
|
* Post IDs.
|
3107
3102
|
* @maxSize 500
|
@@ -3109,18 +3104,18 @@ export interface BulkGetPostReactionsRequest {
|
|
3109
3104
|
*/
|
3110
3105
|
postIds?: string[];
|
3111
3106
|
}
|
3112
|
-
|
3107
|
+
interface BulkGetPostReactionsResponse {
|
3113
3108
|
/** Map of post.id to reactions */
|
3114
3109
|
reactionsMap?: Record<string, Reactions>;
|
3115
3110
|
}
|
3116
|
-
|
3111
|
+
interface Reactions {
|
3117
3112
|
/**
|
3118
3113
|
* Is post liked by the current user
|
3119
3114
|
* @readonly
|
3120
3115
|
*/
|
3121
3116
|
liked?: boolean;
|
3122
3117
|
}
|
3123
|
-
|
3118
|
+
interface ListDemoPostsRequest {
|
3124
3119
|
/**
|
3125
3120
|
* Whether to return only featured posts.
|
3126
3121
|
*
|
@@ -3207,35 +3202,35 @@ export interface ListDemoPostsRequest {
|
|
3207
3202
|
*/
|
3208
3203
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3209
3204
|
}
|
3210
|
-
|
3205
|
+
interface ListDemoPostsResponse {
|
3211
3206
|
/** List of posts. */
|
3212
3207
|
posts?: Post[];
|
3213
3208
|
/** Details on the paged set of results returned. */
|
3214
3209
|
metaData?: MetaData;
|
3215
3210
|
}
|
3216
|
-
|
3211
|
+
interface ConvertDraftJsToRichContentRequest {
|
3217
3212
|
/** DraftJs content to convert to Rich content. */
|
3218
3213
|
content?: Record<string, any> | null;
|
3219
3214
|
}
|
3220
|
-
|
3215
|
+
interface ConvertDraftJsToRichContentResponse {
|
3221
3216
|
/**
|
3222
3217
|
* Rich content converted from DraftJs content.
|
3223
3218
|
* @maxLength 2000000
|
3224
3219
|
*/
|
3225
3220
|
richContent?: string;
|
3226
3221
|
}
|
3227
|
-
|
3222
|
+
interface ConvertRichContentToDraftJsRequest {
|
3228
3223
|
/**
|
3229
3224
|
* Rich content to convert to DraftJs content.
|
3230
3225
|
* @maxLength 2000000
|
3231
3226
|
*/
|
3232
3227
|
richContent?: string;
|
3233
3228
|
}
|
3234
|
-
|
3229
|
+
interface ConvertRichContentToDraftJsResponse {
|
3235
3230
|
/** DraftJs content converted from Rich content. */
|
3236
3231
|
content?: Record<string, any> | null;
|
3237
3232
|
}
|
3238
|
-
|
3233
|
+
interface OldBlogMigratedEvent {
|
3239
3234
|
/**
|
3240
3235
|
* Instance id of new version of blog
|
3241
3236
|
* @format GUID
|
@@ -3247,7 +3242,7 @@ export interface OldBlogMigratedEvent {
|
|
3247
3242
|
*/
|
3248
3243
|
oldBlogInstanceId?: string;
|
3249
3244
|
}
|
3250
|
-
|
3245
|
+
interface BaseEventMetadata {
|
3251
3246
|
/**
|
3252
3247
|
* App instance ID.
|
3253
3248
|
* @format GUID
|
@@ -3261,7 +3256,7 @@ export interface BaseEventMetadata {
|
|
3261
3256
|
/** The identification type and identity data. */
|
3262
3257
|
identity?: IdentificationData;
|
3263
3258
|
}
|
3264
|
-
|
3259
|
+
interface EventMetadata extends BaseEventMetadata {
|
3265
3260
|
/**
|
3266
3261
|
* Unique event ID.
|
3267
3262
|
* Allows clients to ignore duplicate webhooks.
|
@@ -3299,139 +3294,27 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
3299
3294
|
*/
|
3300
3295
|
entityEventSequence?: string | null;
|
3301
3296
|
}
|
3302
|
-
|
3297
|
+
interface PostCreatedEnvelope {
|
3303
3298
|
entity: Post;
|
3304
3299
|
metadata: EventMetadata;
|
3305
3300
|
}
|
3306
|
-
|
3307
|
-
* Triggered when a post is created.
|
3308
|
-
* @permissionScope Read Blog
|
3309
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3310
|
-
* @permissionScope Manage Blog
|
3311
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3312
|
-
* @permissionScope Manage Blog
|
3313
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3314
|
-
* @permissionScope Read Draft Blog Posts
|
3315
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3316
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3317
|
-
* @webhook
|
3318
|
-
* @eventType wix.blog.v3.post_created
|
3319
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3320
|
-
* @slug created
|
3321
|
-
*/
|
3322
|
-
export declare function onPostCreated(handler: (event: PostCreatedEnvelope) => void | Promise<void>): void;
|
3323
|
-
export interface PostDeletedEnvelope {
|
3301
|
+
interface PostDeletedEnvelope {
|
3324
3302
|
entity: Post;
|
3325
3303
|
metadata: EventMetadata;
|
3326
3304
|
}
|
3327
|
-
|
3328
|
-
* Triggered when a post is deleted.
|
3329
|
-
* @permissionScope Read Blog
|
3330
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3331
|
-
* @permissionScope Manage Blog
|
3332
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3333
|
-
* @permissionScope Manage Blog
|
3334
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3335
|
-
* @permissionScope Read Draft Blog Posts
|
3336
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3337
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3338
|
-
* @webhook
|
3339
|
-
* @eventType wix.blog.v3.post_deleted
|
3340
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3341
|
-
* @slug deleted
|
3342
|
-
*/
|
3343
|
-
export declare function onPostDeleted(handler: (event: PostDeletedEnvelope) => void | Promise<void>): void;
|
3344
|
-
export interface PostLikedEnvelope {
|
3305
|
+
interface PostLikedEnvelope {
|
3345
3306
|
data: PostLiked;
|
3346
3307
|
metadata: EventMetadata;
|
3347
3308
|
}
|
3348
|
-
|
3349
|
-
* Triggered when a post is liked.
|
3350
|
-
* @permissionScope Read Blog
|
3351
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3352
|
-
* @permissionScope Manage Blog
|
3353
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3354
|
-
* @permissionScope Manage Blog
|
3355
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3356
|
-
* @permissionScope Read Draft Blog Posts
|
3357
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3358
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3359
|
-
* @webhook
|
3360
|
-
* @eventType wix.blog.v3.post_liked
|
3361
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3362
|
-
* @slug liked
|
3363
|
-
*/
|
3364
|
-
export declare function onPostLiked(handler: (event: PostLikedEnvelope) => void | Promise<void>): void;
|
3365
|
-
export interface PostUnlikedEnvelope {
|
3309
|
+
interface PostUnlikedEnvelope {
|
3366
3310
|
data: PostUnliked;
|
3367
3311
|
metadata: EventMetadata;
|
3368
3312
|
}
|
3369
|
-
|
3370
|
-
* Triggered when a post is unliked.
|
3371
|
-
* @permissionScope Read Blog
|
3372
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3373
|
-
* @permissionScope Manage Blog
|
3374
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3375
|
-
* @permissionScope Manage Blog
|
3376
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3377
|
-
* @permissionScope Read Draft Blog Posts
|
3378
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3379
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3380
|
-
* @webhook
|
3381
|
-
* @eventType wix.blog.v3.post_unliked
|
3382
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3383
|
-
* @slug unliked
|
3384
|
-
*/
|
3385
|
-
export declare function onPostUnliked(handler: (event: PostUnlikedEnvelope) => void | Promise<void>): void;
|
3386
|
-
export interface PostUpdatedEnvelope {
|
3313
|
+
interface PostUpdatedEnvelope {
|
3387
3314
|
entity: Post;
|
3388
3315
|
metadata: EventMetadata;
|
3389
3316
|
}
|
3390
|
-
|
3391
|
-
* Triggered when a post is updated.
|
3392
|
-
* @permissionScope Read Blog
|
3393
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3394
|
-
* @permissionScope Manage Blog
|
3395
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3396
|
-
* @permissionScope Manage Blog
|
3397
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3398
|
-
* @permissionScope Read Draft Blog Posts
|
3399
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3400
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3401
|
-
* @webhook
|
3402
|
-
* @eventType wix.blog.v3.post_updated
|
3403
|
-
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
|
3404
|
-
* @slug updated
|
3405
|
-
*/
|
3406
|
-
export declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | Promise<void>): void;
|
3407
|
-
type PostNonNullablePaths = `_id` | `title` | `excerpt` | `slug` | `featured` | `pinned` | `categoryIds` | `coverMedia.enabled` | `coverMedia.displayed` | `coverMedia.custom` | `memberId` | `hashtags` | `commentingEnabled` | `minutesToRead` | `tagIds` | `relatedPostIds` | `pricingPlanIds` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `preview` | `moderationDetails.submittedBy` | `moderationDetails.status` | `media.embedMedia.thumbnail.url` | `media.embedMedia.thumbnail.width` | `media.embedMedia.thumbnail.height` | `media.embedMedia.video.url` | `media.embedMedia.video.width` | `media.embedMedia.video.height` | `media.displayed` | `media.custom` | `hasUnpublishedChanges`;
|
3408
|
-
/**
|
3409
|
-
* Retrieves the number of published posts per month within a specified time range.
|
3410
|
-
*
|
3411
|
-
*
|
3412
|
-
* The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
|
3413
|
-
*
|
3414
|
-
* 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.
|
3415
|
-
*
|
3416
|
-
* >**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.
|
3417
|
-
* @public
|
3418
|
-
* @param options - Options specifying time frame, sort, and filter.
|
3419
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3420
|
-
* @permissionScope Read Blog
|
3421
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3422
|
-
* @permissionScope Manage Blog
|
3423
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3424
|
-
* @permissionScope Manage Blog
|
3425
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3426
|
-
* @permissionScope Read Draft Blog Posts
|
3427
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3428
|
-
* @applicableIdentity APP
|
3429
|
-
* @applicableIdentity VISITOR
|
3430
|
-
* @returns Get Blog Post Count Stats response
|
3431
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.QueryPostCountStats
|
3432
|
-
*/
|
3433
|
-
export declare function queryPostCountStats(options?: QueryPostCountStatsOptions): Promise<NonNullablePaths<QueryPostCountStatsResponse, `stats` | `stats.${number}.postCount`>>;
|
3434
|
-
export interface QueryPostCountStatsOptions {
|
3317
|
+
interface QueryPostCountStatsOptions {
|
3435
3318
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
3436
3319
|
rangeStart?: Date | null;
|
3437
3320
|
/**
|
@@ -3462,25 +3345,7 @@ export interface QueryPostCountStatsOptions {
|
|
3462
3345
|
*/
|
3463
3346
|
timeZone?: string | null;
|
3464
3347
|
}
|
3465
|
-
|
3466
|
-
* Retrieves the total amount of published posts of the blog.
|
3467
|
-
* @public
|
3468
|
-
* @param options - Language Options.
|
3469
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3470
|
-
* @permissionScope Read Blog
|
3471
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3472
|
-
* @permissionScope Manage Blog
|
3473
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3474
|
-
* @permissionScope Manage Blog
|
3475
|
-
* @permissionScopeId SCOPE.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.BlogStatsService.GetTotalPosts
|
3481
|
-
*/
|
3482
|
-
export declare function getTotalPosts(options?: GetTotalPostsOptions): Promise<NonNullablePaths<GetTotalPostsResponse, `total`>>;
|
3483
|
-
export interface GetTotalPostsOptions {
|
3348
|
+
interface GetTotalPostsOptions {
|
3484
3349
|
/**
|
3485
3350
|
* Language filter.
|
3486
3351
|
*
|
@@ -3490,29 +3355,7 @@ export interface GetTotalPostsOptions {
|
|
3490
3355
|
*/
|
3491
3356
|
language?: string | null;
|
3492
3357
|
}
|
3493
|
-
|
3494
|
-
* Retrieves a post by the specified ID.
|
3495
|
-
* @param postId - Post ID.
|
3496
|
-
* @public
|
3497
|
-
* @requiredField postId
|
3498
|
-
* @param options - Options specifying which fields to return.
|
3499
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3500
|
-
* @permissionScope Read Blog
|
3501
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3502
|
-
* @permissionScope Manage Blog
|
3503
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3504
|
-
* @permissionScope Manage Blog
|
3505
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3506
|
-
* @permissionScope Read Draft Blog Posts
|
3507
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3508
|
-
* @applicableIdentity APP
|
3509
|
-
* @applicableIdentity VISITOR
|
3510
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
|
3511
|
-
*/
|
3512
|
-
export declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<GetPostResponse, {
|
3513
|
-
[P in PostNonNullablePaths]: `post.${P}`;
|
3514
|
-
}[PostNonNullablePaths]>>;
|
3515
|
-
export interface GetPostOptions {
|
3358
|
+
interface GetPostOptions {
|
3516
3359
|
/**
|
3517
3360
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3518
3361
|
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
@@ -3521,34 +3364,7 @@ export interface GetPostOptions {
|
|
3521
3364
|
*/
|
3522
3365
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3523
3366
|
}
|
3524
|
-
|
3525
|
-
* Retrieves a post with the provided slug.
|
3526
|
-
*
|
3527
|
-
* The slug is the end of a post's URL that refers to a specific post.
|
3528
|
-
* For example, if a post's URL is `https:/example.com/blog/post/my-post-slug`,
|
3529
|
-
* the slug is `my-post-slug`. The slug is case-sensitive, and is generally derived from the post title,
|
3530
|
-
* unless specified otherwise.
|
3531
|
-
* @param slug - Slug of the post to retrieve.
|
3532
|
-
* @public
|
3533
|
-
* @requiredField slug
|
3534
|
-
* @param options - Options specifying which fields to return.
|
3535
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3536
|
-
* @permissionScope Read Blog
|
3537
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3538
|
-
* @permissionScope Manage Blog
|
3539
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3540
|
-
* @permissionScope Manage Blog
|
3541
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3542
|
-
* @permissionScope Read Draft Blog Posts
|
3543
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3544
|
-
* @applicableIdentity APP
|
3545
|
-
* @applicableIdentity VISITOR
|
3546
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
|
3547
|
-
*/
|
3548
|
-
export declare function getPostBySlug(slug: string, options?: GetPostBySlugOptions): Promise<NonNullablePaths<GetPostBySlugResponse, {
|
3549
|
-
[P in PostNonNullablePaths]: `post.${P}`;
|
3550
|
-
}[PostNonNullablePaths]>>;
|
3551
|
-
export interface GetPostBySlugOptions {
|
3367
|
+
interface GetPostBySlugOptions {
|
3552
3368
|
/**
|
3553
3369
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3554
3370
|
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
@@ -3557,32 +3373,7 @@ export interface GetPostBySlugOptions {
|
|
3557
3373
|
*/
|
3558
3374
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3559
3375
|
}
|
3560
|
-
|
3561
|
-
* Retrieves a list of up to 100 published posts per request.
|
3562
|
-
*
|
3563
|
-
* List Posts runs with these defaults, which you can override:
|
3564
|
-
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
|
3565
|
-
* - `paging.limit` is `50`.
|
3566
|
-
* - `paging.offset` is `0`.
|
3567
|
-
* @public
|
3568
|
-
* @param options - Sort, filter, and paging options.
|
3569
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3570
|
-
* @permissionScope Read Blog
|
3571
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3572
|
-
* @permissionScope Manage Blog
|
3573
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3574
|
-
* @permissionScope Manage Blog
|
3575
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3576
|
-
* @permissionScope Read Draft Blog Posts
|
3577
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3578
|
-
* @applicableIdentity APP
|
3579
|
-
* @applicableIdentity VISITOR
|
3580
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
|
3581
|
-
*/
|
3582
|
-
export declare function listPosts(options?: ListPostsOptions): Promise<NonNullablePaths<ListPostsResponse, {
|
3583
|
-
[P in PostNonNullablePaths]: `posts.${number}.${P}`;
|
3584
|
-
}[PostNonNullablePaths] | `metaData.count` | `metaData.offset` | `metaData.total`>>;
|
3585
|
-
export interface ListPostsOptions {
|
3376
|
+
interface ListPostsOptions {
|
3586
3377
|
/**
|
3587
3378
|
* Whether to return only featured posts.
|
3588
3379
|
*
|
@@ -3646,42 +3437,7 @@ export interface ListPostsOptions {
|
|
3646
3437
|
*/
|
3647
3438
|
fieldsets?: PostFieldFieldWithLiterals[];
|
3648
3439
|
}
|
3649
|
-
|
3650
|
-
* Creates a query to retrieve a list of posts.
|
3651
|
-
*
|
3652
|
-
*
|
3653
|
-
* The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
|
3654
|
-
*
|
3655
|
-
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
3656
|
-
*
|
3657
|
-
* 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.
|
3658
|
-
*
|
3659
|
-
* `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
|
3660
|
-
* + `limit(50)`
|
3661
|
-
* + `descending('firstPublishedDate')`
|
3662
|
-
*
|
3663
|
-
* Note that the default limit is `'50'`, but the max limit is `'100'`.
|
3664
|
-
*
|
3665
|
-
* To learn how to query posts, refer to the table below.
|
3666
|
-
*
|
3667
|
-
* 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`.
|
3668
|
-
* @public
|
3669
|
-
* @param options - Options specifying which fields to return.
|
3670
|
-
* @permissionScope Read Blog
|
3671
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3672
|
-
* @permissionScope Manage Blog
|
3673
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3674
|
-
* @permissionScope Manage Blog
|
3675
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3676
|
-
* @permissionScope Read Draft Blog Posts
|
3677
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3678
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3679
|
-
* @applicableIdentity APP
|
3680
|
-
* @applicableIdentity VISITOR
|
3681
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
|
3682
|
-
*/
|
3683
|
-
export declare function queryPosts(options?: QueryPostsOptions): PostsQueryBuilder;
|
3684
|
-
export interface QueryPostsOptions {
|
3440
|
+
interface QueryPostsOptions {
|
3685
3441
|
/**
|
3686
3442
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3687
3443
|
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
@@ -3697,13 +3453,13 @@ interface QueryCursorResult {
|
|
3697
3453
|
length: number;
|
3698
3454
|
pageSize: number;
|
3699
3455
|
}
|
3700
|
-
|
3456
|
+
interface PostsQueryResult extends QueryCursorResult {
|
3701
3457
|
items: Post[];
|
3702
3458
|
query: PostsQueryBuilder;
|
3703
3459
|
next: () => Promise<PostsQueryResult>;
|
3704
3460
|
prev: () => Promise<PostsQueryResult>;
|
3705
3461
|
}
|
3706
|
-
|
3462
|
+
interface PostsQueryBuilder {
|
3707
3463
|
/** @param propertyName - Property whose value is compared with `value`.
|
3708
3464
|
* @param value - Value to compare against.
|
3709
3465
|
*/
|
@@ -3715,19 +3471,19 @@ export interface PostsQueryBuilder {
|
|
3715
3471
|
/** @param propertyName - Property whose value is compared with `value`.
|
3716
3472
|
* @param value - Value to compare against.
|
3717
3473
|
*/
|
3718
|
-
ge: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
|
3474
|
+
ge: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
|
3719
3475
|
/** @param propertyName - Property whose value is compared with `value`.
|
3720
3476
|
* @param value - Value to compare against.
|
3721
3477
|
*/
|
3722
|
-
gt: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
|
3478
|
+
gt: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
|
3723
3479
|
/** @param propertyName - Property whose value is compared with `value`.
|
3724
3480
|
* @param value - Value to compare against.
|
3725
3481
|
*/
|
3726
|
-
le: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
|
3482
|
+
le: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
|
3727
3483
|
/** @param propertyName - Property whose value is compared with `value`.
|
3728
3484
|
* @param value - Value to compare against.
|
3729
3485
|
*/
|
3730
|
-
lt: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
|
3486
|
+
lt: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
|
3731
3487
|
/** @param propertyName - Property whose value is compared with `string`.
|
3732
3488
|
* @param string - String to compare against. Case-insensitive.
|
3733
3489
|
*/
|
@@ -3752,25 +3508,5 @@ export interface PostsQueryBuilder {
|
|
3752
3508
|
skipTo: (cursor: string) => PostsQueryBuilder;
|
3753
3509
|
find: () => Promise<PostsQueryResult>;
|
3754
3510
|
}
|
3755
|
-
|
3756
|
-
|
3757
|
-
*
|
3758
|
-
* A post's metrics include the comments, likes, and views the post receives.
|
3759
|
-
* @param postId - Post ID to retrieve metrics for.
|
3760
|
-
* @public
|
3761
|
-
* @requiredField postId
|
3762
|
-
* @permissionId BLOG.READ-PUBLICATION
|
3763
|
-
* @permissionScope Read Blog
|
3764
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
|
3765
|
-
* @permissionScope Manage Blog
|
3766
|
-
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
|
3767
|
-
* @permissionScope Manage Blog
|
3768
|
-
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
3769
|
-
* @permissionScope Read Draft Blog Posts
|
3770
|
-
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
|
3771
|
-
* @applicableIdentity APP
|
3772
|
-
* @applicableIdentity VISITOR
|
3773
|
-
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostMetrics
|
3774
|
-
*/
|
3775
|
-
export declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`>>;
|
3776
|
-
export {};
|
3511
|
+
|
3512
|
+
export { Origin as $, Alignment as A, PollLayoutDirection as B, Crop as C, BackgroundType as D, DecorationType as E, FontType as F, type GetTotalPostsOptions as G, AppType as H, InitialExpandedItems as I, Direction as J, VerticalAlignment as K, type ListPostsOptions as L, MapType as M, NodeType as N, Orientation as O, type Post as P, type QueryPostCountStatsOptions as Q, NullValue as R, Source as S, Type as T, ModerationStatusStatus as U, ViewMode as V, WidthType as W, QueryPublicationsCountStatsRequestOrder as X, Order as Y, WebhookIdentityType as Z, GetPostTemplatesSort as _, type QueryPostCountStatsResponse as a, type PollSettings as a$, Status as a0, Field as a1, PostFieldField as a2, GetPostsSort as a3, SortOrder as a4, type CoverMedia as a5, type CoverMediaMediaOneOf as a6, type FocalPoint as a7, type PostCountInfo as a8, type Metrics as a9, type PDFSettings as aA, type GalleryData as aB, type V1Media as aC, type Image as aD, type Video as aE, type Item as aF, type ItemDataOneOf as aG, type GalleryOptions as aH, type Layout as aI, type ItemStyle as aJ, type Thumbnails as aK, type GIFData as aL, type GIF as aM, type HeadingData as aN, type HTMLData as aO, type HTMLDataDataOneOf as aP, type ImageData as aQ, type StylesBorder as aR, type ImageDataStyles as aS, type LinkPreviewData as aT, type LinkPreviewDataStyles as aU, type MapData as aV, type MapSettings as aW, type ParagraphData as aX, type PollData as aY, type Permissions as aZ, type Option as a_, type SeoSchema as aa, type Keyword as ab, type Tag as ac, type Settings as ad, type RichContent as ae, type Node as af, type NodeDataOneOf as ag, type NodeStyle as ah, type ButtonData as ai, type Border as aj, type Colors as ak, type PluginContainerData as al, type PluginContainerDataWidth as am, type PluginContainerDataWidthDataOneOf as an, type Spoiler as ao, type Height as ap, type Styles as aq, type Link as ar, type LinkDataOneOf as as, type Rel as at, type CodeBlockData as au, type TextStyle as av, type DividerData as aw, type FileData as ax, type FileSource as ay, type FileSourceDataOneOf as az, type GetTotalPostsResponse as b, type DomainEvent as b$, type PollLayout as b0, type OptionLayout as b1, type Gradient as b2, type Background as b3, type BackgroundBackgroundOneOf as b4, type PollDesign as b5, type OptionDesign as b6, type Poll as b7, type PollDataLayout as b8, type Design as b9, type BulletedListData as bA, type BlockquoteData as bB, type CaptionData as bC, type LayoutCellData as bD, type Metadata as bE, type DocumentStyle as bF, type TextNodeStyle as bG, type ModerationDetails as bH, type Media as bI, type MediaMediaOneOf as bJ, type WixMedia as bK, type VideoResolution as bL, type EmbedMedia as bM, type EmbedThumbnail as bN, type EmbedVideo as bO, type PostTranslation as bP, type PostCategoriesUpdated as bQ, type PostTagsUpdated as bR, type ScheduledPostPublished as bS, type QueryPublicationsCountStatsRequest as bT, type QueryPublicationsCountStatsResponse as bU, type PeriodPublicationsCount as bV, type QueryPostCountStatsRequest as bW, type PeriodPostCount as bX, type GetTotalPublicationsRequest as bY, type GetTotalPublicationsResponse as bZ, type GetTotalPostsRequest as b_, type TextData as ba, type Decoration as bb, type DecorationDataOneOf as bc, type AnchorData as bd, type ColorData as be, type LinkData as bf, type MentionData as bg, type FontSizeData as bh, type SpoilerData as bi, type AppEmbedData as bj, type AppEmbedDataAppDataOneOf as bk, type BookingData as bl, type EventData as bm, type VideoData as bn, type PlaybackOptions as bo, type EmbedData as bp, type Oembed as bq, type CollapsibleListData as br, type TableData as bs, type Dimensions as bt, type TableCellData as bu, type CellStyle as bv, type BorderColors as bw, type ListValue as bx, type AudioData as by, type OrderedListData as bz, type GetPostOptions as c, type ListDemoPostsResponse as c$, type DomainEventBodyOneOf as c0, type EntityCreatedEvent as c1, type RestoreInfo as c2, type EntityUpdatedEvent as c3, type EntityDeletedEvent as c4, type ActionEvent as c5, type MessageEnvelope as c6, type IdentificationData as c7, type IdentificationDataIdOneOf as c8, type ListTemplatesRequest as c9, type Sorting as cA, type PlatformQuery as cB, type PlatformQueryPagingMethodOneOf as cC, type Paging as cD, type CursorPaging as cE, type QueryPostsResponse as cF, type PagingMetadataV2 as cG, type Cursors as cH, type GetPostMetricsRequest as cI, type BulkGetPostMetricsRequest as cJ, type BulkGetPostMetricsResponse as cK, type ViewPostRequest as cL, type ViewPostResponse as cM, type LikePostRequest as cN, type LikePostResponse as cO, type UnlikePostRequest as cP, type UnlikePostResponse as cQ, type PinPostRequest as cR, type PinPostResponse as cS, type UnpinPostRequest as cT, type UnpinPostResponse as cU, type ListPostsArchiveRequest as cV, type ListPostsArchiveResponse as cW, type BulkGetPostReactionsRequest as cX, type BulkGetPostReactionsResponse as cY, type Reactions as cZ, type ListDemoPostsRequest as c_, type BlogPaging as ca, type ListTemplatesResponse as cb, type MetaData as cc, type Category as cd, type CategoryTranslation as ce, type GetTemplateRequest as cf, type GetTemplateResponse as cg, type CreateDraftPostFromTemplateRequest as ch, type CreateDraftPostFromTemplateResponse as ci, type DraftPost as cj, type DraftPostTranslation as ck, type GetTotalLikesPerMemberRequest as cl, type GetTotalLikesPerMemberResponse as cm, type PostLiked as cn, type PostLikedInitiatorOneOf as co, type PostUnliked as cp, type PostUnlikedInitiatorOneOf as cq, type PostCountersUpdated as cr, type PostCountersUpdatedInitiatorOneOf as cs, type PostOwnerChanged as ct, type InitialPostsCopied as cu, type GetPostRequest as cv, type GetPostResponse as cw, type GetPostBySlugRequest as cx, type ListPostsRequest as cy, type QueryPostsRequest as cz, type GetPostBySlugOptions as d, type ConvertDraftJsToRichContentRequest as d0, type ConvertDraftJsToRichContentResponse as d1, type ConvertRichContentToDraftJsRequest as d2, type ConvertRichContentToDraftJsResponse as d3, type OldBlogMigratedEvent as d4, type BaseEventMetadata as d5, type EventMetadata as d6, type PostsQueryResult as d7, type GetPostBySlugResponse as e, type ListPostsResponse as f, type QueryPostsOptions as g, type PostsQueryBuilder as h, type GetPostMetricsResponse as i, type PostCreatedEnvelope as j, type PostDeletedEnvelope as k, type PostLikedEnvelope as l, type PostUnlikedEnvelope as m, type PostUpdatedEnvelope as n, PluginContainerDataAlignment as o, Target as p, TextAlignment as q, LineStyle as r, Width as s, LayoutType as t, ThumbnailsAlignment as u, GIFType as v, Position as w, ViewRole as x, VoteRole as y, PollLayoutType as z };
|