@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,4037 +0,0 @@
1
- export interface Post {
2
- /**
3
- * Post ID.
4
- * @readonly
5
- * @format GUID
6
- */
7
- _id?: string;
8
- /**
9
- * Post title.
10
- * @maxLength 100
11
- */
12
- title?: string;
13
- /**
14
- * Post excerpt.
15
- * Can be selected by a site contributor. By default, it is extracted from the content text's first characters.
16
- *
17
- * Max: 500 characters
18
- * @maxLength 500
19
- */
20
- excerpt?: string;
21
- /**
22
- * The post's content in plain text.
23
- * @readonly
24
- * @maxLength 400000
25
- */
26
- contentText?: string | null;
27
- /** Date the post was first published. */
28
- firstPublishedDate?: Date | null;
29
- /**
30
- * Date the post was last published.
31
- * @readonly
32
- */
33
- lastPublishedDate?: Date | null;
34
- /** Post URL. */
35
- url?: string;
36
- /**
37
- * Post slug. For example, `'post-slug'`.
38
- * @maxLength 100
39
- */
40
- slug?: string;
41
- /** Whether the post is marked as featured. */
42
- featured?: boolean;
43
- /** Whether the post is pinned. If `true`, the post is placed at the top of the post list. */
44
- pinned?: boolean;
45
- /**
46
- * [Category IDs](https://dev.wix.com/docs/rest/business-solutions/blog/category/introduction) of the post.
47
- * @maxSize 10
48
- * @format GUID
49
- */
50
- categoryIds?: string[];
51
- /**
52
- * __Deprecated.__ Use `media` instead.
53
- * This property will be removed on June 30, 2023.
54
- *
55
- * Post cover media.
56
- * @deprecated
57
- * @replacedBy media
58
- * @targetRemovalDate 2024-06-30
59
- */
60
- coverMedia?: CoverMedia;
61
- /**
62
- * Post owner's [member ID](https://dev.wix.com/api/rest/members).
63
- * @format GUID
64
- */
65
- memberId?: string;
66
- /**
67
- * Hashtags in the post.
68
- * @readonly
69
- * @maxSize 100
70
- * @maxLength 100
71
- */
72
- hashtags?: string[];
73
- /** Whether commenting on the post is enabled. */
74
- commentingEnabled?: boolean;
75
- /** Estimated reading time (calculated automatically). */
76
- minutesToRead?: number;
77
- /** Image placed at the top of the blog page. */
78
- heroImage?: string;
79
- /**
80
- * IDs of [tags](https://dev.wix.com/docs/rest/business-solutions/blog/tags) the post is tagged with.
81
- * @readonly
82
- * @maxSize 30
83
- * @format GUID
84
- */
85
- tagIds?: string[];
86
- /**
87
- * IDs of posts related to the post.
88
- * @readonly
89
- * @maxSize 3
90
- * @format GUID
91
- */
92
- relatedPostIds?: string[];
93
- /**
94
- * [Pricing plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans). Only relevant if a post is assigned to a specific pricing plan.
95
- * @readonly
96
- * @maxSize 100
97
- * @format GUID
98
- */
99
- pricingPlanIds?: string[];
100
- /**
101
- * ID of the translations of this post. All translations of a single post share the same `translationId`.
102
- * @format GUID
103
- */
104
- translationId?: string | null;
105
- /**
106
- * Language the post is written in.
107
- *
108
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
109
- * @format LANGUAGE_TAG
110
- */
111
- language?: string | null;
112
- /** SEO data. */
113
- seoData?: SeoSchema;
114
- /**
115
- * Reserved for internal use.
116
- * @readonly
117
- * @maxLength 400000
118
- */
119
- content?: string | null;
120
- /**
121
- * Post owner's [contact ID](https://dev.wix.com/api/rest/contacts).
122
- * @format GUID
123
- */
124
- contactId?: string | null;
125
- /**
126
- * Post rich content
127
- *
128
- * <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">
129
- * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
130
- * </widget>
131
- * @readonly
132
- */
133
- richContent?: RichContent;
134
- /**
135
- * Whether the returned content is a preview of premium content. Defaults to `false`.
136
- * A preview displays a limited number of paragraphs of paid content to non-subscribed users.
137
- * @readonly
138
- */
139
- preview?: boolean;
140
- /**
141
- * Reserved for internal use.
142
- * @maxLength 24
143
- */
144
- contentId?: string | null;
145
- /**
146
- * Reserved for internal use.
147
- * @readonly
148
- * @format GUID
149
- */
150
- mostRecentContributorId?: string | null;
151
- /**
152
- * Post moderation details. Only relevant to posts submitted by [guest writers](https://support.wix.com/en/article/wix-blog-moderating-blog-posts-from-your-guest-writers).
153
- * @readonly
154
- */
155
- moderationDetails?: ModerationDetails;
156
- /** Post cover media. */
157
- media?: Media;
158
- /**
159
- * Indicates if there is a draft post with changes that have not yet been published.
160
- * @readonly
161
- */
162
- hasUnpublishedChanges?: boolean;
163
- /**
164
- * Post reference ID. You can reference the post from other entities, for example, comments.
165
- * @readonly
166
- * @maxLength 24
167
- */
168
- referenceId?: string | null;
169
- }
170
- export interface CoverMedia extends CoverMediaMediaOneOf {
171
- /** Image url. */
172
- image?: string;
173
- /** Video url. */
174
- video?: string;
175
- /**
176
- * Is cover media enabled.
177
- * Selected by user whether to display cover media on the feed
178
- * @deprecated Is cover media enabled.
179
- * Selected by user whether to display cover media on the feed
180
- * @replacedBy displayed
181
- * @targetRemovalDate 2024-06-30
182
- */
183
- enabled?: boolean;
184
- /** Whether cover media is displayed. */
185
- displayed?: boolean;
186
- /** Whether cover media is custom. If `false` the cover image is set to the first media item that appears in the content. */
187
- custom?: boolean;
188
- /**
189
- * Media alternative text.
190
- * @minLength 1
191
- * @maxLength 1000
192
- */
193
- altText?: string | null;
194
- }
195
- /** @oneof */
196
- export interface CoverMediaMediaOneOf {
197
- /** Image url. */
198
- image?: string;
199
- /** Video url. */
200
- video?: string;
201
- }
202
- export interface FocalPoint {
203
- /** X-coordinate of the focal point. */
204
- x?: number;
205
- /** Y-coordinate of the focal point. */
206
- y?: number;
207
- /** crop by height */
208
- height?: number | null;
209
- /** crop by width */
210
- width?: number | null;
211
- }
212
- export interface PostCountInfo {
213
- /**
214
- * Total number of post comments
215
- * @readonly
216
- */
217
- comments?: number;
218
- /**
219
- * Total number of post likes
220
- * @readonly
221
- */
222
- likes?: number;
223
- /**
224
- * Total number of post views
225
- * @readonly
226
- */
227
- views?: number;
228
- }
229
- export interface Metrics {
230
- /**
231
- * Total number of post comments.
232
- * @readonly
233
- */
234
- comments?: number;
235
- /**
236
- * Total number of post likes.
237
- * @readonly
238
- */
239
- likes?: number;
240
- /**
241
- * Total number of post views.
242
- * @readonly
243
- */
244
- views?: number;
245
- }
246
- /**
247
- * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
248
- * The search engines use this information for ranking purposes, or to display snippets in the search results.
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.
250
- */
251
- export interface SeoSchema {
252
- /** SEO tag information. */
253
- tags?: Tag[];
254
- /** SEO general settings. */
255
- settings?: Settings;
256
- }
257
- export interface Keyword {
258
- /** Keyword value. */
259
- term?: string;
260
- /** Whether the keyword is the main focus keyword. */
261
- isMain?: boolean;
262
- /**
263
- * The source that added the keyword terms to the SEO settings.
264
- * @maxLength 1000
265
- */
266
- origin?: string | null;
267
- }
268
- export interface Tag {
269
- /**
270
- * SEO tag type.
271
- *
272
- *
273
- * Supported values: `title`, `meta`, `script`, `link`.
274
- */
275
- type?: string;
276
- /**
277
- * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
278
- * For example: `{"name": "description", "content": "the description itself"}`.
279
- */
280
- props?: Record<string, any> | null;
281
- /** SEO tag meta data. For example, `{"height": 300, "width": 240}`. */
282
- meta?: Record<string, any> | null;
283
- /** SEO tag inner content. For example, `<title> inner content </title>`. */
284
- children?: string;
285
- /** Whether the tag is a custom tag. */
286
- custom?: boolean;
287
- /** Whether the tag is disabled. */
288
- disabled?: boolean;
289
- }
290
- export interface Settings {
291
- /**
292
- * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
293
- *
294
- *
295
- * Default: `false` (Auto Redirect is enabled.)
296
- */
297
- preventAutoRedirect?: boolean;
298
- /**
299
- * User-selected keyword terms for a specific page.
300
- * @maxSize 5
301
- */
302
- keywords?: Keyword[];
303
- }
304
- export interface RichContent {
305
- /** Node objects representing a rich content document. */
306
- nodes?: Node[];
307
- /** Object metadata. */
308
- metadata?: Metadata;
309
- /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
310
- documentStyle?: DocumentStyle;
311
- }
312
- export interface Node extends NodeDataOneOf {
313
- /** Data for a button node. */
314
- buttonData?: ButtonData;
315
- /** Data for a code block node. */
316
- codeBlockData?: CodeBlockData;
317
- /** Data for a divider node. */
318
- dividerData?: DividerData;
319
- /** Data for a file node. */
320
- fileData?: FileData;
321
- /** Data for a gallery node. */
322
- galleryData?: GalleryData;
323
- /** Data for a GIF node. */
324
- gifData?: GIFData;
325
- /** Data for a heading node. */
326
- headingData?: HeadingData;
327
- /** Data for an embedded HTML node. */
328
- htmlData?: HTMLData;
329
- /** Data for an image node. */
330
- imageData?: ImageData;
331
- /** Data for a link preview node. */
332
- linkPreviewData?: LinkPreviewData;
333
- /** @deprecated */
334
- mapData?: MapData;
335
- /** Data for a paragraph node. */
336
- paragraphData?: ParagraphData;
337
- /** Data for a poll node. */
338
- pollData?: PollData;
339
- /** Data for a text node. Used to apply decorations to text. */
340
- textData?: TextData;
341
- /** Data for an app embed node. */
342
- appEmbedData?: AppEmbedData;
343
- /** Data for a video node. */
344
- videoData?: VideoData;
345
- /** Data for an oEmbed node. */
346
- embedData?: EmbedData;
347
- /** Data for a collapsible list node. */
348
- collapsibleListData?: CollapsibleListData;
349
- /** Data for a table node. */
350
- tableData?: TableData;
351
- /** Data for a table cell node. */
352
- tableCellData?: TableCellData;
353
- /** Data for a custom external node. */
354
- externalData?: Record<string, any> | null;
355
- /** Data for an audio node. */
356
- audioData?: AudioData;
357
- /** Data for an ordered list node. */
358
- orderedListData?: OrderedListData;
359
- /** Data for a bulleted list node. */
360
- bulletedListData?: BulletedListData;
361
- /** Data for a block quote node. */
362
- blockquoteData?: BlockquoteData;
363
- /** Data for a caption node. */
364
- captionData?: CaptionData;
365
- /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
366
- layoutCellData?: LayoutCellData;
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. */
368
- type?: NodeType;
369
- /** Node ID. */
370
- _id?: string;
371
- /** A list of child nodes. */
372
- nodes?: Node[];
373
- /** Padding and background color styling for the node. */
374
- style?: NodeStyle;
375
- }
376
- /** @oneof */
377
- export interface NodeDataOneOf {
378
- /** Data for a button node. */
379
- buttonData?: ButtonData;
380
- /** Data for a code block node. */
381
- codeBlockData?: CodeBlockData;
382
- /** Data for a divider node. */
383
- dividerData?: DividerData;
384
- /** Data for a file node. */
385
- fileData?: FileData;
386
- /** Data for a gallery node. */
387
- galleryData?: GalleryData;
388
- /** Data for a GIF node. */
389
- gifData?: GIFData;
390
- /** Data for a heading node. */
391
- headingData?: HeadingData;
392
- /** Data for an embedded HTML node. */
393
- htmlData?: HTMLData;
394
- /** Data for an image node. */
395
- imageData?: ImageData;
396
- /** Data for a link preview node. */
397
- linkPreviewData?: LinkPreviewData;
398
- /** @deprecated */
399
- mapData?: MapData;
400
- /** Data for a paragraph node. */
401
- paragraphData?: ParagraphData;
402
- /** Data for a poll node. */
403
- pollData?: PollData;
404
- /** Data for a text node. Used to apply decorations to text. */
405
- textData?: TextData;
406
- /** Data for an app embed node. */
407
- appEmbedData?: AppEmbedData;
408
- /** Data for a video node. */
409
- videoData?: VideoData;
410
- /** Data for an oEmbed node. */
411
- embedData?: EmbedData;
412
- /** Data for a collapsible list node. */
413
- collapsibleListData?: CollapsibleListData;
414
- /** Data for a table node. */
415
- tableData?: TableData;
416
- /** Data for a table cell node. */
417
- tableCellData?: TableCellData;
418
- /** Data for a custom external node. */
419
- externalData?: Record<string, any> | null;
420
- /** Data for an audio node. */
421
- audioData?: AudioData;
422
- /** Data for an ordered list node. */
423
- orderedListData?: OrderedListData;
424
- /** Data for a bulleted list node. */
425
- bulletedListData?: BulletedListData;
426
- /** Data for a block quote node. */
427
- blockquoteData?: BlockquoteData;
428
- /** Data for a caption node. */
429
- captionData?: CaptionData;
430
- /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
431
- layoutCellData?: LayoutCellData;
432
- }
433
- export declare enum NodeType {
434
- PARAGRAPH = "PARAGRAPH",
435
- TEXT = "TEXT",
436
- HEADING = "HEADING",
437
- BULLETED_LIST = "BULLETED_LIST",
438
- ORDERED_LIST = "ORDERED_LIST",
439
- LIST_ITEM = "LIST_ITEM",
440
- BLOCKQUOTE = "BLOCKQUOTE",
441
- CODE_BLOCK = "CODE_BLOCK",
442
- VIDEO = "VIDEO",
443
- DIVIDER = "DIVIDER",
444
- FILE = "FILE",
445
- GALLERY = "GALLERY",
446
- GIF = "GIF",
447
- HTML = "HTML",
448
- IMAGE = "IMAGE",
449
- LINK_PREVIEW = "LINK_PREVIEW",
450
- /** @deprecated */
451
- MAP = "MAP",
452
- POLL = "POLL",
453
- APP_EMBED = "APP_EMBED",
454
- BUTTON = "BUTTON",
455
- COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
456
- TABLE = "TABLE",
457
- EMBED = "EMBED",
458
- COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
459
- COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
460
- COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
461
- TABLE_CELL = "TABLE_CELL",
462
- TABLE_ROW = "TABLE_ROW",
463
- EXTERNAL = "EXTERNAL",
464
- AUDIO = "AUDIO",
465
- CAPTION = "CAPTION",
466
- LAYOUT = "LAYOUT",
467
- LAYOUT_CELL = "LAYOUT_CELL"
468
- }
469
- export interface NodeStyle {
470
- /** The top padding value in pixels. */
471
- paddingTop?: string | null;
472
- /** The bottom padding value in pixels. */
473
- paddingBottom?: string | null;
474
- /** The background color as a hexadecimal value. */
475
- backgroundColor?: string | null;
476
- }
477
- export interface ButtonData {
478
- /** Styling for the button's container. */
479
- containerData?: PluginContainerData;
480
- /** The button type. */
481
- type?: Type;
482
- /** Styling for the button. */
483
- styles?: Styles;
484
- /** The text to display on the button. */
485
- text?: string | null;
486
- /** Button link details. */
487
- link?: Link;
488
- }
489
- export interface Border {
490
- /** Border width in pixels. */
491
- width?: number | null;
492
- /** Border radius in pixels. */
493
- radius?: number | null;
494
- }
495
- export interface Colors {
496
- /** The text color as a hexadecimal value. */
497
- text?: string | null;
498
- /** The border color as a hexadecimal value. */
499
- border?: string | null;
500
- /** The background color as a hexadecimal value. */
501
- background?: string | null;
502
- }
503
- export interface PluginContainerData {
504
- /** The width of the node when it's displayed. */
505
- width?: PluginContainerDataWidth;
506
- /** The node's alignment within its container. */
507
- alignment?: PluginContainerDataAlignment;
508
- /** Spoiler cover settings for the node. */
509
- spoiler?: Spoiler;
510
- /** The height of the node when it's displayed. */
511
- height?: Height;
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`. */
513
- textWrap?: boolean | null;
514
- }
515
- export declare enum WidthType {
516
- /** Width matches the content width */
517
- CONTENT = "CONTENT",
518
- /** Small Width */
519
- SMALL = "SMALL",
520
- /** Width will match the original asset width */
521
- ORIGINAL = "ORIGINAL",
522
- /** coast-to-coast display */
523
- FULL_WIDTH = "FULL_WIDTH"
524
- }
525
- export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
526
- /**
527
- * One of the following predefined width options:
528
- * `CONTENT`: The width of the container matches the content width.
529
- * `SMALL`: A small width.
530
- * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
531
- * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
532
- */
533
- size?: WidthType;
534
- /** A custom width value in pixels. */
535
- custom?: string | null;
536
- }
537
- /** @oneof */
538
- export interface PluginContainerDataWidthDataOneOf {
539
- /**
540
- * One of the following predefined width options:
541
- * `CONTENT`: The width of the container matches the content width.
542
- * `SMALL`: A small width.
543
- * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
544
- * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
545
- */
546
- size?: WidthType;
547
- /** A custom width value in pixels. */
548
- custom?: string | null;
549
- }
550
- export declare enum PluginContainerDataAlignment {
551
- /** Center Alignment */
552
- CENTER = "CENTER",
553
- /** Left Alignment */
554
- LEFT = "LEFT",
555
- /** Right Alignment */
556
- RIGHT = "RIGHT"
557
- }
558
- export interface Spoiler {
559
- /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
560
- enabled?: boolean | null;
561
- /** The description displayed on top of the spoiler cover. */
562
- description?: string | null;
563
- /** The text for the button used to remove the spoiler cover. */
564
- buttonText?: string | null;
565
- }
566
- export interface Height {
567
- /** A custom height value in pixels. */
568
- custom?: string | null;
569
- }
570
- export declare enum Type {
571
- /** Regular link button */
572
- LINK = "LINK",
573
- /** Triggers custom action that is defined in plugin configuration by the consumer */
574
- ACTION = "ACTION"
575
- }
576
- export interface Styles {
577
- /** Border attributes. */
578
- border?: Border;
579
- /** Color attributes. */
580
- colors?: Colors;
581
- }
582
- export interface Link extends LinkDataOneOf {
583
- /** The absolute URL for the linked document. */
584
- url?: string;
585
- /** The target node's ID. Used for linking to another node in this object. */
586
- anchor?: string;
587
- /**
588
- * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
589
- * `SELF` - Default. Opens the linked document in the same frame as the link.
590
- * `BLANK` - Opens the linked document in a new browser tab or window.
591
- * `PARENT` - Opens the linked document in the link's parent frame.
592
- * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
593
- */
594
- target?: Target;
595
- /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
596
- rel?: Rel;
597
- /** A serialized object used for a custom or external link panel. */
598
- customData?: string | null;
599
- }
600
- /** @oneof */
601
- export interface LinkDataOneOf {
602
- /** The absolute URL for the linked document. */
603
- url?: string;
604
- /** The target node's ID. Used for linking to another node in this object. */
605
- anchor?: string;
606
- }
607
- export declare enum Target {
608
- /** Opens the linked document in the same frame as it was clicked (this is default) */
609
- SELF = "SELF",
610
- /** Opens the linked document in a new window or tab */
611
- BLANK = "BLANK",
612
- /** Opens the linked document in the parent frame */
613
- PARENT = "PARENT",
614
- /** Opens the linked document in the full body of the window */
615
- TOP = "TOP"
616
- }
617
- export interface Rel {
618
- /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
619
- nofollow?: boolean | null;
620
- /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
621
- sponsored?: boolean | null;
622
- /** Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`. */
623
- ugc?: boolean | null;
624
- /** Indicates that this link protect referral information from being passed to the target website. */
625
- noreferrer?: boolean | null;
626
- }
627
- export interface CodeBlockData {
628
- /** Styling for the code block's text. */
629
- textStyle?: TextStyle;
630
- }
631
- export interface TextStyle {
632
- /** Text alignment. Defaults to `AUTO`. */
633
- textAlignment?: TextAlignment;
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. */
635
- lineHeight?: string | null;
636
- }
637
- export declare enum TextAlignment {
638
- /** browser default, eqivalent to `initial` */
639
- AUTO = "AUTO",
640
- /** Left align */
641
- LEFT = "LEFT",
642
- /** Right align */
643
- RIGHT = "RIGHT",
644
- /** Center align */
645
- CENTER = "CENTER",
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 */
647
- JUSTIFY = "JUSTIFY"
648
- }
649
- export interface DividerData {
650
- /** Styling for the divider's container. */
651
- containerData?: PluginContainerData;
652
- /** Divider line style. */
653
- lineStyle?: LineStyle;
654
- /** Divider width. */
655
- width?: Width;
656
- /** Divider alignment. */
657
- alignment?: Alignment;
658
- }
659
- export declare enum LineStyle {
660
- /** Single Line */
661
- SINGLE = "SINGLE",
662
- /** Double Line */
663
- DOUBLE = "DOUBLE",
664
- /** Dashed Line */
665
- DASHED = "DASHED",
666
- /** Dotted Line */
667
- DOTTED = "DOTTED"
668
- }
669
- export declare enum Width {
670
- /** Large line */
671
- LARGE = "LARGE",
672
- /** Medium line */
673
- MEDIUM = "MEDIUM",
674
- /** Small line */
675
- SMALL = "SMALL"
676
- }
677
- export declare enum Alignment {
678
- /** Center alignment */
679
- CENTER = "CENTER",
680
- /** Left alignment */
681
- LEFT = "LEFT",
682
- /** Right alignment */
683
- RIGHT = "RIGHT"
684
- }
685
- export interface FileData {
686
- /** Styling for the file's container. */
687
- containerData?: PluginContainerData;
688
- /** The source for the file's data. */
689
- src?: FileSource;
690
- /** File name. */
691
- name?: string | null;
692
- /** File type. */
693
- type?: string | null;
694
- /**
695
- * Use `sizeInKb` instead.
696
- * @deprecated
697
- */
698
- size?: number | null;
699
- /** Settings for PDF files. */
700
- pdfSettings?: PDFSettings;
701
- /** File MIME type. */
702
- mimeType?: string | null;
703
- /** File path. */
704
- path?: string | null;
705
- /** File size in KB. */
706
- sizeInKb?: string | null;
707
- }
708
- export declare enum ViewMode {
709
- /** No PDF view */
710
- NONE = "NONE",
711
- /** Full PDF view */
712
- FULL = "FULL",
713
- /** Mini PDF view */
714
- MINI = "MINI"
715
- }
716
- export interface FileSource extends FileSourceDataOneOf {
717
- /** The absolute URL for the file's source. */
718
- url?: string | null;
719
- /**
720
- * Custom ID. Use `id` instead.
721
- * @deprecated
722
- */
723
- custom?: string | null;
724
- /** An ID that's resolved to a URL by a resolver function. */
725
- _id?: string | null;
726
- /** Indicates whether the file's source is private. Defaults to `false`. */
727
- private?: boolean | null;
728
- }
729
- /** @oneof */
730
- export interface FileSourceDataOneOf {
731
- /** The absolute URL for the file's source. */
732
- url?: string | null;
733
- /**
734
- * Custom ID. Use `id` instead.
735
- * @deprecated
736
- */
737
- custom?: string | null;
738
- /** An ID that's resolved to a URL by a resolver function. */
739
- _id?: string | null;
740
- }
741
- export interface PDFSettings {
742
- /**
743
- * PDF view mode. One of the following:
744
- * `NONE` : The PDF isn't displayed.
745
- * `FULL` : A full page view of the PDF is displayed.
746
- * `MINI` : A mini view of the PDF is displayed.
747
- */
748
- viewMode?: ViewMode;
749
- /** Sets whether the PDF download button is disabled. Defaults to `false`. */
750
- disableDownload?: boolean | null;
751
- /** Sets whether the PDF print button is disabled. Defaults to `false`. */
752
- disablePrint?: boolean | null;
753
- }
754
- export interface GalleryData {
755
- /** Styling for the gallery's container. */
756
- containerData?: PluginContainerData;
757
- /** The items in the gallery. */
758
- items?: Item[];
759
- /** Options for defining the gallery's appearance. */
760
- options?: GalleryOptions;
761
- /** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
762
- disableExpand?: boolean | null;
763
- /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
764
- disableDownload?: boolean | null;
765
- }
766
- export interface V1Media {
767
- /** The source for the media's data. */
768
- src?: FileSource;
769
- /** Media width in pixels. */
770
- width?: number | null;
771
- /** Media height in pixels. */
772
- height?: number | null;
773
- /** Media duration in seconds. Only relevant for audio and video files. */
774
- duration?: number | null;
775
- }
776
- export interface Image {
777
- /** Image file details. */
778
- media?: V1Media;
779
- /** Link details for images that are links. */
780
- link?: Link;
781
- }
782
- export interface Video {
783
- /** Video file details. */
784
- media?: V1Media;
785
- /** Video thumbnail file details. */
786
- thumbnail?: V1Media;
787
- }
788
- export interface Item extends ItemDataOneOf {
789
- /** An image item. */
790
- image?: Image;
791
- /** A video item. */
792
- video?: Video;
793
- /** Item title. */
794
- title?: string | null;
795
- /** Item's alternative text. */
796
- altText?: string | null;
797
- }
798
- /** @oneof */
799
- export interface ItemDataOneOf {
800
- /** An image item. */
801
- image?: Image;
802
- /** A video item. */
803
- video?: Video;
804
- }
805
- export interface GalleryOptions {
806
- /** Gallery layout. */
807
- layout?: Layout;
808
- /** Styling for gallery items. */
809
- item?: ItemStyle;
810
- /** Styling for gallery thumbnail images. */
811
- thumbnails?: Thumbnails;
812
- }
813
- export declare enum LayoutType {
814
- /** Collage type */
815
- COLLAGE = "COLLAGE",
816
- /** Masonry type */
817
- MASONRY = "MASONRY",
818
- /** Grid type */
819
- GRID = "GRID",
820
- /** Thumbnail type */
821
- THUMBNAIL = "THUMBNAIL",
822
- /** Slider type */
823
- SLIDER = "SLIDER",
824
- /** Slideshow type */
825
- SLIDESHOW = "SLIDESHOW",
826
- /** Panorama type */
827
- PANORAMA = "PANORAMA",
828
- /** Column type */
829
- COLUMN = "COLUMN",
830
- /** Magic type */
831
- MAGIC = "MAGIC",
832
- /** Fullsize images type */
833
- FULLSIZE = "FULLSIZE"
834
- }
835
- export declare enum Orientation {
836
- /** Rows Orientation */
837
- ROWS = "ROWS",
838
- /** Columns Orientation */
839
- COLUMNS = "COLUMNS"
840
- }
841
- export declare enum Crop {
842
- /** Crop to fill */
843
- FILL = "FILL",
844
- /** Crop to fit */
845
- FIT = "FIT"
846
- }
847
- export declare enum ThumbnailsAlignment {
848
- /** Top alignment */
849
- TOP = "TOP",
850
- /** Right alignment */
851
- RIGHT = "RIGHT",
852
- /** Bottom alignment */
853
- BOTTOM = "BOTTOM",
854
- /** Left alignment */
855
- LEFT = "LEFT",
856
- /** No thumbnail */
857
- NONE = "NONE"
858
- }
859
- export interface Layout {
860
- /** Gallery layout type. */
861
- type?: LayoutType;
862
- /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
863
- horizontalScroll?: boolean | null;
864
- /** Gallery orientation. */
865
- orientation?: Orientation;
866
- /** The number of columns to display on full size screens. */
867
- numberOfColumns?: number | null;
868
- /** The number of columns to display on mobile screens. */
869
- mobileNumberOfColumns?: number | null;
870
- }
871
- export interface ItemStyle {
872
- /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
873
- targetSize?: number | null;
874
- /** Item ratio */
875
- ratio?: number | null;
876
- /** Sets how item images are cropped. */
877
- crop?: Crop;
878
- /** The spacing between items in pixels. */
879
- spacing?: number | null;
880
- }
881
- export interface Thumbnails {
882
- /** Thumbnail alignment. */
883
- placement?: ThumbnailsAlignment;
884
- /** Spacing between thumbnails in pixels. */
885
- spacing?: number | null;
886
- }
887
- export interface GIFData {
888
- /** Styling for the GIF's container. */
889
- containerData?: PluginContainerData;
890
- /** The source of the full size GIF. */
891
- original?: GIF;
892
- /** The source of the downsized GIF. */
893
- downsized?: GIF;
894
- /** Height in pixels. */
895
- height?: number;
896
- /** Width in pixels. */
897
- width?: number;
898
- /** Type of GIF (Sticker or GIF). Defaults to `GIF`. */
899
- gifType?: GIFType;
900
- }
901
- export interface GIF {
902
- /**
903
- * GIF format URL.
904
- * @format WEB_URL
905
- */
906
- gif?: string | null;
907
- /**
908
- * MP4 format URL.
909
- * @format WEB_URL
910
- */
911
- mp4?: string | null;
912
- /**
913
- * Thumbnail URL.
914
- * @format WEB_URL
915
- */
916
- still?: string | null;
917
- }
918
- export declare enum GIFType {
919
- GIF = "GIF",
920
- STICKER = "STICKER"
921
- }
922
- export interface HeadingData {
923
- /** Heading level from 1-6. */
924
- level?: number;
925
- /** Styling for the heading text. */
926
- textStyle?: TextStyle;
927
- /** Indentation level from 1-4. */
928
- indentation?: number | null;
929
- }
930
- export interface HTMLData extends HTMLDataDataOneOf {
931
- /** The URL for the HTML code for the node. */
932
- url?: string;
933
- /** The HTML code for the node. */
934
- html?: string;
935
- /**
936
- * Whether this is an AdSense element. Use `source` instead.
937
- * @deprecated
938
- */
939
- isAdsense?: boolean | null;
940
- /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
941
- containerData?: PluginContainerData;
942
- /** The type of HTML code. */
943
- source?: Source;
944
- /** If container height is aligned with its content height. Defaults to `true`. */
945
- autoHeight?: boolean | null;
946
- }
947
- /** @oneof */
948
- export interface HTMLDataDataOneOf {
949
- /** The URL for the HTML code for the node. */
950
- url?: string;
951
- /** The HTML code for the node. */
952
- html?: string;
953
- /**
954
- * Whether this is an AdSense element. Use `source` instead.
955
- * @deprecated
956
- */
957
- isAdsense?: boolean | null;
958
- }
959
- export declare enum Source {
960
- HTML = "HTML",
961
- ADSENSE = "ADSENSE"
962
- }
963
- export interface ImageData {
964
- /** Styling for the image's container. */
965
- containerData?: PluginContainerData;
966
- /** Image file details. */
967
- image?: V1Media;
968
- /** Link details for images that are links. */
969
- link?: Link;
970
- /** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
971
- disableExpand?: boolean | null;
972
- /** Image's alternative text. */
973
- altText?: string | null;
974
- /**
975
- * Deprecated: use Caption node instead.
976
- * @deprecated
977
- */
978
- caption?: string | null;
979
- /** Sets whether the image's download button is disabled. Defaults to `false`. */
980
- disableDownload?: boolean | null;
981
- }
982
- export interface StylesBorder {
983
- /** Border width in pixels. */
984
- width?: number | null;
985
- /**
986
- * Border color as a hexadecimal value.
987
- * @format COLOR_HEX
988
- */
989
- color?: string | null;
990
- /** Border radius in pixels. */
991
- radius?: number | null;
992
- }
993
- export interface ImageDataStyles {
994
- /** Border attributes. */
995
- border?: StylesBorder;
996
- }
997
- export interface LinkPreviewData {
998
- /** Styling for the link preview's container. */
999
- containerData?: PluginContainerData;
1000
- /** Link details. */
1001
- link?: Link;
1002
- /** Preview title. */
1003
- title?: string | null;
1004
- /** Preview thumbnail URL. */
1005
- thumbnailUrl?: string | null;
1006
- /** Preview description. */
1007
- description?: string | null;
1008
- /** The preview content as HTML. */
1009
- html?: string | null;
1010
- }
1011
- export declare enum Position {
1012
- /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
1013
- START = "START",
1014
- /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
1015
- END = "END",
1016
- /** Thumbnail positioned at the top */
1017
- TOP = "TOP",
1018
- /** Thumbnail hidden and not displayed */
1019
- HIDDEN = "HIDDEN"
1020
- }
1021
- export interface LinkPreviewDataStyles {
1022
- /**
1023
- * Background color as a hexadecimal value.
1024
- * @format COLOR_HEX
1025
- */
1026
- backgroundColor?: string | null;
1027
- /**
1028
- * Title color as a hexadecimal value.
1029
- * @format COLOR_HEX
1030
- */
1031
- titleColor?: string | null;
1032
- /**
1033
- * Subtitle color as a hexadecimal value.
1034
- * @format COLOR_HEX
1035
- */
1036
- subtitleColor?: string | null;
1037
- /**
1038
- * Link color as a hexadecimal value.
1039
- * @format COLOR_HEX
1040
- */
1041
- linkColor?: string | null;
1042
- /** Border width in pixels. */
1043
- borderWidth?: number | null;
1044
- /** Border radius in pixels. */
1045
- borderRadius?: number | null;
1046
- /**
1047
- * Border color as a hexadecimal value.
1048
- * @format COLOR_HEX
1049
- */
1050
- borderColor?: string | null;
1051
- /** Position of thumbnail. Defaults to `START`. */
1052
- thumbnailPosition?: Position;
1053
- }
1054
- export interface MapData {
1055
- /** Styling for the map's container. */
1056
- containerData?: PluginContainerData;
1057
- /** Map settings. */
1058
- mapSettings?: MapSettings;
1059
- }
1060
- export interface MapSettings {
1061
- /** The address to display on the map. */
1062
- address?: string | null;
1063
- /** Sets whether the map is draggable. */
1064
- draggable?: boolean | null;
1065
- /** Sets whether the location marker is visible. */
1066
- marker?: boolean | null;
1067
- /** Sets whether street view control is enabled. */
1068
- streetViewControl?: boolean | null;
1069
- /** Sets whether zoom control is enabled. */
1070
- zoomControl?: boolean | null;
1071
- /** Location latitude. */
1072
- lat?: number | null;
1073
- /** Location longitude. */
1074
- lng?: number | null;
1075
- /** Location name. */
1076
- locationName?: string | null;
1077
- /** Sets whether view mode control is enabled. */
1078
- viewModeControl?: boolean | null;
1079
- /** Initial zoom value. */
1080
- initialZoom?: number | null;
1081
- /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
1082
- mapType?: MapType;
1083
- }
1084
- export declare enum MapType {
1085
- /** Roadmap map type */
1086
- ROADMAP = "ROADMAP",
1087
- /** Satellite map type */
1088
- SATELITE = "SATELITE",
1089
- /** Hybrid map type */
1090
- HYBRID = "HYBRID",
1091
- /** Terrain map type */
1092
- TERRAIN = "TERRAIN"
1093
- }
1094
- export interface ParagraphData {
1095
- /** Styling for the paragraph text. */
1096
- textStyle?: TextStyle;
1097
- /** Indentation level from 1-4. */
1098
- indentation?: number | null;
1099
- /** Paragraph level */
1100
- level?: number | null;
1101
- }
1102
- export interface PollData {
1103
- /** Styling for the poll's container. */
1104
- containerData?: PluginContainerData;
1105
- /** Poll data. */
1106
- poll?: Poll;
1107
- /** Layout settings for the poll and voting options. */
1108
- layout?: PollDataLayout;
1109
- /** Styling for the poll and voting options. */
1110
- design?: Design;
1111
- }
1112
- export declare enum ViewRole {
1113
- /** Only Poll creator can view the results */
1114
- CREATOR = "CREATOR",
1115
- /** Anyone who voted can see the results */
1116
- VOTERS = "VOTERS",
1117
- /** Anyone can see the results, even if one didn't vote */
1118
- EVERYONE = "EVERYONE"
1119
- }
1120
- export declare enum VoteRole {
1121
- /** Logged in member */
1122
- SITE_MEMBERS = "SITE_MEMBERS",
1123
- /** Anyone */
1124
- ALL = "ALL"
1125
- }
1126
- export interface Permissions {
1127
- /** Sets who can view the poll results. */
1128
- view?: ViewRole;
1129
- /** Sets who can vote. */
1130
- vote?: VoteRole;
1131
- /** Sets whether one voter can vote multiple times. Defaults to `false`. */
1132
- allowMultipleVotes?: boolean | null;
1133
- }
1134
- export interface Option {
1135
- /** Option ID. */
1136
- _id?: string | null;
1137
- /** Option title. */
1138
- title?: string | null;
1139
- /** The image displayed with the option. */
1140
- image?: V1Media;
1141
- }
1142
- export interface PollSettings {
1143
- /** Permissions settings for voting. */
1144
- permissions?: Permissions;
1145
- /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
1146
- showVoters?: boolean | null;
1147
- /** Sets whether the vote count is displayed. Defaults to `true`. */
1148
- showVotesCount?: boolean | null;
1149
- }
1150
- export declare enum PollLayoutType {
1151
- /** List */
1152
- LIST = "LIST",
1153
- /** Grid */
1154
- GRID = "GRID"
1155
- }
1156
- export declare enum PollLayoutDirection {
1157
- /** Left-to-right */
1158
- LTR = "LTR",
1159
- /** Right-to-left */
1160
- RTL = "RTL"
1161
- }
1162
- export interface PollLayout {
1163
- /** The layout for displaying the voting options. */
1164
- type?: PollLayoutType;
1165
- /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
1166
- direction?: PollLayoutDirection;
1167
- /** Sets whether to display the main poll image. Defaults to `false`. */
1168
- enableImage?: boolean | null;
1169
- }
1170
- export interface OptionLayout {
1171
- /** Sets whether to display option images. Defaults to `false`. */
1172
- enableImage?: boolean | null;
1173
- }
1174
- export declare enum BackgroundType {
1175
- /** Color background type */
1176
- COLOR = "COLOR",
1177
- /** Image background type */
1178
- IMAGE = "IMAGE",
1179
- /** Gradiant background type */
1180
- GRADIENT = "GRADIENT"
1181
- }
1182
- export interface Gradient {
1183
- /** The gradient angle in degrees. */
1184
- angle?: number | null;
1185
- /**
1186
- * The start color as a hexademical value.
1187
- * @format COLOR_HEX
1188
- */
1189
- startColor?: string | null;
1190
- /**
1191
- * The end color as a hexademical value.
1192
- * @format COLOR_HEX
1193
- */
1194
- lastColor?: string | null;
1195
- }
1196
- export interface Background extends BackgroundBackgroundOneOf {
1197
- /**
1198
- * The background color as a hexademical value.
1199
- * @format COLOR_HEX
1200
- */
1201
- color?: string | null;
1202
- /** An image to use for the background. */
1203
- image?: V1Media;
1204
- /** Details for a gradient background. */
1205
- gradient?: Gradient;
1206
- /** Background type. For each option, include the relevant details. */
1207
- type?: BackgroundType;
1208
- }
1209
- /** @oneof */
1210
- export interface BackgroundBackgroundOneOf {
1211
- /**
1212
- * The background color as a hexademical value.
1213
- * @format COLOR_HEX
1214
- */
1215
- color?: string | null;
1216
- /** An image to use for the background. */
1217
- image?: V1Media;
1218
- /** Details for a gradient background. */
1219
- gradient?: Gradient;
1220
- }
1221
- export interface PollDesign {
1222
- /** Background styling. */
1223
- background?: Background;
1224
- /** Border radius in pixels. */
1225
- borderRadius?: number | null;
1226
- }
1227
- export interface OptionDesign {
1228
- /** Border radius in pixels. */
1229
- borderRadius?: number | null;
1230
- }
1231
- export interface Poll {
1232
- /** Poll ID. */
1233
- _id?: string | null;
1234
- /** Poll title. */
1235
- title?: string | null;
1236
- /** Poll creator ID. */
1237
- creatorId?: string | null;
1238
- /** Main poll image. */
1239
- image?: V1Media;
1240
- /** Voting options. */
1241
- options?: Option[];
1242
- /** The poll's permissions and display settings. */
1243
- settings?: PollSettings;
1244
- }
1245
- export interface PollDataLayout {
1246
- /** Poll layout settings. */
1247
- poll?: PollLayout;
1248
- /** Voting otpions layout settings. */
1249
- options?: OptionLayout;
1250
- }
1251
- export interface Design {
1252
- /** Styling for the poll. */
1253
- poll?: PollDesign;
1254
- /** Styling for voting options. */
1255
- options?: OptionDesign;
1256
- }
1257
- export interface TextData {
1258
- /** The text to apply decorations to. */
1259
- text?: string;
1260
- /** The decorations to apply. */
1261
- decorations?: Decoration[];
1262
- }
1263
- /** Adds appearence changes to text */
1264
- export interface Decoration extends DecorationDataOneOf {
1265
- /** Data for an anchor link decoration. */
1266
- anchorData?: AnchorData;
1267
- /** Data for a color decoration. */
1268
- colorData?: ColorData;
1269
- /** Data for an external link decoration. */
1270
- linkData?: LinkData;
1271
- /** Data for a mention decoration. */
1272
- mentionData?: MentionData;
1273
- /** Data for a font size decoration. */
1274
- fontSizeData?: FontSizeData;
1275
- /** Font weight for a bold decoration. */
1276
- fontWeightValue?: number | null;
1277
- /** Data for an italic decoration. Defaults to `true`. */
1278
- italicData?: boolean | null;
1279
- /** Data for an underline decoration. Defaults to `true`. */
1280
- underlineData?: boolean | null;
1281
- /** Data for a spoiler decoration. */
1282
- spoilerData?: SpoilerData;
1283
- /** The type of decoration to apply. */
1284
- type?: DecorationType;
1285
- }
1286
- /** @oneof */
1287
- export interface DecorationDataOneOf {
1288
- /** Data for an anchor link decoration. */
1289
- anchorData?: AnchorData;
1290
- /** Data for a color decoration. */
1291
- colorData?: ColorData;
1292
- /** Data for an external link decoration. */
1293
- linkData?: LinkData;
1294
- /** Data for a mention decoration. */
1295
- mentionData?: MentionData;
1296
- /** Data for a font size decoration. */
1297
- fontSizeData?: FontSizeData;
1298
- /** Font weight for a bold decoration. */
1299
- fontWeightValue?: number | null;
1300
- /** Data for an italic decoration. Defaults to `true`. */
1301
- italicData?: boolean | null;
1302
- /** Data for an underline decoration. Defaults to `true`. */
1303
- underlineData?: boolean | null;
1304
- /** Data for a spoiler decoration. */
1305
- spoilerData?: SpoilerData;
1306
- }
1307
- export declare enum DecorationType {
1308
- BOLD = "BOLD",
1309
- ITALIC = "ITALIC",
1310
- UNDERLINE = "UNDERLINE",
1311
- SPOILER = "SPOILER",
1312
- ANCHOR = "ANCHOR",
1313
- MENTION = "MENTION",
1314
- LINK = "LINK",
1315
- COLOR = "COLOR",
1316
- FONT_SIZE = "FONT_SIZE",
1317
- EXTERNAL = "EXTERNAL"
1318
- }
1319
- export interface AnchorData {
1320
- /** The target node's ID. */
1321
- anchor?: string;
1322
- }
1323
- export interface ColorData {
1324
- /** The text's background color as a hexadecimal value. */
1325
- background?: string | null;
1326
- /** The text's foreground color as a hexadecimal value. */
1327
- foreground?: string | null;
1328
- }
1329
- export interface LinkData {
1330
- /** Link details. */
1331
- link?: Link;
1332
- }
1333
- export interface MentionData {
1334
- /** The mentioned user's name. */
1335
- name?: string;
1336
- /** The version of the user's name that appears after the `@` character in the mention. */
1337
- slug?: string;
1338
- /** Mentioned user's ID. */
1339
- _id?: string | null;
1340
- }
1341
- export interface FontSizeData {
1342
- /** The units used for the font size. */
1343
- unit?: FontType;
1344
- /** Font size value. */
1345
- value?: number | null;
1346
- }
1347
- export declare enum FontType {
1348
- PX = "PX",
1349
- EM = "EM"
1350
- }
1351
- export interface SpoilerData {
1352
- /** Spoiler ID. */
1353
- _id?: string | null;
1354
- }
1355
- export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1356
- /** Data for embedded Wix Bookings content. */
1357
- bookingData?: BookingData;
1358
- /** Data for embedded Wix Events content. */
1359
- eventData?: EventData;
1360
- /** The type of Wix App content being embedded. */
1361
- type?: AppType;
1362
- /** The ID of the embedded content. */
1363
- itemId?: string | null;
1364
- /** The name of the embedded content. */
1365
- name?: string | null;
1366
- /**
1367
- * Deprecated: Use `image` instead.
1368
- * @deprecated
1369
- */
1370
- imageSrc?: string | null;
1371
- /** The URL for the embedded content. */
1372
- url?: string | null;
1373
- /** An image for the embedded content. */
1374
- image?: V1Media;
1375
- }
1376
- /** @oneof */
1377
- export interface AppEmbedDataAppDataOneOf {
1378
- /** Data for embedded Wix Bookings content. */
1379
- bookingData?: BookingData;
1380
- /** Data for embedded Wix Events content. */
1381
- eventData?: EventData;
1382
- }
1383
- export declare enum AppType {
1384
- PRODUCT = "PRODUCT",
1385
- EVENT = "EVENT",
1386
- BOOKING = "BOOKING"
1387
- }
1388
- export interface BookingData {
1389
- /** Booking duration in minutes. */
1390
- durations?: string | null;
1391
- }
1392
- export interface EventData {
1393
- /** Event schedule. */
1394
- scheduling?: string | null;
1395
- /** Event location. */
1396
- location?: string | null;
1397
- }
1398
- export interface VideoData {
1399
- /** Styling for the video's container. */
1400
- containerData?: PluginContainerData;
1401
- /** Video details. */
1402
- video?: V1Media;
1403
- /** Video thumbnail details. */
1404
- thumbnail?: V1Media;
1405
- /** Sets whether the video's download button is disabled. Defaults to `false`. */
1406
- disableDownload?: boolean | null;
1407
- /** Video title. */
1408
- title?: string | null;
1409
- /** Video options. */
1410
- options?: PlaybackOptions;
1411
- }
1412
- export interface PlaybackOptions {
1413
- /** Sets whether the media will automatically start playing. */
1414
- autoPlay?: boolean | null;
1415
- /** Sets whether media's will be looped. */
1416
- playInLoop?: boolean | null;
1417
- /** Sets whether media's controls will be shown. */
1418
- showControls?: boolean | null;
1419
- }
1420
- export interface EmbedData {
1421
- /** Styling for the oEmbed node's container. */
1422
- containerData?: PluginContainerData;
1423
- /** An [oEmbed](https://www.oembed.com) object. */
1424
- oembed?: Oembed;
1425
- /** Origin asset source. */
1426
- src?: string | null;
1427
- }
1428
- export interface Oembed {
1429
- /** The resource type. */
1430
- type?: string | null;
1431
- /** The width of the resource specified in the `url` property in pixels. */
1432
- width?: number | null;
1433
- /** The height of the resource specified in the `url` property in pixels. */
1434
- height?: number | null;
1435
- /** Resource title. */
1436
- title?: string | null;
1437
- /** The source URL for the resource. */
1438
- url?: string | null;
1439
- /** HTML for embedding a video player. The HTML should have no padding or margins. */
1440
- html?: string | null;
1441
- /** The name of the author or owner of the resource. */
1442
- authorName?: string | null;
1443
- /** The URL for the author or owner of the resource. */
1444
- authorUrl?: string | null;
1445
- /** The name of the resource provider. */
1446
- providerName?: string | null;
1447
- /** The URL for the resource provider. */
1448
- providerUrl?: string | null;
1449
- /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
1450
- thumbnailUrl?: string | null;
1451
- /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
1452
- thumbnailWidth?: string | null;
1453
- /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
1454
- thumbnailHeight?: string | null;
1455
- /** The URL for an embedded viedo. */
1456
- videoUrl?: string | null;
1457
- /** The oEmbed version number. This value must be `1.0`. */
1458
- version?: string | null;
1459
- }
1460
- export interface CollapsibleListData {
1461
- /** Styling for the collapsible list's container. */
1462
- containerData?: PluginContainerData;
1463
- /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
1464
- expandOnlyOne?: boolean | null;
1465
- /** Sets which items are expanded when the page loads. */
1466
- initialExpandedItems?: InitialExpandedItems;
1467
- /** The direction of the text in the list. Either left-to-right or right-to-left. */
1468
- direction?: Direction;
1469
- /** If `true`, The collapsible item will appear in search results as an FAQ. */
1470
- isQapageData?: boolean | null;
1471
- }
1472
- export declare enum InitialExpandedItems {
1473
- /** First item will be expended initally */
1474
- FIRST = "FIRST",
1475
- /** All items will expended initally */
1476
- ALL = "ALL",
1477
- /** All items collapsed initally */
1478
- NONE = "NONE"
1479
- }
1480
- export declare enum Direction {
1481
- /** Left-to-right */
1482
- LTR = "LTR",
1483
- /** Right-to-left */
1484
- RTL = "RTL"
1485
- }
1486
- export interface TableData {
1487
- /** Styling for the table's container. */
1488
- containerData?: PluginContainerData;
1489
- /** The table's dimensions. */
1490
- dimensions?: Dimensions;
1491
- /**
1492
- * Deprecated: Use `rowHeader` and `columnHeader` instead.
1493
- * @deprecated
1494
- */
1495
- header?: boolean | null;
1496
- /** Sets whether the table's first row is a header. Defaults to `false`. */
1497
- rowHeader?: boolean | null;
1498
- /** Sets whether the table's first column is a header. Defaults to `false`. */
1499
- columnHeader?: boolean | null;
1500
- }
1501
- export interface Dimensions {
1502
- /** An array representing relative width of each column in relation to the other columns. */
1503
- colsWidthRatio?: number[];
1504
- /** An array representing the height of each row in pixels. */
1505
- rowsHeight?: number[];
1506
- /** An array representing the minimum width of each column in pixels. */
1507
- colsMinWidth?: number[];
1508
- }
1509
- export interface TableCellData {
1510
- /** Styling for the cell's background color and text alignment. */
1511
- cellStyle?: CellStyle;
1512
- /** The cell's border colors. */
1513
- borderColors?: BorderColors;
1514
- }
1515
- export declare enum VerticalAlignment {
1516
- /** Top alignment */
1517
- TOP = "TOP",
1518
- /** Middle alignment */
1519
- MIDDLE = "MIDDLE",
1520
- /** Bottom alignment */
1521
- BOTTOM = "BOTTOM"
1522
- }
1523
- export interface CellStyle {
1524
- /** Vertical alignment for the cell's text. */
1525
- verticalAlignment?: VerticalAlignment;
1526
- /**
1527
- * Cell background color as a hexadecimal value.
1528
- * @format COLOR_HEX
1529
- */
1530
- backgroundColor?: string | null;
1531
- }
1532
- export interface BorderColors {
1533
- /**
1534
- * Left border color as a hexadecimal value.
1535
- * @format COLOR_HEX
1536
- */
1537
- left?: string | null;
1538
- /**
1539
- * Right border color as a hexadecimal value.
1540
- * @format COLOR_HEX
1541
- */
1542
- right?: string | null;
1543
- /**
1544
- * Top border color as a hexadecimal value.
1545
- * @format COLOR_HEX
1546
- */
1547
- top?: string | null;
1548
- /**
1549
- * Bottom border color as a hexadecimal value.
1550
- * @format COLOR_HEX
1551
- */
1552
- bottom?: string | null;
1553
- }
1554
- /**
1555
- * `NullValue` is a singleton enumeration to represent the null value for the
1556
- * `Value` type union.
1557
- *
1558
- * The JSON representation for `NullValue` is JSON `null`.
1559
- */
1560
- export declare enum NullValue {
1561
- /** Null value. */
1562
- NULL_VALUE = "NULL_VALUE"
1563
- }
1564
- /**
1565
- * `ListValue` is a wrapper around a repeated field of values.
1566
- *
1567
- * The JSON representation for `ListValue` is JSON array.
1568
- */
1569
- export interface ListValue {
1570
- /** Repeated field of dynamically typed values. */
1571
- values?: any[];
1572
- }
1573
- export interface AudioData {
1574
- /** Styling for the audio node's container. */
1575
- containerData?: PluginContainerData;
1576
- /** Audio file details. */
1577
- audio?: V1Media;
1578
- /** Sets whether the audio node's download button is disabled. Defaults to `false`. */
1579
- disableDownload?: boolean | null;
1580
- /** Cover image. */
1581
- coverImage?: V1Media;
1582
- /** Track name. */
1583
- name?: string | null;
1584
- /** Author name. */
1585
- authorName?: string | null;
1586
- /** An HTML version of the audio node. */
1587
- html?: string | null;
1588
- }
1589
- export interface OrderedListData {
1590
- /** Indentation level from 0-4. */
1591
- indentation?: number;
1592
- /** Offset level from 0-4. */
1593
- offset?: number | null;
1594
- /** List start number. */
1595
- start?: number | null;
1596
- }
1597
- export interface BulletedListData {
1598
- /** Indentation level from 0-4. */
1599
- indentation?: number;
1600
- /** Offset level from 0-4. */
1601
- offset?: number | null;
1602
- }
1603
- export interface BlockquoteData {
1604
- /** Indentation level from 1-4. */
1605
- indentation?: number;
1606
- }
1607
- export interface CaptionData {
1608
- textStyle?: TextStyle;
1609
- }
1610
- export interface LayoutCellData {
1611
- /** Size of the cell in 12 columns grid. */
1612
- colSpan?: number | null;
1613
- }
1614
- export interface Metadata {
1615
- /** Schema version. */
1616
- version?: number;
1617
- /**
1618
- * When the object was created.
1619
- * @readonly
1620
- * @deprecated
1621
- */
1622
- createdTimestamp?: Date | null;
1623
- /**
1624
- * When the object was most recently updated.
1625
- * @deprecated
1626
- */
1627
- updatedTimestamp?: Date | null;
1628
- /** Object ID. */
1629
- _id?: string | null;
1630
- }
1631
- export interface DocumentStyle {
1632
- /** Styling for H1 nodes. */
1633
- headerOne?: TextNodeStyle;
1634
- /** Styling for H2 nodes. */
1635
- headerTwo?: TextNodeStyle;
1636
- /** Styling for H3 nodes. */
1637
- headerThree?: TextNodeStyle;
1638
- /** Styling for H4 nodes. */
1639
- headerFour?: TextNodeStyle;
1640
- /** Styling for H5 nodes. */
1641
- headerFive?: TextNodeStyle;
1642
- /** Styling for H6 nodes. */
1643
- headerSix?: TextNodeStyle;
1644
- /** Styling for paragraph nodes. */
1645
- paragraph?: TextNodeStyle;
1646
- /** Styling for block quote nodes. */
1647
- blockquote?: TextNodeStyle;
1648
- /** Styling for code block nodes. */
1649
- codeBlock?: TextNodeStyle;
1650
- }
1651
- export interface TextNodeStyle {
1652
- /** The decorations to apply to the node. */
1653
- decorations?: Decoration[];
1654
- /** Padding and background color for the node. */
1655
- nodeStyle?: NodeStyle;
1656
- /** Line height for text in the node. */
1657
- lineHeight?: string | null;
1658
- }
1659
- export interface ModerationDetails {
1660
- /**
1661
- * Member ID of the person submitting the draft post for review.
1662
- * @format GUID
1663
- */
1664
- submittedBy?: string;
1665
- /** Date the post was submitted for review. */
1666
- submittedDate?: Date | null;
1667
- /** Status indicating whether the submission was approved or rejected by the moderator. */
1668
- status?: ModerationStatusStatus;
1669
- /**
1670
- * Member ID of the person who approved or rejected the post.
1671
- * @format GUID
1672
- */
1673
- moderatedBy?: string | null;
1674
- /** Date the post was approved or rejected. */
1675
- moderationDate?: Date | null;
1676
- }
1677
- export declare enum ModerationStatusStatus {
1678
- UNKNOWN = "UNKNOWN",
1679
- APPROVED = "APPROVED",
1680
- REJECTED = "REJECTED"
1681
- }
1682
- export interface Media extends MediaMediaOneOf {
1683
- /** Wix Media details. */
1684
- wixMedia?: WixMedia;
1685
- /** Embed media details. */
1686
- embedMedia?: EmbedMedia;
1687
- /** Whether cover media is displayed. */
1688
- displayed?: boolean;
1689
- /** Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media. */
1690
- custom?: boolean;
1691
- /**
1692
- * Media alternative text.
1693
- * @minLength 1
1694
- * @maxLength 1000
1695
- */
1696
- altText?: string | null;
1697
- }
1698
- /** @oneof */
1699
- export interface MediaMediaOneOf {
1700
- /** Wix Media details. */
1701
- wixMedia?: WixMedia;
1702
- /** Embed media details. */
1703
- embedMedia?: EmbedMedia;
1704
- }
1705
- export interface WixMedia {
1706
- /** Image details. */
1707
- image?: string;
1708
- /** Video details. */
1709
- videoV2?: string;
1710
- }
1711
- export interface VideoResolution {
1712
- /** Video URL. */
1713
- url?: string;
1714
- /** Video height. */
1715
- height?: number;
1716
- /** Video width. */
1717
- width?: number;
1718
- /** Video format for example, mp4, hls. */
1719
- format?: string;
1720
- }
1721
- export interface EmbedMedia {
1722
- /** Thumbnail details. */
1723
- thumbnail?: EmbedThumbnail;
1724
- /** Video details. */
1725
- video?: EmbedVideo;
1726
- }
1727
- export interface EmbedThumbnail {
1728
- /**
1729
- * Thumbnail url.
1730
- * @maxLength 2000
1731
- */
1732
- url?: string;
1733
- /** Thumbnail width. */
1734
- width?: number;
1735
- /** Thumbnail height. */
1736
- height?: number;
1737
- }
1738
- export interface EmbedVideo {
1739
- /**
1740
- * Video url.
1741
- * @maxLength 2000
1742
- */
1743
- url?: string;
1744
- /** Video width. */
1745
- width?: number;
1746
- /** Video height. */
1747
- height?: number;
1748
- }
1749
- export interface PostTranslation {
1750
- /**
1751
- * Post ID.
1752
- * @format GUID
1753
- */
1754
- _id?: string;
1755
- /**
1756
- * Language the post is written in.
1757
- * @format LANGUAGE_TAG
1758
- */
1759
- language?: string | null;
1760
- /**
1761
- * Post slug. For example, 'post-slug'.
1762
- * @maxLength 100
1763
- */
1764
- slug?: string | null;
1765
- /** SEO data. */
1766
- seoData?: SeoSchema;
1767
- /** Post URL. */
1768
- url?: string;
1769
- }
1770
- export interface PostCategoriesUpdated {
1771
- /**
1772
- * ID of the post which counters were updated.
1773
- * @format GUID
1774
- */
1775
- postId?: string;
1776
- /**
1777
- * Current categories of the post.
1778
- * @maxSize 10
1779
- * @format GUID
1780
- */
1781
- categories?: string[];
1782
- /**
1783
- * Previous categories of the post.
1784
- * @maxSize 10
1785
- * @format GUID
1786
- */
1787
- previousCategories?: string[];
1788
- }
1789
- export interface PostTagsUpdated {
1790
- /**
1791
- * ID of the post which counters were updated.
1792
- * @format GUID
1793
- */
1794
- postId?: string;
1795
- /**
1796
- * Current tags of the post.
1797
- * @maxSize 30
1798
- * @format GUID
1799
- */
1800
- tags?: string[];
1801
- /**
1802
- * Previous tags of the post.
1803
- * @maxSize 30
1804
- * @format GUID
1805
- */
1806
- previousTags?: string[];
1807
- }
1808
- export interface ScheduledPostPublished {
1809
- /**
1810
- * ID of the scheduled post which was published.
1811
- * @format GUID
1812
- */
1813
- postId?: string;
1814
- }
1815
- /** Get Blog Publications Count Stats request */
1816
- export interface QueryPublicationsCountStatsRequest {
1817
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
1818
- rangeStart?: Date | null;
1819
- /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
1820
- rangeEnd?: Date | null;
1821
- /** Order of the returned results. */
1822
- order?: QueryPublicationsCountStatsRequestOrder;
1823
- /** Number of months to include in the response. */
1824
- months?: number;
1825
- /**
1826
- * Language filter
1827
- *
1828
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
1829
- * @format LANGUAGE_TAG
1830
- */
1831
- language?: string | null;
1832
- /**
1833
- * Timezone of the client.
1834
- * @minLength 3
1835
- * @maxLength 100
1836
- */
1837
- timeZone?: string | null;
1838
- }
1839
- export declare enum QueryPublicationsCountStatsRequestOrder {
1840
- UNKNOWN = "UNKNOWN",
1841
- OLDEST = "OLDEST",
1842
- NEWEST = "NEWEST"
1843
- }
1844
- /** Get Blog Publications Count Stats response */
1845
- export interface QueryPublicationsCountStatsResponse {
1846
- /** Chronologically ordered list of publications. */
1847
- stats?: PeriodPublicationsCount[];
1848
- }
1849
- /** Publications count for a specific time period */
1850
- export interface PeriodPublicationsCount {
1851
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
1852
- periodStart?: Date | null;
1853
- /** Number of posts published during this month. */
1854
- publicationsCount?: number;
1855
- }
1856
- /** Get Blog Post Count Stats request */
1857
- export interface QueryPostCountStatsRequest {
1858
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
1859
- rangeStart?: Date | null;
1860
- /**
1861
- * Order of returned results.
1862
- *
1863
- * - `OLDEST`: posts by date in ascending order.
1864
- * - `NEWEST`: posts by date in descending order.
1865
- *
1866
- * Default: `OLDEST`
1867
- */
1868
- order?: Order;
1869
- /** Number of months to include in response. */
1870
- months?: number;
1871
- /**
1872
- * Language filter.
1873
- *
1874
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
1875
- * Pass a language to only receive the period post count for that specified language.
1876
- * @format LANGUAGE_TAG
1877
- */
1878
- language?: string | null;
1879
- /**
1880
- * Time zone to use when calculating the start of the month.
1881
- *
1882
- * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
1883
- * @minLength 3
1884
- * @maxLength 100
1885
- */
1886
- timeZone?: string | null;
1887
- }
1888
- export declare enum Order {
1889
- UNKNOWN = "UNKNOWN",
1890
- OLDEST = "OLDEST",
1891
- NEWEST = "NEWEST"
1892
- }
1893
- /** Get Blog Post Count Stats response */
1894
- export interface QueryPostCountStatsResponse {
1895
- /** List of published post counts by month. */
1896
- stats?: PeriodPostCount[];
1897
- }
1898
- /** Post count for a specific time period */
1899
- export interface PeriodPostCount {
1900
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
1901
- periodStart?: Date | null;
1902
- /** Number of posts published during this month. */
1903
- postCount?: number;
1904
- }
1905
- export interface GetTotalPublicationsRequest {
1906
- /**
1907
- * Language filter
1908
- * @minLength 2
1909
- * @format LANGUAGE_TAG
1910
- */
1911
- language?: string | null;
1912
- }
1913
- export interface GetTotalPublicationsResponse {
1914
- /** Total amount of publications. */
1915
- total?: number;
1916
- }
1917
- export interface GetTotalPostsRequest {
1918
- /**
1919
- * Language filter.
1920
- *
1921
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
1922
- * Pass a language to receive the total amount of posts in that specified language.
1923
- * @format LANGUAGE_TAG
1924
- */
1925
- language?: string | null;
1926
- }
1927
- export interface GetTotalPostsResponse {
1928
- /** Total amount of published posts. */
1929
- total?: number;
1930
- }
1931
- export interface DomainEvent extends DomainEventBodyOneOf {
1932
- createdEvent?: EntityCreatedEvent;
1933
- updatedEvent?: EntityUpdatedEvent;
1934
- deletedEvent?: EntityDeletedEvent;
1935
- actionEvent?: ActionEvent;
1936
- /**
1937
- * Unique event ID.
1938
- * Allows clients to ignore duplicate webhooks.
1939
- */
1940
- _id?: string;
1941
- /**
1942
- * Assumes actions are also always typed to an entity_type
1943
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1944
- */
1945
- entityFqdn?: string;
1946
- /**
1947
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1948
- * This is although the created/updated/deleted notion is duplication of the oneof types
1949
- * Example: created/updated/deleted/started/completed/email_opened
1950
- */
1951
- slug?: string;
1952
- /** ID of the entity associated with the event. */
1953
- entityId?: string;
1954
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1955
- eventTime?: Date | null;
1956
- /**
1957
- * Whether the event was triggered as a result of a privacy regulation application
1958
- * (for example, GDPR).
1959
- */
1960
- triggeredByAnonymizeRequest?: boolean | null;
1961
- /** If present, indicates the action that triggered the event. */
1962
- originatedFrom?: string | null;
1963
- /**
1964
- * A sequence number defining the order of updates to the underlying entity.
1965
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
1966
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1967
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1968
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
1969
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1970
- */
1971
- entityEventSequence?: string | null;
1972
- }
1973
- /** @oneof */
1974
- export interface DomainEventBodyOneOf {
1975
- createdEvent?: EntityCreatedEvent;
1976
- updatedEvent?: EntityUpdatedEvent;
1977
- deletedEvent?: EntityDeletedEvent;
1978
- actionEvent?: ActionEvent;
1979
- }
1980
- export interface EntityCreatedEvent {
1981
- entity?: string;
1982
- }
1983
- export interface RestoreInfo {
1984
- deletedDate?: Date | null;
1985
- }
1986
- export interface EntityUpdatedEvent {
1987
- /**
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.
1989
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1990
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1991
- */
1992
- currentEntity?: string;
1993
- }
1994
- export interface EntityDeletedEvent {
1995
- /** Entity that was deleted */
1996
- deletedEntity?: string | null;
1997
- }
1998
- export interface ActionEvent {
1999
- body?: string;
2000
- }
2001
- export interface MessageEnvelope {
2002
- /**
2003
- * App instance ID.
2004
- * @format GUID
2005
- */
2006
- instanceId?: string | null;
2007
- /**
2008
- * Event type.
2009
- * @maxLength 150
2010
- */
2011
- eventType?: string;
2012
- /** The identification type and identity data. */
2013
- identity?: IdentificationData;
2014
- /** Stringify payload. */
2015
- data?: string;
2016
- }
2017
- export interface IdentificationData extends IdentificationDataIdOneOf {
2018
- /**
2019
- * ID of a site visitor that has not logged in to the site.
2020
- * @format GUID
2021
- */
2022
- anonymousVisitorId?: string;
2023
- /**
2024
- * ID of a site visitor that has logged in to the site.
2025
- * @format GUID
2026
- */
2027
- memberId?: string;
2028
- /**
2029
- * ID of a Wix user (site owner, contributor, etc.).
2030
- * @format GUID
2031
- */
2032
- wixUserId?: string;
2033
- /**
2034
- * ID of an app.
2035
- * @format GUID
2036
- */
2037
- appId?: string;
2038
- /** @readonly */
2039
- identityType?: WebhookIdentityType;
2040
- }
2041
- /** @oneof */
2042
- export interface IdentificationDataIdOneOf {
2043
- /**
2044
- * ID of a site visitor that has not logged in to the site.
2045
- * @format GUID
2046
- */
2047
- anonymousVisitorId?: string;
2048
- /**
2049
- * ID of a site visitor that has logged in to the site.
2050
- * @format GUID
2051
- */
2052
- memberId?: string;
2053
- /**
2054
- * ID of a Wix user (site owner, contributor, etc.).
2055
- * @format GUID
2056
- */
2057
- wixUserId?: string;
2058
- /**
2059
- * ID of an app.
2060
- * @format GUID
2061
- */
2062
- appId?: string;
2063
- }
2064
- export declare enum WebhookIdentityType {
2065
- UNKNOWN = "UNKNOWN",
2066
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2067
- MEMBER = "MEMBER",
2068
- WIX_USER = "WIX_USER",
2069
- APP = "APP"
2070
- }
2071
- export interface ListTemplatesRequest {
2072
- /**
2073
- * Filter post templates by given template category ids
2074
- * @maxSize 50
2075
- * @format GUID
2076
- */
2077
- categoryIds?: string[];
2078
- /**
2079
- * Filter post templates by provided language
2080
- * @format LANGUAGE_TAG
2081
- */
2082
- language?: string | null;
2083
- /** Returns post template categories when set to TRUE */
2084
- listTemplateCategories?: boolean;
2085
- /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2086
- sort?: GetPostTemplatesSort;
2087
- /** Pagination options. */
2088
- paging?: BlogPaging;
2089
- }
2090
- export declare enum GetPostTemplatesSort {
2091
- /** Sort by ascending publishing date. */
2092
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2093
- /** Sort by descending publishing date. */
2094
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2095
- }
2096
- export interface BlogPaging {
2097
- /**
2098
- * Number of items to skip in the current sort order.
2099
- *
2100
- *
2101
- * Default: `0`
2102
- */
2103
- offset?: number;
2104
- /**
2105
- * Number of items to return.
2106
- *
2107
- *
2108
- * Default:`50`
2109
- * @min 1
2110
- * @max 100
2111
- */
2112
- limit?: number;
2113
- /**
2114
- * Pointer to the next or previous page in the list of results.
2115
- * @maxLength 2000
2116
- */
2117
- cursor?: string | null;
2118
- }
2119
- export interface ListTemplatesResponse {
2120
- /** Available post templates */
2121
- postTemplates?: Post[];
2122
- /** Details on the paged set of posts templates returned. */
2123
- postTemplatesMetaData?: MetaData;
2124
- /** Post template categories. This value is returned empty unless asked explicitly */
2125
- templateCategories?: Category[];
2126
- }
2127
- export interface MetaData {
2128
- /** Number of items returned in this response. */
2129
- count?: number;
2130
- /** Requested offset. */
2131
- offset?: number;
2132
- /** Total number of items that match the query. */
2133
- total?: number;
2134
- /**
2135
- * Pointer to the next or previous page in the list of results.
2136
- * @maxLength 2000
2137
- */
2138
- cursor?: string | null;
2139
- }
2140
- export interface Category {
2141
- /**
2142
- * Category ID.
2143
- * @immutable
2144
- * @maxLength 38
2145
- */
2146
- _id?: string;
2147
- /**
2148
- * Category label. Displayed in the Category Menu.
2149
- * @maxLength 35
2150
- */
2151
- label?: string;
2152
- /**
2153
- * Number of posts in the category.
2154
- * @readonly
2155
- */
2156
- postCount?: number;
2157
- /**
2158
- * The `url` of the page that lists every post with the specified category.
2159
- * @readonly
2160
- */
2161
- url?: string;
2162
- /**
2163
- * Category description.
2164
- * @maxLength 500
2165
- */
2166
- description?: string | null;
2167
- /**
2168
- * Category title.
2169
- * @maxLength 200
2170
- * @deprecated Category title.
2171
- * @targetRemovalDate 2025-07-16
2172
- */
2173
- title?: string;
2174
- /**
2175
- * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
2176
- * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
2177
- *
2178
- * Default: `-1`
2179
- */
2180
- displayPosition?: number | null;
2181
- /**
2182
- * ID of the category's translations. All translations of a single category share the same `translationId`.
2183
- * @format GUID
2184
- */
2185
- translationId?: string | null;
2186
- /**
2187
- * Category language.
2188
- *
2189
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2190
- * @immutable
2191
- */
2192
- language?: string | null;
2193
- /**
2194
- * Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`.
2195
- * @maxLength 100
2196
- */
2197
- slug?: string;
2198
- /** SEO data. */
2199
- seoData?: SeoSchema;
2200
- /** Category cover image. */
2201
- coverImage?: string;
2202
- /**
2203
- * Date and time the Category was last updated.
2204
- * @readonly
2205
- */
2206
- _updatedDate?: Date | null;
2207
- }
2208
- export interface CategoryTranslation {
2209
- /**
2210
- * Category ID.
2211
- * @format GUID
2212
- */
2213
- _id?: string;
2214
- /**
2215
- * Label displayed in the categories menu on the site.
2216
- * @maxLength 100
2217
- */
2218
- label?: string | null;
2219
- /**
2220
- * Language of the category.
2221
- * @format LANGUAGE_TAG
2222
- */
2223
- language?: string | null;
2224
- /** URL of this category page. */
2225
- url?: string;
2226
- }
2227
- export interface GetTemplateRequest {
2228
- /**
2229
- * Post template id
2230
- * @format GUID
2231
- */
2232
- postTemplateId?: string;
2233
- }
2234
- export interface GetTemplateResponse {
2235
- /** Post template */
2236
- postTemplate?: Post;
2237
- }
2238
- export interface CreateDraftPostFromTemplateRequest {
2239
- /**
2240
- * Post template id
2241
- * @format GUID
2242
- */
2243
- postTemplateId?: string;
2244
- }
2245
- export interface CreateDraftPostFromTemplateResponse {
2246
- /** Created draft post */
2247
- draftPost?: DraftPost;
2248
- }
2249
- export interface DraftPost {
2250
- /**
2251
- * Draft post ID.
2252
- * @readonly
2253
- * @maxLength 38
2254
- */
2255
- _id?: string;
2256
- /**
2257
- * Draft post title.
2258
- * @maxLength 200
2259
- */
2260
- title?: string;
2261
- /**
2262
- * Draft post excerpt.
2263
- *
2264
- * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
2265
- * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
2266
- * @maxLength 500
2267
- */
2268
- excerpt?: string | null;
2269
- /** Whether the draft post is marked as featured. */
2270
- featured?: boolean | null;
2271
- /**
2272
- * Category IDs of the draft post.
2273
- * @maxSize 10
2274
- * @maxLength 38
2275
- */
2276
- categoryIds?: string[];
2277
- /**
2278
- * Draft post owner's member ID.
2279
- * @format GUID
2280
- */
2281
- memberId?: string | null;
2282
- /**
2283
- * Hashtags in the post.
2284
- * @maxSize 100
2285
- * @maxLength 100
2286
- */
2287
- hashtags?: string[];
2288
- /** Whether commenting on the draft post is enabled. */
2289
- commentingEnabled?: boolean | null;
2290
- /**
2291
- * Estimated reading time of the draft post (calculated automatically).
2292
- * @readonly
2293
- */
2294
- minutesToRead?: number;
2295
- /** Image placed at the top of the blog page. */
2296
- heroImage?: string;
2297
- /**
2298
- * Tag IDs the draft post is tagged with.
2299
- * @maxSize 30
2300
- * @maxLength 38
2301
- */
2302
- tagIds?: string[];
2303
- /**
2304
- * IDs of posts related to this draft post.
2305
- * @maxSize 3
2306
- * @maxLength 38
2307
- */
2308
- relatedPostIds?: string[];
2309
- /**
2310
- * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
2311
- * @maxSize 100
2312
- * @format GUID
2313
- */
2314
- pricingPlanIds?: string[];
2315
- /**
2316
- * ID of the draft post's translations.
2317
- *
2318
- * All translations of a single post share the same `translationId`.
2319
- * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
2320
- * @format GUID
2321
- */
2322
- translationId?: string | null;
2323
- /**
2324
- * Language the draft post is written in.
2325
- *
2326
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2327
- * @format LANGUAGE_TAG
2328
- */
2329
- language?: string | null;
2330
- /**
2331
- * Draft Post rich content.
2332
- *
2333
- * <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">
2334
- * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
2335
- * </widget>
2336
- */
2337
- richContent?: RichContent;
2338
- /**
2339
- * Status of the draft post.
2340
- * @readonly
2341
- */
2342
- status?: Status;
2343
- /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
2344
- moderationDetails?: ModerationDetails;
2345
- /**
2346
- * Indicates if there are changes made to the draft post that have not yet been published.
2347
- * @readonly
2348
- */
2349
- hasUnpublishedChanges?: boolean;
2350
- /**
2351
- * Date the draft post was last edited.
2352
- * @readonly
2353
- */
2354
- editedDate?: Date | null;
2355
- /**
2356
- * Date the draft post is scheduled to be published.
2357
- * @readonly
2358
- */
2359
- scheduledPublishDate?: Date | null;
2360
- /** Date the post was first published. */
2361
- firstPublishedDate?: Date | null;
2362
- /** SEO data. */
2363
- seoData?: SeoSchema;
2364
- /**
2365
- * Draft post URL preview. What the URL will look like once the post is published.
2366
- * @readonly
2367
- */
2368
- url?: string;
2369
- /**
2370
- * Date the draft post was first created.
2371
- * @readonly
2372
- */
2373
- _createdDate?: Date | null;
2374
- /**
2375
- * SEO slug.
2376
- * @maxLength 100
2377
- */
2378
- seoSlug?: string | null;
2379
- /** Post cover media. */
2380
- media?: Media;
2381
- /** Number of paragraphs to display in a paid content preview for non-paying users. */
2382
- previewTextParagraph?: number | null;
2383
- }
2384
- export declare enum Origin {
2385
- UNKNOWN = "UNKNOWN",
2386
- /** Changed by admin */
2387
- ADMIN = "ADMIN",
2388
- /** Categories were changed */
2389
- ADD_CATEGORIES = "ADD_CATEGORIES",
2390
- /** Saved automatically */
2391
- AUTO_SAVE = "AUTO_SAVE",
2392
- /** Copied from template */
2393
- COPY_TEMPLATE = "COPY_TEMPLATE",
2394
- /** Imported */
2395
- IMPORT = "IMPORT",
2396
- /** Imported in bulk */
2397
- IMPORT_BULK = "IMPORT_BULK",
2398
- /** Imported with html import */
2399
- IMPORT_HTML = "IMPORT_HTML",
2400
- /** Patch import */
2401
- IMPORT_PATCH = "IMPORT_PATCH",
2402
- /** Changed language */
2403
- LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
2404
- /** Saved manually */
2405
- MANUAL_SAVE = "MANUAL_SAVE",
2406
- /** Affected by migration */
2407
- MIGRATION = "MIGRATION",
2408
- /** Affected by moderation */
2409
- MODERATION = "MODERATION",
2410
- /** Moved to trash */
2411
- MOVE_TO_TRASH = "MOVE_TO_TRASH",
2412
- /** Pricing plans were changed */
2413
- PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
2414
- /** Was provisioned */
2415
- PROVISION = "PROVISION",
2416
- /** Was published */
2417
- PUBLISH = "PUBLISH",
2418
- /** Owner was reassigned */
2419
- REASSIGN_OWNER = "REASSIGN_OWNER",
2420
- /** Was reblogged */
2421
- REBLOG = "REBLOG",
2422
- /** Was restored */
2423
- RESTORE = "RESTORE",
2424
- /** Reverted to draft */
2425
- REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
2426
- /** Was translated */
2427
- TRANSLATION = "TRANSLATION",
2428
- /** Was unpublished */
2429
- UNPUBLISH = "UNPUBLISH",
2430
- /** Was unscheduled */
2431
- UNSCHEDULE = "UNSCHEDULE",
2432
- /** New edit session started which updated editing_session_id id */
2433
- NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
2434
- /** Was scheduled by Later */
2435
- SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
2436
- /** Was unscheduled by Later */
2437
- SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
2438
- /** Was published by Later */
2439
- SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
2440
- /** Was scheduled */
2441
- SCHEDULE = "SCHEDULE",
2442
- /** Was removed from moderation */
2443
- REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
2444
- /** Was rejected from moderation */
2445
- REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
2446
- /** Was approved in moderation */
2447
- APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
2448
- /** Tag was deleted */
2449
- DELETE_TAG = "DELETE_TAG",
2450
- /** Post was pinned */
2451
- PIN = "PIN",
2452
- /** Post was unpinned */
2453
- UNPIN = "UNPIN",
2454
- /** Saved automatically by AI tool. */
2455
- AI_AUTO_SAVE = "AI_AUTO_SAVE"
2456
- }
2457
- export declare enum Status {
2458
- UNKNOWN = "UNKNOWN",
2459
- /** Status indicating the draft post is published. */
2460
- PUBLISHED = "PUBLISHED",
2461
- /** Status indicating the draft post is unpublished. */
2462
- UNPUBLISHED = "UNPUBLISHED",
2463
- /** Status indicating the draft post is scheduled for publication. */
2464
- SCHEDULED = "SCHEDULED",
2465
- /** Status indicating the draft post is deleted. */
2466
- DELETED = "DELETED",
2467
- /** Status indicating the draft post is in review. */
2468
- IN_REVIEW = "IN_REVIEW"
2469
- }
2470
- export interface DraftPostTranslation {
2471
- /**
2472
- * Post ID.
2473
- * @format GUID
2474
- */
2475
- _id?: string;
2476
- /** Post status. */
2477
- status?: Status;
2478
- /**
2479
- * Language the post is written in.
2480
- * @format LANGUAGE_TAG
2481
- */
2482
- language?: string | null;
2483
- /**
2484
- * Post slug. For example, 'post-slug'.
2485
- * @maxLength 100
2486
- */
2487
- slug?: string | null;
2488
- /** SEO data. */
2489
- seoData?: SeoSchema;
2490
- /** Post URL. */
2491
- url?: string;
2492
- }
2493
- export interface GetTotalLikesPerMemberRequest {
2494
- /**
2495
- * Member ID.
2496
- * @format GUID
2497
- */
2498
- memberId?: string;
2499
- }
2500
- export interface GetTotalLikesPerMemberResponse {
2501
- /** The total number of likes of the member. */
2502
- total?: number;
2503
- }
2504
- export interface PostLiked extends PostLikedInitiatorOneOf {
2505
- /**
2506
- * Member ID of person who liked the post (only returned when the member was logged in when liking the post).
2507
- * @format GUID
2508
- */
2509
- memberId?: string | null;
2510
- /**
2511
- * Visitor ID of person who liked the post when they are not logged in.
2512
- * @format GUID
2513
- */
2514
- anonymousVisitorId?: string | null;
2515
- /**
2516
- * ID of the liked post.
2517
- * @format GUID
2518
- */
2519
- postId?: string;
2520
- }
2521
- /** @oneof */
2522
- export interface PostLikedInitiatorOneOf {
2523
- /**
2524
- * Member ID of person who liked the post (only returned when the member was logged in when liking the post).
2525
- * @format GUID
2526
- */
2527
- memberId?: string | null;
2528
- /**
2529
- * Visitor ID of person who liked the post when they are not logged in.
2530
- * @format GUID
2531
- */
2532
- anonymousVisitorId?: string | null;
2533
- }
2534
- export interface PostUnliked extends PostUnlikedInitiatorOneOf {
2535
- /**
2536
- * Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
2537
- * @format GUID
2538
- */
2539
- memberId?: string | null;
2540
- /**
2541
- * Visitor ID of person who unliked the post when they are not logged in.
2542
- * @format GUID
2543
- */
2544
- anonymousVisitorId?: string | null;
2545
- /**
2546
- * ID of the unliked post.
2547
- * @format GUID
2548
- */
2549
- postId?: string;
2550
- }
2551
- /** @oneof */
2552
- export interface PostUnlikedInitiatorOneOf {
2553
- /**
2554
- * Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
2555
- * @format GUID
2556
- */
2557
- memberId?: string | null;
2558
- /**
2559
- * Visitor ID of person who unliked the post when they are not logged in.
2560
- * @format GUID
2561
- */
2562
- anonymousVisitorId?: string | null;
2563
- }
2564
- export interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
2565
- /**
2566
- * Member ID of person who triggered the counter update
2567
- * @format GUID
2568
- */
2569
- memberId?: string | null;
2570
- /**
2571
- * Visitor ID if person that liked the post is not logged in
2572
- * @format GUID
2573
- */
2574
- anonymousVisitorId?: string | null;
2575
- /**
2576
- * ID of the post which counters were updated.
2577
- * @format GUID
2578
- */
2579
- postId?: string;
2580
- /** Field of the updated counter. */
2581
- updatedCounterField?: Field;
2582
- /** New counter value. */
2583
- counter?: number;
2584
- }
2585
- /** @oneof */
2586
- export interface PostCountersUpdatedInitiatorOneOf {
2587
- /**
2588
- * Member ID of person who triggered the counter update
2589
- * @format GUID
2590
- */
2591
- memberId?: string | null;
2592
- /**
2593
- * Visitor ID if person that liked the post is not logged in
2594
- * @format GUID
2595
- */
2596
- anonymousVisitorId?: string | null;
2597
- }
2598
- export declare enum Field {
2599
- /** Undefined field. */
2600
- UNKNOWN = "UNKNOWN",
2601
- /** Total comments field. */
2602
- TOTAL_COMMENTS = "TOTAL_COMMENTS",
2603
- /** Like count field. */
2604
- LIKE_COUNT = "LIKE_COUNT",
2605
- /** View count field. */
2606
- VIEW_COUNT = "VIEW_COUNT",
2607
- /** Rating count field. */
2608
- RATING_COUNT = "RATING_COUNT"
2609
- }
2610
- export interface PostOwnerChanged {
2611
- }
2612
- export interface InitialPostsCopied {
2613
- /** Number of posts copied. */
2614
- count?: number;
2615
- }
2616
- export interface GetPostRequest {
2617
- /**
2618
- * Post ID.
2619
- * @minLength 1
2620
- * @maxLength 38
2621
- */
2622
- postId: string;
2623
- /**
2624
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2625
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
2626
- * only the post’s base fields are returned.
2627
- * @maxSize 20
2628
- */
2629
- fieldsets?: PostFieldField[];
2630
- }
2631
- export declare enum PostFieldField {
2632
- UNKNOWN = "UNKNOWN",
2633
- /** Includes post URL when present. */
2634
- URL = "URL",
2635
- /** Includes post content text string when present. */
2636
- CONTENT_TEXT = "CONTENT_TEXT",
2637
- /** Includes post metrics when present. */
2638
- METRICS = "METRICS",
2639
- /** Includes SEO data. */
2640
- SEO = "SEO",
2641
- /** Includes post owner's contact ID. */
2642
- CONTACT_ID = "CONTACT_ID",
2643
- /** Includes post rich content. */
2644
- RICH_CONTENT = "RICH_CONTENT",
2645
- /** Includes post reference ID field. */
2646
- REFERENCE_ID = "REFERENCE_ID"
2647
- }
2648
- export interface GetPostResponse {
2649
- /** Retrieved post info. */
2650
- post?: Post;
2651
- }
2652
- export interface GetPostBySlugRequest {
2653
- /**
2654
- * Slug of the post to retrieve.
2655
- * @minLength 1
2656
- * @maxLength 200
2657
- */
2658
- slug: string;
2659
- /**
2660
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2661
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
2662
- * only the post’s base fields are returned.
2663
- * @maxSize 20
2664
- */
2665
- fieldsets?: PostFieldField[];
2666
- }
2667
- export interface GetPostBySlugResponse {
2668
- /** Retrieved post info. */
2669
- post?: Post;
2670
- }
2671
- export interface ListPostsRequest {
2672
- /**
2673
- * Whether to return only featured posts.
2674
- *
2675
- * Default: `false`
2676
- */
2677
- featured?: boolean;
2678
- /**
2679
- * Hashtag filter.
2680
- *
2681
- * Pass an array of hashtags to return only posts containing any of the provided hashtags.
2682
- * If omitted, all posts with or without hashtags are returned.
2683
- * @maxSize 100
2684
- * @maxLength 100
2685
- */
2686
- hashtags?: string[];
2687
- /**
2688
- * Category filter.
2689
- *
2690
- * Pass an array of category IDs to return only posts with any of the provided categories.
2691
- * If omitted, all posts with or without associated categories are returned.
2692
- * @maxSize 50
2693
- * @maxLength 38
2694
- */
2695
- categoryIds?: string[];
2696
- /**
2697
- * Tag filter.
2698
- *
2699
- * Pass an array of tag IDs to return only posts with any of the provided tags.
2700
- * If omitted, all posts with or without tags are returned.
2701
- * @maxSize 50
2702
- * @maxLength 38
2703
- */
2704
- tagIds?: string[];
2705
- /**
2706
- * Sorting options.
2707
- *
2708
- * Default: `FEED`
2709
- */
2710
- sort?: GetPostsSort;
2711
- /** Pagination options. */
2712
- paging?: BlogPaging;
2713
- /**
2714
- * Language filter.
2715
- *
2716
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2717
- * Pass a language to only receive posts that are in that language.
2718
- * If omitted, posts in all languages are returned.
2719
- * @format LANGUAGE_TAG
2720
- */
2721
- language?: string | null;
2722
- /**
2723
- * Post owner's member ID.
2724
- * @format GUID
2725
- */
2726
- memberId?: string | null;
2727
- /**
2728
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2729
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
2730
- * only the post’s base fields are returned.
2731
- * @maxSize 20
2732
- */
2733
- fieldsets?: PostFieldField[];
2734
- }
2735
- export declare enum GetPostsSort {
2736
- /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
2737
- FEED = "FEED",
2738
- /** Ordered by `firstPublishedDate` in ascending order. */
2739
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2740
- /** Ordered by `firstPublishedDate` in descending order. */
2741
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
2742
- /** Ordered by total number of views in descending order. */
2743
- VIEW_COUNT = "VIEW_COUNT",
2744
- /** Ordered by total number of likes in descending order. */
2745
- LIKE_COUNT = "LIKE_COUNT",
2746
- /** Ordered by `title` in ascening order. */
2747
- TITLE_ASC = "TITLE_ASC",
2748
- /** Ordered by `title` in descending order. */
2749
- TITLE_DESC = "TITLE_DESC"
2750
- }
2751
- export interface ListPostsResponse {
2752
- /** List of retrieved posts. */
2753
- posts?: Post[];
2754
- /** Details on the paged set of results returned. */
2755
- metaData?: MetaData;
2756
- }
2757
- export interface QueryPostsRequest {
2758
- /** Query options. */
2759
- query?: PlatformQuery;
2760
- /**
2761
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2762
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
2763
- * only the post’s base fields are returned.
2764
- * @maxSize 20
2765
- */
2766
- fieldsets?: PostFieldField[];
2767
- }
2768
- export interface Sorting {
2769
- /**
2770
- * Name of the field to sort by.
2771
- * @maxLength 512
2772
- */
2773
- fieldName?: string;
2774
- /** Sort order. */
2775
- order?: SortOrder;
2776
- }
2777
- export declare enum SortOrder {
2778
- ASC = "ASC",
2779
- DESC = "DESC"
2780
- }
2781
- export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
2782
- /** Paging options to limit and skip the number of items. */
2783
- paging?: Paging;
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`. */
2785
- cursorPaging?: CursorPaging;
2786
- /**
2787
- * Filter object in the following format:
2788
- * `"filter" : {
2789
- * "fieldName1": "value1",
2790
- * "fieldName2":{"$operator":"value2"}
2791
- * }`
2792
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2793
- */
2794
- filter?: Record<string, any> | null;
2795
- /**
2796
- * Sort object in the following format:
2797
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2798
- * @maxSize 3
2799
- */
2800
- sort?: Sorting[];
2801
- }
2802
- /** @oneof */
2803
- export interface PlatformQueryPagingMethodOneOf {
2804
- /** Paging options to limit and skip the number of items. */
2805
- paging?: Paging;
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`. */
2807
- cursorPaging?: CursorPaging;
2808
- }
2809
- export interface Paging {
2810
- /**
2811
- * Number of items to load.
2812
- * @max 100
2813
- */
2814
- limit?: number | null;
2815
- /** Number of items to skip in the current sort order. */
2816
- offset?: number | null;
2817
- }
2818
- export interface CursorPaging {
2819
- /**
2820
- * Number of items to load.
2821
- * @max 100
2822
- */
2823
- limit?: number | null;
2824
- /**
2825
- * Pointer to the next or previous page in the list of results.
2826
- *
2827
- * You can get the relevant cursor token
2828
- * from the `pagingMetadata` object in the previous call's response.
2829
- * Not relevant for the first request.
2830
- * @maxLength 2000
2831
- */
2832
- cursor?: string | null;
2833
- }
2834
- export interface QueryPostsResponse {
2835
- /** List of retrieved posts. */
2836
- posts?: Post[];
2837
- /** Details on the paged set of results returned. */
2838
- pagingMetadata?: PagingMetadataV2;
2839
- }
2840
- export interface PagingMetadataV2 {
2841
- /** Number of items returned in the response. */
2842
- count?: number | null;
2843
- /** Offset that was requested. */
2844
- offset?: number | null;
2845
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
2846
- total?: number | null;
2847
- /** Flag that indicates the server failed to calculate the `total` field. */
2848
- tooManyToCount?: boolean | null;
2849
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
2850
- cursors?: Cursors;
2851
- }
2852
- export interface Cursors {
2853
- /**
2854
- * Cursor pointing to next page in the list of results.
2855
- * @maxLength 2000
2856
- */
2857
- next?: string | null;
2858
- /**
2859
- * Cursor pointing to previous page in the list of results.
2860
- * @maxLength 2000
2861
- */
2862
- prev?: string | null;
2863
- }
2864
- export interface GetPostMetricsRequest {
2865
- /**
2866
- * Post ID to retrieve metrics for.
2867
- * @minLength 1
2868
- * @maxLength 38
2869
- */
2870
- postId: string;
2871
- }
2872
- export interface GetPostMetricsResponse {
2873
- /** Retrieved post metrics. */
2874
- metrics?: Metrics;
2875
- }
2876
- export interface BulkGetPostMetricsRequest {
2877
- /**
2878
- * Post IDs.
2879
- * @maxSize 500
2880
- * @maxLength 38
2881
- */
2882
- postIds?: string[];
2883
- }
2884
- export interface BulkGetPostMetricsResponse {
2885
- /** Map of post.id to metrics */
2886
- metrics?: Record<string, Metrics>;
2887
- }
2888
- export interface ViewPostRequest {
2889
- /**
2890
- * Post ID.
2891
- * @minLength 1
2892
- * @maxLength 38
2893
- */
2894
- postId?: string;
2895
- }
2896
- export interface ViewPostResponse {
2897
- /** Total number of post views */
2898
- views?: number;
2899
- }
2900
- export interface LikePostRequest {
2901
- /**
2902
- * Post ID.
2903
- * @minLength 1
2904
- * @format GUID
2905
- */
2906
- postId?: string;
2907
- /**
2908
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2909
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
2910
- * only the post’s base fields are returned.
2911
- * @maxSize 20
2912
- */
2913
- fieldsets?: PostFieldField[];
2914
- }
2915
- export interface LikePostResponse {
2916
- /** Post info. */
2917
- post?: Post;
2918
- }
2919
- export interface UnlikePostRequest {
2920
- /**
2921
- * Post ID.
2922
- * @minLength 1
2923
- * @format GUID
2924
- */
2925
- postId?: string;
2926
- /**
2927
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2928
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
2929
- * only the post’s base fields are returned.
2930
- * @maxSize 20
2931
- */
2932
- fieldsets?: PostFieldField[];
2933
- }
2934
- export interface UnlikePostResponse {
2935
- /** Post info. */
2936
- post?: Post;
2937
- }
2938
- export interface PinPostRequest {
2939
- /**
2940
- * Post ID.
2941
- * @minLength 1
2942
- * @format GUID
2943
- */
2944
- postId?: string;
2945
- /**
2946
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2947
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
2948
- * only the post’s base fields are returned.
2949
- * @maxSize 20
2950
- */
2951
- fieldsets?: PostFieldField[];
2952
- }
2953
- export interface PinPostResponse {
2954
- /** Post info. */
2955
- post?: Post;
2956
- }
2957
- export interface UnpinPostRequest {
2958
- /**
2959
- * Post ID.
2960
- * @minLength 1
2961
- * @format GUID
2962
- */
2963
- postId?: string;
2964
- /**
2965
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2966
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
2967
- * only the post’s base fields are returned.
2968
- * @maxSize 20
2969
- */
2970
- fieldsets?: PostFieldField[];
2971
- }
2972
- export interface UnpinPostResponse {
2973
- /** Post info. */
2974
- post?: Post;
2975
- }
2976
- export interface ListPostsArchiveRequest {
2977
- /**
2978
- * Month
2979
- * @min 1
2980
- * @max 12
2981
- */
2982
- month?: number | null;
2983
- /**
2984
- * Year
2985
- * @min 2000
2986
- * @max 3000
2987
- */
2988
- year?: number;
2989
- /**
2990
- * Time zone
2991
- * @maxLength 50
2992
- */
2993
- timeZone?: string | null;
2994
- /** Pagination options. */
2995
- paging?: BlogPaging;
2996
- /**
2997
- * Language filter.
2998
- *
2999
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3000
- * Pass a language to only receive posts that are in that language.
3001
- * If omitted, posts in all languages are returned.
3002
- * @format LANGUAGE_TAG
3003
- */
3004
- language?: string | null;
3005
- /**
3006
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3007
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3008
- * only the post’s base fields are returned.
3009
- * @maxSize 20
3010
- */
3011
- fieldsets?: PostFieldField[];
3012
- }
3013
- export interface ListPostsArchiveResponse {
3014
- /** List of posts. */
3015
- posts?: Post[];
3016
- /** Details on the paged set of results returned. */
3017
- metaData?: MetaData;
3018
- /** Details on the paged set of results returned. */
3019
- pagingMetadata?: PagingMetadataV2;
3020
- }
3021
- export interface BulkGetPostReactionsRequest {
3022
- /**
3023
- * Post IDs.
3024
- * @maxSize 500
3025
- * @maxLength 38
3026
- */
3027
- postIds?: string[];
3028
- }
3029
- export interface BulkGetPostReactionsResponse {
3030
- /** Map of post.id to reactions */
3031
- reactionsMap?: Record<string, Reactions>;
3032
- }
3033
- export interface Reactions {
3034
- /**
3035
- * Is post liked by the current user
3036
- * @readonly
3037
- */
3038
- liked?: boolean;
3039
- }
3040
- export interface ListDemoPostsRequest {
3041
- /**
3042
- * Whether to return only featured posts.
3043
- *
3044
- * Default: `false`
3045
- */
3046
- featured?: boolean;
3047
- /**
3048
- * Hashtag filter.
3049
- *
3050
- * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3051
- * If omitted, all posts with or without hashtags are returned.
3052
- * @maxSize 100
3053
- * @maxLength 100
3054
- */
3055
- hashtags?: string[];
3056
- /**
3057
- * Category filter.
3058
- *
3059
- * Pass an array of category IDs to return only posts with any of the provided categories.
3060
- * If omitted, all posts with or without associated categories are returned.
3061
- * @maxSize 50
3062
- * @format GUID
3063
- */
3064
- categoryIds?: string[];
3065
- /**
3066
- * Tag filter.
3067
- *
3068
- * Pass an array of tag IDs to return only posts with any of the provided tags.
3069
- * If omitted, all posts with or without tags are returned.
3070
- * @maxSize 50
3071
- * @format GUID
3072
- */
3073
- tagIds?: string[];
3074
- /**
3075
- * Sorting options.
3076
- *
3077
- * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
3078
- * - `VIEW_COUNT`: Ordered by total number of views in descending order.
3079
- * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
3080
- * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
3081
- * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
3082
- * - `TITLE_ASC`: Ordered by `title` in ascening order.
3083
- * - `TITLE_DESC`: Ordered by `title` in descending order.
3084
- * - `RATING`: reserved for internal use.
3085
- *
3086
- * Default: `FEED`
3087
- */
3088
- sort?: GetPostsSort;
3089
- /** Pagination options. */
3090
- paging?: BlogPaging;
3091
- /**
3092
- * __Deprecated.__ Use `fieldsets` instead.
3093
- * This parameter will be removed on June 30, 2023.
3094
- *
3095
- * List of post fields to be included in the response.
3096
- * @maxSize 20
3097
- * @deprecated __Deprecated.__ Use `fieldsets` instead.
3098
- * This parameter will be removed on June 30, 2023.
3099
- *
3100
- * List of post fields to be included in the response.
3101
- * @replacedBy fieldsets
3102
- * @targetRemovalDate 2024-06-30
3103
- */
3104
- fieldsToInclude?: PostFieldField[];
3105
- /**
3106
- * Language filter.
3107
- *
3108
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3109
- * Pass a language to only receive posts that are in that language.
3110
- * If omitted, posts in all languages are returned.
3111
- * @format LANGUAGE_TAG
3112
- */
3113
- language?: string | null;
3114
- /**
3115
- * Post owner's member ID.
3116
- * @format GUID
3117
- */
3118
- memberId?: string | null;
3119
- /**
3120
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3121
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3122
- * only the post’s base fields are returned.
3123
- * @maxSize 20
3124
- */
3125
- fieldsets?: PostFieldField[];
3126
- }
3127
- export interface ListDemoPostsResponse {
3128
- /** List of posts. */
3129
- posts?: Post[];
3130
- /** Details on the paged set of results returned. */
3131
- metaData?: MetaData;
3132
- }
3133
- export interface ConvertDraftJsToRichContentRequest {
3134
- /** DraftJs content to convert to Rich content. */
3135
- content?: Record<string, any> | null;
3136
- }
3137
- export interface ConvertDraftJsToRichContentResponse {
3138
- /**
3139
- * Rich content converted from DraftJs content.
3140
- * @maxLength 2000000
3141
- */
3142
- richContent?: string;
3143
- }
3144
- export interface ConvertRichContentToDraftJsRequest {
3145
- /**
3146
- * Rich content to convert to DraftJs content.
3147
- * @maxLength 2000000
3148
- */
3149
- richContent?: string;
3150
- }
3151
- export interface ConvertRichContentToDraftJsResponse {
3152
- /** DraftJs content converted from Rich content. */
3153
- content?: Record<string, any> | null;
3154
- }
3155
- export interface OldBlogMigratedEvent {
3156
- /**
3157
- * Instance id of new version of blog
3158
- * @format GUID
3159
- */
3160
- newBlogInstanceId?: string;
3161
- /**
3162
- * Instance id of old version of blog
3163
- * @format GUID
3164
- */
3165
- oldBlogInstanceId?: string;
3166
- }
3167
- interface PeriodPostCountNonNullableFields {
3168
- postCount: number;
3169
- }
3170
- export interface QueryPostCountStatsResponseNonNullableFields {
3171
- stats: PeriodPostCountNonNullableFields[];
3172
- }
3173
- export interface GetTotalPostsResponseNonNullableFields {
3174
- total: number;
3175
- }
3176
- interface CoverMediaNonNullableFields {
3177
- image: string;
3178
- video: string;
3179
- enabled: boolean;
3180
- displayed: boolean;
3181
- custom: boolean;
3182
- }
3183
- interface PostCountInfoNonNullableFields {
3184
- comments: number;
3185
- likes: number;
3186
- views: number;
3187
- }
3188
- interface MetricsNonNullableFields {
3189
- comments: number;
3190
- likes: number;
3191
- views: number;
3192
- totalRatings: number;
3193
- averageRating: number;
3194
- }
3195
- interface TagNonNullableFields {
3196
- type: string;
3197
- children: string;
3198
- custom: boolean;
3199
- disabled: boolean;
3200
- }
3201
- interface KeywordNonNullableFields {
3202
- term: string;
3203
- isMain: boolean;
3204
- }
3205
- interface SettingsNonNullableFields {
3206
- preventAutoRedirect: boolean;
3207
- keywords: KeywordNonNullableFields[];
3208
- }
3209
- interface SeoSchemaNonNullableFields {
3210
- tags: TagNonNullableFields[];
3211
- settings?: SettingsNonNullableFields;
3212
- }
3213
- interface PluginContainerDataWidthNonNullableFields {
3214
- size: WidthType;
3215
- }
3216
- interface PluginContainerDataNonNullableFields {
3217
- width?: PluginContainerDataWidthNonNullableFields;
3218
- alignment: PluginContainerDataAlignment;
3219
- }
3220
- interface LinkNonNullableFields {
3221
- url: string;
3222
- anchor: string;
3223
- target: Target;
3224
- }
3225
- interface ButtonDataNonNullableFields {
3226
- containerData?: PluginContainerDataNonNullableFields;
3227
- type: Type;
3228
- link?: LinkNonNullableFields;
3229
- }
3230
- interface TextStyleNonNullableFields {
3231
- textAlignment: TextAlignment;
3232
- }
3233
- interface CodeBlockDataNonNullableFields {
3234
- textStyle?: TextStyleNonNullableFields;
3235
- }
3236
- interface DividerDataNonNullableFields {
3237
- containerData?: PluginContainerDataNonNullableFields;
3238
- lineStyle: LineStyle;
3239
- width: Width;
3240
- alignment: Alignment;
3241
- }
3242
- interface PDFSettingsNonNullableFields {
3243
- viewMode: ViewMode;
3244
- }
3245
- interface FileDataNonNullableFields {
3246
- containerData?: PluginContainerDataNonNullableFields;
3247
- pdfSettings?: PDFSettingsNonNullableFields;
3248
- }
3249
- interface ImageNonNullableFields {
3250
- link?: LinkNonNullableFields;
3251
- }
3252
- interface ItemNonNullableFields {
3253
- image?: ImageNonNullableFields;
3254
- }
3255
- interface LayoutNonNullableFields {
3256
- type: LayoutType;
3257
- orientation: Orientation;
3258
- }
3259
- interface ItemStyleNonNullableFields {
3260
- crop: Crop;
3261
- }
3262
- interface ThumbnailsNonNullableFields {
3263
- placement: ThumbnailsAlignment;
3264
- }
3265
- interface GalleryOptionsNonNullableFields {
3266
- layout?: LayoutNonNullableFields;
3267
- item?: ItemStyleNonNullableFields;
3268
- thumbnails?: ThumbnailsNonNullableFields;
3269
- }
3270
- interface GalleryDataNonNullableFields {
3271
- containerData?: PluginContainerDataNonNullableFields;
3272
- items: ItemNonNullableFields[];
3273
- options?: GalleryOptionsNonNullableFields;
3274
- }
3275
- interface GIFDataNonNullableFields {
3276
- containerData?: PluginContainerDataNonNullableFields;
3277
- height: number;
3278
- width: number;
3279
- gifType: GIFType;
3280
- }
3281
- interface HeadingDataNonNullableFields {
3282
- level: number;
3283
- textStyle?: TextStyleNonNullableFields;
3284
- }
3285
- interface HTMLDataNonNullableFields {
3286
- url: string;
3287
- html: string;
3288
- containerData?: PluginContainerDataNonNullableFields;
3289
- source: Source;
3290
- }
3291
- interface ImageDataNonNullableFields {
3292
- containerData?: PluginContainerDataNonNullableFields;
3293
- link?: LinkNonNullableFields;
3294
- }
3295
- interface LinkPreviewDataNonNullableFields {
3296
- containerData?: PluginContainerDataNonNullableFields;
3297
- link?: LinkNonNullableFields;
3298
- }
3299
- interface MapSettingsNonNullableFields {
3300
- mapType: MapType;
3301
- }
3302
- interface MapDataNonNullableFields {
3303
- containerData?: PluginContainerDataNonNullableFields;
3304
- mapSettings?: MapSettingsNonNullableFields;
3305
- }
3306
- interface ParagraphDataNonNullableFields {
3307
- textStyle?: TextStyleNonNullableFields;
3308
- }
3309
- interface PermissionsNonNullableFields {
3310
- view: ViewRole;
3311
- vote: VoteRole;
3312
- }
3313
- interface PollSettingsNonNullableFields {
3314
- permissions?: PermissionsNonNullableFields;
3315
- }
3316
- interface PollNonNullableFields {
3317
- settings?: PollSettingsNonNullableFields;
3318
- }
3319
- interface PollLayoutNonNullableFields {
3320
- type: PollLayoutType;
3321
- direction: PollLayoutDirection;
3322
- }
3323
- interface PollDataLayoutNonNullableFields {
3324
- poll?: PollLayoutNonNullableFields;
3325
- }
3326
- interface BackgroundNonNullableFields {
3327
- type: BackgroundType;
3328
- }
3329
- interface PollDesignNonNullableFields {
3330
- background?: BackgroundNonNullableFields;
3331
- }
3332
- interface DesignNonNullableFields {
3333
- poll?: PollDesignNonNullableFields;
3334
- }
3335
- interface PollDataNonNullableFields {
3336
- containerData?: PluginContainerDataNonNullableFields;
3337
- poll?: PollNonNullableFields;
3338
- layout?: PollDataLayoutNonNullableFields;
3339
- design?: DesignNonNullableFields;
3340
- }
3341
- interface AnchorDataNonNullableFields {
3342
- anchor: string;
3343
- }
3344
- interface LinkDataNonNullableFields {
3345
- link?: LinkNonNullableFields;
3346
- }
3347
- interface MentionDataNonNullableFields {
3348
- name: string;
3349
- slug: string;
3350
- }
3351
- interface FontSizeDataNonNullableFields {
3352
- unit: FontType;
3353
- }
3354
- interface DecorationNonNullableFields {
3355
- anchorData?: AnchorDataNonNullableFields;
3356
- linkData?: LinkDataNonNullableFields;
3357
- mentionData?: MentionDataNonNullableFields;
3358
- fontSizeData?: FontSizeDataNonNullableFields;
3359
- type: DecorationType;
3360
- }
3361
- interface TextDataNonNullableFields {
3362
- text: string;
3363
- decorations: DecorationNonNullableFields[];
3364
- }
3365
- interface AppEmbedDataNonNullableFields {
3366
- type: AppType;
3367
- }
3368
- interface VideoDataNonNullableFields {
3369
- containerData?: PluginContainerDataNonNullableFields;
3370
- }
3371
- interface EmbedDataNonNullableFields {
3372
- containerData?: PluginContainerDataNonNullableFields;
3373
- }
3374
- interface CollapsibleListDataNonNullableFields {
3375
- containerData?: PluginContainerDataNonNullableFields;
3376
- initialExpandedItems: InitialExpandedItems;
3377
- direction: Direction;
3378
- }
3379
- interface DimensionsNonNullableFields {
3380
- colsWidthRatio: number[];
3381
- rowsHeight: number[];
3382
- colsMinWidth: number[];
3383
- }
3384
- interface TableDataNonNullableFields {
3385
- containerData?: PluginContainerDataNonNullableFields;
3386
- dimensions?: DimensionsNonNullableFields;
3387
- }
3388
- interface CellStyleNonNullableFields {
3389
- verticalAlignment: VerticalAlignment;
3390
- }
3391
- interface TableCellDataNonNullableFields {
3392
- cellStyle?: CellStyleNonNullableFields;
3393
- }
3394
- interface AudioDataNonNullableFields {
3395
- containerData?: PluginContainerDataNonNullableFields;
3396
- }
3397
- interface OrderedListDataNonNullableFields {
3398
- indentation: number;
3399
- }
3400
- interface BulletedListDataNonNullableFields {
3401
- indentation: number;
3402
- }
3403
- interface BlockquoteDataNonNullableFields {
3404
- indentation: number;
3405
- }
3406
- interface CaptionDataNonNullableFields {
3407
- textStyle?: TextStyleNonNullableFields;
3408
- }
3409
- interface NodeNonNullableFields {
3410
- buttonData?: ButtonDataNonNullableFields;
3411
- codeBlockData?: CodeBlockDataNonNullableFields;
3412
- dividerData?: DividerDataNonNullableFields;
3413
- fileData?: FileDataNonNullableFields;
3414
- galleryData?: GalleryDataNonNullableFields;
3415
- gifData?: GIFDataNonNullableFields;
3416
- headingData?: HeadingDataNonNullableFields;
3417
- htmlData?: HTMLDataNonNullableFields;
3418
- imageData?: ImageDataNonNullableFields;
3419
- linkPreviewData?: LinkPreviewDataNonNullableFields;
3420
- mapData?: MapDataNonNullableFields;
3421
- paragraphData?: ParagraphDataNonNullableFields;
3422
- pollData?: PollDataNonNullableFields;
3423
- textData?: TextDataNonNullableFields;
3424
- appEmbedData?: AppEmbedDataNonNullableFields;
3425
- videoData?: VideoDataNonNullableFields;
3426
- embedData?: EmbedDataNonNullableFields;
3427
- collapsibleListData?: CollapsibleListDataNonNullableFields;
3428
- tableData?: TableDataNonNullableFields;
3429
- tableCellData?: TableCellDataNonNullableFields;
3430
- audioData?: AudioDataNonNullableFields;
3431
- orderedListData?: OrderedListDataNonNullableFields;
3432
- bulletedListData?: BulletedListDataNonNullableFields;
3433
- blockquoteData?: BlockquoteDataNonNullableFields;
3434
- captionData?: CaptionDataNonNullableFields;
3435
- type: NodeType;
3436
- _id: string;
3437
- nodes: NodeNonNullableFields[];
3438
- }
3439
- interface MetadataNonNullableFields {
3440
- version: number;
3441
- }
3442
- interface TextNodeStyleNonNullableFields {
3443
- decorations: DecorationNonNullableFields[];
3444
- }
3445
- interface DocumentStyleNonNullableFields {
3446
- headerOne?: TextNodeStyleNonNullableFields;
3447
- headerTwo?: TextNodeStyleNonNullableFields;
3448
- headerThree?: TextNodeStyleNonNullableFields;
3449
- headerFour?: TextNodeStyleNonNullableFields;
3450
- headerFive?: TextNodeStyleNonNullableFields;
3451
- headerSix?: TextNodeStyleNonNullableFields;
3452
- paragraph?: TextNodeStyleNonNullableFields;
3453
- blockquote?: TextNodeStyleNonNullableFields;
3454
- codeBlock?: TextNodeStyleNonNullableFields;
3455
- }
3456
- interface RichContentNonNullableFields {
3457
- nodes: NodeNonNullableFields[];
3458
- metadata?: MetadataNonNullableFields;
3459
- documentStyle?: DocumentStyleNonNullableFields;
3460
- }
3461
- interface ModerationDetailsNonNullableFields {
3462
- submittedBy: string;
3463
- status: ModerationStatusStatus;
3464
- }
3465
- interface WixMediaNonNullableFields {
3466
- image: string;
3467
- videoV2: string;
3468
- }
3469
- interface EmbedThumbnailNonNullableFields {
3470
- url: string;
3471
- width: number;
3472
- height: number;
3473
- }
3474
- interface EmbedVideoNonNullableFields {
3475
- url: string;
3476
- width: number;
3477
- height: number;
3478
- }
3479
- interface EmbedMediaNonNullableFields {
3480
- thumbnail?: EmbedThumbnailNonNullableFields;
3481
- video?: EmbedVideoNonNullableFields;
3482
- }
3483
- interface MediaNonNullableFields {
3484
- wixMedia?: WixMediaNonNullableFields;
3485
- embedMedia?: EmbedMediaNonNullableFields;
3486
- displayed: boolean;
3487
- custom: boolean;
3488
- }
3489
- interface PostTranslationNonNullableFields {
3490
- _id: string;
3491
- seoData?: SeoSchemaNonNullableFields;
3492
- url: string;
3493
- }
3494
- export interface PostNonNullableFields {
3495
- _id: string;
3496
- title: string;
3497
- excerpt: string;
3498
- url: string;
3499
- slug: string;
3500
- featured: boolean;
3501
- pinned: boolean;
3502
- categoryIds: string[];
3503
- coverMedia?: CoverMediaNonNullableFields;
3504
- memberId: string;
3505
- hashtags: string[];
3506
- commentingEnabled: boolean;
3507
- postCountInfo?: PostCountInfoNonNullableFields;
3508
- minutesToRead: number;
3509
- heroImage: string;
3510
- tagIds: string[];
3511
- relatedPostIds: string[];
3512
- pricingPlanIds: string[];
3513
- metrics?: MetricsNonNullableFields;
3514
- seoData?: SeoSchemaNonNullableFields;
3515
- richContent?: RichContentNonNullableFields;
3516
- preview: boolean;
3517
- moderationDetails?: ModerationDetailsNonNullableFields;
3518
- media?: MediaNonNullableFields;
3519
- hasUnpublishedChanges: boolean;
3520
- translations: PostTranslationNonNullableFields[];
3521
- customExcerpt: boolean;
3522
- internalCategoryIds: string[];
3523
- internalRelatedPostIds: string[];
3524
- }
3525
- export interface GetPostResponseNonNullableFields {
3526
- post?: PostNonNullableFields;
3527
- }
3528
- export interface GetPostBySlugResponseNonNullableFields {
3529
- post?: PostNonNullableFields;
3530
- }
3531
- interface MetaDataNonNullableFields {
3532
- count: number;
3533
- offset: number;
3534
- total: number;
3535
- }
3536
- export interface ListPostsResponseNonNullableFields {
3537
- posts: PostNonNullableFields[];
3538
- metaData?: MetaDataNonNullableFields;
3539
- }
3540
- export interface QueryPostsResponseNonNullableFields {
3541
- posts: PostNonNullableFields[];
3542
- metaData?: MetaDataNonNullableFields;
3543
- }
3544
- export interface GetPostMetricsResponseNonNullableFields {
3545
- metrics?: MetricsNonNullableFields;
3546
- }
3547
- export interface BaseEventMetadata {
3548
- /**
3549
- * App instance ID.
3550
- * @format GUID
3551
- */
3552
- instanceId?: string | null;
3553
- /**
3554
- * Event type.
3555
- * @maxLength 150
3556
- */
3557
- eventType?: string;
3558
- /** The identification type and identity data. */
3559
- identity?: IdentificationData;
3560
- }
3561
- export interface EventMetadata extends BaseEventMetadata {
3562
- /**
3563
- * Unique event ID.
3564
- * Allows clients to ignore duplicate webhooks.
3565
- */
3566
- _id?: string;
3567
- /**
3568
- * Assumes actions are also always typed to an entity_type
3569
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
3570
- */
3571
- entityFqdn?: string;
3572
- /**
3573
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
3574
- * This is although the created/updated/deleted notion is duplication of the oneof types
3575
- * Example: created/updated/deleted/started/completed/email_opened
3576
- */
3577
- slug?: string;
3578
- /** ID of the entity associated with the event. */
3579
- entityId?: string;
3580
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
3581
- eventTime?: Date | null;
3582
- /**
3583
- * Whether the event was triggered as a result of a privacy regulation application
3584
- * (for example, GDPR).
3585
- */
3586
- triggeredByAnonymizeRequest?: boolean | null;
3587
- /** If present, indicates the action that triggered the event. */
3588
- originatedFrom?: string | null;
3589
- /**
3590
- * A sequence number defining the order of updates to the underlying entity.
3591
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
3592
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
3593
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
3594
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
3595
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
3596
- */
3597
- entityEventSequence?: string | null;
3598
- }
3599
- export interface PostCreatedEnvelope {
3600
- entity: Post;
3601
- metadata: EventMetadata;
3602
- }
3603
- /**
3604
- * Triggered when a post is created.
3605
- * @permissionScope Read Blog
3606
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
3607
- * @permissionScope Manage Blog
3608
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
3609
- * @permissionScope Read Draft Blog Posts
3610
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
3611
- * @permissionId BLOG.READ-PUBLICATION
3612
- * @webhook
3613
- * @eventType wix.blog.v3.post_created
3614
- * @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
3615
- * @slug created
3616
- */
3617
- export declare function onPostCreated(handler: (event: PostCreatedEnvelope) => void | Promise<void>): void;
3618
- export interface PostDeletedEnvelope {
3619
- entity: Post;
3620
- metadata: EventMetadata;
3621
- }
3622
- /**
3623
- * Triggered when a post is deleted.
3624
- * @permissionScope Read Blog
3625
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
3626
- * @permissionScope Manage Blog
3627
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
3628
- * @permissionScope Read Draft Blog Posts
3629
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
3630
- * @permissionId BLOG.READ-PUBLICATION
3631
- * @webhook
3632
- * @eventType wix.blog.v3.post_deleted
3633
- * @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
3634
- * @slug deleted
3635
- */
3636
- export declare function onPostDeleted(handler: (event: PostDeletedEnvelope) => void | Promise<void>): void;
3637
- export interface PostLikedEnvelope {
3638
- data: PostLiked;
3639
- metadata: EventMetadata;
3640
- }
3641
- /**
3642
- * Triggered when a post is liked.
3643
- * @permissionScope Read Blog
3644
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
3645
- * @permissionScope Manage Blog
3646
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
3647
- * @permissionScope Read Draft Blog Posts
3648
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
3649
- * @permissionId BLOG.READ-PUBLICATION
3650
- * @webhook
3651
- * @eventType wix.blog.v3.post_liked
3652
- * @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
3653
- * @slug liked
3654
- */
3655
- export declare function onPostLiked(handler: (event: PostLikedEnvelope) => void | Promise<void>): void;
3656
- export interface PostUnlikedEnvelope {
3657
- data: PostUnliked;
3658
- metadata: EventMetadata;
3659
- }
3660
- /**
3661
- * Triggered when a post is unliked.
3662
- * @permissionScope Read Blog
3663
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
3664
- * @permissionScope Manage Blog
3665
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
3666
- * @permissionScope Read Draft Blog Posts
3667
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
3668
- * @permissionId BLOG.READ-PUBLICATION
3669
- * @webhook
3670
- * @eventType wix.blog.v3.post_unliked
3671
- * @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
3672
- * @slug unliked
3673
- */
3674
- export declare function onPostUnliked(handler: (event: PostUnlikedEnvelope) => void | Promise<void>): void;
3675
- export interface PostUpdatedEnvelope {
3676
- entity: Post;
3677
- metadata: EventMetadata;
3678
- }
3679
- /**
3680
- * Triggered when a post is updated.
3681
- * @permissionScope Read Blog
3682
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
3683
- * @permissionScope Manage Blog
3684
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
3685
- * @permissionScope Read Draft Blog Posts
3686
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
3687
- * @permissionId BLOG.READ-PUBLICATION
3688
- * @webhook
3689
- * @eventType wix.blog.v3.post_updated
3690
- * @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
3691
- * @slug updated
3692
- */
3693
- export declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | Promise<void>): void;
3694
- /**
3695
- * Retrieves the number of published posts per month within a specified time range.
3696
- *
3697
- * The time range is set using the `rangeStart` and `months` properties.
3698
- * The time range always starts on the 1st day of the month set in `rangeStart` and
3699
- * includes the number of `months` following `rangeStart`.
3700
- * For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
3701
- * the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range always ends on the last day of the month.
3702
- * > Note: If there are no published posts in a month within the time range, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
3703
- * @public
3704
- * @documentationMaturity preview
3705
- * @permissionId BLOG.READ-PUBLICATION
3706
- * @permissionScope Read Blog
3707
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
3708
- * @permissionScope Manage Blog
3709
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
3710
- * @permissionScope Read Draft Blog Posts
3711
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
3712
- * @applicableIdentity APP
3713
- * @applicableIdentity VISITOR
3714
- * @returns Get Blog Post Count Stats response
3715
- * @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.QueryPostCountStats
3716
- */
3717
- export declare function queryPostCountStats(options?: QueryPostCountStatsOptions): Promise<QueryPostCountStatsResponse & QueryPostCountStatsResponseNonNullableFields>;
3718
- export interface QueryPostCountStatsOptions {
3719
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3720
- rangeStart?: Date | null;
3721
- /**
3722
- * Order of returned results.
3723
- *
3724
- * - `OLDEST`: posts by date in ascending order.
3725
- * - `NEWEST`: posts by date in descending order.
3726
- *
3727
- * Default: `OLDEST`
3728
- */
3729
- order?: Order;
3730
- /** Number of months to include in response. */
3731
- months?: number;
3732
- /**
3733
- * Language filter.
3734
- *
3735
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3736
- * Pass a language to only receive the period post count for that specified language.
3737
- * @format LANGUAGE_TAG
3738
- */
3739
- language?: string | null;
3740
- /**
3741
- * Time zone to use when calculating the start of the month.
3742
- *
3743
- * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
3744
- * @minLength 3
3745
- * @maxLength 100
3746
- */
3747
- timeZone?: string | null;
3748
- }
3749
- /**
3750
- * Retrieves the total amount of published posts of the blog.
3751
- * @public
3752
- * @documentationMaturity preview
3753
- * @permissionId BLOG.READ-PUBLICATION
3754
- * @permissionScope Read Blog
3755
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
3756
- * @permissionScope Manage Blog
3757
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
3758
- * @permissionScope Read Draft Blog Posts
3759
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
3760
- * @applicableIdentity APP
3761
- * @applicableIdentity VISITOR
3762
- * @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
3763
- */
3764
- export declare function getTotalPosts(options?: GetTotalPostsOptions): Promise<GetTotalPostsResponse & GetTotalPostsResponseNonNullableFields>;
3765
- export interface GetTotalPostsOptions {
3766
- /**
3767
- * Language filter.
3768
- *
3769
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3770
- * Pass a language to receive the total amount of posts in that specified language.
3771
- * @format LANGUAGE_TAG
3772
- */
3773
- language?: string | null;
3774
- }
3775
- /**
3776
- * Retrieves a post by the specified ID.
3777
- * @param postId - Post ID.
3778
- * @public
3779
- * @requiredField postId
3780
- * @permissionId BLOG.READ-PUBLICATION
3781
- * @permissionScope Read Blog
3782
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
3783
- * @permissionScope Manage Blog
3784
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
3785
- * @permissionScope Read Draft Blog Posts
3786
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
3787
- * @applicableIdentity APP
3788
- * @applicableIdentity VISITOR
3789
- * @returns Retrieved post info.
3790
- * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
3791
- */
3792
- export declare function getPost(postId: string, options?: GetPostOptions): Promise<Post & PostNonNullableFields>;
3793
- export interface GetPostOptions {
3794
- /**
3795
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3796
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3797
- * only the post’s base fields are returned.
3798
- * @maxSize 20
3799
- */
3800
- fieldsets?: PostFieldField[];
3801
- }
3802
- /**
3803
- * Retrieves a post with the provided slug.
3804
- *
3805
- * The slug is the end of a post's URL that refers to a specific post.
3806
- * For example, if a post's URL is `https:/example.com/blog/post/my-post-slug`,
3807
- * the slug is `my-post-slug`. The slug is case-sensitive, and is generally derived from the post title,
3808
- * unless specified otherwise.
3809
- * @param slug - Slug of the post to retrieve.
3810
- * @public
3811
- * @requiredField slug
3812
- * @permissionId BLOG.READ-PUBLICATION
3813
- * @permissionScope Read Blog
3814
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
3815
- * @permissionScope Manage Blog
3816
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
3817
- * @permissionScope Read Draft Blog Posts
3818
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
3819
- * @applicableIdentity APP
3820
- * @applicableIdentity VISITOR
3821
- * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
3822
- */
3823
- export declare function getPostBySlug(slug: string, options?: GetPostBySlugOptions): Promise<GetPostBySlugResponse & GetPostBySlugResponseNonNullableFields>;
3824
- export interface GetPostBySlugOptions {
3825
- /**
3826
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3827
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3828
- * only the post’s base fields are returned.
3829
- * @maxSize 20
3830
- */
3831
- fieldsets?: PostFieldField[];
3832
- }
3833
- /**
3834
- * Retrieves a list of up to 100 published posts per request.
3835
- *
3836
- * List Posts runs with these defaults, which you can override:
3837
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
3838
- * - `paging.limit` is `50`.
3839
- * - `paging.offset` is `0`.
3840
- * @public
3841
- * @permissionId BLOG.READ-PUBLICATION
3842
- * @permissionScope Read Blog
3843
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
3844
- * @permissionScope Manage Blog
3845
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
3846
- * @permissionScope Read Draft Blog Posts
3847
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
3848
- * @applicableIdentity APP
3849
- * @applicableIdentity VISITOR
3850
- * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
3851
- */
3852
- export declare function listPosts(options?: ListPostsOptions): Promise<ListPostsResponse & ListPostsResponseNonNullableFields>;
3853
- export interface ListPostsOptions {
3854
- /**
3855
- * Whether to return only featured posts.
3856
- *
3857
- * Default: `false`
3858
- */
3859
- featured?: boolean;
3860
- /**
3861
- * Hashtag filter.
3862
- *
3863
- * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3864
- * If omitted, all posts with or without hashtags are returned.
3865
- * @maxSize 100
3866
- * @maxLength 100
3867
- */
3868
- hashtags?: string[];
3869
- /**
3870
- * Category filter.
3871
- *
3872
- * Pass an array of category IDs to return only posts with any of the provided categories.
3873
- * If omitted, all posts with or without associated categories are returned.
3874
- * @maxSize 50
3875
- * @maxLength 38
3876
- */
3877
- categoryIds?: string[];
3878
- /**
3879
- * Tag filter.
3880
- *
3881
- * Pass an array of tag IDs to return only posts with any of the provided tags.
3882
- * If omitted, all posts with or without tags are returned.
3883
- * @maxSize 50
3884
- * @maxLength 38
3885
- */
3886
- tagIds?: string[];
3887
- /**
3888
- * Sorting options.
3889
- *
3890
- * Default: `FEED`
3891
- */
3892
- sort?: GetPostsSort;
3893
- /** Pagination options. */
3894
- paging?: BlogPaging;
3895
- /**
3896
- * Language filter.
3897
- *
3898
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3899
- * Pass a language to only receive posts that are in that language.
3900
- * If omitted, posts in all languages are returned.
3901
- * @format LANGUAGE_TAG
3902
- */
3903
- language?: string | null;
3904
- /**
3905
- * Post owner's member ID.
3906
- * @format GUID
3907
- */
3908
- memberId?: string | null;
3909
- /**
3910
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3911
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3912
- * only the post’s base fields are returned.
3913
- * @maxSize 20
3914
- */
3915
- fieldsets?: PostFieldField[];
3916
- }
3917
- /**
3918
- * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
3919
- *
3920
- * Query Posts runs with these defaults, which you can override:
3921
- * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
3922
- * - `paging.limit` is `50`.
3923
- * - `paging.offset` is `0`.
3924
- *
3925
- * For field support for filters and sorting, see
3926
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
3927
- *
3928
- * To learn about working with _Query_ endpoints, see
3929
- * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
3930
- * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
3931
- * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
3932
- * For a detailed list of supported filters and sortable fields, see
3933
- * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
3934
- * @public
3935
- * @permissionScope Read Blog
3936
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
3937
- * @permissionScope Manage Blog
3938
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
3939
- * @permissionScope Read Draft Blog Posts
3940
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
3941
- * @permissionId BLOG.READ-PUBLICATION
3942
- * @applicableIdentity APP
3943
- * @applicableIdentity VISITOR
3944
- * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
3945
- */
3946
- export declare function queryPosts(options?: QueryPostsOptions): PostsQueryBuilder;
3947
- export interface QueryPostsOptions {
3948
- /**
3949
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3950
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3951
- * only the post’s base fields are returned.
3952
- * @maxSize 20
3953
- */
3954
- fieldsets?: PostFieldField[] | undefined;
3955
- }
3956
- interface QueryCursorResult {
3957
- cursors: Cursors;
3958
- hasNext: () => boolean;
3959
- hasPrev: () => boolean;
3960
- length: number;
3961
- pageSize: number;
3962
- }
3963
- export interface PostsQueryResult extends QueryCursorResult {
3964
- items: Post[];
3965
- query: PostsQueryBuilder;
3966
- next: () => Promise<PostsQueryResult>;
3967
- prev: () => Promise<PostsQueryResult>;
3968
- }
3969
- export interface PostsQueryBuilder {
3970
- /** @param propertyName - Property whose value is compared with `value`.
3971
- * @param value - Value to compare against.
3972
- */
3973
- 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;
3974
- /** @param propertyName - Property whose value is compared with `value`.
3975
- * @param value - Value to compare against.
3976
- */
3977
- 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;
3978
- /** @param propertyName - Property whose value is compared with `value`.
3979
- * @param value - Value to compare against.
3980
- */
3981
- ge: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
3982
- /** @param propertyName - Property whose value is compared with `value`.
3983
- * @param value - Value to compare against.
3984
- */
3985
- gt: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
3986
- /** @param propertyName - Property whose value is compared with `value`.
3987
- * @param value - Value to compare against.
3988
- */
3989
- le: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
3990
- /** @param propertyName - Property whose value is compared with `value`.
3991
- * @param value - Value to compare against.
3992
- */
3993
- lt: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
3994
- /** @param propertyName - Property whose value is compared with `string`.
3995
- * @param string - String to compare against. Case-insensitive.
3996
- */
3997
- startsWith: (propertyName: 'title', value: string) => PostsQueryBuilder;
3998
- /** @param propertyName - Property whose value is compared with `values`.
3999
- * @param values - List of values to compare against.
4000
- */
4001
- hasSome: (propertyName: '_id' | 'title' | 'slug' | 'categoryIds' | 'memberId' | 'hashtags' | 'tagIds' | 'pricingPlanIds' | 'language', value: any[]) => PostsQueryBuilder;
4002
- /** @param propertyName - Property whose value is compared with `values`.
4003
- * @param values - List of values to compare against.
4004
- */
4005
- hasAll: (propertyName: 'categoryIds' | 'hashtags' | 'tagIds' | 'pricingPlanIds', value: any[]) => PostsQueryBuilder;
4006
- in: (propertyName: '_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'translationId' | 'language' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
4007
- exists: (propertyName: 'title' | 'translationId' | 'language', value: boolean) => PostsQueryBuilder;
4008
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
4009
- ascending: (...propertyNames: Array<'_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'commentingEnabled' | 'metrics.comments' | 'metrics.likes' | 'metrics.views'>) => PostsQueryBuilder;
4010
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
4011
- descending: (...propertyNames: Array<'_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'commentingEnabled' | 'metrics.comments' | 'metrics.likes' | 'metrics.views'>) => PostsQueryBuilder;
4012
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
4013
- limit: (limit: number) => PostsQueryBuilder;
4014
- /** @param cursor - A pointer to specific record */
4015
- skipTo: (cursor: string) => PostsQueryBuilder;
4016
- find: () => Promise<PostsQueryResult>;
4017
- }
4018
- /**
4019
- * Retrieves a post's metrics.
4020
- *
4021
- * A post's metrics include the comments, likes, and views the post receives.
4022
- * @param postId - Post ID to retrieve metrics for.
4023
- * @public
4024
- * @requiredField postId
4025
- * @permissionId BLOG.READ-PUBLICATION
4026
- * @permissionScope Read Blog
4027
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
4028
- * @permissionScope Manage Blog
4029
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
4030
- * @permissionScope Read Draft Blog Posts
4031
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
4032
- * @applicableIdentity APP
4033
- * @applicableIdentity VISITOR
4034
- * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostMetrics
4035
- */
4036
- export declare function getPostMetrics(postId: string): Promise<GetPostMetricsResponse & GetPostMetricsResponseNonNullableFields>;
4037
- export {};