@wix/auto_sdk_blog_posts 1.0.30 → 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 -554
- package/build/{es/src/blog-v3-post-posts.universal.d.ts → blog-v3-post-posts.universal-hTPKKRYx.d.ts} +299 -554
- 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 -554
- package/build/internal/{es/src/blog-v3-post-posts.universal.d.ts → blog-v3-post-posts.universal-D8MomLjA.d.ts} +299 -554
- 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 -59
- package/build/cjs/src/blog-v3-post-posts.http.js +0 -892
- package/build/cjs/src/blog-v3-post-posts.http.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.meta.d.ts +0 -25
- package/build/cjs/src/blog-v3-post-posts.meta.js +0 -161
- package/build/cjs/src/blog-v3-post-posts.meta.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.public.d.ts +0 -99
- package/build/cjs/src/blog-v3-post-posts.public.js +0 -320
- package/build/cjs/src/blog-v3-post-posts.public.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.types.js +0 -485
- package/build/cjs/src/blog-v3-post-posts.types.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.universal.js +0 -967
- package/build/cjs/src/blog-v3-post-posts.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/blog-v3-post-posts.context.d.ts +0 -37
- package/build/es/src/blog-v3-post-posts.context.js +0 -37
- package/build/es/src/blog-v3-post-posts.context.js.map +0 -1
- package/build/es/src/blog-v3-post-posts.http.d.ts +0 -59
- package/build/es/src/blog-v3-post-posts.http.js +0 -882
- package/build/es/src/blog-v3-post-posts.http.js.map +0 -1
- package/build/es/src/blog-v3-post-posts.meta.d.ts +0 -25
- package/build/es/src/blog-v3-post-posts.meta.js +0 -128
- package/build/es/src/blog-v3-post-posts.meta.js.map +0 -1
- package/build/es/src/blog-v3-post-posts.public.d.ts +0 -99
- package/build/es/src/blog-v3-post-posts.public.js +0 -268
- package/build/es/src/blog-v3-post-posts.public.js.map +0 -1
- package/build/es/src/blog-v3-post-posts.types.js +0 -482
- package/build/es/src/blog-v3-post-posts.types.js.map +0 -1
- package/build/es/src/blog-v3-post-posts.universal.js +0 -934
- package/build/es/src/blog-v3-post-posts.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.context.d.ts +0 -37
- package/build/internal/cjs/src/blog-v3-post-posts.context.js +0 -82
- package/build/internal/cjs/src/blog-v3-post-posts.context.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.http.d.ts +0 -59
- package/build/internal/cjs/src/blog-v3-post-posts.http.js +0 -892
- package/build/internal/cjs/src/blog-v3-post-posts.http.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.meta.d.ts +0 -25
- package/build/internal/cjs/src/blog-v3-post-posts.meta.js +0 -161
- package/build/internal/cjs/src/blog-v3-post-posts.meta.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.public.d.ts +0 -99
- package/build/internal/cjs/src/blog-v3-post-posts.public.js +0 -320
- package/build/internal/cjs/src/blog-v3-post-posts.public.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.types.js +0 -485
- package/build/internal/cjs/src/blog-v3-post-posts.types.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.universal.js +0 -967
- package/build/internal/cjs/src/blog-v3-post-posts.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.context.d.ts +0 -37
- package/build/internal/es/src/blog-v3-post-posts.context.js +0 -37
- package/build/internal/es/src/blog-v3-post-posts.context.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.http.d.ts +0 -59
- package/build/internal/es/src/blog-v3-post-posts.http.js +0 -882
- package/build/internal/es/src/blog-v3-post-posts.http.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.meta.d.ts +0 -25
- package/build/internal/es/src/blog-v3-post-posts.meta.js +0 -128
- package/build/internal/es/src/blog-v3-post-posts.meta.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.public.d.ts +0 -99
- package/build/internal/es/src/blog-v3-post-posts.public.js +0 -268
- package/build/internal/es/src/blog-v3-post-posts.public.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.types.js +0 -482
- package/build/internal/es/src/blog-v3-post-posts.types.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.universal.js +0 -934
- package/build/internal/es/src/blog-v3-post-posts.universal.js.map +0 -1
@@ -1,4 +1,6 @@
|
|
1
|
-
|
1
|
+
import { bW as QueryPostCountStatsRequest$1, a as QueryPostCountStatsResponse$1, b_ as GetTotalPostsRequest$1, b as GetTotalPostsResponse$1, cv as GetPostRequest$1, cw as GetPostResponse$1, cx as GetPostBySlugRequest$1, e as GetPostBySlugResponse$1, cy as ListPostsRequest$1, f as ListPostsResponse$1, cz as QueryPostsRequest$1, cF as QueryPostsResponse$1, cI as GetPostMetricsRequest$1, i as GetPostMetricsResponse$1 } from './blog-v3-post-posts.universal-hTPKKRYx.mjs';
|
2
|
+
|
3
|
+
interface Post {
|
2
4
|
/**
|
3
5
|
* Post ID.
|
4
6
|
* @readonly
|
@@ -167,13 +169,13 @@ export interface Post {
|
|
167
169
|
*/
|
168
170
|
referenceId?: string | null;
|
169
171
|
}
|
170
|
-
|
172
|
+
interface PageUrl {
|
171
173
|
/** The base URL. For premium sites, this is the domain. For free sites, this is the site URL. For example, `mysite.wixsite.com/mysite`. */
|
172
174
|
base?: string;
|
173
175
|
/** The relative path for the page within the site. For example, `/product-page/a-product`. */
|
174
176
|
path?: string;
|
175
177
|
}
|
176
|
-
|
178
|
+
interface CoverMedia extends CoverMediaMediaOneOf {
|
177
179
|
/** Image url. */
|
178
180
|
image?: Image;
|
179
181
|
/** Video url. */
|
@@ -199,13 +201,13 @@ export interface CoverMedia extends CoverMediaMediaOneOf {
|
|
199
201
|
altText?: string | null;
|
200
202
|
}
|
201
203
|
/** @oneof */
|
202
|
-
|
204
|
+
interface CoverMediaMediaOneOf {
|
203
205
|
/** Image url. */
|
204
206
|
image?: Image;
|
205
207
|
/** Video url. */
|
206
208
|
video?: Video;
|
207
209
|
}
|
208
|
-
|
210
|
+
interface Image {
|
209
211
|
/** WixMedia image ID. */
|
210
212
|
id?: string;
|
211
213
|
/** Image URL. */
|
@@ -228,18 +230,8 @@ export interface Image {
|
|
228
230
|
*/
|
229
231
|
filename?: string | null;
|
230
232
|
}
|
231
|
-
export interface FocalPoint {
|
232
|
-
/** X-coordinate of the focal point. */
|
233
|
-
x?: number;
|
234
|
-
/** Y-coordinate of the focal point. */
|
235
|
-
y?: number;
|
236
|
-
/** crop by height */
|
237
|
-
height?: number | null;
|
238
|
-
/** crop by width */
|
239
|
-
width?: number | null;
|
240
|
-
}
|
241
233
|
/** Deprecated - use VideoV2 */
|
242
|
-
|
234
|
+
interface Video {
|
243
235
|
/** WixMedia ID */
|
244
236
|
id?: string;
|
245
237
|
/** URL of video */
|
@@ -257,24 +249,7 @@ export interface Video {
|
|
257
249
|
/** Video poster */
|
258
250
|
thumbnail?: Image;
|
259
251
|
}
|
260
|
-
|
261
|
-
/**
|
262
|
-
* Total number of post comments
|
263
|
-
* @readonly
|
264
|
-
*/
|
265
|
-
comments?: number;
|
266
|
-
/**
|
267
|
-
* Total number of post likes
|
268
|
-
* @readonly
|
269
|
-
*/
|
270
|
-
likes?: number;
|
271
|
-
/**
|
272
|
-
* Total number of post views
|
273
|
-
* @readonly
|
274
|
-
*/
|
275
|
-
views?: number;
|
276
|
-
}
|
277
|
-
export interface Metrics {
|
252
|
+
interface Metrics {
|
278
253
|
/**
|
279
254
|
* Total number of post comments.
|
280
255
|
* @readonly
|
@@ -296,13 +271,13 @@ export interface Metrics {
|
|
296
271
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
297
272
|
* 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.
|
298
273
|
*/
|
299
|
-
|
274
|
+
interface SeoSchema {
|
300
275
|
/** SEO tag information. */
|
301
276
|
tags?: Tag[];
|
302
277
|
/** SEO general settings. */
|
303
278
|
settings?: Settings;
|
304
279
|
}
|
305
|
-
|
280
|
+
interface Keyword {
|
306
281
|
/** Keyword value. */
|
307
282
|
term?: string;
|
308
283
|
/** Whether the keyword is the main focus keyword. */
|
@@ -313,7 +288,7 @@ export interface Keyword {
|
|
313
288
|
*/
|
314
289
|
origin?: string | null;
|
315
290
|
}
|
316
|
-
|
291
|
+
interface Tag {
|
317
292
|
/**
|
318
293
|
* SEO tag type.
|
319
294
|
*
|
@@ -335,7 +310,7 @@ export interface Tag {
|
|
335
310
|
/** Whether the tag is disabled. */
|
336
311
|
disabled?: boolean;
|
337
312
|
}
|
338
|
-
|
313
|
+
interface Settings {
|
339
314
|
/**
|
340
315
|
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
341
316
|
*
|
@@ -349,7 +324,7 @@ export interface Settings {
|
|
349
324
|
*/
|
350
325
|
keywords?: Keyword[];
|
351
326
|
}
|
352
|
-
|
327
|
+
interface RichContent {
|
353
328
|
/** Node objects representing a rich content document. */
|
354
329
|
nodes?: Node[];
|
355
330
|
/** Object metadata. */
|
@@ -357,7 +332,7 @@ export interface RichContent {
|
|
357
332
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
358
333
|
documentStyle?: DocumentStyle;
|
359
334
|
}
|
360
|
-
|
335
|
+
interface Node extends NodeDataOneOf {
|
361
336
|
/** Data for a button node. */
|
362
337
|
buttonData?: ButtonData;
|
363
338
|
/** Data for a code block node. */
|
@@ -422,7 +397,7 @@ export interface Node extends NodeDataOneOf {
|
|
422
397
|
style?: NodeStyle;
|
423
398
|
}
|
424
399
|
/** @oneof */
|
425
|
-
|
400
|
+
interface NodeDataOneOf {
|
426
401
|
/** Data for a button node. */
|
427
402
|
buttonData?: ButtonData;
|
428
403
|
/** Data for a code block node. */
|
@@ -478,7 +453,7 @@ export interface NodeDataOneOf {
|
|
478
453
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
479
454
|
layoutCellData?: LayoutCellData;
|
480
455
|
}
|
481
|
-
|
456
|
+
declare enum NodeType {
|
482
457
|
PARAGRAPH = "PARAGRAPH",
|
483
458
|
TEXT = "TEXT",
|
484
459
|
HEADING = "HEADING",
|
@@ -515,8 +490,8 @@ export declare enum NodeType {
|
|
515
490
|
LAYOUT_CELL = "LAYOUT_CELL"
|
516
491
|
}
|
517
492
|
/** @enumType */
|
518
|
-
|
519
|
-
|
493
|
+
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';
|
494
|
+
interface NodeStyle {
|
520
495
|
/** The top padding value in pixels. */
|
521
496
|
paddingTop?: string | null;
|
522
497
|
/** The bottom padding value in pixels. */
|
@@ -524,7 +499,7 @@ export interface NodeStyle {
|
|
524
499
|
/** The background color as a hexadecimal value. */
|
525
500
|
backgroundColor?: string | null;
|
526
501
|
}
|
527
|
-
|
502
|
+
interface ButtonData {
|
528
503
|
/** Styling for the button's container. */
|
529
504
|
containerData?: PluginContainerData;
|
530
505
|
/** The button type. */
|
@@ -536,13 +511,13 @@ export interface ButtonData {
|
|
536
511
|
/** Button link details. */
|
537
512
|
link?: Link;
|
538
513
|
}
|
539
|
-
|
514
|
+
interface Border {
|
540
515
|
/** Border width in pixels. */
|
541
516
|
width?: number | null;
|
542
517
|
/** Border radius in pixels. */
|
543
518
|
radius?: number | null;
|
544
519
|
}
|
545
|
-
|
520
|
+
interface Colors {
|
546
521
|
/** The text color as a hexadecimal value. */
|
547
522
|
text?: string | null;
|
548
523
|
/** The border color as a hexadecimal value. */
|
@@ -550,7 +525,7 @@ export interface Colors {
|
|
550
525
|
/** The background color as a hexadecimal value. */
|
551
526
|
background?: string | null;
|
552
527
|
}
|
553
|
-
|
528
|
+
interface PluginContainerData {
|
554
529
|
/** The width of the node when it's displayed. */
|
555
530
|
width?: PluginContainerDataWidth;
|
556
531
|
/** The node's alignment within its container. */
|
@@ -562,7 +537,7 @@ export interface PluginContainerData {
|
|
562
537
|
/** 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`. */
|
563
538
|
textWrap?: boolean | null;
|
564
539
|
}
|
565
|
-
|
540
|
+
declare enum WidthType {
|
566
541
|
/** Width matches the content width */
|
567
542
|
CONTENT = "CONTENT",
|
568
543
|
/** Small Width */
|
@@ -573,8 +548,8 @@ export declare enum WidthType {
|
|
573
548
|
FULL_WIDTH = "FULL_WIDTH"
|
574
549
|
}
|
575
550
|
/** @enumType */
|
576
|
-
|
577
|
-
|
551
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
552
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
578
553
|
/**
|
579
554
|
* One of the following predefined width options:
|
580
555
|
* `CONTENT`: The width of the container matches the content width.
|
@@ -587,7 +562,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
587
562
|
custom?: string | null;
|
588
563
|
}
|
589
564
|
/** @oneof */
|
590
|
-
|
565
|
+
interface PluginContainerDataWidthDataOneOf {
|
591
566
|
/**
|
592
567
|
* One of the following predefined width options:
|
593
568
|
* `CONTENT`: The width of the container matches the content width.
|
@@ -599,7 +574,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
599
574
|
/** A custom width value in pixels. */
|
600
575
|
custom?: string | null;
|
601
576
|
}
|
602
|
-
|
577
|
+
declare enum PluginContainerDataAlignment {
|
603
578
|
/** Center Alignment */
|
604
579
|
CENTER = "CENTER",
|
605
580
|
/** Left Alignment */
|
@@ -608,8 +583,8 @@ export declare enum PluginContainerDataAlignment {
|
|
608
583
|
RIGHT = "RIGHT"
|
609
584
|
}
|
610
585
|
/** @enumType */
|
611
|
-
|
612
|
-
|
586
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
587
|
+
interface Spoiler {
|
613
588
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
614
589
|
enabled?: boolean | null;
|
615
590
|
/** The description displayed on top of the spoiler cover. */
|
@@ -617,25 +592,25 @@ export interface Spoiler {
|
|
617
592
|
/** The text for the button used to remove the spoiler cover. */
|
618
593
|
buttonText?: string | null;
|
619
594
|
}
|
620
|
-
|
595
|
+
interface Height {
|
621
596
|
/** A custom height value in pixels. */
|
622
597
|
custom?: string | null;
|
623
598
|
}
|
624
|
-
|
599
|
+
declare enum Type {
|
625
600
|
/** Regular link button */
|
626
601
|
LINK = "LINK",
|
627
602
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
628
603
|
ACTION = "ACTION"
|
629
604
|
}
|
630
605
|
/** @enumType */
|
631
|
-
|
632
|
-
|
606
|
+
type TypeWithLiterals = Type | 'LINK' | 'ACTION';
|
607
|
+
interface Styles {
|
633
608
|
/** Border attributes. */
|
634
609
|
border?: Border;
|
635
610
|
/** Color attributes. */
|
636
611
|
colors?: Colors;
|
637
612
|
}
|
638
|
-
|
613
|
+
interface Link extends LinkDataOneOf {
|
639
614
|
/** The absolute URL for the linked document. */
|
640
615
|
url?: string;
|
641
616
|
/** The target node's ID. Used for linking to another node in this object. */
|
@@ -654,13 +629,13 @@ export interface Link extends LinkDataOneOf {
|
|
654
629
|
customData?: string | null;
|
655
630
|
}
|
656
631
|
/** @oneof */
|
657
|
-
|
632
|
+
interface LinkDataOneOf {
|
658
633
|
/** The absolute URL for the linked document. */
|
659
634
|
url?: string;
|
660
635
|
/** The target node's ID. Used for linking to another node in this object. */
|
661
636
|
anchor?: string;
|
662
637
|
}
|
663
|
-
|
638
|
+
declare enum Target {
|
664
639
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
665
640
|
SELF = "SELF",
|
666
641
|
/** Opens the linked document in a new window or tab */
|
@@ -671,8 +646,8 @@ export declare enum Target {
|
|
671
646
|
TOP = "TOP"
|
672
647
|
}
|
673
648
|
/** @enumType */
|
674
|
-
|
675
|
-
|
649
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
650
|
+
interface Rel {
|
676
651
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
677
652
|
nofollow?: boolean | null;
|
678
653
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
@@ -682,17 +657,17 @@ export interface Rel {
|
|
682
657
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
683
658
|
noreferrer?: boolean | null;
|
684
659
|
}
|
685
|
-
|
660
|
+
interface CodeBlockData {
|
686
661
|
/** Styling for the code block's text. */
|
687
662
|
textStyle?: TextStyle;
|
688
663
|
}
|
689
|
-
|
664
|
+
interface TextStyle {
|
690
665
|
/** Text alignment. Defaults to `AUTO`. */
|
691
666
|
textAlignment?: TextAlignmentWithLiterals;
|
692
667
|
/** 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. */
|
693
668
|
lineHeight?: string | null;
|
694
669
|
}
|
695
|
-
|
670
|
+
declare enum TextAlignment {
|
696
671
|
/** browser default, eqivalent to `initial` */
|
697
672
|
AUTO = "AUTO",
|
698
673
|
/** Left align */
|
@@ -705,8 +680,8 @@ export declare enum TextAlignment {
|
|
705
680
|
JUSTIFY = "JUSTIFY"
|
706
681
|
}
|
707
682
|
/** @enumType */
|
708
|
-
|
709
|
-
|
683
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
684
|
+
interface DividerData {
|
710
685
|
/** Styling for the divider's container. */
|
711
686
|
containerData?: PluginContainerData;
|
712
687
|
/** Divider line style. */
|
@@ -716,7 +691,7 @@ export interface DividerData {
|
|
716
691
|
/** Divider alignment. */
|
717
692
|
alignment?: AlignmentWithLiterals;
|
718
693
|
}
|
719
|
-
|
694
|
+
declare enum LineStyle {
|
720
695
|
/** Single Line */
|
721
696
|
SINGLE = "SINGLE",
|
722
697
|
/** Double Line */
|
@@ -727,8 +702,8 @@ export declare enum LineStyle {
|
|
727
702
|
DOTTED = "DOTTED"
|
728
703
|
}
|
729
704
|
/** @enumType */
|
730
|
-
|
731
|
-
|
705
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
706
|
+
declare enum Width {
|
732
707
|
/** Large line */
|
733
708
|
LARGE = "LARGE",
|
734
709
|
/** Medium line */
|
@@ -737,8 +712,8 @@ export declare enum Width {
|
|
737
712
|
SMALL = "SMALL"
|
738
713
|
}
|
739
714
|
/** @enumType */
|
740
|
-
|
741
|
-
|
715
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
716
|
+
declare enum Alignment {
|
742
717
|
/** Center alignment */
|
743
718
|
CENTER = "CENTER",
|
744
719
|
/** Left alignment */
|
@@ -747,8 +722,8 @@ export declare enum Alignment {
|
|
747
722
|
RIGHT = "RIGHT"
|
748
723
|
}
|
749
724
|
/** @enumType */
|
750
|
-
|
751
|
-
|
725
|
+
type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
726
|
+
interface FileData {
|
752
727
|
/** Styling for the file's container. */
|
753
728
|
containerData?: PluginContainerData;
|
754
729
|
/** The source for the file's data. */
|
@@ -771,7 +746,7 @@ export interface FileData {
|
|
771
746
|
/** File size in KB. */
|
772
747
|
sizeInKb?: string | null;
|
773
748
|
}
|
774
|
-
|
749
|
+
declare enum ViewMode {
|
775
750
|
/** No PDF view */
|
776
751
|
NONE = "NONE",
|
777
752
|
/** Full PDF view */
|
@@ -780,8 +755,8 @@ export declare enum ViewMode {
|
|
780
755
|
MINI = "MINI"
|
781
756
|
}
|
782
757
|
/** @enumType */
|
783
|
-
|
784
|
-
|
758
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
759
|
+
interface FileSource extends FileSourceDataOneOf {
|
785
760
|
/** The absolute URL for the file's source. */
|
786
761
|
url?: string | null;
|
787
762
|
/**
|
@@ -795,7 +770,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
795
770
|
private?: boolean | null;
|
796
771
|
}
|
797
772
|
/** @oneof */
|
798
|
-
|
773
|
+
interface FileSourceDataOneOf {
|
799
774
|
/** The absolute URL for the file's source. */
|
800
775
|
url?: string | null;
|
801
776
|
/**
|
@@ -806,7 +781,7 @@ export interface FileSourceDataOneOf {
|
|
806
781
|
/** An ID that's resolved to a URL by a resolver function. */
|
807
782
|
id?: string | null;
|
808
783
|
}
|
809
|
-
|
784
|
+
interface PDFSettings {
|
810
785
|
/**
|
811
786
|
* PDF view mode. One of the following:
|
812
787
|
* `NONE` : The PDF isn't displayed.
|
@@ -819,7 +794,7 @@ export interface PDFSettings {
|
|
819
794
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
820
795
|
disablePrint?: boolean | null;
|
821
796
|
}
|
822
|
-
|
797
|
+
interface GalleryData {
|
823
798
|
/** Styling for the gallery's container. */
|
824
799
|
containerData?: PluginContainerData;
|
825
800
|
/** The items in the gallery. */
|
@@ -831,7 +806,7 @@ export interface GalleryData {
|
|
831
806
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
832
807
|
disableDownload?: boolean | null;
|
833
808
|
}
|
834
|
-
|
809
|
+
interface V1Media {
|
835
810
|
/** The source for the media's data. */
|
836
811
|
src?: FileSource;
|
837
812
|
/** Media width in pixels. */
|
@@ -841,19 +816,19 @@ export interface V1Media {
|
|
841
816
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
842
817
|
duration?: number | null;
|
843
818
|
}
|
844
|
-
|
819
|
+
interface ItemImage {
|
845
820
|
/** Image file details. */
|
846
821
|
media?: V1Media;
|
847
822
|
/** Link details for images that are links. */
|
848
823
|
link?: Link;
|
849
824
|
}
|
850
|
-
|
825
|
+
interface ItemVideo {
|
851
826
|
/** Video file details. */
|
852
827
|
media?: V1Media;
|
853
828
|
/** Video thumbnail file details. */
|
854
829
|
thumbnail?: V1Media;
|
855
830
|
}
|
856
|
-
|
831
|
+
interface Item extends ItemDataOneOf {
|
857
832
|
/** An image item. */
|
858
833
|
image?: ItemImage;
|
859
834
|
/** A video item. */
|
@@ -864,13 +839,13 @@ export interface Item extends ItemDataOneOf {
|
|
864
839
|
altText?: string | null;
|
865
840
|
}
|
866
841
|
/** @oneof */
|
867
|
-
|
842
|
+
interface ItemDataOneOf {
|
868
843
|
/** An image item. */
|
869
844
|
image?: ItemImage;
|
870
845
|
/** A video item. */
|
871
846
|
video?: ItemVideo;
|
872
847
|
}
|
873
|
-
|
848
|
+
interface GalleryOptions {
|
874
849
|
/** Gallery layout. */
|
875
850
|
layout?: Layout;
|
876
851
|
/** Styling for gallery items. */
|
@@ -878,7 +853,7 @@ export interface GalleryOptions {
|
|
878
853
|
/** Styling for gallery thumbnail images. */
|
879
854
|
thumbnails?: Thumbnails;
|
880
855
|
}
|
881
|
-
|
856
|
+
declare enum LayoutType {
|
882
857
|
/** Collage type */
|
883
858
|
COLLAGE = "COLLAGE",
|
884
859
|
/** Masonry type */
|
@@ -901,24 +876,24 @@ export declare enum LayoutType {
|
|
901
876
|
FULLSIZE = "FULLSIZE"
|
902
877
|
}
|
903
878
|
/** @enumType */
|
904
|
-
|
905
|
-
|
879
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
880
|
+
declare enum Orientation {
|
906
881
|
/** Rows Orientation */
|
907
882
|
ROWS = "ROWS",
|
908
883
|
/** Columns Orientation */
|
909
884
|
COLUMNS = "COLUMNS"
|
910
885
|
}
|
911
886
|
/** @enumType */
|
912
|
-
|
913
|
-
|
887
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
888
|
+
declare enum Crop {
|
914
889
|
/** Crop to fill */
|
915
890
|
FILL = "FILL",
|
916
891
|
/** Crop to fit */
|
917
892
|
FIT = "FIT"
|
918
893
|
}
|
919
894
|
/** @enumType */
|
920
|
-
|
921
|
-
|
895
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
896
|
+
declare enum ThumbnailsAlignment {
|
922
897
|
/** Top alignment */
|
923
898
|
TOP = "TOP",
|
924
899
|
/** Right alignment */
|
@@ -931,8 +906,8 @@ export declare enum ThumbnailsAlignment {
|
|
931
906
|
NONE = "NONE"
|
932
907
|
}
|
933
908
|
/** @enumType */
|
934
|
-
|
935
|
-
|
909
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
910
|
+
interface Layout {
|
936
911
|
/** Gallery layout type. */
|
937
912
|
type?: LayoutTypeWithLiterals;
|
938
913
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
@@ -944,7 +919,7 @@ export interface Layout {
|
|
944
919
|
/** The number of columns to display on mobile screens. */
|
945
920
|
mobileNumberOfColumns?: number | null;
|
946
921
|
}
|
947
|
-
|
922
|
+
interface ItemStyle {
|
948
923
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
949
924
|
targetSize?: number | null;
|
950
925
|
/** Item ratio */
|
@@ -954,13 +929,13 @@ export interface ItemStyle {
|
|
954
929
|
/** The spacing between items in pixels. */
|
955
930
|
spacing?: number | null;
|
956
931
|
}
|
957
|
-
|
932
|
+
interface Thumbnails {
|
958
933
|
/** Thumbnail alignment. */
|
959
934
|
placement?: ThumbnailsAlignmentWithLiterals;
|
960
935
|
/** Spacing between thumbnails in pixels. */
|
961
936
|
spacing?: number | null;
|
962
937
|
}
|
963
|
-
|
938
|
+
interface GIFData {
|
964
939
|
/** Styling for the GIF's container. */
|
965
940
|
containerData?: PluginContainerData;
|
966
941
|
/** The source of the full size GIF. */
|
@@ -974,7 +949,7 @@ export interface GIFData {
|
|
974
949
|
/** Type of GIF (Sticker or GIF). Defaults to `GIF`. */
|
975
950
|
gifType?: GIFTypeWithLiterals;
|
976
951
|
}
|
977
|
-
|
952
|
+
interface GIF {
|
978
953
|
/**
|
979
954
|
* GIF format URL.
|
980
955
|
* @format WEB_URL
|
@@ -991,13 +966,13 @@ export interface GIF {
|
|
991
966
|
*/
|
992
967
|
still?: string | null;
|
993
968
|
}
|
994
|
-
|
969
|
+
declare enum GIFType {
|
995
970
|
GIF = "GIF",
|
996
971
|
STICKER = "STICKER"
|
997
972
|
}
|
998
973
|
/** @enumType */
|
999
|
-
|
1000
|
-
|
974
|
+
type GIFTypeWithLiterals = GIFType | 'GIF' | 'STICKER';
|
975
|
+
interface HeadingData {
|
1001
976
|
/** Heading level from 1-6. */
|
1002
977
|
level?: number;
|
1003
978
|
/** Styling for the heading text. */
|
@@ -1005,7 +980,7 @@ export interface HeadingData {
|
|
1005
980
|
/** Indentation level from 1-4. */
|
1006
981
|
indentation?: number | null;
|
1007
982
|
}
|
1008
|
-
|
983
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
1009
984
|
/** The URL for the HTML code for the node. */
|
1010
985
|
url?: string;
|
1011
986
|
/** The HTML code for the node. */
|
@@ -1023,7 +998,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
1023
998
|
autoHeight?: boolean | null;
|
1024
999
|
}
|
1025
1000
|
/** @oneof */
|
1026
|
-
|
1001
|
+
interface HTMLDataDataOneOf {
|
1027
1002
|
/** The URL for the HTML code for the node. */
|
1028
1003
|
url?: string;
|
1029
1004
|
/** The HTML code for the node. */
|
@@ -1034,13 +1009,13 @@ export interface HTMLDataDataOneOf {
|
|
1034
1009
|
*/
|
1035
1010
|
isAdsense?: boolean | null;
|
1036
1011
|
}
|
1037
|
-
|
1012
|
+
declare enum Source {
|
1038
1013
|
HTML = "HTML",
|
1039
1014
|
ADSENSE = "ADSENSE"
|
1040
1015
|
}
|
1041
1016
|
/** @enumType */
|
1042
|
-
|
1043
|
-
|
1017
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
1018
|
+
interface ImageData {
|
1044
1019
|
/** Styling for the image's container. */
|
1045
1020
|
containerData?: PluginContainerData;
|
1046
1021
|
/** Image file details. */
|
@@ -1059,22 +1034,7 @@ export interface ImageData {
|
|
1059
1034
|
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
1060
1035
|
disableDownload?: boolean | null;
|
1061
1036
|
}
|
1062
|
-
|
1063
|
-
/** Border width in pixels. */
|
1064
|
-
width?: number | null;
|
1065
|
-
/**
|
1066
|
-
* Border color as a hexadecimal value.
|
1067
|
-
* @format COLOR_HEX
|
1068
|
-
*/
|
1069
|
-
color?: string | null;
|
1070
|
-
/** Border radius in pixels. */
|
1071
|
-
radius?: number | null;
|
1072
|
-
}
|
1073
|
-
export interface ImageDataStyles {
|
1074
|
-
/** Border attributes. */
|
1075
|
-
border?: StylesBorder;
|
1076
|
-
}
|
1077
|
-
export interface LinkPreviewData {
|
1037
|
+
interface LinkPreviewData {
|
1078
1038
|
/** Styling for the link preview's container. */
|
1079
1039
|
containerData?: PluginContainerData;
|
1080
1040
|
/** Link details. */
|
@@ -1088,58 +1048,13 @@ export interface LinkPreviewData {
|
|
1088
1048
|
/** The preview content as HTML. */
|
1089
1049
|
html?: string | null;
|
1090
1050
|
}
|
1091
|
-
|
1092
|
-
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
1093
|
-
START = "START",
|
1094
|
-
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
1095
|
-
END = "END",
|
1096
|
-
/** Thumbnail positioned at the top */
|
1097
|
-
TOP = "TOP",
|
1098
|
-
/** Thumbnail hidden and not displayed */
|
1099
|
-
HIDDEN = "HIDDEN"
|
1100
|
-
}
|
1101
|
-
/** @enumType */
|
1102
|
-
export type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
1103
|
-
export interface LinkPreviewDataStyles {
|
1104
|
-
/**
|
1105
|
-
* Background color as a hexadecimal value.
|
1106
|
-
* @format COLOR_HEX
|
1107
|
-
*/
|
1108
|
-
backgroundColor?: string | null;
|
1109
|
-
/**
|
1110
|
-
* Title color as a hexadecimal value.
|
1111
|
-
* @format COLOR_HEX
|
1112
|
-
*/
|
1113
|
-
titleColor?: string | null;
|
1114
|
-
/**
|
1115
|
-
* Subtitle color as a hexadecimal value.
|
1116
|
-
* @format COLOR_HEX
|
1117
|
-
*/
|
1118
|
-
subtitleColor?: string | null;
|
1119
|
-
/**
|
1120
|
-
* Link color as a hexadecimal value.
|
1121
|
-
* @format COLOR_HEX
|
1122
|
-
*/
|
1123
|
-
linkColor?: string | null;
|
1124
|
-
/** Border width in pixels. */
|
1125
|
-
borderWidth?: number | null;
|
1126
|
-
/** Border radius in pixels. */
|
1127
|
-
borderRadius?: number | null;
|
1128
|
-
/**
|
1129
|
-
* Border color as a hexadecimal value.
|
1130
|
-
* @format COLOR_HEX
|
1131
|
-
*/
|
1132
|
-
borderColor?: string | null;
|
1133
|
-
/** Position of thumbnail. Defaults to `START`. */
|
1134
|
-
thumbnailPosition?: PositionWithLiterals;
|
1135
|
-
}
|
1136
|
-
export interface MapData {
|
1051
|
+
interface MapData {
|
1137
1052
|
/** Styling for the map's container. */
|
1138
1053
|
containerData?: PluginContainerData;
|
1139
1054
|
/** Map settings. */
|
1140
1055
|
mapSettings?: MapSettings;
|
1141
1056
|
}
|
1142
|
-
|
1057
|
+
interface MapSettings {
|
1143
1058
|
/** The address to display on the map. */
|
1144
1059
|
address?: string | null;
|
1145
1060
|
/** Sets whether the map is draggable. */
|
@@ -1163,7 +1078,7 @@ export interface MapSettings {
|
|
1163
1078
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
1164
1079
|
mapType?: MapTypeWithLiterals;
|
1165
1080
|
}
|
1166
|
-
|
1081
|
+
declare enum MapType {
|
1167
1082
|
/** Roadmap map type */
|
1168
1083
|
ROADMAP = "ROADMAP",
|
1169
1084
|
/** Satellite map type */
|
@@ -1174,8 +1089,8 @@ export declare enum MapType {
|
|
1174
1089
|
TERRAIN = "TERRAIN"
|
1175
1090
|
}
|
1176
1091
|
/** @enumType */
|
1177
|
-
|
1178
|
-
|
1092
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
1093
|
+
interface ParagraphData {
|
1179
1094
|
/** Styling for the paragraph text. */
|
1180
1095
|
textStyle?: TextStyle;
|
1181
1096
|
/** Indentation level from 1-4. */
|
@@ -1183,7 +1098,7 @@ export interface ParagraphData {
|
|
1183
1098
|
/** Paragraph level */
|
1184
1099
|
level?: number | null;
|
1185
1100
|
}
|
1186
|
-
|
1101
|
+
interface PollData {
|
1187
1102
|
/** Styling for the poll's container. */
|
1188
1103
|
containerData?: PluginContainerData;
|
1189
1104
|
/** Poll data. */
|
@@ -1193,7 +1108,7 @@ export interface PollData {
|
|
1193
1108
|
/** Styling for the poll and voting options. */
|
1194
1109
|
design?: Design;
|
1195
1110
|
}
|
1196
|
-
|
1111
|
+
declare enum ViewRole {
|
1197
1112
|
/** Only Poll creator can view the results */
|
1198
1113
|
CREATOR = "CREATOR",
|
1199
1114
|
/** Anyone who voted can see the results */
|
@@ -1202,16 +1117,16 @@ export declare enum ViewRole {
|
|
1202
1117
|
EVERYONE = "EVERYONE"
|
1203
1118
|
}
|
1204
1119
|
/** @enumType */
|
1205
|
-
|
1206
|
-
|
1120
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
1121
|
+
declare enum VoteRole {
|
1207
1122
|
/** Logged in member */
|
1208
1123
|
SITE_MEMBERS = "SITE_MEMBERS",
|
1209
1124
|
/** Anyone */
|
1210
1125
|
ALL = "ALL"
|
1211
1126
|
}
|
1212
1127
|
/** @enumType */
|
1213
|
-
|
1214
|
-
|
1128
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
1129
|
+
interface Permissions {
|
1215
1130
|
/** Sets who can view the poll results. */
|
1216
1131
|
view?: ViewRoleWithLiterals;
|
1217
1132
|
/** Sets who can vote. */
|
@@ -1219,7 +1134,7 @@ export interface Permissions {
|
|
1219
1134
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
1220
1135
|
allowMultipleVotes?: boolean | null;
|
1221
1136
|
}
|
1222
|
-
|
1137
|
+
interface Option {
|
1223
1138
|
/** Option ID. */
|
1224
1139
|
id?: string | null;
|
1225
1140
|
/** Option title. */
|
@@ -1227,7 +1142,7 @@ export interface Option {
|
|
1227
1142
|
/** The image displayed with the option. */
|
1228
1143
|
image?: V1Media;
|
1229
1144
|
}
|
1230
|
-
|
1145
|
+
interface PollSettings {
|
1231
1146
|
/** Permissions settings for voting. */
|
1232
1147
|
permissions?: Permissions;
|
1233
1148
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
@@ -1235,23 +1150,23 @@ export interface PollSettings {
|
|
1235
1150
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
1236
1151
|
showVotesCount?: boolean | null;
|
1237
1152
|
}
|
1238
|
-
|
1153
|
+
declare enum PollLayoutType {
|
1239
1154
|
/** List */
|
1240
1155
|
LIST = "LIST",
|
1241
1156
|
/** Grid */
|
1242
1157
|
GRID = "GRID"
|
1243
1158
|
}
|
1244
1159
|
/** @enumType */
|
1245
|
-
|
1246
|
-
|
1160
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
1161
|
+
declare enum PollLayoutDirection {
|
1247
1162
|
/** Left-to-right */
|
1248
1163
|
LTR = "LTR",
|
1249
1164
|
/** Right-to-left */
|
1250
1165
|
RTL = "RTL"
|
1251
1166
|
}
|
1252
1167
|
/** @enumType */
|
1253
|
-
|
1254
|
-
|
1168
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
1169
|
+
interface PollLayout {
|
1255
1170
|
/** The layout for displaying the voting options. */
|
1256
1171
|
type?: PollLayoutTypeWithLiterals;
|
1257
1172
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
@@ -1259,11 +1174,11 @@ export interface PollLayout {
|
|
1259
1174
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
1260
1175
|
enableImage?: boolean | null;
|
1261
1176
|
}
|
1262
|
-
|
1177
|
+
interface OptionLayout {
|
1263
1178
|
/** Sets whether to display option images. Defaults to `false`. */
|
1264
1179
|
enableImage?: boolean | null;
|
1265
1180
|
}
|
1266
|
-
|
1181
|
+
declare enum BackgroundType {
|
1267
1182
|
/** Color background type */
|
1268
1183
|
COLOR = "COLOR",
|
1269
1184
|
/** Image background type */
|
@@ -1272,8 +1187,8 @@ export declare enum BackgroundType {
|
|
1272
1187
|
GRADIENT = "GRADIENT"
|
1273
1188
|
}
|
1274
1189
|
/** @enumType */
|
1275
|
-
|
1276
|
-
|
1190
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
1191
|
+
interface Gradient {
|
1277
1192
|
/** The gradient angle in degrees. */
|
1278
1193
|
angle?: number | null;
|
1279
1194
|
/**
|
@@ -1287,7 +1202,7 @@ export interface Gradient {
|
|
1287
1202
|
*/
|
1288
1203
|
lastColor?: string | null;
|
1289
1204
|
}
|
1290
|
-
|
1205
|
+
interface Background extends BackgroundBackgroundOneOf {
|
1291
1206
|
/**
|
1292
1207
|
* The background color as a hexademical value.
|
1293
1208
|
* @format COLOR_HEX
|
@@ -1301,7 +1216,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
1301
1216
|
type?: BackgroundTypeWithLiterals;
|
1302
1217
|
}
|
1303
1218
|
/** @oneof */
|
1304
|
-
|
1219
|
+
interface BackgroundBackgroundOneOf {
|
1305
1220
|
/**
|
1306
1221
|
* The background color as a hexademical value.
|
1307
1222
|
* @format COLOR_HEX
|
@@ -1312,17 +1227,17 @@ export interface BackgroundBackgroundOneOf {
|
|
1312
1227
|
/** Details for a gradient background. */
|
1313
1228
|
gradient?: Gradient;
|
1314
1229
|
}
|
1315
|
-
|
1230
|
+
interface PollDesign {
|
1316
1231
|
/** Background styling. */
|
1317
1232
|
background?: Background;
|
1318
1233
|
/** Border radius in pixels. */
|
1319
1234
|
borderRadius?: number | null;
|
1320
1235
|
}
|
1321
|
-
|
1236
|
+
interface OptionDesign {
|
1322
1237
|
/** Border radius in pixels. */
|
1323
1238
|
borderRadius?: number | null;
|
1324
1239
|
}
|
1325
|
-
|
1240
|
+
interface Poll {
|
1326
1241
|
/** Poll ID. */
|
1327
1242
|
id?: string | null;
|
1328
1243
|
/** Poll title. */
|
@@ -1336,26 +1251,26 @@ export interface Poll {
|
|
1336
1251
|
/** The poll's permissions and display settings. */
|
1337
1252
|
settings?: PollSettings;
|
1338
1253
|
}
|
1339
|
-
|
1254
|
+
interface PollDataLayout {
|
1340
1255
|
/** Poll layout settings. */
|
1341
1256
|
poll?: PollLayout;
|
1342
1257
|
/** Voting otpions layout settings. */
|
1343
1258
|
options?: OptionLayout;
|
1344
1259
|
}
|
1345
|
-
|
1260
|
+
interface Design {
|
1346
1261
|
/** Styling for the poll. */
|
1347
1262
|
poll?: PollDesign;
|
1348
1263
|
/** Styling for voting options. */
|
1349
1264
|
options?: OptionDesign;
|
1350
1265
|
}
|
1351
|
-
|
1266
|
+
interface TextData {
|
1352
1267
|
/** The text to apply decorations to. */
|
1353
1268
|
text?: string;
|
1354
1269
|
/** The decorations to apply. */
|
1355
1270
|
decorations?: Decoration[];
|
1356
1271
|
}
|
1357
1272
|
/** Adds appearence changes to text */
|
1358
|
-
|
1273
|
+
interface Decoration extends DecorationDataOneOf {
|
1359
1274
|
/** Data for an anchor link decoration. */
|
1360
1275
|
anchorData?: AnchorData;
|
1361
1276
|
/** Data for a color decoration. */
|
@@ -1378,7 +1293,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
1378
1293
|
type?: DecorationTypeWithLiterals;
|
1379
1294
|
}
|
1380
1295
|
/** @oneof */
|
1381
|
-
|
1296
|
+
interface DecorationDataOneOf {
|
1382
1297
|
/** Data for an anchor link decoration. */
|
1383
1298
|
anchorData?: AnchorData;
|
1384
1299
|
/** Data for a color decoration. */
|
@@ -1398,7 +1313,7 @@ export interface DecorationDataOneOf {
|
|
1398
1313
|
/** Data for a spoiler decoration. */
|
1399
1314
|
spoilerData?: SpoilerData;
|
1400
1315
|
}
|
1401
|
-
|
1316
|
+
declare enum DecorationType {
|
1402
1317
|
BOLD = "BOLD",
|
1403
1318
|
ITALIC = "ITALIC",
|
1404
1319
|
UNDERLINE = "UNDERLINE",
|
@@ -1411,22 +1326,22 @@ export declare enum DecorationType {
|
|
1411
1326
|
EXTERNAL = "EXTERNAL"
|
1412
1327
|
}
|
1413
1328
|
/** @enumType */
|
1414
|
-
|
1415
|
-
|
1329
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL';
|
1330
|
+
interface AnchorData {
|
1416
1331
|
/** The target node's ID. */
|
1417
1332
|
anchor?: string;
|
1418
1333
|
}
|
1419
|
-
|
1334
|
+
interface ColorData {
|
1420
1335
|
/** The text's background color as a hexadecimal value. */
|
1421
1336
|
background?: string | null;
|
1422
1337
|
/** The text's foreground color as a hexadecimal value. */
|
1423
1338
|
foreground?: string | null;
|
1424
1339
|
}
|
1425
|
-
|
1340
|
+
interface LinkData {
|
1426
1341
|
/** Link details. */
|
1427
1342
|
link?: Link;
|
1428
1343
|
}
|
1429
|
-
|
1344
|
+
interface MentionData {
|
1430
1345
|
/** The mentioned user's name. */
|
1431
1346
|
name?: string;
|
1432
1347
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
@@ -1434,23 +1349,23 @@ export interface MentionData {
|
|
1434
1349
|
/** Mentioned user's ID. */
|
1435
1350
|
id?: string | null;
|
1436
1351
|
}
|
1437
|
-
|
1352
|
+
interface FontSizeData {
|
1438
1353
|
/** The units used for the font size. */
|
1439
1354
|
unit?: FontTypeWithLiterals;
|
1440
1355
|
/** Font size value. */
|
1441
1356
|
value?: number | null;
|
1442
1357
|
}
|
1443
|
-
|
1358
|
+
declare enum FontType {
|
1444
1359
|
PX = "PX",
|
1445
1360
|
EM = "EM"
|
1446
1361
|
}
|
1447
1362
|
/** @enumType */
|
1448
|
-
|
1449
|
-
|
1363
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
1364
|
+
interface SpoilerData {
|
1450
1365
|
/** Spoiler ID. */
|
1451
1366
|
id?: string | null;
|
1452
1367
|
}
|
1453
|
-
|
1368
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
1454
1369
|
/** Data for embedded Wix Bookings content. */
|
1455
1370
|
bookingData?: BookingData;
|
1456
1371
|
/** Data for embedded Wix Events content. */
|
@@ -1472,30 +1387,30 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1472
1387
|
image?: V1Media;
|
1473
1388
|
}
|
1474
1389
|
/** @oneof */
|
1475
|
-
|
1390
|
+
interface AppEmbedDataAppDataOneOf {
|
1476
1391
|
/** Data for embedded Wix Bookings content. */
|
1477
1392
|
bookingData?: BookingData;
|
1478
1393
|
/** Data for embedded Wix Events content. */
|
1479
1394
|
eventData?: EventData;
|
1480
1395
|
}
|
1481
|
-
|
1396
|
+
declare enum AppType {
|
1482
1397
|
PRODUCT = "PRODUCT",
|
1483
1398
|
EVENT = "EVENT",
|
1484
1399
|
BOOKING = "BOOKING"
|
1485
1400
|
}
|
1486
1401
|
/** @enumType */
|
1487
|
-
|
1488
|
-
|
1402
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
1403
|
+
interface BookingData {
|
1489
1404
|
/** Booking duration in minutes. */
|
1490
1405
|
durations?: string | null;
|
1491
1406
|
}
|
1492
|
-
|
1407
|
+
interface EventData {
|
1493
1408
|
/** Event schedule. */
|
1494
1409
|
scheduling?: string | null;
|
1495
1410
|
/** Event location. */
|
1496
1411
|
location?: string | null;
|
1497
1412
|
}
|
1498
|
-
|
1413
|
+
interface VideoData {
|
1499
1414
|
/** Styling for the video's container. */
|
1500
1415
|
containerData?: PluginContainerData;
|
1501
1416
|
/** Video details. */
|
@@ -1509,7 +1424,7 @@ export interface VideoData {
|
|
1509
1424
|
/** Video options. */
|
1510
1425
|
options?: PlaybackOptions;
|
1511
1426
|
}
|
1512
|
-
|
1427
|
+
interface PlaybackOptions {
|
1513
1428
|
/** Sets whether the media will automatically start playing. */
|
1514
1429
|
autoPlay?: boolean | null;
|
1515
1430
|
/** Sets whether media's will be looped. */
|
@@ -1517,7 +1432,7 @@ export interface PlaybackOptions {
|
|
1517
1432
|
/** Sets whether media's controls will be shown. */
|
1518
1433
|
showControls?: boolean | null;
|
1519
1434
|
}
|
1520
|
-
|
1435
|
+
interface EmbedData {
|
1521
1436
|
/** Styling for the oEmbed node's container. */
|
1522
1437
|
containerData?: PluginContainerData;
|
1523
1438
|
/** An [oEmbed](https://www.oembed.com) object. */
|
@@ -1525,7 +1440,7 @@ export interface EmbedData {
|
|
1525
1440
|
/** Origin asset source. */
|
1526
1441
|
src?: string | null;
|
1527
1442
|
}
|
1528
|
-
|
1443
|
+
interface Oembed {
|
1529
1444
|
/** The resource type. */
|
1530
1445
|
type?: string | null;
|
1531
1446
|
/** The width of the resource specified in the `url` property in pixels. */
|
@@ -1557,7 +1472,7 @@ export interface Oembed {
|
|
1557
1472
|
/** The oEmbed version number. This value must be `1.0`. */
|
1558
1473
|
version?: string | null;
|
1559
1474
|
}
|
1560
|
-
|
1475
|
+
interface CollapsibleListData {
|
1561
1476
|
/** Styling for the collapsible list's container. */
|
1562
1477
|
containerData?: PluginContainerData;
|
1563
1478
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
@@ -1569,7 +1484,7 @@ export interface CollapsibleListData {
|
|
1569
1484
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
1570
1485
|
isQapageData?: boolean | null;
|
1571
1486
|
}
|
1572
|
-
|
1487
|
+
declare enum InitialExpandedItems {
|
1573
1488
|
/** First item will be expended initally */
|
1574
1489
|
FIRST = "FIRST",
|
1575
1490
|
/** All items will expended initally */
|
@@ -1578,16 +1493,16 @@ export declare enum InitialExpandedItems {
|
|
1578
1493
|
NONE = "NONE"
|
1579
1494
|
}
|
1580
1495
|
/** @enumType */
|
1581
|
-
|
1582
|
-
|
1496
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
1497
|
+
declare enum Direction {
|
1583
1498
|
/** Left-to-right */
|
1584
1499
|
LTR = "LTR",
|
1585
1500
|
/** Right-to-left */
|
1586
1501
|
RTL = "RTL"
|
1587
1502
|
}
|
1588
1503
|
/** @enumType */
|
1589
|
-
|
1590
|
-
|
1504
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
1505
|
+
interface TableData {
|
1591
1506
|
/** Styling for the table's container. */
|
1592
1507
|
containerData?: PluginContainerData;
|
1593
1508
|
/** The table's dimensions. */
|
@@ -1602,7 +1517,7 @@ export interface TableData {
|
|
1602
1517
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
1603
1518
|
columnHeader?: boolean | null;
|
1604
1519
|
}
|
1605
|
-
|
1520
|
+
interface Dimensions {
|
1606
1521
|
/** An array representing relative width of each column in relation to the other columns. */
|
1607
1522
|
colsWidthRatio?: number[];
|
1608
1523
|
/** An array representing the height of each row in pixels. */
|
@@ -1610,13 +1525,13 @@ export interface Dimensions {
|
|
1610
1525
|
/** An array representing the minimum width of each column in pixels. */
|
1611
1526
|
colsMinWidth?: number[];
|
1612
1527
|
}
|
1613
|
-
|
1528
|
+
interface TableCellData {
|
1614
1529
|
/** Styling for the cell's background color and text alignment. */
|
1615
1530
|
cellStyle?: CellStyle;
|
1616
1531
|
/** The cell's border colors. */
|
1617
1532
|
borderColors?: BorderColors;
|
1618
1533
|
}
|
1619
|
-
|
1534
|
+
declare enum VerticalAlignment {
|
1620
1535
|
/** Top alignment */
|
1621
1536
|
TOP = "TOP",
|
1622
1537
|
/** Middle alignment */
|
@@ -1625,8 +1540,8 @@ export declare enum VerticalAlignment {
|
|
1625
1540
|
BOTTOM = "BOTTOM"
|
1626
1541
|
}
|
1627
1542
|
/** @enumType */
|
1628
|
-
|
1629
|
-
|
1543
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
1544
|
+
interface CellStyle {
|
1630
1545
|
/** Vertical alignment for the cell's text. */
|
1631
1546
|
verticalAlignment?: VerticalAlignmentWithLiterals;
|
1632
1547
|
/**
|
@@ -1635,7 +1550,7 @@ export interface CellStyle {
|
|
1635
1550
|
*/
|
1636
1551
|
backgroundColor?: string | null;
|
1637
1552
|
}
|
1638
|
-
|
1553
|
+
interface BorderColors {
|
1639
1554
|
/**
|
1640
1555
|
* Left border color as a hexadecimal value.
|
1641
1556
|
* @format COLOR_HEX
|
@@ -1657,28 +1572,7 @@ export interface BorderColors {
|
|
1657
1572
|
*/
|
1658
1573
|
bottom?: string | null;
|
1659
1574
|
}
|
1660
|
-
|
1661
|
-
* `NullValue` is a singleton enumeration to represent the null value for the
|
1662
|
-
* `Value` type union.
|
1663
|
-
*
|
1664
|
-
* The JSON representation for `NullValue` is JSON `null`.
|
1665
|
-
*/
|
1666
|
-
export declare enum NullValue {
|
1667
|
-
/** Null value. */
|
1668
|
-
NULL_VALUE = "NULL_VALUE"
|
1669
|
-
}
|
1670
|
-
/** @enumType */
|
1671
|
-
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
1672
|
-
/**
|
1673
|
-
* `ListValue` is a wrapper around a repeated field of values.
|
1674
|
-
*
|
1675
|
-
* The JSON representation for `ListValue` is JSON array.
|
1676
|
-
*/
|
1677
|
-
export interface ListValue {
|
1678
|
-
/** Repeated field of dynamically typed values. */
|
1679
|
-
values?: any[];
|
1680
|
-
}
|
1681
|
-
export interface AudioData {
|
1575
|
+
interface AudioData {
|
1682
1576
|
/** Styling for the audio node's container. */
|
1683
1577
|
containerData?: PluginContainerData;
|
1684
1578
|
/** Audio file details. */
|
@@ -1694,7 +1588,7 @@ export interface AudioData {
|
|
1694
1588
|
/** An HTML version of the audio node. */
|
1695
1589
|
html?: string | null;
|
1696
1590
|
}
|
1697
|
-
|
1591
|
+
interface OrderedListData {
|
1698
1592
|
/** Indentation level from 0-4. */
|
1699
1593
|
indentation?: number;
|
1700
1594
|
/** Offset level from 0-4. */
|
@@ -1702,24 +1596,24 @@ export interface OrderedListData {
|
|
1702
1596
|
/** List start number. */
|
1703
1597
|
start?: number | null;
|
1704
1598
|
}
|
1705
|
-
|
1599
|
+
interface BulletedListData {
|
1706
1600
|
/** Indentation level from 0-4. */
|
1707
1601
|
indentation?: number;
|
1708
1602
|
/** Offset level from 0-4. */
|
1709
1603
|
offset?: number | null;
|
1710
1604
|
}
|
1711
|
-
|
1605
|
+
interface BlockquoteData {
|
1712
1606
|
/** Indentation level from 1-4. */
|
1713
1607
|
indentation?: number;
|
1714
1608
|
}
|
1715
|
-
|
1609
|
+
interface CaptionData {
|
1716
1610
|
textStyle?: TextStyle;
|
1717
1611
|
}
|
1718
|
-
|
1612
|
+
interface LayoutCellData {
|
1719
1613
|
/** Size of the cell in 12 columns grid. */
|
1720
1614
|
colSpan?: number | null;
|
1721
1615
|
}
|
1722
|
-
|
1616
|
+
interface Metadata {
|
1723
1617
|
/** Schema version. */
|
1724
1618
|
version?: number;
|
1725
1619
|
/**
|
@@ -1736,7 +1630,7 @@ export interface Metadata {
|
|
1736
1630
|
/** Object ID. */
|
1737
1631
|
id?: string | null;
|
1738
1632
|
}
|
1739
|
-
|
1633
|
+
interface DocumentStyle {
|
1740
1634
|
/** Styling for H1 nodes. */
|
1741
1635
|
headerOne?: TextNodeStyle;
|
1742
1636
|
/** Styling for H2 nodes. */
|
@@ -1756,7 +1650,7 @@ export interface DocumentStyle {
|
|
1756
1650
|
/** Styling for code block nodes. */
|
1757
1651
|
codeBlock?: TextNodeStyle;
|
1758
1652
|
}
|
1759
|
-
|
1653
|
+
interface TextNodeStyle {
|
1760
1654
|
/** The decorations to apply to the node. */
|
1761
1655
|
decorations?: Decoration[];
|
1762
1656
|
/** Padding and background color for the node. */
|
@@ -1764,7 +1658,7 @@ export interface TextNodeStyle {
|
|
1764
1658
|
/** Line height for text in the node. */
|
1765
1659
|
lineHeight?: string | null;
|
1766
1660
|
}
|
1767
|
-
|
1661
|
+
interface ModerationDetails {
|
1768
1662
|
/**
|
1769
1663
|
* Member ID of the person submitting the draft post for review.
|
1770
1664
|
* @format GUID
|
@@ -1782,14 +1676,14 @@ export interface ModerationDetails {
|
|
1782
1676
|
/** Date the post was approved or rejected. */
|
1783
1677
|
moderationDate?: Date | null;
|
1784
1678
|
}
|
1785
|
-
|
1679
|
+
declare enum ModerationStatusStatus {
|
1786
1680
|
UNKNOWN = "UNKNOWN",
|
1787
1681
|
APPROVED = "APPROVED",
|
1788
1682
|
REJECTED = "REJECTED"
|
1789
1683
|
}
|
1790
1684
|
/** @enumType */
|
1791
|
-
|
1792
|
-
|
1685
|
+
type ModerationStatusStatusWithLiterals = ModerationStatusStatus | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
|
1686
|
+
interface Media extends MediaMediaOneOf {
|
1793
1687
|
/** Wix Media details. */
|
1794
1688
|
wixMedia?: WixMedia;
|
1795
1689
|
/** Embed media details. */
|
@@ -1806,19 +1700,19 @@ export interface Media extends MediaMediaOneOf {
|
|
1806
1700
|
altText?: string | null;
|
1807
1701
|
}
|
1808
1702
|
/** @oneof */
|
1809
|
-
|
1703
|
+
interface MediaMediaOneOf {
|
1810
1704
|
/** Wix Media details. */
|
1811
1705
|
wixMedia?: WixMedia;
|
1812
1706
|
/** Embed media details. */
|
1813
1707
|
embedMedia?: EmbedMedia;
|
1814
1708
|
}
|
1815
|
-
|
1709
|
+
interface WixMedia {
|
1816
1710
|
/** Image details. */
|
1817
1711
|
image?: Image;
|
1818
1712
|
/** Video details. */
|
1819
1713
|
videoV2?: VideoV2;
|
1820
1714
|
}
|
1821
|
-
|
1715
|
+
interface VideoV2 {
|
1822
1716
|
/** WixMedia ID. */
|
1823
1717
|
id?: string;
|
1824
1718
|
/**
|
@@ -1833,7 +1727,7 @@ export interface VideoV2 {
|
|
1833
1727
|
*/
|
1834
1728
|
filename?: string | null;
|
1835
1729
|
}
|
1836
|
-
|
1730
|
+
interface VideoResolution {
|
1837
1731
|
/** Video URL. */
|
1838
1732
|
url?: string;
|
1839
1733
|
/** Video height. */
|
@@ -1843,13 +1737,13 @@ export interface VideoResolution {
|
|
1843
1737
|
/** Video format for example, mp4, hls. */
|
1844
1738
|
format?: string;
|
1845
1739
|
}
|
1846
|
-
|
1740
|
+
interface EmbedMedia {
|
1847
1741
|
/** Thumbnail details. */
|
1848
1742
|
thumbnail?: EmbedThumbnail;
|
1849
1743
|
/** Video details. */
|
1850
1744
|
video?: EmbedVideo;
|
1851
1745
|
}
|
1852
|
-
|
1746
|
+
interface EmbedThumbnail {
|
1853
1747
|
/**
|
1854
1748
|
* Thumbnail url.
|
1855
1749
|
* @maxLength 2000
|
@@ -1860,7 +1754,7 @@ export interface EmbedThumbnail {
|
|
1860
1754
|
/** Thumbnail height. */
|
1861
1755
|
height?: number;
|
1862
1756
|
}
|
1863
|
-
|
1757
|
+
interface EmbedVideo {
|
1864
1758
|
/**
|
1865
1759
|
* Video url.
|
1866
1760
|
* @maxLength 2000
|
@@ -1871,117 +1765,8 @@ export interface EmbedVideo {
|
|
1871
1765
|
/** Video height. */
|
1872
1766
|
height?: number;
|
1873
1767
|
}
|
1874
|
-
export interface PostTranslation {
|
1875
|
-
/**
|
1876
|
-
* Post ID.
|
1877
|
-
* @format GUID
|
1878
|
-
*/
|
1879
|
-
id?: string;
|
1880
|
-
/**
|
1881
|
-
* Language the post is written in.
|
1882
|
-
* @format LANGUAGE_TAG
|
1883
|
-
*/
|
1884
|
-
language?: string | null;
|
1885
|
-
/**
|
1886
|
-
* Post slug. For example, 'post-slug'.
|
1887
|
-
* @maxLength 100
|
1888
|
-
*/
|
1889
|
-
slug?: string | null;
|
1890
|
-
/** SEO data. */
|
1891
|
-
seoData?: SeoSchema;
|
1892
|
-
/** Post URL. */
|
1893
|
-
url?: PageUrl;
|
1894
|
-
}
|
1895
|
-
export interface PostCategoriesUpdated {
|
1896
|
-
/**
|
1897
|
-
* ID of the post which counters were updated.
|
1898
|
-
* @format GUID
|
1899
|
-
*/
|
1900
|
-
postId?: string;
|
1901
|
-
/**
|
1902
|
-
* Current categories of the post.
|
1903
|
-
* @maxSize 10
|
1904
|
-
* @format GUID
|
1905
|
-
*/
|
1906
|
-
categories?: string[];
|
1907
|
-
/**
|
1908
|
-
* Previous categories of the post.
|
1909
|
-
* @maxSize 10
|
1910
|
-
* @format GUID
|
1911
|
-
*/
|
1912
|
-
previousCategories?: string[];
|
1913
|
-
}
|
1914
|
-
export interface PostTagsUpdated {
|
1915
|
-
/**
|
1916
|
-
* ID of the post which counters were updated.
|
1917
|
-
* @format GUID
|
1918
|
-
*/
|
1919
|
-
postId?: string;
|
1920
|
-
/**
|
1921
|
-
* Current tags of the post.
|
1922
|
-
* @maxSize 30
|
1923
|
-
* @format GUID
|
1924
|
-
*/
|
1925
|
-
tags?: string[];
|
1926
|
-
/**
|
1927
|
-
* Previous tags of the post.
|
1928
|
-
* @maxSize 30
|
1929
|
-
* @format GUID
|
1930
|
-
*/
|
1931
|
-
previousTags?: string[];
|
1932
|
-
}
|
1933
|
-
export interface ScheduledPostPublished {
|
1934
|
-
/**
|
1935
|
-
* ID of the scheduled post which was published.
|
1936
|
-
* @format GUID
|
1937
|
-
*/
|
1938
|
-
postId?: string;
|
1939
|
-
}
|
1940
|
-
/** Get Blog Publications Count Stats request */
|
1941
|
-
export interface QueryPublicationsCountStatsRequest {
|
1942
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1943
|
-
rangeStart?: Date | null;
|
1944
|
-
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1945
|
-
rangeEnd?: Date | null;
|
1946
|
-
/** Order of the returned results. */
|
1947
|
-
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
|
1948
|
-
/** Number of months to include in the response. */
|
1949
|
-
months?: number;
|
1950
|
-
/**
|
1951
|
-
* Language filter
|
1952
|
-
*
|
1953
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
1954
|
-
* @format LANGUAGE_TAG
|
1955
|
-
*/
|
1956
|
-
language?: string | null;
|
1957
|
-
/**
|
1958
|
-
* Timezone of the client.
|
1959
|
-
* @minLength 3
|
1960
|
-
* @maxLength 100
|
1961
|
-
*/
|
1962
|
-
timeZone?: string | null;
|
1963
|
-
}
|
1964
|
-
export declare enum QueryPublicationsCountStatsRequestOrder {
|
1965
|
-
UNKNOWN = "UNKNOWN",
|
1966
|
-
OLDEST = "OLDEST",
|
1967
|
-
NEWEST = "NEWEST"
|
1968
|
-
}
|
1969
|
-
/** @enumType */
|
1970
|
-
export type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
1971
|
-
/** Get Blog Publications Count Stats response */
|
1972
|
-
export interface QueryPublicationsCountStatsResponse {
|
1973
|
-
/** Chronologically ordered list of publications. */
|
1974
|
-
stats?: PeriodPublicationsCount[];
|
1975
|
-
}
|
1976
|
-
/** Publications count for a specific time period */
|
1977
|
-
export interface PeriodPublicationsCount {
|
1978
|
-
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1979
|
-
periodStart?: Date | null;
|
1980
|
-
/** Number of posts published during this month. */
|
1981
|
-
publicationsCount?: number;
|
1982
|
-
}
|
1983
1768
|
/** Get Blog Post Count Stats request */
|
1984
|
-
|
1769
|
+
interface QueryPostCountStatsRequest {
|
1985
1770
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1986
1771
|
rangeStart?: Date | null;
|
1987
1772
|
/**
|
@@ -2012,38 +1797,26 @@ export interface QueryPostCountStatsRequest {
|
|
2012
1797
|
*/
|
2013
1798
|
timeZone?: string | null;
|
2014
1799
|
}
|
2015
|
-
|
1800
|
+
declare enum Order {
|
2016
1801
|
UNKNOWN = "UNKNOWN",
|
2017
1802
|
OLDEST = "OLDEST",
|
2018
1803
|
NEWEST = "NEWEST"
|
2019
1804
|
}
|
2020
1805
|
/** @enumType */
|
2021
|
-
|
1806
|
+
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
|
2022
1807
|
/** Get Blog Post Count Stats response */
|
2023
|
-
|
1808
|
+
interface QueryPostCountStatsResponse {
|
2024
1809
|
/** List of published post counts by month. */
|
2025
1810
|
stats?: PeriodPostCount[];
|
2026
1811
|
}
|
2027
1812
|
/** Post count for a specific time period */
|
2028
|
-
|
1813
|
+
interface PeriodPostCount {
|
2029
1814
|
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
2030
1815
|
periodStart?: Date | null;
|
2031
1816
|
/** Number of posts published during this month. */
|
2032
1817
|
postCount?: number;
|
2033
1818
|
}
|
2034
|
-
|
2035
|
-
/**
|
2036
|
-
* Language filter
|
2037
|
-
* @minLength 2
|
2038
|
-
* @format LANGUAGE_TAG
|
2039
|
-
*/
|
2040
|
-
language?: string | null;
|
2041
|
-
}
|
2042
|
-
export interface GetTotalPublicationsResponse {
|
2043
|
-
/** Total amount of publications. */
|
2044
|
-
total?: number;
|
2045
|
-
}
|
2046
|
-
export interface GetTotalPostsRequest {
|
1819
|
+
interface GetTotalPostsRequest {
|
2047
1820
|
/**
|
2048
1821
|
* Language filter.
|
2049
1822
|
*
|
@@ -2053,182 +1826,11 @@ export interface GetTotalPostsRequest {
|
|
2053
1826
|
*/
|
2054
1827
|
language?: string | null;
|
2055
1828
|
}
|
2056
|
-
|
1829
|
+
interface GetTotalPostsResponse {
|
2057
1830
|
/** Total amount of published posts. */
|
2058
1831
|
total?: number;
|
2059
1832
|
}
|
2060
|
-
|
2061
|
-
createdEvent?: EntityCreatedEvent;
|
2062
|
-
updatedEvent?: EntityUpdatedEvent;
|
2063
|
-
deletedEvent?: EntityDeletedEvent;
|
2064
|
-
actionEvent?: ActionEvent;
|
2065
|
-
/**
|
2066
|
-
* Unique event ID.
|
2067
|
-
* Allows clients to ignore duplicate webhooks.
|
2068
|
-
*/
|
2069
|
-
id?: string;
|
2070
|
-
/**
|
2071
|
-
* Assumes actions are also always typed to an entity_type
|
2072
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
2073
|
-
*/
|
2074
|
-
entityFqdn?: string;
|
2075
|
-
/**
|
2076
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
2077
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
2078
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
2079
|
-
*/
|
2080
|
-
slug?: string;
|
2081
|
-
/** ID of the entity associated with the event. */
|
2082
|
-
entityId?: string;
|
2083
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
2084
|
-
eventTime?: Date | null;
|
2085
|
-
/**
|
2086
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
2087
|
-
* (for example, GDPR).
|
2088
|
-
*/
|
2089
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
2090
|
-
/** If present, indicates the action that triggered the event. */
|
2091
|
-
originatedFrom?: string | null;
|
2092
|
-
/**
|
2093
|
-
* A sequence number defining the order of updates to the underlying entity.
|
2094
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
2095
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
2096
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
2097
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
2098
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
2099
|
-
*/
|
2100
|
-
entityEventSequence?: string | null;
|
2101
|
-
}
|
2102
|
-
/** @oneof */
|
2103
|
-
export interface DomainEventBodyOneOf {
|
2104
|
-
createdEvent?: EntityCreatedEvent;
|
2105
|
-
updatedEvent?: EntityUpdatedEvent;
|
2106
|
-
deletedEvent?: EntityDeletedEvent;
|
2107
|
-
actionEvent?: ActionEvent;
|
2108
|
-
}
|
2109
|
-
export interface EntityCreatedEvent {
|
2110
|
-
entityAsJson?: string;
|
2111
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
2112
|
-
restoreInfo?: RestoreInfo;
|
2113
|
-
}
|
2114
|
-
export interface RestoreInfo {
|
2115
|
-
deletedDate?: Date | null;
|
2116
|
-
}
|
2117
|
-
export interface EntityUpdatedEvent {
|
2118
|
-
/**
|
2119
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
2120
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
2121
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
2122
|
-
*/
|
2123
|
-
currentEntityAsJson?: string;
|
2124
|
-
}
|
2125
|
-
export interface EntityDeletedEvent {
|
2126
|
-
/** Entity that was deleted */
|
2127
|
-
deletedEntityAsJson?: string | null;
|
2128
|
-
}
|
2129
|
-
export interface ActionEvent {
|
2130
|
-
bodyAsJson?: string;
|
2131
|
-
}
|
2132
|
-
export interface MessageEnvelope {
|
2133
|
-
/**
|
2134
|
-
* App instance ID.
|
2135
|
-
* @format GUID
|
2136
|
-
*/
|
2137
|
-
instanceId?: string | null;
|
2138
|
-
/**
|
2139
|
-
* Event type.
|
2140
|
-
* @maxLength 150
|
2141
|
-
*/
|
2142
|
-
eventType?: string;
|
2143
|
-
/** The identification type and identity data. */
|
2144
|
-
identity?: IdentificationData;
|
2145
|
-
/** Stringify payload. */
|
2146
|
-
data?: string;
|
2147
|
-
}
|
2148
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
2149
|
-
/**
|
2150
|
-
* ID of a site visitor that has not logged in to the site.
|
2151
|
-
* @format GUID
|
2152
|
-
*/
|
2153
|
-
anonymousVisitorId?: string;
|
2154
|
-
/**
|
2155
|
-
* ID of a site visitor that has logged in to the site.
|
2156
|
-
* @format GUID
|
2157
|
-
*/
|
2158
|
-
memberId?: string;
|
2159
|
-
/**
|
2160
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
2161
|
-
* @format GUID
|
2162
|
-
*/
|
2163
|
-
wixUserId?: string;
|
2164
|
-
/**
|
2165
|
-
* ID of an app.
|
2166
|
-
* @format GUID
|
2167
|
-
*/
|
2168
|
-
appId?: string;
|
2169
|
-
/** @readonly */
|
2170
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
2171
|
-
}
|
2172
|
-
/** @oneof */
|
2173
|
-
export interface IdentificationDataIdOneOf {
|
2174
|
-
/**
|
2175
|
-
* ID of a site visitor that has not logged in to the site.
|
2176
|
-
* @format GUID
|
2177
|
-
*/
|
2178
|
-
anonymousVisitorId?: string;
|
2179
|
-
/**
|
2180
|
-
* ID of a site visitor that has logged in to the site.
|
2181
|
-
* @format GUID
|
2182
|
-
*/
|
2183
|
-
memberId?: string;
|
2184
|
-
/**
|
2185
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
2186
|
-
* @format GUID
|
2187
|
-
*/
|
2188
|
-
wixUserId?: string;
|
2189
|
-
/**
|
2190
|
-
* ID of an app.
|
2191
|
-
* @format GUID
|
2192
|
-
*/
|
2193
|
-
appId?: string;
|
2194
|
-
}
|
2195
|
-
export declare enum WebhookIdentityType {
|
2196
|
-
UNKNOWN = "UNKNOWN",
|
2197
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
2198
|
-
MEMBER = "MEMBER",
|
2199
|
-
WIX_USER = "WIX_USER",
|
2200
|
-
APP = "APP"
|
2201
|
-
}
|
2202
|
-
/** @enumType */
|
2203
|
-
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
2204
|
-
export interface ListTemplatesRequest {
|
2205
|
-
/**
|
2206
|
-
* Filter post templates by given template category ids
|
2207
|
-
* @maxSize 50
|
2208
|
-
* @format GUID
|
2209
|
-
*/
|
2210
|
-
categoryIds?: string[];
|
2211
|
-
/**
|
2212
|
-
* Filter post templates by provided language
|
2213
|
-
* @format LANGUAGE_TAG
|
2214
|
-
*/
|
2215
|
-
language?: string | null;
|
2216
|
-
/** Returns post template categories when set to TRUE */
|
2217
|
-
listTemplateCategories?: boolean;
|
2218
|
-
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
2219
|
-
sort?: GetPostTemplatesSortWithLiterals;
|
2220
|
-
/** Pagination options. */
|
2221
|
-
paging?: BlogPaging;
|
2222
|
-
}
|
2223
|
-
export declare enum GetPostTemplatesSort {
|
2224
|
-
/** Sort by ascending publishing date. */
|
2225
|
-
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
2226
|
-
/** Sort by descending publishing date. */
|
2227
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
2228
|
-
}
|
2229
|
-
/** @enumType */
|
2230
|
-
export type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
|
2231
|
-
export interface BlogPaging {
|
1833
|
+
interface BlogPaging {
|
2232
1834
|
/**
|
2233
1835
|
* Number of items to skip in the current sort order.
|
2234
1836
|
*
|
@@ -2251,15 +1853,7 @@ export interface BlogPaging {
|
|
2251
1853
|
*/
|
2252
1854
|
cursor?: string | null;
|
2253
1855
|
}
|
2254
|
-
|
2255
|
-
/** Available post templates */
|
2256
|
-
postTemplates?: Post[];
|
2257
|
-
/** Details on the paged set of posts templates returned. */
|
2258
|
-
postTemplatesMetaData?: MetaData;
|
2259
|
-
/** Post template categories. This value is returned empty unless asked explicitly */
|
2260
|
-
templateCategories?: Category[];
|
2261
|
-
}
|
2262
|
-
export interface MetaData {
|
1856
|
+
interface MetaData {
|
2263
1857
|
/** Number of items returned in this response. */
|
2264
1858
|
count?: number;
|
2265
1859
|
/** Requested offset. */
|
@@ -2272,495 +1866,51 @@ export interface MetaData {
|
|
2272
1866
|
*/
|
2273
1867
|
cursor?: string | null;
|
2274
1868
|
}
|
2275
|
-
|
1869
|
+
interface GetPostRequest {
|
2276
1870
|
/**
|
2277
|
-
*
|
2278
|
-
* @
|
1871
|
+
* Post ID.
|
1872
|
+
* @minLength 1
|
2279
1873
|
* @maxLength 38
|
2280
1874
|
*/
|
2281
|
-
|
2282
|
-
/**
|
2283
|
-
* Category label. Displayed in the Category Menu.
|
2284
|
-
* @maxLength 35
|
2285
|
-
*/
|
2286
|
-
label?: string;
|
2287
|
-
/**
|
2288
|
-
* Number of posts in the category.
|
2289
|
-
* @readonly
|
2290
|
-
*/
|
2291
|
-
postCount?: number;
|
2292
|
-
/**
|
2293
|
-
* The `url` of the page that lists every post with the specified category.
|
2294
|
-
* @readonly
|
2295
|
-
*/
|
2296
|
-
url?: PageUrl;
|
1875
|
+
postId: string;
|
2297
1876
|
/**
|
2298
|
-
*
|
2299
|
-
*
|
1877
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
1878
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
1879
|
+
* only the post’s base fields are returned.
|
1880
|
+
* @maxSize 20
|
2300
1881
|
*/
|
2301
|
-
|
1882
|
+
fieldsets?: PostFieldFieldWithLiterals[];
|
1883
|
+
}
|
1884
|
+
declare enum PostFieldField {
|
1885
|
+
UNKNOWN = "UNKNOWN",
|
1886
|
+
/** Includes post URL when present. */
|
1887
|
+
URL = "URL",
|
1888
|
+
/** Includes post content text string when present. */
|
1889
|
+
CONTENT_TEXT = "CONTENT_TEXT",
|
1890
|
+
/** Includes post metrics when present. */
|
1891
|
+
METRICS = "METRICS",
|
1892
|
+
/** Includes SEO data. */
|
1893
|
+
SEO = "SEO",
|
1894
|
+
/** Includes post owner's contact ID. */
|
1895
|
+
CONTACT_ID = "CONTACT_ID",
|
1896
|
+
/** Includes post rich content. */
|
1897
|
+
RICH_CONTENT = "RICH_CONTENT",
|
1898
|
+
/** Includes post reference ID field. */
|
1899
|
+
REFERENCE_ID = "REFERENCE_ID"
|
1900
|
+
}
|
1901
|
+
/** @enumType */
|
1902
|
+
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
1903
|
+
interface GetPostResponse {
|
1904
|
+
/** Retrieved post info. */
|
1905
|
+
post?: Post;
|
1906
|
+
}
|
1907
|
+
interface GetPostBySlugRequest {
|
2302
1908
|
/**
|
2303
|
-
*
|
1909
|
+
* Slug of the post to retrieve.
|
1910
|
+
* @minLength 1
|
2304
1911
|
* @maxLength 200
|
2305
|
-
* @deprecated Category title.
|
2306
|
-
* @targetRemovalDate 2025-07-16
|
2307
1912
|
*/
|
2308
|
-
|
2309
|
-
/**
|
2310
|
-
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
2311
|
-
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
2312
|
-
*
|
2313
|
-
* Default: `-1`
|
2314
|
-
*/
|
2315
|
-
displayPosition?: number | null;
|
2316
|
-
/**
|
2317
|
-
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
2318
|
-
* @format GUID
|
2319
|
-
*/
|
2320
|
-
translationId?: string | null;
|
2321
|
-
/**
|
2322
|
-
* Category language.
|
2323
|
-
*
|
2324
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
2325
|
-
* @immutable
|
2326
|
-
*/
|
2327
|
-
language?: string | null;
|
2328
|
-
/**
|
2329
|
-
* Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`.
|
2330
|
-
* @maxLength 100
|
2331
|
-
*/
|
2332
|
-
slug?: string;
|
2333
|
-
/** SEO data. */
|
2334
|
-
seoData?: SeoSchema;
|
2335
|
-
/** Category cover image. */
|
2336
|
-
coverImage?: Image;
|
2337
|
-
/**
|
2338
|
-
* Date and time the Category was last updated.
|
2339
|
-
* @readonly
|
2340
|
-
*/
|
2341
|
-
updatedDate?: Date | null;
|
2342
|
-
}
|
2343
|
-
export interface CategoryTranslation {
|
2344
|
-
/**
|
2345
|
-
* Category ID.
|
2346
|
-
* @format GUID
|
2347
|
-
*/
|
2348
|
-
id?: string;
|
2349
|
-
/**
|
2350
|
-
* Label displayed in the categories menu on the site.
|
2351
|
-
* @maxLength 100
|
2352
|
-
*/
|
2353
|
-
label?: string | null;
|
2354
|
-
/**
|
2355
|
-
* Language of the category.
|
2356
|
-
* @format LANGUAGE_TAG
|
2357
|
-
*/
|
2358
|
-
language?: string | null;
|
2359
|
-
/** URL of this category page. */
|
2360
|
-
url?: PageUrl;
|
2361
|
-
}
|
2362
|
-
export interface GetTemplateRequest {
|
2363
|
-
/**
|
2364
|
-
* Post template id
|
2365
|
-
* @format GUID
|
2366
|
-
*/
|
2367
|
-
postTemplateId?: string;
|
2368
|
-
}
|
2369
|
-
export interface GetTemplateResponse {
|
2370
|
-
/** Post template */
|
2371
|
-
postTemplate?: Post;
|
2372
|
-
}
|
2373
|
-
export interface CreateDraftPostFromTemplateRequest {
|
2374
|
-
/**
|
2375
|
-
* Post template id
|
2376
|
-
* @format GUID
|
2377
|
-
*/
|
2378
|
-
postTemplateId?: string;
|
2379
|
-
}
|
2380
|
-
export interface CreateDraftPostFromTemplateResponse {
|
2381
|
-
/** Created draft post */
|
2382
|
-
draftPost?: DraftPost;
|
2383
|
-
}
|
2384
|
-
export interface DraftPost {
|
2385
|
-
/**
|
2386
|
-
* Draft post ID.
|
2387
|
-
* @readonly
|
2388
|
-
* @maxLength 38
|
2389
|
-
*/
|
2390
|
-
id?: string;
|
2391
|
-
/**
|
2392
|
-
* Draft post title.
|
2393
|
-
* @maxLength 200
|
2394
|
-
*/
|
2395
|
-
title?: string;
|
2396
|
-
/**
|
2397
|
-
* Draft post excerpt.
|
2398
|
-
*
|
2399
|
-
* If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
|
2400
|
-
* This can be retrieved using the `GENERATED_EXCERPT` fieldset.
|
2401
|
-
* @maxLength 500
|
2402
|
-
*/
|
2403
|
-
excerpt?: string | null;
|
2404
|
-
/** Whether the draft post is marked as featured. */
|
2405
|
-
featured?: boolean | null;
|
2406
|
-
/**
|
2407
|
-
* Category IDs of the draft post.
|
2408
|
-
* @maxSize 10
|
2409
|
-
* @maxLength 38
|
2410
|
-
*/
|
2411
|
-
categoryIds?: string[];
|
2412
|
-
/**
|
2413
|
-
* Draft post owner's member ID.
|
2414
|
-
* @format GUID
|
2415
|
-
*/
|
2416
|
-
memberId?: string | null;
|
2417
|
-
/**
|
2418
|
-
* Hashtags in the post.
|
2419
|
-
* @maxSize 100
|
2420
|
-
* @maxLength 100
|
2421
|
-
*/
|
2422
|
-
hashtags?: string[];
|
2423
|
-
/** Whether commenting on the draft post is enabled. */
|
2424
|
-
commentingEnabled?: boolean | null;
|
2425
|
-
/**
|
2426
|
-
* Estimated reading time of the draft post (calculated automatically).
|
2427
|
-
* @readonly
|
2428
|
-
*/
|
2429
|
-
minutesToRead?: number;
|
2430
|
-
/** Image placed at the top of the blog page. */
|
2431
|
-
heroImage?: Image;
|
2432
|
-
/**
|
2433
|
-
* Tag IDs the draft post is tagged with.
|
2434
|
-
* @maxSize 30
|
2435
|
-
* @maxLength 38
|
2436
|
-
*/
|
2437
|
-
tagIds?: string[];
|
2438
|
-
/**
|
2439
|
-
* IDs of posts related to this draft post.
|
2440
|
-
* @maxSize 3
|
2441
|
-
* @maxLength 38
|
2442
|
-
*/
|
2443
|
-
relatedPostIds?: string[];
|
2444
|
-
/**
|
2445
|
-
* Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
|
2446
|
-
* @maxSize 100
|
2447
|
-
* @format GUID
|
2448
|
-
*/
|
2449
|
-
pricingPlanIds?: string[];
|
2450
|
-
/**
|
2451
|
-
* ID of the draft post's translations.
|
2452
|
-
*
|
2453
|
-
* All translations of a single post share the same `translationId`.
|
2454
|
-
* Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
|
2455
|
-
* @format GUID
|
2456
|
-
*/
|
2457
|
-
translationId?: string | null;
|
2458
|
-
/**
|
2459
|
-
* Language the draft post is written in.
|
2460
|
-
*
|
2461
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
2462
|
-
* @format LANGUAGE_TAG
|
2463
|
-
*/
|
2464
|
-
language?: string | null;
|
2465
|
-
/**
|
2466
|
-
* Draft Post rich content.
|
2467
|
-
*
|
2468
|
-
* <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">
|
2469
|
-
* <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
|
2470
|
-
* </widget>
|
2471
|
-
*/
|
2472
|
-
richContent?: RichContent;
|
2473
|
-
/**
|
2474
|
-
* Status of the draft post.
|
2475
|
-
* @readonly
|
2476
|
-
*/
|
2477
|
-
status?: StatusWithLiterals;
|
2478
|
-
/** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
|
2479
|
-
moderationDetails?: ModerationDetails;
|
2480
|
-
/**
|
2481
|
-
* Indicates if there are changes made to the draft post that have not yet been published.
|
2482
|
-
* @readonly
|
2483
|
-
*/
|
2484
|
-
hasUnpublishedChanges?: boolean;
|
2485
|
-
/**
|
2486
|
-
* Date the draft post was last edited.
|
2487
|
-
* @readonly
|
2488
|
-
*/
|
2489
|
-
editedDate?: Date | null;
|
2490
|
-
/**
|
2491
|
-
* Date the draft post is scheduled to be published.
|
2492
|
-
* @readonly
|
2493
|
-
*/
|
2494
|
-
scheduledPublishDate?: Date | null;
|
2495
|
-
/** Date the post was first published. */
|
2496
|
-
firstPublishedDate?: Date | null;
|
2497
|
-
/** SEO data. */
|
2498
|
-
seoData?: SeoSchema;
|
2499
|
-
/**
|
2500
|
-
* Draft post URL preview. What the URL will look like once the post is published.
|
2501
|
-
* @readonly
|
2502
|
-
*/
|
2503
|
-
url?: PageUrl;
|
2504
|
-
/**
|
2505
|
-
* Date the draft post was first created.
|
2506
|
-
* @readonly
|
2507
|
-
*/
|
2508
|
-
createdDate?: Date | null;
|
2509
|
-
/**
|
2510
|
-
* SEO slug.
|
2511
|
-
* @maxLength 100
|
2512
|
-
*/
|
2513
|
-
seoSlug?: string | null;
|
2514
|
-
/** Post cover media. */
|
2515
|
-
media?: Media;
|
2516
|
-
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
2517
|
-
previewTextParagraph?: number | null;
|
2518
|
-
}
|
2519
|
-
export declare enum Origin {
|
2520
|
-
UNKNOWN = "UNKNOWN",
|
2521
|
-
/** Changed by admin */
|
2522
|
-
ADMIN = "ADMIN",
|
2523
|
-
/** Categories were changed */
|
2524
|
-
ADD_CATEGORIES = "ADD_CATEGORIES",
|
2525
|
-
/** Saved automatically */
|
2526
|
-
AUTO_SAVE = "AUTO_SAVE",
|
2527
|
-
/** Copied from template */
|
2528
|
-
COPY_TEMPLATE = "COPY_TEMPLATE",
|
2529
|
-
/** Imported */
|
2530
|
-
IMPORT = "IMPORT",
|
2531
|
-
/** Imported in bulk */
|
2532
|
-
IMPORT_BULK = "IMPORT_BULK",
|
2533
|
-
/** Imported with html import */
|
2534
|
-
IMPORT_HTML = "IMPORT_HTML",
|
2535
|
-
/** Patch import */
|
2536
|
-
IMPORT_PATCH = "IMPORT_PATCH",
|
2537
|
-
/** Changed language */
|
2538
|
-
LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
|
2539
|
-
/** Saved manually */
|
2540
|
-
MANUAL_SAVE = "MANUAL_SAVE",
|
2541
|
-
/** Affected by migration */
|
2542
|
-
MIGRATION = "MIGRATION",
|
2543
|
-
/** Affected by moderation */
|
2544
|
-
MODERATION = "MODERATION",
|
2545
|
-
/** Moved to trash */
|
2546
|
-
MOVE_TO_TRASH = "MOVE_TO_TRASH",
|
2547
|
-
/** Pricing plans were changed */
|
2548
|
-
PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
|
2549
|
-
/** Was provisioned */
|
2550
|
-
PROVISION = "PROVISION",
|
2551
|
-
/** Was published */
|
2552
|
-
PUBLISH = "PUBLISH",
|
2553
|
-
/** Owner was reassigned */
|
2554
|
-
REASSIGN_OWNER = "REASSIGN_OWNER",
|
2555
|
-
/** Was reblogged */
|
2556
|
-
REBLOG = "REBLOG",
|
2557
|
-
/** Was restored */
|
2558
|
-
RESTORE = "RESTORE",
|
2559
|
-
/** Reverted to draft */
|
2560
|
-
REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
|
2561
|
-
/** Was translated */
|
2562
|
-
TRANSLATION = "TRANSLATION",
|
2563
|
-
/** Was unpublished */
|
2564
|
-
UNPUBLISH = "UNPUBLISH",
|
2565
|
-
/** Was unscheduled */
|
2566
|
-
UNSCHEDULE = "UNSCHEDULE",
|
2567
|
-
/** New edit session started which updated editing_session_id id */
|
2568
|
-
NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
|
2569
|
-
/** Was scheduled by Later */
|
2570
|
-
SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
|
2571
|
-
/** Was unscheduled by Later */
|
2572
|
-
SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
|
2573
|
-
/** Was published by Later */
|
2574
|
-
SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
|
2575
|
-
/** Was scheduled */
|
2576
|
-
SCHEDULE = "SCHEDULE",
|
2577
|
-
/** Was removed from moderation */
|
2578
|
-
REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
|
2579
|
-
/** Was rejected from moderation */
|
2580
|
-
REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
|
2581
|
-
/** Was approved in moderation */
|
2582
|
-
APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
|
2583
|
-
/** Tag was deleted */
|
2584
|
-
DELETE_TAG = "DELETE_TAG",
|
2585
|
-
/** Post was pinned */
|
2586
|
-
PIN = "PIN",
|
2587
|
-
/** Post was unpinned */
|
2588
|
-
UNPIN = "UNPIN",
|
2589
|
-
/** Saved automatically by AI tool. */
|
2590
|
-
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
2591
|
-
}
|
2592
|
-
/** @enumType */
|
2593
|
-
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';
|
2594
|
-
export declare enum Status {
|
2595
|
-
UNKNOWN = "UNKNOWN",
|
2596
|
-
/** Status indicating the draft post is published. */
|
2597
|
-
PUBLISHED = "PUBLISHED",
|
2598
|
-
/** Status indicating the draft post is unpublished. */
|
2599
|
-
UNPUBLISHED = "UNPUBLISHED",
|
2600
|
-
/** Status indicating the draft post is scheduled for publication. */
|
2601
|
-
SCHEDULED = "SCHEDULED",
|
2602
|
-
/** Status indicating the draft post is deleted. */
|
2603
|
-
DELETED = "DELETED",
|
2604
|
-
/** Status indicating the draft post is in review. */
|
2605
|
-
IN_REVIEW = "IN_REVIEW"
|
2606
|
-
}
|
2607
|
-
/** @enumType */
|
2608
|
-
export type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
|
2609
|
-
export interface DraftPostTranslation {
|
2610
|
-
/**
|
2611
|
-
* Post ID.
|
2612
|
-
* @format GUID
|
2613
|
-
*/
|
2614
|
-
id?: string;
|
2615
|
-
/** Post status. */
|
2616
|
-
status?: StatusWithLiterals;
|
2617
|
-
/**
|
2618
|
-
* Language the post is written in.
|
2619
|
-
* @format LANGUAGE_TAG
|
2620
|
-
*/
|
2621
|
-
language?: string | null;
|
2622
|
-
/**
|
2623
|
-
* Post slug. For example, 'post-slug'.
|
2624
|
-
* @maxLength 100
|
2625
|
-
*/
|
2626
|
-
slug?: string | null;
|
2627
|
-
/** SEO data. */
|
2628
|
-
seoData?: SeoSchema;
|
2629
|
-
/** Post URL. */
|
2630
|
-
url?: PageUrl;
|
2631
|
-
}
|
2632
|
-
export interface GetTotalLikesPerMemberRequest {
|
2633
|
-
/**
|
2634
|
-
* Member ID.
|
2635
|
-
* @format GUID
|
2636
|
-
*/
|
2637
|
-
memberId?: string;
|
2638
|
-
}
|
2639
|
-
export interface GetTotalLikesPerMemberResponse {
|
2640
|
-
/** The total number of likes of the member. */
|
2641
|
-
total?: number;
|
2642
|
-
}
|
2643
|
-
export interface PostLiked extends PostLikedInitiatorOneOf {
|
2644
|
-
/**
|
2645
|
-
* Member ID of person who liked the post (only returned when the member was logged in when liking the post).
|
2646
|
-
* @format GUID
|
2647
|
-
*/
|
2648
|
-
memberId?: string | null;
|
2649
|
-
/**
|
2650
|
-
* Visitor ID of person who liked the post when they are not logged in.
|
2651
|
-
* @format GUID
|
2652
|
-
*/
|
2653
|
-
anonymousVisitorId?: string | null;
|
2654
|
-
/**
|
2655
|
-
* ID of the liked post.
|
2656
|
-
* @format GUID
|
2657
|
-
*/
|
2658
|
-
postId?: string;
|
2659
|
-
}
|
2660
|
-
/** @oneof */
|
2661
|
-
export interface PostLikedInitiatorOneOf {
|
2662
|
-
/**
|
2663
|
-
* Member ID of person who liked the post (only returned when the member was logged in when liking the post).
|
2664
|
-
* @format GUID
|
2665
|
-
*/
|
2666
|
-
memberId?: string | null;
|
2667
|
-
/**
|
2668
|
-
* Visitor ID of person who liked the post when they are not logged in.
|
2669
|
-
* @format GUID
|
2670
|
-
*/
|
2671
|
-
anonymousVisitorId?: string | null;
|
2672
|
-
}
|
2673
|
-
export interface PostUnliked extends PostUnlikedInitiatorOneOf {
|
2674
|
-
/**
|
2675
|
-
* Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
|
2676
|
-
* @format GUID
|
2677
|
-
*/
|
2678
|
-
memberId?: string | null;
|
2679
|
-
/**
|
2680
|
-
* Visitor ID of person who unliked the post when they are not logged in.
|
2681
|
-
* @format GUID
|
2682
|
-
*/
|
2683
|
-
anonymousVisitorId?: string | null;
|
2684
|
-
/**
|
2685
|
-
* ID of the unliked post.
|
2686
|
-
* @format GUID
|
2687
|
-
*/
|
2688
|
-
postId?: string;
|
2689
|
-
}
|
2690
|
-
/** @oneof */
|
2691
|
-
export interface PostUnlikedInitiatorOneOf {
|
2692
|
-
/**
|
2693
|
-
* Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
|
2694
|
-
* @format GUID
|
2695
|
-
*/
|
2696
|
-
memberId?: string | null;
|
2697
|
-
/**
|
2698
|
-
* Visitor ID of person who unliked the post when they are not logged in.
|
2699
|
-
* @format GUID
|
2700
|
-
*/
|
2701
|
-
anonymousVisitorId?: string | null;
|
2702
|
-
}
|
2703
|
-
export interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
2704
|
-
/**
|
2705
|
-
* Member ID of person who triggered the counter update
|
2706
|
-
* @format GUID
|
2707
|
-
*/
|
2708
|
-
memberId?: string | null;
|
2709
|
-
/**
|
2710
|
-
* Visitor ID if person that liked the post is not logged in
|
2711
|
-
* @format GUID
|
2712
|
-
*/
|
2713
|
-
anonymousVisitorId?: string | null;
|
2714
|
-
/**
|
2715
|
-
* ID of the post which counters were updated.
|
2716
|
-
* @format GUID
|
2717
|
-
*/
|
2718
|
-
postId?: string;
|
2719
|
-
/** Field of the updated counter. */
|
2720
|
-
updatedCounterField?: FieldWithLiterals;
|
2721
|
-
/** New counter value. */
|
2722
|
-
counter?: number;
|
2723
|
-
}
|
2724
|
-
/** @oneof */
|
2725
|
-
export interface PostCountersUpdatedInitiatorOneOf {
|
2726
|
-
/**
|
2727
|
-
* Member ID of person who triggered the counter update
|
2728
|
-
* @format GUID
|
2729
|
-
*/
|
2730
|
-
memberId?: string | null;
|
2731
|
-
/**
|
2732
|
-
* Visitor ID if person that liked the post is not logged in
|
2733
|
-
* @format GUID
|
2734
|
-
*/
|
2735
|
-
anonymousVisitorId?: string | null;
|
2736
|
-
}
|
2737
|
-
export declare enum Field {
|
2738
|
-
/** Undefined field. */
|
2739
|
-
UNKNOWN = "UNKNOWN",
|
2740
|
-
/** Total comments field. */
|
2741
|
-
TOTAL_COMMENTS = "TOTAL_COMMENTS",
|
2742
|
-
/** Like count field. */
|
2743
|
-
LIKE_COUNT = "LIKE_COUNT",
|
2744
|
-
/** View count field. */
|
2745
|
-
VIEW_COUNT = "VIEW_COUNT",
|
2746
|
-
/** Rating count field. */
|
2747
|
-
RATING_COUNT = "RATING_COUNT"
|
2748
|
-
}
|
2749
|
-
/** @enumType */
|
2750
|
-
export type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
|
2751
|
-
export interface PostOwnerChanged {
|
2752
|
-
}
|
2753
|
-
export interface InitialPostsCopied {
|
2754
|
-
/** Number of posts copied. */
|
2755
|
-
count?: number;
|
2756
|
-
}
|
2757
|
-
export interface GetPostRequest {
|
2758
|
-
/**
|
2759
|
-
* Post ID.
|
2760
|
-
* @minLength 1
|
2761
|
-
* @maxLength 38
|
2762
|
-
*/
|
2763
|
-
postId: string;
|
1913
|
+
slug: string;
|
2764
1914
|
/**
|
2765
1915
|
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
2766
1916
|
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
@@ -2769,49 +1919,11 @@ export interface GetPostRequest {
|
|
2769
1919
|
*/
|
2770
1920
|
fieldsets?: PostFieldFieldWithLiterals[];
|
2771
1921
|
}
|
2772
|
-
|
2773
|
-
UNKNOWN = "UNKNOWN",
|
2774
|
-
/** Includes post URL when present. */
|
2775
|
-
URL = "URL",
|
2776
|
-
/** Includes post content text string when present. */
|
2777
|
-
CONTENT_TEXT = "CONTENT_TEXT",
|
2778
|
-
/** Includes post metrics when present. */
|
2779
|
-
METRICS = "METRICS",
|
2780
|
-
/** Includes SEO data. */
|
2781
|
-
SEO = "SEO",
|
2782
|
-
/** Includes post owner's contact ID. */
|
2783
|
-
CONTACT_ID = "CONTACT_ID",
|
2784
|
-
/** Includes post rich content. */
|
2785
|
-
RICH_CONTENT = "RICH_CONTENT",
|
2786
|
-
/** Includes post reference ID field. */
|
2787
|
-
REFERENCE_ID = "REFERENCE_ID"
|
2788
|
-
}
|
2789
|
-
/** @enumType */
|
2790
|
-
export type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
|
2791
|
-
export interface GetPostResponse {
|
1922
|
+
interface GetPostBySlugResponse {
|
2792
1923
|
/** Retrieved post info. */
|
2793
1924
|
post?: Post;
|
2794
1925
|
}
|
2795
|
-
|
2796
|
-
/**
|
2797
|
-
* Slug of the post to retrieve.
|
2798
|
-
* @minLength 1
|
2799
|
-
* @maxLength 200
|
2800
|
-
*/
|
2801
|
-
slug: string;
|
2802
|
-
/**
|
2803
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
2804
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
2805
|
-
* only the post’s base fields are returned.
|
2806
|
-
* @maxSize 20
|
2807
|
-
*/
|
2808
|
-
fieldsets?: PostFieldFieldWithLiterals[];
|
2809
|
-
}
|
2810
|
-
export interface GetPostBySlugResponse {
|
2811
|
-
/** Retrieved post info. */
|
2812
|
-
post?: Post;
|
2813
|
-
}
|
2814
|
-
export interface ListPostsRequest {
|
1926
|
+
interface ListPostsRequest {
|
2815
1927
|
/**
|
2816
1928
|
* Whether to return only featured posts.
|
2817
1929
|
*
|
@@ -2875,7 +1987,7 @@ export interface ListPostsRequest {
|
|
2875
1987
|
*/
|
2876
1988
|
fieldsets?: PostFieldFieldWithLiterals[];
|
2877
1989
|
}
|
2878
|
-
|
1990
|
+
declare enum GetPostsSort {
|
2879
1991
|
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
2880
1992
|
FEED = "FEED",
|
2881
1993
|
/** Ordered by `firstPublishedDate` in ascending order. */
|
@@ -2892,14 +2004,14 @@ export declare enum GetPostsSort {
|
|
2892
2004
|
TITLE_DESC = "TITLE_DESC"
|
2893
2005
|
}
|
2894
2006
|
/** @enumType */
|
2895
|
-
|
2896
|
-
|
2007
|
+
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
|
2008
|
+
interface ListPostsResponse {
|
2897
2009
|
/** List of retrieved posts. */
|
2898
2010
|
posts?: Post[];
|
2899
2011
|
/** Details on the paged set of results returned. */
|
2900
2012
|
metaData?: MetaData;
|
2901
2013
|
}
|
2902
|
-
|
2014
|
+
interface QueryPostsRequest {
|
2903
2015
|
/** Query options. */
|
2904
2016
|
query?: PlatformQuery;
|
2905
2017
|
/**
|
@@ -2910,7 +2022,7 @@ export interface QueryPostsRequest {
|
|
2910
2022
|
*/
|
2911
2023
|
fieldsets?: PostFieldFieldWithLiterals[];
|
2912
2024
|
}
|
2913
|
-
|
2025
|
+
interface Sorting {
|
2914
2026
|
/**
|
2915
2027
|
* Name of the field to sort by.
|
2916
2028
|
* @maxLength 512
|
@@ -2919,13 +2031,13 @@ export interface Sorting {
|
|
2919
2031
|
/** Sort order. */
|
2920
2032
|
order?: SortOrderWithLiterals;
|
2921
2033
|
}
|
2922
|
-
|
2034
|
+
declare enum SortOrder {
|
2923
2035
|
ASC = "ASC",
|
2924
2036
|
DESC = "DESC"
|
2925
2037
|
}
|
2926
2038
|
/** @enumType */
|
2927
|
-
|
2928
|
-
|
2039
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
2040
|
+
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
2929
2041
|
/** Paging options to limit and skip the number of items. */
|
2930
2042
|
paging?: Paging;
|
2931
2043
|
/** 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`. */
|
@@ -2947,13 +2059,13 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
2947
2059
|
sort?: Sorting[];
|
2948
2060
|
}
|
2949
2061
|
/** @oneof */
|
2950
|
-
|
2062
|
+
interface PlatformQueryPagingMethodOneOf {
|
2951
2063
|
/** Paging options to limit and skip the number of items. */
|
2952
2064
|
paging?: Paging;
|
2953
2065
|
/** 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`. */
|
2954
2066
|
cursorPaging?: CursorPaging;
|
2955
2067
|
}
|
2956
|
-
|
2068
|
+
interface Paging {
|
2957
2069
|
/**
|
2958
2070
|
* Number of items to load.
|
2959
2071
|
* @max 100
|
@@ -2962,7 +2074,7 @@ export interface Paging {
|
|
2962
2074
|
/** Number of items to skip in the current sort order. */
|
2963
2075
|
offset?: number | null;
|
2964
2076
|
}
|
2965
|
-
|
2077
|
+
interface CursorPaging {
|
2966
2078
|
/**
|
2967
2079
|
* Number of items to load.
|
2968
2080
|
* @max 100
|
@@ -2978,13 +2090,13 @@ export interface CursorPaging {
|
|
2978
2090
|
*/
|
2979
2091
|
cursor?: string | null;
|
2980
2092
|
}
|
2981
|
-
|
2093
|
+
interface QueryPostsResponse {
|
2982
2094
|
/** List of retrieved posts. */
|
2983
2095
|
posts?: Post[];
|
2984
2096
|
/** Details on the paged set of results returned. */
|
2985
2097
|
pagingMetadata?: PagingMetadataV2;
|
2986
2098
|
}
|
2987
|
-
|
2099
|
+
interface PagingMetadataV2 {
|
2988
2100
|
/** Number of items returned in the response. */
|
2989
2101
|
count?: number | null;
|
2990
2102
|
/** Offset that was requested. */
|
@@ -2996,7 +2108,7 @@ export interface PagingMetadataV2 {
|
|
2996
2108
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
2997
2109
|
cursors?: Cursors;
|
2998
2110
|
}
|
2999
|
-
|
2111
|
+
interface Cursors {
|
3000
2112
|
/**
|
3001
2113
|
* Cursor pointing to next page in the list of results.
|
3002
2114
|
* @maxLength 2000
|
@@ -3008,7 +2120,7 @@ export interface Cursors {
|
|
3008
2120
|
*/
|
3009
2121
|
prev?: string | null;
|
3010
2122
|
}
|
3011
|
-
|
2123
|
+
interface GetPostMetricsRequest {
|
3012
2124
|
/**
|
3013
2125
|
* Post ID to retrieve metrics for.
|
3014
2126
|
* @minLength 1
|
@@ -3016,298 +2128,33 @@ export interface GetPostMetricsRequest {
|
|
3016
2128
|
*/
|
3017
2129
|
postId: string;
|
3018
2130
|
}
|
3019
|
-
|
2131
|
+
interface GetPostMetricsResponse {
|
3020
2132
|
/** Retrieved post metrics. */
|
3021
2133
|
metrics?: Metrics;
|
3022
2134
|
}
|
3023
|
-
|
3024
|
-
|
3025
|
-
|
3026
|
-
|
3027
|
-
|
3028
|
-
|
3029
|
-
|
3030
|
-
|
3031
|
-
|
3032
|
-
|
3033
|
-
|
3034
|
-
}
|
3035
|
-
|
3036
|
-
|
3037
|
-
|
3038
|
-
|
3039
|
-
|
3040
|
-
|
3041
|
-
|
3042
|
-
}
|
3043
|
-
|
3044
|
-
|
3045
|
-
|
3046
|
-
}
|
3047
|
-
|
3048
|
-
|
3049
|
-
* Post ID.
|
3050
|
-
* @minLength 1
|
3051
|
-
* @format GUID
|
3052
|
-
*/
|
3053
|
-
postId?: string;
|
3054
|
-
/**
|
3055
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3056
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
3057
|
-
* only the post’s base fields are returned.
|
3058
|
-
* @maxSize 20
|
3059
|
-
*/
|
3060
|
-
fieldsets?: PostFieldFieldWithLiterals[];
|
3061
|
-
}
|
3062
|
-
export interface LikePostResponse {
|
3063
|
-
/** Post info. */
|
3064
|
-
post?: Post;
|
3065
|
-
}
|
3066
|
-
export interface UnlikePostRequest {
|
3067
|
-
/**
|
3068
|
-
* Post ID.
|
3069
|
-
* @minLength 1
|
3070
|
-
* @format GUID
|
3071
|
-
*/
|
3072
|
-
postId?: string;
|
3073
|
-
/**
|
3074
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3075
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
3076
|
-
* only the post’s base fields are returned.
|
3077
|
-
* @maxSize 20
|
3078
|
-
*/
|
3079
|
-
fieldsets?: PostFieldFieldWithLiterals[];
|
3080
|
-
}
|
3081
|
-
export interface UnlikePostResponse {
|
3082
|
-
/** Post info. */
|
3083
|
-
post?: Post;
|
3084
|
-
}
|
3085
|
-
export interface PinPostRequest {
|
3086
|
-
/**
|
3087
|
-
* Post ID.
|
3088
|
-
* @minLength 1
|
3089
|
-
* @format GUID
|
3090
|
-
*/
|
3091
|
-
postId?: string;
|
3092
|
-
/**
|
3093
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3094
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
3095
|
-
* only the post’s base fields are returned.
|
3096
|
-
* @maxSize 20
|
3097
|
-
*/
|
3098
|
-
fieldsets?: PostFieldFieldWithLiterals[];
|
3099
|
-
}
|
3100
|
-
export interface PinPostResponse {
|
3101
|
-
/** Post info. */
|
3102
|
-
post?: Post;
|
3103
|
-
}
|
3104
|
-
export interface UnpinPostRequest {
|
3105
|
-
/**
|
3106
|
-
* Post ID.
|
3107
|
-
* @minLength 1
|
3108
|
-
* @format GUID
|
3109
|
-
*/
|
3110
|
-
postId?: string;
|
3111
|
-
/**
|
3112
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3113
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
3114
|
-
* only the post’s base fields are returned.
|
3115
|
-
* @maxSize 20
|
3116
|
-
*/
|
3117
|
-
fieldsets?: PostFieldFieldWithLiterals[];
|
3118
|
-
}
|
3119
|
-
export interface UnpinPostResponse {
|
3120
|
-
/** Post info. */
|
3121
|
-
post?: Post;
|
3122
|
-
}
|
3123
|
-
export interface ListPostsArchiveRequest {
|
3124
|
-
/**
|
3125
|
-
* Month
|
3126
|
-
* @min 1
|
3127
|
-
* @max 12
|
3128
|
-
*/
|
3129
|
-
month?: number | null;
|
3130
|
-
/**
|
3131
|
-
* Year
|
3132
|
-
* @min 2000
|
3133
|
-
* @max 3000
|
3134
|
-
*/
|
3135
|
-
year?: number;
|
3136
|
-
/**
|
3137
|
-
* Time zone
|
3138
|
-
* @maxLength 50
|
3139
|
-
*/
|
3140
|
-
timeZone?: string | null;
|
3141
|
-
/** Pagination options. */
|
3142
|
-
paging?: BlogPaging;
|
3143
|
-
/**
|
3144
|
-
* Language filter.
|
3145
|
-
*
|
3146
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
3147
|
-
* Pass a language to only receive posts that are in that language.
|
3148
|
-
* If omitted, posts in all languages are returned.
|
3149
|
-
* @format LANGUAGE_TAG
|
3150
|
-
*/
|
3151
|
-
language?: string | null;
|
3152
|
-
/**
|
3153
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3154
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
3155
|
-
* only the post’s base fields are returned.
|
3156
|
-
* @maxSize 20
|
3157
|
-
*/
|
3158
|
-
fieldsets?: PostFieldFieldWithLiterals[];
|
3159
|
-
}
|
3160
|
-
export interface ListPostsArchiveResponse {
|
3161
|
-
/** List of posts. */
|
3162
|
-
posts?: Post[];
|
3163
|
-
/** Details on the paged set of results returned. */
|
3164
|
-
metaData?: MetaData;
|
3165
|
-
/** Details on the paged set of results returned. */
|
3166
|
-
pagingMetadata?: PagingMetadataV2;
|
3167
|
-
}
|
3168
|
-
export interface BulkGetPostReactionsRequest {
|
3169
|
-
/**
|
3170
|
-
* Post IDs.
|
3171
|
-
* @maxSize 500
|
3172
|
-
* @maxLength 38
|
3173
|
-
*/
|
3174
|
-
postIds?: string[];
|
3175
|
-
}
|
3176
|
-
export interface BulkGetPostReactionsResponse {
|
3177
|
-
/** Map of post.id to reactions */
|
3178
|
-
reactionsMap?: Record<string, Reactions>;
|
3179
|
-
}
|
3180
|
-
export interface Reactions {
|
3181
|
-
/**
|
3182
|
-
* Is post liked by the current user
|
3183
|
-
* @readonly
|
3184
|
-
*/
|
3185
|
-
liked?: boolean;
|
3186
|
-
}
|
3187
|
-
export interface ListDemoPostsRequest {
|
3188
|
-
/**
|
3189
|
-
* Whether to return only featured posts.
|
3190
|
-
*
|
3191
|
-
* Default: `false`
|
3192
|
-
*/
|
3193
|
-
featured?: boolean;
|
3194
|
-
/**
|
3195
|
-
* Hashtag filter.
|
3196
|
-
*
|
3197
|
-
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
3198
|
-
* If omitted, all posts with or without hashtags are returned.
|
3199
|
-
* @maxSize 100
|
3200
|
-
* @maxLength 100
|
3201
|
-
*/
|
3202
|
-
hashtags?: string[];
|
3203
|
-
/**
|
3204
|
-
* Category filter.
|
3205
|
-
*
|
3206
|
-
* Pass an array of category IDs to return only posts with any of the provided categories.
|
3207
|
-
* If omitted, all posts with or without associated categories are returned.
|
3208
|
-
* @maxSize 50
|
3209
|
-
* @format GUID
|
3210
|
-
*/
|
3211
|
-
categoryIds?: string[];
|
3212
|
-
/**
|
3213
|
-
* Tag filter.
|
3214
|
-
*
|
3215
|
-
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
3216
|
-
* If omitted, all posts with or without tags are returned.
|
3217
|
-
* @maxSize 50
|
3218
|
-
* @format GUID
|
3219
|
-
*/
|
3220
|
-
tagIds?: string[];
|
3221
|
-
/**
|
3222
|
-
* Sorting options.
|
3223
|
-
*
|
3224
|
-
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
3225
|
-
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
3226
|
-
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
3227
|
-
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
3228
|
-
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
3229
|
-
* - `TITLE_ASC`: Ordered by `title` in ascening order.
|
3230
|
-
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
3231
|
-
* - `RATING`: reserved for internal use.
|
3232
|
-
*
|
3233
|
-
* Default: `FEED`
|
3234
|
-
*/
|
3235
|
-
sort?: GetPostsSortWithLiterals;
|
3236
|
-
/** Pagination options. */
|
3237
|
-
paging?: BlogPaging;
|
3238
|
-
/**
|
3239
|
-
* __Deprecated.__ Use `fieldsets` instead.
|
3240
|
-
* This parameter will be removed on June 30, 2023.
|
3241
|
-
*
|
3242
|
-
* List of post fields to be included in the response.
|
3243
|
-
* @maxSize 20
|
3244
|
-
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
3245
|
-
* This parameter will be removed on June 30, 2023.
|
3246
|
-
*
|
3247
|
-
* List of post fields to be included in the response.
|
3248
|
-
* @replacedBy fieldsets
|
3249
|
-
* @targetRemovalDate 2024-06-30
|
3250
|
-
*/
|
3251
|
-
fieldsToInclude?: PostFieldFieldWithLiterals[];
|
3252
|
-
/**
|
3253
|
-
* Language filter.
|
3254
|
-
*
|
3255
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
3256
|
-
* Pass a language to only receive posts that are in that language.
|
3257
|
-
* If omitted, posts in all languages are returned.
|
3258
|
-
* @format LANGUAGE_TAG
|
3259
|
-
*/
|
3260
|
-
language?: string | null;
|
3261
|
-
/**
|
3262
|
-
* Post owner's member ID.
|
3263
|
-
* @format GUID
|
3264
|
-
*/
|
3265
|
-
memberId?: string | null;
|
3266
|
-
/**
|
3267
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3268
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
3269
|
-
* only the post’s base fields are returned.
|
3270
|
-
* @maxSize 20
|
3271
|
-
*/
|
3272
|
-
fieldsets?: PostFieldFieldWithLiterals[];
|
3273
|
-
}
|
3274
|
-
export interface ListDemoPostsResponse {
|
3275
|
-
/** List of posts. */
|
3276
|
-
posts?: Post[];
|
3277
|
-
/** Details on the paged set of results returned. */
|
3278
|
-
metaData?: MetaData;
|
3279
|
-
}
|
3280
|
-
export interface ConvertDraftJsToRichContentRequest {
|
3281
|
-
/** DraftJs content to convert to Rich content. */
|
3282
|
-
content?: Record<string, any> | null;
|
3283
|
-
}
|
3284
|
-
export interface ConvertDraftJsToRichContentResponse {
|
3285
|
-
/**
|
3286
|
-
* Rich content converted from DraftJs content.
|
3287
|
-
* @maxLength 2000000
|
3288
|
-
*/
|
3289
|
-
richContent?: string;
|
3290
|
-
}
|
3291
|
-
export interface ConvertRichContentToDraftJsRequest {
|
3292
|
-
/**
|
3293
|
-
* Rich content to convert to DraftJs content.
|
3294
|
-
* @maxLength 2000000
|
3295
|
-
*/
|
3296
|
-
richContent?: string;
|
3297
|
-
}
|
3298
|
-
export interface ConvertRichContentToDraftJsResponse {
|
3299
|
-
/** DraftJs content converted from Rich content. */
|
3300
|
-
content?: Record<string, any> | null;
|
3301
|
-
}
|
3302
|
-
export interface OldBlogMigratedEvent {
|
3303
|
-
/**
|
3304
|
-
* Instance id of new version of blog
|
3305
|
-
* @format GUID
|
3306
|
-
*/
|
3307
|
-
newBlogInstanceId?: string;
|
3308
|
-
/**
|
3309
|
-
* Instance id of old version of blog
|
3310
|
-
* @format GUID
|
3311
|
-
*/
|
3312
|
-
oldBlogInstanceId?: string;
|
3313
|
-
}
|
2135
|
+
|
2136
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
2137
|
+
getUrl: (context: any) => string;
|
2138
|
+
httpMethod: K;
|
2139
|
+
path: string;
|
2140
|
+
pathParams: M;
|
2141
|
+
__requestType: T;
|
2142
|
+
__originalRequestType: S;
|
2143
|
+
__responseType: Q;
|
2144
|
+
__originalResponseType: R;
|
2145
|
+
};
|
2146
|
+
declare function queryPostCountStats(): __PublicMethodMetaInfo<'GET', {}, QueryPostCountStatsRequest$1, QueryPostCountStatsRequest, QueryPostCountStatsResponse$1, QueryPostCountStatsResponse>;
|
2147
|
+
declare function getTotalPosts(): __PublicMethodMetaInfo<'GET', {}, GetTotalPostsRequest$1, GetTotalPostsRequest, GetTotalPostsResponse$1, GetTotalPostsResponse>;
|
2148
|
+
declare function getPost(): __PublicMethodMetaInfo<'GET', {
|
2149
|
+
postId: string;
|
2150
|
+
}, GetPostRequest$1, GetPostRequest, GetPostResponse$1, GetPostResponse>;
|
2151
|
+
declare function getPostBySlug(): __PublicMethodMetaInfo<'GET', {
|
2152
|
+
slug: string;
|
2153
|
+
}, GetPostBySlugRequest$1, GetPostBySlugRequest, GetPostBySlugResponse$1, GetPostBySlugResponse>;
|
2154
|
+
declare function listPosts(): __PublicMethodMetaInfo<'GET', {}, ListPostsRequest$1, ListPostsRequest, ListPostsResponse$1, ListPostsResponse>;
|
2155
|
+
declare function queryPosts(): __PublicMethodMetaInfo<'POST', {}, QueryPostsRequest$1, QueryPostsRequest, QueryPostsResponse$1, QueryPostsResponse>;
|
2156
|
+
declare function getPostMetrics(): __PublicMethodMetaInfo<'GET', {
|
2157
|
+
postId: string;
|
2158
|
+
}, GetPostMetricsRequest$1, GetPostMetricsRequest, GetPostMetricsResponse$1, GetPostMetricsResponse>;
|
2159
|
+
|
2160
|
+
export { type __PublicMethodMetaInfo, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, queryPostCountStats, queryPosts };
|