@wix/auto_sdk_blog_posts 1.0.17 → 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.
Files changed (134) hide show
  1. package/build/{cjs/src/blog-v3-post-posts.types.d.ts → blog-v3-post-posts.universal-CEsWp0Fx.d.mts} +535 -748
  2. package/build/{internal/cjs/src/blog-v3-post-posts.types.d.ts → blog-v3-post-posts.universal-CEsWp0Fx.d.ts} +535 -748
  3. package/build/index.d.mts +130 -0
  4. package/build/index.d.ts +130 -0
  5. package/build/index.js +1975 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +1899 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/{es/src/blog-v3-post-posts.types.d.ts → internal/blog-v3-post-posts.universal-nU7XoyIE.d.mts} +542 -748
  10. package/build/internal/{es/src/blog-v3-post-posts.types.d.ts → blog-v3-post-posts.universal-nU7XoyIE.d.ts} +542 -748
  11. package/build/internal/index.d.mts +130 -0
  12. package/build/internal/index.d.ts +130 -0
  13. package/build/internal/index.js +1975 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +1899 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +2094 -0
  18. package/build/internal/meta.d.ts +2094 -0
  19. package/build/internal/meta.js +1002 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +969 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +2094 -0
  24. package/build/meta.d.ts +2094 -0
  25. package/build/meta.js +1002 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +969 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +13 -12
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/blog-v3-post-posts.context.d.ts +0 -37
  40. package/build/cjs/src/blog-v3-post-posts.context.js +0 -82
  41. package/build/cjs/src/blog-v3-post-posts.context.js.map +0 -1
  42. package/build/cjs/src/blog-v3-post-posts.http.d.ts +0 -59
  43. package/build/cjs/src/blog-v3-post-posts.http.js +0 -892
  44. package/build/cjs/src/blog-v3-post-posts.http.js.map +0 -1
  45. package/build/cjs/src/blog-v3-post-posts.meta.d.ts +0 -25
  46. package/build/cjs/src/blog-v3-post-posts.meta.js +0 -161
  47. package/build/cjs/src/blog-v3-post-posts.meta.js.map +0 -1
  48. package/build/cjs/src/blog-v3-post-posts.public.d.ts +0 -99
  49. package/build/cjs/src/blog-v3-post-posts.public.js +0 -320
  50. package/build/cjs/src/blog-v3-post-posts.public.js.map +0 -1
  51. package/build/cjs/src/blog-v3-post-posts.types.js +0 -485
  52. package/build/cjs/src/blog-v3-post-posts.types.js.map +0 -1
  53. package/build/cjs/src/blog-v3-post-posts.universal.d.ts +0 -4037
  54. package/build/cjs/src/blog-v3-post-posts.universal.js +0 -966
  55. package/build/cjs/src/blog-v3-post-posts.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/blog-v3-post-posts.context.d.ts +0 -37
  67. package/build/es/src/blog-v3-post-posts.context.js +0 -37
  68. package/build/es/src/blog-v3-post-posts.context.js.map +0 -1
  69. package/build/es/src/blog-v3-post-posts.http.d.ts +0 -59
  70. package/build/es/src/blog-v3-post-posts.http.js +0 -882
  71. package/build/es/src/blog-v3-post-posts.http.js.map +0 -1
  72. package/build/es/src/blog-v3-post-posts.meta.d.ts +0 -25
  73. package/build/es/src/blog-v3-post-posts.meta.js +0 -128
  74. package/build/es/src/blog-v3-post-posts.meta.js.map +0 -1
  75. package/build/es/src/blog-v3-post-posts.public.d.ts +0 -99
  76. package/build/es/src/blog-v3-post-posts.public.js +0 -268
  77. package/build/es/src/blog-v3-post-posts.public.js.map +0 -1
  78. package/build/es/src/blog-v3-post-posts.types.js +0 -482
  79. package/build/es/src/blog-v3-post-posts.types.js.map +0 -1
  80. package/build/es/src/blog-v3-post-posts.universal.d.ts +0 -4037
  81. package/build/es/src/blog-v3-post-posts.universal.js +0 -933
  82. package/build/es/src/blog-v3-post-posts.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/blog-v3-post-posts.context.d.ts +0 -37
  93. package/build/internal/cjs/src/blog-v3-post-posts.context.js +0 -82
  94. package/build/internal/cjs/src/blog-v3-post-posts.context.js.map +0 -1
  95. package/build/internal/cjs/src/blog-v3-post-posts.http.d.ts +0 -59
  96. package/build/internal/cjs/src/blog-v3-post-posts.http.js +0 -892
  97. package/build/internal/cjs/src/blog-v3-post-posts.http.js.map +0 -1
  98. package/build/internal/cjs/src/blog-v3-post-posts.meta.d.ts +0 -25
  99. package/build/internal/cjs/src/blog-v3-post-posts.meta.js +0 -161
  100. package/build/internal/cjs/src/blog-v3-post-posts.meta.js.map +0 -1
  101. package/build/internal/cjs/src/blog-v3-post-posts.public.d.ts +0 -99
  102. package/build/internal/cjs/src/blog-v3-post-posts.public.js +0 -320
  103. package/build/internal/cjs/src/blog-v3-post-posts.public.js.map +0 -1
  104. package/build/internal/cjs/src/blog-v3-post-posts.types.js +0 -485
  105. package/build/internal/cjs/src/blog-v3-post-posts.types.js.map +0 -1
  106. package/build/internal/cjs/src/blog-v3-post-posts.universal.d.ts +0 -4044
  107. package/build/internal/cjs/src/blog-v3-post-posts.universal.js +0 -966
  108. package/build/internal/cjs/src/blog-v3-post-posts.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/blog-v3-post-posts.context.d.ts +0 -37
  119. package/build/internal/es/src/blog-v3-post-posts.context.js +0 -37
  120. package/build/internal/es/src/blog-v3-post-posts.context.js.map +0 -1
  121. package/build/internal/es/src/blog-v3-post-posts.http.d.ts +0 -59
  122. package/build/internal/es/src/blog-v3-post-posts.http.js +0 -882
  123. package/build/internal/es/src/blog-v3-post-posts.http.js.map +0 -1
  124. package/build/internal/es/src/blog-v3-post-posts.meta.d.ts +0 -25
  125. package/build/internal/es/src/blog-v3-post-posts.meta.js +0 -128
  126. package/build/internal/es/src/blog-v3-post-posts.meta.js.map +0 -1
  127. package/build/internal/es/src/blog-v3-post-posts.public.d.ts +0 -99
  128. package/build/internal/es/src/blog-v3-post-posts.public.js +0 -268
  129. package/build/internal/es/src/blog-v3-post-posts.public.js.map +0 -1
  130. package/build/internal/es/src/blog-v3-post-posts.types.js +0 -482
  131. package/build/internal/es/src/blog-v3-post-posts.types.js.map +0 -1
  132. package/build/internal/es/src/blog-v3-post-posts.universal.d.ts +0 -4044
  133. package/build/internal/es/src/blog-v3-post-posts.universal.js +0 -933
  134. package/build/internal/es/src/blog-v3-post-posts.universal.js.map +0 -1
