@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
@@ -167,17 +167,11 @@ export interface Post {
167
167
  */
168
168
  referenceId?: string | null;
169
169
  }
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 {
170
+ interface CoverMedia extends CoverMediaMediaOneOf {
177
171
  /** Image url. */
178
- image?: Image;
172
+ image?: string;
179
173
  /** Video url. */
180
- video?: Video;
174
+ video?: string;
181
175
  /**
182
176
  * Is cover media enabled.
183
177
  * Selected by user whether to display cover media on the feed
@@ -199,36 +193,13 @@ export interface CoverMedia extends CoverMediaMediaOneOf {
199
193
  altText?: string | null;
200
194
  }
201
195
  /** @oneof */
202
- export interface CoverMediaMediaOneOf {
196
+ interface CoverMediaMediaOneOf {
203
197
  /** Image url. */
204
- image?: Image;
198
+ image?: string;
205
199
  /** Video url. */
206
- video?: Video;
200
+ video?: string;
207
201
  }
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 {
202
+ interface FocalPoint {
232
203
  /** X-coordinate of the focal point. */
233
204
  x?: number;
234
205
  /** Y-coordinate of the focal point. */
@@ -238,26 +209,7 @@ export interface FocalPoint {
238
209
  /** crop by width */
239
210
  width?: number | null;
240
211
  }
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 {
212
+ interface PostCountInfo {
261
213
  /**
262
214
  * Total number of post comments
263
215
  * @readonly
@@ -274,7 +226,7 @@ export interface PostCountInfo {
274
226
  */
275
227
  views?: number;
276
228
  }
277
- export interface Metrics {
229
+ interface Metrics {
278
230
  /**
279
231
  * Total number of post comments.
280
232
  * @readonly
@@ -296,13 +248,13 @@ export interface Metrics {
296
248
  * The search engines use this information for ranking purposes, or to display snippets in the search results.
297
249
  * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
298
250
  */
299
- export interface SeoSchema {
251
+ interface SeoSchema {
300
252
  /** SEO tag information. */
301
253
  tags?: Tag[];
302
254
  /** SEO general settings. */
303
255
  settings?: Settings;
304
256
  }
305
- export interface Keyword {
257
+ interface Keyword {
306
258
  /** Keyword value. */
307
259
  term?: string;
308
260
  /** Whether the keyword is the main focus keyword. */
@@ -313,7 +265,7 @@ export interface Keyword {
313
265
  */
314
266
  origin?: string | null;
315
267
  }
316
- export interface Tag {
268
+ interface Tag {
317
269
  /**
318
270
  * SEO tag type.
319
271
  *
@@ -335,7 +287,7 @@ export interface Tag {
335
287
  /** Whether the tag is disabled. */
336
288
  disabled?: boolean;
337
289
  }
338
- export interface Settings {
290
+ interface Settings {
339
291
  /**
340
292
  * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
341
293
  *
@@ -349,7 +301,7 @@ export interface Settings {
349
301
  */
350
302
  keywords?: Keyword[];
351
303
  }
352
- export interface RichContent {
304
+ interface RichContent {
353
305
  /** Node objects representing a rich content document. */
354
306
  nodes?: Node[];
355
307
  /** Object metadata. */
@@ -357,7 +309,7 @@ export interface RichContent {
357
309
  /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
358
310
  documentStyle?: DocumentStyle;
359
311
  }
360
- export interface Node extends NodeDataOneOf {
312
+ interface Node extends NodeDataOneOf {
361
313
  /** Data for a button node. */
362
314
  buttonData?: ButtonData;
363
315
  /** Data for a code block node. */
@@ -415,14 +367,14 @@ export interface Node extends NodeDataOneOf {
415
367
  /** 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
368
  type?: NodeType;
417
369
  /** Node ID. */
418
- id?: string;
370
+ _id?: string;
419
371
  /** A list of child nodes. */
420
372
  nodes?: Node[];
421
373
  /** Padding and background color styling for the node. */
422
374
  style?: NodeStyle;
423
375
  }
424
376
  /** @oneof */
425
- export interface NodeDataOneOf {
377
+ interface NodeDataOneOf {
426
378
  /** Data for a button node. */
427
379
  buttonData?: ButtonData;
428
380
  /** Data for a code block node. */
@@ -478,7 +430,7 @@ export interface NodeDataOneOf {
478
430
  /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
479
431
  layoutCellData?: LayoutCellData;
480
432
  }
481
- export declare enum NodeType {
433
+ declare enum NodeType {
482
434
  PARAGRAPH = "PARAGRAPH",
483
435
  TEXT = "TEXT",
484
436
  HEADING = "HEADING",
@@ -514,7 +466,7 @@ export declare enum NodeType {
514
466
  LAYOUT = "LAYOUT",
515
467
  LAYOUT_CELL = "LAYOUT_CELL"
516
468
  }
517
- export interface NodeStyle {
469
+ interface NodeStyle {
518
470
  /** The top padding value in pixels. */
519
471
  paddingTop?: string | null;
520
472
  /** The bottom padding value in pixels. */
@@ -522,7 +474,7 @@ export interface NodeStyle {
522
474
  /** The background color as a hexadecimal value. */
523
475
  backgroundColor?: string | null;
524
476
  }
525
- export interface ButtonData {
477
+ interface ButtonData {
526
478
  /** Styling for the button's container. */
527
479
  containerData?: PluginContainerData;
528
480
  /** The button type. */
@@ -534,13 +486,13 @@ export interface ButtonData {
534
486
  /** Button link details. */
535
487
  link?: Link;
536
488
  }
537
- export interface Border {
489
+ interface Border {
538
490
  /** Border width in pixels. */
539
491
  width?: number | null;
540
492
  /** Border radius in pixels. */
541
493
  radius?: number | null;
542
494
  }
543
- export interface Colors {
495
+ interface Colors {
544
496
  /** The text color as a hexadecimal value. */
545
497
  text?: string | null;
546
498
  /** The border color as a hexadecimal value. */
@@ -548,7 +500,7 @@ export interface Colors {
548
500
  /** The background color as a hexadecimal value. */
549
501
  background?: string | null;
550
502
  }
551
- export interface PluginContainerData {
503
+ interface PluginContainerData {
552
504
  /** The width of the node when it's displayed. */
553
505
  width?: PluginContainerDataWidth;
554
506
  /** The node's alignment within its container. */
@@ -560,7 +512,7 @@ export interface PluginContainerData {
560
512
  /** 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
513
  textWrap?: boolean | null;
562
514
  }
563
- export declare enum WidthType {
515
+ declare enum WidthType {
564
516
  /** Width matches the content width */
565
517
  CONTENT = "CONTENT",
566
518
  /** Small Width */
@@ -570,7 +522,7 @@ export declare enum WidthType {
570
522
  /** coast-to-coast display */
571
523
  FULL_WIDTH = "FULL_WIDTH"
572
524
  }
573
- export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
525
+ interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
574
526
  /**
575
527
  * One of the following predefined width options:
576
528
  * `CONTENT`: The width of the container matches the content width.
@@ -583,7 +535,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
583
535
  custom?: string | null;
584
536
  }
585
537
  /** @oneof */
586
- export interface PluginContainerDataWidthDataOneOf {
538
+ interface PluginContainerDataWidthDataOneOf {
587
539
  /**
588
540
  * One of the following predefined width options:
589
541
  * `CONTENT`: The width of the container matches the content width.
@@ -595,7 +547,7 @@ export interface PluginContainerDataWidthDataOneOf {
595
547
  /** A custom width value in pixels. */
596
548
  custom?: string | null;
597
549
  }
598
- export declare enum PluginContainerDataAlignment {
550
+ declare enum PluginContainerDataAlignment {
599
551
  /** Center Alignment */
600
552
  CENTER = "CENTER",
601
553
  /** Left Alignment */
@@ -603,7 +555,7 @@ export declare enum PluginContainerDataAlignment {
603
555
  /** Right Alignment */
604
556
  RIGHT = "RIGHT"
605
557
  }
606
- export interface Spoiler {
558
+ interface Spoiler {
607
559
  /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
608
560
  enabled?: boolean | null;
609
561
  /** The description displayed on top of the spoiler cover. */
@@ -611,23 +563,23 @@ export interface Spoiler {
611
563
  /** The text for the button used to remove the spoiler cover. */
612
564
  buttonText?: string | null;
613
565
  }
614
- export interface Height {
566
+ interface Height {
615
567
  /** A custom height value in pixels. */
616
568
  custom?: string | null;
617
569
  }
618
- export declare enum Type {
570
+ declare enum Type {
619
571
  /** Regular link button */
620
572
  LINK = "LINK",
621
573
  /** Triggers custom action that is defined in plugin configuration by the consumer */
622
574
  ACTION = "ACTION"
623
575
  }
624
- export interface Styles {
576
+ interface Styles {
625
577
  /** Border attributes. */
626
578
  border?: Border;
627
579
  /** Color attributes. */
628
580
  colors?: Colors;
629
581
  }
630
- export interface Link extends LinkDataOneOf {
582
+ interface Link extends LinkDataOneOf {
631
583
  /** The absolute URL for the linked document. */
632
584
  url?: string;
633
585
  /** The target node's ID. Used for linking to another node in this object. */
@@ -646,13 +598,13 @@ export interface Link extends LinkDataOneOf {
646
598
  customData?: string | null;
647
599
  }
648
600
  /** @oneof */
649
- export interface LinkDataOneOf {
601
+ interface LinkDataOneOf {
650
602
  /** The absolute URL for the linked document. */
651
603
  url?: string;
652
604
  /** The target node's ID. Used for linking to another node in this object. */
653
605
  anchor?: string;
654
606
  }
655
- export declare enum Target {
607
+ declare enum Target {
656
608
  /** Opens the linked document in the same frame as it was clicked (this is default) */
657
609
  SELF = "SELF",
658
610
  /** Opens the linked document in a new window or tab */
@@ -662,7 +614,7 @@ export declare enum Target {
662
614
  /** Opens the linked document in the full body of the window */
663
615
  TOP = "TOP"
664
616
  }
665
- export interface Rel {
617
+ interface Rel {
666
618
  /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
667
619
  nofollow?: boolean | null;
668
620
  /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
@@ -672,17 +624,17 @@ export interface Rel {
672
624
  /** Indicates that this link protect referral information from being passed to the target website. */
673
625
  noreferrer?: boolean | null;
674
626
  }
675
- export interface CodeBlockData {
627
+ interface CodeBlockData {
676
628
  /** Styling for the code block's text. */
677
629
  textStyle?: TextStyle;
678
630
  }
679
- export interface TextStyle {
631
+ interface TextStyle {
680
632
  /** Text alignment. Defaults to `AUTO`. */
681
633
  textAlignment?: TextAlignment;
682
634
  /** 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
635
  lineHeight?: string | null;
684
636
  }
685
- export declare enum TextAlignment {
637
+ declare enum TextAlignment {
686
638
  /** browser default, eqivalent to `initial` */
687
639
  AUTO = "AUTO",
688
640
  /** Left align */
@@ -694,7 +646,7 @@ export declare enum TextAlignment {
694
646
  /** 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
647
  JUSTIFY = "JUSTIFY"
696
648
  }
697
- export interface DividerData {
649
+ interface DividerData {
698
650
  /** Styling for the divider's container. */
699
651
  containerData?: PluginContainerData;
700
652
  /** Divider line style. */
@@ -704,7 +656,7 @@ export interface DividerData {
704
656
  /** Divider alignment. */
705
657
  alignment?: Alignment;
706
658
  }
707
- export declare enum LineStyle {
659
+ declare enum LineStyle {
708
660
  /** Single Line */
709
661
  SINGLE = "SINGLE",
710
662
  /** Double Line */
@@ -714,7 +666,7 @@ export declare enum LineStyle {
714
666
  /** Dotted Line */
715
667
  DOTTED = "DOTTED"
716
668
  }
717
- export declare enum Width {
669
+ declare enum Width {
718
670
  /** Large line */
719
671
  LARGE = "LARGE",
720
672
  /** Medium line */
@@ -722,7 +674,7 @@ export declare enum Width {
722
674
  /** Small line */
723
675
  SMALL = "SMALL"
724
676
  }
725
- export declare enum Alignment {
677
+ declare enum Alignment {
726
678
  /** Center alignment */
727
679
  CENTER = "CENTER",
728
680
  /** Left alignment */
@@ -730,7 +682,7 @@ export declare enum Alignment {
730
682
  /** Right alignment */
731
683
  RIGHT = "RIGHT"
732
684
  }
733
- export interface FileData {
685
+ interface FileData {
734
686
  /** Styling for the file's container. */
735
687
  containerData?: PluginContainerData;
736
688
  /** The source for the file's data. */
@@ -753,7 +705,7 @@ export interface FileData {
753
705
  /** File size in KB. */
754
706
  sizeInKb?: string | null;
755
707
  }
756
- export declare enum ViewMode {
708
+ declare enum ViewMode {
757
709
  /** No PDF view */
758
710
  NONE = "NONE",
759
711
  /** Full PDF view */
@@ -761,7 +713,7 @@ export declare enum ViewMode {
761
713
  /** Mini PDF view */
762
714
  MINI = "MINI"
763
715
  }
764
- export interface FileSource extends FileSourceDataOneOf {
716
+ interface FileSource extends FileSourceDataOneOf {
765
717
  /** The absolute URL for the file's source. */
766
718
  url?: string | null;
767
719
  /**
@@ -770,12 +722,12 @@ export interface FileSource extends FileSourceDataOneOf {
770
722
  */
771
723
  custom?: string | null;
772
724
  /** An ID that's resolved to a URL by a resolver function. */
773
- id?: string | null;
725
+ _id?: string | null;
774
726
  /** Indicates whether the file's source is private. Defaults to `false`. */
775
727
  private?: boolean | null;
776
728
  }
777
729
  /** @oneof */
778
- export interface FileSourceDataOneOf {
730
+ interface FileSourceDataOneOf {
779
731
  /** The absolute URL for the file's source. */
780
732
  url?: string | null;
781
733
  /**
@@ -784,9 +736,9 @@ export interface FileSourceDataOneOf {
784
736
  */
785
737
  custom?: string | null;
786
738
  /** An ID that's resolved to a URL by a resolver function. */
787
- id?: string | null;
739
+ _id?: string | null;
788
740
  }
789
- export interface PDFSettings {
741
+ interface PDFSettings {
790
742
  /**
791
743
  * PDF view mode. One of the following:
792
744
  * `NONE` : The PDF isn't displayed.
@@ -799,7 +751,7 @@ export interface PDFSettings {
799
751
  /** Sets whether the PDF print button is disabled. Defaults to `false`. */
800
752
  disablePrint?: boolean | null;
801
753
  }
802
- export interface GalleryData {
754
+ interface GalleryData {
803
755
  /** Styling for the gallery's container. */
804
756
  containerData?: PluginContainerData;
805
757
  /** The items in the gallery. */
@@ -811,7 +763,7 @@ export interface GalleryData {
811
763
  /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
812
764
  disableDownload?: boolean | null;
813
765
  }
814
- export interface V1Media {
766
+ interface V1Media {
815
767
  /** The source for the media's data. */
816
768
  src?: FileSource;
817
769
  /** Media width in pixels. */
@@ -821,36 +773,36 @@ export interface V1Media {
821
773
  /** Media duration in seconds. Only relevant for audio and video files. */
822
774
  duration?: number | null;
823
775
  }
824
- export interface ItemImage {
776
+ interface Image {
825
777
  /** Image file details. */
826
778
  media?: V1Media;
827
779
  /** Link details for images that are links. */
828
780
  link?: Link;
829
781
  }
830
- export interface ItemVideo {
782
+ interface Video {
831
783
  /** Video file details. */
832
784
  media?: V1Media;
833
785
  /** Video thumbnail file details. */
834
786
  thumbnail?: V1Media;
835
787
  }
836
- export interface Item extends ItemDataOneOf {
788
+ interface Item extends ItemDataOneOf {
837
789
  /** An image item. */
838
- image?: ItemImage;
790
+ image?: Image;
839
791
  /** A video item. */
840
- video?: ItemVideo;
792
+ video?: Video;
841
793
  /** Item title. */
842
794
  title?: string | null;
843
795
  /** Item's alternative text. */
844
796
  altText?: string | null;
845
797
  }
846
798
  /** @oneof */
847
- export interface ItemDataOneOf {
799
+ interface ItemDataOneOf {
848
800
  /** An image item. */
849
- image?: ItemImage;
801
+ image?: Image;
850
802
  /** A video item. */
851
- video?: ItemVideo;
803
+ video?: Video;
852
804
  }
853
- export interface GalleryOptions {
805
+ interface GalleryOptions {
854
806
  /** Gallery layout. */
855
807
  layout?: Layout;
856
808
  /** Styling for gallery items. */
@@ -858,7 +810,7 @@ export interface GalleryOptions {
858
810
  /** Styling for gallery thumbnail images. */
859
811
  thumbnails?: Thumbnails;
860
812
  }
861
- export declare enum LayoutType {
813
+ declare enum LayoutType {
862
814
  /** Collage type */
863
815
  COLLAGE = "COLLAGE",
864
816
  /** Masonry type */
@@ -880,19 +832,19 @@ export declare enum LayoutType {
880
832
  /** Fullsize images type */
881
833
  FULLSIZE = "FULLSIZE"
882
834
  }
883
- export declare enum Orientation {
835
+ declare enum Orientation {
884
836
  /** Rows Orientation */
885
837
  ROWS = "ROWS",
886
838
  /** Columns Orientation */
887
839
  COLUMNS = "COLUMNS"
888
840
  }
889
- export declare enum Crop {
841
+ declare enum Crop {
890
842
  /** Crop to fill */
891
843
  FILL = "FILL",
892
844
  /** Crop to fit */
893
845
  FIT = "FIT"
894
846
  }
895
- export declare enum ThumbnailsAlignment {
847
+ declare enum ThumbnailsAlignment {
896
848
  /** Top alignment */
897
849
  TOP = "TOP",
898
850
  /** Right alignment */
@@ -904,7 +856,7 @@ export declare enum ThumbnailsAlignment {
904
856
  /** No thumbnail */
905
857
  NONE = "NONE"
906
858
  }
907
- export interface Layout {
859
+ interface Layout {
908
860
  /** Gallery layout type. */
909
861
  type?: LayoutType;
910
862
  /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
@@ -916,7 +868,7 @@ export interface Layout {
916
868
  /** The number of columns to display on mobile screens. */
917
869
  mobileNumberOfColumns?: number | null;
918
870
  }
919
- export interface ItemStyle {
871
+ interface ItemStyle {
920
872
  /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
921
873
  targetSize?: number | null;
922
874
  /** Item ratio */
@@ -926,13 +878,13 @@ export interface ItemStyle {
926
878
  /** The spacing between items in pixels. */
927
879
  spacing?: number | null;
928
880
  }
929
- export interface Thumbnails {
881
+ interface Thumbnails {
930
882
  /** Thumbnail alignment. */
931
883
  placement?: ThumbnailsAlignment;
932
884
  /** Spacing between thumbnails in pixels. */
933
885
  spacing?: number | null;
934
886
  }
935
- export interface GIFData {
887
+ interface GIFData {
936
888
  /** Styling for the GIF's container. */
937
889
  containerData?: PluginContainerData;
938
890
  /** The source of the full size GIF. */
@@ -946,7 +898,7 @@ export interface GIFData {
946
898
  /** Type of GIF (Sticker or GIF). Defaults to `GIF`. */
947
899
  gifType?: GIFType;
948
900
  }
949
- export interface GIF {
901
+ interface GIF {
950
902
  /**
951
903
  * GIF format URL.
952
904
  * @format WEB_URL
@@ -963,11 +915,11 @@ export interface GIF {
963
915
  */
964
916
  still?: string | null;
965
917
  }
966
- export declare enum GIFType {
918
+ declare enum GIFType {
967
919
  GIF = "GIF",
968
920
  STICKER = "STICKER"
969
921
  }
970
- export interface HeadingData {
922
+ interface HeadingData {
971
923
  /** Heading level from 1-6. */
972
924
  level?: number;
973
925
  /** Styling for the heading text. */
@@ -975,7 +927,7 @@ export interface HeadingData {
975
927
  /** Indentation level from 1-4. */
976
928
  indentation?: number | null;
977
929
  }
978
- export interface HTMLData extends HTMLDataDataOneOf {
930
+ interface HTMLData extends HTMLDataDataOneOf {
979
931
  /** The URL for the HTML code for the node. */
980
932
  url?: string;
981
933
  /** The HTML code for the node. */
@@ -993,7 +945,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
993
945
  autoHeight?: boolean | null;
994
946
  }
995
947
  /** @oneof */
996
- export interface HTMLDataDataOneOf {
948
+ interface HTMLDataDataOneOf {
997
949
  /** The URL for the HTML code for the node. */
998
950
  url?: string;
999
951
  /** The HTML code for the node. */
@@ -1004,11 +956,11 @@ export interface HTMLDataDataOneOf {
1004
956
  */
1005
957
  isAdsense?: boolean | null;
1006
958
  }
1007
- export declare enum Source {
959
+ declare enum Source {
1008
960
  HTML = "HTML",
1009
961
  ADSENSE = "ADSENSE"
1010
962
  }
1011
- export interface ImageData {
963
+ interface ImageData {
1012
964
  /** Styling for the image's container. */
1013
965
  containerData?: PluginContainerData;
1014
966
  /** Image file details. */
@@ -1027,7 +979,7 @@ export interface ImageData {
1027
979
  /** Sets whether the image's download button is disabled. Defaults to `false`. */
1028
980
  disableDownload?: boolean | null;
1029
981
  }
1030
- export interface StylesBorder {
982
+ interface StylesBorder {
1031
983
  /** Border width in pixels. */
1032
984
  width?: number | null;
1033
985
  /**
@@ -1038,11 +990,11 @@ export interface StylesBorder {
1038
990
  /** Border radius in pixels. */
1039
991
  radius?: number | null;
1040
992
  }
1041
- export interface ImageDataStyles {
993
+ interface ImageDataStyles {
1042
994
  /** Border attributes. */
1043
995
  border?: StylesBorder;
1044
996
  }
1045
- export interface LinkPreviewData {
997
+ interface LinkPreviewData {
1046
998
  /** Styling for the link preview's container. */
1047
999
  containerData?: PluginContainerData;
1048
1000
  /** Link details. */
@@ -1056,7 +1008,7 @@ export interface LinkPreviewData {
1056
1008
  /** The preview content as HTML. */
1057
1009
  html?: string | null;
1058
1010
  }
1059
- export declare enum Position {
1011
+ declare enum Position {
1060
1012
  /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
1061
1013
  START = "START",
1062
1014
  /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
@@ -1066,7 +1018,7 @@ export declare enum Position {
1066
1018
  /** Thumbnail hidden and not displayed */
1067
1019
  HIDDEN = "HIDDEN"
1068
1020
  }
1069
- export interface LinkPreviewDataStyles {
1021
+ interface LinkPreviewDataStyles {
1070
1022
  /**
1071
1023
  * Background color as a hexadecimal value.
1072
1024
  * @format COLOR_HEX
@@ -1099,13 +1051,13 @@ export interface LinkPreviewDataStyles {
1099
1051
  /** Position of thumbnail. Defaults to `START`. */
1100
1052
  thumbnailPosition?: Position;
1101
1053
  }
1102
- export interface MapData {
1054
+ interface MapData {
1103
1055
  /** Styling for the map's container. */
1104
1056
  containerData?: PluginContainerData;
1105
1057
  /** Map settings. */
1106
1058
  mapSettings?: MapSettings;
1107
1059
  }
1108
- export interface MapSettings {
1060
+ interface MapSettings {
1109
1061
  /** The address to display on the map. */
1110
1062
  address?: string | null;
1111
1063
  /** Sets whether the map is draggable. */
@@ -1129,7 +1081,7 @@ export interface MapSettings {
1129
1081
  /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
1130
1082
  mapType?: MapType;
1131
1083
  }
1132
- export declare enum MapType {
1084
+ declare enum MapType {
1133
1085
  /** Roadmap map type */
1134
1086
  ROADMAP = "ROADMAP",
1135
1087
  /** Satellite map type */
@@ -1139,7 +1091,7 @@ export declare enum MapType {
1139
1091
  /** Terrain map type */
1140
1092
  TERRAIN = "TERRAIN"
1141
1093
  }
1142
- export interface ParagraphData {
1094
+ interface ParagraphData {
1143
1095
  /** Styling for the paragraph text. */
1144
1096
  textStyle?: TextStyle;
1145
1097
  /** Indentation level from 1-4. */
@@ -1147,7 +1099,7 @@ export interface ParagraphData {
1147
1099
  /** Paragraph level */
1148
1100
  level?: number | null;
1149
1101
  }
1150
- export interface PollData {
1102
+ interface PollData {
1151
1103
  /** Styling for the poll's container. */
1152
1104
  containerData?: PluginContainerData;
1153
1105
  /** Poll data. */
@@ -1157,7 +1109,7 @@ export interface PollData {
1157
1109
  /** Styling for the poll and voting options. */
1158
1110
  design?: Design;
1159
1111
  }
1160
- export declare enum ViewRole {
1112
+ declare enum ViewRole {
1161
1113
  /** Only Poll creator can view the results */
1162
1114
  CREATOR = "CREATOR",
1163
1115
  /** Anyone who voted can see the results */
@@ -1165,13 +1117,13 @@ export declare enum ViewRole {
1165
1117
  /** Anyone can see the results, even if one didn't vote */
1166
1118
  EVERYONE = "EVERYONE"
1167
1119
  }
1168
- export declare enum VoteRole {
1120
+ declare enum VoteRole {
1169
1121
  /** Logged in member */
1170
1122
  SITE_MEMBERS = "SITE_MEMBERS",
1171
1123
  /** Anyone */
1172
1124
  ALL = "ALL"
1173
1125
  }
1174
- export interface Permissions {
1126
+ interface Permissions {
1175
1127
  /** Sets who can view the poll results. */
1176
1128
  view?: ViewRole;
1177
1129
  /** Sets who can vote. */
@@ -1179,15 +1131,15 @@ export interface Permissions {
1179
1131
  /** Sets whether one voter can vote multiple times. Defaults to `false`. */
1180
1132
  allowMultipleVotes?: boolean | null;
1181
1133
  }
1182
- export interface Option {
1134
+ interface Option {
1183
1135
  /** Option ID. */
1184
- id?: string | null;
1136
+ _id?: string | null;
1185
1137
  /** Option title. */
1186
1138
  title?: string | null;
1187
1139
  /** The image displayed with the option. */
1188
1140
  image?: V1Media;
1189
1141
  }
1190
- export interface PollSettings {
1142
+ interface PollSettings {
1191
1143
  /** Permissions settings for voting. */
1192
1144
  permissions?: Permissions;
1193
1145
  /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
@@ -1195,19 +1147,19 @@ export interface PollSettings {
1195
1147
  /** Sets whether the vote count is displayed. Defaults to `true`. */
1196
1148
  showVotesCount?: boolean | null;
1197
1149
  }
1198
- export declare enum PollLayoutType {
1150
+ declare enum PollLayoutType {
1199
1151
  /** List */
1200
1152
  LIST = "LIST",
1201
1153
  /** Grid */
1202
1154
  GRID = "GRID"
1203
1155
  }
1204
- export declare enum PollLayoutDirection {
1156
+ declare enum PollLayoutDirection {
1205
1157
  /** Left-to-right */
1206
1158
  LTR = "LTR",
1207
1159
  /** Right-to-left */
1208
1160
  RTL = "RTL"
1209
1161
  }
1210
- export interface PollLayout {
1162
+ interface PollLayout {
1211
1163
  /** The layout for displaying the voting options. */
1212
1164
  type?: PollLayoutType;
1213
1165
  /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
@@ -1215,11 +1167,11 @@ export interface PollLayout {
1215
1167
  /** Sets whether to display the main poll image. Defaults to `false`. */
1216
1168
  enableImage?: boolean | null;
1217
1169
  }
1218
- export interface OptionLayout {
1170
+ interface OptionLayout {
1219
1171
  /** Sets whether to display option images. Defaults to `false`. */
1220
1172
  enableImage?: boolean | null;
1221
1173
  }
1222
- export declare enum BackgroundType {
1174
+ declare enum BackgroundType {
1223
1175
  /** Color background type */
1224
1176
  COLOR = "COLOR",
1225
1177
  /** Image background type */
@@ -1227,7 +1179,7 @@ export declare enum BackgroundType {
1227
1179
  /** Gradiant background type */
1228
1180
  GRADIENT = "GRADIENT"
1229
1181
  }
1230
- export interface Gradient {
1182
+ interface Gradient {
1231
1183
  /** The gradient angle in degrees. */
1232
1184
  angle?: number | null;
1233
1185
  /**
@@ -1241,7 +1193,7 @@ export interface Gradient {
1241
1193
  */
1242
1194
  lastColor?: string | null;
1243
1195
  }
1244
- export interface Background extends BackgroundBackgroundOneOf {
1196
+ interface Background extends BackgroundBackgroundOneOf {
1245
1197
  /**
1246
1198
  * The background color as a hexademical value.
1247
1199
  * @format COLOR_HEX
@@ -1255,7 +1207,7 @@ export interface Background extends BackgroundBackgroundOneOf {
1255
1207
  type?: BackgroundType;
1256
1208
  }
1257
1209
  /** @oneof */
1258
- export interface BackgroundBackgroundOneOf {
1210
+ interface BackgroundBackgroundOneOf {
1259
1211
  /**
1260
1212
  * The background color as a hexademical value.
1261
1213
  * @format COLOR_HEX
@@ -1266,19 +1218,19 @@ export interface BackgroundBackgroundOneOf {
1266
1218
  /** Details for a gradient background. */
1267
1219
  gradient?: Gradient;
1268
1220
  }
1269
- export interface PollDesign {
1221
+ interface PollDesign {
1270
1222
  /** Background styling. */
1271
1223
  background?: Background;
1272
1224
  /** Border radius in pixels. */
1273
1225
  borderRadius?: number | null;
1274
1226
  }
1275
- export interface OptionDesign {
1227
+ interface OptionDesign {
1276
1228
  /** Border radius in pixels. */
1277
1229
  borderRadius?: number | null;
1278
1230
  }
1279
- export interface Poll {
1231
+ interface Poll {
1280
1232
  /** Poll ID. */
1281
- id?: string | null;
1233
+ _id?: string | null;
1282
1234
  /** Poll title. */
1283
1235
  title?: string | null;
1284
1236
  /** Poll creator ID. */
@@ -1290,26 +1242,26 @@ export interface Poll {
1290
1242
  /** The poll's permissions and display settings. */
1291
1243
  settings?: PollSettings;
1292
1244
  }
1293
- export interface PollDataLayout {
1245
+ interface PollDataLayout {
1294
1246
  /** Poll layout settings. */
1295
1247
  poll?: PollLayout;
1296
1248
  /** Voting otpions layout settings. */
1297
1249
  options?: OptionLayout;
1298
1250
  }
1299
- export interface Design {
1251
+ interface Design {
1300
1252
  /** Styling for the poll. */
1301
1253
  poll?: PollDesign;
1302
1254
  /** Styling for voting options. */
1303
1255
  options?: OptionDesign;
1304
1256
  }
1305
- export interface TextData {
1257
+ interface TextData {
1306
1258
  /** The text to apply decorations to. */
1307
1259
  text?: string;
1308
1260
  /** The decorations to apply. */
1309
1261
  decorations?: Decoration[];
1310
1262
  }
1311
1263
  /** Adds appearence changes to text */
1312
- export interface Decoration extends DecorationDataOneOf {
1264
+ interface Decoration extends DecorationDataOneOf {
1313
1265
  /** Data for an anchor link decoration. */
1314
1266
  anchorData?: AnchorData;
1315
1267
  /** Data for a color decoration. */
@@ -1332,7 +1284,7 @@ export interface Decoration extends DecorationDataOneOf {
1332
1284
  type?: DecorationType;
1333
1285
  }
1334
1286
  /** @oneof */
1335
- export interface DecorationDataOneOf {
1287
+ interface DecorationDataOneOf {
1336
1288
  /** Data for an anchor link decoration. */
1337
1289
  anchorData?: AnchorData;
1338
1290
  /** Data for a color decoration. */
@@ -1352,7 +1304,7 @@ export interface DecorationDataOneOf {
1352
1304
  /** Data for a spoiler decoration. */
1353
1305
  spoilerData?: SpoilerData;
1354
1306
  }
1355
- export declare enum DecorationType {
1307
+ declare enum DecorationType {
1356
1308
  BOLD = "BOLD",
1357
1309
  ITALIC = "ITALIC",
1358
1310
  UNDERLINE = "UNDERLINE",
@@ -1364,43 +1316,43 @@ export declare enum DecorationType {
1364
1316
  FONT_SIZE = "FONT_SIZE",
1365
1317
  EXTERNAL = "EXTERNAL"
1366
1318
  }
1367
- export interface AnchorData {
1319
+ interface AnchorData {
1368
1320
  /** The target node's ID. */
1369
1321
  anchor?: string;
1370
1322
  }
1371
- export interface ColorData {
1323
+ interface ColorData {
1372
1324
  /** The text's background color as a hexadecimal value. */
1373
1325
  background?: string | null;
1374
1326
  /** The text's foreground color as a hexadecimal value. */
1375
1327
  foreground?: string | null;
1376
1328
  }
1377
- export interface LinkData {
1329
+ interface LinkData {
1378
1330
  /** Link details. */
1379
1331
  link?: Link;
1380
1332
  }
1381
- export interface MentionData {
1333
+ interface MentionData {
1382
1334
  /** The mentioned user's name. */
1383
1335
  name?: string;
1384
1336
  /** The version of the user's name that appears after the `@` character in the mention. */
1385
1337
  slug?: string;
1386
1338
  /** Mentioned user's ID. */
1387
- id?: string | null;
1339
+ _id?: string | null;
1388
1340
  }
1389
- export interface FontSizeData {
1341
+ interface FontSizeData {
1390
1342
  /** The units used for the font size. */
1391
1343
  unit?: FontType;
1392
1344
  /** Font size value. */
1393
1345
  value?: number | null;
1394
1346
  }
1395
- export declare enum FontType {
1347
+ declare enum FontType {
1396
1348
  PX = "PX",
1397
1349
  EM = "EM"
1398
1350
  }
1399
- export interface SpoilerData {
1351
+ interface SpoilerData {
1400
1352
  /** Spoiler ID. */
1401
- id?: string | null;
1353
+ _id?: string | null;
1402
1354
  }
1403
- export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1355
+ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1404
1356
  /** Data for embedded Wix Bookings content. */
1405
1357
  bookingData?: BookingData;
1406
1358
  /** Data for embedded Wix Events content. */
@@ -1422,28 +1374,28 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1422
1374
  image?: V1Media;
1423
1375
  }
1424
1376
  /** @oneof */
1425
- export interface AppEmbedDataAppDataOneOf {
1377
+ interface AppEmbedDataAppDataOneOf {
1426
1378
  /** Data for embedded Wix Bookings content. */
1427
1379
  bookingData?: BookingData;
1428
1380
  /** Data for embedded Wix Events content. */
1429
1381
  eventData?: EventData;
1430
1382
  }
1431
- export declare enum AppType {
1383
+ declare enum AppType {
1432
1384
  PRODUCT = "PRODUCT",
1433
1385
  EVENT = "EVENT",
1434
1386
  BOOKING = "BOOKING"
1435
1387
  }
1436
- export interface BookingData {
1388
+ interface BookingData {
1437
1389
  /** Booking duration in minutes. */
1438
1390
  durations?: string | null;
1439
1391
  }
1440
- export interface EventData {
1392
+ interface EventData {
1441
1393
  /** Event schedule. */
1442
1394
  scheduling?: string | null;
1443
1395
  /** Event location. */
1444
1396
  location?: string | null;
1445
1397
  }
1446
- export interface VideoData {
1398
+ interface VideoData {
1447
1399
  /** Styling for the video's container. */
1448
1400
  containerData?: PluginContainerData;
1449
1401
  /** Video details. */
@@ -1457,7 +1409,7 @@ export interface VideoData {
1457
1409
  /** Video options. */
1458
1410
  options?: PlaybackOptions;
1459
1411
  }
1460
- export interface PlaybackOptions {
1412
+ interface PlaybackOptions {
1461
1413
  /** Sets whether the media will automatically start playing. */
1462
1414
  autoPlay?: boolean | null;
1463
1415
  /** Sets whether media's will be looped. */
@@ -1465,7 +1417,7 @@ export interface PlaybackOptions {
1465
1417
  /** Sets whether media's controls will be shown. */
1466
1418
  showControls?: boolean | null;
1467
1419
  }
1468
- export interface EmbedData {
1420
+ interface EmbedData {
1469
1421
  /** Styling for the oEmbed node's container. */
1470
1422
  containerData?: PluginContainerData;
1471
1423
  /** An [oEmbed](https://www.oembed.com) object. */
@@ -1473,7 +1425,7 @@ export interface EmbedData {
1473
1425
  /** Origin asset source. */
1474
1426
  src?: string | null;
1475
1427
  }
1476
- export interface Oembed {
1428
+ interface Oembed {
1477
1429
  /** The resource type. */
1478
1430
  type?: string | null;
1479
1431
  /** The width of the resource specified in the `url` property in pixels. */
@@ -1505,7 +1457,7 @@ export interface Oembed {
1505
1457
  /** The oEmbed version number. This value must be `1.0`. */
1506
1458
  version?: string | null;
1507
1459
  }
1508
- export interface CollapsibleListData {
1460
+ interface CollapsibleListData {
1509
1461
  /** Styling for the collapsible list's container. */
1510
1462
  containerData?: PluginContainerData;
1511
1463
  /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
@@ -1517,7 +1469,7 @@ export interface CollapsibleListData {
1517
1469
  /** If `true`, The collapsible item will appear in search results as an FAQ. */
1518
1470
  isQapageData?: boolean | null;
1519
1471
  }
1520
- export declare enum InitialExpandedItems {
1472
+ declare enum InitialExpandedItems {
1521
1473
  /** First item will be expended initally */
1522
1474
  FIRST = "FIRST",
1523
1475
  /** All items will expended initally */
@@ -1525,13 +1477,13 @@ export declare enum InitialExpandedItems {
1525
1477
  /** All items collapsed initally */
1526
1478
  NONE = "NONE"
1527
1479
  }
1528
- export declare enum Direction {
1480
+ declare enum Direction {
1529
1481
  /** Left-to-right */
1530
1482
  LTR = "LTR",
1531
1483
  /** Right-to-left */
1532
1484
  RTL = "RTL"
1533
1485
  }
1534
- export interface TableData {
1486
+ interface TableData {
1535
1487
  /** Styling for the table's container. */
1536
1488
  containerData?: PluginContainerData;
1537
1489
  /** The table's dimensions. */
@@ -1546,7 +1498,7 @@ export interface TableData {
1546
1498
  /** Sets whether the table's first column is a header. Defaults to `false`. */
1547
1499
  columnHeader?: boolean | null;
1548
1500
  }
1549
- export interface Dimensions {
1501
+ interface Dimensions {
1550
1502
  /** An array representing relative width of each column in relation to the other columns. */
1551
1503
  colsWidthRatio?: number[];
1552
1504
  /** An array representing the height of each row in pixels. */
@@ -1554,13 +1506,13 @@ export interface Dimensions {
1554
1506
  /** An array representing the minimum width of each column in pixels. */
1555
1507
  colsMinWidth?: number[];
1556
1508
  }
1557
- export interface TableCellData {
1509
+ interface TableCellData {
1558
1510
  /** Styling for the cell's background color and text alignment. */
1559
1511
  cellStyle?: CellStyle;
1560
1512
  /** The cell's border colors. */
1561
1513
  borderColors?: BorderColors;
1562
1514
  }
1563
- export declare enum VerticalAlignment {
1515
+ declare enum VerticalAlignment {
1564
1516
  /** Top alignment */
1565
1517
  TOP = "TOP",
1566
1518
  /** Middle alignment */
@@ -1568,7 +1520,7 @@ export declare enum VerticalAlignment {
1568
1520
  /** Bottom alignment */
1569
1521
  BOTTOM = "BOTTOM"
1570
1522
  }
1571
- export interface CellStyle {
1523
+ interface CellStyle {
1572
1524
  /** Vertical alignment for the cell's text. */
1573
1525
  verticalAlignment?: VerticalAlignment;
1574
1526
  /**
@@ -1577,7 +1529,7 @@ export interface CellStyle {
1577
1529
  */
1578
1530
  backgroundColor?: string | null;
1579
1531
  }
1580
- export interface BorderColors {
1532
+ interface BorderColors {
1581
1533
  /**
1582
1534
  * Left border color as a hexadecimal value.
1583
1535
  * @format COLOR_HEX
@@ -1605,7 +1557,7 @@ export interface BorderColors {
1605
1557
  *
1606
1558
  * The JSON representation for `NullValue` is JSON `null`.
1607
1559
  */
1608
- export declare enum NullValue {
1560
+ declare enum NullValue {
1609
1561
  /** Null value. */
1610
1562
  NULL_VALUE = "NULL_VALUE"
1611
1563
  }
@@ -1614,11 +1566,11 @@ export declare enum NullValue {
1614
1566
  *
1615
1567
  * The JSON representation for `ListValue` is JSON array.
1616
1568
  */
1617
- export interface ListValue {
1569
+ interface ListValue {
1618
1570
  /** Repeated field of dynamically typed values. */
1619
1571
  values?: any[];
1620
1572
  }
1621
- export interface AudioData {
1573
+ interface AudioData {
1622
1574
  /** Styling for the audio node's container. */
1623
1575
  containerData?: PluginContainerData;
1624
1576
  /** Audio file details. */
@@ -1634,7 +1586,7 @@ export interface AudioData {
1634
1586
  /** An HTML version of the audio node. */
1635
1587
  html?: string | null;
1636
1588
  }
1637
- export interface OrderedListData {
1589
+ interface OrderedListData {
1638
1590
  /** Indentation level from 0-4. */
1639
1591
  indentation?: number;
1640
1592
  /** Offset level from 0-4. */
@@ -1642,24 +1594,24 @@ export interface OrderedListData {
1642
1594
  /** List start number. */
1643
1595
  start?: number | null;
1644
1596
  }
1645
- export interface BulletedListData {
1597
+ interface BulletedListData {
1646
1598
  /** Indentation level from 0-4. */
1647
1599
  indentation?: number;
1648
1600
  /** Offset level from 0-4. */
1649
1601
  offset?: number | null;
1650
1602
  }
1651
- export interface BlockquoteData {
1603
+ interface BlockquoteData {
1652
1604
  /** Indentation level from 1-4. */
1653
1605
  indentation?: number;
1654
1606
  }
1655
- export interface CaptionData {
1607
+ interface CaptionData {
1656
1608
  textStyle?: TextStyle;
1657
1609
  }
1658
- export interface LayoutCellData {
1610
+ interface LayoutCellData {
1659
1611
  /** Size of the cell in 12 columns grid. */
1660
1612
  colSpan?: number | null;
1661
1613
  }
1662
- export interface Metadata {
1614
+ interface Metadata {
1663
1615
  /** Schema version. */
1664
1616
  version?: number;
1665
1617
  /**
@@ -1674,9 +1626,9 @@ export interface Metadata {
1674
1626
  */
1675
1627
  updatedTimestamp?: Date | null;
1676
1628
  /** Object ID. */
1677
- id?: string | null;
1629
+ _id?: string | null;
1678
1630
  }
1679
- export interface DocumentStyle {
1631
+ interface DocumentStyle {
1680
1632
  /** Styling for H1 nodes. */
1681
1633
  headerOne?: TextNodeStyle;
1682
1634
  /** Styling for H2 nodes. */
@@ -1696,7 +1648,7 @@ export interface DocumentStyle {
1696
1648
  /** Styling for code block nodes. */
1697
1649
  codeBlock?: TextNodeStyle;
1698
1650
  }
1699
- export interface TextNodeStyle {
1651
+ interface TextNodeStyle {
1700
1652
  /** The decorations to apply to the node. */
1701
1653
  decorations?: Decoration[];
1702
1654
  /** Padding and background color for the node. */
@@ -1704,7 +1656,7 @@ export interface TextNodeStyle {
1704
1656
  /** Line height for text in the node. */
1705
1657
  lineHeight?: string | null;
1706
1658
  }
1707
- export interface ModerationDetails {
1659
+ interface ModerationDetails {
1708
1660
  /**
1709
1661
  * Member ID of the person submitting the draft post for review.
1710
1662
  * @format GUID
@@ -1722,12 +1674,12 @@ export interface ModerationDetails {
1722
1674
  /** Date the post was approved or rejected. */
1723
1675
  moderationDate?: Date | null;
1724
1676
  }
1725
- export declare enum ModerationStatusStatus {
1677
+ declare enum ModerationStatusStatus {
1726
1678
  UNKNOWN = "UNKNOWN",
1727
1679
  APPROVED = "APPROVED",
1728
1680
  REJECTED = "REJECTED"
1729
1681
  }
1730
- export interface Media extends MediaMediaOneOf {
1682
+ interface Media extends MediaMediaOneOf {
1731
1683
  /** Wix Media details. */
1732
1684
  wixMedia?: WixMedia;
1733
1685
  /** Embed media details. */
@@ -1744,34 +1696,19 @@ export interface Media extends MediaMediaOneOf {
1744
1696
  altText?: string | null;
1745
1697
  }
1746
1698
  /** @oneof */
1747
- export interface MediaMediaOneOf {
1699
+ interface MediaMediaOneOf {
1748
1700
  /** Wix Media details. */
1749
1701
  wixMedia?: WixMedia;
1750
1702
  /** Embed media details. */
1751
1703
  embedMedia?: EmbedMedia;
1752
1704
  }
1753
- export interface WixMedia {
1705
+ interface WixMedia {
1754
1706
  /** Image details. */
1755
- image?: Image;
1707
+ image?: string;
1756
1708
  /** 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;
1709
+ videoV2?: string;
1773
1710
  }
1774
- export interface VideoResolution {
1711
+ interface VideoResolution {
1775
1712
  /** Video URL. */
1776
1713
  url?: string;
1777
1714
  /** Video height. */
@@ -1781,13 +1718,13 @@ export interface VideoResolution {
1781
1718
  /** Video format for example, mp4, hls. */
1782
1719
  format?: string;
1783
1720
  }
1784
- export interface EmbedMedia {
1721
+ interface EmbedMedia {
1785
1722
  /** Thumbnail details. */
1786
1723
  thumbnail?: EmbedThumbnail;
1787
1724
  /** Video details. */
1788
1725
  video?: EmbedVideo;
1789
1726
  }
1790
- export interface EmbedThumbnail {
1727
+ interface EmbedThumbnail {
1791
1728
  /**
1792
1729
  * Thumbnail url.
1793
1730
  * @maxLength 2000
@@ -1798,7 +1735,7 @@ export interface EmbedThumbnail {
1798
1735
  /** Thumbnail height. */
1799
1736
  height?: number;
1800
1737
  }
1801
- export interface EmbedVideo {
1738
+ interface EmbedVideo {
1802
1739
  /**
1803
1740
  * Video url.
1804
1741
  * @maxLength 2000
@@ -1809,12 +1746,12 @@ export interface EmbedVideo {
1809
1746
  /** Video height. */
1810
1747
  height?: number;
1811
1748
  }
1812
- export interface PostTranslation {
1749
+ interface PostTranslation {
1813
1750
  /**
1814
1751
  * Post ID.
1815
1752
  * @format GUID
1816
1753
  */
1817
- id?: string;
1754
+ _id?: string;
1818
1755
  /**
1819
1756
  * Language the post is written in.
1820
1757
  * @format LANGUAGE_TAG
@@ -1828,9 +1765,9 @@ export interface PostTranslation {
1828
1765
  /** SEO data. */
1829
1766
  seoData?: SeoSchema;
1830
1767
  /** Post URL. */
1831
- url?: PageUrl;
1768
+ url?: string;
1832
1769
  }
1833
- export interface PostCategoriesUpdated {
1770
+ interface PostCategoriesUpdated {
1834
1771
  /**
1835
1772
  * ID of the post which counters were updated.
1836
1773
  * @format GUID
@@ -1849,7 +1786,7 @@ export interface PostCategoriesUpdated {
1849
1786
  */
1850
1787
  previousCategories?: string[];
1851
1788
  }
1852
- export interface PostTagsUpdated {
1789
+ interface PostTagsUpdated {
1853
1790
  /**
1854
1791
  * ID of the post which counters were updated.
1855
1792
  * @format GUID
@@ -1868,7 +1805,7 @@ export interface PostTagsUpdated {
1868
1805
  */
1869
1806
  previousTags?: string[];
1870
1807
  }
1871
- export interface ScheduledPostPublished {
1808
+ interface ScheduledPostPublished {
1872
1809
  /**
1873
1810
  * ID of the scheduled post which was published.
1874
1811
  * @format GUID
@@ -1876,7 +1813,7 @@ export interface ScheduledPostPublished {
1876
1813
  postId?: string;
1877
1814
  }
1878
1815
  /** Get Blog Publications Count Stats request */
1879
- export interface QueryPublicationsCountStatsRequest {
1816
+ interface QueryPublicationsCountStatsRequest {
1880
1817
  /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
1881
1818
  rangeStart?: Date | null;
1882
1819
  /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
@@ -1899,25 +1836,25 @@ export interface QueryPublicationsCountStatsRequest {
1899
1836
  */
1900
1837
  timeZone?: string | null;
1901
1838
  }
1902
- export declare enum QueryPublicationsCountStatsRequestOrder {
1839
+ declare enum QueryPublicationsCountStatsRequestOrder {
1903
1840
  UNKNOWN = "UNKNOWN",
1904
1841
  OLDEST = "OLDEST",
1905
1842
  NEWEST = "NEWEST"
1906
1843
  }
1907
1844
  /** Get Blog Publications Count Stats response */
1908
- export interface QueryPublicationsCountStatsResponse {
1845
+ interface QueryPublicationsCountStatsResponse {
1909
1846
  /** Chronologically ordered list of publications. */
1910
1847
  stats?: PeriodPublicationsCount[];
1911
1848
  }
1912
1849
  /** Publications count for a specific time period */
1913
- export interface PeriodPublicationsCount {
1850
+ interface PeriodPublicationsCount {
1914
1851
  /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
1915
1852
  periodStart?: Date | null;
1916
1853
  /** Number of posts published during this month. */
1917
1854
  publicationsCount?: number;
1918
1855
  }
1919
1856
  /** Get Blog Post Count Stats request */
1920
- export interface QueryPostCountStatsRequest {
1857
+ interface QueryPostCountStatsRequest {
1921
1858
  /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
1922
1859
  rangeStart?: Date | null;
1923
1860
  /**
@@ -1948,24 +1885,24 @@ export interface QueryPostCountStatsRequest {
1948
1885
  */
1949
1886
  timeZone?: string | null;
1950
1887
  }
1951
- export declare enum Order {
1888
+ declare enum Order {
1952
1889
  UNKNOWN = "UNKNOWN",
1953
1890
  OLDEST = "OLDEST",
1954
1891
  NEWEST = "NEWEST"
1955
1892
  }
1956
1893
  /** Get Blog Post Count Stats response */
1957
- export interface QueryPostCountStatsResponse {
1894
+ interface QueryPostCountStatsResponse {
1958
1895
  /** List of published post counts by month. */
1959
1896
  stats?: PeriodPostCount[];
1960
1897
  }
1961
1898
  /** Post count for a specific time period */
1962
- export interface PeriodPostCount {
1899
+ interface PeriodPostCount {
1963
1900
  /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
1964
1901
  periodStart?: Date | null;
1965
1902
  /** Number of posts published during this month. */
1966
1903
  postCount?: number;
1967
1904
  }
1968
- export interface GetTotalPublicationsRequest {
1905
+ interface GetTotalPublicationsRequest {
1969
1906
  /**
1970
1907
  * Language filter
1971
1908
  * @minLength 2
@@ -1973,11 +1910,11 @@ export interface GetTotalPublicationsRequest {
1973
1910
  */
1974
1911
  language?: string | null;
1975
1912
  }
1976
- export interface GetTotalPublicationsResponse {
1913
+ interface GetTotalPublicationsResponse {
1977
1914
  /** Total amount of publications. */
1978
1915
  total?: number;
1979
1916
  }
1980
- export interface GetTotalPostsRequest {
1917
+ interface GetTotalPostsRequest {
1981
1918
  /**
1982
1919
  * Language filter.
1983
1920
  *
@@ -1987,11 +1924,11 @@ export interface GetTotalPostsRequest {
1987
1924
  */
1988
1925
  language?: string | null;
1989
1926
  }
1990
- export interface GetTotalPostsResponse {
1927
+ interface GetTotalPostsResponse {
1991
1928
  /** Total amount of published posts. */
1992
1929
  total?: number;
1993
1930
  }
1994
- export interface DomainEvent extends DomainEventBodyOneOf {
1931
+ interface DomainEvent extends DomainEventBodyOneOf {
1995
1932
  createdEvent?: EntityCreatedEvent;
1996
1933
  updatedEvent?: EntityUpdatedEvent;
1997
1934
  deletedEvent?: EntityDeletedEvent;
@@ -2000,7 +1937,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
2000
1937
  * Unique event ID.
2001
1938
  * Allows clients to ignore duplicate webhooks.
2002
1939
  */
2003
- id?: string;
1940
+ _id?: string;
2004
1941
  /**
2005
1942
  * Assumes actions are also always typed to an entity_type
2006
1943
  * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
@@ -2034,36 +1971,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
2034
1971
  entityEventSequence?: string | null;
2035
1972
  }
2036
1973
  /** @oneof */
2037
- export interface DomainEventBodyOneOf {
1974
+ interface DomainEventBodyOneOf {
2038
1975
  createdEvent?: EntityCreatedEvent;
2039
1976
  updatedEvent?: EntityUpdatedEvent;
2040
1977
  deletedEvent?: EntityDeletedEvent;
2041
1978
  actionEvent?: ActionEvent;
2042
1979
  }
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;
1980
+ interface EntityCreatedEvent {
1981
+ entity?: string;
2047
1982
  }
2048
- export interface RestoreInfo {
1983
+ interface RestoreInfo {
2049
1984
  deletedDate?: Date | null;
2050
1985
  }
2051
- export interface EntityUpdatedEvent {
1986
+ interface EntityUpdatedEvent {
2052
1987
  /**
2053
1988
  * 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
1989
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2055
1990
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2056
1991
  */
2057
- currentEntityAsJson?: string;
1992
+ currentEntity?: string;
2058
1993
  }
2059
- export interface EntityDeletedEvent {
1994
+ interface EntityDeletedEvent {
2060
1995
  /** Entity that was deleted */
2061
- deletedEntityAsJson?: string | null;
1996
+ deletedEntity?: string | null;
2062
1997
  }
2063
- export interface ActionEvent {
2064
- bodyAsJson?: string;
1998
+ interface ActionEvent {
1999
+ body?: string;
2065
2000
  }
2066
- export interface MessageEnvelope {
2001
+ interface MessageEnvelope {
2067
2002
  /**
2068
2003
  * App instance ID.
2069
2004
  * @format GUID
@@ -2079,7 +2014,7 @@ export interface MessageEnvelope {
2079
2014
  /** Stringify payload. */
2080
2015
  data?: string;
2081
2016
  }
2082
- export interface IdentificationData extends IdentificationDataIdOneOf {
2017
+ interface IdentificationData extends IdentificationDataIdOneOf {
2083
2018
  /**
2084
2019
  * ID of a site visitor that has not logged in to the site.
2085
2020
  * @format GUID
@@ -2104,7 +2039,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
2104
2039
  identityType?: WebhookIdentityType;
2105
2040
  }
2106
2041
  /** @oneof */
2107
- export interface IdentificationDataIdOneOf {
2042
+ interface IdentificationDataIdOneOf {
2108
2043
  /**
2109
2044
  * ID of a site visitor that has not logged in to the site.
2110
2045
  * @format GUID
@@ -2126,14 +2061,14 @@ export interface IdentificationDataIdOneOf {
2126
2061
  */
2127
2062
  appId?: string;
2128
2063
  }
2129
- export declare enum WebhookIdentityType {
2064
+ declare enum WebhookIdentityType {
2130
2065
  UNKNOWN = "UNKNOWN",
2131
2066
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2132
2067
  MEMBER = "MEMBER",
2133
2068
  WIX_USER = "WIX_USER",
2134
2069
  APP = "APP"
2135
2070
  }
2136
- export interface ListTemplatesRequest {
2071
+ interface ListTemplatesRequest {
2137
2072
  /**
2138
2073
  * Filter post templates by given template category ids
2139
2074
  * @maxSize 50
@@ -2152,13 +2087,13 @@ export interface ListTemplatesRequest {
2152
2087
  /** Pagination options. */
2153
2088
  paging?: BlogPaging;
2154
2089
  }
2155
- export declare enum GetPostTemplatesSort {
2090
+ declare enum GetPostTemplatesSort {
2156
2091
  /** Sort by ascending publishing date. */
2157
2092
  PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2158
2093
  /** Sort by descending publishing date. */
2159
2094
  PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2160
2095
  }
2161
- export interface BlogPaging {
2096
+ interface BlogPaging {
2162
2097
  /**
2163
2098
  * Number of items to skip in the current sort order.
2164
2099
  *
@@ -2181,7 +2116,7 @@ export interface BlogPaging {
2181
2116
  */
2182
2117
  cursor?: string | null;
2183
2118
  }
2184
- export interface ListTemplatesResponse {
2119
+ interface ListTemplatesResponse {
2185
2120
  /** Available post templates */
2186
2121
  postTemplates?: Post[];
2187
2122
  /** Details on the paged set of posts templates returned. */
@@ -2189,7 +2124,7 @@ export interface ListTemplatesResponse {
2189
2124
  /** Post template categories. This value is returned empty unless asked explicitly */
2190
2125
  templateCategories?: Category[];
2191
2126
  }
2192
- export interface MetaData {
2127
+ interface MetaData {
2193
2128
  /** Number of items returned in this response. */
2194
2129
  count?: number;
2195
2130
  /** Requested offset. */
@@ -2202,13 +2137,13 @@ export interface MetaData {
2202
2137
  */
2203
2138
  cursor?: string | null;
2204
2139
  }
2205
- export interface Category {
2140
+ interface Category {
2206
2141
  /**
2207
2142
  * Category ID.
2208
2143
  * @immutable
2209
2144
  * @maxLength 38
2210
2145
  */
2211
- id?: string;
2146
+ _id?: string;
2212
2147
  /**
2213
2148
  * Category label. Displayed in the Category Menu.
2214
2149
  * @maxLength 35
@@ -2223,7 +2158,7 @@ export interface Category {
2223
2158
  * The `url` of the page that lists every post with the specified category.
2224
2159
  * @readonly
2225
2160
  */
2226
- url?: PageUrl;
2161
+ url?: string;
2227
2162
  /**
2228
2163
  * Category description.
2229
2164
  * @maxLength 500
@@ -2263,19 +2198,19 @@ export interface Category {
2263
2198
  /** SEO data. */
2264
2199
  seoData?: SeoSchema;
2265
2200
  /** Category cover image. */
2266
- coverImage?: Image;
2201
+ coverImage?: string;
2267
2202
  /**
2268
2203
  * Date and time the Category was last updated.
2269
2204
  * @readonly
2270
2205
  */
2271
- updatedDate?: Date | null;
2206
+ _updatedDate?: Date | null;
2272
2207
  }
2273
- export interface CategoryTranslation {
2208
+ interface CategoryTranslation {
2274
2209
  /**
2275
2210
  * Category ID.
2276
2211
  * @format GUID
2277
2212
  */
2278
- id?: string;
2213
+ _id?: string;
2279
2214
  /**
2280
2215
  * Label displayed in the categories menu on the site.
2281
2216
  * @maxLength 100
@@ -2287,37 +2222,37 @@ export interface CategoryTranslation {
2287
2222
  */
2288
2223
  language?: string | null;
2289
2224
  /** URL of this category page. */
2290
- url?: PageUrl;
2225
+ url?: string;
2291
2226
  }
2292
- export interface GetTemplateRequest {
2227
+ interface GetTemplateRequest {
2293
2228
  /**
2294
2229
  * Post template id
2295
2230
  * @format GUID
2296
2231
  */
2297
2232
  postTemplateId?: string;
2298
2233
  }
2299
- export interface GetTemplateResponse {
2234
+ interface GetTemplateResponse {
2300
2235
  /** Post template */
2301
2236
  postTemplate?: Post;
2302
2237
  }
2303
- export interface CreateDraftPostFromTemplateRequest {
2238
+ interface CreateDraftPostFromTemplateRequest {
2304
2239
  /**
2305
2240
  * Post template id
2306
2241
  * @format GUID
2307
2242
  */
2308
2243
  postTemplateId?: string;
2309
2244
  }
2310
- export interface CreateDraftPostFromTemplateResponse {
2245
+ interface CreateDraftPostFromTemplateResponse {
2311
2246
  /** Created draft post */
2312
2247
  draftPost?: DraftPost;
2313
2248
  }
2314
- export interface DraftPost {
2249
+ interface DraftPost {
2315
2250
  /**
2316
2251
  * Draft post ID.
2317
2252
  * @readonly
2318
2253
  * @maxLength 38
2319
2254
  */
2320
- id?: string;
2255
+ _id?: string;
2321
2256
  /**
2322
2257
  * Draft post title.
2323
2258
  * @maxLength 200
@@ -2358,7 +2293,7 @@ export interface DraftPost {
2358
2293
  */
2359
2294
  minutesToRead?: number;
2360
2295
  /** Image placed at the top of the blog page. */
2361
- heroImage?: Image;
2296
+ heroImage?: string;
2362
2297
  /**
2363
2298
  * Tag IDs the draft post is tagged with.
2364
2299
  * @maxSize 30
@@ -2430,12 +2365,12 @@ export interface DraftPost {
2430
2365
  * Draft post URL preview. What the URL will look like once the post is published.
2431
2366
  * @readonly
2432
2367
  */
2433
- url?: PageUrl;
2368
+ url?: string;
2434
2369
  /**
2435
2370
  * Date the draft post was first created.
2436
2371
  * @readonly
2437
2372
  */
2438
- createdDate?: Date | null;
2373
+ _createdDate?: Date | null;
2439
2374
  /**
2440
2375
  * SEO slug.
2441
2376
  * @maxLength 100
@@ -2446,7 +2381,7 @@ export interface DraftPost {
2446
2381
  /** Number of paragraphs to display in a paid content preview for non-paying users. */
2447
2382
  previewTextParagraph?: number | null;
2448
2383
  }
2449
- export declare enum Origin {
2384
+ declare enum Origin {
2450
2385
  UNKNOWN = "UNKNOWN",
2451
2386
  /** Changed by admin */
2452
2387
  ADMIN = "ADMIN",
@@ -2519,7 +2454,7 @@ export declare enum Origin {
2519
2454
  /** Saved automatically by AI tool. */
2520
2455
  AI_AUTO_SAVE = "AI_AUTO_SAVE"
2521
2456
  }
2522
- export declare enum Status {
2457
+ declare enum Status {
2523
2458
  UNKNOWN = "UNKNOWN",
2524
2459
  /** Status indicating the draft post is published. */
2525
2460
  PUBLISHED = "PUBLISHED",
@@ -2532,12 +2467,12 @@ export declare enum Status {
2532
2467
  /** Status indicating the draft post is in review. */
2533
2468
  IN_REVIEW = "IN_REVIEW"
2534
2469
  }
2535
- export interface DraftPostTranslation {
2470
+ interface DraftPostTranslation {
2536
2471
  /**
2537
2472
  * Post ID.
2538
2473
  * @format GUID
2539
2474
  */
2540
- id?: string;
2475
+ _id?: string;
2541
2476
  /** Post status. */
2542
2477
  status?: Status;
2543
2478
  /**
@@ -2553,20 +2488,20 @@ export interface DraftPostTranslation {
2553
2488
  /** SEO data. */
2554
2489
  seoData?: SeoSchema;
2555
2490
  /** Post URL. */
2556
- url?: PageUrl;
2491
+ url?: string;
2557
2492
  }
2558
- export interface GetTotalLikesPerMemberRequest {
2493
+ interface GetTotalLikesPerMemberRequest {
2559
2494
  /**
2560
2495
  * Member ID.
2561
2496
  * @format GUID
2562
2497
  */
2563
2498
  memberId?: string;
2564
2499
  }
2565
- export interface GetTotalLikesPerMemberResponse {
2500
+ interface GetTotalLikesPerMemberResponse {
2566
2501
  /** The total number of likes of the member. */
2567
2502
  total?: number;
2568
2503
  }
2569
- export interface PostLiked extends PostLikedInitiatorOneOf {
2504
+ interface PostLiked extends PostLikedInitiatorOneOf {
2570
2505
  /**
2571
2506
  * Member ID of person who liked the post (only returned when the member was logged in when liking the post).
2572
2507
  * @format GUID
@@ -2584,7 +2519,7 @@ export interface PostLiked extends PostLikedInitiatorOneOf {
2584
2519
  postId?: string;
2585
2520
  }
2586
2521
  /** @oneof */
2587
- export interface PostLikedInitiatorOneOf {
2522
+ interface PostLikedInitiatorOneOf {
2588
2523
  /**
2589
2524
  * Member ID of person who liked the post (only returned when the member was logged in when liking the post).
2590
2525
  * @format GUID
@@ -2596,7 +2531,7 @@ export interface PostLikedInitiatorOneOf {
2596
2531
  */
2597
2532
  anonymousVisitorId?: string | null;
2598
2533
  }
2599
- export interface PostUnliked extends PostUnlikedInitiatorOneOf {
2534
+ interface PostUnliked extends PostUnlikedInitiatorOneOf {
2600
2535
  /**
2601
2536
  * Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
2602
2537
  * @format GUID
@@ -2614,7 +2549,7 @@ export interface PostUnliked extends PostUnlikedInitiatorOneOf {
2614
2549
  postId?: string;
2615
2550
  }
2616
2551
  /** @oneof */
2617
- export interface PostUnlikedInitiatorOneOf {
2552
+ interface PostUnlikedInitiatorOneOf {
2618
2553
  /**
2619
2554
  * Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
2620
2555
  * @format GUID
@@ -2626,7 +2561,7 @@ export interface PostUnlikedInitiatorOneOf {
2626
2561
  */
2627
2562
  anonymousVisitorId?: string | null;
2628
2563
  }
2629
- export interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
2564
+ interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
2630
2565
  /**
2631
2566
  * Member ID of person who triggered the counter update
2632
2567
  * @format GUID
@@ -2648,7 +2583,7 @@ export interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
2648
2583
  counter?: number;
2649
2584
  }
2650
2585
  /** @oneof */
2651
- export interface PostCountersUpdatedInitiatorOneOf {
2586
+ interface PostCountersUpdatedInitiatorOneOf {
2652
2587
  /**
2653
2588
  * Member ID of person who triggered the counter update
2654
2589
  * @format GUID
@@ -2660,7 +2595,7 @@ export interface PostCountersUpdatedInitiatorOneOf {
2660
2595
  */
2661
2596
  anonymousVisitorId?: string | null;
2662
2597
  }
2663
- export declare enum Field {
2598
+ declare enum Field {
2664
2599
  /** Undefined field. */
2665
2600
  UNKNOWN = "UNKNOWN",
2666
2601
  /** Total comments field. */
@@ -2672,13 +2607,13 @@ export declare enum Field {
2672
2607
  /** Rating count field. */
2673
2608
  RATING_COUNT = "RATING_COUNT"
2674
2609
  }
2675
- export interface PostOwnerChanged {
2610
+ interface PostOwnerChanged {
2676
2611
  }
2677
- export interface InitialPostsCopied {
2612
+ interface InitialPostsCopied {
2678
2613
  /** Number of posts copied. */
2679
2614
  count?: number;
2680
2615
  }
2681
- export interface GetPostRequest {
2616
+ interface GetPostRequest {
2682
2617
  /**
2683
2618
  * Post ID.
2684
2619
  * @minLength 1
@@ -2693,7 +2628,7 @@ export interface GetPostRequest {
2693
2628
  */
2694
2629
  fieldsets?: PostFieldField[];
2695
2630
  }
2696
- export declare enum PostFieldField {
2631
+ declare enum PostFieldField {
2697
2632
  UNKNOWN = "UNKNOWN",
2698
2633
  /** Includes post URL when present. */
2699
2634
  URL = "URL",
@@ -2710,11 +2645,11 @@ export declare enum PostFieldField {
2710
2645
  /** Includes post reference ID field. */
2711
2646
  REFERENCE_ID = "REFERENCE_ID"
2712
2647
  }
2713
- export interface GetPostResponse {
2648
+ interface GetPostResponse {
2714
2649
  /** Retrieved post info. */
2715
2650
  post?: Post;
2716
2651
  }
2717
- export interface GetPostBySlugRequest {
2652
+ interface GetPostBySlugRequest {
2718
2653
  /**
2719
2654
  * Slug of the post to retrieve.
2720
2655
  * @minLength 1
@@ -2729,11 +2664,11 @@ export interface GetPostBySlugRequest {
2729
2664
  */
2730
2665
  fieldsets?: PostFieldField[];
2731
2666
  }
2732
- export interface GetPostBySlugResponse {
2667
+ interface GetPostBySlugResponse {
2733
2668
  /** Retrieved post info. */
2734
2669
  post?: Post;
2735
2670
  }
2736
- export interface ListPostsRequest {
2671
+ interface ListPostsRequest {
2737
2672
  /**
2738
2673
  * Whether to return only featured posts.
2739
2674
  *
@@ -2797,7 +2732,7 @@ export interface ListPostsRequest {
2797
2732
  */
2798
2733
  fieldsets?: PostFieldField[];
2799
2734
  }
2800
- export declare enum GetPostsSort {
2735
+ declare enum GetPostsSort {
2801
2736
  /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
2802
2737
  FEED = "FEED",
2803
2738
  /** Ordered by `firstPublishedDate` in ascending order. */
@@ -2813,13 +2748,13 @@ export declare enum GetPostsSort {
2813
2748
  /** Ordered by `title` in descending order. */
2814
2749
  TITLE_DESC = "TITLE_DESC"
2815
2750
  }
2816
- export interface ListPostsResponse {
2751
+ interface ListPostsResponse {
2817
2752
  /** List of retrieved posts. */
2818
2753
  posts?: Post[];
2819
2754
  /** Details on the paged set of results returned. */
2820
2755
  metaData?: MetaData;
2821
2756
  }
2822
- export interface QueryPostsRequest {
2757
+ interface QueryPostsRequest {
2823
2758
  /** Query options. */
2824
2759
  query?: PlatformQuery;
2825
2760
  /**
@@ -2830,7 +2765,7 @@ export interface QueryPostsRequest {
2830
2765
  */
2831
2766
  fieldsets?: PostFieldField[];
2832
2767
  }
2833
- export interface Sorting {
2768
+ interface Sorting {
2834
2769
  /**
2835
2770
  * Name of the field to sort by.
2836
2771
  * @maxLength 512
@@ -2839,11 +2774,11 @@ export interface Sorting {
2839
2774
  /** Sort order. */
2840
2775
  order?: SortOrder;
2841
2776
  }
2842
- export declare enum SortOrder {
2777
+ declare enum SortOrder {
2843
2778
  ASC = "ASC",
2844
2779
  DESC = "DESC"
2845
2780
  }
2846
- export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
2781
+ interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
2847
2782
  /** Paging options to limit and skip the number of items. */
2848
2783
  paging?: Paging;
2849
2784
  /** 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 +2800,13 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
2865
2800
  sort?: Sorting[];
2866
2801
  }
2867
2802
  /** @oneof */
2868
- export interface PlatformQueryPagingMethodOneOf {
2803
+ interface PlatformQueryPagingMethodOneOf {
2869
2804
  /** Paging options to limit and skip the number of items. */
2870
2805
  paging?: Paging;
2871
2806
  /** 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
2807
  cursorPaging?: CursorPaging;
2873
2808
  }
2874
- export interface Paging {
2809
+ interface Paging {
2875
2810
  /**
2876
2811
  * Number of items to load.
2877
2812
  * @max 100
@@ -2880,7 +2815,7 @@ export interface Paging {
2880
2815
  /** Number of items to skip in the current sort order. */
2881
2816
  offset?: number | null;
2882
2817
  }
2883
- export interface CursorPaging {
2818
+ interface CursorPaging {
2884
2819
  /**
2885
2820
  * Number of items to load.
2886
2821
  * @max 100
@@ -2896,13 +2831,13 @@ export interface CursorPaging {
2896
2831
  */
2897
2832
  cursor?: string | null;
2898
2833
  }
2899
- export interface QueryPostsResponse {
2834
+ interface QueryPostsResponse {
2900
2835
  /** List of retrieved posts. */
2901
2836
  posts?: Post[];
2902
2837
  /** Details on the paged set of results returned. */
2903
2838
  pagingMetadata?: PagingMetadataV2;
2904
2839
  }
2905
- export interface PagingMetadataV2 {
2840
+ interface PagingMetadataV2 {
2906
2841
  /** Number of items returned in the response. */
2907
2842
  count?: number | null;
2908
2843
  /** Offset that was requested. */
@@ -2914,7 +2849,7 @@ export interface PagingMetadataV2 {
2914
2849
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
2915
2850
  cursors?: Cursors;
2916
2851
  }
2917
- export interface Cursors {
2852
+ interface Cursors {
2918
2853
  /**
2919
2854
  * Cursor pointing to next page in the list of results.
2920
2855
  * @maxLength 2000
@@ -2926,7 +2861,7 @@ export interface Cursors {
2926
2861
  */
2927
2862
  prev?: string | null;
2928
2863
  }
2929
- export interface GetPostMetricsRequest {
2864
+ interface GetPostMetricsRequest {
2930
2865
  /**
2931
2866
  * Post ID to retrieve metrics for.
2932
2867
  * @minLength 1
@@ -2934,11 +2869,11 @@ export interface GetPostMetricsRequest {
2934
2869
  */
2935
2870
  postId: string;
2936
2871
  }
2937
- export interface GetPostMetricsResponse {
2872
+ interface GetPostMetricsResponse {
2938
2873
  /** Retrieved post metrics. */
2939
2874
  metrics?: Metrics;
2940
2875
  }
2941
- export interface BulkGetPostMetricsRequest {
2876
+ interface BulkGetPostMetricsRequest {
2942
2877
  /**
2943
2878
  * Post IDs.
2944
2879
  * @maxSize 500
@@ -2946,11 +2881,11 @@ export interface BulkGetPostMetricsRequest {
2946
2881
  */
2947
2882
  postIds?: string[];
2948
2883
  }
2949
- export interface BulkGetPostMetricsResponse {
2884
+ interface BulkGetPostMetricsResponse {
2950
2885
  /** Map of post.id to metrics */
2951
2886
  metrics?: Record<string, Metrics>;
2952
2887
  }
2953
- export interface ViewPostRequest {
2888
+ interface ViewPostRequest {
2954
2889
  /**
2955
2890
  * Post ID.
2956
2891
  * @minLength 1
@@ -2958,11 +2893,11 @@ export interface ViewPostRequest {
2958
2893
  */
2959
2894
  postId?: string;
2960
2895
  }
2961
- export interface ViewPostResponse {
2896
+ interface ViewPostResponse {
2962
2897
  /** Total number of post views */
2963
2898
  views?: number;
2964
2899
  }
2965
- export interface LikePostRequest {
2900
+ interface LikePostRequest {
2966
2901
  /**
2967
2902
  * Post ID.
2968
2903
  * @minLength 1
@@ -2977,11 +2912,11 @@ export interface LikePostRequest {
2977
2912
  */
2978
2913
  fieldsets?: PostFieldField[];
2979
2914
  }
2980
- export interface LikePostResponse {
2915
+ interface LikePostResponse {
2981
2916
  /** Post info. */
2982
2917
  post?: Post;
2983
2918
  }
2984
- export interface UnlikePostRequest {
2919
+ interface UnlikePostRequest {
2985
2920
  /**
2986
2921
  * Post ID.
2987
2922
  * @minLength 1
@@ -2996,11 +2931,11 @@ export interface UnlikePostRequest {
2996
2931
  */
2997
2932
  fieldsets?: PostFieldField[];
2998
2933
  }
2999
- export interface UnlikePostResponse {
2934
+ interface UnlikePostResponse {
3000
2935
  /** Post info. */
3001
2936
  post?: Post;
3002
2937
  }
3003
- export interface PinPostRequest {
2938
+ interface PinPostRequest {
3004
2939
  /**
3005
2940
  * Post ID.
3006
2941
  * @minLength 1
@@ -3015,11 +2950,11 @@ export interface PinPostRequest {
3015
2950
  */
3016
2951
  fieldsets?: PostFieldField[];
3017
2952
  }
3018
- export interface PinPostResponse {
2953
+ interface PinPostResponse {
3019
2954
  /** Post info. */
3020
2955
  post?: Post;
3021
2956
  }
3022
- export interface UnpinPostRequest {
2957
+ interface UnpinPostRequest {
3023
2958
  /**
3024
2959
  * Post ID.
3025
2960
  * @minLength 1
@@ -3034,11 +2969,11 @@ export interface UnpinPostRequest {
3034
2969
  */
3035
2970
  fieldsets?: PostFieldField[];
3036
2971
  }
3037
- export interface UnpinPostResponse {
2972
+ interface UnpinPostResponse {
3038
2973
  /** Post info. */
3039
2974
  post?: Post;
3040
2975
  }
3041
- export interface ListPostsArchiveRequest {
2976
+ interface ListPostsArchiveRequest {
3042
2977
  /**
3043
2978
  * Month
3044
2979
  * @min 1
@@ -3075,7 +3010,7 @@ export interface ListPostsArchiveRequest {
3075
3010
  */
3076
3011
  fieldsets?: PostFieldField[];
3077
3012
  }
3078
- export interface ListPostsArchiveResponse {
3013
+ interface ListPostsArchiveResponse {
3079
3014
  /** List of posts. */
3080
3015
  posts?: Post[];
3081
3016
  /** Details on the paged set of results returned. */
@@ -3083,7 +3018,7 @@ export interface ListPostsArchiveResponse {
3083
3018
  /** Details on the paged set of results returned. */
3084
3019
  pagingMetadata?: PagingMetadataV2;
3085
3020
  }
3086
- export interface BulkGetPostReactionsRequest {
3021
+ interface BulkGetPostReactionsRequest {
3087
3022
  /**
3088
3023
  * Post IDs.
3089
3024
  * @maxSize 500
@@ -3091,18 +3026,18 @@ export interface BulkGetPostReactionsRequest {
3091
3026
  */
3092
3027
  postIds?: string[];
3093
3028
  }
3094
- export interface BulkGetPostReactionsResponse {
3029
+ interface BulkGetPostReactionsResponse {
3095
3030
  /** Map of post.id to reactions */
3096
3031
  reactionsMap?: Record<string, Reactions>;
3097
3032
  }
3098
- export interface Reactions {
3033
+ interface Reactions {
3099
3034
  /**
3100
3035
  * Is post liked by the current user
3101
3036
  * @readonly
3102
3037
  */
3103
3038
  liked?: boolean;
3104
3039
  }
3105
- export interface ListDemoPostsRequest {
3040
+ interface ListDemoPostsRequest {
3106
3041
  /**
3107
3042
  * Whether to return only featured posts.
3108
3043
  *
@@ -3189,35 +3124,35 @@ export interface ListDemoPostsRequest {
3189
3124
  */
3190
3125
  fieldsets?: PostFieldField[];
3191
3126
  }
3192
- export interface ListDemoPostsResponse {
3127
+ interface ListDemoPostsResponse {
3193
3128
  /** List of posts. */
3194
3129
  posts?: Post[];
3195
3130
  /** Details on the paged set of results returned. */
3196
3131
  metaData?: MetaData;
3197
3132
  }
3198
- export interface ConvertDraftJsToRichContentRequest {
3133
+ interface ConvertDraftJsToRichContentRequest {
3199
3134
  /** DraftJs content to convert to Rich content. */
3200
3135
  content?: Record<string, any> | null;
3201
3136
  }
3202
- export interface ConvertDraftJsToRichContentResponse {
3137
+ interface ConvertDraftJsToRichContentResponse {
3203
3138
  /**
3204
3139
  * Rich content converted from DraftJs content.
3205
3140
  * @maxLength 2000000
3206
3141
  */
3207
3142
  richContent?: string;
3208
3143
  }
3209
- export interface ConvertRichContentToDraftJsRequest {
3144
+ interface ConvertRichContentToDraftJsRequest {
3210
3145
  /**
3211
3146
  * Rich content to convert to DraftJs content.
3212
3147
  * @maxLength 2000000
3213
3148
  */
3214
3149
  richContent?: string;
3215
3150
  }
3216
- export interface ConvertRichContentToDraftJsResponse {
3151
+ interface ConvertRichContentToDraftJsResponse {
3217
3152
  /** DraftJs content converted from Rich content. */
3218
3153
  content?: Record<string, any> | null;
3219
3154
  }
3220
- export interface OldBlogMigratedEvent {
3155
+ interface OldBlogMigratedEvent {
3221
3156
  /**
3222
3157
  * Instance id of new version of blog
3223
3158
  * @format GUID
@@ -3229,419 +3164,271 @@ export interface OldBlogMigratedEvent {
3229
3164
  */
3230
3165
  oldBlogInstanceId?: string;
3231
3166
  }
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;
3167
+ interface BaseEventMetadata {
3168
+ /**
3169
+ * App instance ID.
3170
+ * @format GUID
3171
+ */
3172
+ instanceId?: string | null;
3173
+ /**
3174
+ * Event type.
3175
+ * @maxLength 150
3176
+ */
3177
+ eventType?: string;
3178
+ /** The identification type and identity data. */
3179
+ identity?: IdentificationData;
3399
3180
  }
3400
- interface PollSettingsNonNullableFields {
3401
- permissions?: PermissionsNonNullableFields;
3181
+ interface EventMetadata extends BaseEventMetadata {
3182
+ /**
3183
+ * Unique event ID.
3184
+ * Allows clients to ignore duplicate webhooks.
3185
+ */
3186
+ _id?: string;
3187
+ /**
3188
+ * Assumes actions are also always typed to an entity_type
3189
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
3190
+ */
3191
+ entityFqdn?: string;
3192
+ /**
3193
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
3194
+ * This is although the created/updated/deleted notion is duplication of the oneof types
3195
+ * Example: created/updated/deleted/started/completed/email_opened
3196
+ */
3197
+ slug?: string;
3198
+ /** ID of the entity associated with the event. */
3199
+ entityId?: string;
3200
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
3201
+ eventTime?: Date | null;
3202
+ /**
3203
+ * Whether the event was triggered as a result of a privacy regulation application
3204
+ * (for example, GDPR).
3205
+ */
3206
+ triggeredByAnonymizeRequest?: boolean | null;
3207
+ /** If present, indicates the action that triggered the event. */
3208
+ originatedFrom?: string | null;
3209
+ /**
3210
+ * A sequence number defining the order of updates to the underlying entity.
3211
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
3212
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
3213
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
3214
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
3215
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
3216
+ */
3217
+ entityEventSequence?: string | null;
3402
3218
  }
3403
- interface PollNonNullableFields {
3404
- settings?: PollSettingsNonNullableFields;
3219
+ interface PostCreatedEnvelope {
3220
+ entity: Post;
3221
+ metadata: EventMetadata;
3405
3222
  }
3406
- interface PollLayoutNonNullableFields {
3407
- type: PollLayoutType;
3408
- direction: PollLayoutDirection;
3223
+ interface PostDeletedEnvelope {
3224
+ entity: Post;
3225
+ metadata: EventMetadata;
3409
3226
  }
3410
- interface PollDataLayoutNonNullableFields {
3411
- poll?: PollLayoutNonNullableFields;
3227
+ interface PostLikedEnvelope {
3228
+ data: PostLiked;
3229
+ metadata: EventMetadata;
3412
3230
  }
3413
- interface BackgroundNonNullableFields {
3414
- type: BackgroundType;
3231
+ interface PostUnlikedEnvelope {
3232
+ data: PostUnliked;
3233
+ metadata: EventMetadata;
3415
3234
  }
3416
- interface PollDesignNonNullableFields {
3417
- background?: BackgroundNonNullableFields;
3235
+ interface PostUpdatedEnvelope {
3236
+ entity: Post;
3237
+ metadata: EventMetadata;
3418
3238
  }
3419
- interface DesignNonNullableFields {
3420
- poll?: PollDesignNonNullableFields;
3239
+ interface QueryPostCountStatsOptions {
3240
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3241
+ rangeStart?: Date | null;
3242
+ /**
3243
+ * Order of returned results.
3244
+ *
3245
+ * - `OLDEST`: posts by date in ascending order.
3246
+ * - `NEWEST`: posts by date in descending order.
3247
+ *
3248
+ * Default: `OLDEST`
3249
+ */
3250
+ order?: Order;
3251
+ /** Number of months to include in response. */
3252
+ months?: number;
3253
+ /**
3254
+ * Language filter.
3255
+ *
3256
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3257
+ * Pass a language to only receive the period post count for that specified language.
3258
+ * @format LANGUAGE_TAG
3259
+ */
3260
+ language?: string | null;
3261
+ /**
3262
+ * Time zone to use when calculating the start of the month.
3263
+ *
3264
+ * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
3265
+ * @minLength 3
3266
+ * @maxLength 100
3267
+ */
3268
+ timeZone?: string | null;
3421
3269
  }
3422
- interface PollDataNonNullableFields {
3423
- containerData?: PluginContainerDataNonNullableFields;
3424
- poll?: PollNonNullableFields;
3425
- layout?: PollDataLayoutNonNullableFields;
3426
- design?: DesignNonNullableFields;
3270
+ interface GetTotalPostsOptions {
3271
+ /**
3272
+ * Language filter.
3273
+ *
3274
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3275
+ * Pass a language to receive the total amount of posts in that specified language.
3276
+ * @format LANGUAGE_TAG
3277
+ */
3278
+ language?: string | null;
3427
3279
  }
3428
- interface AnchorDataNonNullableFields {
3429
- anchor: string;
3280
+ interface GetPostOptions {
3281
+ /**
3282
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3283
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3284
+ * only the post’s base fields are returned.
3285
+ * @maxSize 20
3286
+ */
3287
+ fieldsets?: PostFieldField[];
3430
3288
  }
3431
- interface LinkDataNonNullableFields {
3432
- link?: LinkNonNullableFields;
3289
+ interface GetPostBySlugOptions {
3290
+ /**
3291
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3292
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3293
+ * only the post’s base fields are returned.
3294
+ * @maxSize 20
3295
+ */
3296
+ fieldsets?: PostFieldField[];
3433
3297
  }
3434
- interface MentionDataNonNullableFields {
3435
- name: string;
3436
- slug: string;
3298
+ interface ListPostsOptions {
3299
+ /**
3300
+ * Whether to return only featured posts.
3301
+ *
3302
+ * Default: `false`
3303
+ */
3304
+ featured?: boolean;
3305
+ /**
3306
+ * Hashtag filter.
3307
+ *
3308
+ * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3309
+ * If omitted, all posts with or without hashtags are returned.
3310
+ * @maxSize 100
3311
+ * @maxLength 100
3312
+ */
3313
+ hashtags?: string[];
3314
+ /**
3315
+ * Category filter.
3316
+ *
3317
+ * Pass an array of category IDs to return only posts with any of the provided categories.
3318
+ * If omitted, all posts with or without associated categories are returned.
3319
+ * @maxSize 50
3320
+ * @maxLength 38
3321
+ */
3322
+ categoryIds?: string[];
3323
+ /**
3324
+ * Tag filter.
3325
+ *
3326
+ * Pass an array of tag IDs to return only posts with any of the provided tags.
3327
+ * If omitted, all posts with or without tags are returned.
3328
+ * @maxSize 50
3329
+ * @maxLength 38
3330
+ */
3331
+ tagIds?: string[];
3332
+ /**
3333
+ * Sorting options.
3334
+ *
3335
+ * Default: `FEED`
3336
+ */
3337
+ sort?: GetPostsSort;
3338
+ /** Pagination options. */
3339
+ paging?: BlogPaging;
3340
+ /**
3341
+ * Language filter.
3342
+ *
3343
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3344
+ * Pass a language to only receive posts that are in that language.
3345
+ * If omitted, posts in all languages are returned.
3346
+ * @format LANGUAGE_TAG
3347
+ */
3348
+ language?: string | null;
3349
+ /**
3350
+ * Post owner's member ID.
3351
+ * @format GUID
3352
+ */
3353
+ memberId?: string | null;
3354
+ /**
3355
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3356
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3357
+ * only the post’s base fields are returned.
3358
+ * @maxSize 20
3359
+ */
3360
+ fieldsets?: PostFieldField[];
3437
3361
  }
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 {};
3362
+ interface QueryPostsOptions {
3363
+ /**
3364
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3365
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3366
+ * only the post’s base fields are returned.
3367
+ * @maxSize 20
3368
+ */
3369
+ fieldsets?: PostFieldField[] | undefined;
3370
+ }
3371
+ interface QueryCursorResult {
3372
+ cursors: Cursors;
3373
+ hasNext: () => boolean;
3374
+ hasPrev: () => boolean;
3375
+ length: number;
3376
+ pageSize: number;
3377
+ }
3378
+ interface PostsQueryResult extends QueryCursorResult {
3379
+ items: Post[];
3380
+ query: PostsQueryBuilder;
3381
+ next: () => Promise<PostsQueryResult>;
3382
+ prev: () => Promise<PostsQueryResult>;
3383
+ }
3384
+ interface PostsQueryBuilder {
3385
+ /** @param propertyName - Property whose value is compared with `value`.
3386
+ * @param value - Value to compare against.
3387
+ */
3388
+ 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;
3389
+ /** @param propertyName - Property whose value is compared with `value`.
3390
+ * @param value - Value to compare against.
3391
+ */
3392
+ 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;
3393
+ /** @param propertyName - Property whose value is compared with `value`.
3394
+ * @param value - Value to compare against.
3395
+ */
3396
+ ge: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
3397
+ /** @param propertyName - Property whose value is compared with `value`.
3398
+ * @param value - Value to compare against.
3399
+ */
3400
+ gt: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
3401
+ /** @param propertyName - Property whose value is compared with `value`.
3402
+ * @param value - Value to compare against.
3403
+ */
3404
+ le: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
3405
+ /** @param propertyName - Property whose value is compared with `value`.
3406
+ * @param value - Value to compare against.
3407
+ */
3408
+ lt: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
3409
+ /** @param propertyName - Property whose value is compared with `string`.
3410
+ * @param string - String to compare against. Case-insensitive.
3411
+ */
3412
+ startsWith: (propertyName: 'title', value: string) => PostsQueryBuilder;
3413
+ /** @param propertyName - Property whose value is compared with `values`.
3414
+ * @param values - List of values to compare against.
3415
+ */
3416
+ hasSome: (propertyName: '_id' | 'title' | 'slug' | 'categoryIds' | 'memberId' | 'hashtags' | 'tagIds' | 'pricingPlanIds' | 'language', value: any[]) => PostsQueryBuilder;
3417
+ /** @param propertyName - Property whose value is compared with `values`.
3418
+ * @param values - List of values to compare against.
3419
+ */
3420
+ hasAll: (propertyName: 'categoryIds' | 'hashtags' | 'tagIds' | 'pricingPlanIds', value: any[]) => PostsQueryBuilder;
3421
+ in: (propertyName: '_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'translationId' | 'language' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
3422
+ exists: (propertyName: 'title' | 'translationId' | 'language', value: boolean) => PostsQueryBuilder;
3423
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
3424
+ ascending: (...propertyNames: Array<'_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'commentingEnabled' | 'metrics.comments' | 'metrics.likes' | 'metrics.views'>) => PostsQueryBuilder;
3425
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
3426
+ descending: (...propertyNames: Array<'_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'commentingEnabled' | 'metrics.comments' | 'metrics.likes' | 'metrics.views'>) => PostsQueryBuilder;
3427
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
3428
+ limit: (limit: number) => PostsQueryBuilder;
3429
+ /** @param cursor - A pointer to specific record */
3430
+ skipTo: (cursor: string) => PostsQueryBuilder;
3431
+ find: () => Promise<PostsQueryResult>;
3432
+ }
3433
+
3434
+ 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 };