@wix/auto_sdk_blog_posts 1.0.18 → 1.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{cjs/src/blog-v3-post-posts.universal.d.ts → blog-v3-post-posts.universal-CEsWp0Fx.d.mts} +256 -485
- package/build/{es/src/blog-v3-post-posts.universal.d.ts → blog-v3-post-posts.universal-CEsWp0Fx.d.ts} +256 -485
- package/build/index.d.mts +130 -0
- package/build/index.d.ts +130 -0
- package/build/index.js +1975 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +1899 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{cjs/src/blog-v3-post-posts.universal.d.ts → blog-v3-post-posts.universal-nU7XoyIE.d.mts} +256 -485
- package/build/internal/{es/src/blog-v3-post-posts.universal.d.ts → blog-v3-post-posts.universal-nU7XoyIE.d.ts} +256 -485
- package/build/internal/index.d.mts +130 -0
- package/build/internal/index.d.ts +130 -0
- package/build/internal/index.js +1975 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +1899 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/{es/src/blog-v3-post-posts.types.d.ts → internal/meta.d.mts} +238 -1375
- package/build/internal/{cjs/src/blog-v3-post-posts.types.d.ts → meta.d.ts} +238 -1375
- package/build/internal/meta.js +1002 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +969 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{cjs/src/blog-v3-post-posts.types.d.ts → meta.d.mts} +238 -1375
- package/build/{internal/es/src/blog-v3-post-posts.types.d.ts → meta.d.ts} +238 -1375
- package/build/meta.js +1002 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +969 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.context.d.ts +0 -37
- package/build/cjs/src/blog-v3-post-posts.context.js +0 -82
- package/build/cjs/src/blog-v3-post-posts.context.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.http.d.ts +0 -59
- package/build/cjs/src/blog-v3-post-posts.http.js +0 -892
- package/build/cjs/src/blog-v3-post-posts.http.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.meta.d.ts +0 -25
- package/build/cjs/src/blog-v3-post-posts.meta.js +0 -161
- package/build/cjs/src/blog-v3-post-posts.meta.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.public.d.ts +0 -99
- package/build/cjs/src/blog-v3-post-posts.public.js +0 -320
- package/build/cjs/src/blog-v3-post-posts.public.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.types.js +0 -485
- package/build/cjs/src/blog-v3-post-posts.types.js.map +0 -1
- package/build/cjs/src/blog-v3-post-posts.universal.js +0 -966
- package/build/cjs/src/blog-v3-post-posts.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/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 -933
- package/build/es/src/blog-v3-post-posts.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.context.d.ts +0 -37
- package/build/internal/cjs/src/blog-v3-post-posts.context.js +0 -82
- package/build/internal/cjs/src/blog-v3-post-posts.context.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.http.d.ts +0 -59
- package/build/internal/cjs/src/blog-v3-post-posts.http.js +0 -892
- package/build/internal/cjs/src/blog-v3-post-posts.http.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.meta.d.ts +0 -25
- package/build/internal/cjs/src/blog-v3-post-posts.meta.js +0 -161
- package/build/internal/cjs/src/blog-v3-post-posts.meta.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.public.d.ts +0 -99
- package/build/internal/cjs/src/blog-v3-post-posts.public.js +0 -320
- package/build/internal/cjs/src/blog-v3-post-posts.public.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.types.js +0 -485
- package/build/internal/cjs/src/blog-v3-post-posts.types.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-post-posts.universal.js +0 -966
- package/build/internal/cjs/src/blog-v3-post-posts.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.context.d.ts +0 -37
- package/build/internal/es/src/blog-v3-post-posts.context.js +0 -37
- package/build/internal/es/src/blog-v3-post-posts.context.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.http.d.ts +0 -59
- package/build/internal/es/src/blog-v3-post-posts.http.js +0 -882
- package/build/internal/es/src/blog-v3-post-posts.http.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.meta.d.ts +0 -25
- package/build/internal/es/src/blog-v3-post-posts.meta.js +0 -128
- package/build/internal/es/src/blog-v3-post-posts.meta.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.public.d.ts +0 -99
- package/build/internal/es/src/blog-v3-post-posts.public.js +0 -268
- package/build/internal/es/src/blog-v3-post-posts.public.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.types.js +0 -482
- package/build/internal/es/src/blog-v3-post-posts.types.js.map +0 -1
- package/build/internal/es/src/blog-v3-post-posts.universal.js +0 -933
- package/build/internal/es/src/blog-v3-post-posts.universal.js.map +0 -1
@@ -1,4 +1,6 @@
|
|
1
|
-
|
1
|
+
import { bS as QueryPostCountStatsRequest$1, a as QueryPostCountStatsResponse$1, bW as GetTotalPostsRequest$1, b as GetTotalPostsResponse$1, cr as GetPostRequest$1, d as GetPostResponse$1, cs as GetPostBySlugRequest$1, f as GetPostBySlugResponse$1, ct as ListPostsRequest$1, g as ListPostsResponse$1, cu as QueryPostsRequest$1, cA as QueryPostsResponse$1, cD as GetPostMetricsRequest$1, i as GetPostMetricsResponse$1 } from './blog-v3-post-posts.universal-CEsWp0Fx.js';
|
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",
|
@@ -514,7 +489,7 @@ export declare enum NodeType {
|
|
514
489
|
LAYOUT = "LAYOUT",
|
515
490
|
LAYOUT_CELL = "LAYOUT_CELL"
|
516
491
|
}
|
517
|
-
|
492
|
+
interface NodeStyle {
|
518
493
|
/** The top padding value in pixels. */
|
519
494
|
paddingTop?: string | null;
|
520
495
|
/** The bottom padding value in pixels. */
|
@@ -522,7 +497,7 @@ export interface NodeStyle {
|
|
522
497
|
/** The background color as a hexadecimal value. */
|
523
498
|
backgroundColor?: string | null;
|
524
499
|
}
|
525
|
-
|
500
|
+
interface ButtonData {
|
526
501
|
/** Styling for the button's container. */
|
527
502
|
containerData?: PluginContainerData;
|
528
503
|
/** The button type. */
|
@@ -534,13 +509,13 @@ export interface ButtonData {
|
|
534
509
|
/** Button link details. */
|
535
510
|
link?: Link;
|
536
511
|
}
|
537
|
-
|
512
|
+
interface Border {
|
538
513
|
/** Border width in pixels. */
|
539
514
|
width?: number | null;
|
540
515
|
/** Border radius in pixels. */
|
541
516
|
radius?: number | null;
|
542
517
|
}
|
543
|
-
|
518
|
+
interface Colors {
|
544
519
|
/** The text color as a hexadecimal value. */
|
545
520
|
text?: string | null;
|
546
521
|
/** The border color as a hexadecimal value. */
|
@@ -548,7 +523,7 @@ export interface Colors {
|
|
548
523
|
/** The background color as a hexadecimal value. */
|
549
524
|
background?: string | null;
|
550
525
|
}
|
551
|
-
|
526
|
+
interface PluginContainerData {
|
552
527
|
/** The width of the node when it's displayed. */
|
553
528
|
width?: PluginContainerDataWidth;
|
554
529
|
/** The node's alignment within its container. */
|
@@ -560,7 +535,7 @@ export interface PluginContainerData {
|
|
560
535
|
/** 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`. */
|
561
536
|
textWrap?: boolean | null;
|
562
537
|
}
|
563
|
-
|
538
|
+
declare enum WidthType {
|
564
539
|
/** Width matches the content width */
|
565
540
|
CONTENT = "CONTENT",
|
566
541
|
/** Small Width */
|
@@ -570,7 +545,7 @@ export declare enum WidthType {
|
|
570
545
|
/** coast-to-coast display */
|
571
546
|
FULL_WIDTH = "FULL_WIDTH"
|
572
547
|
}
|
573
|
-
|
548
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
574
549
|
/**
|
575
550
|
* One of the following predefined width options:
|
576
551
|
* `CONTENT`: The width of the container matches the content width.
|
@@ -583,7 +558,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
583
558
|
custom?: string | null;
|
584
559
|
}
|
585
560
|
/** @oneof */
|
586
|
-
|
561
|
+
interface PluginContainerDataWidthDataOneOf {
|
587
562
|
/**
|
588
563
|
* One of the following predefined width options:
|
589
564
|
* `CONTENT`: The width of the container matches the content width.
|
@@ -595,7 +570,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
595
570
|
/** A custom width value in pixels. */
|
596
571
|
custom?: string | null;
|
597
572
|
}
|
598
|
-
|
573
|
+
declare enum PluginContainerDataAlignment {
|
599
574
|
/** Center Alignment */
|
600
575
|
CENTER = "CENTER",
|
601
576
|
/** Left Alignment */
|
@@ -603,7 +578,7 @@ export declare enum PluginContainerDataAlignment {
|
|
603
578
|
/** Right Alignment */
|
604
579
|
RIGHT = "RIGHT"
|
605
580
|
}
|
606
|
-
|
581
|
+
interface Spoiler {
|
607
582
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
608
583
|
enabled?: boolean | null;
|
609
584
|
/** The description displayed on top of the spoiler cover. */
|
@@ -611,23 +586,23 @@ export interface Spoiler {
|
|
611
586
|
/** The text for the button used to remove the spoiler cover. */
|
612
587
|
buttonText?: string | null;
|
613
588
|
}
|
614
|
-
|
589
|
+
interface Height {
|
615
590
|
/** A custom height value in pixels. */
|
616
591
|
custom?: string | null;
|
617
592
|
}
|
618
|
-
|
593
|
+
declare enum Type {
|
619
594
|
/** Regular link button */
|
620
595
|
LINK = "LINK",
|
621
596
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
622
597
|
ACTION = "ACTION"
|
623
598
|
}
|
624
|
-
|
599
|
+
interface Styles {
|
625
600
|
/** Border attributes. */
|
626
601
|
border?: Border;
|
627
602
|
/** Color attributes. */
|
628
603
|
colors?: Colors;
|
629
604
|
}
|
630
|
-
|
605
|
+
interface Link extends LinkDataOneOf {
|
631
606
|
/** The absolute URL for the linked document. */
|
632
607
|
url?: string;
|
633
608
|
/** The target node's ID. Used for linking to another node in this object. */
|
@@ -646,13 +621,13 @@ export interface Link extends LinkDataOneOf {
|
|
646
621
|
customData?: string | null;
|
647
622
|
}
|
648
623
|
/** @oneof */
|
649
|
-
|
624
|
+
interface LinkDataOneOf {
|
650
625
|
/** The absolute URL for the linked document. */
|
651
626
|
url?: string;
|
652
627
|
/** The target node's ID. Used for linking to another node in this object. */
|
653
628
|
anchor?: string;
|
654
629
|
}
|
655
|
-
|
630
|
+
declare enum Target {
|
656
631
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
657
632
|
SELF = "SELF",
|
658
633
|
/** Opens the linked document in a new window or tab */
|
@@ -662,7 +637,7 @@ export declare enum Target {
|
|
662
637
|
/** Opens the linked document in the full body of the window */
|
663
638
|
TOP = "TOP"
|
664
639
|
}
|
665
|
-
|
640
|
+
interface Rel {
|
666
641
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
667
642
|
nofollow?: boolean | null;
|
668
643
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
@@ -672,17 +647,17 @@ export interface Rel {
|
|
672
647
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
673
648
|
noreferrer?: boolean | null;
|
674
649
|
}
|
675
|
-
|
650
|
+
interface CodeBlockData {
|
676
651
|
/** Styling for the code block's text. */
|
677
652
|
textStyle?: TextStyle;
|
678
653
|
}
|
679
|
-
|
654
|
+
interface TextStyle {
|
680
655
|
/** Text alignment. Defaults to `AUTO`. */
|
681
656
|
textAlignment?: TextAlignment;
|
682
657
|
/** 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. */
|
683
658
|
lineHeight?: string | null;
|
684
659
|
}
|
685
|
-
|
660
|
+
declare enum TextAlignment {
|
686
661
|
/** browser default, eqivalent to `initial` */
|
687
662
|
AUTO = "AUTO",
|
688
663
|
/** Left align */
|
@@ -694,7 +669,7 @@ export declare enum TextAlignment {
|
|
694
669
|
/** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
|
695
670
|
JUSTIFY = "JUSTIFY"
|
696
671
|
}
|
697
|
-
|
672
|
+
interface DividerData {
|
698
673
|
/** Styling for the divider's container. */
|
699
674
|
containerData?: PluginContainerData;
|
700
675
|
/** Divider line style. */
|
@@ -704,7 +679,7 @@ export interface DividerData {
|
|
704
679
|
/** Divider alignment. */
|
705
680
|
alignment?: Alignment;
|
706
681
|
}
|
707
|
-
|
682
|
+
declare enum LineStyle {
|
708
683
|
/** Single Line */
|
709
684
|
SINGLE = "SINGLE",
|
710
685
|
/** Double Line */
|
@@ -714,7 +689,7 @@ export declare enum LineStyle {
|
|
714
689
|
/** Dotted Line */
|
715
690
|
DOTTED = "DOTTED"
|
716
691
|
}
|
717
|
-
|
692
|
+
declare enum Width {
|
718
693
|
/** Large line */
|
719
694
|
LARGE = "LARGE",
|
720
695
|
/** Medium line */
|
@@ -722,7 +697,7 @@ export declare enum Width {
|
|
722
697
|
/** Small line */
|
723
698
|
SMALL = "SMALL"
|
724
699
|
}
|
725
|
-
|
700
|
+
declare enum Alignment {
|
726
701
|
/** Center alignment */
|
727
702
|
CENTER = "CENTER",
|
728
703
|
/** Left alignment */
|
@@ -730,7 +705,7 @@ export declare enum Alignment {
|
|
730
705
|
/** Right alignment */
|
731
706
|
RIGHT = "RIGHT"
|
732
707
|
}
|
733
|
-
|
708
|
+
interface FileData {
|
734
709
|
/** Styling for the file's container. */
|
735
710
|
containerData?: PluginContainerData;
|
736
711
|
/** The source for the file's data. */
|
@@ -753,7 +728,7 @@ export interface FileData {
|
|
753
728
|
/** File size in KB. */
|
754
729
|
sizeInKb?: string | null;
|
755
730
|
}
|
756
|
-
|
731
|
+
declare enum ViewMode {
|
757
732
|
/** No PDF view */
|
758
733
|
NONE = "NONE",
|
759
734
|
/** Full PDF view */
|
@@ -761,7 +736,7 @@ export declare enum ViewMode {
|
|
761
736
|
/** Mini PDF view */
|
762
737
|
MINI = "MINI"
|
763
738
|
}
|
764
|
-
|
739
|
+
interface FileSource extends FileSourceDataOneOf {
|
765
740
|
/** The absolute URL for the file's source. */
|
766
741
|
url?: string | null;
|
767
742
|
/**
|
@@ -775,7 +750,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
775
750
|
private?: boolean | null;
|
776
751
|
}
|
777
752
|
/** @oneof */
|
778
|
-
|
753
|
+
interface FileSourceDataOneOf {
|
779
754
|
/** The absolute URL for the file's source. */
|
780
755
|
url?: string | null;
|
781
756
|
/**
|
@@ -786,7 +761,7 @@ export interface FileSourceDataOneOf {
|
|
786
761
|
/** An ID that's resolved to a URL by a resolver function. */
|
787
762
|
id?: string | null;
|
788
763
|
}
|
789
|
-
|
764
|
+
interface PDFSettings {
|
790
765
|
/**
|
791
766
|
* PDF view mode. One of the following:
|
792
767
|
* `NONE` : The PDF isn't displayed.
|
@@ -799,7 +774,7 @@ export interface PDFSettings {
|
|
799
774
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
800
775
|
disablePrint?: boolean | null;
|
801
776
|
}
|
802
|
-
|
777
|
+
interface GalleryData {
|
803
778
|
/** Styling for the gallery's container. */
|
804
779
|
containerData?: PluginContainerData;
|
805
780
|
/** The items in the gallery. */
|
@@ -811,7 +786,7 @@ export interface GalleryData {
|
|
811
786
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
812
787
|
disableDownload?: boolean | null;
|
813
788
|
}
|
814
|
-
|
789
|
+
interface V1Media {
|
815
790
|
/** The source for the media's data. */
|
816
791
|
src?: FileSource;
|
817
792
|
/** Media width in pixels. */
|
@@ -821,19 +796,19 @@ export interface V1Media {
|
|
821
796
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
822
797
|
duration?: number | null;
|
823
798
|
}
|
824
|
-
|
799
|
+
interface ItemImage {
|
825
800
|
/** Image file details. */
|
826
801
|
media?: V1Media;
|
827
802
|
/** Link details for images that are links. */
|
828
803
|
link?: Link;
|
829
804
|
}
|
830
|
-
|
805
|
+
interface ItemVideo {
|
831
806
|
/** Video file details. */
|
832
807
|
media?: V1Media;
|
833
808
|
/** Video thumbnail file details. */
|
834
809
|
thumbnail?: V1Media;
|
835
810
|
}
|
836
|
-
|
811
|
+
interface Item extends ItemDataOneOf {
|
837
812
|
/** An image item. */
|
838
813
|
image?: ItemImage;
|
839
814
|
/** A video item. */
|
@@ -844,13 +819,13 @@ export interface Item extends ItemDataOneOf {
|
|
844
819
|
altText?: string | null;
|
845
820
|
}
|
846
821
|
/** @oneof */
|
847
|
-
|
822
|
+
interface ItemDataOneOf {
|
848
823
|
/** An image item. */
|
849
824
|
image?: ItemImage;
|
850
825
|
/** A video item. */
|
851
826
|
video?: ItemVideo;
|
852
827
|
}
|
853
|
-
|
828
|
+
interface GalleryOptions {
|
854
829
|
/** Gallery layout. */
|
855
830
|
layout?: Layout;
|
856
831
|
/** Styling for gallery items. */
|
@@ -858,7 +833,7 @@ export interface GalleryOptions {
|
|
858
833
|
/** Styling for gallery thumbnail images. */
|
859
834
|
thumbnails?: Thumbnails;
|
860
835
|
}
|
861
|
-
|
836
|
+
declare enum LayoutType {
|
862
837
|
/** Collage type */
|
863
838
|
COLLAGE = "COLLAGE",
|
864
839
|
/** Masonry type */
|
@@ -880,19 +855,19 @@ export declare enum LayoutType {
|
|
880
855
|
/** Fullsize images type */
|
881
856
|
FULLSIZE = "FULLSIZE"
|
882
857
|
}
|
883
|
-
|
858
|
+
declare enum Orientation {
|
884
859
|
/** Rows Orientation */
|
885
860
|
ROWS = "ROWS",
|
886
861
|
/** Columns Orientation */
|
887
862
|
COLUMNS = "COLUMNS"
|
888
863
|
}
|
889
|
-
|
864
|
+
declare enum Crop {
|
890
865
|
/** Crop to fill */
|
891
866
|
FILL = "FILL",
|
892
867
|
/** Crop to fit */
|
893
868
|
FIT = "FIT"
|
894
869
|
}
|
895
|
-
|
870
|
+
declare enum ThumbnailsAlignment {
|
896
871
|
/** Top alignment */
|
897
872
|
TOP = "TOP",
|
898
873
|
/** Right alignment */
|
@@ -904,7 +879,7 @@ export declare enum ThumbnailsAlignment {
|
|
904
879
|
/** No thumbnail */
|
905
880
|
NONE = "NONE"
|
906
881
|
}
|
907
|
-
|
882
|
+
interface Layout {
|
908
883
|
/** Gallery layout type. */
|
909
884
|
type?: LayoutType;
|
910
885
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
@@ -916,7 +891,7 @@ export interface Layout {
|
|
916
891
|
/** The number of columns to display on mobile screens. */
|
917
892
|
mobileNumberOfColumns?: number | null;
|
918
893
|
}
|
919
|
-
|
894
|
+
interface ItemStyle {
|
920
895
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
921
896
|
targetSize?: number | null;
|
922
897
|
/** Item ratio */
|
@@ -926,13 +901,13 @@ export interface ItemStyle {
|
|
926
901
|
/** The spacing between items in pixels. */
|
927
902
|
spacing?: number | null;
|
928
903
|
}
|
929
|
-
|
904
|
+
interface Thumbnails {
|
930
905
|
/** Thumbnail alignment. */
|
931
906
|
placement?: ThumbnailsAlignment;
|
932
907
|
/** Spacing between thumbnails in pixels. */
|
933
908
|
spacing?: number | null;
|
934
909
|
}
|
935
|
-
|
910
|
+
interface GIFData {
|
936
911
|
/** Styling for the GIF's container. */
|
937
912
|
containerData?: PluginContainerData;
|
938
913
|
/** The source of the full size GIF. */
|
@@ -946,7 +921,7 @@ export interface GIFData {
|
|
946
921
|
/** Type of GIF (Sticker or GIF). Defaults to `GIF`. */
|
947
922
|
gifType?: GIFType;
|
948
923
|
}
|
949
|
-
|
924
|
+
interface GIF {
|
950
925
|
/**
|
951
926
|
* GIF format URL.
|
952
927
|
* @format WEB_URL
|
@@ -963,11 +938,11 @@ export interface GIF {
|
|
963
938
|
*/
|
964
939
|
still?: string | null;
|
965
940
|
}
|
966
|
-
|
941
|
+
declare enum GIFType {
|
967
942
|
GIF = "GIF",
|
968
943
|
STICKER = "STICKER"
|
969
944
|
}
|
970
|
-
|
945
|
+
interface HeadingData {
|
971
946
|
/** Heading level from 1-6. */
|
972
947
|
level?: number;
|
973
948
|
/** Styling for the heading text. */
|
@@ -975,7 +950,7 @@ export interface HeadingData {
|
|
975
950
|
/** Indentation level from 1-4. */
|
976
951
|
indentation?: number | null;
|
977
952
|
}
|
978
|
-
|
953
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
979
954
|
/** The URL for the HTML code for the node. */
|
980
955
|
url?: string;
|
981
956
|
/** The HTML code for the node. */
|
@@ -993,7 +968,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
993
968
|
autoHeight?: boolean | null;
|
994
969
|
}
|
995
970
|
/** @oneof */
|
996
|
-
|
971
|
+
interface HTMLDataDataOneOf {
|
997
972
|
/** The URL for the HTML code for the node. */
|
998
973
|
url?: string;
|
999
974
|
/** The HTML code for the node. */
|
@@ -1004,11 +979,11 @@ export interface HTMLDataDataOneOf {
|
|
1004
979
|
*/
|
1005
980
|
isAdsense?: boolean | null;
|
1006
981
|
}
|
1007
|
-
|
982
|
+
declare enum Source {
|
1008
983
|
HTML = "HTML",
|
1009
984
|
ADSENSE = "ADSENSE"
|
1010
985
|
}
|
1011
|
-
|
986
|
+
interface ImageData {
|
1012
987
|
/** Styling for the image's container. */
|
1013
988
|
containerData?: PluginContainerData;
|
1014
989
|
/** Image file details. */
|
@@ -1027,22 +1002,7 @@ export interface ImageData {
|
|
1027
1002
|
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
1028
1003
|
disableDownload?: boolean | null;
|
1029
1004
|
}
|
1030
|
-
|
1031
|
-
/** Border width in pixels. */
|
1032
|
-
width?: number | null;
|
1033
|
-
/**
|
1034
|
-
* Border color as a hexadecimal value.
|
1035
|
-
* @format COLOR_HEX
|
1036
|
-
*/
|
1037
|
-
color?: string | null;
|
1038
|
-
/** Border radius in pixels. */
|
1039
|
-
radius?: number | null;
|
1040
|
-
}
|
1041
|
-
export interface ImageDataStyles {
|
1042
|
-
/** Border attributes. */
|
1043
|
-
border?: StylesBorder;
|
1044
|
-
}
|
1045
|
-
export interface LinkPreviewData {
|
1005
|
+
interface LinkPreviewData {
|
1046
1006
|
/** Styling for the link preview's container. */
|
1047
1007
|
containerData?: PluginContainerData;
|
1048
1008
|
/** Link details. */
|
@@ -1056,56 +1016,13 @@ export interface LinkPreviewData {
|
|
1056
1016
|
/** The preview content as HTML. */
|
1057
1017
|
html?: string | null;
|
1058
1018
|
}
|
1059
|
-
|
1060
|
-
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
1061
|
-
START = "START",
|
1062
|
-
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
1063
|
-
END = "END",
|
1064
|
-
/** Thumbnail positioned at the top */
|
1065
|
-
TOP = "TOP",
|
1066
|
-
/** Thumbnail hidden and not displayed */
|
1067
|
-
HIDDEN = "HIDDEN"
|
1068
|
-
}
|
1069
|
-
export interface LinkPreviewDataStyles {
|
1070
|
-
/**
|
1071
|
-
* Background color as a hexadecimal value.
|
1072
|
-
* @format COLOR_HEX
|
1073
|
-
*/
|
1074
|
-
backgroundColor?: string | null;
|
1075
|
-
/**
|
1076
|
-
* Title color as a hexadecimal value.
|
1077
|
-
* @format COLOR_HEX
|
1078
|
-
*/
|
1079
|
-
titleColor?: string | null;
|
1080
|
-
/**
|
1081
|
-
* Subtitle color as a hexadecimal value.
|
1082
|
-
* @format COLOR_HEX
|
1083
|
-
*/
|
1084
|
-
subtitleColor?: string | null;
|
1085
|
-
/**
|
1086
|
-
* Link color as a hexadecimal value.
|
1087
|
-
* @format COLOR_HEX
|
1088
|
-
*/
|
1089
|
-
linkColor?: string | null;
|
1090
|
-
/** Border width in pixels. */
|
1091
|
-
borderWidth?: number | null;
|
1092
|
-
/** Border radius in pixels. */
|
1093
|
-
borderRadius?: number | null;
|
1094
|
-
/**
|
1095
|
-
* Border color as a hexadecimal value.
|
1096
|
-
* @format COLOR_HEX
|
1097
|
-
*/
|
1098
|
-
borderColor?: string | null;
|
1099
|
-
/** Position of thumbnail. Defaults to `START`. */
|
1100
|
-
thumbnailPosition?: Position;
|
1101
|
-
}
|
1102
|
-
export interface MapData {
|
1019
|
+
interface MapData {
|
1103
1020
|
/** Styling for the map's container. */
|
1104
1021
|
containerData?: PluginContainerData;
|
1105
1022
|
/** Map settings. */
|
1106
1023
|
mapSettings?: MapSettings;
|
1107
1024
|
}
|
1108
|
-
|
1025
|
+
interface MapSettings {
|
1109
1026
|
/** The address to display on the map. */
|
1110
1027
|
address?: string | null;
|
1111
1028
|
/** Sets whether the map is draggable. */
|
@@ -1129,7 +1046,7 @@ export interface MapSettings {
|
|
1129
1046
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
1130
1047
|
mapType?: MapType;
|
1131
1048
|
}
|
1132
|
-
|
1049
|
+
declare enum MapType {
|
1133
1050
|
/** Roadmap map type */
|
1134
1051
|
ROADMAP = "ROADMAP",
|
1135
1052
|
/** Satellite map type */
|
@@ -1139,7 +1056,7 @@ export declare enum MapType {
|
|
1139
1056
|
/** Terrain map type */
|
1140
1057
|
TERRAIN = "TERRAIN"
|
1141
1058
|
}
|
1142
|
-
|
1059
|
+
interface ParagraphData {
|
1143
1060
|
/** Styling for the paragraph text. */
|
1144
1061
|
textStyle?: TextStyle;
|
1145
1062
|
/** Indentation level from 1-4. */
|
@@ -1147,7 +1064,7 @@ export interface ParagraphData {
|
|
1147
1064
|
/** Paragraph level */
|
1148
1065
|
level?: number | null;
|
1149
1066
|
}
|
1150
|
-
|
1067
|
+
interface PollData {
|
1151
1068
|
/** Styling for the poll's container. */
|
1152
1069
|
containerData?: PluginContainerData;
|
1153
1070
|
/** Poll data. */
|
@@ -1157,7 +1074,7 @@ export interface PollData {
|
|
1157
1074
|
/** Styling for the poll and voting options. */
|
1158
1075
|
design?: Design;
|
1159
1076
|
}
|
1160
|
-
|
1077
|
+
declare enum ViewRole {
|
1161
1078
|
/** Only Poll creator can view the results */
|
1162
1079
|
CREATOR = "CREATOR",
|
1163
1080
|
/** Anyone who voted can see the results */
|
@@ -1165,13 +1082,13 @@ export declare enum ViewRole {
|
|
1165
1082
|
/** Anyone can see the results, even if one didn't vote */
|
1166
1083
|
EVERYONE = "EVERYONE"
|
1167
1084
|
}
|
1168
|
-
|
1085
|
+
declare enum VoteRole {
|
1169
1086
|
/** Logged in member */
|
1170
1087
|
SITE_MEMBERS = "SITE_MEMBERS",
|
1171
1088
|
/** Anyone */
|
1172
1089
|
ALL = "ALL"
|
1173
1090
|
}
|
1174
|
-
|
1091
|
+
interface Permissions {
|
1175
1092
|
/** Sets who can view the poll results. */
|
1176
1093
|
view?: ViewRole;
|
1177
1094
|
/** Sets who can vote. */
|
@@ -1179,7 +1096,7 @@ export interface Permissions {
|
|
1179
1096
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
1180
1097
|
allowMultipleVotes?: boolean | null;
|
1181
1098
|
}
|
1182
|
-
|
1099
|
+
interface Option {
|
1183
1100
|
/** Option ID. */
|
1184
1101
|
id?: string | null;
|
1185
1102
|
/** Option title. */
|
@@ -1187,7 +1104,7 @@ export interface Option {
|
|
1187
1104
|
/** The image displayed with the option. */
|
1188
1105
|
image?: V1Media;
|
1189
1106
|
}
|
1190
|
-
|
1107
|
+
interface PollSettings {
|
1191
1108
|
/** Permissions settings for voting. */
|
1192
1109
|
permissions?: Permissions;
|
1193
1110
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
@@ -1195,19 +1112,19 @@ export interface PollSettings {
|
|
1195
1112
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
1196
1113
|
showVotesCount?: boolean | null;
|
1197
1114
|
}
|
1198
|
-
|
1115
|
+
declare enum PollLayoutType {
|
1199
1116
|
/** List */
|
1200
1117
|
LIST = "LIST",
|
1201
1118
|
/** Grid */
|
1202
1119
|
GRID = "GRID"
|
1203
1120
|
}
|
1204
|
-
|
1121
|
+
declare enum PollLayoutDirection {
|
1205
1122
|
/** Left-to-right */
|
1206
1123
|
LTR = "LTR",
|
1207
1124
|
/** Right-to-left */
|
1208
1125
|
RTL = "RTL"
|
1209
1126
|
}
|
1210
|
-
|
1127
|
+
interface PollLayout {
|
1211
1128
|
/** The layout for displaying the voting options. */
|
1212
1129
|
type?: PollLayoutType;
|
1213
1130
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
@@ -1215,11 +1132,11 @@ export interface PollLayout {
|
|
1215
1132
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
1216
1133
|
enableImage?: boolean | null;
|
1217
1134
|
}
|
1218
|
-
|
1135
|
+
interface OptionLayout {
|
1219
1136
|
/** Sets whether to display option images. Defaults to `false`. */
|
1220
1137
|
enableImage?: boolean | null;
|
1221
1138
|
}
|
1222
|
-
|
1139
|
+
declare enum BackgroundType {
|
1223
1140
|
/** Color background type */
|
1224
1141
|
COLOR = "COLOR",
|
1225
1142
|
/** Image background type */
|
@@ -1227,7 +1144,7 @@ export declare enum BackgroundType {
|
|
1227
1144
|
/** Gradiant background type */
|
1228
1145
|
GRADIENT = "GRADIENT"
|
1229
1146
|
}
|
1230
|
-
|
1147
|
+
interface Gradient {
|
1231
1148
|
/** The gradient angle in degrees. */
|
1232
1149
|
angle?: number | null;
|
1233
1150
|
/**
|
@@ -1241,7 +1158,7 @@ export interface Gradient {
|
|
1241
1158
|
*/
|
1242
1159
|
lastColor?: string | null;
|
1243
1160
|
}
|
1244
|
-
|
1161
|
+
interface Background extends BackgroundBackgroundOneOf {
|
1245
1162
|
/**
|
1246
1163
|
* The background color as a hexademical value.
|
1247
1164
|
* @format COLOR_HEX
|
@@ -1255,7 +1172,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
1255
1172
|
type?: BackgroundType;
|
1256
1173
|
}
|
1257
1174
|
/** @oneof */
|
1258
|
-
|
1175
|
+
interface BackgroundBackgroundOneOf {
|
1259
1176
|
/**
|
1260
1177
|
* The background color as a hexademical value.
|
1261
1178
|
* @format COLOR_HEX
|
@@ -1266,17 +1183,17 @@ export interface BackgroundBackgroundOneOf {
|
|
1266
1183
|
/** Details for a gradient background. */
|
1267
1184
|
gradient?: Gradient;
|
1268
1185
|
}
|
1269
|
-
|
1186
|
+
interface PollDesign {
|
1270
1187
|
/** Background styling. */
|
1271
1188
|
background?: Background;
|
1272
1189
|
/** Border radius in pixels. */
|
1273
1190
|
borderRadius?: number | null;
|
1274
1191
|
}
|
1275
|
-
|
1192
|
+
interface OptionDesign {
|
1276
1193
|
/** Border radius in pixels. */
|
1277
1194
|
borderRadius?: number | null;
|
1278
1195
|
}
|
1279
|
-
|
1196
|
+
interface Poll {
|
1280
1197
|
/** Poll ID. */
|
1281
1198
|
id?: string | null;
|
1282
1199
|
/** Poll title. */
|
@@ -1290,26 +1207,26 @@ export interface Poll {
|
|
1290
1207
|
/** The poll's permissions and display settings. */
|
1291
1208
|
settings?: PollSettings;
|
1292
1209
|
}
|
1293
|
-
|
1210
|
+
interface PollDataLayout {
|
1294
1211
|
/** Poll layout settings. */
|
1295
1212
|
poll?: PollLayout;
|
1296
1213
|
/** Voting otpions layout settings. */
|
1297
1214
|
options?: OptionLayout;
|
1298
1215
|
}
|
1299
|
-
|
1216
|
+
interface Design {
|
1300
1217
|
/** Styling for the poll. */
|
1301
1218
|
poll?: PollDesign;
|
1302
1219
|
/** Styling for voting options. */
|
1303
1220
|
options?: OptionDesign;
|
1304
1221
|
}
|
1305
|
-
|
1222
|
+
interface TextData {
|
1306
1223
|
/** The text to apply decorations to. */
|
1307
1224
|
text?: string;
|
1308
1225
|
/** The decorations to apply. */
|
1309
1226
|
decorations?: Decoration[];
|
1310
1227
|
}
|
1311
1228
|
/** Adds appearence changes to text */
|
1312
|
-
|
1229
|
+
interface Decoration extends DecorationDataOneOf {
|
1313
1230
|
/** Data for an anchor link decoration. */
|
1314
1231
|
anchorData?: AnchorData;
|
1315
1232
|
/** Data for a color decoration. */
|
@@ -1332,7 +1249,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
1332
1249
|
type?: DecorationType;
|
1333
1250
|
}
|
1334
1251
|
/** @oneof */
|
1335
|
-
|
1252
|
+
interface DecorationDataOneOf {
|
1336
1253
|
/** Data for an anchor link decoration. */
|
1337
1254
|
anchorData?: AnchorData;
|
1338
1255
|
/** Data for a color decoration. */
|
@@ -1352,7 +1269,7 @@ export interface DecorationDataOneOf {
|
|
1352
1269
|
/** Data for a spoiler decoration. */
|
1353
1270
|
spoilerData?: SpoilerData;
|
1354
1271
|
}
|
1355
|
-
|
1272
|
+
declare enum DecorationType {
|
1356
1273
|
BOLD = "BOLD",
|
1357
1274
|
ITALIC = "ITALIC",
|
1358
1275
|
UNDERLINE = "UNDERLINE",
|
@@ -1364,21 +1281,21 @@ export declare enum DecorationType {
|
|
1364
1281
|
FONT_SIZE = "FONT_SIZE",
|
1365
1282
|
EXTERNAL = "EXTERNAL"
|
1366
1283
|
}
|
1367
|
-
|
1284
|
+
interface AnchorData {
|
1368
1285
|
/** The target node's ID. */
|
1369
1286
|
anchor?: string;
|
1370
1287
|
}
|
1371
|
-
|
1288
|
+
interface ColorData {
|
1372
1289
|
/** The text's background color as a hexadecimal value. */
|
1373
1290
|
background?: string | null;
|
1374
1291
|
/** The text's foreground color as a hexadecimal value. */
|
1375
1292
|
foreground?: string | null;
|
1376
1293
|
}
|
1377
|
-
|
1294
|
+
interface LinkData {
|
1378
1295
|
/** Link details. */
|
1379
1296
|
link?: Link;
|
1380
1297
|
}
|
1381
|
-
|
1298
|
+
interface MentionData {
|
1382
1299
|
/** The mentioned user's name. */
|
1383
1300
|
name?: string;
|
1384
1301
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
@@ -1386,21 +1303,21 @@ export interface MentionData {
|
|
1386
1303
|
/** Mentioned user's ID. */
|
1387
1304
|
id?: string | null;
|
1388
1305
|
}
|
1389
|
-
|
1306
|
+
interface FontSizeData {
|
1390
1307
|
/** The units used for the font size. */
|
1391
1308
|
unit?: FontType;
|
1392
1309
|
/** Font size value. */
|
1393
1310
|
value?: number | null;
|
1394
1311
|
}
|
1395
|
-
|
1312
|
+
declare enum FontType {
|
1396
1313
|
PX = "PX",
|
1397
1314
|
EM = "EM"
|
1398
1315
|
}
|
1399
|
-
|
1316
|
+
interface SpoilerData {
|
1400
1317
|
/** Spoiler ID. */
|
1401
1318
|
id?: string | null;
|
1402
1319
|
}
|
1403
|
-
|
1320
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
1404
1321
|
/** Data for embedded Wix Bookings content. */
|
1405
1322
|
bookingData?: BookingData;
|
1406
1323
|
/** Data for embedded Wix Events content. */
|
@@ -1422,28 +1339,28 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1422
1339
|
image?: V1Media;
|
1423
1340
|
}
|
1424
1341
|
/** @oneof */
|
1425
|
-
|
1342
|
+
interface AppEmbedDataAppDataOneOf {
|
1426
1343
|
/** Data for embedded Wix Bookings content. */
|
1427
1344
|
bookingData?: BookingData;
|
1428
1345
|
/** Data for embedded Wix Events content. */
|
1429
1346
|
eventData?: EventData;
|
1430
1347
|
}
|
1431
|
-
|
1348
|
+
declare enum AppType {
|
1432
1349
|
PRODUCT = "PRODUCT",
|
1433
1350
|
EVENT = "EVENT",
|
1434
1351
|
BOOKING = "BOOKING"
|
1435
1352
|
}
|
1436
|
-
|
1353
|
+
interface BookingData {
|
1437
1354
|
/** Booking duration in minutes. */
|
1438
1355
|
durations?: string | null;
|
1439
1356
|
}
|
1440
|
-
|
1357
|
+
interface EventData {
|
1441
1358
|
/** Event schedule. */
|
1442
1359
|
scheduling?: string | null;
|
1443
1360
|
/** Event location. */
|
1444
1361
|
location?: string | null;
|
1445
1362
|
}
|
1446
|
-
|
1363
|
+
interface VideoData {
|
1447
1364
|
/** Styling for the video's container. */
|
1448
1365
|
containerData?: PluginContainerData;
|
1449
1366
|
/** Video details. */
|
@@ -1457,7 +1374,7 @@ export interface VideoData {
|
|
1457
1374
|
/** Video options. */
|
1458
1375
|
options?: PlaybackOptions;
|
1459
1376
|
}
|
1460
|
-
|
1377
|
+
interface PlaybackOptions {
|
1461
1378
|
/** Sets whether the media will automatically start playing. */
|
1462
1379
|
autoPlay?: boolean | null;
|
1463
1380
|
/** Sets whether media's will be looped. */
|
@@ -1465,7 +1382,7 @@ export interface PlaybackOptions {
|
|
1465
1382
|
/** Sets whether media's controls will be shown. */
|
1466
1383
|
showControls?: boolean | null;
|
1467
1384
|
}
|
1468
|
-
|
1385
|
+
interface EmbedData {
|
1469
1386
|
/** Styling for the oEmbed node's container. */
|
1470
1387
|
containerData?: PluginContainerData;
|
1471
1388
|
/** An [oEmbed](https://www.oembed.com) object. */
|
@@ -1473,7 +1390,7 @@ export interface EmbedData {
|
|
1473
1390
|
/** Origin asset source. */
|
1474
1391
|
src?: string | null;
|
1475
1392
|
}
|
1476
|
-
|
1393
|
+
interface Oembed {
|
1477
1394
|
/** The resource type. */
|
1478
1395
|
type?: string | null;
|
1479
1396
|
/** The width of the resource specified in the `url` property in pixels. */
|
@@ -1505,7 +1422,7 @@ export interface Oembed {
|
|
1505
1422
|
/** The oEmbed version number. This value must be `1.0`. */
|
1506
1423
|
version?: string | null;
|
1507
1424
|
}
|
1508
|
-
|
1425
|
+
interface CollapsibleListData {
|
1509
1426
|
/** Styling for the collapsible list's container. */
|
1510
1427
|
containerData?: PluginContainerData;
|
1511
1428
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
@@ -1517,7 +1434,7 @@ export interface CollapsibleListData {
|
|
1517
1434
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
1518
1435
|
isQapageData?: boolean | null;
|
1519
1436
|
}
|
1520
|
-
|
1437
|
+
declare enum InitialExpandedItems {
|
1521
1438
|
/** First item will be expended initally */
|
1522
1439
|
FIRST = "FIRST",
|
1523
1440
|
/** All items will expended initally */
|
@@ -1525,13 +1442,13 @@ export declare enum InitialExpandedItems {
|
|
1525
1442
|
/** All items collapsed initally */
|
1526
1443
|
NONE = "NONE"
|
1527
1444
|
}
|
1528
|
-
|
1445
|
+
declare enum Direction {
|
1529
1446
|
/** Left-to-right */
|
1530
1447
|
LTR = "LTR",
|
1531
1448
|
/** Right-to-left */
|
1532
1449
|
RTL = "RTL"
|
1533
1450
|
}
|
1534
|
-
|
1451
|
+
interface TableData {
|
1535
1452
|
/** Styling for the table's container. */
|
1536
1453
|
containerData?: PluginContainerData;
|
1537
1454
|
/** The table's dimensions. */
|
@@ -1546,7 +1463,7 @@ export interface TableData {
|
|
1546
1463
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
1547
1464
|
columnHeader?: boolean | null;
|
1548
1465
|
}
|
1549
|
-
|
1466
|
+
interface Dimensions {
|
1550
1467
|
/** An array representing relative width of each column in relation to the other columns. */
|
1551
1468
|
colsWidthRatio?: number[];
|
1552
1469
|
/** An array representing the height of each row in pixels. */
|
@@ -1554,13 +1471,13 @@ export interface Dimensions {
|
|
1554
1471
|
/** An array representing the minimum width of each column in pixels. */
|
1555
1472
|
colsMinWidth?: number[];
|
1556
1473
|
}
|
1557
|
-
|
1474
|
+
interface TableCellData {
|
1558
1475
|
/** Styling for the cell's background color and text alignment. */
|
1559
1476
|
cellStyle?: CellStyle;
|
1560
1477
|
/** The cell's border colors. */
|
1561
1478
|
borderColors?: BorderColors;
|
1562
1479
|
}
|
1563
|
-
|
1480
|
+
declare enum VerticalAlignment {
|
1564
1481
|
/** Top alignment */
|
1565
1482
|
TOP = "TOP",
|
1566
1483
|
/** Middle alignment */
|
@@ -1568,7 +1485,7 @@ export declare enum VerticalAlignment {
|
|
1568
1485
|
/** Bottom alignment */
|
1569
1486
|
BOTTOM = "BOTTOM"
|
1570
1487
|
}
|
1571
|
-
|
1488
|
+
interface CellStyle {
|
1572
1489
|
/** Vertical alignment for the cell's text. */
|
1573
1490
|
verticalAlignment?: VerticalAlignment;
|
1574
1491
|
/**
|
@@ -1577,7 +1494,7 @@ export interface CellStyle {
|
|
1577
1494
|
*/
|
1578
1495
|
backgroundColor?: string | null;
|
1579
1496
|
}
|
1580
|
-
|
1497
|
+
interface BorderColors {
|
1581
1498
|
/**
|
1582
1499
|
* Left border color as a hexadecimal value.
|
1583
1500
|
* @format COLOR_HEX
|
@@ -1599,26 +1516,7 @@ export interface BorderColors {
|
|
1599
1516
|
*/
|
1600
1517
|
bottom?: string | null;
|
1601
1518
|
}
|
1602
|
-
|
1603
|
-
* `NullValue` is a singleton enumeration to represent the null value for the
|
1604
|
-
* `Value` type union.
|
1605
|
-
*
|
1606
|
-
* The JSON representation for `NullValue` is JSON `null`.
|
1607
|
-
*/
|
1608
|
-
export declare enum NullValue {
|
1609
|
-
/** Null value. */
|
1610
|
-
NULL_VALUE = "NULL_VALUE"
|
1611
|
-
}
|
1612
|
-
/**
|
1613
|
-
* `ListValue` is a wrapper around a repeated field of values.
|
1614
|
-
*
|
1615
|
-
* The JSON representation for `ListValue` is JSON array.
|
1616
|
-
*/
|
1617
|
-
export interface ListValue {
|
1618
|
-
/** Repeated field of dynamically typed values. */
|
1619
|
-
values?: any[];
|
1620
|
-
}
|
1621
|
-
export interface AudioData {
|
1519
|
+
interface AudioData {
|
1622
1520
|
/** Styling for the audio node's container. */
|
1623
1521
|
containerData?: PluginContainerData;
|
1624
1522
|
/** Audio file details. */
|
@@ -1634,7 +1532,7 @@ export interface AudioData {
|
|
1634
1532
|
/** An HTML version of the audio node. */
|
1635
1533
|
html?: string | null;
|
1636
1534
|
}
|
1637
|
-
|
1535
|
+
interface OrderedListData {
|
1638
1536
|
/** Indentation level from 0-4. */
|
1639
1537
|
indentation?: number;
|
1640
1538
|
/** Offset level from 0-4. */
|
@@ -1642,24 +1540,24 @@ export interface OrderedListData {
|
|
1642
1540
|
/** List start number. */
|
1643
1541
|
start?: number | null;
|
1644
1542
|
}
|
1645
|
-
|
1543
|
+
interface BulletedListData {
|
1646
1544
|
/** Indentation level from 0-4. */
|
1647
1545
|
indentation?: number;
|
1648
1546
|
/** Offset level from 0-4. */
|
1649
1547
|
offset?: number | null;
|
1650
1548
|
}
|
1651
|
-
|
1549
|
+
interface BlockquoteData {
|
1652
1550
|
/** Indentation level from 1-4. */
|
1653
1551
|
indentation?: number;
|
1654
1552
|
}
|
1655
|
-
|
1553
|
+
interface CaptionData {
|
1656
1554
|
textStyle?: TextStyle;
|
1657
1555
|
}
|
1658
|
-
|
1556
|
+
interface LayoutCellData {
|
1659
1557
|
/** Size of the cell in 12 columns grid. */
|
1660
1558
|
colSpan?: number | null;
|
1661
1559
|
}
|
1662
|
-
|
1560
|
+
interface Metadata {
|
1663
1561
|
/** Schema version. */
|
1664
1562
|
version?: number;
|
1665
1563
|
/**
|
@@ -1676,7 +1574,7 @@ export interface Metadata {
|
|
1676
1574
|
/** Object ID. */
|
1677
1575
|
id?: string | null;
|
1678
1576
|
}
|
1679
|
-
|
1577
|
+
interface DocumentStyle {
|
1680
1578
|
/** Styling for H1 nodes. */
|
1681
1579
|
headerOne?: TextNodeStyle;
|
1682
1580
|
/** Styling for H2 nodes. */
|
@@ -1696,7 +1594,7 @@ export interface DocumentStyle {
|
|
1696
1594
|
/** Styling for code block nodes. */
|
1697
1595
|
codeBlock?: TextNodeStyle;
|
1698
1596
|
}
|
1699
|
-
|
1597
|
+
interface TextNodeStyle {
|
1700
1598
|
/** The decorations to apply to the node. */
|
1701
1599
|
decorations?: Decoration[];
|
1702
1600
|
/** Padding and background color for the node. */
|
@@ -1704,7 +1602,7 @@ export interface TextNodeStyle {
|
|
1704
1602
|
/** Line height for text in the node. */
|
1705
1603
|
lineHeight?: string | null;
|
1706
1604
|
}
|
1707
|
-
|
1605
|
+
interface ModerationDetails {
|
1708
1606
|
/**
|
1709
1607
|
* Member ID of the person submitting the draft post for review.
|
1710
1608
|
* @format GUID
|
@@ -1722,12 +1620,12 @@ export interface ModerationDetails {
|
|
1722
1620
|
/** Date the post was approved or rejected. */
|
1723
1621
|
moderationDate?: Date | null;
|
1724
1622
|
}
|
1725
|
-
|
1623
|
+
declare enum ModerationStatusStatus {
|
1726
1624
|
UNKNOWN = "UNKNOWN",
|
1727
1625
|
APPROVED = "APPROVED",
|
1728
1626
|
REJECTED = "REJECTED"
|
1729
1627
|
}
|
1730
|
-
|
1628
|
+
interface Media extends MediaMediaOneOf {
|
1731
1629
|
/** Wix Media details. */
|
1732
1630
|
wixMedia?: WixMedia;
|
1733
1631
|
/** Embed media details. */
|
@@ -1744,19 +1642,19 @@ export interface Media extends MediaMediaOneOf {
|
|
1744
1642
|
altText?: string | null;
|
1745
1643
|
}
|
1746
1644
|
/** @oneof */
|
1747
|
-
|
1645
|
+
interface MediaMediaOneOf {
|
1748
1646
|
/** Wix Media details. */
|
1749
1647
|
wixMedia?: WixMedia;
|
1750
1648
|
/** Embed media details. */
|
1751
1649
|
embedMedia?: EmbedMedia;
|
1752
1650
|
}
|
1753
|
-
|
1651
|
+
interface WixMedia {
|
1754
1652
|
/** Image details. */
|
1755
1653
|
image?: Image;
|
1756
1654
|
/** Video details. */
|
1757
1655
|
videoV2?: VideoV2;
|
1758
1656
|
}
|
1759
|
-
|
1657
|
+
interface VideoV2 {
|
1760
1658
|
/** WixMedia ID. */
|
1761
1659
|
id?: string;
|
1762
1660
|
/**
|
@@ -1771,7 +1669,7 @@ export interface VideoV2 {
|
|
1771
1669
|
*/
|
1772
1670
|
filename?: string | null;
|
1773
1671
|
}
|
1774
|
-
|
1672
|
+
interface VideoResolution {
|
1775
1673
|
/** Video URL. */
|
1776
1674
|
url?: string;
|
1777
1675
|
/** Video height. */
|
@@ -1781,13 +1679,13 @@ export interface VideoResolution {
|
|
1781
1679
|
/** Video format for example, mp4, hls. */
|
1782
1680
|
format?: string;
|
1783
1681
|
}
|
1784
|
-
|
1682
|
+
interface EmbedMedia {
|
1785
1683
|
/** Thumbnail details. */
|
1786
1684
|
thumbnail?: EmbedThumbnail;
|
1787
1685
|
/** Video details. */
|
1788
1686
|
video?: EmbedVideo;
|
1789
1687
|
}
|
1790
|
-
|
1688
|
+
interface EmbedThumbnail {
|
1791
1689
|
/**
|
1792
1690
|
* Thumbnail url.
|
1793
1691
|
* @maxLength 2000
|
@@ -1798,7 +1696,7 @@ export interface EmbedThumbnail {
|
|
1798
1696
|
/** Thumbnail height. */
|
1799
1697
|
height?: number;
|
1800
1698
|
}
|
1801
|
-
|
1699
|
+
interface EmbedVideo {
|
1802
1700
|
/**
|
1803
1701
|
* Video url.
|
1804
1702
|
* @maxLength 2000
|
@@ -1809,115 +1707,8 @@ export interface EmbedVideo {
|
|
1809
1707
|
/** Video height. */
|
1810
1708
|
height?: number;
|
1811
1709
|
}
|
1812
|
-
export interface PostTranslation {
|
1813
|
-
/**
|
1814
|
-
* Post ID.
|
1815
|
-
* @format GUID
|
1816
|
-
*/
|
1817
|
-
id?: string;
|
1818
|
-
/**
|
1819
|
-
* Language the post is written in.
|
1820
|
-
* @format LANGUAGE_TAG
|
1821
|
-
*/
|
1822
|
-
language?: string | null;
|
1823
|
-
/**
|
1824
|
-
* Post slug. For example, 'post-slug'.
|
1825
|
-
* @maxLength 100
|
1826
|
-
*/
|
1827
|
-
slug?: string | null;
|
1828
|
-
/** SEO data. */
|
1829
|
-
seoData?: SeoSchema;
|
1830
|
-
/** Post URL. */
|
1831
|
-
url?: PageUrl;
|
1832
|
-
}
|
1833
|
-
export interface PostCategoriesUpdated {
|
1834
|
-
/**
|
1835
|
-
* ID of the post which counters were updated.
|
1836
|
-
* @format GUID
|
1837
|
-
*/
|
1838
|
-
postId?: string;
|
1839
|
-
/**
|
1840
|
-
* Current categories of the post.
|
1841
|
-
* @maxSize 10
|
1842
|
-
* @format GUID
|
1843
|
-
*/
|
1844
|
-
categories?: string[];
|
1845
|
-
/**
|
1846
|
-
* Previous categories of the post.
|
1847
|
-
* @maxSize 10
|
1848
|
-
* @format GUID
|
1849
|
-
*/
|
1850
|
-
previousCategories?: string[];
|
1851
|
-
}
|
1852
|
-
export interface PostTagsUpdated {
|
1853
|
-
/**
|
1854
|
-
* ID of the post which counters were updated.
|
1855
|
-
* @format GUID
|
1856
|
-
*/
|
1857
|
-
postId?: string;
|
1858
|
-
/**
|
1859
|
-
* Current tags of the post.
|
1860
|
-
* @maxSize 30
|
1861
|
-
* @format GUID
|
1862
|
-
*/
|
1863
|
-
tags?: string[];
|
1864
|
-
/**
|
1865
|
-
* Previous tags of the post.
|
1866
|
-
* @maxSize 30
|
1867
|
-
* @format GUID
|
1868
|
-
*/
|
1869
|
-
previousTags?: string[];
|
1870
|
-
}
|
1871
|
-
export interface ScheduledPostPublished {
|
1872
|
-
/**
|
1873
|
-
* ID of the scheduled post which was published.
|
1874
|
-
* @format GUID
|
1875
|
-
*/
|
1876
|
-
postId?: string;
|
1877
|
-
}
|
1878
|
-
/** Get Blog Publications Count Stats request */
|
1879
|
-
export interface QueryPublicationsCountStatsRequest {
|
1880
|
-
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1881
|
-
rangeStart?: Date | null;
|
1882
|
-
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1883
|
-
rangeEnd?: Date | null;
|
1884
|
-
/** Order of the returned results. */
|
1885
|
-
order?: QueryPublicationsCountStatsRequestOrder;
|
1886
|
-
/** Number of months to include in the response. */
|
1887
|
-
months?: number;
|
1888
|
-
/**
|
1889
|
-
* Language filter
|
1890
|
-
*
|
1891
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
1892
|
-
* @format LANGUAGE_TAG
|
1893
|
-
*/
|
1894
|
-
language?: string | null;
|
1895
|
-
/**
|
1896
|
-
* Timezone of the client.
|
1897
|
-
* @minLength 3
|
1898
|
-
* @maxLength 100
|
1899
|
-
*/
|
1900
|
-
timeZone?: string | null;
|
1901
|
-
}
|
1902
|
-
export declare enum QueryPublicationsCountStatsRequestOrder {
|
1903
|
-
UNKNOWN = "UNKNOWN",
|
1904
|
-
OLDEST = "OLDEST",
|
1905
|
-
NEWEST = "NEWEST"
|
1906
|
-
}
|
1907
|
-
/** Get Blog Publications Count Stats response */
|
1908
|
-
export interface QueryPublicationsCountStatsResponse {
|
1909
|
-
/** Chronologically ordered list of publications. */
|
1910
|
-
stats?: PeriodPublicationsCount[];
|
1911
|
-
}
|
1912
|
-
/** Publications count for a specific time period */
|
1913
|
-
export interface PeriodPublicationsCount {
|
1914
|
-
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1915
|
-
periodStart?: Date | null;
|
1916
|
-
/** Number of posts published during this month. */
|
1917
|
-
publicationsCount?: number;
|
1918
|
-
}
|
1919
1710
|
/** Get Blog Post Count Stats request */
|
1920
|
-
|
1711
|
+
interface QueryPostCountStatsRequest {
|
1921
1712
|
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1922
1713
|
rangeStart?: Date | null;
|
1923
1714
|
/**
|
@@ -1948,36 +1739,24 @@ export interface QueryPostCountStatsRequest {
|
|
1948
1739
|
*/
|
1949
1740
|
timeZone?: string | null;
|
1950
1741
|
}
|
1951
|
-
|
1742
|
+
declare enum Order {
|
1952
1743
|
UNKNOWN = "UNKNOWN",
|
1953
1744
|
OLDEST = "OLDEST",
|
1954
1745
|
NEWEST = "NEWEST"
|
1955
1746
|
}
|
1956
1747
|
/** Get Blog Post Count Stats response */
|
1957
|
-
|
1748
|
+
interface QueryPostCountStatsResponse {
|
1958
1749
|
/** List of published post counts by month. */
|
1959
1750
|
stats?: PeriodPostCount[];
|
1960
1751
|
}
|
1961
1752
|
/** Post count for a specific time period */
|
1962
|
-
|
1753
|
+
interface PeriodPostCount {
|
1963
1754
|
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
|
1964
1755
|
periodStart?: Date | null;
|
1965
1756
|
/** Number of posts published during this month. */
|
1966
1757
|
postCount?: number;
|
1967
1758
|
}
|
1968
|
-
|
1969
|
-
/**
|
1970
|
-
* Language filter
|
1971
|
-
* @minLength 2
|
1972
|
-
* @format LANGUAGE_TAG
|
1973
|
-
*/
|
1974
|
-
language?: string | null;
|
1975
|
-
}
|
1976
|
-
export interface GetTotalPublicationsResponse {
|
1977
|
-
/** Total amount of publications. */
|
1978
|
-
total?: number;
|
1979
|
-
}
|
1980
|
-
export interface GetTotalPostsRequest {
|
1759
|
+
interface GetTotalPostsRequest {
|
1981
1760
|
/**
|
1982
1761
|
* Language filter.
|
1983
1762
|
*
|
@@ -1987,178 +1766,11 @@ export interface GetTotalPostsRequest {
|
|
1987
1766
|
*/
|
1988
1767
|
language?: string | null;
|
1989
1768
|
}
|
1990
|
-
|
1769
|
+
interface GetTotalPostsResponse {
|
1991
1770
|
/** Total amount of published posts. */
|
1992
1771
|
total?: number;
|
1993
1772
|
}
|
1994
|
-
|
1995
|
-
createdEvent?: EntityCreatedEvent;
|
1996
|
-
updatedEvent?: EntityUpdatedEvent;
|
1997
|
-
deletedEvent?: EntityDeletedEvent;
|
1998
|
-
actionEvent?: ActionEvent;
|
1999
|
-
/**
|
2000
|
-
* Unique event ID.
|
2001
|
-
* Allows clients to ignore duplicate webhooks.
|
2002
|
-
*/
|
2003
|
-
id?: string;
|
2004
|
-
/**
|
2005
|
-
* Assumes actions are also always typed to an entity_type
|
2006
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
2007
|
-
*/
|
2008
|
-
entityFqdn?: string;
|
2009
|
-
/**
|
2010
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
2011
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
2012
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
2013
|
-
*/
|
2014
|
-
slug?: string;
|
2015
|
-
/** ID of the entity associated with the event. */
|
2016
|
-
entityId?: string;
|
2017
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
2018
|
-
eventTime?: Date | null;
|
2019
|
-
/**
|
2020
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
2021
|
-
* (for example, GDPR).
|
2022
|
-
*/
|
2023
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
2024
|
-
/** If present, indicates the action that triggered the event. */
|
2025
|
-
originatedFrom?: string | null;
|
2026
|
-
/**
|
2027
|
-
* A sequence number defining the order of updates to the underlying entity.
|
2028
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
2029
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
2030
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
2031
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
2032
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
2033
|
-
*/
|
2034
|
-
entityEventSequence?: string | null;
|
2035
|
-
}
|
2036
|
-
/** @oneof */
|
2037
|
-
export interface DomainEventBodyOneOf {
|
2038
|
-
createdEvent?: EntityCreatedEvent;
|
2039
|
-
updatedEvent?: EntityUpdatedEvent;
|
2040
|
-
deletedEvent?: EntityDeletedEvent;
|
2041
|
-
actionEvent?: ActionEvent;
|
2042
|
-
}
|
2043
|
-
export interface EntityCreatedEvent {
|
2044
|
-
entityAsJson?: string;
|
2045
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
2046
|
-
restoreInfo?: RestoreInfo;
|
2047
|
-
}
|
2048
|
-
export interface RestoreInfo {
|
2049
|
-
deletedDate?: Date | null;
|
2050
|
-
}
|
2051
|
-
export interface EntityUpdatedEvent {
|
2052
|
-
/**
|
2053
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
2054
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
2055
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
2056
|
-
*/
|
2057
|
-
currentEntityAsJson?: string;
|
2058
|
-
}
|
2059
|
-
export interface EntityDeletedEvent {
|
2060
|
-
/** Entity that was deleted */
|
2061
|
-
deletedEntityAsJson?: string | null;
|
2062
|
-
}
|
2063
|
-
export interface ActionEvent {
|
2064
|
-
bodyAsJson?: string;
|
2065
|
-
}
|
2066
|
-
export interface MessageEnvelope {
|
2067
|
-
/**
|
2068
|
-
* App instance ID.
|
2069
|
-
* @format GUID
|
2070
|
-
*/
|
2071
|
-
instanceId?: string | null;
|
2072
|
-
/**
|
2073
|
-
* Event type.
|
2074
|
-
* @maxLength 150
|
2075
|
-
*/
|
2076
|
-
eventType?: string;
|
2077
|
-
/** The identification type and identity data. */
|
2078
|
-
identity?: IdentificationData;
|
2079
|
-
/** Stringify payload. */
|
2080
|
-
data?: string;
|
2081
|
-
}
|
2082
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
2083
|
-
/**
|
2084
|
-
* ID of a site visitor that has not logged in to the site.
|
2085
|
-
* @format GUID
|
2086
|
-
*/
|
2087
|
-
anonymousVisitorId?: string;
|
2088
|
-
/**
|
2089
|
-
* ID of a site visitor that has logged in to the site.
|
2090
|
-
* @format GUID
|
2091
|
-
*/
|
2092
|
-
memberId?: string;
|
2093
|
-
/**
|
2094
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
2095
|
-
* @format GUID
|
2096
|
-
*/
|
2097
|
-
wixUserId?: string;
|
2098
|
-
/**
|
2099
|
-
* ID of an app.
|
2100
|
-
* @format GUID
|
2101
|
-
*/
|
2102
|
-
appId?: string;
|
2103
|
-
/** @readonly */
|
2104
|
-
identityType?: WebhookIdentityType;
|
2105
|
-
}
|
2106
|
-
/** @oneof */
|
2107
|
-
export interface IdentificationDataIdOneOf {
|
2108
|
-
/**
|
2109
|
-
* ID of a site visitor that has not logged in to the site.
|
2110
|
-
* @format GUID
|
2111
|
-
*/
|
2112
|
-
anonymousVisitorId?: string;
|
2113
|
-
/**
|
2114
|
-
* ID of a site visitor that has logged in to the site.
|
2115
|
-
* @format GUID
|
2116
|
-
*/
|
2117
|
-
memberId?: string;
|
2118
|
-
/**
|
2119
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
2120
|
-
* @format GUID
|
2121
|
-
*/
|
2122
|
-
wixUserId?: string;
|
2123
|
-
/**
|
2124
|
-
* ID of an app.
|
2125
|
-
* @format GUID
|
2126
|
-
*/
|
2127
|
-
appId?: string;
|
2128
|
-
}
|
2129
|
-
export declare enum WebhookIdentityType {
|
2130
|
-
UNKNOWN = "UNKNOWN",
|
2131
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
2132
|
-
MEMBER = "MEMBER",
|
2133
|
-
WIX_USER = "WIX_USER",
|
2134
|
-
APP = "APP"
|
2135
|
-
}
|
2136
|
-
export interface ListTemplatesRequest {
|
2137
|
-
/**
|
2138
|
-
* Filter post templates by given template category ids
|
2139
|
-
* @maxSize 50
|
2140
|
-
* @format GUID
|
2141
|
-
*/
|
2142
|
-
categoryIds?: string[];
|
2143
|
-
/**
|
2144
|
-
* Filter post templates by provided language
|
2145
|
-
* @format LANGUAGE_TAG
|
2146
|
-
*/
|
2147
|
-
language?: string | null;
|
2148
|
-
/** Returns post template categories when set to TRUE */
|
2149
|
-
listTemplateCategories?: boolean;
|
2150
|
-
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
|
2151
|
-
sort?: GetPostTemplatesSort;
|
2152
|
-
/** Pagination options. */
|
2153
|
-
paging?: BlogPaging;
|
2154
|
-
}
|
2155
|
-
export declare enum GetPostTemplatesSort {
|
2156
|
-
/** Sort by ascending publishing date. */
|
2157
|
-
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
|
2158
|
-
/** Sort by descending publishing date. */
|
2159
|
-
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
|
2160
|
-
}
|
2161
|
-
export interface BlogPaging {
|
1773
|
+
interface BlogPaging {
|
2162
1774
|
/**
|
2163
1775
|
* Number of items to skip in the current sort order.
|
2164
1776
|
*
|
@@ -2181,15 +1793,7 @@ export interface BlogPaging {
|
|
2181
1793
|
*/
|
2182
1794
|
cursor?: string | null;
|
2183
1795
|
}
|
2184
|
-
|
2185
|
-
/** Available post templates */
|
2186
|
-
postTemplates?: Post[];
|
2187
|
-
/** Details on the paged set of posts templates returned. */
|
2188
|
-
postTemplatesMetaData?: MetaData;
|
2189
|
-
/** Post template categories. This value is returned empty unless asked explicitly */
|
2190
|
-
templateCategories?: Category[];
|
2191
|
-
}
|
2192
|
-
export interface MetaData {
|
1796
|
+
interface MetaData {
|
2193
1797
|
/** Number of items returned in this response. */
|
2194
1798
|
count?: number;
|
2195
1799
|
/** Requested offset. */
|
@@ -2202,542 +1806,66 @@ export interface MetaData {
|
|
2202
1806
|
*/
|
2203
1807
|
cursor?: string | null;
|
2204
1808
|
}
|
2205
|
-
|
1809
|
+
interface GetPostRequest {
|
2206
1810
|
/**
|
2207
|
-
*
|
2208
|
-
* @
|
1811
|
+
* Post ID.
|
1812
|
+
* @minLength 1
|
2209
1813
|
* @maxLength 38
|
2210
1814
|
*/
|
2211
|
-
|
1815
|
+
postId: string;
|
2212
1816
|
/**
|
2213
|
-
*
|
2214
|
-
*
|
1817
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
1818
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
1819
|
+
* only the post’s base fields are returned.
|
1820
|
+
* @maxSize 20
|
2215
1821
|
*/
|
2216
|
-
|
1822
|
+
fieldsets?: PostFieldField[];
|
1823
|
+
}
|
1824
|
+
declare enum PostFieldField {
|
1825
|
+
UNKNOWN = "UNKNOWN",
|
1826
|
+
/** Includes post URL when present. */
|
1827
|
+
URL = "URL",
|
1828
|
+
/** Includes post content text string when present. */
|
1829
|
+
CONTENT_TEXT = "CONTENT_TEXT",
|
1830
|
+
/** Includes post metrics when present. */
|
1831
|
+
METRICS = "METRICS",
|
1832
|
+
/** Includes SEO data. */
|
1833
|
+
SEO = "SEO",
|
1834
|
+
/** Includes post owner's contact ID. */
|
1835
|
+
CONTACT_ID = "CONTACT_ID",
|
1836
|
+
/** Includes post rich content. */
|
1837
|
+
RICH_CONTENT = "RICH_CONTENT",
|
1838
|
+
/** Includes post reference ID field. */
|
1839
|
+
REFERENCE_ID = "REFERENCE_ID"
|
1840
|
+
}
|
1841
|
+
interface GetPostResponse {
|
1842
|
+
/** Retrieved post info. */
|
1843
|
+
post?: Post;
|
1844
|
+
}
|
1845
|
+
interface GetPostBySlugRequest {
|
2217
1846
|
/**
|
2218
|
-
*
|
2219
|
-
* @
|
1847
|
+
* Slug of the post to retrieve.
|
1848
|
+
* @minLength 1
|
1849
|
+
* @maxLength 200
|
2220
1850
|
*/
|
2221
|
-
|
1851
|
+
slug: string;
|
2222
1852
|
/**
|
2223
|
-
*
|
2224
|
-
*
|
1853
|
+
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
1854
|
+
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
1855
|
+
* only the post’s base fields are returned.
|
1856
|
+
* @maxSize 20
|
2225
1857
|
*/
|
2226
|
-
|
1858
|
+
fieldsets?: PostFieldField[];
|
1859
|
+
}
|
1860
|
+
interface GetPostBySlugResponse {
|
1861
|
+
/** Retrieved post info. */
|
1862
|
+
post?: Post;
|
1863
|
+
}
|
1864
|
+
interface ListPostsRequest {
|
2227
1865
|
/**
|
2228
|
-
*
|
2229
|
-
*
|
2230
|
-
|
2231
|
-
description?: string | null;
|
2232
|
-
/**
|
2233
|
-
* Category title.
|
2234
|
-
* @maxLength 200
|
2235
|
-
* @deprecated Category title.
|
2236
|
-
* @targetRemovalDate 2025-07-16
|
2237
|
-
*/
|
2238
|
-
title?: string;
|
2239
|
-
/**
|
2240
|
-
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
2241
|
-
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
2242
|
-
*
|
2243
|
-
* Default: `-1`
|
2244
|
-
*/
|
2245
|
-
displayPosition?: number | null;
|
2246
|
-
/**
|
2247
|
-
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
2248
|
-
* @format GUID
|
2249
|
-
*/
|
2250
|
-
translationId?: string | null;
|
2251
|
-
/**
|
2252
|
-
* Category language.
|
2253
|
-
*
|
2254
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
2255
|
-
* @immutable
|
2256
|
-
*/
|
2257
|
-
language?: string | null;
|
2258
|
-
/**
|
2259
|
-
* 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`.
|
2260
|
-
* @maxLength 100
|
2261
|
-
*/
|
2262
|
-
slug?: string;
|
2263
|
-
/** SEO data. */
|
2264
|
-
seoData?: SeoSchema;
|
2265
|
-
/** Category cover image. */
|
2266
|
-
coverImage?: Image;
|
2267
|
-
/**
|
2268
|
-
* Date and time the Category was last updated.
|
2269
|
-
* @readonly
|
2270
|
-
*/
|
2271
|
-
updatedDate?: Date | null;
|
2272
|
-
}
|
2273
|
-
export interface CategoryTranslation {
|
2274
|
-
/**
|
2275
|
-
* Category ID.
|
2276
|
-
* @format GUID
|
2277
|
-
*/
|
2278
|
-
id?: string;
|
2279
|
-
/**
|
2280
|
-
* Label displayed in the categories menu on the site.
|
2281
|
-
* @maxLength 100
|
2282
|
-
*/
|
2283
|
-
label?: string | null;
|
2284
|
-
/**
|
2285
|
-
* Language of the category.
|
2286
|
-
* @format LANGUAGE_TAG
|
2287
|
-
*/
|
2288
|
-
language?: string | null;
|
2289
|
-
/** URL of this category page. */
|
2290
|
-
url?: PageUrl;
|
2291
|
-
}
|
2292
|
-
export interface GetTemplateRequest {
|
2293
|
-
/**
|
2294
|
-
* Post template id
|
2295
|
-
* @format GUID
|
2296
|
-
*/
|
2297
|
-
postTemplateId?: string;
|
2298
|
-
}
|
2299
|
-
export interface GetTemplateResponse {
|
2300
|
-
/** Post template */
|
2301
|
-
postTemplate?: Post;
|
2302
|
-
}
|
2303
|
-
export interface CreateDraftPostFromTemplateRequest {
|
2304
|
-
/**
|
2305
|
-
* Post template id
|
2306
|
-
* @format GUID
|
2307
|
-
*/
|
2308
|
-
postTemplateId?: string;
|
2309
|
-
}
|
2310
|
-
export interface CreateDraftPostFromTemplateResponse {
|
2311
|
-
/** Created draft post */
|
2312
|
-
draftPost?: DraftPost;
|
2313
|
-
}
|
2314
|
-
export interface DraftPost {
|
2315
|
-
/**
|
2316
|
-
* Draft post ID.
|
2317
|
-
* @readonly
|
2318
|
-
* @maxLength 38
|
2319
|
-
*/
|
2320
|
-
id?: string;
|
2321
|
-
/**
|
2322
|
-
* Draft post title.
|
2323
|
-
* @maxLength 200
|
2324
|
-
*/
|
2325
|
-
title?: string;
|
2326
|
-
/**
|
2327
|
-
* Draft post excerpt.
|
2328
|
-
*
|
2329
|
-
* If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
|
2330
|
-
* This can be retrieved using the `GENERATED_EXCERPT` fieldset.
|
2331
|
-
* @maxLength 500
|
2332
|
-
*/
|
2333
|
-
excerpt?: string | null;
|
2334
|
-
/** Whether the draft post is marked as featured. */
|
2335
|
-
featured?: boolean | null;
|
2336
|
-
/**
|
2337
|
-
* Category IDs of the draft post.
|
2338
|
-
* @maxSize 10
|
2339
|
-
* @maxLength 38
|
2340
|
-
*/
|
2341
|
-
categoryIds?: string[];
|
2342
|
-
/**
|
2343
|
-
* Draft post owner's member ID.
|
2344
|
-
* @format GUID
|
2345
|
-
*/
|
2346
|
-
memberId?: string | null;
|
2347
|
-
/**
|
2348
|
-
* Hashtags in the post.
|
2349
|
-
* @maxSize 100
|
2350
|
-
* @maxLength 100
|
2351
|
-
*/
|
2352
|
-
hashtags?: string[];
|
2353
|
-
/** Whether commenting on the draft post is enabled. */
|
2354
|
-
commentingEnabled?: boolean | null;
|
2355
|
-
/**
|
2356
|
-
* Estimated reading time of the draft post (calculated automatically).
|
2357
|
-
* @readonly
|
2358
|
-
*/
|
2359
|
-
minutesToRead?: number;
|
2360
|
-
/** Image placed at the top of the blog page. */
|
2361
|
-
heroImage?: Image;
|
2362
|
-
/**
|
2363
|
-
* Tag IDs the draft post is tagged with.
|
2364
|
-
* @maxSize 30
|
2365
|
-
* @maxLength 38
|
2366
|
-
*/
|
2367
|
-
tagIds?: string[];
|
2368
|
-
/**
|
2369
|
-
* IDs of posts related to this draft post.
|
2370
|
-
* @maxSize 3
|
2371
|
-
* @maxLength 38
|
2372
|
-
*/
|
2373
|
-
relatedPostIds?: string[];
|
2374
|
-
/**
|
2375
|
-
* Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
|
2376
|
-
* @maxSize 100
|
2377
|
-
* @format GUID
|
2378
|
-
*/
|
2379
|
-
pricingPlanIds?: string[];
|
2380
|
-
/**
|
2381
|
-
* ID of the draft post's translations.
|
2382
|
-
*
|
2383
|
-
* All translations of a single post share the same `translationId`.
|
2384
|
-
* Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
|
2385
|
-
* @format GUID
|
2386
|
-
*/
|
2387
|
-
translationId?: string | null;
|
2388
|
-
/**
|
2389
|
-
* Language the draft post is written in.
|
2390
|
-
*
|
2391
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
2392
|
-
* @format LANGUAGE_TAG
|
2393
|
-
*/
|
2394
|
-
language?: string | null;
|
2395
|
-
/**
|
2396
|
-
* Draft Post rich content.
|
2397
|
-
*
|
2398
|
-
* <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">
|
2399
|
-
* <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
|
2400
|
-
* </widget>
|
2401
|
-
*/
|
2402
|
-
richContent?: RichContent;
|
2403
|
-
/**
|
2404
|
-
* Status of the draft post.
|
2405
|
-
* @readonly
|
2406
|
-
*/
|
2407
|
-
status?: Status;
|
2408
|
-
/** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
|
2409
|
-
moderationDetails?: ModerationDetails;
|
2410
|
-
/**
|
2411
|
-
* Indicates if there are changes made to the draft post that have not yet been published.
|
2412
|
-
* @readonly
|
2413
|
-
*/
|
2414
|
-
hasUnpublishedChanges?: boolean;
|
2415
|
-
/**
|
2416
|
-
* Date the draft post was last edited.
|
2417
|
-
* @readonly
|
2418
|
-
*/
|
2419
|
-
editedDate?: Date | null;
|
2420
|
-
/**
|
2421
|
-
* Date the draft post is scheduled to be published.
|
2422
|
-
* @readonly
|
2423
|
-
*/
|
2424
|
-
scheduledPublishDate?: Date | null;
|
2425
|
-
/** Date the post was first published. */
|
2426
|
-
firstPublishedDate?: Date | null;
|
2427
|
-
/** SEO data. */
|
2428
|
-
seoData?: SeoSchema;
|
2429
|
-
/**
|
2430
|
-
* Draft post URL preview. What the URL will look like once the post is published.
|
2431
|
-
* @readonly
|
2432
|
-
*/
|
2433
|
-
url?: PageUrl;
|
2434
|
-
/**
|
2435
|
-
* Date the draft post was first created.
|
2436
|
-
* @readonly
|
2437
|
-
*/
|
2438
|
-
createdDate?: Date | null;
|
2439
|
-
/**
|
2440
|
-
* SEO slug.
|
2441
|
-
* @maxLength 100
|
2442
|
-
*/
|
2443
|
-
seoSlug?: string | null;
|
2444
|
-
/** Post cover media. */
|
2445
|
-
media?: Media;
|
2446
|
-
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
2447
|
-
previewTextParagraph?: number | null;
|
2448
|
-
}
|
2449
|
-
export declare enum Origin {
|
2450
|
-
UNKNOWN = "UNKNOWN",
|
2451
|
-
/** Changed by admin */
|
2452
|
-
ADMIN = "ADMIN",
|
2453
|
-
/** Categories were changed */
|
2454
|
-
ADD_CATEGORIES = "ADD_CATEGORIES",
|
2455
|
-
/** Saved automatically */
|
2456
|
-
AUTO_SAVE = "AUTO_SAVE",
|
2457
|
-
/** Copied from template */
|
2458
|
-
COPY_TEMPLATE = "COPY_TEMPLATE",
|
2459
|
-
/** Imported */
|
2460
|
-
IMPORT = "IMPORT",
|
2461
|
-
/** Imported in bulk */
|
2462
|
-
IMPORT_BULK = "IMPORT_BULK",
|
2463
|
-
/** Imported with html import */
|
2464
|
-
IMPORT_HTML = "IMPORT_HTML",
|
2465
|
-
/** Patch import */
|
2466
|
-
IMPORT_PATCH = "IMPORT_PATCH",
|
2467
|
-
/** Changed language */
|
2468
|
-
LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
|
2469
|
-
/** Saved manually */
|
2470
|
-
MANUAL_SAVE = "MANUAL_SAVE",
|
2471
|
-
/** Affected by migration */
|
2472
|
-
MIGRATION = "MIGRATION",
|
2473
|
-
/** Affected by moderation */
|
2474
|
-
MODERATION = "MODERATION",
|
2475
|
-
/** Moved to trash */
|
2476
|
-
MOVE_TO_TRASH = "MOVE_TO_TRASH",
|
2477
|
-
/** Pricing plans were changed */
|
2478
|
-
PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
|
2479
|
-
/** Was provisioned */
|
2480
|
-
PROVISION = "PROVISION",
|
2481
|
-
/** Was published */
|
2482
|
-
PUBLISH = "PUBLISH",
|
2483
|
-
/** Owner was reassigned */
|
2484
|
-
REASSIGN_OWNER = "REASSIGN_OWNER",
|
2485
|
-
/** Was reblogged */
|
2486
|
-
REBLOG = "REBLOG",
|
2487
|
-
/** Was restored */
|
2488
|
-
RESTORE = "RESTORE",
|
2489
|
-
/** Reverted to draft */
|
2490
|
-
REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
|
2491
|
-
/** Was translated */
|
2492
|
-
TRANSLATION = "TRANSLATION",
|
2493
|
-
/** Was unpublished */
|
2494
|
-
UNPUBLISH = "UNPUBLISH",
|
2495
|
-
/** Was unscheduled */
|
2496
|
-
UNSCHEDULE = "UNSCHEDULE",
|
2497
|
-
/** New edit session started which updated editing_session_id id */
|
2498
|
-
NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
|
2499
|
-
/** Was scheduled by Later */
|
2500
|
-
SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
|
2501
|
-
/** Was unscheduled by Later */
|
2502
|
-
SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
|
2503
|
-
/** Was published by Later */
|
2504
|
-
SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
|
2505
|
-
/** Was scheduled */
|
2506
|
-
SCHEDULE = "SCHEDULE",
|
2507
|
-
/** Was removed from moderation */
|
2508
|
-
REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
|
2509
|
-
/** Was rejected from moderation */
|
2510
|
-
REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
|
2511
|
-
/** Was approved in moderation */
|
2512
|
-
APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
|
2513
|
-
/** Tag was deleted */
|
2514
|
-
DELETE_TAG = "DELETE_TAG",
|
2515
|
-
/** Post was pinned */
|
2516
|
-
PIN = "PIN",
|
2517
|
-
/** Post was unpinned */
|
2518
|
-
UNPIN = "UNPIN",
|
2519
|
-
/** Saved automatically by AI tool. */
|
2520
|
-
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
2521
|
-
}
|
2522
|
-
export declare enum Status {
|
2523
|
-
UNKNOWN = "UNKNOWN",
|
2524
|
-
/** Status indicating the draft post is published. */
|
2525
|
-
PUBLISHED = "PUBLISHED",
|
2526
|
-
/** Status indicating the draft post is unpublished. */
|
2527
|
-
UNPUBLISHED = "UNPUBLISHED",
|
2528
|
-
/** Status indicating the draft post is scheduled for publication. */
|
2529
|
-
SCHEDULED = "SCHEDULED",
|
2530
|
-
/** Status indicating the draft post is deleted. */
|
2531
|
-
DELETED = "DELETED",
|
2532
|
-
/** Status indicating the draft post is in review. */
|
2533
|
-
IN_REVIEW = "IN_REVIEW"
|
2534
|
-
}
|
2535
|
-
export interface DraftPostTranslation {
|
2536
|
-
/**
|
2537
|
-
* Post ID.
|
2538
|
-
* @format GUID
|
2539
|
-
*/
|
2540
|
-
id?: string;
|
2541
|
-
/** Post status. */
|
2542
|
-
status?: Status;
|
2543
|
-
/**
|
2544
|
-
* Language the post is written in.
|
2545
|
-
* @format LANGUAGE_TAG
|
2546
|
-
*/
|
2547
|
-
language?: string | null;
|
2548
|
-
/**
|
2549
|
-
* Post slug. For example, 'post-slug'.
|
2550
|
-
* @maxLength 100
|
2551
|
-
*/
|
2552
|
-
slug?: string | null;
|
2553
|
-
/** SEO data. */
|
2554
|
-
seoData?: SeoSchema;
|
2555
|
-
/** Post URL. */
|
2556
|
-
url?: PageUrl;
|
2557
|
-
}
|
2558
|
-
export interface GetTotalLikesPerMemberRequest {
|
2559
|
-
/**
|
2560
|
-
* Member ID.
|
2561
|
-
* @format GUID
|
2562
|
-
*/
|
2563
|
-
memberId?: string;
|
2564
|
-
}
|
2565
|
-
export interface GetTotalLikesPerMemberResponse {
|
2566
|
-
/** The total number of likes of the member. */
|
2567
|
-
total?: number;
|
2568
|
-
}
|
2569
|
-
export interface PostLiked extends PostLikedInitiatorOneOf {
|
2570
|
-
/**
|
2571
|
-
* Member ID of person who liked the post (only returned when the member was logged in when liking the post).
|
2572
|
-
* @format GUID
|
2573
|
-
*/
|
2574
|
-
memberId?: string | null;
|
2575
|
-
/**
|
2576
|
-
* Visitor ID of person who liked the post when they are not logged in.
|
2577
|
-
* @format GUID
|
2578
|
-
*/
|
2579
|
-
anonymousVisitorId?: string | null;
|
2580
|
-
/**
|
2581
|
-
* ID of the liked post.
|
2582
|
-
* @format GUID
|
2583
|
-
*/
|
2584
|
-
postId?: string;
|
2585
|
-
}
|
2586
|
-
/** @oneof */
|
2587
|
-
export interface PostLikedInitiatorOneOf {
|
2588
|
-
/**
|
2589
|
-
* Member ID of person who liked the post (only returned when the member was logged in when liking the post).
|
2590
|
-
* @format GUID
|
2591
|
-
*/
|
2592
|
-
memberId?: string | null;
|
2593
|
-
/**
|
2594
|
-
* Visitor ID of person who liked the post when they are not logged in.
|
2595
|
-
* @format GUID
|
2596
|
-
*/
|
2597
|
-
anonymousVisitorId?: string | null;
|
2598
|
-
}
|
2599
|
-
export interface PostUnliked extends PostUnlikedInitiatorOneOf {
|
2600
|
-
/**
|
2601
|
-
* Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
|
2602
|
-
* @format GUID
|
2603
|
-
*/
|
2604
|
-
memberId?: string | null;
|
2605
|
-
/**
|
2606
|
-
* Visitor ID of person who unliked the post when they are not logged in.
|
2607
|
-
* @format GUID
|
2608
|
-
*/
|
2609
|
-
anonymousVisitorId?: string | null;
|
2610
|
-
/**
|
2611
|
-
* ID of the unliked post.
|
2612
|
-
* @format GUID
|
2613
|
-
*/
|
2614
|
-
postId?: string;
|
2615
|
-
}
|
2616
|
-
/** @oneof */
|
2617
|
-
export interface PostUnlikedInitiatorOneOf {
|
2618
|
-
/**
|
2619
|
-
* Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
|
2620
|
-
* @format GUID
|
2621
|
-
*/
|
2622
|
-
memberId?: string | null;
|
2623
|
-
/**
|
2624
|
-
* Visitor ID of person who unliked the post when they are not logged in.
|
2625
|
-
* @format GUID
|
2626
|
-
*/
|
2627
|
-
anonymousVisitorId?: string | null;
|
2628
|
-
}
|
2629
|
-
export interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
|
2630
|
-
/**
|
2631
|
-
* Member ID of person who triggered the counter update
|
2632
|
-
* @format GUID
|
2633
|
-
*/
|
2634
|
-
memberId?: string | null;
|
2635
|
-
/**
|
2636
|
-
* Visitor ID if person that liked the post is not logged in
|
2637
|
-
* @format GUID
|
2638
|
-
*/
|
2639
|
-
anonymousVisitorId?: string | null;
|
2640
|
-
/**
|
2641
|
-
* ID of the post which counters were updated.
|
2642
|
-
* @format GUID
|
2643
|
-
*/
|
2644
|
-
postId?: string;
|
2645
|
-
/** Field of the updated counter. */
|
2646
|
-
updatedCounterField?: Field;
|
2647
|
-
/** New counter value. */
|
2648
|
-
counter?: number;
|
2649
|
-
}
|
2650
|
-
/** @oneof */
|
2651
|
-
export interface PostCountersUpdatedInitiatorOneOf {
|
2652
|
-
/**
|
2653
|
-
* Member ID of person who triggered the counter update
|
2654
|
-
* @format GUID
|
2655
|
-
*/
|
2656
|
-
memberId?: string | null;
|
2657
|
-
/**
|
2658
|
-
* Visitor ID if person that liked the post is not logged in
|
2659
|
-
* @format GUID
|
2660
|
-
*/
|
2661
|
-
anonymousVisitorId?: string | null;
|
2662
|
-
}
|
2663
|
-
export declare enum Field {
|
2664
|
-
/** Undefined field. */
|
2665
|
-
UNKNOWN = "UNKNOWN",
|
2666
|
-
/** Total comments field. */
|
2667
|
-
TOTAL_COMMENTS = "TOTAL_COMMENTS",
|
2668
|
-
/** Like count field. */
|
2669
|
-
LIKE_COUNT = "LIKE_COUNT",
|
2670
|
-
/** View count field. */
|
2671
|
-
VIEW_COUNT = "VIEW_COUNT",
|
2672
|
-
/** Rating count field. */
|
2673
|
-
RATING_COUNT = "RATING_COUNT"
|
2674
|
-
}
|
2675
|
-
export interface PostOwnerChanged {
|
2676
|
-
}
|
2677
|
-
export interface InitialPostsCopied {
|
2678
|
-
/** Number of posts copied. */
|
2679
|
-
count?: number;
|
2680
|
-
}
|
2681
|
-
export interface GetPostRequest {
|
2682
|
-
/**
|
2683
|
-
* Post ID.
|
2684
|
-
* @minLength 1
|
2685
|
-
* @maxLength 38
|
2686
|
-
*/
|
2687
|
-
postId: string;
|
2688
|
-
/**
|
2689
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
2690
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
2691
|
-
* only the post’s base fields are returned.
|
2692
|
-
* @maxSize 20
|
2693
|
-
*/
|
2694
|
-
fieldsets?: PostFieldField[];
|
2695
|
-
}
|
2696
|
-
export declare enum PostFieldField {
|
2697
|
-
UNKNOWN = "UNKNOWN",
|
2698
|
-
/** Includes post URL when present. */
|
2699
|
-
URL = "URL",
|
2700
|
-
/** Includes post content text string when present. */
|
2701
|
-
CONTENT_TEXT = "CONTENT_TEXT",
|
2702
|
-
/** Includes post metrics when present. */
|
2703
|
-
METRICS = "METRICS",
|
2704
|
-
/** Includes SEO data. */
|
2705
|
-
SEO = "SEO",
|
2706
|
-
/** Includes post owner's contact ID. */
|
2707
|
-
CONTACT_ID = "CONTACT_ID",
|
2708
|
-
/** Includes post rich content. */
|
2709
|
-
RICH_CONTENT = "RICH_CONTENT",
|
2710
|
-
/** Includes post reference ID field. */
|
2711
|
-
REFERENCE_ID = "REFERENCE_ID"
|
2712
|
-
}
|
2713
|
-
export interface GetPostResponse {
|
2714
|
-
/** Retrieved post info. */
|
2715
|
-
post?: Post;
|
2716
|
-
}
|
2717
|
-
export interface GetPostBySlugRequest {
|
2718
|
-
/**
|
2719
|
-
* Slug of the post to retrieve.
|
2720
|
-
* @minLength 1
|
2721
|
-
* @maxLength 200
|
2722
|
-
*/
|
2723
|
-
slug: string;
|
2724
|
-
/**
|
2725
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
2726
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
2727
|
-
* only the post’s base fields are returned.
|
2728
|
-
* @maxSize 20
|
2729
|
-
*/
|
2730
|
-
fieldsets?: PostFieldField[];
|
2731
|
-
}
|
2732
|
-
export interface GetPostBySlugResponse {
|
2733
|
-
/** Retrieved post info. */
|
2734
|
-
post?: Post;
|
2735
|
-
}
|
2736
|
-
export interface ListPostsRequest {
|
2737
|
-
/**
|
2738
|
-
* Whether to return only featured posts.
|
2739
|
-
*
|
2740
|
-
* Default: `false`
|
1866
|
+
* Whether to return only featured posts.
|
1867
|
+
*
|
1868
|
+
* Default: `false`
|
2741
1869
|
*/
|
2742
1870
|
featured?: boolean;
|
2743
1871
|
/**
|
@@ -2797,7 +1925,7 @@ export interface ListPostsRequest {
|
|
2797
1925
|
*/
|
2798
1926
|
fieldsets?: PostFieldField[];
|
2799
1927
|
}
|
2800
|
-
|
1928
|
+
declare enum GetPostsSort {
|
2801
1929
|
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
|
2802
1930
|
FEED = "FEED",
|
2803
1931
|
/** Ordered by `firstPublishedDate` in ascending order. */
|
@@ -2813,13 +1941,13 @@ export declare enum GetPostsSort {
|
|
2813
1941
|
/** Ordered by `title` in descending order. */
|
2814
1942
|
TITLE_DESC = "TITLE_DESC"
|
2815
1943
|
}
|
2816
|
-
|
1944
|
+
interface ListPostsResponse {
|
2817
1945
|
/** List of retrieved posts. */
|
2818
1946
|
posts?: Post[];
|
2819
1947
|
/** Details on the paged set of results returned. */
|
2820
1948
|
metaData?: MetaData;
|
2821
1949
|
}
|
2822
|
-
|
1950
|
+
interface QueryPostsRequest {
|
2823
1951
|
/** Query options. */
|
2824
1952
|
query?: PlatformQuery;
|
2825
1953
|
/**
|
@@ -2830,7 +1958,7 @@ export interface QueryPostsRequest {
|
|
2830
1958
|
*/
|
2831
1959
|
fieldsets?: PostFieldField[];
|
2832
1960
|
}
|
2833
|
-
|
1961
|
+
interface Sorting {
|
2834
1962
|
/**
|
2835
1963
|
* Name of the field to sort by.
|
2836
1964
|
* @maxLength 512
|
@@ -2839,11 +1967,11 @@ export interface Sorting {
|
|
2839
1967
|
/** Sort order. */
|
2840
1968
|
order?: SortOrder;
|
2841
1969
|
}
|
2842
|
-
|
1970
|
+
declare enum SortOrder {
|
2843
1971
|
ASC = "ASC",
|
2844
1972
|
DESC = "DESC"
|
2845
1973
|
}
|
2846
|
-
|
1974
|
+
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
2847
1975
|
/** Paging options to limit and skip the number of items. */
|
2848
1976
|
paging?: Paging;
|
2849
1977
|
/** 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`. */
|
@@ -2865,13 +1993,13 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
2865
1993
|
sort?: Sorting[];
|
2866
1994
|
}
|
2867
1995
|
/** @oneof */
|
2868
|
-
|
1996
|
+
interface PlatformQueryPagingMethodOneOf {
|
2869
1997
|
/** Paging options to limit and skip the number of items. */
|
2870
1998
|
paging?: Paging;
|
2871
1999
|
/** 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`. */
|
2872
2000
|
cursorPaging?: CursorPaging;
|
2873
2001
|
}
|
2874
|
-
|
2002
|
+
interface Paging {
|
2875
2003
|
/**
|
2876
2004
|
* Number of items to load.
|
2877
2005
|
* @max 100
|
@@ -2880,7 +2008,7 @@ export interface Paging {
|
|
2880
2008
|
/** Number of items to skip in the current sort order. */
|
2881
2009
|
offset?: number | null;
|
2882
2010
|
}
|
2883
|
-
|
2011
|
+
interface CursorPaging {
|
2884
2012
|
/**
|
2885
2013
|
* Number of items to load.
|
2886
2014
|
* @max 100
|
@@ -2896,13 +2024,13 @@ export interface CursorPaging {
|
|
2896
2024
|
*/
|
2897
2025
|
cursor?: string | null;
|
2898
2026
|
}
|
2899
|
-
|
2027
|
+
interface QueryPostsResponse {
|
2900
2028
|
/** List of retrieved posts. */
|
2901
2029
|
posts?: Post[];
|
2902
2030
|
/** Details on the paged set of results returned. */
|
2903
2031
|
pagingMetadata?: PagingMetadataV2;
|
2904
2032
|
}
|
2905
|
-
|
2033
|
+
interface PagingMetadataV2 {
|
2906
2034
|
/** Number of items returned in the response. */
|
2907
2035
|
count?: number | null;
|
2908
2036
|
/** Offset that was requested. */
|
@@ -2914,7 +2042,7 @@ export interface PagingMetadataV2 {
|
|
2914
2042
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
2915
2043
|
cursors?: Cursors;
|
2916
2044
|
}
|
2917
|
-
|
2045
|
+
interface Cursors {
|
2918
2046
|
/**
|
2919
2047
|
* Cursor pointing to next page in the list of results.
|
2920
2048
|
* @maxLength 2000
|
@@ -2926,7 +2054,7 @@ export interface Cursors {
|
|
2926
2054
|
*/
|
2927
2055
|
prev?: string | null;
|
2928
2056
|
}
|
2929
|
-
|
2057
|
+
interface GetPostMetricsRequest {
|
2930
2058
|
/**
|
2931
2059
|
* Post ID to retrieve metrics for.
|
2932
2060
|
* @minLength 1
|
@@ -2934,298 +2062,33 @@ export interface GetPostMetricsRequest {
|
|
2934
2062
|
*/
|
2935
2063
|
postId: string;
|
2936
2064
|
}
|
2937
|
-
|
2065
|
+
interface GetPostMetricsResponse {
|
2938
2066
|
/** Retrieved post metrics. */
|
2939
2067
|
metrics?: Metrics;
|
2940
2068
|
}
|
2941
|
-
|
2942
|
-
|
2943
|
-
|
2944
|
-
|
2945
|
-
|
2946
|
-
|
2947
|
-
|
2948
|
-
|
2949
|
-
|
2950
|
-
|
2951
|
-
|
2952
|
-
}
|
2953
|
-
|
2954
|
-
|
2955
|
-
|
2956
|
-
|
2957
|
-
|
2958
|
-
|
2959
|
-
|
2960
|
-
}
|
2961
|
-
|
2962
|
-
|
2963
|
-
|
2964
|
-
}
|
2965
|
-
|
2966
|
-
|
2967
|
-
* Post ID.
|
2968
|
-
* @minLength 1
|
2969
|
-
* @format GUID
|
2970
|
-
*/
|
2971
|
-
postId?: string;
|
2972
|
-
/**
|
2973
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
2974
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
2975
|
-
* only the post’s base fields are returned.
|
2976
|
-
* @maxSize 20
|
2977
|
-
*/
|
2978
|
-
fieldsets?: PostFieldField[];
|
2979
|
-
}
|
2980
|
-
export interface LikePostResponse {
|
2981
|
-
/** Post info. */
|
2982
|
-
post?: Post;
|
2983
|
-
}
|
2984
|
-
export interface UnlikePostRequest {
|
2985
|
-
/**
|
2986
|
-
* Post ID.
|
2987
|
-
* @minLength 1
|
2988
|
-
* @format GUID
|
2989
|
-
*/
|
2990
|
-
postId?: string;
|
2991
|
-
/**
|
2992
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
2993
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
2994
|
-
* only the post’s base fields are returned.
|
2995
|
-
* @maxSize 20
|
2996
|
-
*/
|
2997
|
-
fieldsets?: PostFieldField[];
|
2998
|
-
}
|
2999
|
-
export interface UnlikePostResponse {
|
3000
|
-
/** Post info. */
|
3001
|
-
post?: Post;
|
3002
|
-
}
|
3003
|
-
export interface PinPostRequest {
|
3004
|
-
/**
|
3005
|
-
* Post ID.
|
3006
|
-
* @minLength 1
|
3007
|
-
* @format GUID
|
3008
|
-
*/
|
3009
|
-
postId?: string;
|
3010
|
-
/**
|
3011
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3012
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
3013
|
-
* only the post’s base fields are returned.
|
3014
|
-
* @maxSize 20
|
3015
|
-
*/
|
3016
|
-
fieldsets?: PostFieldField[];
|
3017
|
-
}
|
3018
|
-
export interface PinPostResponse {
|
3019
|
-
/** Post info. */
|
3020
|
-
post?: Post;
|
3021
|
-
}
|
3022
|
-
export interface UnpinPostRequest {
|
3023
|
-
/**
|
3024
|
-
* Post ID.
|
3025
|
-
* @minLength 1
|
3026
|
-
* @format GUID
|
3027
|
-
*/
|
3028
|
-
postId?: string;
|
3029
|
-
/**
|
3030
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3031
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
3032
|
-
* only the post’s base fields are returned.
|
3033
|
-
* @maxSize 20
|
3034
|
-
*/
|
3035
|
-
fieldsets?: PostFieldField[];
|
3036
|
-
}
|
3037
|
-
export interface UnpinPostResponse {
|
3038
|
-
/** Post info. */
|
3039
|
-
post?: Post;
|
3040
|
-
}
|
3041
|
-
export interface ListPostsArchiveRequest {
|
3042
|
-
/**
|
3043
|
-
* Month
|
3044
|
-
* @min 1
|
3045
|
-
* @max 12
|
3046
|
-
*/
|
3047
|
-
month?: number | null;
|
3048
|
-
/**
|
3049
|
-
* Year
|
3050
|
-
* @min 2000
|
3051
|
-
* @max 3000
|
3052
|
-
*/
|
3053
|
-
year?: number;
|
3054
|
-
/**
|
3055
|
-
* Time zone
|
3056
|
-
* @maxLength 50
|
3057
|
-
*/
|
3058
|
-
timeZone?: string | null;
|
3059
|
-
/** Pagination options. */
|
3060
|
-
paging?: BlogPaging;
|
3061
|
-
/**
|
3062
|
-
* Language filter.
|
3063
|
-
*
|
3064
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
3065
|
-
* Pass a language to only receive posts that are in that language.
|
3066
|
-
* If omitted, posts in all languages are returned.
|
3067
|
-
* @format LANGUAGE_TAG
|
3068
|
-
*/
|
3069
|
-
language?: string | null;
|
3070
|
-
/**
|
3071
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3072
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
3073
|
-
* only the post’s base fields are returned.
|
3074
|
-
* @maxSize 20
|
3075
|
-
*/
|
3076
|
-
fieldsets?: PostFieldField[];
|
3077
|
-
}
|
3078
|
-
export interface ListPostsArchiveResponse {
|
3079
|
-
/** List of posts. */
|
3080
|
-
posts?: Post[];
|
3081
|
-
/** Details on the paged set of results returned. */
|
3082
|
-
metaData?: MetaData;
|
3083
|
-
/** Details on the paged set of results returned. */
|
3084
|
-
pagingMetadata?: PagingMetadataV2;
|
3085
|
-
}
|
3086
|
-
export interface BulkGetPostReactionsRequest {
|
3087
|
-
/**
|
3088
|
-
* Post IDs.
|
3089
|
-
* @maxSize 500
|
3090
|
-
* @maxLength 38
|
3091
|
-
*/
|
3092
|
-
postIds?: string[];
|
3093
|
-
}
|
3094
|
-
export interface BulkGetPostReactionsResponse {
|
3095
|
-
/** Map of post.id to reactions */
|
3096
|
-
reactionsMap?: Record<string, Reactions>;
|
3097
|
-
}
|
3098
|
-
export interface Reactions {
|
3099
|
-
/**
|
3100
|
-
* Is post liked by the current user
|
3101
|
-
* @readonly
|
3102
|
-
*/
|
3103
|
-
liked?: boolean;
|
3104
|
-
}
|
3105
|
-
export interface ListDemoPostsRequest {
|
3106
|
-
/**
|
3107
|
-
* Whether to return only featured posts.
|
3108
|
-
*
|
3109
|
-
* Default: `false`
|
3110
|
-
*/
|
3111
|
-
featured?: boolean;
|
3112
|
-
/**
|
3113
|
-
* Hashtag filter.
|
3114
|
-
*
|
3115
|
-
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
|
3116
|
-
* If omitted, all posts with or without hashtags are returned.
|
3117
|
-
* @maxSize 100
|
3118
|
-
* @maxLength 100
|
3119
|
-
*/
|
3120
|
-
hashtags?: string[];
|
3121
|
-
/**
|
3122
|
-
* Category filter.
|
3123
|
-
*
|
3124
|
-
* Pass an array of category IDs to return only posts with any of the provided categories.
|
3125
|
-
* If omitted, all posts with or without associated categories are returned.
|
3126
|
-
* @maxSize 50
|
3127
|
-
* @format GUID
|
3128
|
-
*/
|
3129
|
-
categoryIds?: string[];
|
3130
|
-
/**
|
3131
|
-
* Tag filter.
|
3132
|
-
*
|
3133
|
-
* Pass an array of tag IDs to return only posts with any of the provided tags.
|
3134
|
-
* If omitted, all posts with or without tags are returned.
|
3135
|
-
* @maxSize 50
|
3136
|
-
* @format GUID
|
3137
|
-
*/
|
3138
|
-
tagIds?: string[];
|
3139
|
-
/**
|
3140
|
-
* Sorting options.
|
3141
|
-
*
|
3142
|
-
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
|
3143
|
-
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
|
3144
|
-
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
|
3145
|
-
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
|
3146
|
-
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
|
3147
|
-
* - `TITLE_ASC`: Ordered by `title` in ascening order.
|
3148
|
-
* - `TITLE_DESC`: Ordered by `title` in descending order.
|
3149
|
-
* - `RATING`: reserved for internal use.
|
3150
|
-
*
|
3151
|
-
* Default: `FEED`
|
3152
|
-
*/
|
3153
|
-
sort?: GetPostsSort;
|
3154
|
-
/** Pagination options. */
|
3155
|
-
paging?: BlogPaging;
|
3156
|
-
/**
|
3157
|
-
* __Deprecated.__ Use `fieldsets` instead.
|
3158
|
-
* This parameter will be removed on June 30, 2023.
|
3159
|
-
*
|
3160
|
-
* List of post fields to be included in the response.
|
3161
|
-
* @maxSize 20
|
3162
|
-
* @deprecated __Deprecated.__ Use `fieldsets` instead.
|
3163
|
-
* This parameter will be removed on June 30, 2023.
|
3164
|
-
*
|
3165
|
-
* List of post fields to be included in the response.
|
3166
|
-
* @replacedBy fieldsets
|
3167
|
-
* @targetRemovalDate 2024-06-30
|
3168
|
-
*/
|
3169
|
-
fieldsToInclude?: PostFieldField[];
|
3170
|
-
/**
|
3171
|
-
* Language filter.
|
3172
|
-
*
|
3173
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
3174
|
-
* Pass a language to only receive posts that are in that language.
|
3175
|
-
* If omitted, posts in all languages are returned.
|
3176
|
-
* @format LANGUAGE_TAG
|
3177
|
-
*/
|
3178
|
-
language?: string | null;
|
3179
|
-
/**
|
3180
|
-
* Post owner's member ID.
|
3181
|
-
* @format GUID
|
3182
|
-
*/
|
3183
|
-
memberId?: string | null;
|
3184
|
-
/**
|
3185
|
-
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
3186
|
-
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
3187
|
-
* only the post’s base fields are returned.
|
3188
|
-
* @maxSize 20
|
3189
|
-
*/
|
3190
|
-
fieldsets?: PostFieldField[];
|
3191
|
-
}
|
3192
|
-
export interface ListDemoPostsResponse {
|
3193
|
-
/** List of posts. */
|
3194
|
-
posts?: Post[];
|
3195
|
-
/** Details on the paged set of results returned. */
|
3196
|
-
metaData?: MetaData;
|
3197
|
-
}
|
3198
|
-
export interface ConvertDraftJsToRichContentRequest {
|
3199
|
-
/** DraftJs content to convert to Rich content. */
|
3200
|
-
content?: Record<string, any> | null;
|
3201
|
-
}
|
3202
|
-
export interface ConvertDraftJsToRichContentResponse {
|
3203
|
-
/**
|
3204
|
-
* Rich content converted from DraftJs content.
|
3205
|
-
* @maxLength 2000000
|
3206
|
-
*/
|
3207
|
-
richContent?: string;
|
3208
|
-
}
|
3209
|
-
export interface ConvertRichContentToDraftJsRequest {
|
3210
|
-
/**
|
3211
|
-
* Rich content to convert to DraftJs content.
|
3212
|
-
* @maxLength 2000000
|
3213
|
-
*/
|
3214
|
-
richContent?: string;
|
3215
|
-
}
|
3216
|
-
export interface ConvertRichContentToDraftJsResponse {
|
3217
|
-
/** DraftJs content converted from Rich content. */
|
3218
|
-
content?: Record<string, any> | null;
|
3219
|
-
}
|
3220
|
-
export interface OldBlogMigratedEvent {
|
3221
|
-
/**
|
3222
|
-
* Instance id of new version of blog
|
3223
|
-
* @format GUID
|
3224
|
-
*/
|
3225
|
-
newBlogInstanceId?: string;
|
3226
|
-
/**
|
3227
|
-
* Instance id of old version of blog
|
3228
|
-
* @format GUID
|
3229
|
-
*/
|
3230
|
-
oldBlogInstanceId?: string;
|
3231
|
-
}
|
2069
|
+
|
2070
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
2071
|
+
getUrl: (context: any) => string;
|
2072
|
+
httpMethod: K;
|
2073
|
+
path: string;
|
2074
|
+
pathParams: M;
|
2075
|
+
__requestType: T;
|
2076
|
+
__originalRequestType: S;
|
2077
|
+
__responseType: Q;
|
2078
|
+
__originalResponseType: R;
|
2079
|
+
};
|
2080
|
+
declare function queryPostCountStats(): __PublicMethodMetaInfo<'GET', {}, QueryPostCountStatsRequest$1, QueryPostCountStatsRequest, QueryPostCountStatsResponse$1, QueryPostCountStatsResponse>;
|
2081
|
+
declare function getTotalPosts(): __PublicMethodMetaInfo<'GET', {}, GetTotalPostsRequest$1, GetTotalPostsRequest, GetTotalPostsResponse$1, GetTotalPostsResponse>;
|
2082
|
+
declare function getPost(): __PublicMethodMetaInfo<'GET', {
|
2083
|
+
postId: string;
|
2084
|
+
}, GetPostRequest$1, GetPostRequest, GetPostResponse$1, GetPostResponse>;
|
2085
|
+
declare function getPostBySlug(): __PublicMethodMetaInfo<'GET', {
|
2086
|
+
slug: string;
|
2087
|
+
}, GetPostBySlugRequest$1, GetPostBySlugRequest, GetPostBySlugResponse$1, GetPostBySlugResponse>;
|
2088
|
+
declare function listPosts(): __PublicMethodMetaInfo<'GET', {}, ListPostsRequest$1, ListPostsRequest, ListPostsResponse$1, ListPostsResponse>;
|
2089
|
+
declare function queryPosts(): __PublicMethodMetaInfo<'POST', {}, QueryPostsRequest$1, QueryPostsRequest, QueryPostsResponse$1, QueryPostsResponse>;
|
2090
|
+
declare function getPostMetrics(): __PublicMethodMetaInfo<'GET', {
|
2091
|
+
postId: string;
|
2092
|
+
}, GetPostMetricsRequest$1, GetPostMetricsRequest, GetPostMetricsResponse$1, GetPostMetricsResponse>;
|
2093
|
+
|
2094
|
+
export { type __PublicMethodMetaInfo, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, queryPostCountStats, queryPosts };
|