@@ -1,10 +1,10 @@
1
- export interface Post {
1
+ interface Post {
2
2
  /**
3
3
  * Post ID.
4
4
  * @readonly
5
5
  * @format GUID
6
6
  */
7
- id?: string;
7
+ _id?: string;
8
8
  /**
9
9
  * Post title.
10
10
  * @maxLength 100
@@ -32,7 +32,7 @@ export interface Post {
32
32
  */
33
33
  lastPublishedDate?: Date | null;
34
34
  /** Post URL. */
35
- url?: PageUrl;
35
+ url?: string;
36
36
  /**
37
37
  * Post slug. For example, `'post-slug'`.
38
38
  * @maxLength 100
@@ -75,7 +75,7 @@ export interface Post {
75
75
  /** Estimated reading time (calculated automatically). */
76
76
  minutesToRead?: number;
77
77
  /** Image placed at the top of the blog page. */
78
- heroImage?: Image;
78
+ heroImage?: string;
79
79
  /**
80
80
  * IDs of [tags](https://dev.wix.com/docs/rest/business-solutions/blog/tags) the post is tagged with.
81
81
  * @readonly
@@ -155,6 +155,13 @@ export interface Post {
155
155
  moderationDetails?: ModerationDetails;
156
156
  /** Post cover media. */
157
157
  media?: Media;
158
+ /**
159
+ * Post rich content as a string
160
+ * @internal
161
+ * @readonly
162
+ * @maxLength 8000000
163
+ */
164
+ richContentString?: string | null;
158
165
  /**
159
166
  * Indicates if there is a draft post with changes that have not yet been published.
160
167
  * @readonly
@@ -167,17 +174,11 @@ export interface Post {
167
174
  */
168
175
  referenceId?: string | null;
169
176
  }
170
- export interface PageUrl {
171
- /** 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
- base?: string;
173
- /** The relative path for the page within the site. For example, `/product-page/a-product`. */
174
- path?: string;
175
- }
176
- export interface CoverMedia extends CoverMediaMediaOneOf {
177
+ interface CoverMedia extends CoverMediaMediaOneOf {
177
178
  /** Image url. */
178
- image?: Image;
179
+ image?: string;
179
180
  /** Video url. */
180
- video?: Video;
181
+ video?: string;
181
182
  /**
182
183
  * Is cover media enabled.
183
184
  * Selected by user whether to display cover media on the feed
@@ -199,36 +200,13 @@ export interface CoverMedia extends CoverMediaMediaOneOf {
199
200
  altText?: string | null;
200
201
  }
201
202
  /** @oneof */
202
- export interface CoverMediaMediaOneOf {
203
+ interface CoverMediaMediaOneOf {
203
204
  /** Image url. */
204
- image?: Image;
205
+ image?: string;
205
206
  /** Video url. */
206
- video?: Video;
207
+ video?: string;
207
208
  }
208
- export interface Image {
209
- /** WixMedia image ID. */
210
- id?: string;
211
- /** Image URL. */
212
- url?: string;
213
- /**
214
- * Original image height.
215
- * @readonly
216
- */
217
- height?: number;
218
- /**
219
- * Original image width.
220
- * @readonly
221
- */
222
- width?: number;
223
- /** Image alt text. */
224
- altText?: string | null;
225
- /**
226
- * Image filename.
227
- * @readonly
228
- */
229
- filename?: string | null;
230
- }
231
- export interface FocalPoint {
209
+ interface FocalPoint {
232
210
  /** X-coordinate of the focal point. */
233
211
  x?: number;
234
212
  /** Y-coordinate of the focal point. */
@@ -238,26 +216,7 @@ export interface FocalPoint {
238
216
  /** crop by width */
239
217
  width?: number | null;
240
218
  }
241
- /** Deprecated - use VideoV2 */
242
- export interface Video {
243
- /** WixMedia ID */
244
- id?: string;
245
- /** URL of video */
246
- url?: string;
247
- /**
248
- * Original image height
249
- * @readonly
250
- */
251
- height?: number;
252
- /**
253
- * Original image width
254
- * @readonly
255
- */
256
- width?: number;
257
- /** Video poster */
258
- thumbnail?: Image;
259
- }
260
- export interface PostCountInfo {
219
+ interface PostCountInfo {
261
220
  /**
262
221
  * Total number of post comments
263
222
  * @readonly
@@ -274,7 +233,7 @@ export interface PostCountInfo {
274
233
  */
275
234
  views?: number;
276
235
  }
277
- export interface Metrics {
236
+ interface Metrics {
278
237
  /**
279
238
  * Total number of post comments.
280
239
  * @readonly
@@ -296,13 +255,13 @@ export interface Metrics {
296
255
  * The search engines use this information for ranking purposes, or to display snippets in the search results.
297
256
  * 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
257
  */
299
- export interface SeoSchema {
258
+ interface SeoSchema {
300
259
  /** SEO tag information. */
301
260
  tags?: Tag[];
302
261
  /** SEO general settings. */
303
262
  settings?: Settings;
304
263
  }
305
- export interface Keyword {
264
+ interface Keyword {
306
265
  /** Keyword value. */
307
266
  term?: string;
308
267
  /** Whether the keyword is the main focus keyword. */
@@ -313,7 +272,7 @@ export interface Keyword {
313
272
  */
314
273
  origin?: string | null;
315
274
  }
316
- export interface Tag {
275
+ interface Tag {
317
276
  /**
318
277
  * SEO tag type.
319
278
  *
@@ -335,7 +294,7 @@ export interface Tag {
335
294
  /** Whether the tag is disabled. */
336
295
  disabled?: boolean;
337
296
  }
338
- export interface Settings {
297
+ interface Settings {
339
298
  /**
340
299
  * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
341
300
  *
@@ -349,7 +308,7 @@ export interface Settings {
349
308
  */
350
309
  keywords?: Keyword[];
351
310
  }
352
- export interface RichContent {
311
+ interface RichContent {
353
312
  /** Node objects representing a rich content document. */
354
313
  nodes?: Node[];
355
314
  /** Object metadata. */
@@ -357,7 +316,7 @@ export interface RichContent {
357
316
  /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
358
317
  documentStyle?: DocumentStyle;
359
318
  }
360
- export interface Node extends NodeDataOneOf {
319
+ interface Node extends NodeDataOneOf {
361
320
  /** Data for a button node. */
362
321
  buttonData?: ButtonData;
363
322
  /** Data for a code block node. */
@@ -415,14 +374,14 @@ export interface Node extends NodeDataOneOf {
415
374
  /** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
416
375
  type?: NodeType;
417
376
  /** Node ID. */
418
- id?: string;
377
+ _id?: string;
419
378
  /** A list of child nodes. */
420
379
  nodes?: Node[];
421
380
  /** Padding and background color styling for the node. */
422
381
  style?: NodeStyle;
423
382
  }
424
383
  /** @oneof */
425
- export interface NodeDataOneOf {
384
+ interface NodeDataOneOf {
426
385
  /** Data for a button node. */
427
386
  buttonData?: ButtonData;
428
387
  /** Data for a code block node. */
@@ -478,7 +437,7 @@ export interface NodeDataOneOf {
478
437
  /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
479
438
  layoutCellData?: LayoutCellData;
480
439
  }
481
- export declare enum NodeType {
440
+ declare enum NodeType {
482
441
  PARAGRAPH = "PARAGRAPH",
483
442
  TEXT = "TEXT",
484
443
  HEADING = "HEADING",
@@ -514,7 +473,7 @@ export declare enum NodeType {
514
473
  LAYOUT = "LAYOUT",
515
474
  LAYOUT_CELL = "LAYOUT_CELL"
516
475
  }
517
- export interface NodeStyle {
476
+ interface NodeStyle {
518
477
  /** The top padding value in pixels. */
519
478
  paddingTop?: string | null;
520
479
  /** The bottom padding value in pixels. */
@@ -522,7 +481,7 @@ export interface NodeStyle {
522
481
  /** The background color as a hexadecimal value. */
523
482
  backgroundColor?: string | null;
524
483
  }
525
- export interface ButtonData {
484
+ interface ButtonData {
526
485
  /** Styling for the button's container. */
527
486
  containerData?: PluginContainerData;
528
487
  /** The button type. */
@@ -534,13 +493,13 @@ export interface ButtonData {
534
493
  /** Button link details. */
535
494
  link?: Link;
536
495
  }
537
- export interface Border {
496
+ interface Border {
538
497
  /** Border width in pixels. */
539
498
  width?: number | null;
540
499
  /** Border radius in pixels. */
541
500
  radius?: number | null;
542
501
  }
543
- export interface Colors {
502
+ interface Colors {
544
503
  /** The text color as a hexadecimal value. */
545
504
  text?: string | null;
546
505
  /** The border color as a hexadecimal value. */
@@ -548,7 +507,7 @@ export interface Colors {
548
507
  /** The background color as a hexadecimal value. */
549
508
  background?: string | null;
550
509
  }
551
- export interface PluginContainerData {
510
+ interface PluginContainerData {
552
511
  /** The width of the node when it's displayed. */
553
512
  width?: PluginContainerDataWidth;
554
513
  /** The node's alignment within its container. */
@@ -560,7 +519,7 @@ export interface PluginContainerData {
560
519
  /** 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
520
  textWrap?: boolean | null;
562
521
  }
563
- export declare enum WidthType {
522
+ declare enum WidthType {
564
523
  /** Width matches the content width */
565
524
  CONTENT = "CONTENT",
566
525
  /** Small Width */
@@ -570,7 +529,7 @@ export declare enum WidthType {
570
529
  /** coast-to-coast display */
571
530
  FULL_WIDTH = "FULL_WIDTH"
572
531
  }
573
- export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
532
+ interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
574
533
  /**
575
534
  * One of the following predefined width options:
576
535
  * `CONTENT`: The width of the container matches the content width.
@@ -583,7 +542,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
583
542
  custom?: string | null;
584
543
  }
585
544
  /** @oneof */
586
- export interface PluginContainerDataWidthDataOneOf {
545
+ interface PluginContainerDataWidthDataOneOf {
587
546
  /**
588
547
  * One of the following predefined width options:
589
548
  * `CONTENT`: The width of the container matches the content width.
@@ -595,7 +554,7 @@ export interface PluginContainerDataWidthDataOneOf {
595
554
  /** A custom width value in pixels. */
596
555
  custom?: string | null;
597
556
  }
598
- export declare enum PluginContainerDataAlignment {
557
+ declare enum PluginContainerDataAlignment {
599
558
  /** Center Alignment */
600
559
  CENTER = "CENTER",
601
560
  /** Left Alignment */
@@ -603,7 +562,7 @@ export declare enum PluginContainerDataAlignment {
603
562
  /** Right Alignment */
604
563
  RIGHT = "RIGHT"
605
564
  }
606
- export interface Spoiler {
565
+ interface Spoiler {
607
566
  /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
608
567
  enabled?: boolean | null;
609
568
  /** The description displayed on top of the spoiler cover. */
@@ -611,23 +570,23 @@ export interface Spoiler {
611
570
  /** The text for the button used to remove the spoiler cover. */
612
571
  buttonText?: string | null;
613
572
  }
614
- export interface Height {
573
+ interface Height {
615
574
  /** A custom height value in pixels. */
616
575
  custom?: string | null;
617
576
  }
618
- export declare enum Type {
577
+ declare enum Type {
619
578
  /** Regular link button */
620
579
  LINK = "LINK",
621
580
  /** Triggers custom action that is defined in plugin configuration by the consumer */
622
581
  ACTION = "ACTION"
623
582
  }
624
- export interface Styles {
583
+ interface Styles {
625
584
  /** Border attributes. */
626
585
  border?: Border;
627
586
  /** Color attributes. */
628
587
  colors?: Colors;
629
588
  }
630
- export interface Link extends LinkDataOneOf {
589
+ interface Link extends LinkDataOneOf {
631
590
  /** The absolute URL for the linked document. */
632
591
  url?: string;
633
592
  /** The target node's ID. Used for linking to another node in this object. */
@@ -646,13 +605,13 @@ export interface Link extends LinkDataOneOf {
646
605
  customData?: string | null;
647
606
  }
648
607
  /** @oneof */
649
- export interface LinkDataOneOf {
608
+ interface LinkDataOneOf {
650
609
  /** The absolute URL for the linked document. */
651
610
  url?: string;
652
611
  /** The target node's ID. Used for linking to another node in this object. */
653
612
  anchor?: string;
654
613
  }
655
- export declare enum Target {
614
+ declare enum Target {
656
615
  /** Opens the linked document in the same frame as it was clicked (this is default) */
657
616
  SELF = "SELF",
658
617
  /** Opens the linked document in a new window or tab */
@@ -662,7 +621,7 @@ export declare enum Target {
662
621
  /** Opens the linked document in the full body of the window */
663
622
  TOP = "TOP"
664
623
  }
665
- export interface Rel {
624
+ interface Rel {
666
625
  /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
667
626
  nofollow?: boolean | null;
668
627
  /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
@@ -672,17 +631,17 @@ export interface Rel {
672
631
  /** Indicates that this link protect referral information from being passed to the target website. */
673
632
  noreferrer?: boolean | null;
674
633
  }
675
- export interface CodeBlockData {
634
+ interface CodeBlockData {
676
635
  /** Styling for the code block's text. */
677
636
  textStyle?: TextStyle;
678
637
  }
679
- export interface TextStyle {
638
+ interface TextStyle {
680
639
  /** Text alignment. Defaults to `AUTO`. */
681
640
  textAlignment?: TextAlignment;
682
641
  /** 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
642
  lineHeight?: string | null;
684
643
  }
685
- export declare enum TextAlignment {
644
+ declare enum TextAlignment {
686
645
  /** browser default, eqivalent to `initial` */
687
646
  AUTO = "AUTO",
688
647
  /** Left align */
@@ -694,7 +653,7 @@ export declare enum TextAlignment {
694
653
  /** 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
654
  JUSTIFY = "JUSTIFY"
696
655
  }
697
- export interface DividerData {
656
+ interface DividerData {
698
657
  /** Styling for the divider's container. */
699
658
  containerData?: PluginContainerData;
700
659
  /** Divider line style. */
@@ -704,7 +663,7 @@ export interface DividerData {
704
663
  /** Divider alignment. */
705
664
  alignment?: Alignment;
706
665
  }
707
- export declare enum LineStyle {
666
+ declare enum LineStyle {
708
667
  /** Single Line */
709
668
  SINGLE = "SINGLE",
710
669
  /** Double Line */
@@ -714,7 +673,7 @@ export declare enum LineStyle {
714
673
  /** Dotted Line */
715
674
  DOTTED = "DOTTED"
716
675
  }
717
- export declare enum Width {
676
+ declare enum Width {
718
677
  /** Large line */
719
678
  LARGE = "LARGE",
720
679
  /** Medium line */
@@ -722,7 +681,7 @@ export declare enum Width {
722
681
  /** Small line */
723
682
  SMALL = "SMALL"
724
683
  }
725
- export declare enum Alignment {
684
+ declare enum Alignment {
726
685
  /** Center alignment */
727
686
  CENTER = "CENTER",
728
687
  /** Left alignment */
@@ -730,7 +689,7 @@ export declare enum Alignment {
730
689
  /** Right alignment */
731
690
  RIGHT = "RIGHT"
732
691
  }
733
- export interface FileData {
692
+ interface FileData {
734
693
  /** Styling for the file's container. */
735
694
  containerData?: PluginContainerData;
736
695
  /** The source for the file's data. */
@@ -753,7 +712,7 @@ export interface FileData {
753
712
  /** File size in KB. */
754
713
  sizeInKb?: string | null;
755
714
  }
756
- export declare enum ViewMode {
715
+ declare enum ViewMode {
757
716
  /** No PDF view */
758
717
  NONE = "NONE",
759
718
  /** Full PDF view */
@@ -761,7 +720,7 @@ export declare enum ViewMode {
761
720
  /** Mini PDF view */
762
721
  MINI = "MINI"
763
722
  }
764
- export interface FileSource extends FileSourceDataOneOf {
723
+ interface FileSource extends FileSourceDataOneOf {
765
724
  /** The absolute URL for the file's source. */
766
725
  url?: string | null;
767
726
  /**
@@ -770,12 +729,12 @@ export interface FileSource extends FileSourceDataOneOf {
770
729
  */
771
730
  custom?: string | null;
772
731
  /** An ID that's resolved to a URL by a resolver function. */
773
- id?: string | null;
732
+ _id?: string | null;
774
733
  /** Indicates whether the file's source is private. Defaults to `false`. */
775
734
  private?: boolean | null;
776
735
  }
777
736
  /** @oneof */
778
- export interface FileSourceDataOneOf {
737
+ interface FileSourceDataOneOf {
779
738
  /** The absolute URL for the file's source. */
780
739
  url?: string | null;
781
740
  /**
@@ -784,9 +743,9 @@ export interface FileSourceDataOneOf {
784
743
  */
785
744
  custom?: string | null;
786
745
  /** An ID that's resolved to a URL by a resolver function. */
787
- id?: string | null;
746
+ _id?: string | null;
788
747
  }
789
- export interface PDFSettings {
748
+ interface PDFSettings {
790
749
  /**
791
750
  * PDF view mode. One of the following:
792
751
  * `NONE` : The PDF isn't displayed.
@@ -799,7 +758,7 @@ export interface PDFSettings {
799
758
  /** Sets whether the PDF print button is disabled. Defaults to `false`. */
800
759
  disablePrint?: boolean | null;
801
760
  }
802
- export interface GalleryData {
761
+ interface GalleryData {
803
762
  /** Styling for the gallery's container. */
804
763
  containerData?: PluginContainerData;
805
764
  /** The items in the gallery. */
@@ -811,7 +770,7 @@ export interface GalleryData {
811
770
  /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
812
771
  disableDownload?: boolean | null;
813
772
  }
814
- export interface V1Media {
773
+ interface V1Media {
815
774
  /** The source for the media's data. */
816
775
  src?: FileSource;
817
776
  /** Media width in pixels. */
@@ -821,36 +780,36 @@ export interface V1Media {
821
780
  /** Media duration in seconds. Only relevant for audio and video files. */
822
781
  duration?: number | null;
823
782
  }
824
- export interface ItemImage {
783
+ interface Image {
825
784
  /** Image file details. */
826
785
  media?: V1Media;
827
786
  /** Link details for images that are links. */
828
787
  link?: Link;
829
788
  }
830
- export interface ItemVideo {
789
+ interface Video {
831
790
  /** Video file details. */
832
791
  media?: V1Media;
833
792
  /** Video thumbnail file details. */
834
793
  thumbnail?: V1Media;
835
794
  }
836
- export interface Item extends ItemDataOneOf {
795
+ interface Item extends ItemDataOneOf {
837
796
  /** An image item. */
838
- image?: ItemImage;
797
+ image?: Image;
839
798
  /** A video item. */
840
- video?: ItemVideo;
799
+ video?: Video;
841
800
  /** Item title. */
842
801
  title?: string | null;
843
802
  /** Item's alternative text. */
844
803
  altText?: string | null;
845
804
  }
846
805
  /** @oneof */
847
- export interface ItemDataOneOf {
806
+ interface ItemDataOneOf {
848
807
  /** An image item. */
849
- image?: ItemImage;
808
+ image?: Image;
850
809
  /** A video item. */
851
- video?: ItemVideo;
810
+ video?: Video;
852
811
  }
853
- export interface GalleryOptions {
812
+ interface GalleryOptions {
854
813
  /** Gallery layout. */
855
814
  layout?: Layout;
856
815
  /** Styling for gallery items. */
@@ -858,7 +817,7 @@ export interface GalleryOptions {
858
817
  /** Styling for gallery thumbnail images. */
859
818
  thumbnails?: Thumbnails;
860
819
  }
861
- export declare enum LayoutType {
820
+ declare enum LayoutType {
862
821
  /** Collage type */
863
822
  COLLAGE = "COLLAGE",
864
823
  /** Masonry type */
@@ -880,19 +839,19 @@ export declare enum LayoutType {
880
839
  /** Fullsize images type */
881
840
  FULLSIZE = "FULLSIZE"
882
841
  }
883
- export declare enum Orientation {
842
+ declare enum Orientation {
884
843
  /** Rows Orientation */
885
844
  ROWS = "ROWS",
886
845
  /** Columns Orientation */
887
846
  COLUMNS = "COLUMNS"
888
847
  }
889
- export declare enum Crop {
848
+ declare enum Crop {
890
849
  /** Crop to fill */
891
850
  FILL = "FILL",
892
851
  /** Crop to fit */
893
852
  FIT = "FIT"
894
853
  }
895
- export declare enum ThumbnailsAlignment {
854
+ declare enum ThumbnailsAlignment {
896
855
  /** Top alignment */
897
856
  TOP = "TOP",
898
857
  /** Right alignment */
@@ -904,7 +863,7 @@ export declare enum ThumbnailsAlignment {
904
863
  /** No thumbnail */
905
864
  NONE = "NONE"
906
865
  }
907
- export interface Layout {
866
+ interface Layout {
908
867
  /** Gallery layout type. */
909
868
  type?: LayoutType;
910
869
  /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
@@ -916,7 +875,7 @@ export interface Layout {
916
875
  /** The number of columns to display on mobile screens. */
917
876
  mobileNumberOfColumns?: number | null;
918
877
  }
919
- export interface ItemStyle {
878
+ interface ItemStyle {
920
879
  /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
921
880
  targetSize?: number | null;
922
881
  /** Item ratio */
@@ -926,13 +885,13 @@ export interface ItemStyle {
926
885
  /** The spacing between items in pixels. */
927
886
  spacing?: number | null;
928
887
  }
929
- export interface Thumbnails {
888
+ interface Thumbnails {
930
889
  /** Thumbnail alignment. */
931
890
  placement?: ThumbnailsAlignment;
932
891
  /** Spacing between thumbnails in pixels. */
933
892
  spacing?: number | null;
934
893
  }
935
- export interface GIFData {
894
+ interface GIFData {
936
895
  /** Styling for the GIF's container. */
937
896
  containerData?: PluginContainerData;
938
897
  /** The source of the full size GIF. */
@@ -946,7 +905,7 @@ export interface GIFData {
946
905
  /** Type of GIF (Sticker or GIF). Defaults to `GIF`. */
947
906
  gifType?: GIFType;
948
907
  }
949
- export interface GIF {
908
+ interface GIF {
950
909
  /**
951
910
  * GIF format URL.
952
911
  * @format WEB_URL
@@ -963,11 +922,11 @@ export interface GIF {
963
922
  */
964
923
  still?: string | null;
965
924
  }
966
- export declare enum GIFType {
925
+ declare enum GIFType {
967
926
  GIF = "GIF",
968
927
  STICKER = "STICKER"
969
928
  }
970
- export interface HeadingData {
929
+ interface HeadingData {
971
930
  /** Heading level from 1-6. */
972
931
  level?: number;
973
932
  /** Styling for the heading text. */
@@ -975,7 +934,7 @@ export interface HeadingData {
975
934
  /** Indentation level from 1-4. */
976
935
  indentation?: number | null;
977
936
  }
978
- export interface HTMLData extends HTMLDataDataOneOf {
937
+ interface HTMLData extends HTMLDataDataOneOf {
979
938
  /** The URL for the HTML code for the node. */
980
939
  url?: string;
981
940
  /** The HTML code for the node. */
@@ -993,7 +952,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
993
952
  autoHeight?: boolean | null;
994
953
  }
995
954
  /** @oneof */
996
- export interface HTMLDataDataOneOf {
955
+ interface HTMLDataDataOneOf {
997
956
  /** The URL for the HTML code for the node. */
998
957
  url?: string;
999
958
  /** The HTML code for the node. */
@@ -1004,11 +963,11 @@ export interface HTMLDataDataOneOf {
1004
963
  */
1005
964
  isAdsense?: boolean | null;
1006
965
  }
1007
- export declare enum Source {
966
+ declare enum Source {
1008
967
  HTML = "HTML",
1009
968
  ADSENSE = "ADSENSE"
1010
969
  }
1011
- export interface ImageData {
970
+ interface ImageData {
1012
971
  /** Styling for the image's container. */
1013
972
  containerData?: PluginContainerData;
1014
973
  /** Image file details. */
@@ -1027,7 +986,7 @@ export interface ImageData {
1027
986
  /** Sets whether the image's download button is disabled. Defaults to `false`. */
1028
987
  disableDownload?: boolean | null;
1029
988
  }
1030
- export interface StylesBorder {
989
+ interface StylesBorder {
1031
990
  /** Border width in pixels. */
1032
991
  width?: number | null;
1033
992
  /**
@@ -1038,11 +997,11 @@ export interface StylesBorder {
1038
997
  /** Border radius in pixels. */
1039
998
  radius?: number | null;
1040
999
  }
1041
- export interface ImageDataStyles {
1000
+ interface ImageDataStyles {
1042
1001
  /** Border attributes. */
1043
1002
  border?: StylesBorder;
1044
1003
  }
1045
- export interface LinkPreviewData {
1004
+ interface LinkPreviewData {
1046
1005
  /** Styling for the link preview's container. */
1047
1006
  containerData?: PluginContainerData;
1048
1007
  /** Link details. */
@@ -1056,7 +1015,7 @@ export interface LinkPreviewData {
1056
1015
  /** The preview content as HTML. */
1057
1016
  html?: string | null;
1058
1017
  }
1059
- export declare enum Position {
1018
+ declare enum Position {
1060
1019
  /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
1061
1020
  START = "START",
1062
1021
  /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
@@ -1066,7 +1025,7 @@ export declare enum Position {
1066
1025
  /** Thumbnail hidden and not displayed */
1067
1026
  HIDDEN = "HIDDEN"
1068
1027
  }
1069
- export interface LinkPreviewDataStyles {
1028
+ interface LinkPreviewDataStyles {
1070
1029
  /**
1071
1030
  * Background color as a hexadecimal value.
1072
1031
  * @format COLOR_HEX
@@ -1099,13 +1058,13 @@ export interface LinkPreviewDataStyles {
1099
1058
  /** Position of thumbnail. Defaults to `START`. */
1100
1059
  thumbnailPosition?: Position;
1101
1060
  }
1102
- export interface MapData {
1061
+ interface MapData {
1103
1062
  /** Styling for the map's container. */
1104
1063
  containerData?: PluginContainerData;
1105
1064
  /** Map settings. */
1106
1065
  mapSettings?: MapSettings;
1107
1066
  }
1108
- export interface MapSettings {
1067
+ interface MapSettings {
1109
1068
  /** The address to display on the map. */
1110
1069
  address?: string | null;
1111
1070
  /** Sets whether the map is draggable. */
@@ -1129,7 +1088,7 @@ export interface MapSettings {
1129
1088
  /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
1130
1089
  mapType?: MapType;
1131
1090
  }
1132
- export declare enum MapType {
1091
+ declare enum MapType {
1133
1092
  /** Roadmap map type */
1134
1093
  ROADMAP = "ROADMAP",
1135
1094
  /** Satellite map type */
@@ -1139,7 +1098,7 @@ export declare enum MapType {
1139
1098
  /** Terrain map type */
1140
1099
  TERRAIN = "TERRAIN"
1141
1100
  }
1142
- export interface ParagraphData {
1101
+ interface ParagraphData {
1143
1102
  /** Styling for the paragraph text. */
1144
1103
  textStyle?: TextStyle;
1145
1104
  /** Indentation level from 1-4. */
@@ -1147,7 +1106,7 @@ export interface ParagraphData {
1147
1106
  /** Paragraph level */
1148
1107
  level?: number | null;
1149
1108
  }
1150
- export interface PollData {
1109
+ interface PollData {
1151
1110
  /** Styling for the poll's container. */
1152
1111
  containerData?: PluginContainerData;
1153
1112
  /** Poll data. */
@@ -1157,7 +1116,7 @@ export interface PollData {
1157
1116
  /** Styling for the poll and voting options. */
1158
1117
  design?: Design;
1159
1118
  }
1160
- export declare enum ViewRole {
1119
+ declare enum ViewRole {
1161
1120
  /** Only Poll creator can view the results */
1162
1121
  CREATOR = "CREATOR",
1163
1122
  /** Anyone who voted can see the results */
@@ -1165,13 +1124,13 @@ export declare enum ViewRole {
1165
1124
  /** Anyone can see the results, even if one didn't vote */
1166
1125
  EVERYONE = "EVERYONE"
1167
1126
  }
1168
- export declare enum VoteRole {
1127
+ declare enum VoteRole {
1169
1128
  /** Logged in member */
1170
1129
  SITE_MEMBERS = "SITE_MEMBERS",
1171
1130
  /** Anyone */
1172
1131
  ALL = "ALL"
1173
1132
  }
1174
- export interface Permissions {
1133
+ interface Permissions {
1175
1134
  /** Sets who can view the poll results. */
1176
1135
  view?: ViewRole;
1177
1136
  /** Sets who can vote. */
@@ -1179,15 +1138,15 @@ export interface Permissions {
1179
1138
  /** Sets whether one voter can vote multiple times. Defaults to `false`. */
1180
1139
  allowMultipleVotes?: boolean | null;
1181
1140
  }
1182
- export interface Option {
1141
+ interface Option {
1183
1142
  /** Option ID. */
1184
- id?: string | null;
1143
+ _id?: string | null;
1185
1144
  /** Option title. */
1186
1145
  title?: string | null;
1187
1146
  /** The image displayed with the option. */
1188
1147
  image?: V1Media;
1189
1148
  }
1190
- export interface PollSettings {
1149
+ interface PollSettings {
1191
1150
  /** Permissions settings for voting. */
1192
1151
  permissions?: Permissions;
1193
1152
  /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
@@ -1195,19 +1154,19 @@ export interface PollSettings {
1195
1154
  /** Sets whether the vote count is displayed. Defaults to `true`. */
1196
1155
  showVotesCount?: boolean | null;
1197
1156
  }
1198
- export declare enum PollLayoutType {
1157
+ declare enum PollLayoutType {
1199
1158
  /** List */
1200
1159
  LIST = "LIST",
1201
1160
  /** Grid */
1202
1161
  GRID = "GRID"
1203
1162
  }
1204
- export declare enum PollLayoutDirection {
1163
+ declare enum PollLayoutDirection {
1205
1164
  /** Left-to-right */
1206
1165
  LTR = "LTR",
1207
1166
  /** Right-to-left */
1208
1167
  RTL = "RTL"
1209
1168
  }
1210
- export interface PollLayout {
1169
+ interface PollLayout {
1211
1170
  /** The layout for displaying the voting options. */
1212
1171
  type?: PollLayoutType;
1213
1172
  /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
@@ -1215,11 +1174,11 @@ export interface PollLayout {
1215
1174
  /** Sets whether to display the main poll image. Defaults to `false`. */
1216
1175
  enableImage?: boolean | null;
1217
1176
  }
1218
- export interface OptionLayout {
1177
+ interface OptionLayout {
1219
1178
  /** Sets whether to display option images. Defaults to `false`. */
1220
1179
  enableImage?: boolean | null;
1221
1180
  }
1222
- export declare enum BackgroundType {
1181
+ declare enum BackgroundType {
1223
1182
  /** Color background type */
1224
1183
  COLOR = "COLOR",
1225
1184
  /** Image background type */
@@ -1227,7 +1186,7 @@ export declare enum BackgroundType {
1227
1186
  /** Gradiant background type */
1228
1187
  GRADIENT = "GRADIENT"
1229
1188
  }
1230
- export interface Gradient {
1189
+ interface Gradient {
1231
1190
  /** The gradient angle in degrees. */
1232
1191
  angle?: number | null;
1233
1192
  /**
@@ -1241,7 +1200,7 @@ export interface Gradient {
1241
1200
  */
1242
1201
  lastColor?: string | null;
1243
1202
  }
1244
- export interface Background extends BackgroundBackgroundOneOf {
1203
+ interface Background extends BackgroundBackgroundOneOf {
1245
1204
  /**
1246
1205
  * The background color as a hexademical value.
1247
1206
  * @format COLOR_HEX
@@ -1255,7 +1214,7 @@ export interface Background extends BackgroundBackgroundOneOf {
1255
1214
  type?: BackgroundType;
1256
1215
  }
1257
1216
  /** @oneof */
1258
- export interface BackgroundBackgroundOneOf {
1217
+ interface BackgroundBackgroundOneOf {
1259
1218
  /**
1260
1219
  * The background color as a hexademical value.
1261
1220
  * @format COLOR_HEX
@@ -1266,19 +1225,19 @@ export interface BackgroundBackgroundOneOf {
1266
1225
  /** Details for a gradient background. */
1267
1226
  gradient?: Gradient;
1268
1227
  }
1269
- export interface PollDesign {
1228
+ interface PollDesign {
1270
1229
  /** Background styling. */
1271
1230
  background?: Background;
1272
1231
  /** Border radius in pixels. */
1273
1232
  borderRadius?: number | null;
1274
1233
  }
1275
- export interface OptionDesign {
1234
+ interface OptionDesign {
1276
1235
  /** Border radius in pixels. */
1277
1236
  borderRadius?: number | null;
1278
1237
  }
1279
- export interface Poll {
1238
+ interface Poll {
1280
1239
  /** Poll ID. */
1281
- id?: string | null;
1240
+ _id?: string | null;
1282
1241
  /** Poll title. */
1283
1242
  title?: string | null;
1284
1243
  /** Poll creator ID. */
@@ -1290,26 +1249,26 @@ export interface Poll {
1290
1249
  /** The poll's permissions and display settings. */
1291
1250
  settings?: PollSettings;
1292
1251
  }
1293
- export interface PollDataLayout {
1252
+ interface PollDataLayout {
1294
1253
  /** Poll layout settings. */
1295
1254
  poll?: PollLayout;
1296
1255
  /** Voting otpions layout settings. */
1297
1256
  options?: OptionLayout;
1298
1257
  }
1299
- export interface Design {
1258
+ interface Design {
1300
1259
  /** Styling for the poll. */
1301
1260
  poll?: PollDesign;
1302
1261
  /** Styling for voting options. */
1303
1262
  options?: OptionDesign;
1304
1263
  }
1305
- export interface TextData {
1264
+ interface TextData {
1306
1265
  /** The text to apply decorations to. */
1307
1266
  text?: string;
1308
1267
  /** The decorations to apply. */
1309
1268
  decorations?: Decoration[];
1310
1269
  }
1311
1270
  /** Adds appearence changes to text */
1312
- export interface Decoration extends DecorationDataOneOf {
1271
+ interface Decoration extends DecorationDataOneOf {
1313
1272
  /** Data for an anchor link decoration. */
1314
1273
  anchorData?: AnchorData;
1315
1274
  /** Data for a color decoration. */
@@ -1332,7 +1291,7 @@ export interface Decoration extends DecorationDataOneOf {
1332
1291
  type?: DecorationType;
1333
1292
  }
1334
1293
  /** @oneof */
1335
- export interface DecorationDataOneOf {
1294
+ interface DecorationDataOneOf {
1336
1295
  /** Data for an anchor link decoration. */
1337
1296
  anchorData?: AnchorData;
1338
1297
  /** Data for a color decoration. */
@@ -1352,7 +1311,7 @@ export interface DecorationDataOneOf {
1352
1311
  /** Data for a spoiler decoration. */
1353
1312
  spoilerData?: SpoilerData;
1354
1313
  }
1355
- export declare enum DecorationType {
1314
+ declare enum DecorationType {
1356
1315
  BOLD = "BOLD",
1357
1316
  ITALIC = "ITALIC",
1358
1317
  UNDERLINE = "UNDERLINE",
@@ -1364,43 +1323,43 @@ export declare enum DecorationType {
1364
1323
  FONT_SIZE = "FONT_SIZE",
1365
1324
  EXTERNAL = "EXTERNAL"
1366
1325
  }
1367
- export interface AnchorData {
1326
+ interface AnchorData {
1368
1327
  /** The target node's ID. */
1369
1328
  anchor?: string;
1370
1329
  }
1371
- export interface ColorData {
1330
+ interface ColorData {
1372
1331
  /** The text's background color as a hexadecimal value. */
1373
1332
  background?: string | null;
1374
1333
  /** The text's foreground color as a hexadecimal value. */
1375
1334
  foreground?: string | null;
1376
1335
  }
1377
- export interface LinkData {
1336
+ interface LinkData {
1378
1337
  /** Link details. */
1379
1338
  link?: Link;
1380
1339
  }
1381
- export interface MentionData {
1340
+ interface MentionData {
1382
1341
  /** The mentioned user's name. */
1383
1342
  name?: string;
1384
1343
  /** The version of the user's name that appears after the `@` character in the mention. */
1385
1344
  slug?: string;
1386
1345
  /** Mentioned user's ID. */
1387
- id?: string | null;
1346
+ _id?: string | null;
1388
1347
  }
1389
- export interface FontSizeData {
1348
+ interface FontSizeData {
1390
1349
  /** The units used for the font size. */
1391
1350
  unit?: FontType;
1392
1351
  /** Font size value. */
1393
1352
  value?: number | null;
1394
1353
  }
1395
- export declare enum FontType {
1354
+ declare enum FontType {
1396
1355
  PX = "PX",
1397
1356
  EM = "EM"
1398
1357
  }
1399
- export interface SpoilerData {
1358
+ interface SpoilerData {
1400
1359
  /** Spoiler ID. */
1401
- id?: string | null;
1360
+ _id?: string | null;
1402
1361
  }
1403
- export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1362
+ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1404
1363
  /** Data for embedded Wix Bookings content. */
1405
1364
  bookingData?: BookingData;
1406
1365
  /** Data for embedded Wix Events content. */
@@ -1422,28 +1381,28 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1422
1381
  image?: V1Media;
1423
1382
  }
1424
1383
  /** @oneof */
1425
- export interface AppEmbedDataAppDataOneOf {
1384
+ interface AppEmbedDataAppDataOneOf {
1426
1385
  /** Data for embedded Wix Bookings content. */
1427
1386
  bookingData?: BookingData;
1428
1387
  /** Data for embedded Wix Events content. */
1429
1388
  eventData?: EventData;
1430
1389
  }
1431
- export declare enum AppType {
1390
+ declare enum AppType {
1432
1391
  PRODUCT = "PRODUCT",
1433
1392
  EVENT = "EVENT",
1434
1393
  BOOKING = "BOOKING"
1435
1394
  }
1436
- export interface BookingData {
1395
+ interface BookingData {
1437
1396
  /** Booking duration in minutes. */
1438
1397
  durations?: string | null;
1439
1398
  }
1440
- export interface EventData {
1399
+ interface EventData {
1441
1400
  /** Event schedule. */
1442
1401
  scheduling?: string | null;
1443
1402
  /** Event location. */
1444
1403
  location?: string | null;
1445
1404
  }
1446
- export interface VideoData {
1405
+ interface VideoData {
1447
1406
  /** Styling for the video's container. */
1448
1407
  containerData?: PluginContainerData;
1449
1408
  /** Video details. */
@@ -1457,7 +1416,7 @@ export interface VideoData {
1457
1416
  /** Video options. */
1458
1417
  options?: PlaybackOptions;
1459
1418
  }
1460
- export interface PlaybackOptions {
1419
+ interface PlaybackOptions {
1461
1420
  /** Sets whether the media will automatically start playing. */
1462
1421
  autoPlay?: boolean | null;
1463
1422
  /** Sets whether media's will be looped. */
@@ -1465,7 +1424,7 @@ export interface PlaybackOptions {
1465
1424
  /** Sets whether media's controls will be shown. */
1466
1425
  showControls?: boolean | null;
1467
1426
  }
1468
- export interface EmbedData {
1427
+ interface EmbedData {
1469
1428
  /** Styling for the oEmbed node's container. */
1470
1429
  containerData?: PluginContainerData;
1471
1430
  /** An [oEmbed](https://www.oembed.com) object. */
@@ -1473,7 +1432,7 @@ export interface EmbedData {
1473
1432
  /** Origin asset source. */
1474
1433
  src?: string | null;
1475
1434
  }
1476
- export interface Oembed {
1435
+ interface Oembed {
1477
1436
  /** The resource type. */
1478
1437
  type?: string | null;
1479
1438
  /** The width of the resource specified in the `url` property in pixels. */
@@ -1505,7 +1464,7 @@ export interface Oembed {
1505
1464
  /** The oEmbed version number. This value must be `1.0`. */
1506
1465
  version?: string | null;
1507
1466
  }
1508
- export interface CollapsibleListData {
1467
+ interface CollapsibleListData {
1509
1468
  /** Styling for the collapsible list's container. */
1510
1469
  containerData?: PluginContainerData;
1511
1470
  /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
@@ -1517,7 +1476,7 @@ export interface CollapsibleListData {
1517
1476
  /** If `true`, The collapsible item will appear in search results as an FAQ. */
1518
1477
  isQapageData?: boolean | null;
1519
1478
  }
1520
- export declare enum InitialExpandedItems {
1479
+ declare enum InitialExpandedItems {
1521
1480
  /** First item will be expended initally */
1522
1481
  FIRST = "FIRST",
1523
1482
  /** All items will expended initally */
@@ -1525,13 +1484,13 @@ export declare enum InitialExpandedItems {
1525
1484
  /** All items collapsed initally */
1526
1485
  NONE = "NONE"
1527
1486
  }
1528
- export declare enum Direction {
1487
+ declare enum Direction {
1529
1488
  /** Left-to-right */
1530
1489
  LTR = "LTR",
1531
1490
  /** Right-to-left */
1532
1491
  RTL = "RTL"
1533
1492
  }
1534
- export interface TableData {
1493
+ interface TableData {
1535
1494
  /** Styling for the table's container. */
1536
1495
  containerData?: PluginContainerData;
1537
1496
  /** The table's dimensions. */
@@ -1546,7 +1505,7 @@ export interface TableData {
1546
1505
  /** Sets whether the table's first column is a header. Defaults to `false`. */
1547
1506
  columnHeader?: boolean | null;
1548
1507
  }
1549
- export interface Dimensions {
1508
+ interface Dimensions {
1550
1509
  /** An array representing relative width of each column in relation to the other columns. */
1551
1510
  colsWidthRatio?: number[];
1552
1511
  /** An array representing the height of each row in pixels. */
@@ -1554,13 +1513,13 @@ export interface Dimensions {
1554
1513
  /** An array representing the minimum width of each column in pixels. */
1555
1514
  colsMinWidth?: number[];
1556
1515
  }
1557
- export interface TableCellData {
1516
+ interface TableCellData {
1558
1517
  /** Styling for the cell's background color and text alignment. */
1559
1518
  cellStyle?: CellStyle;
1560
1519
  /** The cell's border colors. */
1561
1520
  borderColors?: BorderColors;
1562
1521
  }
1563
- export declare enum VerticalAlignment {
1522
+ declare enum VerticalAlignment {
1564
1523
  /** Top alignment */
1565
1524
  TOP = "TOP",
1566
1525
  /** Middle alignment */
@@ -1568,7 +1527,7 @@ export declare enum VerticalAlignment {
1568
1527
  /** Bottom alignment */
1569
1528
  BOTTOM = "BOTTOM"
1570
1529
  }
1571
- export interface CellStyle {
1530
+ interface CellStyle {
1572
1531
  /** Vertical alignment for the cell's text. */
1573
1532
  verticalAlignment?: VerticalAlignment;
1574
1533
  /**
@@ -1577,7 +1536,7 @@ export interface CellStyle {
1577
1536
  */
1578
1537
  backgroundColor?: string | null;
1579
1538
  }
1580
- export interface BorderColors {
1539
+ interface BorderColors {
1581
1540
  /**
1582
1541
  * Left border color as a hexadecimal value.
1583
1542
  * @format COLOR_HEX
@@ -1605,7 +1564,7 @@ export interface BorderColors {
1605
1564
  *
1606
1565
  * The JSON representation for `NullValue` is JSON `null`.
1607
1566
  */
1608
- export declare enum NullValue {
1567
+ declare enum NullValue {
1609
1568
  /** Null value. */
1610
1569
  NULL_VALUE = "NULL_VALUE"
1611
1570
  }
@@ -1614,11 +1573,11 @@ export declare enum NullValue {
1614
1573
  *
1615
1574
  * The JSON representation for `ListValue` is JSON array.
1616
1575
  */
1617
- export interface ListValue {
1576
+ interface ListValue {
1618
1577
  /** Repeated field of dynamically typed values. */
1619
1578
  values?: any[];
1620
1579
  }
1621
- export interface AudioData {
1580
+ interface AudioData {
1622
1581
  /** Styling for the audio node's container. */
1623
1582
  containerData?: PluginContainerData;
1624
1583
  /** Audio file details. */
@@ -1634,7 +1593,7 @@ export interface AudioData {
1634
1593
  /** An HTML version of the audio node. */
1635
1594
  html?: string | null;
1636
1595
  }
1637
- export interface OrderedListData {
1596
+ interface OrderedListData {
1638
1597
  /** Indentation level from 0-4. */
1639
1598
  indentation?: number;
1640
1599
  /** Offset level from 0-4. */
@@ -1642,24 +1601,24 @@ export interface OrderedListData {
1642
1601
  /** List start number. */
1643
1602
  start?: number | null;
1644
1603
  }
1645
- export interface BulletedListData {
1604
+ interface BulletedListData {
1646
1605
  /** Indentation level from 0-4. */
1647
1606
  indentation?: number;
1648
1607
  /** Offset level from 0-4. */
1649
1608
  offset?: number | null;
1650
1609
  }
1651
- export interface BlockquoteData {
1610
+ interface BlockquoteData {
1652
1611
  /** Indentation level from 1-4. */
1653
1612
  indentation?: number;
1654
1613
  }
1655
- export interface CaptionData {
1614
+ interface CaptionData {
1656
1615
  textStyle?: TextStyle;
1657
1616
  }
1658
- export interface LayoutCellData {
1617
+ interface LayoutCellData {
1659
1618
  /** Size of the cell in 12 columns grid. */
1660
1619
  colSpan?: number | null;
1661
1620
  }
1662
- export interface Metadata {
1621
+ interface Metadata {
1663
1622
  /** Schema version. */
1664
1623
  version?: number;
1665
1624
  /**
@@ -1674,9 +1633,9 @@ export interface Metadata {
1674
1633
  */
1675
1634
  updatedTimestamp?: Date | null;
1676
1635
  /** Object ID. */
1677
- id?: string | null;
1636
+ _id?: string | null;
1678
1637
  }
1679
- export interface DocumentStyle {
1638
+ interface DocumentStyle {
1680
1639
  /** Styling for H1 nodes. */
1681
1640
  headerOne?: TextNodeStyle;
1682
1641
  /** Styling for H2 nodes. */
@@ -1696,7 +1655,7 @@ export interface DocumentStyle {
1696
1655
  /** Styling for code block nodes. */
1697
1656
  codeBlock?: TextNodeStyle;
1698
1657
  }
1699
- export interface TextNodeStyle {
1658
+ interface TextNodeStyle {
1700
1659
  /** The decorations to apply to the node. */
1701
1660
  decorations?: Decoration[];
1702
1661
  /** Padding and background color for the node. */
@@ -1704,7 +1663,7 @@ export interface TextNodeStyle {
1704
1663
  /** Line height for text in the node. */
1705
1664
  lineHeight?: string | null;
1706
1665
  }
1707
- export interface ModerationDetails {
1666
+ interface ModerationDetails {
1708
1667
  /**
1709
1668
  * Member ID of the person submitting the draft post for review.
1710
1669
  * @format GUID
@@ -1722,12 +1681,12 @@ export interface ModerationDetails {
1722
1681
  /** Date the post was approved or rejected. */
1723
1682
  moderationDate?: Date | null;
1724
1683
  }
1725
- export declare enum ModerationStatusStatus {
1684
+ declare enum ModerationStatusStatus {
1726
1685
  UNKNOWN = "UNKNOWN",
1727
1686
  APPROVED = "APPROVED",
1728
1687
  REJECTED = "REJECTED"
1729
1688
  }
1730
- export interface Media extends MediaMediaOneOf {
1689
+ interface Media extends MediaMediaOneOf {
1731
1690
  /** Wix Media details. */
1732
1691
  wixMedia?: WixMedia;
1733
1692
  /** Embed media details. */
@@ -1744,34 +1703,19 @@ export interface Media extends MediaMediaOneOf {
1744
1703
  altText?: string | null;
1745
1704
  }
1746
1705
  /** @oneof */
1747
- export interface MediaMediaOneOf {
1706
+ interface MediaMediaOneOf {
1748
1707
  /** Wix Media details. */
1749
1708
  wixMedia?: WixMedia;
1750
1709
  /** Embed media details. */
1751
1710
  embedMedia?: EmbedMedia;
1752
1711
  }
1753
- export interface WixMedia {
1712
+ interface WixMedia {
1754
1713
  /** Image details. */
1755
- image?: Image;
1714
+ image?: string;
1756
1715
  /** Video details. */
1757
- videoV2?: VideoV2;
1758
- }
1759
- export interface VideoV2 {
1760
- /** WixMedia ID. */
1761
- id?: string;
1762
- /**
1763
- * Available resolutions for the video, starting with the optimal resolution.
1764
- * @readonly
1765
- * @maxSize 100
1766
- */
1767
- resolutions?: VideoResolution[];
1768
- /**
1769
- * Video filename.
1770
- * @readonly
1771
- */
1772
- filename?: string | null;
1716
+ videoV2?: string;
1773
1717
  }
1774
- export interface VideoResolution {
1718
+ interface VideoResolution {
1775
1719
  /** Video URL. */
1776
1720
  url?: string;
1777
1721
  /** Video height. */
@@ -1781,13 +1725,13 @@ export interface VideoResolution {
1781
1725
  /** Video format for example, mp4, hls. */
1782
1726
  format?: string;
1783
1727
  }
1784
- export interface EmbedMedia {
1728
+ interface EmbedMedia {
1785
1729
  /** Thumbnail details. */
1786
1730
  thumbnail?: EmbedThumbnail;
1787
1731
  /** Video details. */
1788
1732
  video?: EmbedVideo;
1789
1733
  }
1790
- export interface EmbedThumbnail {
1734
+ interface EmbedThumbnail {
1791
1735
  /**
1792
1736
  * Thumbnail url.
1793
1737
  * @maxLength 2000
@@ -1798,7 +1742,7 @@ export interface EmbedThumbnail {
1798
1742
  /** Thumbnail height. */
1799
1743
  height?: number;
1800
1744
  }
1801
- export interface EmbedVideo {
1745
+ interface EmbedVideo {
1802
1746
  /**
1803
1747
  * Video url.
1804
1748
  * @maxLength 2000
@@ -1809,12 +1753,12 @@ export interface EmbedVideo {
1809
1753
  /** Video height. */
1810
1754
  height?: number;
1811
1755
  }
1812
- export interface PostTranslation {
1756
+ interface PostTranslation {
1813
1757
  /**
1814
1758
  * Post ID.
1815
1759
  * @format GUID
1816
1760
  */
1817
- id?: string;
1761
+ _id?: string;
1818
1762
  /**
1819
1763
  * Language the post is written in.
1820
1764
  * @format LANGUAGE_TAG
@@ -1828,9 +1772,9 @@ export interface PostTranslation {
1828
1772
  /** SEO data. */
1829
1773
  seoData?: SeoSchema;
1830
1774
  /** Post URL. */
1831
- url?: PageUrl;
1775
+ url?: string;
1832
1776
  }
1833
- export interface PostCategoriesUpdated {
1777
+ interface PostCategoriesUpdated {
1834
1778
  /**
1835
1779
  * ID of the post which counters were updated.
1836
1780
  * @format GUID
@@ -1849,7 +1793,7 @@ export interface PostCategoriesUpdated {
1849
1793
  */
1850
1794
  previousCategories?: string[];
1851
1795
  }
1852
- export interface PostTagsUpdated {
1796
+ interface PostTagsUpdated {
1853
1797
  /**
1854
1798
  * ID of the post which counters were updated.
1855
1799
  * @format GUID
@@ -1868,7 +1812,7 @@ export interface PostTagsUpdated {
1868
1812
  */
1869
1813
  previousTags?: string[];
1870
1814
  }
1871
- export interface ScheduledPostPublished {
1815
+ interface ScheduledPostPublished {
1872
1816
  /**
1873
1817
  * ID of the scheduled post which was published.
1874
1818
  * @format GUID
@@ -1876,7 +1820,7 @@ export interface ScheduledPostPublished {
1876
1820
  postId?: string;
1877
1821
  }
1878
1822
  /** Get Blog Publications Count Stats request */
1879
- export interface QueryPublicationsCountStatsRequest {
1823
+ interface QueryPublicationsCountStatsRequest {
1880
1824
  /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
1881
1825
  rangeStart?: Date | null;
1882
1826
  /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
@@ -1899,25 +1843,25 @@ export interface QueryPublicationsCountStatsRequest {
1899
1843
  */
1900
1844
  timeZone?: string | null;
1901
1845
  }
1902
- export declare enum QueryPublicationsCountStatsRequestOrder {
1846
+ declare enum QueryPublicationsCountStatsRequestOrder {
1903
1847
  UNKNOWN = "UNKNOWN",
1904
1848
  OLDEST = "OLDEST",
1905
1849
  NEWEST = "NEWEST"
1906
1850
  }
1907
1851
  /** Get Blog Publications Count Stats response */
1908
- export interface QueryPublicationsCountStatsResponse {
1852
+ interface QueryPublicationsCountStatsResponse {
1909
1853
  /** Chronologically ordered list of publications. */
1910
1854
  stats?: PeriodPublicationsCount[];
1911
1855
  }
1912
1856
  /** Publications count for a specific time period */
1913
- export interface PeriodPublicationsCount {
1857
+ interface PeriodPublicationsCount {
1914
1858
  /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
1915
1859
  periodStart?: Date | null;
1916
1860
  /** Number of posts published during this month. */
1917
1861
  publicationsCount?: number;
1918
1862
  }
1919
1863
  /** Get Blog Post Count Stats request */
1920
- export interface QueryPostCountStatsRequest {
1864
+ interface QueryPostCountStatsRequest {
1921
1865
  /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
1922
1866
  rangeStart?: Date | null;
1923
1867
  /**
@@ -1948,24 +1892,24 @@ export interface QueryPostCountStatsRequest {
1948
1892
  */
1949
1893
  timeZone?: string | null;
1950
1894
  }
1951
- export declare enum Order {
1895
+ declare enum Order {
1952
1896
  UNKNOWN = "UNKNOWN",
1953
1897
  OLDEST = "OLDEST",
1954
1898
  NEWEST = "NEWEST"
1955
1899
  }
1956
1900
  /** Get Blog Post Count Stats response */
1957
- export interface QueryPostCountStatsResponse {
1901
+ interface QueryPostCountStatsResponse {
1958
1902
  /** List of published post counts by month. */
1959
1903
  stats?: PeriodPostCount[];
1960
1904
  }
1961
1905
  /** Post count for a specific time period */
1962
- export interface PeriodPostCount {
1906
+ interface PeriodPostCount {
1963
1907
  /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
1964
1908
  periodStart?: Date | null;
1965
1909
  /** Number of posts published during this month. */
1966
1910
  postCount?: number;
1967
1911
  }
1968
- export interface GetTotalPublicationsRequest {
1912
+ interface GetTotalPublicationsRequest {
1969
1913
  /**
1970
1914
  * Language filter
1971
1915
  * @minLength 2
@@ -1973,11 +1917,11 @@ export interface GetTotalPublicationsRequest {
1973
1917
  */
1974
1918
  language?: string | null;
1975
1919
  }
1976
- export interface GetTotalPublicationsResponse {
1920
+ interface GetTotalPublicationsResponse {
1977
1921
  /** Total amount of publications. */
1978
1922
  total?: number;
1979
1923
  }
1980
- export interface GetTotalPostsRequest {
1924
+ interface GetTotalPostsRequest {
1981
1925
  /**
1982
1926
  * Language filter.
1983
1927
  *
@@ -1987,11 +1931,11 @@ export interface GetTotalPostsRequest {
1987
1931
  */
1988
1932
  language?: string | null;
1989
1933
  }
1990
- export interface GetTotalPostsResponse {
1934
+ interface GetTotalPostsResponse {
1991
1935
  /** Total amount of published posts. */
1992
1936
  total?: number;
1993
1937
  }
1994
- export interface DomainEvent extends DomainEventBodyOneOf {
1938
+ interface DomainEvent extends DomainEventBodyOneOf {
1995
1939
  createdEvent?: EntityCreatedEvent;
1996
1940
  updatedEvent?: EntityUpdatedEvent;
1997
1941
  deletedEvent?: EntityDeletedEvent;
@@ -2000,7 +1944,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
2000
1944
  * Unique event ID.
2001
1945
  * Allows clients to ignore duplicate webhooks.
2002
1946
  */
2003
- id?: string;
1947
+ _id?: string;
2004
1948
  /**
2005
1949
  * Assumes actions are also always typed to an entity_type
2006
1950
  * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
@@ -2034,36 +1978,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
2034
1978
  entityEventSequence?: string | null;
2035
1979
  }
2036
1980
  /** @oneof */
2037
- export interface DomainEventBodyOneOf {
1981
+ interface DomainEventBodyOneOf {
2038
1982
  createdEvent?: EntityCreatedEvent;
2039
1983
  updatedEvent?: EntityUpdatedEvent;
2040
1984
  deletedEvent?: EntityDeletedEvent;
2041
1985
  actionEvent?: ActionEvent;
2042
1986
  }
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;
1987
+ interface EntityCreatedEvent {
1988
+ entity?: string;
2047
1989
  }
2048
- export interface RestoreInfo {
1990
+ interface RestoreInfo {
2049
1991
  deletedDate?: Date | null;
2050
1992
  }
2051
- export interface EntityUpdatedEvent {
1993
+ interface EntityUpdatedEvent {
2052
1994
  /**
2053
1995
  * 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
1996
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2055
1997
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2056
1998
  */
2057
- currentEntityAsJson?: string;
1999
+ currentEntity?: string;
2058
2000
  }
2059
- export interface EntityDeletedEvent {
2001
+ interface EntityDeletedEvent {
2060
2002
  /** Entity that was deleted */
2061
- deletedEntityAsJson?: string | null;
2003
+ deletedEntity?: string | null;
2062
2004
  }
2063
- export interface ActionEvent {
2064
- bodyAsJson?: string;
2005
+ interface ActionEvent {
2006
+ body?: string;
2065
2007
  }
2066
- export interface MessageEnvelope {
2008
+ interface MessageEnvelope {
2067
2009
  /**
2068
2010
  * App instance ID.
2069
2011
  * @format GUID
@@ -2079,7 +2021,7 @@ export interface MessageEnvelope {
2079
2021
  /** Stringify payload. */
2080
2022
  data?: string;
2081
2023
  }
2082
- export interface IdentificationData extends IdentificationDataIdOneOf {
2024
+ interface IdentificationData extends IdentificationDataIdOneOf {
2083
2025
  /**
2084
2026
  * ID of a site visitor that has not logged in to the site.
2085
2027
  * @format GUID
@@ -2104,7 +2046,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
2104
2046
  identityType?: WebhookIdentityType;
2105
2047
  }
2106
2048
  /** @oneof */
2107
- export interface IdentificationDataIdOneOf {
2049
+ interface IdentificationDataIdOneOf {
2108
2050
  /**
2109
2051
  * ID of a site visitor that has not logged in to the site.
2110
2052
  * @format GUID
@@ -2126,14 +2068,14 @@ export interface IdentificationDataIdOneOf {
2126
2068
  */
2127
2069
  appId?: string;
2128
2070
  }
2129
- export declare enum WebhookIdentityType {
2071
+ declare enum WebhookIdentityType {
2130
2072
  UNKNOWN = "UNKNOWN",
2131
2073
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2132
2074
  MEMBER = "MEMBER",
2133
2075
  WIX_USER = "WIX_USER",
2134
2076
  APP = "APP"
2135
2077
  }
2136
- export interface ListTemplatesRequest {
2078
+ interface ListTemplatesRequest {
2137
2079
  /**
2138
2080
  * Filter post templates by given template category ids
2139
2081
  * @maxSize 50
@@ -2152,13 +2094,13 @@ export interface ListTemplatesRequest {
2152
2094
  /** Pagination options. */
2153
2095
  paging?: BlogPaging;
2154
2096
  }
2155
- export declare enum GetPostTemplatesSort {
2097
+ declare enum GetPostTemplatesSort {
2156
2098
  /** Sort by ascending publishing date. */
2157
2099
  PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2158
2100
  /** Sort by descending publishing date. */
2159
2101
  PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2160
2102
  }
2161
- export interface BlogPaging {
2103
+ interface BlogPaging {
2162
2104
  /**
2163
2105
  * Number of items to skip in the current sort order.
2164
2106
  *
@@ -2181,7 +2123,7 @@ export interface BlogPaging {
2181
2123
  */
2182
2124
  cursor?: string | null;
2183
2125
  }
2184
- export interface ListTemplatesResponse {
2126
+ interface ListTemplatesResponse {
2185
2127
  /** Available post templates */
2186
2128
  postTemplates?: Post[];
2187
2129
  /** Details on the paged set of posts templates returned. */
@@ -2189,7 +2131,7 @@ export interface ListTemplatesResponse {
2189
2131
  /** Post template categories. This value is returned empty unless asked explicitly */
2190
2132
  templateCategories?: Category[];
2191
2133
  }
2192
- export interface MetaData {
2134
+ interface MetaData {
2193
2135
  /** Number of items returned in this response. */
2194
2136
  count?: number;
2195
2137
  /** Requested offset. */
@@ -2202,13 +2144,13 @@ export interface MetaData {
2202
2144
  */
2203
2145
  cursor?: string | null;
2204
2146
  }
2205
- export interface Category {
2147
+ interface Category {
2206
2148
  /**
2207
2149
  * Category ID.
2208
2150
  * @immutable
2209
2151
  * @maxLength 38
2210
2152
  */
2211
- id?: string;
2153
+ _id?: string;
2212
2154
  /**
2213
2155
  * Category label. Displayed in the Category Menu.
2214
2156
  * @maxLength 35
@@ -2223,7 +2165,7 @@ export interface Category {
2223
2165
  * The `url` of the page that lists every post with the specified category.
2224
2166
  * @readonly
2225
2167
  */
2226
- url?: PageUrl;
2168
+ url?: string;
2227
2169
  /**
2228
2170
  * Category description.
2229
2171
  * @maxLength 500
@@ -2263,19 +2205,19 @@ export interface Category {
2263
2205
  /** SEO data. */
2264
2206
  seoData?: SeoSchema;
2265
2207
  /** Category cover image. */
2266
- coverImage?: Image;
2208
+ coverImage?: string;
2267
2209
  /**
2268
2210
  * Date and time the Category was last updated.
2269
2211
  * @readonly
2270
2212
  */
2271
- updatedDate?: Date | null;
2213
+ _updatedDate?: Date | null;
2272
2214
  }
2273
- export interface CategoryTranslation {
2215
+ interface CategoryTranslation {
2274
2216
  /**
2275
2217
  * Category ID.
2276
2218
  * @format GUID
2277
2219
  */
2278
- id?: string;
2220
+ _id?: string;
2279
2221
  /**
2280
2222
  * Label displayed in the categories menu on the site.
2281
2223
  * @maxLength 100
@@ -2287,37 +2229,37 @@ export interface CategoryTranslation {
2287
2229
  */
2288
2230
  language?: string | null;
2289
2231
  /** URL of this category page. */
2290
- url?: PageUrl;
2232
+ url?: string;
2291
2233
  }
2292
- export interface GetTemplateRequest {
2234
+ interface GetTemplateRequest {
2293
2235
  /**
2294
2236
  * Post template id
2295
2237
  * @format GUID
2296
2238
  */
2297
2239
  postTemplateId?: string;
2298
2240
  }
2299
- export interface GetTemplateResponse {
2241
+ interface GetTemplateResponse {
2300
2242
  /** Post template */
2301
2243
  postTemplate?: Post;
2302
2244
  }
2303
- export interface CreateDraftPostFromTemplateRequest {
2245
+ interface CreateDraftPostFromTemplateRequest {
2304
2246
  /**
2305
2247
  * Post template id
2306
2248
  * @format GUID
2307
2249
  */
2308
2250
  postTemplateId?: string;
2309
2251
  }
2310
- export interface CreateDraftPostFromTemplateResponse {
2252
+ interface CreateDraftPostFromTemplateResponse {
2311
2253
  /** Created draft post */
2312
2254
  draftPost?: DraftPost;
2313
2255
  }
2314
- export interface DraftPost {
2256
+ interface DraftPost {
2315
2257
  /**
2316
2258
  * Draft post ID.
2317
2259
  * @readonly
2318
2260
  * @maxLength 38
2319
2261
  */
2320
- id?: string;
2262
+ _id?: string;
2321
2263
  /**
2322
2264
  * Draft post title.
2323
2265
  * @maxLength 200
@@ -2358,7 +2300,7 @@ export interface DraftPost {
2358
2300
  */
2359
2301
  minutesToRead?: number;
2360
2302
  /** Image placed at the top of the blog page. */
2361
- heroImage?: Image;
2303
+ heroImage?: string;
2362
2304
  /**
2363
2305
  * Tag IDs the draft post is tagged with.
2364
2306
  * @maxSize 30
@@ -2430,12 +2372,12 @@ export interface DraftPost {
2430
2372
  * Draft post URL preview. What the URL will look like once the post is published.
2431
2373
  * @readonly
2432
2374
  */
2433
- url?: PageUrl;
2375
+ url?: string;
2434
2376
  /**
2435
2377
  * Date the draft post was first created.
2436
2378
  * @readonly
2437
2379
  */
2438
- createdDate?: Date | null;
2380
+ _createdDate?: Date | null;
2439
2381
  /**
2440
2382
  * SEO slug.
2441
2383
  * @maxLength 100
@@ -2446,7 +2388,7 @@ export interface DraftPost {
2446
2388
  /** Number of paragraphs to display in a paid content preview for non-paying users. */
2447
2389
  previewTextParagraph?: number | null;
2448
2390
  }
2449
- export declare enum Origin {
2391
+ declare enum Origin {
2450
2392
  UNKNOWN = "UNKNOWN",
2451
2393
  /** Changed by admin */
2452
2394
  ADMIN = "ADMIN",
@@ -2519,7 +2461,7 @@ export declare enum Origin {
2519
2461
  /** Saved automatically by AI tool. */
2520
2462
  AI_AUTO_SAVE = "AI_AUTO_SAVE"
2521
2463
  }
2522
- export declare enum Status {
2464
+ declare enum Status {
2523
2465
  UNKNOWN = "UNKNOWN",
2524
2466
  /** Status indicating the draft post is published. */
2525
2467
  PUBLISHED = "PUBLISHED",
@@ -2532,12 +2474,12 @@ export declare enum Status {
2532
2474
  /** Status indicating the draft post is in review. */
2533
2475
  IN_REVIEW = "IN_REVIEW"
2534
2476
  }
2535
- export interface DraftPostTranslation {
2477
+ interface DraftPostTranslation {
2536
2478
  /**
2537
2479
  * Post ID.
2538
2480
  * @format GUID
2539
2481
  */
2540
- id?: string;
2482
+ _id?: string;
2541
2483
  /** Post status. */
2542
2484
  status?: Status;
2543
2485
  /**
@@ -2553,20 +2495,20 @@ export interface DraftPostTranslation {
2553
2495
  /** SEO data. */
2554
2496
  seoData?: SeoSchema;
2555
2497
  /** Post URL. */
2556
- url?: PageUrl;
2498
+ url?: string;
2557
2499
  }
2558
- export interface GetTotalLikesPerMemberRequest {
2500
+ interface GetTotalLikesPerMemberRequest {
2559
2501
  /**
2560
2502
  * Member ID.
2561
2503
  * @format GUID
2562
2504
  */
2563
2505
  memberId?: string;
2564
2506
  }
2565
- export interface GetTotalLikesPerMemberResponse {
2507
+ interface GetTotalLikesPerMemberResponse {
2566
2508
  /** The total number of likes of the member. */
2567
2509
  total?: number;
2568
2510
  }
2569
- export interface PostLiked extends PostLikedInitiatorOneOf {
2511
+ interface PostLiked extends PostLikedInitiatorOneOf {
2570
2512
  /**
2571
2513
  * Member ID of person who liked the post (only returned when the member was logged in when liking the post).
2572
2514
  * @format GUID
@@ -2584,7 +2526,7 @@ export interface PostLiked extends PostLikedInitiatorOneOf {
2584
2526
  postId?: string;
2585
2527
  }
2586
2528
  /** @oneof */
2587
- export interface PostLikedInitiatorOneOf {
2529
+ interface PostLikedInitiatorOneOf {
2588
2530
  /**
2589
2531
  * Member ID of person who liked the post (only returned when the member was logged in when liking the post).
2590
2532
  * @format GUID
@@ -2596,7 +2538,7 @@ export interface PostLikedInitiatorOneOf {
2596
2538
  */
2597
2539
  anonymousVisitorId?: string | null;
2598
2540
  }
2599
- export interface PostUnliked extends PostUnlikedInitiatorOneOf {
2541
+ interface PostUnliked extends PostUnlikedInitiatorOneOf {
2600
2542
  /**
2601
2543
  * Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
2602
2544
  * @format GUID
@@ -2614,7 +2556,7 @@ export interface PostUnliked extends PostUnlikedInitiatorOneOf {
2614
2556
  postId?: string;
2615
2557
  }
2616
2558
  /** @oneof */
2617
- export interface PostUnlikedInitiatorOneOf {
2559
+ interface PostUnlikedInitiatorOneOf {
2618
2560
  /**
2619
2561
  * Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
2620
2562
  * @format GUID
@@ -2626,7 +2568,7 @@ export interface PostUnlikedInitiatorOneOf {
2626
2568
  */
2627
2569
  anonymousVisitorId?: string | null;
2628
2570
  }
2629
- export interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
2571
+ interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
2630
2572
  /**
2631
2573
  * Member ID of person who triggered the counter update
2632
2574
  * @format GUID
@@ -2648,7 +2590,7 @@ export interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
2648
2590
  counter?: number;
2649
2591
  }
2650
2592
  /** @oneof */
2651
- export interface PostCountersUpdatedInitiatorOneOf {
2593
+ interface PostCountersUpdatedInitiatorOneOf {
2652
2594
  /**
2653
2595
  * Member ID of person who triggered the counter update
2654
2596
  * @format GUID
@@ -2660,7 +2602,7 @@ export interface PostCountersUpdatedInitiatorOneOf {
2660
2602
  */
2661
2603
  anonymousVisitorId?: string | null;
2662
2604
  }
2663
- export declare enum Field {
2605
+ declare enum Field {
2664
2606
  /** Undefined field. */
2665
2607
  UNKNOWN = "UNKNOWN",
2666
2608
  /** Total comments field. */
@@ -2672,13 +2614,13 @@ export declare enum Field {
2672
2614
  /** Rating count field. */
2673
2615
  RATING_COUNT = "RATING_COUNT"
2674
2616
  }
2675
- export interface PostOwnerChanged {
2617
+ interface PostOwnerChanged {
2676
2618
  }
2677
- export interface InitialPostsCopied {
2619
+ interface InitialPostsCopied {
2678
2620
  /** Number of posts copied. */
2679
2621
  count?: number;
2680
2622
  }
2681
- export interface GetPostRequest {
2623
+ interface GetPostRequest {
2682
2624
  /**
2683
2625
  * Post ID.
2684
2626
  * @minLength 1
@@ -2693,7 +2635,7 @@ export interface GetPostRequest {
2693
2635
  */
2694
2636
  fieldsets?: PostFieldField[];
2695
2637
  }
2696
- export declare enum PostFieldField {
2638
+ declare enum PostFieldField {
2697
2639
  UNKNOWN = "UNKNOWN",
2698
2640
  /** Includes post URL when present. */
2699
2641
  URL = "URL",
@@ -2710,11 +2652,11 @@ export declare enum PostFieldField {
2710
2652
  /** Includes post reference ID field. */
2711
2653
  REFERENCE_ID = "REFERENCE_ID"
2712
2654
  }
2713
- export interface GetPostResponse {
2655
+ interface GetPostResponse {
2714
2656
  /** Retrieved post info. */
2715
2657
  post?: Post;
2716
2658
  }
2717
- export interface GetPostBySlugRequest {
2659
+ interface GetPostBySlugRequest {
2718
2660
  /**
2719
2661
  * Slug of the post to retrieve.
2720
2662
  * @minLength 1
@@ -2729,11 +2671,11 @@ export interface GetPostBySlugRequest {
2729
2671
  */
2730
2672
  fieldsets?: PostFieldField[];
2731
2673
  }
2732
- export interface GetPostBySlugResponse {
2674
+ interface GetPostBySlugResponse {
2733
2675
  /** Retrieved post info. */
2734
2676
  post?: Post;
2735
2677
  }
2736
- export interface ListPostsRequest {
2678
+ interface ListPostsRequest {
2737
2679
  /**
2738
2680
  * Whether to return only featured posts.
2739
2681
  *
@@ -2797,7 +2739,7 @@ export interface ListPostsRequest {
2797
2739
  */
2798
2740
  fieldsets?: PostFieldField[];
2799
2741
  }
2800
- export declare enum GetPostsSort {
2742
+ declare enum GetPostsSort {
2801
2743
  /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
2802
2744
  FEED = "FEED",
2803
2745
  /** Ordered by `firstPublishedDate` in ascending order. */
@@ -2813,13 +2755,13 @@ export declare enum GetPostsSort {
2813
2755
  /** Ordered by `title` in descending order. */
2814
2756
  TITLE_DESC = "TITLE_DESC"
2815
2757
  }
2816
- export interface ListPostsResponse {
2758
+ interface ListPostsResponse {
2817
2759
  /** List of retrieved posts. */
2818
2760
  posts?: Post[];
2819
2761
  /** Details on the paged set of results returned. */
2820
2762
  metaData?: MetaData;
2821
2763
  }
2822
- export interface QueryPostsRequest {
2764
+ interface QueryPostsRequest {
2823
2765
  /** Query options. */
2824
2766
  query?: PlatformQuery;
2825
2767
  /**
@@ -2830,7 +2772,7 @@ export interface QueryPostsRequest {
2830
2772
  */
2831
2773
  fieldsets?: PostFieldField[];
2832
2774
  }
2833
- export interface Sorting {
2775
+ interface Sorting {
2834
2776
  /**
2835
2777
  * Name of the field to sort by.
2836
2778
  * @maxLength 512
@@ -2839,11 +2781,11 @@ export interface Sorting {
2839
2781
  /** Sort order. */
2840
2782
  order?: SortOrder;
2841
2783
  }
2842
- export declare enum SortOrder {
2784
+ declare enum SortOrder {
2843
2785
  ASC = "ASC",
2844
2786
  DESC = "DESC"
2845
2787
  }
2846
- export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
2788
+ interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
2847
2789
  /** Paging options to limit and skip the number of items. */
2848
2790
  paging?: Paging;
2849
2791
  /** 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 +2807,13 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
2865
2807
  sort?: Sorting[];
2866
2808
  }
2867
2809
  /** @oneof */
2868
- export interface PlatformQueryPagingMethodOneOf {
2810
+ interface PlatformQueryPagingMethodOneOf {
2869
2811
  /** Paging options to limit and skip the number of items. */
2870
2812
  paging?: Paging;
2871
2813
  /** 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
2814
  cursorPaging?: CursorPaging;
2873
2815
  }
2874
- export interface Paging {
2816
+ interface Paging {
2875
2817
  /**
2876
2818
  * Number of items to load.
2877
2819
  * @max 100
@@ -2880,7 +2822,7 @@ export interface Paging {
2880
2822
  /** Number of items to skip in the current sort order. */
2881
2823
  offset?: number | null;
2882
2824
  }
2883
- export interface CursorPaging {
2825
+ interface CursorPaging {
2884
2826
  /**
2885
2827
  * Number of items to load.
2886
2828
  * @max 100
@@ -2896,13 +2838,13 @@ export interface CursorPaging {
2896
2838
  */
2897
2839
  cursor?: string | null;
2898
2840
  }
2899
- export interface QueryPostsResponse {
2841
+ interface QueryPostsResponse {
2900
2842
  /** List of retrieved posts. */
2901
2843
  posts?: Post[];
2902
2844
  /** Details on the paged set of results returned. */
2903
2845
  pagingMetadata?: PagingMetadataV2;
2904
2846
  }
2905
- export interface PagingMetadataV2 {
2847
+ interface PagingMetadataV2 {
2906
2848
  /** Number of items returned in the response. */
2907
2849
  count?: number | null;
2908
2850
  /** Offset that was requested. */
@@ -2914,7 +2856,7 @@ export interface PagingMetadataV2 {
2914
2856
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
2915
2857
  cursors?: Cursors;
2916
2858
  }
2917
- export interface Cursors {
2859
+ interface Cursors {
2918
2860
  /**
2919
2861
  * Cursor pointing to next page in the list of results.
2920
2862
  * @maxLength 2000
@@ -2926,7 +2868,7 @@ export interface Cursors {
2926
2868
  */
2927
2869
  prev?: string | null;
2928
2870
  }
2929
- export interface GetPostMetricsRequest {
2871
+ interface GetPostMetricsRequest {
2930
2872
  /**
2931
2873
  * Post ID to retrieve metrics for.
2932
2874
  * @minLength 1
@@ -2934,11 +2876,11 @@ export interface GetPostMetricsRequest {
2934
2876
  */
2935
2877
  postId: string;
2936
2878
  }
2937
- export interface GetPostMetricsResponse {
2879
+ interface GetPostMetricsResponse {
2938
2880
  /** Retrieved post metrics. */
2939
2881
  metrics?: Metrics;
2940
2882
  }
2941
- export interface BulkGetPostMetricsRequest {
2883
+ interface BulkGetPostMetricsRequest {
2942
2884
  /**
2943
2885
  * Post IDs.
2944
2886
  * @maxSize 500
@@ -2946,11 +2888,11 @@ export interface BulkGetPostMetricsRequest {
2946
2888
  */
2947
2889
  postIds?: string[];
2948
2890
  }
2949
- export interface BulkGetPostMetricsResponse {
2891
+ interface BulkGetPostMetricsResponse {
2950
2892
  /** Map of post.id to metrics */
2951
2893
  metrics?: Record<string, Metrics>;
2952
2894
  }
2953
- export interface ViewPostRequest {
2895
+ interface ViewPostRequest {
2954
2896
  /**
2955
2897
  * Post ID.
2956
2898
  * @minLength 1
@@ -2958,11 +2900,11 @@ export interface ViewPostRequest {
2958
2900
  */
2959
2901
  postId?: string;
2960
2902
  }
2961
- export interface ViewPostResponse {
2903
+ interface ViewPostResponse {
2962
2904
  /** Total number of post views */
2963
2905
  views?: number;
2964
2906
  }
2965
- export interface LikePostRequest {
2907
+ interface LikePostRequest {
2966
2908
  /**
2967
2909
  * Post ID.
2968
2910
  * @minLength 1
@@ -2977,11 +2919,11 @@ export interface LikePostRequest {
2977
2919
  */
2978
2920
  fieldsets?: PostFieldField[];
2979
2921
  }
2980
- export interface LikePostResponse {
2922
+ interface LikePostResponse {
2981
2923
  /** Post info. */
2982
2924
  post?: Post;
2983
2925
  }
2984
- export interface UnlikePostRequest {
2926
+ interface UnlikePostRequest {
2985
2927
  /**
2986
2928
  * Post ID.
2987
2929
  * @minLength 1
@@ -2996,11 +2938,11 @@ export interface UnlikePostRequest {
2996
2938
  */
2997
2939
  fieldsets?: PostFieldField[];
2998
2940
  }
2999
- export interface UnlikePostResponse {
2941
+ interface UnlikePostResponse {
3000
2942
  /** Post info. */
3001
2943
  post?: Post;
3002
2944
  }
3003
- export interface PinPostRequest {
2945
+ interface PinPostRequest {
3004
2946
  /**
3005
2947
  * Post ID.
3006
2948
  * @minLength 1
@@ -3015,11 +2957,11 @@ export interface PinPostRequest {
3015
2957
  */
3016
2958
  fieldsets?: PostFieldField[];
3017
2959
  }
3018
- export interface PinPostResponse {
2960
+ interface PinPostResponse {
3019
2961
  /** Post info. */
3020
2962
  post?: Post;
3021
2963
  }
3022
- export interface UnpinPostRequest {
2964
+ interface UnpinPostRequest {
3023
2965
  /**
3024
2966
  * Post ID.
3025
2967
  * @minLength 1
@@ -3034,11 +2976,11 @@ export interface UnpinPostRequest {
3034
2976
  */
3035
2977
  fieldsets?: PostFieldField[];
3036
2978
  }
3037
- export interface UnpinPostResponse {
2979
+ interface UnpinPostResponse {
3038
2980
  /** Post info. */
3039
2981
  post?: Post;
3040
2982
  }
3041
- export interface ListPostsArchiveRequest {
2983
+ interface ListPostsArchiveRequest {
3042
2984
  /**
3043
2985
  * Month
3044
2986
  * @min 1
@@ -3075,7 +3017,7 @@ export interface ListPostsArchiveRequest {
3075
3017
  */
3076
3018
  fieldsets?: PostFieldField[];
3077
3019
  }
3078
- export interface ListPostsArchiveResponse {
3020
+ interface ListPostsArchiveResponse {
3079
3021
  /** List of posts. */
3080
3022
  posts?: Post[];
3081
3023
  /** Details on the paged set of results returned. */
@@ -3083,7 +3025,7 @@ export interface ListPostsArchiveResponse {
3083
3025
  /** Details on the paged set of results returned. */
3084
3026
  pagingMetadata?: PagingMetadataV2;
3085
3027
  }
3086
- export interface BulkGetPostReactionsRequest {
3028
+ interface BulkGetPostReactionsRequest {
3087
3029
  /**
3088
3030
  * Post IDs.
3089
3031
  * @maxSize 500
@@ -3091,18 +3033,18 @@ export interface BulkGetPostReactionsRequest {
3091
3033
  */
3092
3034
  postIds?: string[];
3093
3035
  }
3094
- export interface BulkGetPostReactionsResponse {
3036
+ interface BulkGetPostReactionsResponse {
3095
3037
  /** Map of post.id to reactions */
3096
3038
  reactionsMap?: Record<string, Reactions>;
3097
3039
  }
3098
- export interface Reactions {
3040
+ interface Reactions {
3099
3041
  /**
3100
3042
  * Is post liked by the current user
3101
3043
  * @readonly
3102
3044
  */
3103
3045
  liked?: boolean;
3104
3046
  }
3105
- export interface ListDemoPostsRequest {
3047
+ interface ListDemoPostsRequest {
3106
3048
  /**
3107
3049
  * Whether to return only featured posts.
3108
3050
  *
@@ -3189,35 +3131,35 @@ export interface ListDemoPostsRequest {
3189
3131
  */
3190
3132
  fieldsets?: PostFieldField[];
3191
3133
  }
3192
- export interface ListDemoPostsResponse {
3134
+ interface ListDemoPostsResponse {
3193
3135
  /** List of posts. */
3194
3136
  posts?: Post[];
3195
3137
  /** Details on the paged set of results returned. */
3196
3138
  metaData?: MetaData;
3197
3139
  }
3198
- export interface ConvertDraftJsToRichContentRequest {
3140
+ interface ConvertDraftJsToRichContentRequest {
3199
3141
  /** DraftJs content to convert to Rich content. */
3200
3142
  content?: Record<string, any> | null;
3201
3143
  }
3202
- export interface ConvertDraftJsToRichContentResponse {
3144
+ interface ConvertDraftJsToRichContentResponse {
3203
3145
  /**
3204
3146
  * Rich content converted from DraftJs content.
3205
3147
  * @maxLength 2000000
3206
3148
  */
3207
3149
  richContent?: string;
3208
3150
  }
3209
- export interface ConvertRichContentToDraftJsRequest {
3151
+ interface ConvertRichContentToDraftJsRequest {
3210
3152
  /**
3211
3153
  * Rich content to convert to DraftJs content.
3212
3154
  * @maxLength 2000000
3213
3155
  */
3214
3156
  richContent?: string;
3215
3157
  }
3216
- export interface ConvertRichContentToDraftJsResponse {
3158
+ interface ConvertRichContentToDraftJsResponse {
3217
3159
  /** DraftJs content converted from Rich content. */
3218
3160
  content?: Record<string, any> | null;
3219
3161
  }
3220
- export interface OldBlogMigratedEvent {
3162
+ interface OldBlogMigratedEvent {
3221
3163
  /**
3222
3164
  * Instance id of new version of blog
3223
3165
  * @format GUID
@@ -3229,419 +3171,271 @@ export interface OldBlogMigratedEvent {
3229
3171
  */
3230
3172
  oldBlogInstanceId?: string;
3231
3173
  }
3232
- interface PeriodPostCountNonNullableFields {
3233
- postCount: number;
3234
- }
3235
- export interface QueryPostCountStatsResponseNonNullableFields {
3236
- stats: PeriodPostCountNonNullableFields[];
3237
- }
3238
- export interface GetTotalPostsResponseNonNullableFields {
3239
- total: number;
3240
- }
3241
- interface PageUrlNonNullableFields {
3242
- base: string;
3243
- path: string;
3244
- }
3245
- interface FocalPointNonNullableFields {
3246
- x: number;
3247
- y: number;
3248
- }
3249
- interface ImageNonNullableFields {
3250
- id: string;
3251
- url: string;
3252
- height: number;
3253
- width: number;
3254
- focalPoint?: FocalPointNonNullableFields;
3255
- }
3256
- interface VideoNonNullableFields {
3257
- id: string;
3258
- url: string;
3259
- height: number;
3260
- width: number;
3261
- thumbnail?: ImageNonNullableFields;
3262
- }
3263
- interface CoverMediaNonNullableFields {
3264
- image?: ImageNonNullableFields;
3265
- video?: VideoNonNullableFields;
3266
- enabled: boolean;
3267
- displayed: boolean;
3268
- custom: boolean;
3269
- }
3270
- interface PostCountInfoNonNullableFields {
3271
- comments: number;
3272
- likes: number;
3273
- views: number;
3274
- }
3275
- interface MetricsNonNullableFields {
3276
- comments: number;
3277
- likes: number;
3278
- views: number;
3279
- totalRatings: number;
3280
- averageRating: number;
3281
- }
3282
- interface TagNonNullableFields {
3283
- type: string;
3284
- children: string;
3285
- custom: boolean;
3286
- disabled: boolean;
3287
- }
3288
- interface KeywordNonNullableFields {
3289
- term: string;
3290
- isMain: boolean;
3291
- }
3292
- interface SettingsNonNullableFields {
3293
- preventAutoRedirect: boolean;
3294
- keywords: KeywordNonNullableFields[];
3295
- }
3296
- interface SeoSchemaNonNullableFields {
3297
- tags: TagNonNullableFields[];
3298
- settings?: SettingsNonNullableFields;
3299
- }
3300
- interface PluginContainerDataWidthNonNullableFields {
3301
- size: WidthType;
3302
- }
3303
- interface PluginContainerDataNonNullableFields {
3304
- width?: PluginContainerDataWidthNonNullableFields;
3305
- alignment: PluginContainerDataAlignment;
3306
- }
3307
- interface LinkNonNullableFields {
3308
- url: string;
3309
- anchor: string;
3310
- target: Target;
3311
- }
3312
- interface ButtonDataNonNullableFields {
3313
- containerData?: PluginContainerDataNonNullableFields;
3314
- type: Type;
3315
- link?: LinkNonNullableFields;
3316
- }
3317
- interface TextStyleNonNullableFields {
3318
- textAlignment: TextAlignment;
3319
- }
3320
- interface CodeBlockDataNonNullableFields {
3321
- textStyle?: TextStyleNonNullableFields;
3322
- }
3323
- interface DividerDataNonNullableFields {
3324
- containerData?: PluginContainerDataNonNullableFields;
3325
- lineStyle: LineStyle;
3326
- width: Width;
3327
- alignment: Alignment;
3328
- }
3329
- interface PDFSettingsNonNullableFields {
3330
- viewMode: ViewMode;
3331
- }
3332
- interface FileDataNonNullableFields {
3333
- containerData?: PluginContainerDataNonNullableFields;
3334
- pdfSettings?: PDFSettingsNonNullableFields;
3335
- }
3336
- interface ItemImageNonNullableFields {
3337
- link?: LinkNonNullableFields;
3338
- }
3339
- interface ItemNonNullableFields {
3340
- image?: ItemImageNonNullableFields;
3341
- }
3342
- interface LayoutNonNullableFields {
3343
- type: LayoutType;
3344
- orientation: Orientation;
3345
- }
3346
- interface ItemStyleNonNullableFields {
3347
- crop: Crop;
3348
- }
3349
- interface ThumbnailsNonNullableFields {
3350
- placement: ThumbnailsAlignment;
3351
- }
3352
- interface GalleryOptionsNonNullableFields {
3353
- layout?: LayoutNonNullableFields;
3354
- item?: ItemStyleNonNullableFields;
3355
- thumbnails?: ThumbnailsNonNullableFields;
3356
- }
3357
- interface GalleryDataNonNullableFields {
3358
- containerData?: PluginContainerDataNonNullableFields;
3359
- items: ItemNonNullableFields[];
3360
- options?: GalleryOptionsNonNullableFields;
3361
- }
3362
- interface GIFDataNonNullableFields {
3363
- containerData?: PluginContainerDataNonNullableFields;
3364
- height: number;
3365
- width: number;
3366
- gifType: GIFType;
3367
- }
3368
- interface HeadingDataNonNullableFields {
3369
- level: number;
3370
- textStyle?: TextStyleNonNullableFields;
3371
- }
3372
- interface HTMLDataNonNullableFields {
3373
- url: string;
3374
- html: string;
3375
- containerData?: PluginContainerDataNonNullableFields;
3376
- source: Source;
3377
- }
3378
- interface ImageDataNonNullableFields {
3379
- containerData?: PluginContainerDataNonNullableFields;
3380
- link?: LinkNonNullableFields;
3381
- }
3382
- interface LinkPreviewDataNonNullableFields {
3383
- containerData?: PluginContainerDataNonNullableFields;
3384
- link?: LinkNonNullableFields;
3385
- }
3386
- interface MapSettingsNonNullableFields {
3387
- mapType: MapType;
3388
- }
3389
- interface MapDataNonNullableFields {
3390
- containerData?: PluginContainerDataNonNullableFields;
3391
- mapSettings?: MapSettingsNonNullableFields;
3392
- }
3393
- interface ParagraphDataNonNullableFields {
3394
- textStyle?: TextStyleNonNullableFields;
3395
- }
3396
- interface PermissionsNonNullableFields {
3397
- view: ViewRole;
3398
- vote: VoteRole;
3174
+ interface BaseEventMetadata {
3175
+ /**
3176
+ * App instance ID.
3177
+ * @format GUID
3178
+ */
3179
+ instanceId?: string | null;
3180
+ /**
3181
+ * Event type.
3182
+ * @maxLength 150
3183
+ */
3184
+ eventType?: string;
3185
+ /** The identification type and identity data. */
3186
+ identity?: IdentificationData;
3399
3187
  }
3400
- interface PollSettingsNonNullableFields {
3401
- permissions?: PermissionsNonNullableFields;
3188
+ interface EventMetadata extends BaseEventMetadata {
3189
+ /**
3190
+ * Unique event ID.
3191
+ * Allows clients to ignore duplicate webhooks.
3192
+ */
3193
+ _id?: string;
3194
+ /**
3195
+ * Assumes actions are also always typed to an entity_type
3196
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
3197
+ */
3198
+ entityFqdn?: string;
3199
+ /**
3200
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
3201
+ * This is although the created/updated/deleted notion is duplication of the oneof types
3202
+ * Example: created/updated/deleted/started/completed/email_opened
3203
+ */
3204
+ slug?: string;
3205
+ /** ID of the entity associated with the event. */
3206
+ entityId?: string;
3207
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
3208
+ eventTime?: Date | null;
3209
+ /**
3210
+ * Whether the event was triggered as a result of a privacy regulation application
3211
+ * (for example, GDPR).
3212
+ */
3213
+ triggeredByAnonymizeRequest?: boolean | null;
3214
+ /** If present, indicates the action that triggered the event. */
3215
+ originatedFrom?: string | null;
3216
+ /**
3217
+ * A sequence number defining the order of updates to the underlying entity.
3218
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
3219
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
3220
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
3221
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
3222
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
3223
+ */
3224
+ entityEventSequence?: string | null;
3402
3225
  }
3403
- interface PollNonNullableFields {
3404
- settings?: PollSettingsNonNullableFields;
3226
+ interface PostCreatedEnvelope {
3227
+ entity: Post;
3228
+ metadata: EventMetadata;
3405
3229
  }
3406
- interface PollLayoutNonNullableFields {
3407
- type: PollLayoutType;
3408
- direction: PollLayoutDirection;
3230
+ interface PostDeletedEnvelope {
3231
+ entity: Post;
3232
+ metadata: EventMetadata;
3409
3233
  }
3410
- interface PollDataLayoutNonNullableFields {
3411
- poll?: PollLayoutNonNullableFields;
3234
+ interface PostLikedEnvelope {
3235
+ data: PostLiked;
3236
+ metadata: EventMetadata;
3412
3237
  }
3413
- interface BackgroundNonNullableFields {
3414
- type: BackgroundType;
3238
+ interface PostUnlikedEnvelope {
3239
+ data: PostUnliked;
3240
+ metadata: EventMetadata;
3415
3241
  }
3416
- interface PollDesignNonNullableFields {
3417
- background?: BackgroundNonNullableFields;
3242
+ interface PostUpdatedEnvelope {
3243
+ entity: Post;
3244
+ metadata: EventMetadata;
3418
3245
  }
3419
- interface DesignNonNullableFields {
3420
- poll?: PollDesignNonNullableFields;
3246
+ interface QueryPostCountStatsOptions {
3247
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3248
+ rangeStart?: Date | null;
3249
+ /**
3250
+ * Order of returned results.
3251
+ *
3252
+ * - `OLDEST`: posts by date in ascending order.
3253
+ * - `NEWEST`: posts by date in descending order.
3254
+ *
3255
+ * Default: `OLDEST`
3256
+ */
3257
+ order?: Order;
3258
+ /** Number of months to include in response. */
3259
+ months?: number;
3260
+ /**
3261
+ * Language filter.
3262
+ *
3263
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3264
+ * Pass a language to only receive the period post count for that specified language.
3265
+ * @format LANGUAGE_TAG
3266
+ */
3267
+ language?: string | null;
3268
+ /**
3269
+ * Time zone to use when calculating the start of the month.
3270
+ *
3271
+ * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
3272
+ * @minLength 3
3273
+ * @maxLength 100
3274
+ */
3275
+ timeZone?: string | null;
3421
3276
  }
3422
- interface PollDataNonNullableFields {
3423
- containerData?: PluginContainerDataNonNullableFields;
3424
- poll?: PollNonNullableFields;
3425
- layout?: PollDataLayoutNonNullableFields;
3426
- design?: DesignNonNullableFields;
3277
+ interface GetTotalPostsOptions {
3278
+ /**
3279
+ * Language filter.
3280
+ *
3281
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3282
+ * Pass a language to receive the total amount of posts in that specified language.
3283
+ * @format LANGUAGE_TAG
3284
+ */
3285
+ language?: string | null;
3427
3286
  }
3428
- interface AnchorDataNonNullableFields {
3429
- anchor: string;
3287
+ interface GetPostOptions {
3288
+ /**
3289
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3290
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3291
+ * only the post’s base fields are returned.
3292
+ * @maxSize 20
3293
+ */
3294
+ fieldsets?: PostFieldField[];
3430
3295
  }
3431
- interface LinkDataNonNullableFields {
3432
- link?: LinkNonNullableFields;
3296
+ interface GetPostBySlugOptions {
3297
+ /**
3298
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3299
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3300
+ * only the post’s base fields are returned.
3301
+ * @maxSize 20
3302
+ */
3303
+ fieldsets?: PostFieldField[];
3433
3304
  }
3434
- interface MentionDataNonNullableFields {
3435
- name: string;
3436
- slug: string;
3305
+ interface ListPostsOptions {
3306
+ /**
3307
+ * Whether to return only featured posts.
3308
+ *
3309
+ * Default: `false`
3310
+ */
3311
+ featured?: boolean;
3312
+ /**
3313
+ * Hashtag filter.
3314
+ *
3315
+ * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3316
+ * If omitted, all posts with or without hashtags are returned.
3317
+ * @maxSize 100
3318
+ * @maxLength 100
3319
+ */
3320
+ hashtags?: string[];
3321
+ /**
3322
+ * Category filter.
3323
+ *
3324
+ * Pass an array of category IDs to return only posts with any of the provided categories.
3325
+ * If omitted, all posts with or without associated categories are returned.
3326
+ * @maxSize 50
3327
+ * @maxLength 38
3328
+ */
3329
+ categoryIds?: string[];
3330
+ /**
3331
+ * Tag filter.
3332
+ *
3333
+ * Pass an array of tag IDs to return only posts with any of the provided tags.
3334
+ * If omitted, all posts with or without tags are returned.
3335
+ * @maxSize 50
3336
+ * @maxLength 38
3337
+ */
3338
+ tagIds?: string[];
3339
+ /**
3340
+ * Sorting options.
3341
+ *
3342
+ * Default: `FEED`
3343
+ */
3344
+ sort?: GetPostsSort;
3345
+ /** Pagination options. */
3346
+ paging?: BlogPaging;
3347
+ /**
3348
+ * Language filter.
3349
+ *
3350
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3351
+ * Pass a language to only receive posts that are in that language.
3352
+ * If omitted, posts in all languages are returned.
3353
+ * @format LANGUAGE_TAG
3354
+ */
3355
+ language?: string | null;
3356
+ /**
3357
+ * Post owner's member ID.
3358
+ * @format GUID
3359
+ */
3360
+ memberId?: string | null;
3361
+ /**
3362
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3363
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3364
+ * only the post’s base fields are returned.
3365
+ * @maxSize 20
3366
+ */
3367
+ fieldsets?: PostFieldField[];
3437
3368
  }
3438
- interface FontSizeDataNonNullableFields {
3439
- unit: FontType;
3440
- }
3441
- interface DecorationNonNullableFields {
3442
- anchorData?: AnchorDataNonNullableFields;
3443
- linkData?: LinkDataNonNullableFields;
3444
- mentionData?: MentionDataNonNullableFields;
3445
- fontSizeData?: FontSizeDataNonNullableFields;
3446
- type: DecorationType;
3447
- }
3448
- interface TextDataNonNullableFields {
3449
- text: string;
3450
- decorations: DecorationNonNullableFields[];
3451
- }
3452
- interface AppEmbedDataNonNullableFields {
3453
- type: AppType;
3454
- }
3455
- interface VideoDataNonNullableFields {
3456
- containerData?: PluginContainerDataNonNullableFields;
3457
- }
3458
- interface EmbedDataNonNullableFields {
3459
- containerData?: PluginContainerDataNonNullableFields;
3460
- }
3461
- interface CollapsibleListDataNonNullableFields {
3462
- containerData?: PluginContainerDataNonNullableFields;
3463
- initialExpandedItems: InitialExpandedItems;
3464
- direction: Direction;
3465
- }
3466
- interface DimensionsNonNullableFields {
3467
- colsWidthRatio: number[];
3468
- rowsHeight: number[];
3469
- colsMinWidth: number[];
3470
- }
3471
- interface TableDataNonNullableFields {
3472
- containerData?: PluginContainerDataNonNullableFields;
3473
- dimensions?: DimensionsNonNullableFields;
3474
- }
3475
- interface CellStyleNonNullableFields {
3476
- verticalAlignment: VerticalAlignment;
3477
- }
3478
- interface TableCellDataNonNullableFields {
3479
- cellStyle?: CellStyleNonNullableFields;
3480
- }
3481
- interface AudioDataNonNullableFields {
3482
- containerData?: PluginContainerDataNonNullableFields;
3483
- }
3484
- interface OrderedListDataNonNullableFields {
3485
- indentation: number;
3486
- }
3487
- interface BulletedListDataNonNullableFields {
3488
- indentation: number;
3489
- }
3490
- interface BlockquoteDataNonNullableFields {
3491
- indentation: number;
3492
- }
3493
- interface CaptionDataNonNullableFields {
3494
- textStyle?: TextStyleNonNullableFields;
3495
- }
3496
- interface NodeNonNullableFields {
3497
- buttonData?: ButtonDataNonNullableFields;
3498
- codeBlockData?: CodeBlockDataNonNullableFields;
3499
- dividerData?: DividerDataNonNullableFields;
3500
- fileData?: FileDataNonNullableFields;
3501
- galleryData?: GalleryDataNonNullableFields;
3502
- gifData?: GIFDataNonNullableFields;
3503
- headingData?: HeadingDataNonNullableFields;
3504
- htmlData?: HTMLDataNonNullableFields;
3505
- imageData?: ImageDataNonNullableFields;
3506
- linkPreviewData?: LinkPreviewDataNonNullableFields;
3507
- mapData?: MapDataNonNullableFields;
3508
- paragraphData?: ParagraphDataNonNullableFields;
3509
- pollData?: PollDataNonNullableFields;
3510
- textData?: TextDataNonNullableFields;
3511
- appEmbedData?: AppEmbedDataNonNullableFields;
3512
- videoData?: VideoDataNonNullableFields;
3513
- embedData?: EmbedDataNonNullableFields;
3514
- collapsibleListData?: CollapsibleListDataNonNullableFields;
3515
- tableData?: TableDataNonNullableFields;
3516
- tableCellData?: TableCellDataNonNullableFields;
3517
- audioData?: AudioDataNonNullableFields;
3518
- orderedListData?: OrderedListDataNonNullableFields;
3519
- bulletedListData?: BulletedListDataNonNullableFields;
3520
- blockquoteData?: BlockquoteDataNonNullableFields;
3521
- captionData?: CaptionDataNonNullableFields;
3522
- type: NodeType;
3523
- id: string;
3524
- nodes: NodeNonNullableFields[];
3525
- }
3526
- interface MetadataNonNullableFields {
3527
- version: number;
3528
- }
3529
- interface TextNodeStyleNonNullableFields {
3530
- decorations: DecorationNonNullableFields[];
3531
- }
3532
- interface DocumentStyleNonNullableFields {
3533
- headerOne?: TextNodeStyleNonNullableFields;
3534
- headerTwo?: TextNodeStyleNonNullableFields;
3535
- headerThree?: TextNodeStyleNonNullableFields;
3536
- headerFour?: TextNodeStyleNonNullableFields;
3537
- headerFive?: TextNodeStyleNonNullableFields;
3538
- headerSix?: TextNodeStyleNonNullableFields;
3539
- paragraph?: TextNodeStyleNonNullableFields;
3540
- blockquote?: TextNodeStyleNonNullableFields;
3541
- codeBlock?: TextNodeStyleNonNullableFields;
3542
- }
3543
- interface RichContentNonNullableFields {
3544
- nodes: NodeNonNullableFields[];
3545
- metadata?: MetadataNonNullableFields;
3546
- documentStyle?: DocumentStyleNonNullableFields;
3547
- }
3548
- interface ModerationDetailsNonNullableFields {
3549
- submittedBy: string;
3550
- status: ModerationStatusStatus;
3551
- }
3552
- interface VideoResolutionNonNullableFields {
3553
- url: string;
3554
- height: number;
3555
- width: number;
3556
- poster?: ImageNonNullableFields;
3557
- format: string;
3558
- }
3559
- interface VideoV2NonNullableFields {
3560
- id: string;
3561
- url: string;
3562
- resolutions: VideoResolutionNonNullableFields[];
3563
- posters: ImageNonNullableFields[];
3564
- }
3565
- interface WixMediaNonNullableFields {
3566
- image?: ImageNonNullableFields;
3567
- videoV2?: VideoV2NonNullableFields;
3568
- }
3569
- interface EmbedThumbnailNonNullableFields {
3570
- url: string;
3571
- width: number;
3572
- height: number;
3573
- }
3574
- interface EmbedVideoNonNullableFields {
3575
- url: string;
3576
- width: number;
3577
- height: number;
3578
- }
3579
- interface EmbedMediaNonNullableFields {
3580
- thumbnail?: EmbedThumbnailNonNullableFields;
3581
- video?: EmbedVideoNonNullableFields;
3582
- }
3583
- interface MediaNonNullableFields {
3584
- wixMedia?: WixMediaNonNullableFields;
3585
- embedMedia?: EmbedMediaNonNullableFields;
3586
- displayed: boolean;
3587
- custom: boolean;
3588
- }
3589
- interface PostTranslationNonNullableFields {
3590
- id: string;
3591
- seoData?: SeoSchemaNonNullableFields;
3592
- url?: PageUrlNonNullableFields;
3593
- }
3594
- interface PostNonNullableFields {
3595
- id: string;
3596
- title: string;
3597
- excerpt: string;
3598
- url?: PageUrlNonNullableFields;
3599
- slug: string;
3600
- featured: boolean;
3601
- pinned: boolean;
3602
- categoryIds: string[];
3603
- coverMedia?: CoverMediaNonNullableFields;
3604
- memberId: string;
3605
- hashtags: string[];
3606
- commentingEnabled: boolean;
3607
- postCountInfo?: PostCountInfoNonNullableFields;
3608
- minutesToRead: number;
3609
- heroImage?: ImageNonNullableFields;
3610
- tagIds: string[];
3611
- relatedPostIds: string[];
3612
- pricingPlanIds: string[];
3613
- metrics?: MetricsNonNullableFields;
3614
- seoData?: SeoSchemaNonNullableFields;
3615
- richContent?: RichContentNonNullableFields;
3616
- preview: boolean;
3617
- moderationDetails?: ModerationDetailsNonNullableFields;
3618
- media?: MediaNonNullableFields;
3619
- hasUnpublishedChanges: boolean;
3620
- translations: PostTranslationNonNullableFields[];
3621
- customExcerpt: boolean;
3622
- internalCategoryIds: string[];
3623
- internalRelatedPostIds: string[];
3624
- }
3625
- export interface GetPostResponseNonNullableFields {
3626
- post?: PostNonNullableFields;
3627
- }
3628
- export interface GetPostBySlugResponseNonNullableFields {
3629
- post?: PostNonNullableFields;
3630
- }
3631
- interface MetaDataNonNullableFields {
3632
- count: number;
3633
- offset: number;
3634
- total: number;
3635
- }
3636
- export interface ListPostsResponseNonNullableFields {
3637
- posts: PostNonNullableFields[];
3638
- metaData?: MetaDataNonNullableFields;
3639
- }
3640
- export interface QueryPostsResponseNonNullableFields {
3641
- posts: PostNonNullableFields[];
3642
- metaData?: MetaDataNonNullableFields;
3643
- }
3644
- export interface GetPostMetricsResponseNonNullableFields {
3645
- metrics?: MetricsNonNullableFields;
3646
- }
3647
- export {};
3369
+ interface QueryPostsOptions {
3370
+ /**
3371
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3372
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3373
+ * only the post’s base fields are returned.
3374
+ * @maxSize 20
3375
+ */
3376
+ fieldsets?: PostFieldField[] | undefined;
3377
+ }
3378
+ interface QueryCursorResult {
3379
+ cursors: Cursors;
3380
+ hasNext: () => boolean;
3381
+ hasPrev: () => boolean;
3382
+ length: number;
3383
+ pageSize: number;
3384
+ }
3385
+ interface PostsQueryResult extends QueryCursorResult {
3386
+ items: Post[];
3387
+ query: PostsQueryBuilder;
3388
+ next: () => Promise<PostsQueryResult>;
3389
+ prev: () => Promise<PostsQueryResult>;
3390
+ }
3391
+ interface PostsQueryBuilder {
3392
+ /** @param propertyName - Property whose value is compared with `value`.
3393
+ * @param value - Value to compare against.
3394
+ */
3395
+ eq: (propertyName: '_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'coverMedia.enabled' | 'memberId' | 'commentingEnabled' | 'minutesToRead' | 'translationId' | 'language' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
3396
+ /** @param propertyName - Property whose value is compared with `value`.
3397
+ * @param value - Value to compare against.
3398
+ */
3399
+ ne: (propertyName: '_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'coverMedia.enabled' | 'memberId' | 'commentingEnabled' | 'minutesToRead' | 'translationId' | 'language' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
3400
+ /** @param propertyName - Property whose value is compared with `value`.
3401
+ * @param value - Value to compare against.
3402
+ */
3403
+ ge: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
3404
+ /** @param propertyName - Property whose value is compared with `value`.
3405
+ * @param value - Value to compare against.
3406
+ */
3407
+ gt: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
3408
+ /** @param propertyName - Property whose value is compared with `value`.
3409
+ * @param value - Value to compare against.
3410
+ */
3411
+ le: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
3412
+ /** @param propertyName - Property whose value is compared with `value`.
3413
+ * @param value - Value to compare against.
3414
+ */
3415
+ lt: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
3416
+ /** @param propertyName - Property whose value is compared with `string`.
3417
+ * @param string - String to compare against. Case-insensitive.
3418
+ */
3419
+ startsWith: (propertyName: 'title', value: string) => PostsQueryBuilder;
3420
+ /** @param propertyName - Property whose value is compared with `values`.
3421
+ * @param values - List of values to compare against.
3422
+ */
3423
+ hasSome: (propertyName: '_id' | 'title' | 'slug' | 'categoryIds' | 'memberId' | 'hashtags' | 'tagIds' | 'pricingPlanIds' | 'language', value: any[]) => PostsQueryBuilder;
3424
+ /** @param propertyName - Property whose value is compared with `values`.
3425
+ * @param values - List of values to compare against.
3426
+ */
3427
+ hasAll: (propertyName: 'categoryIds' | 'hashtags' | 'tagIds' | 'pricingPlanIds', value: any[]) => PostsQueryBuilder;
3428
+ in: (propertyName: '_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'translationId' | 'language' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
3429
+ exists: (propertyName: 'title' | 'translationId' | 'language', value: boolean) => PostsQueryBuilder;
3430
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
3431
+ ascending: (...propertyNames: Array<'_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'commentingEnabled' | 'metrics.comments' | 'metrics.likes' | 'metrics.views'>) => PostsQueryBuilder;
3432
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
3433
+ descending: (...propertyNames: Array<'_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'commentingEnabled' | 'metrics.comments' | 'metrics.likes' | 'metrics.views'>) => PostsQueryBuilder;
3434
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
3435
+ limit: (limit: number) => PostsQueryBuilder;
3436
+ /** @param cursor - A pointer to specific record */
3437
+ skipTo: (cursor: string) => PostsQueryBuilder;
3438
+ find: () => Promise<PostsQueryResult>;
3439
+ }
3440
+
3441
+ export { SortOrder as $, Alignment as A, BackgroundType as B, Crop as C, DecorationType as D, ModerationStatusStatus as E, FontType as F, type GetTotalPostsOptions as G, QueryPublicationsCountStatsRequestOrder as H, InitialExpandedItems as I, Order as J, WebhookIdentityType as K, type ListPostsOptions as L, MapType as M, NodeType as N, Orientation as O, type PostsQueryBuilder as P, type QueryPostCountStatsOptions as Q, GetPostTemplatesSort as R, Source as S, Type as T, Origin as U, ViewMode as V, WidthType as W, Status as X, Field as Y, PostFieldField as Z, GetPostsSort as _, type QueryPostCountStatsResponse as a, type Background as a$, type Post as a0, type CoverMedia as a1, type CoverMediaMediaOneOf as a2, type FocalPoint as a3, type PostCountInfo as a4, type Metrics as a5, type SeoSchema as a6, type Keyword as a7, type Tag as a8, type Settings as a9, type Video as aA, type Item as aB, type ItemDataOneOf as aC, type GalleryOptions as aD, type Layout as aE, type ItemStyle as aF, type Thumbnails as aG, type GIFData as aH, type GIF as aI, type HeadingData as aJ, type HTMLData as aK, type HTMLDataDataOneOf as aL, type ImageData as aM, type StylesBorder as aN, type ImageDataStyles as aO, type LinkPreviewData as aP, type LinkPreviewDataStyles as aQ, type MapData as aR, type MapSettings as aS, type ParagraphData as aT, type PollData as aU, type Permissions as aV, type Option as aW, type PollSettings as aX, type PollLayout as aY, type OptionLayout as aZ, type Gradient as a_, type RichContent as aa, type Node as ab, type NodeDataOneOf as ac, type NodeStyle as ad, type ButtonData as ae, type Border as af, type Colors as ag, type PluginContainerData as ah, type PluginContainerDataWidth as ai, type PluginContainerDataWidthDataOneOf as aj, type Spoiler as ak, type Height as al, type Styles as am, type Link as an, type LinkDataOneOf as ao, type Rel as ap, type CodeBlockData as aq, type TextStyle as ar, type DividerData as as, type FileData as at, type FileSource as au, type FileSourceDataOneOf as av, type PDFSettings as aw, type GalleryData as ax, type V1Media as ay, type Image as az, type GetTotalPostsResponse as b, type EntityUpdatedEvent as b$, type BackgroundBackgroundOneOf as b0, type PollDesign as b1, type OptionDesign as b2, type Poll as b3, type PollDataLayout as b4, type Design as b5, type TextData as b6, type Decoration as b7, type DecorationDataOneOf as b8, type AnchorData as b9, type Metadata as bA, type DocumentStyle as bB, type TextNodeStyle as bC, type ModerationDetails as bD, type Media as bE, type MediaMediaOneOf as bF, type WixMedia as bG, type VideoResolution as bH, type EmbedMedia as bI, type EmbedThumbnail as bJ, type EmbedVideo as bK, type PostTranslation as bL, type PostCategoriesUpdated as bM, type PostTagsUpdated as bN, type ScheduledPostPublished as bO, type QueryPublicationsCountStatsRequest as bP, type QueryPublicationsCountStatsResponse as bQ, type PeriodPublicationsCount as bR, type QueryPostCountStatsRequest as bS, type PeriodPostCount as bT, type GetTotalPublicationsRequest as bU, type GetTotalPublicationsResponse as bV, type GetTotalPostsRequest as bW, type DomainEvent as bX, type DomainEventBodyOneOf as bY, type EntityCreatedEvent as bZ, type RestoreInfo as b_, type ColorData as ba, type LinkData as bb, type MentionData as bc, type FontSizeData as bd, type SpoilerData as be, type AppEmbedData as bf, type AppEmbedDataAppDataOneOf as bg, type BookingData as bh, type EventData as bi, type VideoData as bj, type PlaybackOptions as bk, type EmbedData as bl, type Oembed as bm, type CollapsibleListData as bn, type TableData as bo, type Dimensions as bp, type TableCellData as bq, type CellStyle as br, type BorderColors as bs, type ListValue as bt, type AudioData as bu, type OrderedListData as bv, type BulletedListData as bw, type BlockquoteData as bx, type CaptionData as by, type LayoutCellData as bz, type GetPostOptions as c, type OldBlogMigratedEvent as c$, type EntityDeletedEvent as c0, type ActionEvent as c1, type MessageEnvelope as c2, type IdentificationData as c3, type IdentificationDataIdOneOf as c4, type ListTemplatesRequest as c5, type BlogPaging as c6, type ListTemplatesResponse as c7, type MetaData as c8, type Category as c9, type QueryPostsResponse as cA, type PagingMetadataV2 as cB, type Cursors as cC, type GetPostMetricsRequest as cD, type BulkGetPostMetricsRequest as cE, type BulkGetPostMetricsResponse as cF, type ViewPostRequest as cG, type ViewPostResponse as cH, type LikePostRequest as cI, type LikePostResponse as cJ, type UnlikePostRequest as cK, type UnlikePostResponse as cL, type PinPostRequest as cM, type PinPostResponse as cN, type UnpinPostRequest as cO, type UnpinPostResponse as cP, type ListPostsArchiveRequest as cQ, type ListPostsArchiveResponse as cR, type BulkGetPostReactionsRequest as cS, type BulkGetPostReactionsResponse as cT, type Reactions as cU, type ListDemoPostsRequest as cV, type ListDemoPostsResponse as cW, type ConvertDraftJsToRichContentRequest as cX, type ConvertDraftJsToRichContentResponse as cY, type ConvertRichContentToDraftJsRequest as cZ, type ConvertRichContentToDraftJsResponse as c_, type CategoryTranslation as ca, type GetTemplateRequest as cb, type GetTemplateResponse as cc, type CreateDraftPostFromTemplateRequest as cd, type CreateDraftPostFromTemplateResponse as ce, type DraftPost as cf, type DraftPostTranslation as cg, type GetTotalLikesPerMemberRequest as ch, type GetTotalLikesPerMemberResponse as ci, type PostLiked as cj, type PostLikedInitiatorOneOf as ck, type PostUnliked as cl, type PostUnlikedInitiatorOneOf as cm, type PostCountersUpdated as cn, type PostCountersUpdatedInitiatorOneOf as co, type PostOwnerChanged as cp, type InitialPostsCopied as cq, type GetPostRequest as cr, type GetPostBySlugRequest as cs, type ListPostsRequest as ct, type QueryPostsRequest as cu, type Sorting as cv, type PlatformQuery as cw, type PlatformQueryPagingMethodOneOf as cx, type Paging as cy, type CursorPaging as cz, type GetPostResponse as d, type BaseEventMetadata as d0, type EventMetadata as d1, type PostCreatedEnvelope as d2, type PostDeletedEnvelope as d3, type PostLikedEnvelope as d4, type PostUnlikedEnvelope as d5, type PostUpdatedEnvelope as d6, type PostsQueryResult as d7, type GetPostBySlugOptions as e, type GetPostBySlugResponse as f, type ListPostsResponse as g, type QueryPostsOptions as h, type GetPostMetricsResponse as i, PluginContainerDataAlignment as j, Target as k, TextAlignment as l, LineStyle as m, Width as n, LayoutType as o, ThumbnailsAlignment as p, GIFType as q, Position as r, ViewRole as s, VoteRole as t, PollLayoutType as u, PollLayoutDirection as v, AppType as w, Direction as x, VerticalAlignment as y, NullValue as z };