@wix/auto_sdk_blog_posts 1.0.21 → 1.0.22

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/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/blog-v3-post-posts.context.d.ts +37 -0
  11. package/build/cjs/src/blog-v3-post-posts.context.js +82 -0
  12. package/build/cjs/src/blog-v3-post-posts.context.js.map +1 -0
  13. package/build/cjs/src/blog-v3-post-posts.http.d.ts +61 -0
  14. package/build/cjs/src/blog-v3-post-posts.http.js +894 -0
  15. package/build/cjs/src/blog-v3-post-posts.http.js.map +1 -0
  16. package/build/cjs/src/blog-v3-post-posts.meta.d.ts +25 -0
  17. package/build/cjs/src/blog-v3-post-posts.meta.js +161 -0
  18. package/build/cjs/src/blog-v3-post-posts.meta.js.map +1 -0
  19. package/build/cjs/src/blog-v3-post-posts.public.d.ts +106 -0
  20. package/build/cjs/src/blog-v3-post-posts.public.js +320 -0
  21. package/build/cjs/src/blog-v3-post-posts.public.js.map +1 -0
  22. package/build/cjs/src/blog-v3-post-posts.types.d.ts +3231 -0
  23. package/build/cjs/src/blog-v3-post-posts.types.js +485 -0
  24. package/build/cjs/src/blog-v3-post-posts.types.js.map +1 -0
  25. package/build/{blog-v3-post-posts.universal-CEsWp0Fx.d.mts → cjs/src/blog-v3-post-posts.universal.d.ts} +494 -256
  26. package/build/cjs/src/blog-v3-post-posts.universal.js +962 -0
  27. package/build/cjs/src/blog-v3-post-posts.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/blog-v3-post-posts.context.d.ts +37 -0
  39. package/build/es/src/blog-v3-post-posts.context.js +37 -0
  40. package/build/es/src/blog-v3-post-posts.context.js.map +1 -0
  41. package/build/es/src/blog-v3-post-posts.http.d.ts +61 -0
  42. package/build/es/src/blog-v3-post-posts.http.js +884 -0
  43. package/build/es/src/blog-v3-post-posts.http.js.map +1 -0
  44. package/build/es/src/blog-v3-post-posts.meta.d.ts +25 -0
  45. package/build/es/src/blog-v3-post-posts.meta.js +128 -0
  46. package/build/es/src/blog-v3-post-posts.meta.js.map +1 -0
  47. package/build/es/src/blog-v3-post-posts.public.d.ts +106 -0
  48. package/build/es/src/blog-v3-post-posts.public.js +268 -0
  49. package/build/es/src/blog-v3-post-posts.public.js.map +1 -0
  50. package/build/es/src/blog-v3-post-posts.types.d.ts +3231 -0
  51. package/build/es/src/blog-v3-post-posts.types.js +482 -0
  52. package/build/es/src/blog-v3-post-posts.types.js.map +1 -0
  53. package/build/{blog-v3-post-posts.universal-CEsWp0Fx.d.ts → es/src/blog-v3-post-posts.universal.d.ts} +494 -256
  54. package/build/es/src/blog-v3-post-posts.universal.js +929 -0
  55. package/build/es/src/blog-v3-post-posts.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/blog-v3-post-posts.context.d.ts +37 -0
  66. package/build/internal/cjs/src/blog-v3-post-posts.context.js +82 -0
  67. package/build/internal/cjs/src/blog-v3-post-posts.context.js.map +1 -0
  68. package/build/internal/cjs/src/blog-v3-post-posts.http.d.ts +61 -0
  69. package/build/internal/cjs/src/blog-v3-post-posts.http.js +894 -0
  70. package/build/internal/cjs/src/blog-v3-post-posts.http.js.map +1 -0
  71. package/build/internal/cjs/src/blog-v3-post-posts.meta.d.ts +25 -0
  72. package/build/internal/cjs/src/blog-v3-post-posts.meta.js +161 -0
  73. package/build/internal/cjs/src/blog-v3-post-posts.meta.js.map +1 -0
  74. package/build/internal/cjs/src/blog-v3-post-posts.public.d.ts +106 -0
  75. package/build/internal/cjs/src/blog-v3-post-posts.public.js +320 -0
  76. package/build/internal/cjs/src/blog-v3-post-posts.public.js.map +1 -0
  77. package/build/internal/cjs/src/blog-v3-post-posts.types.d.ts +3231 -0
  78. package/build/internal/cjs/src/blog-v3-post-posts.types.js +485 -0
  79. package/build/internal/cjs/src/blog-v3-post-posts.types.js.map +1 -0
  80. package/build/internal/{blog-v3-post-posts.universal-nU7XoyIE.d.ts → cjs/src/blog-v3-post-posts.universal.d.ts} +494 -256
  81. package/build/internal/cjs/src/blog-v3-post-posts.universal.js +962 -0
  82. package/build/internal/cjs/src/blog-v3-post-posts.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/blog-v3-post-posts.context.d.ts +37 -0
  93. package/build/internal/es/src/blog-v3-post-posts.context.js +37 -0
  94. package/build/internal/es/src/blog-v3-post-posts.context.js.map +1 -0
  95. package/build/internal/es/src/blog-v3-post-posts.http.d.ts +61 -0
  96. package/build/internal/es/src/blog-v3-post-posts.http.js +884 -0
  97. package/build/internal/es/src/blog-v3-post-posts.http.js.map +1 -0
  98. package/build/internal/es/src/blog-v3-post-posts.meta.d.ts +25 -0
  99. package/build/internal/es/src/blog-v3-post-posts.meta.js +128 -0
  100. package/build/internal/es/src/blog-v3-post-posts.meta.js.map +1 -0
  101. package/build/internal/es/src/blog-v3-post-posts.public.d.ts +106 -0
  102. package/build/internal/es/src/blog-v3-post-posts.public.js +268 -0
  103. package/build/internal/es/src/blog-v3-post-posts.public.js.map +1 -0
  104. package/build/internal/es/src/blog-v3-post-posts.types.d.ts +3231 -0
  105. package/build/internal/es/src/blog-v3-post-posts.types.js +482 -0
  106. package/build/internal/es/src/blog-v3-post-posts.types.js.map +1 -0
  107. package/build/internal/{blog-v3-post-posts.universal-nU7XoyIE.d.mts → es/src/blog-v3-post-posts.universal.d.ts} +494 -256
  108. package/build/internal/es/src/blog-v3-post-posts.universal.js +929 -0
  109. package/build/internal/es/src/blog-v3-post-posts.universal.js.map +1 -0
  110. package/package.json +11 -12
  111. package/build/index.d.mts +0 -130
  112. package/build/index.d.ts +0 -130
  113. package/build/index.js +0 -1975
  114. package/build/index.js.map +0 -1
  115. package/build/index.mjs +0 -1899
  116. package/build/index.mjs.map +0 -1
  117. package/build/internal/index.d.mts +0 -130
  118. package/build/internal/index.d.ts +0 -130
  119. package/build/internal/index.js +0 -1975
  120. package/build/internal/index.js.map +0 -1
  121. package/build/internal/index.mjs +0 -1899
  122. package/build/internal/index.mjs.map +0 -1
  123. package/build/internal/meta.d.mts +0 -2094
  124. package/build/internal/meta.d.ts +0 -2094
  125. package/build/internal/meta.js +0 -1002
  126. package/build/internal/meta.js.map +0 -1
  127. package/build/internal/meta.mjs +0 -969
  128. package/build/internal/meta.mjs.map +0 -1
  129. package/build/meta.d.mts +0 -2094
  130. package/build/meta.d.ts +0 -2094
  131. package/build/meta.js +0 -1002
  132. package/build/meta.js.map +0 -1
  133. package/build/meta.mjs +0 -969
  134. package/build/meta.mjs.map +0 -1
