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