@@ -1,2094 +0,0 @@
1
- import { bS as QueryPostCountStatsRequest$1, a as QueryPostCountStatsResponse$1, bW as GetTotalPostsRequest$1, b as GetTotalPostsResponse$1, cr as GetPostRequest$1, d as GetPostResponse$1, cs as GetPostBySlugRequest$1, f as GetPostBySlugResponse$1, ct as ListPostsRequest$1, g as ListPostsResponse$1, cu as QueryPostsRequest$1, cA as QueryPostsResponse$1, cD as GetPostMetricsRequest$1, i as GetPostMetricsResponse$1 } from './blog-v3-post-posts.universal-nU7XoyIE.mjs';
2
-
3
- interface Post {
4
- /**
5
- * Post ID.
6
- * @readonly
7
- * @format GUID
8
- */
9
- id?: string;
10
- /**
11
- * Post title.
12
- * @maxLength 100
13
- */
14
- title?: string;
15
- /**
16
- * Post excerpt.
17
- * Can be selected by a site contributor. By default, it is extracted from the content text's first characters.
18
- *
19
- * Max: 500 characters
20
- * @maxLength 500
21
- */
22
- excerpt?: string;
23
- /**
24
- * The post's content in plain text.
25
- * @readonly
26
- * @maxLength 400000
27
- */
28
- contentText?: string | null;
29
- /** Date the post was first published. */
30
- firstPublishedDate?: Date | null;
31
- /**
32
- * Date the post was last published.
33
- * @readonly
34
- */
35
- lastPublishedDate?: Date | null;
36
- /** Post URL. */
37
- url?: PageUrl;
38
- /**
39
- * Post slug. For example, `'post-slug'`.
40
- * @maxLength 100
41
- */
42
- slug?: string;
43
- /** Whether the post is marked as featured. */
44
- featured?: boolean;
45
- /** Whether the post is pinned. If `true`, the post is placed at the top of the post list. */
46
- pinned?: boolean;
47
- /**
48
- * [Category IDs](https://dev.wix.com/docs/rest/business-solutions/blog/category/introduction) of the post.
49
- * @maxSize 10
50
- * @format GUID
51
- */
52
- categoryIds?: string[];
53
- /**
54
- * __Deprecated.__ Use `media` instead.
55
- * This property will be removed on June 30, 2023.
56
- *
57
- * Post cover media.
58
- * @deprecated
59
- * @replacedBy media
60
- * @targetRemovalDate 2024-06-30
61
- */
62
- coverMedia?: CoverMedia;
63
- /**
64
- * Post owner's [member ID](https://dev.wix.com/api/rest/members).
65
- * @format GUID
66
- */
67
- memberId?: string;
68
- /**
69
- * Hashtags in the post.
70
- * @readonly
71
- * @maxSize 100
72
- * @maxLength 100
73
- */
74
- hashtags?: string[];
75
- /** Whether commenting on the post is enabled. */
76
- commentingEnabled?: boolean;
77
- /** Estimated reading time (calculated automatically). */
78
- minutesToRead?: number;
79
- /** Image placed at the top of the blog page. */
80
- heroImage?: Image;
81
- /**
82
- * IDs of [tags](https://dev.wix.com/docs/rest/business-solutions/blog/tags) the post is tagged with.
83
- * @readonly
84
- * @maxSize 30
85
- * @format GUID
86
- */
87
- tagIds?: string[];
88
- /**
89
- * IDs of posts related to the post.
90
- * @readonly
91
- * @maxSize 3
92
- * @format GUID
93
- */
94
- relatedPostIds?: string[];
95
- /**
96
- * [Pricing plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans). Only relevant if a post is assigned to a specific pricing plan.
97
- * @readonly
98
- * @maxSize 100
99
- * @format GUID
100
- */
101
- pricingPlanIds?: string[];
102
- /**
103
- * ID of the translations of this post. All translations of a single post share the same `translationId`.
104
- * @format GUID
105
- */
106
- translationId?: string | null;
107
- /**
108
- * Language the post is written in.
109
- *
110
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
111
- * @format LANGUAGE_TAG
112
- */
113
- language?: string | null;
114
- /** SEO data. */
115
- seoData?: SeoSchema;
116
- /**
117
- * Reserved for internal use.
118
- * @readonly
119
- * @maxLength 400000
120
- */
121
- content?: string | null;
122
- /**
123
- * Post owner's [contact ID](https://dev.wix.com/api/rest/contacts).
124
- * @format GUID
125
- */
126
- contactId?: string | null;
127
- /**
128
- * Post rich content
129
- *
130
- * <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">
131
- * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
132
- * </widget>
133
- * @readonly
134
- */
135
- richContent?: RichContent;
136
- /**
137
- * Whether the returned content is a preview of premium content. Defaults to `false`.
138
- * A preview displays a limited number of paragraphs of paid content to non-subscribed users.
139
- * @readonly
140
- */
141
- preview?: boolean;
142
- /**
143
- * Reserved for internal use.
144
- * @maxLength 24
145
- */
146
- contentId?: string | null;
147
- /**
148
- * Reserved for internal use.
149
- * @readonly
150
- * @format GUID
151
- */
152
- mostRecentContributorId?: string | null;
153
- /**
154
- * 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).
155
- * @readonly
156
- */
157
- moderationDetails?: ModerationDetails;
158
- /** Post cover media. */
159
- media?: Media;
160
- /**
161
- * Indicates if there is a draft post with changes that have not yet been published.
162
- * @readonly
163
- */
164
- hasUnpublishedChanges?: boolean;
165
- /**
166
- * Post reference ID. You can reference the post from other entities, for example, comments.
167
- * @readonly
168
- * @maxLength 24
169
- */
170
- referenceId?: string | null;
171
- }
172
- interface PageUrl {
173
- /** The base URL. For premium sites, this is the domain. For free sites, this is the site URL. For example, `mysite.wixsite.com/mysite`. */
174
- base?: string;
175
- /** The relative path for the page within the site. For example, `/product-page/a-product`. */
176
- path?: string;
177
- }
178
- interface CoverMedia extends CoverMediaMediaOneOf {
179
- /** Image url. */
180
- image?: Image;
181
- /** Video url. */
182
- video?: Video;
183
- /**
184
- * Is cover media enabled.
185
- * Selected by user whether to display cover media on the feed
186
- * @deprecated Is cover media enabled.
187
- * Selected by user whether to display cover media on the feed
188
- * @replacedBy displayed
189
- * @targetRemovalDate 2024-06-30
190
- */
191
- enabled?: boolean;
192
- /** Whether cover media is displayed. */
193
- displayed?: boolean;
194
- /** Whether cover media is custom. If `false` the cover image is set to the first media item that appears in the content. */
195
- custom?: boolean;
196
- /**
197
- * Media alternative text.
198
- * @minLength 1
199
- * @maxLength 1000
200
- */
201
- altText?: string | null;
202
- }
203
- /** @oneof */
204
- interface CoverMediaMediaOneOf {
205
- /** Image url. */
206
- image?: Image;
207
- /** Video url. */
208
- video?: Video;
209
- }
210
- interface Image {
211
- /** WixMedia image ID. */
212
- id?: string;
213
- /** Image URL. */
214
- url?: string;
215
- /**
216
- * Original image height.
217
- * @readonly
218
- */
219
- height?: number;
220
- /**
221
- * Original image width.
222
- * @readonly
223
- */
224
- width?: number;
225
- /** Image alt text. */
226
- altText?: string | null;
227
- /**
228
- * Image filename.
229
- * @readonly
230
- */
231
- filename?: string | null;
232
- }
233
- /** Deprecated - use VideoV2 */
234
- interface Video {
235
- /** WixMedia ID */
236
- id?: string;
237
- /** URL of video */
238
- url?: string;
239
- /**
240
- * Original image height
241
- * @readonly
242
- */
243
- height?: number;
244
- /**
245
- * Original image width
246
- * @readonly
247
- */
248
- width?: number;
249
- /** Video poster */
250
- thumbnail?: Image;
251
- }
252
- interface Metrics {
253
- /**
254
- * Total number of post comments.
255
- * @readonly
256
- */
257
- comments?: number;
258
- /**
259
- * Total number of post likes.
260
- * @readonly
261
- */
262
- likes?: number;
263
- /**
264
- * Total number of post views.
265
- * @readonly
266
- */
267
- views?: number;
268
- }
269
- /**
270
- * 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.
271
- * The search engines use this information for ranking purposes, or to display snippets in the search results.
272
- * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
273
- */
274
- interface SeoSchema {
275
- /** SEO tag information. */
276
- tags?: Tag[];
277
- /** SEO general settings. */
278
- settings?: Settings;
279
- }
280
- interface Keyword {
281
- /** Keyword value. */
282
- term?: string;
283
- /** Whether the keyword is the main focus keyword. */
284
- isMain?: boolean;
285
- /**
286
- * The source that added the keyword terms to the SEO settings.
287
- * @maxLength 1000
288
- */
289
- origin?: string | null;
290
- }
291
- interface Tag {
292
- /**
293
- * SEO tag type.
294
- *
295
- *
296
- * Supported values: `title`, `meta`, `script`, `link`.
297
- */
298
- type?: string;
299
- /**
300
- * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
301
- * For example: `{"name": "description", "content": "the description itself"}`.
302
- */
303
- props?: Record<string, any> | null;
304
- /** SEO tag meta data. For example, `{"height": 300, "width": 240}`. */
305
- meta?: Record<string, any> | null;
306
- /** SEO tag inner content. For example, `<title> inner content </title>`. */
307
- children?: string;
308
- /** Whether the tag is a custom tag. */
309
- custom?: boolean;
310
- /** Whether the tag is disabled. */
311
- disabled?: boolean;
312
- }
313
- interface Settings {
314
- /**
315
- * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
316
- *
317
- *
318
- * Default: `false` (Auto Redirect is enabled.)
319
- */
320
- preventAutoRedirect?: boolean;
321
- /**
322
- * User-selected keyword terms for a specific page.
323
- * @maxSize 5
324
- */
325
- keywords?: Keyword[];
326
- }
327
- interface RichContent {
328
- /** Node objects representing a rich content document. */
329
- nodes?: Node[];
330
- /** Object metadata. */
331
- metadata?: Metadata;
332
- /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
333
- documentStyle?: DocumentStyle;
334
- }
335
- interface Node extends NodeDataOneOf {
336
- /** Data for a button node. */
337
- buttonData?: ButtonData;
338
- /** Data for a code block node. */
339
- codeBlockData?: CodeBlockData;
340
- /** Data for a divider node. */
341
- dividerData?: DividerData;
342
- /** Data for a file node. */
343
- fileData?: FileData;
344
- /** Data for a gallery node. */
345
- galleryData?: GalleryData;
346
- /** Data for a GIF node. */
347
- gifData?: GIFData;
348
- /** Data for a heading node. */
349
- headingData?: HeadingData;
350
- /** Data for an embedded HTML node. */
351
- htmlData?: HTMLData;
352
- /** Data for an image node. */
353
- imageData?: ImageData;
354
- /** Data for a link preview node. */
355
- linkPreviewData?: LinkPreviewData;
356
- /** @deprecated */
357
- mapData?: MapData;
358
- /** Data for a paragraph node. */
359
- paragraphData?: ParagraphData;
360
- /** Data for a poll node. */
361
- pollData?: PollData;
362
- /** Data for a text node. Used to apply decorations to text. */
363
- textData?: TextData;
364
- /** Data for an app embed node. */
365
- appEmbedData?: AppEmbedData;
366
- /** Data for a video node. */
367
- videoData?: VideoData;
368
- /** Data for an oEmbed node. */
369
- embedData?: EmbedData;
370
- /** Data for a collapsible list node. */
371
- collapsibleListData?: CollapsibleListData;
372
- /** Data for a table node. */
373
- tableData?: TableData;
374
- /** Data for a table cell node. */
375
- tableCellData?: TableCellData;
376
- /** Data for a custom external node. */
377
- externalData?: Record<string, any> | null;
378
- /** Data for an audio node. */
379
- audioData?: AudioData;
380
- /** Data for an ordered list node. */
381
- orderedListData?: OrderedListData;
382
- /** Data for a bulleted list node. */
383
- bulletedListData?: BulletedListData;
384
- /** Data for a block quote node. */
385
- blockquoteData?: BlockquoteData;
386
- /** Data for a caption node. */
387
- captionData?: CaptionData;
388
- /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
389
- layoutCellData?: LayoutCellData;
390
- /** 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. */
391
- type?: NodeType;
392
- /** Node ID. */
393
- id?: string;
394
- /** A list of child nodes. */
395
- nodes?: Node[];
396
- /** Padding and background color styling for the node. */
397
- style?: NodeStyle;
398
- }
399
- /** @oneof */
400
- interface NodeDataOneOf {
401
- /** Data for a button node. */
402
- buttonData?: ButtonData;
403
- /** Data for a code block node. */
404
- codeBlockData?: CodeBlockData;
405
- /** Data for a divider node. */
406
- dividerData?: DividerData;
407
- /** Data for a file node. */
408
- fileData?: FileData;
409
- /** Data for a gallery node. */
410
- galleryData?: GalleryData;
411
- /** Data for a GIF node. */
412
- gifData?: GIFData;
413
- /** Data for a heading node. */
414
- headingData?: HeadingData;
415
- /** Data for an embedded HTML node. */
416
- htmlData?: HTMLData;
417
- /** Data for an image node. */
418
- imageData?: ImageData;
419
- /** Data for a link preview node. */
420
- linkPreviewData?: LinkPreviewData;
421
- /** @deprecated */
422
- mapData?: MapData;
423
- /** Data for a paragraph node. */
424
- paragraphData?: ParagraphData;
425
- /** Data for a poll node. */
426
- pollData?: PollData;
427
- /** Data for a text node. Used to apply decorations to text. */
428
- textData?: TextData;
429
- /** Data for an app embed node. */
430
- appEmbedData?: AppEmbedData;
431
- /** Data for a video node. */
432
- videoData?: VideoData;
433
- /** Data for an oEmbed node. */
434
- embedData?: EmbedData;
435
- /** Data for a collapsible list node. */
436
- collapsibleListData?: CollapsibleListData;
437
- /** Data for a table node. */
438
- tableData?: TableData;
439
- /** Data for a table cell node. */
440
- tableCellData?: TableCellData;
441
- /** Data for a custom external node. */
442
- externalData?: Record<string, any> | null;
443
- /** Data for an audio node. */
444
- audioData?: AudioData;
445
- /** Data for an ordered list node. */
446
- orderedListData?: OrderedListData;
447
- /** Data for a bulleted list node. */
448
- bulletedListData?: BulletedListData;
449
- /** Data for a block quote node. */
450
- blockquoteData?: BlockquoteData;
451
- /** Data for a caption node. */
452
- captionData?: CaptionData;
453
- /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
454
- layoutCellData?: LayoutCellData;
455
- }
456
- declare enum NodeType {
457
- PARAGRAPH = "PARAGRAPH",
458
- TEXT = "TEXT",
459
- HEADING = "HEADING",
460
- BULLETED_LIST = "BULLETED_LIST",
461
- ORDERED_LIST = "ORDERED_LIST",
462
- LIST_ITEM = "LIST_ITEM",
463
- BLOCKQUOTE = "BLOCKQUOTE",
464
- CODE_BLOCK = "CODE_BLOCK",
465
- VIDEO = "VIDEO",
466
- DIVIDER = "DIVIDER",
467
- FILE = "FILE",
468
- GALLERY = "GALLERY",
469
- GIF = "GIF",
470
- HTML = "HTML",
471
- IMAGE = "IMAGE",
472
- LINK_PREVIEW = "LINK_PREVIEW",
473
- /** @deprecated */
474
- MAP = "MAP",
475
- POLL = "POLL",
476
- APP_EMBED = "APP_EMBED",
477
- BUTTON = "BUTTON",
478
- COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
479
- TABLE = "TABLE",
480
- EMBED = "EMBED",
481
- COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
482
- COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
483
- COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
484
- TABLE_CELL = "TABLE_CELL",
485
- TABLE_ROW = "TABLE_ROW",
486
- EXTERNAL = "EXTERNAL",
487
- AUDIO = "AUDIO",
488
- CAPTION = "CAPTION",
489
- LAYOUT = "LAYOUT",
490
- LAYOUT_CELL = "LAYOUT_CELL"
491
- }
492
- interface NodeStyle {
493
- /** The top padding value in pixels. */
494
- paddingTop?: string | null;
495
- /** The bottom padding value in pixels. */
496
- paddingBottom?: string | null;
497
- /** The background color as a hexadecimal value. */
498
- backgroundColor?: string | null;
499
- }
500
- interface ButtonData {
501
- /** Styling for the button's container. */
502
- containerData?: PluginContainerData;
503
- /** The button type. */
504
- type?: Type;
505
- /** Styling for the button. */
506
- styles?: Styles;
507
- /** The text to display on the button. */
508
- text?: string | null;
509
- /** Button link details. */
510
- link?: Link;
511
- }
512
- interface Border {
513
- /** Border width in pixels. */
514
- width?: number | null;
515
- /** Border radius in pixels. */
516
- radius?: number | null;
517
- }
518
- interface Colors {
519
- /** The text color as a hexadecimal value. */
520
- text?: string | null;
521
- /** The border color as a hexadecimal value. */
522
- border?: string | null;
523
- /** The background color as a hexadecimal value. */
524
- background?: string | null;
525
- }
526
- interface PluginContainerData {
527
- /** The width of the node when it's displayed. */
528
- width?: PluginContainerDataWidth;
529
- /** The node's alignment within its container. */
530
- alignment?: PluginContainerDataAlignment;
531
- /** Spoiler cover settings for the node. */
532
- spoiler?: Spoiler;
533
- /** The height of the node when it's displayed. */
534
- height?: Height;
535
- /** Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. */
536
- textWrap?: boolean | null;
537
- }
538
- declare enum WidthType {
539
- /** Width matches the content width */
540
- CONTENT = "CONTENT",
541
- /** Small Width */
542
- SMALL = "SMALL",
543
- /** Width will match the original asset width */
544
- ORIGINAL = "ORIGINAL",
545
- /** coast-to-coast display */
546
- FULL_WIDTH = "FULL_WIDTH"
547
- }
548
- interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
549
- /**
550
- * One of the following predefined width options:
551
- * `CONTENT`: The width of the container matches the content width.
552
- * `SMALL`: A small width.
553
- * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
554
- * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
555
- */
556
- size?: WidthType;
557
- /** A custom width value in pixels. */
558
- custom?: string | null;
559
- }
560
- /** @oneof */
561
- interface PluginContainerDataWidthDataOneOf {
562
- /**
563
- * One of the following predefined width options:
564
- * `CONTENT`: The width of the container matches the content width.
565
- * `SMALL`: A small width.
566
- * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
567
- * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
568
- */
569
- size?: WidthType;
570
- /** A custom width value in pixels. */
571
- custom?: string | null;
572
- }
573
- declare enum PluginContainerDataAlignment {
574
- /** Center Alignment */
575
- CENTER = "CENTER",
576
- /** Left Alignment */
577
- LEFT = "LEFT",
578
- /** Right Alignment */
579
- RIGHT = "RIGHT"
580
- }
581
- interface Spoiler {
582
- /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
583
- enabled?: boolean | null;
584
- /** The description displayed on top of the spoiler cover. */
585
- description?: string | null;
586
- /** The text for the button used to remove the spoiler cover. */
587
- buttonText?: string | null;
588
- }
589
- interface Height {
590
- /** A custom height value in pixels. */
591
- custom?: string | null;
592
- }
593
- declare enum Type {
594
- /** Regular link button */
595
- LINK = "LINK",
596
- /** Triggers custom action that is defined in plugin configuration by the consumer */
597
- ACTION = "ACTION"
598
- }
599
- interface Styles {
600
- /** Border attributes. */
601
- border?: Border;
602
- /** Color attributes. */
603
- colors?: Colors;
604
- }
605
- interface Link extends LinkDataOneOf {
606
- /** The absolute URL for the linked document. */
607
- url?: string;
608
- /** The target node's ID. Used for linking to another node in this object. */
609
- anchor?: string;
610
- /**
611
- * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
612
- * `SELF` - Default. Opens the linked document in the same frame as the link.
613
- * `BLANK` - Opens the linked document in a new browser tab or window.
614
- * `PARENT` - Opens the linked document in the link's parent frame.
615
- * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
616
- */
617
- target?: Target;
618
- /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
619
- rel?: Rel;
620
- /** A serialized object used for a custom or external link panel. */
621
- customData?: string | null;
622
- }
623
- /** @oneof */
624
- interface LinkDataOneOf {
625
- /** The absolute URL for the linked document. */
626
- url?: string;
627
- /** The target node's ID. Used for linking to another node in this object. */
628
- anchor?: string;
629
- }
630
- declare enum Target {
631
- /** Opens the linked document in the same frame as it was clicked (this is default) */
632
- SELF = "SELF",
633
- /** Opens the linked document in a new window or tab */
634
- BLANK = "BLANK",
635
- /** Opens the linked document in the parent frame */
636
- PARENT = "PARENT",
637
- /** Opens the linked document in the full body of the window */
638
- TOP = "TOP"
639
- }
640
- interface Rel {
641
- /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
642
- nofollow?: boolean | null;
643
- /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
644
- sponsored?: boolean | null;
645
- /** 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`. */
646
- ugc?: boolean | null;
647
- /** Indicates that this link protect referral information from being passed to the target website. */
648
- noreferrer?: boolean | null;
649
- }
650
- interface CodeBlockData {
651
- /** Styling for the code block's text. */
652
- textStyle?: TextStyle;
653
- }
654
- interface TextStyle {
655
- /** Text alignment. Defaults to `AUTO`. */
656
- textAlignment?: TextAlignment;
657
- /** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
658
- lineHeight?: string | null;
659
- }
660
- declare enum TextAlignment {
661
- /** browser default, eqivalent to `initial` */
662
- AUTO = "AUTO",
663
- /** Left align */
664
- LEFT = "LEFT",
665
- /** Right align */
666
- RIGHT = "RIGHT",
667
- /** Center align */
668
- CENTER = "CENTER",
669
- /** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
670
- JUSTIFY = "JUSTIFY"
671
- }
672
- interface DividerData {
673
- /** Styling for the divider's container. */
674
- containerData?: PluginContainerData;
675
- /** Divider line style. */
676
- lineStyle?: LineStyle;
677
- /** Divider width. */
678
- width?: Width;
679
- /** Divider alignment. */
680
- alignment?: Alignment;
681
- }
682
- declare enum LineStyle {
683
- /** Single Line */
684
- SINGLE = "SINGLE",
685
- /** Double Line */
686
- DOUBLE = "DOUBLE",
687
- /** Dashed Line */
688
- DASHED = "DASHED",
689
- /** Dotted Line */
690
- DOTTED = "DOTTED"
691
- }
692
- declare enum Width {
693
- /** Large line */
694
- LARGE = "LARGE",
695
- /** Medium line */
696
- MEDIUM = "MEDIUM",
697
- /** Small line */
698
- SMALL = "SMALL"
699
- }
700
- declare enum Alignment {
701
- /** Center alignment */
702
- CENTER = "CENTER",
703
- /** Left alignment */
704
- LEFT = "LEFT",
705
- /** Right alignment */
706
- RIGHT = "RIGHT"
707
- }
708
- interface FileData {
709
- /** Styling for the file's container. */
710
- containerData?: PluginContainerData;
711
- /** The source for the file's data. */
712
- src?: FileSource;
713
- /** File name. */
714
- name?: string | null;
715
- /** File type. */
716
- type?: string | null;
717
- /**
718
- * Use `sizeInKb` instead.
719
- * @deprecated
720
- */
721
- size?: number | null;
722
- /** Settings for PDF files. */
723
- pdfSettings?: PDFSettings;
724
- /** File MIME type. */
725
- mimeType?: string | null;
726
- /** File path. */
727
- path?: string | null;
728
- /** File size in KB. */
729
- sizeInKb?: string | null;
730
- }
731
- declare enum ViewMode {
732
- /** No PDF view */
733
- NONE = "NONE",
734
- /** Full PDF view */
735
- FULL = "FULL",
736
- /** Mini PDF view */
737
- MINI = "MINI"
738
- }
739
- interface FileSource extends FileSourceDataOneOf {
740
- /** The absolute URL for the file's source. */
741
- url?: string | null;
742
- /**
743
- * Custom ID. Use `id` instead.
744
- * @deprecated
745
- */
746
- custom?: string | null;
747
- /** An ID that's resolved to a URL by a resolver function. */
748
- id?: string | null;
749
- /** Indicates whether the file's source is private. Defaults to `false`. */
750
- private?: boolean | null;
751
- }
752
- /** @oneof */
753
- interface FileSourceDataOneOf {
754
- /** The absolute URL for the file's source. */
755
- url?: string | null;
756
- /**
757
- * Custom ID. Use `id` instead.
758
- * @deprecated
759
- */
760
- custom?: string | null;
761
- /** An ID that's resolved to a URL by a resolver function. */
762
- id?: string | null;
763
- }
764
- interface PDFSettings {
765
- /**
766
- * PDF view mode. One of the following:
767
- * `NONE` : The PDF isn't displayed.
768
- * `FULL` : A full page view of the PDF is displayed.
769
- * `MINI` : A mini view of the PDF is displayed.
770
- */
771
- viewMode?: ViewMode;
772
- /** Sets whether the PDF download button is disabled. Defaults to `false`. */
773
- disableDownload?: boolean | null;
774
- /** Sets whether the PDF print button is disabled. Defaults to `false`. */
775
- disablePrint?: boolean | null;
776
- }
777
- interface GalleryData {
778
- /** Styling for the gallery's container. */
779
- containerData?: PluginContainerData;
780
- /** The items in the gallery. */
781
- items?: Item[];
782
- /** Options for defining the gallery's appearance. */
783
- options?: GalleryOptions;
784
- /** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
785
- disableExpand?: boolean | null;
786
- /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
787
- disableDownload?: boolean | null;
788
- }
789
- interface V1Media {
790
- /** The source for the media's data. */
791
- src?: FileSource;
792
- /** Media width in pixels. */
793
- width?: number | null;
794
- /** Media height in pixels. */
795
- height?: number | null;
796
- /** Media duration in seconds. Only relevant for audio and video files. */
797
- duration?: number | null;
798
- }
799
- interface ItemImage {
800
- /** Image file details. */
801
- media?: V1Media;
802
- /** Link details for images that are links. */
803
- link?: Link;
804
- }
805
- interface ItemVideo {
806
- /** Video file details. */
807
- media?: V1Media;
808
- /** Video thumbnail file details. */
809
- thumbnail?: V1Media;
810
- }
811
- interface Item extends ItemDataOneOf {
812
- /** An image item. */
813
- image?: ItemImage;
814
- /** A video item. */
815
- video?: ItemVideo;
816
- /** Item title. */
817
- title?: string | null;
818
- /** Item's alternative text. */
819
- altText?: string | null;
820
- }
821
- /** @oneof */
822
- interface ItemDataOneOf {
823
- /** An image item. */
824
- image?: ItemImage;
825
- /** A video item. */
826
- video?: ItemVideo;
827
- }
828
- interface GalleryOptions {
829
- /** Gallery layout. */
830
- layout?: Layout;
831
- /** Styling for gallery items. */
832
- item?: ItemStyle;
833
- /** Styling for gallery thumbnail images. */
834
- thumbnails?: Thumbnails;
835
- }
836
- declare enum LayoutType {
837
- /** Collage type */
838
- COLLAGE = "COLLAGE",
839
- /** Masonry type */
840
- MASONRY = "MASONRY",
841
- /** Grid type */
842
- GRID = "GRID",
843
- /** Thumbnail type */
844
- THUMBNAIL = "THUMBNAIL",
845
- /** Slider type */
846
- SLIDER = "SLIDER",
847
- /** Slideshow type */
848
- SLIDESHOW = "SLIDESHOW",
849
- /** Panorama type */
850
- PANORAMA = "PANORAMA",
851
- /** Column type */
852
- COLUMN = "COLUMN",
853
- /** Magic type */
854
- MAGIC = "MAGIC",
855
- /** Fullsize images type */
856
- FULLSIZE = "FULLSIZE"
857
- }
858
- declare enum Orientation {
859
- /** Rows Orientation */
860
- ROWS = "ROWS",
861
- /** Columns Orientation */
862
- COLUMNS = "COLUMNS"
863
- }
864
- declare enum Crop {
865
- /** Crop to fill */
866
- FILL = "FILL",
867
- /** Crop to fit */
868
- FIT = "FIT"
869
- }
870
- declare enum ThumbnailsAlignment {
871
- /** Top alignment */
872
- TOP = "TOP",
873
- /** Right alignment */
874
- RIGHT = "RIGHT",
875
- /** Bottom alignment */
876
- BOTTOM = "BOTTOM",
877
- /** Left alignment */
878
- LEFT = "LEFT",
879
- /** No thumbnail */
880
- NONE = "NONE"
881
- }
882
- interface Layout {
883
- /** Gallery layout type. */
884
- type?: LayoutType;
885
- /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
886
- horizontalScroll?: boolean | null;
887
- /** Gallery orientation. */
888
- orientation?: Orientation;
889
- /** The number of columns to display on full size screens. */
890
- numberOfColumns?: number | null;
891
- /** The number of columns to display on mobile screens. */
892
- mobileNumberOfColumns?: number | null;
893
- }
894
- interface ItemStyle {
895
- /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
896
- targetSize?: number | null;
897
- /** Item ratio */
898
- ratio?: number | null;
899
- /** Sets how item images are cropped. */
900
- crop?: Crop;
901
- /** The spacing between items in pixels. */
902
- spacing?: number | null;
903
- }
904
- interface Thumbnails {
905
- /** Thumbnail alignment. */
906
- placement?: ThumbnailsAlignment;
907
- /** Spacing between thumbnails in pixels. */
908
- spacing?: number | null;
909
- }
910
- interface GIFData {
911
- /** Styling for the GIF's container. */
912
- containerData?: PluginContainerData;
913
- /** The source of the full size GIF. */
914
- original?: GIF;
915
- /** The source of the downsized GIF. */
916
- downsized?: GIF;
917
- /** Height in pixels. */
918
- height?: number;
919
- /** Width in pixels. */
920
- width?: number;
921
- /** Type of GIF (Sticker or GIF). Defaults to `GIF`. */
922
- gifType?: GIFType;
923
- }
924
- interface GIF {
925
- /**
926
- * GIF format URL.
927
- * @format WEB_URL
928
- */
929
- gif?: string | null;
930
- /**
931
- * MP4 format URL.
932
- * @format WEB_URL
933
- */
934
- mp4?: string | null;
935
- /**
936
- * Thumbnail URL.
937
- * @format WEB_URL
938
- */
939
- still?: string | null;
940
- }
941
- declare enum GIFType {
942
- GIF = "GIF",
943
- STICKER = "STICKER"
944
- }
945
- interface HeadingData {
946
- /** Heading level from 1-6. */
947
- level?: number;
948
- /** Styling for the heading text. */
949
- textStyle?: TextStyle;
950
- /** Indentation level from 1-4. */
951
- indentation?: number | null;
952
- }
953
- interface HTMLData extends HTMLDataDataOneOf {
954
- /** The URL for the HTML code for the node. */
955
- url?: string;
956
- /** The HTML code for the node. */
957
- html?: string;
958
- /**
959
- * Whether this is an AdSense element. Use `source` instead.
960
- * @deprecated
961
- */
962
- isAdsense?: boolean | null;
963
- /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
964
- containerData?: PluginContainerData;
965
- /** The type of HTML code. */
966
- source?: Source;
967
- /** If container height is aligned with its content height. Defaults to `true`. */
968
- autoHeight?: boolean | null;
969
- }
970
- /** @oneof */
971
- interface HTMLDataDataOneOf {
972
- /** The URL for the HTML code for the node. */
973
- url?: string;
974
- /** The HTML code for the node. */
975
- html?: string;
976
- /**
977
- * Whether this is an AdSense element. Use `source` instead.
978
- * @deprecated
979
- */
980
- isAdsense?: boolean | null;
981
- }
982
- declare enum Source {
983
- HTML = "HTML",
984
- ADSENSE = "ADSENSE"
985
- }
986
- interface ImageData {
987
- /** Styling for the image's container. */
988
- containerData?: PluginContainerData;
989
- /** Image file details. */
990
- image?: V1Media;
991
- /** Link details for images that are links. */
992
- link?: Link;
993
- /** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
994
- disableExpand?: boolean | null;
995
- /** Image's alternative text. */
996
- altText?: string | null;
997
- /**
998
- * Deprecated: use Caption node instead.
999
- * @deprecated
1000
- */
1001
- caption?: string | null;
1002
- /** Sets whether the image's download button is disabled. Defaults to `false`. */
1003
- disableDownload?: boolean | null;
1004
- }
1005
- interface LinkPreviewData {
1006
- /** Styling for the link preview's container. */
1007
- containerData?: PluginContainerData;
1008
- /** Link details. */
1009
- link?: Link;
1010
- /** Preview title. */
1011
- title?: string | null;
1012
- /** Preview thumbnail URL. */
1013
- thumbnailUrl?: string | null;
1014
- /** Preview description. */
1015
- description?: string | null;
1016
- /** The preview content as HTML. */
1017
- html?: string | null;
1018
- }
1019
- interface MapData {
1020
- /** Styling for the map's container. */
1021
- containerData?: PluginContainerData;
1022
- /** Map settings. */
1023
- mapSettings?: MapSettings;
1024
- }
1025
- interface MapSettings {
1026
- /** The address to display on the map. */
1027
- address?: string | null;
1028
- /** Sets whether the map is draggable. */
1029
- draggable?: boolean | null;
1030
- /** Sets whether the location marker is visible. */
1031
- marker?: boolean | null;
1032
- /** Sets whether street view control is enabled. */
1033
- streetViewControl?: boolean | null;
1034
- /** Sets whether zoom control is enabled. */
1035
- zoomControl?: boolean | null;
1036
- /** Location latitude. */
1037
- lat?: number | null;
1038
- /** Location longitude. */
1039
- lng?: number | null;
1040
- /** Location name. */
1041
- locationName?: string | null;
1042
- /** Sets whether view mode control is enabled. */
1043
- viewModeControl?: boolean | null;
1044
- /** Initial zoom value. */
1045
- initialZoom?: number | null;
1046
- /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
1047
- mapType?: MapType;
1048
- }
1049
- declare enum MapType {
1050
- /** Roadmap map type */
1051
- ROADMAP = "ROADMAP",
1052
- /** Satellite map type */
1053
- SATELITE = "SATELITE",
1054
- /** Hybrid map type */
1055
- HYBRID = "HYBRID",
1056
- /** Terrain map type */
1057
- TERRAIN = "TERRAIN"
1058
- }
1059
- interface ParagraphData {
1060
- /** Styling for the paragraph text. */
1061
- textStyle?: TextStyle;
1062
- /** Indentation level from 1-4. */
1063
- indentation?: number | null;
1064
- /** Paragraph level */
1065
- level?: number | null;
1066
- }
1067
- interface PollData {
1068
- /** Styling for the poll's container. */
1069
- containerData?: PluginContainerData;
1070
- /** Poll data. */
1071
- poll?: Poll;
1072
- /** Layout settings for the poll and voting options. */
1073
- layout?: PollDataLayout;
1074
- /** Styling for the poll and voting options. */
1075
- design?: Design;
1076
- }
1077
- declare enum ViewRole {
1078
- /** Only Poll creator can view the results */
1079
- CREATOR = "CREATOR",
1080
- /** Anyone who voted can see the results */
1081
- VOTERS = "VOTERS",
1082
- /** Anyone can see the results, even if one didn't vote */
1083
- EVERYONE = "EVERYONE"
1084
- }
1085
- declare enum VoteRole {
1086
- /** Logged in member */
1087
- SITE_MEMBERS = "SITE_MEMBERS",
1088
- /** Anyone */
1089
- ALL = "ALL"
1090
- }
1091
- interface Permissions {
1092
- /** Sets who can view the poll results. */
1093
- view?: ViewRole;
1094
- /** Sets who can vote. */
1095
- vote?: VoteRole;
1096
- /** Sets whether one voter can vote multiple times. Defaults to `false`. */
1097
- allowMultipleVotes?: boolean | null;
1098
- }
1099
- interface Option {
1100
- /** Option ID. */
1101
- id?: string | null;
1102
- /** Option title. */
1103
- title?: string | null;
1104
- /** The image displayed with the option. */
1105
- image?: V1Media;
1106
- }
1107
- interface PollSettings {
1108
- /** Permissions settings for voting. */
1109
- permissions?: Permissions;
1110
- /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
1111
- showVoters?: boolean | null;
1112
- /** Sets whether the vote count is displayed. Defaults to `true`. */
1113
- showVotesCount?: boolean | null;
1114
- }
1115
- declare enum PollLayoutType {
1116
- /** List */
1117
- LIST = "LIST",
1118
- /** Grid */
1119
- GRID = "GRID"
1120
- }
1121
- declare enum PollLayoutDirection {
1122
- /** Left-to-right */
1123
- LTR = "LTR",
1124
- /** Right-to-left */
1125
- RTL = "RTL"
1126
- }
1127
- interface PollLayout {
1128
- /** The layout for displaying the voting options. */
1129
- type?: PollLayoutType;
1130
- /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
1131
- direction?: PollLayoutDirection;
1132
- /** Sets whether to display the main poll image. Defaults to `false`. */
1133
- enableImage?: boolean | null;
1134
- }
1135
- interface OptionLayout {
1136
- /** Sets whether to display option images. Defaults to `false`. */
1137
- enableImage?: boolean | null;
1138
- }
1139
- declare enum BackgroundType {
1140
- /** Color background type */
1141
- COLOR = "COLOR",
1142
- /** Image background type */
1143
- IMAGE = "IMAGE",
1144
- /** Gradiant background type */
1145
- GRADIENT = "GRADIENT"
1146
- }
1147
- interface Gradient {
1148
- /** The gradient angle in degrees. */
1149
- angle?: number | null;
1150
- /**
1151
- * The start color as a hexademical value.
1152
- * @format COLOR_HEX
1153
- */
1154
- startColor?: string | null;
1155
- /**
1156
- * The end color as a hexademical value.
1157
- * @format COLOR_HEX
1158
- */
1159
- lastColor?: string | null;
1160
- }
1161
- interface Background extends BackgroundBackgroundOneOf {
1162
- /**
1163
- * The background color as a hexademical value.
1164
- * @format COLOR_HEX
1165
- */
1166
- color?: string | null;
1167
- /** An image to use for the background. */
1168
- image?: V1Media;
1169
- /** Details for a gradient background. */
1170
- gradient?: Gradient;
1171
- /** Background type. For each option, include the relevant details. */
1172
- type?: BackgroundType;
1173
- }
1174
- /** @oneof */
1175
- interface BackgroundBackgroundOneOf {
1176
- /**
1177
- * The background color as a hexademical value.
1178
- * @format COLOR_HEX
1179
- */
1180
- color?: string | null;
1181
- /** An image to use for the background. */
1182
- image?: V1Media;
1183
- /** Details for a gradient background. */
1184
- gradient?: Gradient;
1185
- }
1186
- interface PollDesign {
1187
- /** Background styling. */
1188
- background?: Background;
1189
- /** Border radius in pixels. */
1190
- borderRadius?: number | null;
1191
- }
1192
- interface OptionDesign {
1193
- /** Border radius in pixels. */
1194
- borderRadius?: number | null;
1195
- }
1196
- interface Poll {
1197
- /** Poll ID. */
1198
- id?: string | null;
1199
- /** Poll title. */
1200
- title?: string | null;
1201
- /** Poll creator ID. */
1202
- creatorId?: string | null;
1203
- /** Main poll image. */
1204
- image?: V1Media;
1205
- /** Voting options. */
1206
- options?: Option[];
1207
- /** The poll's permissions and display settings. */
1208
- settings?: PollSettings;
1209
- }
1210
- interface PollDataLayout {
1211
- /** Poll layout settings. */
1212
- poll?: PollLayout;
1213
- /** Voting otpions layout settings. */
1214
- options?: OptionLayout;
1215
- }
1216
- interface Design {
1217
- /** Styling for the poll. */
1218
- poll?: PollDesign;
1219
- /** Styling for voting options. */
1220
- options?: OptionDesign;
1221
- }
1222
- interface TextData {
1223
- /** The text to apply decorations to. */
1224
- text?: string;
1225
- /** The decorations to apply. */
1226
- decorations?: Decoration[];
1227
- }
1228
- /** Adds appearence changes to text */
1229
- interface Decoration extends DecorationDataOneOf {
1230
- /** Data for an anchor link decoration. */
1231
- anchorData?: AnchorData;
1232
- /** Data for a color decoration. */
1233
- colorData?: ColorData;
1234
- /** Data for an external link decoration. */
1235
- linkData?: LinkData;
1236
- /** Data for a mention decoration. */
1237
- mentionData?: MentionData;
1238
- /** Data for a font size decoration. */
1239
- fontSizeData?: FontSizeData;
1240
- /** Font weight for a bold decoration. */
1241
- fontWeightValue?: number | null;
1242
- /** Data for an italic decoration. Defaults to `true`. */
1243
- italicData?: boolean | null;
1244
- /** Data for an underline decoration. Defaults to `true`. */
1245
- underlineData?: boolean | null;
1246
- /** Data for a spoiler decoration. */
1247
- spoilerData?: SpoilerData;
1248
- /** The type of decoration to apply. */
1249
- type?: DecorationType;
1250
- }
1251
- /** @oneof */
1252
- interface DecorationDataOneOf {
1253
- /** Data for an anchor link decoration. */
1254
- anchorData?: AnchorData;
1255
- /** Data for a color decoration. */
1256
- colorData?: ColorData;
1257
- /** Data for an external link decoration. */
1258
- linkData?: LinkData;
1259
- /** Data for a mention decoration. */
1260
- mentionData?: MentionData;
1261
- /** Data for a font size decoration. */
1262
- fontSizeData?: FontSizeData;
1263
- /** Font weight for a bold decoration. */
1264
- fontWeightValue?: number | null;
1265
- /** Data for an italic decoration. Defaults to `true`. */
1266
- italicData?: boolean | null;
1267
- /** Data for an underline decoration. Defaults to `true`. */
1268
- underlineData?: boolean | null;
1269
- /** Data for a spoiler decoration. */
1270
- spoilerData?: SpoilerData;
1271
- }
1272
- declare enum DecorationType {
1273
- BOLD = "BOLD",
1274
- ITALIC = "ITALIC",
1275
- UNDERLINE = "UNDERLINE",
1276
- SPOILER = "SPOILER",
1277
- ANCHOR = "ANCHOR",
1278
- MENTION = "MENTION",
1279
- LINK = "LINK",
1280
- COLOR = "COLOR",
1281
- FONT_SIZE = "FONT_SIZE",
1282
- EXTERNAL = "EXTERNAL"
1283
- }
1284
- interface AnchorData {
1285
- /** The target node's ID. */
1286
- anchor?: string;
1287
- }
1288
- interface ColorData {
1289
- /** The text's background color as a hexadecimal value. */
1290
- background?: string | null;
1291
- /** The text's foreground color as a hexadecimal value. */
1292
- foreground?: string | null;
1293
- }
1294
- interface LinkData {
1295
- /** Link details. */
1296
- link?: Link;
1297
- }
1298
- interface MentionData {
1299
- /** The mentioned user's name. */
1300
- name?: string;
1301
- /** The version of the user's name that appears after the `@` character in the mention. */
1302
- slug?: string;
1303
- /** Mentioned user's ID. */
1304
- id?: string | null;
1305
- }
1306
- interface FontSizeData {
1307
- /** The units used for the font size. */
1308
- unit?: FontType;
1309
- /** Font size value. */
1310
- value?: number | null;
1311
- }
1312
- declare enum FontType {
1313
- PX = "PX",
1314
- EM = "EM"
1315
- }
1316
- interface SpoilerData {
1317
- /** Spoiler ID. */
1318
- id?: string | null;
1319
- }
1320
- interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1321
- /** Data for embedded Wix Bookings content. */
1322
- bookingData?: BookingData;
1323
- /** Data for embedded Wix Events content. */
1324
- eventData?: EventData;
1325
- /** The type of Wix App content being embedded. */
1326
- type?: AppType;
1327
- /** The ID of the embedded content. */
1328
- itemId?: string | null;
1329
- /** The name of the embedded content. */
1330
- name?: string | null;
1331
- /**
1332
- * Deprecated: Use `image` instead.
1333
- * @deprecated
1334
- */
1335
- imageSrc?: string | null;
1336
- /** The URL for the embedded content. */
1337
- url?: string | null;
1338
- /** An image for the embedded content. */
1339
- image?: V1Media;
1340
- }
1341
- /** @oneof */
1342
- interface AppEmbedDataAppDataOneOf {
1343
- /** Data for embedded Wix Bookings content. */
1344
- bookingData?: BookingData;
1345
- /** Data for embedded Wix Events content. */
1346
- eventData?: EventData;
1347
- }
1348
- declare enum AppType {
1349
- PRODUCT = "PRODUCT",
1350
- EVENT = "EVENT",
1351
- BOOKING = "BOOKING"
1352
- }
1353
- interface BookingData {
1354
- /** Booking duration in minutes. */
1355
- durations?: string | null;
1356
- }
1357
- interface EventData {
1358
- /** Event schedule. */
1359
- scheduling?: string | null;
1360
- /** Event location. */
1361
- location?: string | null;
1362
- }
1363
- interface VideoData {
1364
- /** Styling for the video's container. */
1365
- containerData?: PluginContainerData;
1366
- /** Video details. */
1367
- video?: V1Media;
1368
- /** Video thumbnail details. */
1369
- thumbnail?: V1Media;
1370
- /** Sets whether the video's download button is disabled. Defaults to `false`. */
1371
- disableDownload?: boolean | null;
1372
- /** Video title. */
1373
- title?: string | null;
1374
- /** Video options. */
1375
- options?: PlaybackOptions;
1376
- }
1377
- interface PlaybackOptions {
1378
- /** Sets whether the media will automatically start playing. */
1379
- autoPlay?: boolean | null;
1380
- /** Sets whether media's will be looped. */
1381
- playInLoop?: boolean | null;
1382
- /** Sets whether media's controls will be shown. */
1383
- showControls?: boolean | null;
1384
- }
1385
- interface EmbedData {
1386
- /** Styling for the oEmbed node's container. */
1387
- containerData?: PluginContainerData;
1388
- /** An [oEmbed](https://www.oembed.com) object. */
1389
- oembed?: Oembed;
1390
- /** Origin asset source. */
1391
- src?: string | null;
1392
- }
1393
- interface Oembed {
1394
- /** The resource type. */
1395
- type?: string | null;
1396
- /** The width of the resource specified in the `url` property in pixels. */
1397
- width?: number | null;
1398
- /** The height of the resource specified in the `url` property in pixels. */
1399
- height?: number | null;
1400
- /** Resource title. */
1401
- title?: string | null;
1402
- /** The source URL for the resource. */
1403
- url?: string | null;
1404
- /** HTML for embedding a video player. The HTML should have no padding or margins. */
1405
- html?: string | null;
1406
- /** The name of the author or owner of the resource. */
1407
- authorName?: string | null;
1408
- /** The URL for the author or owner of the resource. */
1409
- authorUrl?: string | null;
1410
- /** The name of the resource provider. */
1411
- providerName?: string | null;
1412
- /** The URL for the resource provider. */
1413
- providerUrl?: string | null;
1414
- /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
1415
- thumbnailUrl?: string | null;
1416
- /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
1417
- thumbnailWidth?: string | null;
1418
- /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
1419
- thumbnailHeight?: string | null;
1420
- /** The URL for an embedded viedo. */
1421
- videoUrl?: string | null;
1422
- /** The oEmbed version number. This value must be `1.0`. */
1423
- version?: string | null;
1424
- }
1425
- interface CollapsibleListData {
1426
- /** Styling for the collapsible list's container. */
1427
- containerData?: PluginContainerData;
1428
- /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
1429
- expandOnlyOne?: boolean | null;
1430
- /** Sets which items are expanded when the page loads. */
1431
- initialExpandedItems?: InitialExpandedItems;
1432
- /** The direction of the text in the list. Either left-to-right or right-to-left. */
1433
- direction?: Direction;
1434
- /** If `true`, The collapsible item will appear in search results as an FAQ. */
1435
- isQapageData?: boolean | null;
1436
- }
1437
- declare enum InitialExpandedItems {
1438
- /** First item will be expended initally */
1439
- FIRST = "FIRST",
1440
- /** All items will expended initally */
1441
- ALL = "ALL",
1442
- /** All items collapsed initally */
1443
- NONE = "NONE"
1444
- }
1445
- declare enum Direction {
1446
- /** Left-to-right */
1447
- LTR = "LTR",
1448
- /** Right-to-left */
1449
- RTL = "RTL"
1450
- }
1451
- interface TableData {
1452
- /** Styling for the table's container. */
1453
- containerData?: PluginContainerData;
1454
- /** The table's dimensions. */
1455
- dimensions?: Dimensions;
1456
- /**
1457
- * Deprecated: Use `rowHeader` and `columnHeader` instead.
1458
- * @deprecated
1459
- */
1460
- header?: boolean | null;
1461
- /** Sets whether the table's first row is a header. Defaults to `false`. */
1462
- rowHeader?: boolean | null;
1463
- /** Sets whether the table's first column is a header. Defaults to `false`. */
1464
- columnHeader?: boolean | null;
1465
- }
1466
- interface Dimensions {
1467
- /** An array representing relative width of each column in relation to the other columns. */
1468
- colsWidthRatio?: number[];
1469
- /** An array representing the height of each row in pixels. */
1470
- rowsHeight?: number[];
1471
- /** An array representing the minimum width of each column in pixels. */
1472
- colsMinWidth?: number[];
1473
- }
1474
- interface TableCellData {
1475
- /** Styling for the cell's background color and text alignment. */
1476
- cellStyle?: CellStyle;
1477
- /** The cell's border colors. */
1478
- borderColors?: BorderColors;
1479
- }
1480
- declare enum VerticalAlignment {
1481
- /** Top alignment */
1482
- TOP = "TOP",
1483
- /** Middle alignment */
1484
- MIDDLE = "MIDDLE",
1485
- /** Bottom alignment */
1486
- BOTTOM = "BOTTOM"
1487
- }
1488
- interface CellStyle {
1489
- /** Vertical alignment for the cell's text. */
1490
- verticalAlignment?: VerticalAlignment;
1491
- /**
1492
- * Cell background color as a hexadecimal value.
1493
- * @format COLOR_HEX
1494
- */
1495
- backgroundColor?: string | null;
1496
- }
1497
- interface BorderColors {
1498
- /**
1499
- * Left border color as a hexadecimal value.
1500
- * @format COLOR_HEX
1501
- */
1502
- left?: string | null;
1503
- /**
1504
- * Right border color as a hexadecimal value.
1505
- * @format COLOR_HEX
1506
- */
1507
- right?: string | null;
1508
- /**
1509
- * Top border color as a hexadecimal value.
1510
- * @format COLOR_HEX
1511
- */
1512
- top?: string | null;
1513
- /**
1514
- * Bottom border color as a hexadecimal value.
1515
- * @format COLOR_HEX
1516
- */
1517
- bottom?: string | null;
1518
- }
1519
- interface AudioData {
1520
- /** Styling for the audio node's container. */
1521
- containerData?: PluginContainerData;
1522
- /** Audio file details. */
1523
- audio?: V1Media;
1524
- /** Sets whether the audio node's download button is disabled. Defaults to `false`. */
1525
- disableDownload?: boolean | null;
1526
- /** Cover image. */
1527
- coverImage?: V1Media;
1528
- /** Track name. */
1529
- name?: string | null;
1530
- /** Author name. */
1531
- authorName?: string | null;
1532
- /** An HTML version of the audio node. */
1533
- html?: string | null;
1534
- }
1535
- interface OrderedListData {
1536
- /** Indentation level from 0-4. */
1537
- indentation?: number;
1538
- /** Offset level from 0-4. */
1539
- offset?: number | null;
1540
- /** List start number. */
1541
- start?: number | null;
1542
- }
1543
- interface BulletedListData {
1544
- /** Indentation level from 0-4. */
1545
- indentation?: number;
1546
- /** Offset level from 0-4. */
1547
- offset?: number | null;
1548
- }
1549
- interface BlockquoteData {
1550
- /** Indentation level from 1-4. */
1551
- indentation?: number;
1552
- }
1553
- interface CaptionData {
1554
- textStyle?: TextStyle;
1555
- }
1556
- interface LayoutCellData {
1557
- /** Size of the cell in 12 columns grid. */
1558
- colSpan?: number | null;
1559
- }
1560
- interface Metadata {
1561
- /** Schema version. */
1562
- version?: number;
1563
- /**
1564
- * When the object was created.
1565
- * @readonly
1566
- * @deprecated
1567
- */
1568
- createdTimestamp?: Date | null;
1569
- /**
1570
- * When the object was most recently updated.
1571
- * @deprecated
1572
- */
1573
- updatedTimestamp?: Date | null;
1574
- /** Object ID. */
1575
- id?: string | null;
1576
- }
1577
- interface DocumentStyle {
1578
- /** Styling for H1 nodes. */
1579
- headerOne?: TextNodeStyle;
1580
- /** Styling for H2 nodes. */
1581
- headerTwo?: TextNodeStyle;
1582
- /** Styling for H3 nodes. */
1583
- headerThree?: TextNodeStyle;
1584
- /** Styling for H4 nodes. */
1585
- headerFour?: TextNodeStyle;
1586
- /** Styling for H5 nodes. */
1587
- headerFive?: TextNodeStyle;
1588
- /** Styling for H6 nodes. */
1589
- headerSix?: TextNodeStyle;
1590
- /** Styling for paragraph nodes. */
1591
- paragraph?: TextNodeStyle;
1592
- /** Styling for block quote nodes. */
1593
- blockquote?: TextNodeStyle;
1594
- /** Styling for code block nodes. */
1595
- codeBlock?: TextNodeStyle;
1596
- }
1597
- interface TextNodeStyle {
1598
- /** The decorations to apply to the node. */
1599
- decorations?: Decoration[];
1600
- /** Padding and background color for the node. */
1601
- nodeStyle?: NodeStyle;
1602
- /** Line height for text in the node. */
1603
- lineHeight?: string | null;
1604
- }
1605
- interface ModerationDetails {
1606
- /**
1607
- * Member ID of the person submitting the draft post for review.
1608
- * @format GUID
1609
- */
1610
- submittedBy?: string;
1611
- /** Date the post was submitted for review. */
1612
- submittedDate?: Date | null;
1613
- /** Status indicating whether the submission was approved or rejected by the moderator. */
1614
- status?: ModerationStatusStatus;
1615
- /**
1616
- * Member ID of the person who approved or rejected the post.
1617
- * @format GUID
1618
- */
1619
- moderatedBy?: string | null;
1620
- /** Date the post was approved or rejected. */
1621
- moderationDate?: Date | null;
1622
- }
1623
- declare enum ModerationStatusStatus {
1624
- UNKNOWN = "UNKNOWN",
1625
- APPROVED = "APPROVED",
1626
- REJECTED = "REJECTED"
1627
- }
1628
- interface Media extends MediaMediaOneOf {
1629
- /** Wix Media details. */
1630
- wixMedia?: WixMedia;
1631
- /** Embed media details. */
1632
- embedMedia?: EmbedMedia;
1633
- /** Whether cover media is displayed. */
1634
- displayed?: boolean;
1635
- /** Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media. */
1636
- custom?: boolean;
1637
- /**
1638
- * Media alternative text.
1639
- * @minLength 1
1640
- * @maxLength 1000
1641
- */
1642
- altText?: string | null;
1643
- }
1644
- /** @oneof */
1645
- interface MediaMediaOneOf {
1646
- /** Wix Media details. */
1647
- wixMedia?: WixMedia;
1648
- /** Embed media details. */
1649
- embedMedia?: EmbedMedia;
1650
- }
1651
- interface WixMedia {
1652
- /** Image details. */
1653
- image?: Image;
1654
- /** Video details. */
1655
- videoV2?: VideoV2;
1656
- }
1657
- interface VideoV2 {
1658
- /** WixMedia ID. */
1659
- id?: string;
1660
- /**
1661
- * Available resolutions for the video, starting with the optimal resolution.
1662
- * @readonly
1663
- * @maxSize 100
1664
- */
1665
- resolutions?: VideoResolution[];
1666
- /**
1667
- * Video filename.
1668
- * @readonly
1669
- */
1670
- filename?: string | null;
1671
- }
1672
- interface VideoResolution {
1673
- /** Video URL. */
1674
- url?: string;
1675
- /** Video height. */
1676
- height?: number;
1677
- /** Video width. */
1678
- width?: number;
1679
- /** Video format for example, mp4, hls. */
1680
- format?: string;
1681
- }
1682
- interface EmbedMedia {
1683
- /** Thumbnail details. */
1684
- thumbnail?: EmbedThumbnail;
1685
- /** Video details. */
1686
- video?: EmbedVideo;
1687
- }
1688
- interface EmbedThumbnail {
1689
- /**
1690
- * Thumbnail url.
1691
- * @maxLength 2000
1692
- */
1693
- url?: string;
1694
- /** Thumbnail width. */
1695
- width?: number;
1696
- /** Thumbnail height. */
1697
- height?: number;
1698
- }
1699
- interface EmbedVideo {
1700
- /**
1701
- * Video url.
1702
- * @maxLength 2000
1703
- */
1704
- url?: string;
1705
- /** Video width. */
1706
- width?: number;
1707
- /** Video height. */
1708
- height?: number;
1709
- }
1710
- /** Get Blog Post Count Stats request */
1711
- interface QueryPostCountStatsRequest {
1712
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
1713
- rangeStart?: Date | null;
1714
- /**
1715
- * Order of returned results.
1716
- *
1717
- * - `OLDEST`: posts by date in ascending order.
1718
- * - `NEWEST`: posts by date in descending order.
1719
- *
1720
- * Default: `OLDEST`
1721
- */
1722
- order?: Order;
1723
- /** Number of months to include in response. */
1724
- months?: number;
1725
- /**
1726
- * Language filter.
1727
- *
1728
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
1729
- * Pass a language to only receive the period post count for that specified language.
1730
- * @format LANGUAGE_TAG
1731
- */
1732
- language?: string | null;
1733
- /**
1734
- * Time zone to use when calculating the start of the month.
1735
- *
1736
- * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
1737
- * @minLength 3
1738
- * @maxLength 100
1739
- */
1740
- timeZone?: string | null;
1741
- }
1742
- declare enum Order {
1743
- UNKNOWN = "UNKNOWN",
1744
- OLDEST = "OLDEST",
1745
- NEWEST = "NEWEST"
1746
- }
1747
- /** Get Blog Post Count Stats response */
1748
- interface QueryPostCountStatsResponse {
1749
- /** List of published post counts by month. */
1750
- stats?: PeriodPostCount[];
1751
- }
1752
- /** Post count for a specific time period */
1753
- interface PeriodPostCount {
1754
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
1755
- periodStart?: Date | null;
1756
- /** Number of posts published during this month. */
1757
- postCount?: number;
1758
- }
1759
- interface GetTotalPostsRequest {
1760
- /**
1761
- * Language filter.
1762
- *
1763
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
1764
- * Pass a language to receive the total amount of posts in that specified language.
1765
- * @format LANGUAGE_TAG
1766
- */
1767
- language?: string | null;
1768
- }
1769
- interface GetTotalPostsResponse {
1770
- /** Total amount of published posts. */
1771
- total?: number;
1772
- }
1773
- interface BlogPaging {
1774
- /**
1775
- * Number of items to skip in the current sort order.
1776
- *
1777
- *
1778
- * Default: `0`
1779
- */
1780
- offset?: number;
1781
- /**
1782
- * Number of items to return.
1783
- *
1784
- *
1785
- * Default:`50`
1786
- * @min 1
1787
- * @max 100
1788
- */
1789
- limit?: number;
1790
- /**
1791
- * Pointer to the next or previous page in the list of results.
1792
- * @maxLength 2000
1793
- */
1794
- cursor?: string | null;
1795
- }
1796
- interface MetaData {
1797
- /** Number of items returned in this response. */
1798
- count?: number;
1799
- /** Requested offset. */
1800
- offset?: number;
1801
- /** Total number of items that match the query. */
1802
- total?: number;
1803
- /**
1804
- * Pointer to the next or previous page in the list of results.
1805
- * @maxLength 2000
1806
- */
1807
- cursor?: string | null;
1808
- }
1809
- interface GetPostRequest {
1810
- /**
1811
- * Post ID.
1812
- * @minLength 1
1813
- * @maxLength 38
1814
- */
1815
- postId: string;
1816
- /**
1817
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1818
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
1819
- * only the post’s base fields are returned.
1820
- * @maxSize 20
1821
- */
1822
- fieldsets?: PostFieldField[];
1823
- }
1824
- declare enum PostFieldField {
1825
- UNKNOWN = "UNKNOWN",
1826
- /** Includes post URL when present. */
1827
- URL = "URL",
1828
- /** Includes post content text string when present. */
1829
- CONTENT_TEXT = "CONTENT_TEXT",
1830
- /** Includes post metrics when present. */
1831
- METRICS = "METRICS",
1832
- /** Includes SEO data. */
1833
- SEO = "SEO",
1834
- /** Includes post owner's contact ID. */
1835
- CONTACT_ID = "CONTACT_ID",
1836
- /** Includes post rich content. */
1837
- RICH_CONTENT = "RICH_CONTENT",
1838
- /** Includes post reference ID field. */
1839
- REFERENCE_ID = "REFERENCE_ID"
1840
- }
1841
- interface GetPostResponse {
1842
- /** Retrieved post info. */
1843
- post?: Post;
1844
- }
1845
- interface GetPostBySlugRequest {
1846
- /**
1847
- * Slug of the post to retrieve.
1848
- * @minLength 1
1849
- * @maxLength 200
1850
- */
1851
- slug: string;
1852
- /**
1853
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1854
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
1855
- * only the post’s base fields are returned.
1856
- * @maxSize 20
1857
- */
1858
- fieldsets?: PostFieldField[];
1859
- }
1860
- interface GetPostBySlugResponse {
1861
- /** Retrieved post info. */
1862
- post?: Post;
1863
- }
1864
- interface ListPostsRequest {
1865
- /**
1866
- * Whether to return only featured posts.
1867
- *
1868
- * Default: `false`
1869
- */
1870
- featured?: boolean;
1871
- /**
1872
- * Hashtag filter.
1873
- *
1874
- * Pass an array of hashtags to return only posts containing any of the provided hashtags.
1875
- * If omitted, all posts with or without hashtags are returned.
1876
- * @maxSize 100
1877
- * @maxLength 100
1878
- */
1879
- hashtags?: string[];
1880
- /**
1881
- * Category filter.
1882
- *
1883
- * Pass an array of category IDs to return only posts with any of the provided categories.
1884
- * If omitted, all posts with or without associated categories are returned.
1885
- * @maxSize 50
1886
- * @maxLength 38
1887
- */
1888
- categoryIds?: string[];
1889
- /**
1890
- * Tag filter.
1891
- *
1892
- * Pass an array of tag IDs to return only posts with any of the provided tags.
1893
- * If omitted, all posts with or without tags are returned.
1894
- * @maxSize 50
1895
- * @maxLength 38
1896
- */
1897
- tagIds?: string[];
1898
- /**
1899
- * Sorting options.
1900
- *
1901
- * Default: `FEED`
1902
- */
1903
- sort?: GetPostsSort;
1904
- /** Pagination options. */
1905
- paging?: BlogPaging;
1906
- /**
1907
- * Language filter.
1908
- *
1909
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
1910
- * Pass a language to only receive posts that are in that language.
1911
- * If omitted, posts in all languages are returned.
1912
- * @format LANGUAGE_TAG
1913
- */
1914
- language?: string | null;
1915
- /**
1916
- * Post owner's member ID.
1917
- * @format GUID
1918
- */
1919
- memberId?: string | null;
1920
- /**
1921
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1922
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
1923
- * only the post’s base fields are returned.
1924
- * @maxSize 20
1925
- */
1926
- fieldsets?: PostFieldField[];
1927
- }
1928
- declare enum GetPostsSort {
1929
- /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
1930
- FEED = "FEED",
1931
- /** Ordered by `firstPublishedDate` in ascending order. */
1932
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
1933
- /** Ordered by `firstPublishedDate` in descending order. */
1934
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
1935
- /** Ordered by total number of views in descending order. */
1936
- VIEW_COUNT = "VIEW_COUNT",
1937
- /** Ordered by total number of likes in descending order. */
1938
- LIKE_COUNT = "LIKE_COUNT",
1939
- /** Ordered by `title` in ascening order. */
1940
- TITLE_ASC = "TITLE_ASC",
1941
- /** Ordered by `title` in descending order. */
1942
- TITLE_DESC = "TITLE_DESC"
1943
- }
1944
- interface ListPostsResponse {
1945
- /** List of retrieved posts. */
1946
- posts?: Post[];
1947
- /** Details on the paged set of results returned. */
1948
- metaData?: MetaData;
1949
- }
1950
- interface QueryPostsRequest {
1951
- /** Query options. */
1952
- query?: PlatformQuery;
1953
- /**
1954
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1955
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
1956
- * only the post’s base fields are returned.
1957
- * @maxSize 20
1958
- */
1959
- fieldsets?: PostFieldField[];
1960
- }
1961
- interface Sorting {
1962
- /**
1963
- * Name of the field to sort by.
1964
- * @maxLength 512
1965
- */
1966
- fieldName?: string;
1967
- /** Sort order. */
1968
- order?: SortOrder;
1969
- }
1970
- declare enum SortOrder {
1971
- ASC = "ASC",
1972
- DESC = "DESC"
1973
- }
1974
- interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
1975
- /** Paging options to limit and skip the number of items. */
1976
- paging?: Paging;
1977
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1978
- cursorPaging?: CursorPaging;
1979
- /**
1980
- * Filter object in the following format:
1981
- * `"filter" : {
1982
- * "fieldName1": "value1",
1983
- * "fieldName2":{"$operator":"value2"}
1984
- * }`
1985
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
1986
- */
1987
- filter?: Record<string, any> | null;
1988
- /**
1989
- * Sort object in the following format:
1990
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
1991
- * @maxSize 3
1992
- */
1993
- sort?: Sorting[];
1994
- }
1995
- /** @oneof */
1996
- interface PlatformQueryPagingMethodOneOf {
1997
- /** Paging options to limit and skip the number of items. */
1998
- paging?: Paging;
1999
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
2000
- cursorPaging?: CursorPaging;
2001
- }
2002
- interface Paging {
2003
- /**
2004
- * Number of items to load.
2005
- * @max 100
2006
- */
2007
- limit?: number | null;
2008
- /** Number of items to skip in the current sort order. */
2009
- offset?: number | null;
2010
- }
2011
- interface CursorPaging {
2012
- /**
2013
- * Number of items to load.
2014
- * @max 100
2015
- */
2016
- limit?: number | null;
2017
- /**
2018
- * Pointer to the next or previous page in the list of results.
2019
- *
2020
- * You can get the relevant cursor token
2021
- * from the `pagingMetadata` object in the previous call's response.
2022
- * Not relevant for the first request.
2023
- * @maxLength 2000
2024
- */
2025
- cursor?: string | null;
2026
- }
2027
- interface QueryPostsResponse {
2028
- /** List of retrieved posts. */
2029
- posts?: Post[];
2030
- /** Details on the paged set of results returned. */
2031
- pagingMetadata?: PagingMetadataV2;
2032
- }
2033
- interface PagingMetadataV2 {
2034
- /** Number of items returned in the response. */
2035
- count?: number | null;
2036
- /** Offset that was requested. */
2037
- offset?: number | null;
2038
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
2039
- total?: number | null;
2040
- /** Flag that indicates the server failed to calculate the `total` field. */
2041
- tooManyToCount?: boolean | null;
2042
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
2043
- cursors?: Cursors;
2044
- }
2045
- interface Cursors {
2046
- /**
2047
- * Cursor pointing to next page in the list of results.
2048
- * @maxLength 2000
2049
- */
2050
- next?: string | null;
2051
- /**
2052
- * Cursor pointing to previous page in the list of results.
2053
- * @maxLength 2000
2054
- */
2055
- prev?: string | null;
2056
- }
2057
- interface GetPostMetricsRequest {
2058
- /**
2059
- * Post ID to retrieve metrics for.
2060
- * @minLength 1
2061
- * @maxLength 38
2062
- */
2063
- postId: string;
2064
- }
2065
- interface GetPostMetricsResponse {
2066
- /** Retrieved post metrics. */
2067
- metrics?: Metrics;
2068
- }
2069
-
2070
- type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
2071
- getUrl: (context: any) => string;
2072
- httpMethod: K;
2073
- path: string;
2074
- pathParams: M;
2075
- __requestType: T;
2076
- __originalRequestType: S;
2077
- __responseType: Q;
2078
- __originalResponseType: R;
2079
- };
2080
- declare function queryPostCountStats(): __PublicMethodMetaInfo<'GET', {}, QueryPostCountStatsRequest$1, QueryPostCountStatsRequest, QueryPostCountStatsResponse$1, QueryPostCountStatsResponse>;
2081
- declare function getTotalPosts(): __PublicMethodMetaInfo<'GET', {}, GetTotalPostsRequest$1, GetTotalPostsRequest, GetTotalPostsResponse$1, GetTotalPostsResponse>;
2082
- declare function getPost(): __PublicMethodMetaInfo<'GET', {
2083
- postId: string;
2084
- }, GetPostRequest$1, GetPostRequest, GetPostResponse$1, GetPostResponse>;
2085
- declare function getPostBySlug(): __PublicMethodMetaInfo<'GET', {
2086
- slug: string;
2087
- }, GetPostBySlugRequest$1, GetPostBySlugRequest, GetPostBySlugResponse$1, GetPostBySlugResponse>;
2088
- declare function listPosts(): __PublicMethodMetaInfo<'GET', {}, ListPostsRequest$1, ListPostsRequest, ListPostsResponse$1, ListPostsResponse>;
2089
- declare function queryPosts(): __PublicMethodMetaInfo<'POST', {}, QueryPostsRequest$1, QueryPostsRequest, QueryPostsResponse$1, QueryPostsResponse>;
2090
- declare function getPostMetrics(): __PublicMethodMetaInfo<'GET', {
2091
- postId: string;
2092
- }, GetPostMetricsRequest$1, GetPostMetricsRequest, GetPostMetricsResponse$1, GetPostMetricsResponse>;
2093
-
2094
- export { type __PublicMethodMetaInfo, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, queryPostCountStats, queryPosts };