@wix/auto_sdk_blog_draft-posts 1.0.24 → 1.0.26

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 (119) hide show
  1. package/build/{internal/cjs/src/blog-v3-draft-draft-posts.universal.d.ts → cjs/blog-v3-draft-draft-posts.universal-yk8zFFHT.d.ts} +311 -644
  2. package/build/cjs/index.d.ts +195 -1
  3. package/build/cjs/index.js +3441 -15
  4. package/build/cjs/index.js.map +1 -1
  5. package/build/cjs/meta.d.ts +2359 -1
  6. package/build/cjs/meta.js +2054 -15
  7. package/build/cjs/meta.js.map +1 -1
  8. package/build/{internal/es/src/blog-v3-draft-draft-posts.universal.d.ts → es/blog-v3-draft-draft-posts.universal-yk8zFFHT.d.mts} +311 -644
  9. package/build/es/index.d.mts +195 -0
  10. package/build/es/index.mjs +3364 -0
  11. package/build/es/index.mjs.map +1 -0
  12. package/build/es/{src/blog-v3-draft-draft-posts.types.d.ts → meta.d.mts} +263 -1025
  13. package/build/es/meta.mjs +2017 -0
  14. package/build/es/meta.mjs.map +1 -0
  15. package/build/{cjs/src/blog-v3-draft-draft-posts.universal.d.ts → internal/cjs/blog-v3-draft-draft-posts.universal-yk8zFFHT.d.ts} +311 -644
  16. package/build/internal/cjs/index.d.ts +195 -1
  17. package/build/internal/cjs/index.js +3441 -15
  18. package/build/internal/cjs/index.js.map +1 -1
  19. package/build/internal/cjs/meta.d.ts +2359 -1
  20. package/build/internal/cjs/meta.js +2054 -15
  21. package/build/internal/cjs/meta.js.map +1 -1
  22. package/build/{es/src/blog-v3-draft-draft-posts.universal.d.ts → internal/es/blog-v3-draft-draft-posts.universal-yk8zFFHT.d.mts} +311 -644
  23. package/build/internal/es/index.d.mts +195 -0
  24. package/build/internal/es/index.mjs +3364 -0
  25. package/build/internal/es/index.mjs.map +1 -0
  26. package/build/{cjs/src/blog-v3-draft-draft-posts.types.d.ts → internal/es/meta.d.mts} +263 -1025
  27. package/build/internal/es/meta.mjs +2017 -0
  28. package/build/internal/es/meta.mjs.map +1 -0
  29. package/package.json +9 -8
  30. package/build/cjs/index.typings.d.ts +0 -1
  31. package/build/cjs/index.typings.js +0 -18
  32. package/build/cjs/index.typings.js.map +0 -1
  33. package/build/cjs/src/blog-v3-draft-draft-posts.context.d.ts +0 -34
  34. package/build/cjs/src/blog-v3-draft-draft-posts.context.js +0 -78
  35. package/build/cjs/src/blog-v3-draft-draft-posts.context.js.map +0 -1
  36. package/build/cjs/src/blog-v3-draft-draft-posts.http.d.ts +0 -83
  37. package/build/cjs/src/blog-v3-draft-draft-posts.http.js +0 -1803
  38. package/build/cjs/src/blog-v3-draft-draft-posts.http.js.map +0 -1
  39. package/build/cjs/src/blog-v3-draft-draft-posts.meta.d.ts +0 -40
  40. package/build/cjs/src/blog-v3-draft-draft-posts.meta.js +0 -294
  41. package/build/cjs/src/blog-v3-draft-draft-posts.meta.js.map +0 -1
  42. package/build/cjs/src/blog-v3-draft-draft-posts.public.d.ts +0 -168
  43. package/build/cjs/src/blog-v3-draft-draft-posts.public.js +0 -339
  44. package/build/cjs/src/blog-v3-draft-draft-posts.public.js.map +0 -1
  45. package/build/cjs/src/blog-v3-draft-draft-posts.types.js +0 -477
  46. package/build/cjs/src/blog-v3-draft-draft-posts.types.js.map +0 -1
  47. package/build/cjs/src/blog-v3-draft-draft-posts.universal.js +0 -1506
  48. package/build/cjs/src/blog-v3-draft-draft-posts.universal.js.map +0 -1
  49. package/build/es/index.d.ts +0 -1
  50. package/build/es/index.js +0 -2
  51. package/build/es/index.js.map +0 -1
  52. package/build/es/index.typings.d.ts +0 -1
  53. package/build/es/index.typings.js +0 -2
  54. package/build/es/index.typings.js.map +0 -1
  55. package/build/es/meta.d.ts +0 -1
  56. package/build/es/meta.js +0 -2
  57. package/build/es/meta.js.map +0 -1
  58. package/build/es/src/blog-v3-draft-draft-posts.context.d.ts +0 -34
  59. package/build/es/src/blog-v3-draft-draft-posts.context.js +0 -34
  60. package/build/es/src/blog-v3-draft-draft-posts.context.js.map +0 -1
  61. package/build/es/src/blog-v3-draft-draft-posts.http.d.ts +0 -83
  62. package/build/es/src/blog-v3-draft-draft-posts.http.js +0 -1786
  63. package/build/es/src/blog-v3-draft-draft-posts.http.js.map +0 -1
  64. package/build/es/src/blog-v3-draft-draft-posts.meta.d.ts +0 -40
  65. package/build/es/src/blog-v3-draft-draft-posts.meta.js +0 -254
  66. package/build/es/src/blog-v3-draft-draft-posts.meta.js.map +0 -1
  67. package/build/es/src/blog-v3-draft-draft-posts.public.d.ts +0 -168
  68. package/build/es/src/blog-v3-draft-draft-posts.public.js +0 -281
  69. package/build/es/src/blog-v3-draft-draft-posts.public.js.map +0 -1
  70. package/build/es/src/blog-v3-draft-draft-posts.types.js +0 -474
  71. package/build/es/src/blog-v3-draft-draft-posts.types.js.map +0 -1
  72. package/build/es/src/blog-v3-draft-draft-posts.universal.js +0 -1465
  73. package/build/es/src/blog-v3-draft-draft-posts.universal.js.map +0 -1
  74. package/build/internal/cjs/index.typings.d.ts +0 -1
  75. package/build/internal/cjs/index.typings.js +0 -18
  76. package/build/internal/cjs/index.typings.js.map +0 -1
  77. package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.d.ts +0 -34
  78. package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.js +0 -78
  79. package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.js.map +0 -1
  80. package/build/internal/cjs/src/blog-v3-draft-draft-posts.http.d.ts +0 -83
  81. package/build/internal/cjs/src/blog-v3-draft-draft-posts.http.js +0 -1803
  82. package/build/internal/cjs/src/blog-v3-draft-draft-posts.http.js.map +0 -1
  83. package/build/internal/cjs/src/blog-v3-draft-draft-posts.meta.d.ts +0 -40
  84. package/build/internal/cjs/src/blog-v3-draft-draft-posts.meta.js +0 -294
  85. package/build/internal/cjs/src/blog-v3-draft-draft-posts.meta.js.map +0 -1
  86. package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.d.ts +0 -168
  87. package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.js +0 -339
  88. package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.js.map +0 -1
  89. package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.d.ts +0 -3121
  90. package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.js +0 -477
  91. package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.js.map +0 -1
  92. package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.js +0 -1506
  93. package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.js.map +0 -1
  94. package/build/internal/es/index.d.ts +0 -1
  95. package/build/internal/es/index.js +0 -2
  96. package/build/internal/es/index.js.map +0 -1
  97. package/build/internal/es/index.typings.d.ts +0 -1
  98. package/build/internal/es/index.typings.js +0 -2
  99. package/build/internal/es/index.typings.js.map +0 -1
  100. package/build/internal/es/meta.d.ts +0 -1
  101. package/build/internal/es/meta.js +0 -2
  102. package/build/internal/es/meta.js.map +0 -1
  103. package/build/internal/es/src/blog-v3-draft-draft-posts.context.d.ts +0 -34
  104. package/build/internal/es/src/blog-v3-draft-draft-posts.context.js +0 -34
  105. package/build/internal/es/src/blog-v3-draft-draft-posts.context.js.map +0 -1
  106. package/build/internal/es/src/blog-v3-draft-draft-posts.http.d.ts +0 -83
  107. package/build/internal/es/src/blog-v3-draft-draft-posts.http.js +0 -1786
  108. package/build/internal/es/src/blog-v3-draft-draft-posts.http.js.map +0 -1
  109. package/build/internal/es/src/blog-v3-draft-draft-posts.meta.d.ts +0 -40
  110. package/build/internal/es/src/blog-v3-draft-draft-posts.meta.js +0 -254
  111. package/build/internal/es/src/blog-v3-draft-draft-posts.meta.js.map +0 -1
  112. package/build/internal/es/src/blog-v3-draft-draft-posts.public.d.ts +0 -168
  113. package/build/internal/es/src/blog-v3-draft-draft-posts.public.js +0 -281
  114. package/build/internal/es/src/blog-v3-draft-draft-posts.public.js.map +0 -1
  115. package/build/internal/es/src/blog-v3-draft-draft-posts.types.d.ts +0 -3121
  116. package/build/internal/es/src/blog-v3-draft-draft-posts.types.js +0 -474
  117. package/build/internal/es/src/blog-v3-draft-draft-posts.types.js.map +0 -1
  118. package/build/internal/es/src/blog-v3-draft-draft-posts.universal.js +0 -1465
  119. package/build/internal/es/src/blog-v3-draft-draft-posts.universal.js.map +0 -1
@@ -1,3121 +0,0 @@
1
- export interface DraftPost {
2
- /**
3
- * Draft post ID.
4
- * @readonly
5
- * @maxLength 38
6
- */
7
- id?: string;
8
- /**
9
- * Draft post title.
10
- * @maxLength 200
11
- */
12
- title?: string;
13
- /**
14
- * Draft post excerpt.
15
- *
16
- * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
17
- * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
18
- * @maxLength 500
19
- */
20
- excerpt?: string | null;
21
- /** Whether the draft post is marked as featured. */
22
- featured?: boolean | null;
23
- /**
24
- * Category IDs of the draft post.
25
- * @maxSize 10
26
- * @maxLength 38
27
- */
28
- categoryIds?: string[];
29
- /**
30
- * Draft post owner's member ID.
31
- * @format GUID
32
- */
33
- memberId?: string | null;
34
- /**
35
- * Hashtags in the post.
36
- * @maxSize 100
37
- * @maxLength 100
38
- */
39
- hashtags?: string[];
40
- /** Whether commenting on the draft post is enabled. */
41
- commentingEnabled?: boolean | null;
42
- /**
43
- * Estimated reading time of the draft post (calculated automatically).
44
- * @readonly
45
- */
46
- minutesToRead?: number;
47
- /** Image placed at the top of the blog page. */
48
- heroImage?: Image;
49
- /**
50
- * Tag IDs the draft post is tagged with.
51
- * @maxSize 30
52
- * @maxLength 38
53
- */
54
- tagIds?: string[];
55
- /**
56
- * IDs of posts related to this draft post.
57
- * @maxSize 3
58
- * @maxLength 38
59
- */
60
- relatedPostIds?: string[];
61
- /**
62
- * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
63
- * @maxSize 100
64
- * @format GUID
65
- */
66
- pricingPlanIds?: string[];
67
- /**
68
- * ID of the draft post's translations.
69
- *
70
- * All translations of a single post share the same `translationId`.
71
- * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
72
- * @format GUID
73
- */
74
- translationId?: string | null;
75
- /**
76
- * Language the draft post is written in.
77
- *
78
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
79
- * @format LANGUAGE_TAG
80
- */
81
- language?: string | null;
82
- /**
83
- * Draft Post rich content.
84
- *
85
- * <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">
86
- * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
87
- * </widget>
88
- */
89
- richContent?: RichContent;
90
- /**
91
- * Status of the draft post.
92
- * @readonly
93
- */
94
- status?: StatusWithLiterals;
95
- /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
96
- moderationDetails?: ModerationDetails;
97
- /**
98
- * Indicates if there are changes made to the draft post that have not yet been published.
99
- * @readonly
100
- */
101
- hasUnpublishedChanges?: boolean;
102
- /**
103
- * Date the draft post was last edited.
104
- * @readonly
105
- */
106
- editedDate?: Date | null;
107
- /**
108
- * Date the draft post is scheduled to be published.
109
- * @readonly
110
- */
111
- scheduledPublishDate?: Date | null;
112
- /** Date the post was first published. */
113
- firstPublishedDate?: Date | null;
114
- /** SEO data. */
115
- seoData?: SeoSchema;
116
- /**
117
- * Draft post URL preview. What the URL will look like once the post is published.
118
- * @readonly
119
- */
120
- url?: PageUrl;
121
- /**
122
- * Date the draft post was first created.
123
- * @readonly
124
- */
125
- createdDate?: Date | null;
126
- /**
127
- * SEO slug.
128
- * @maxLength 100
129
- */
130
- seoSlug?: string | null;
131
- /** Post cover media. */
132
- media?: Media;
133
- /** Number of paragraphs to display in a paid content preview for non-paying users. */
134
- previewTextParagraph?: number | null;
135
- }
136
- export interface CoverMedia extends CoverMediaMediaOneOf {
137
- /** Image url. */
138
- image?: Image;
139
- /** Video url. */
140
- video?: Video;
141
- /**
142
- * Is cover media enabled.
143
- * Selected by user whether to display cover media on the feed
144
- * @deprecated Is cover media enabled.
145
- * Selected by user whether to display cover media on the feed
146
- * @replacedBy displayed
147
- * @targetRemovalDate 2024-06-30
148
- */
149
- enabled?: boolean;
150
- /** Whether cover media is displayed. */
151
- displayed?: boolean;
152
- /** Whether cover media is custom. If `false` the cover image is set to the first media item that appears in the content. */
153
- custom?: boolean;
154
- /**
155
- * Alternative text is a short phrase that describes what the image depicts.
156
- *
157
- * The alternative text is used:
158
- * + If the browser cannot display the image.
159
- * + If the user is utilizing a screen reader.
160
- * + By search engines to understand what images are on a site.
161
- * @minLength 1
162
- * @maxLength 1000
163
- */
164
- altText?: string | null;
165
- }
166
- /** @oneof */
167
- export interface CoverMediaMediaOneOf {
168
- /** Image url. */
169
- image?: Image;
170
- /** Video url. */
171
- video?: Video;
172
- }
173
- export interface Image {
174
- /** WixMedia image ID. */
175
- id?: string;
176
- /** Image URL. */
177
- url?: string;
178
- /**
179
- * Original image height.
180
- * @readonly
181
- */
182
- height?: number;
183
- /**
184
- * Original image width.
185
- * @readonly
186
- */
187
- width?: number;
188
- /** Image alt text. */
189
- altText?: string | null;
190
- /**
191
- * Image filename.
192
- * @readonly
193
- */
194
- filename?: string | null;
195
- }
196
- export interface FocalPoint {
197
- /** X-coordinate of the focal point. */
198
- x?: number;
199
- /** Y-coordinate of the focal point. */
200
- y?: number;
201
- /** crop by height */
202
- height?: number | null;
203
- /** crop by width */
204
- width?: number | null;
205
- }
206
- /** Deprecated - use VideoV2 */
207
- export interface Video {
208
- /** WixMedia ID */
209
- id?: string;
210
- /** URL of video */
211
- url?: string;
212
- /**
213
- * Original image height
214
- * @readonly
215
- */
216
- height?: number;
217
- /**
218
- * Original image width
219
- * @readonly
220
- */
221
- width?: number;
222
- /** Video poster */
223
- thumbnail?: Image;
224
- }
225
- export declare enum Origin {
226
- UNKNOWN = "UNKNOWN",
227
- /** Changed by admin */
228
- ADMIN = "ADMIN",
229
- /** Categories were changed */
230
- ADD_CATEGORIES = "ADD_CATEGORIES",
231
- /** Saved automatically */
232
- AUTO_SAVE = "AUTO_SAVE",
233
- /** Copied from template */
234
- COPY_TEMPLATE = "COPY_TEMPLATE",
235
- /** Imported */
236
- IMPORT = "IMPORT",
237
- /** Imported in bulk */
238
- IMPORT_BULK = "IMPORT_BULK",
239
- /** Imported with html import */
240
- IMPORT_HTML = "IMPORT_HTML",
241
- /** Patch import */
242
- IMPORT_PATCH = "IMPORT_PATCH",
243
- /** Changed language */
244
- LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
245
- /** Saved manually */
246
- MANUAL_SAVE = "MANUAL_SAVE",
247
- /** Affected by migration */
248
- MIGRATION = "MIGRATION",
249
- /** Affected by moderation */
250
- MODERATION = "MODERATION",
251
- /** Moved to trash */
252
- MOVE_TO_TRASH = "MOVE_TO_TRASH",
253
- /** Pricing plans were changed */
254
- PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
255
- /** Was provisioned */
256
- PROVISION = "PROVISION",
257
- /** Was published */
258
- PUBLISH = "PUBLISH",
259
- /** Owner was reassigned */
260
- REASSIGN_OWNER = "REASSIGN_OWNER",
261
- /** Was reblogged */
262
- REBLOG = "REBLOG",
263
- /** Was restored */
264
- RESTORE = "RESTORE",
265
- /** Reverted to draft */
266
- REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
267
- /** Was translated */
268
- TRANSLATION = "TRANSLATION",
269
- /** Was unpublished */
270
- UNPUBLISH = "UNPUBLISH",
271
- /** Was unscheduled */
272
- UNSCHEDULE = "UNSCHEDULE",
273
- /** New edit session started which updated editing_session_id id */
274
- NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
275
- /** Was scheduled by Later */
276
- SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
277
- /** Was unscheduled by Later */
278
- SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
279
- /** Was published by Later */
280
- SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
281
- /** Was scheduled */
282
- SCHEDULE = "SCHEDULE",
283
- /** Was removed from moderation */
284
- REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
285
- /** Was rejected from moderation */
286
- REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
287
- /** Was approved in moderation */
288
- APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
289
- /** Tag was deleted */
290
- DELETE_TAG = "DELETE_TAG",
291
- /** Post was pinned */
292
- PIN = "PIN",
293
- /** Post was unpinned */
294
- UNPIN = "UNPIN",
295
- /** Saved automatically by AI tool. */
296
- AI_AUTO_SAVE = "AI_AUTO_SAVE"
297
- }
298
- /** @enumType */
299
- export type OriginWithLiterals = Origin | 'UNKNOWN' | 'ADMIN' | 'ADD_CATEGORIES' | 'AUTO_SAVE' | 'COPY_TEMPLATE' | 'IMPORT' | 'IMPORT_BULK' | 'IMPORT_HTML' | 'IMPORT_PATCH' | 'LANGUAGE_CHANGE' | 'MANUAL_SAVE' | 'MIGRATION' | 'MODERATION' | 'MOVE_TO_TRASH' | 'PRICING_PLANS_CHANGE' | 'PROVISION' | 'PUBLISH' | 'REASSIGN_OWNER' | 'REBLOG' | 'RESTORE' | 'REVERT_TO_DRAFT' | 'TRANSLATION' | 'UNPUBLISH' | 'UNSCHEDULE' | 'NEW_EDIT_SESSION' | 'SCHEDULING_SERVICE_SCHEDULE' | 'SCHEDULING_SERVICE_UNSCHEDULE' | 'SCHEDULING_SERVICE_PUBLISH' | 'SCHEDULE' | 'REMOVE_FROM_MODERATION' | 'REJECT_FROM_MODERATION' | 'APPROVE_IN_MODERATION' | 'DELETE_TAG' | 'PIN' | 'UNPIN' | 'AI_AUTO_SAVE';
300
- export interface RichContent {
301
- /** Node objects representing a rich content document. */
302
- nodes?: Node[];
303
- /** Object metadata. */
304
- metadata?: Metadata;
305
- /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
306
- documentStyle?: DocumentStyle;
307
- }
308
- export interface Node extends NodeDataOneOf {
309
- /** Data for a button node. */
310
- buttonData?: ButtonData;
311
- /** Data for a code block node. */
312
- codeBlockData?: CodeBlockData;
313
- /** Data for a divider node. */
314
- dividerData?: DividerData;
315
- /** Data for a file node. */
316
- fileData?: FileData;
317
- /** Data for a gallery node. */
318
- galleryData?: GalleryData;
319
- /** Data for a GIF node. */
320
- gifData?: GIFData;
321
- /** Data for a heading node. */
322
- headingData?: HeadingData;
323
- /** Data for an embedded HTML node. */
324
- htmlData?: HTMLData;
325
- /** Data for an image node. */
326
- imageData?: ImageData;
327
- /** Data for a link preview node. */
328
- linkPreviewData?: LinkPreviewData;
329
- /** @deprecated */
330
- mapData?: MapData;
331
- /** Data for a paragraph node. */
332
- paragraphData?: ParagraphData;
333
- /** Data for a poll node. */
334
- pollData?: PollData;
335
- /** Data for a text node. Used to apply decorations to text. */
336
- textData?: TextData;
337
- /** Data for an app embed node. */
338
- appEmbedData?: AppEmbedData;
339
- /** Data for a video node. */
340
- videoData?: VideoData;
341
- /** Data for an oEmbed node. */
342
- embedData?: EmbedData;
343
- /** Data for a collapsible list node. */
344
- collapsibleListData?: CollapsibleListData;
345
- /** Data for a table node. */
346
- tableData?: TableData;
347
- /** Data for a table cell node. */
348
- tableCellData?: TableCellData;
349
- /** Data for a custom external node. */
350
- externalData?: Record<string, any> | null;
351
- /** Data for an audio node. */
352
- audioData?: AudioData;
353
- /** Data for an ordered list node. */
354
- orderedListData?: OrderedListData;
355
- /** Data for a bulleted list node. */
356
- bulletedListData?: BulletedListData;
357
- /** Data for a block quote node. */
358
- blockquoteData?: BlockquoteData;
359
- /** Data for a caption node. */
360
- captionData?: CaptionData;
361
- /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
362
- layoutCellData?: LayoutCellData;
363
- /** 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. */
364
- type?: NodeTypeWithLiterals;
365
- /** Node ID. */
366
- id?: string;
367
- /** A list of child nodes. */
368
- nodes?: Node[];
369
- /** Padding and background color styling for the node. */
370
- style?: NodeStyle;
371
- }
372
- /** @oneof */
373
- export interface NodeDataOneOf {
374
- /** Data for a button node. */
375
- buttonData?: ButtonData;
376
- /** Data for a code block node. */
377
- codeBlockData?: CodeBlockData;
378
- /** Data for a divider node. */
379
- dividerData?: DividerData;
380
- /** Data for a file node. */
381
- fileData?: FileData;
382
- /** Data for a gallery node. */
383
- galleryData?: GalleryData;
384
- /** Data for a GIF node. */
385
- gifData?: GIFData;
386
- /** Data for a heading node. */
387
- headingData?: HeadingData;
388
- /** Data for an embedded HTML node. */
389
- htmlData?: HTMLData;
390
- /** Data for an image node. */
391
- imageData?: ImageData;
392
- /** Data for a link preview node. */
393
- linkPreviewData?: LinkPreviewData;
394
- /** @deprecated */
395
- mapData?: MapData;
396
- /** Data for a paragraph node. */
397
- paragraphData?: ParagraphData;
398
- /** Data for a poll node. */
399
- pollData?: PollData;
400
- /** Data for a text node. Used to apply decorations to text. */
401
- textData?: TextData;
402
- /** Data for an app embed node. */
403
- appEmbedData?: AppEmbedData;
404
- /** Data for a video node. */
405
- videoData?: VideoData;
406
- /** Data for an oEmbed node. */
407
- embedData?: EmbedData;
408
- /** Data for a collapsible list node. */
409
- collapsibleListData?: CollapsibleListData;
410
- /** Data for a table node. */
411
- tableData?: TableData;
412
- /** Data for a table cell node. */
413
- tableCellData?: TableCellData;
414
- /** Data for a custom external node. */
415
- externalData?: Record<string, any> | null;
416
- /** Data for an audio node. */
417
- audioData?: AudioData;
418
- /** Data for an ordered list node. */
419
- orderedListData?: OrderedListData;
420
- /** Data for a bulleted list node. */
421
- bulletedListData?: BulletedListData;
422
- /** Data for a block quote node. */
423
- blockquoteData?: BlockquoteData;
424
- /** Data for a caption node. */
425
- captionData?: CaptionData;
426
- /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
427
- layoutCellData?: LayoutCellData;
428
- }
429
- export declare enum NodeType {
430
- PARAGRAPH = "PARAGRAPH",
431
- TEXT = "TEXT",
432
- HEADING = "HEADING",
433
- BULLETED_LIST = "BULLETED_LIST",
434
- ORDERED_LIST = "ORDERED_LIST",
435
- LIST_ITEM = "LIST_ITEM",
436
- BLOCKQUOTE = "BLOCKQUOTE",
437
- CODE_BLOCK = "CODE_BLOCK",
438
- VIDEO = "VIDEO",
439
- DIVIDER = "DIVIDER",
440
- FILE = "FILE",
441
- GALLERY = "GALLERY",
442
- GIF = "GIF",
443
- HTML = "HTML",
444
- IMAGE = "IMAGE",
445
- LINK_PREVIEW = "LINK_PREVIEW",
446
- /** @deprecated */
447
- MAP = "MAP",
448
- POLL = "POLL",
449
- APP_EMBED = "APP_EMBED",
450
- BUTTON = "BUTTON",
451
- COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
452
- TABLE = "TABLE",
453
- EMBED = "EMBED",
454
- COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
455
- COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
456
- COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
457
- TABLE_CELL = "TABLE_CELL",
458
- TABLE_ROW = "TABLE_ROW",
459
- EXTERNAL = "EXTERNAL",
460
- AUDIO = "AUDIO",
461
- CAPTION = "CAPTION",
462
- LAYOUT = "LAYOUT",
463
- LAYOUT_CELL = "LAYOUT_CELL"
464
- }
465
- /** @enumType */
466
- export type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
467
- export interface NodeStyle {
468
- /** The top padding value in pixels. */
469
- paddingTop?: string | null;
470
- /** The bottom padding value in pixels. */
471
- paddingBottom?: string | null;
472
- /** The background color as a hexadecimal value. */
473
- backgroundColor?: string | null;
474
- }
475
- export interface ButtonData {
476
- /** Styling for the button's container. */
477
- containerData?: PluginContainerData;
478
- /** The button type. */
479
- type?: ButtonDataTypeWithLiterals;
480
- /** Styling for the button. */
481
- styles?: Styles;
482
- /** The text to display on the button. */
483
- text?: string | null;
484
- /** Button link details. */
485
- link?: Link;
486
- }
487
- export interface Border {
488
- /**
489
- * Deprecated: Use `borderWidth` in `styles` instead.
490
- * @deprecated
491
- */
492
- width?: number | null;
493
- /**
494
- * Deprecated: Use `borderRadius` in `styles` instead.
495
- * @deprecated
496
- */
497
- radius?: number | null;
498
- }
499
- export interface Colors {
500
- /**
501
- * Deprecated: Use `textColor` in `styles` instead.
502
- * @deprecated
503
- */
504
- text?: string | null;
505
- /**
506
- * Deprecated: Use `borderColor` in `styles` instead.
507
- * @deprecated
508
- */
509
- border?: string | null;
510
- /**
511
- * Deprecated: Use `backgroundColor` in `styles` instead.
512
- * @deprecated
513
- */
514
- background?: string | null;
515
- }
516
- export interface PluginContainerData {
517
- /** The width of the node when it's displayed. */
518
- width?: PluginContainerDataWidth;
519
- /** The node's alignment within its container. */
520
- alignment?: PluginContainerDataAlignmentWithLiterals;
521
- /** Spoiler cover settings for the node. */
522
- spoiler?: Spoiler;
523
- /** The height of the node when it's displayed. */
524
- height?: Height;
525
- /** 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`. */
526
- textWrap?: boolean | null;
527
- }
528
- export declare enum WidthType {
529
- /** Width matches the content width */
530
- CONTENT = "CONTENT",
531
- /** Small Width */
532
- SMALL = "SMALL",
533
- /** Width will match the original asset width */
534
- ORIGINAL = "ORIGINAL",
535
- /** coast-to-coast display */
536
- FULL_WIDTH = "FULL_WIDTH"
537
- }
538
- /** @enumType */
539
- export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
540
- export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
541
- /**
542
- * One of the following predefined width options:
543
- * `CONTENT`: The width of the container matches the content width.
544
- * `SMALL`: A small width.
545
- * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
546
- * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
547
- */
548
- size?: WidthTypeWithLiterals;
549
- /** A custom width value in pixels. */
550
- custom?: string | null;
551
- }
552
- /** @oneof */
553
- export interface PluginContainerDataWidthDataOneOf {
554
- /**
555
- * One of the following predefined width options:
556
- * `CONTENT`: The width of the container matches the content width.
557
- * `SMALL`: A small width.
558
- * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
559
- * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
560
- */
561
- size?: WidthTypeWithLiterals;
562
- /** A custom width value in pixels. */
563
- custom?: string | null;
564
- }
565
- export declare enum PluginContainerDataAlignment {
566
- /** Center Alignment */
567
- CENTER = "CENTER",
568
- /** Left Alignment */
569
- LEFT = "LEFT",
570
- /** Right Alignment */
571
- RIGHT = "RIGHT"
572
- }
573
- /** @enumType */
574
- export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
575
- export interface Spoiler {
576
- /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
577
- enabled?: boolean | null;
578
- /** The description displayed on top of the spoiler cover. */
579
- description?: string | null;
580
- /** The text for the button used to remove the spoiler cover. */
581
- buttonText?: string | null;
582
- }
583
- export interface Height {
584
- /** A custom height value in pixels. */
585
- custom?: string | null;
586
- }
587
- export declare enum ButtonDataType {
588
- /** Regular link button */
589
- LINK = "LINK",
590
- /** Triggers custom action that is defined in plugin configuration by the consumer */
591
- ACTION = "ACTION"
592
- }
593
- /** @enumType */
594
- export type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
595
- export interface Styles {
596
- /**
597
- * Deprecated: Use `borderWidth` and `borderRadius` instead.
598
- * @deprecated
599
- */
600
- border?: Border;
601
- /**
602
- * Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
603
- * @deprecated
604
- */
605
- colors?: Colors;
606
- /** Border width in pixels. */
607
- borderWidth?: number | null;
608
- /**
609
- * Deprecated: Use `borderWidth` for normal/hover states instead.
610
- * @deprecated
611
- */
612
- borderWidthHover?: number | null;
613
- /** Border radius in pixels. */
614
- borderRadius?: number | null;
615
- /**
616
- * Border color as a hexadecimal value.
617
- * @format COLOR_HEX
618
- */
619
- borderColor?: string | null;
620
- /**
621
- * Border color as a hexadecimal value (hover state).
622
- * @format COLOR_HEX
623
- */
624
- borderColorHover?: string | null;
625
- /**
626
- * Text color as a hexadecimal value.
627
- * @format COLOR_HEX
628
- */
629
- textColor?: string | null;
630
- /**
631
- * Text color as a hexadecimal value (hover state).
632
- * @format COLOR_HEX
633
- */
634
- textColorHover?: string | null;
635
- /**
636
- * Background color as a hexadecimal value.
637
- * @format COLOR_HEX
638
- */
639
- backgroundColor?: string | null;
640
- /**
641
- * Background color as a hexadecimal value (hover state).
642
- * @format COLOR_HEX
643
- */
644
- backgroundColorHover?: string | null;
645
- /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
646
- buttonSize?: string | null;
647
- }
648
- export interface Link extends LinkDataOneOf {
649
- /** The absolute URL for the linked document. */
650
- url?: string;
651
- /** The target node's ID. Used for linking to another node in this object. */
652
- anchor?: string;
653
- /**
654
- * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
655
- * `SELF` - Default. Opens the linked document in the same frame as the link.
656
- * `BLANK` - Opens the linked document in a new browser tab or window.
657
- * `PARENT` - Opens the linked document in the link's parent frame.
658
- * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
659
- */
660
- target?: TargetWithLiterals;
661
- /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
662
- rel?: Rel;
663
- /** A serialized object used for a custom or external link panel. */
664
- customData?: string | null;
665
- }
666
- /** @oneof */
667
- export interface LinkDataOneOf {
668
- /** The absolute URL for the linked document. */
669
- url?: string;
670
- /** The target node's ID. Used for linking to another node in this object. */
671
- anchor?: string;
672
- }
673
- export declare enum Target {
674
- /** Opens the linked document in the same frame as it was clicked (this is default) */
675
- SELF = "SELF",
676
- /** Opens the linked document in a new window or tab */
677
- BLANK = "BLANK",
678
- /** Opens the linked document in the parent frame */
679
- PARENT = "PARENT",
680
- /** Opens the linked document in the full body of the window */
681
- TOP = "TOP"
682
- }
683
- /** @enumType */
684
- export type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
685
- export interface Rel {
686
- /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
687
- nofollow?: boolean | null;
688
- /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
689
- sponsored?: boolean | null;
690
- /** 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`. */
691
- ugc?: boolean | null;
692
- /** Indicates that this link protect referral information from being passed to the target website. */
693
- noreferrer?: boolean | null;
694
- }
695
- export interface CodeBlockData {
696
- /** Styling for the code block's text. */
697
- textStyle?: TextStyle;
698
- }
699
- export interface TextStyle {
700
- /** Text alignment. Defaults to `AUTO`. */
701
- textAlignment?: TextAlignmentWithLiterals;
702
- /** 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. */
703
- lineHeight?: string | null;
704
- }
705
- export declare enum TextAlignment {
706
- /** browser default, eqivalent to `initial` */
707
- AUTO = "AUTO",
708
- /** Left align */
709
- LEFT = "LEFT",
710
- /** Right align */
711
- RIGHT = "RIGHT",
712
- /** Center align */
713
- CENTER = "CENTER",
714
- /** 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 */
715
- JUSTIFY = "JUSTIFY"
716
- }
717
- /** @enumType */
718
- export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
719
- export interface DividerData {
720
- /** Styling for the divider's container. */
721
- containerData?: PluginContainerData;
722
- /** Divider line style. */
723
- lineStyle?: LineStyleWithLiterals;
724
- /** Divider width. */
725
- width?: WidthWithLiterals;
726
- /** Divider alignment. */
727
- alignment?: AlignmentWithLiterals;
728
- }
729
- export declare enum LineStyle {
730
- /** Single Line */
731
- SINGLE = "SINGLE",
732
- /** Double Line */
733
- DOUBLE = "DOUBLE",
734
- /** Dashed Line */
735
- DASHED = "DASHED",
736
- /** Dotted Line */
737
- DOTTED = "DOTTED"
738
- }
739
- /** @enumType */
740
- export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
741
- export declare enum Width {
742
- /** Large line */
743
- LARGE = "LARGE",
744
- /** Medium line */
745
- MEDIUM = "MEDIUM",
746
- /** Small line */
747
- SMALL = "SMALL"
748
- }
749
- /** @enumType */
750
- export type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
751
- export declare enum Alignment {
752
- /** Center alignment */
753
- CENTER = "CENTER",
754
- /** Left alignment */
755
- LEFT = "LEFT",
756
- /** Right alignment */
757
- RIGHT = "RIGHT"
758
- }
759
- /** @enumType */
760
- export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
761
- export interface FileData {
762
- /** Styling for the file's container. */
763
- containerData?: PluginContainerData;
764
- /** The source for the file's data. */
765
- src?: FileSource;
766
- /** File name. */
767
- name?: string | null;
768
- /** File type. */
769
- type?: string | null;
770
- /**
771
- * Use `sizeInKb` instead.
772
- * @deprecated
773
- */
774
- size?: number | null;
775
- /** Settings for PDF files. */
776
- pdfSettings?: PDFSettings;
777
- /** File MIME type. */
778
- mimeType?: string | null;
779
- /** File path. */
780
- path?: string | null;
781
- /** File size in KB. */
782
- sizeInKb?: string | null;
783
- }
784
- export declare enum ViewMode {
785
- /** No PDF view */
786
- NONE = "NONE",
787
- /** Full PDF view */
788
- FULL = "FULL",
789
- /** Mini PDF view */
790
- MINI = "MINI"
791
- }
792
- /** @enumType */
793
- export type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
794
- export interface FileSource extends FileSourceDataOneOf {
795
- /** The absolute URL for the file's source. */
796
- url?: string | null;
797
- /**
798
- * Custom ID. Use `id` instead.
799
- * @deprecated
800
- */
801
- custom?: string | null;
802
- /** An ID that's resolved to a URL by a resolver function. */
803
- id?: string | null;
804
- /** Indicates whether the file's source is private. Defaults to `false`. */
805
- private?: boolean | null;
806
- }
807
- /** @oneof */
808
- export interface FileSourceDataOneOf {
809
- /** The absolute URL for the file's source. */
810
- url?: string | null;
811
- /**
812
- * Custom ID. Use `id` instead.
813
- * @deprecated
814
- */
815
- custom?: string | null;
816
- /** An ID that's resolved to a URL by a resolver function. */
817
- id?: string | null;
818
- }
819
- export interface PDFSettings {
820
- /**
821
- * PDF view mode. One of the following:
822
- * `NONE` : The PDF isn't displayed.
823
- * `FULL` : A full page view of the PDF is displayed.
824
- * `MINI` : A mini view of the PDF is displayed.
825
- */
826
- viewMode?: ViewModeWithLiterals;
827
- /** Sets whether the PDF download button is disabled. Defaults to `false`. */
828
- disableDownload?: boolean | null;
829
- /** Sets whether the PDF print button is disabled. Defaults to `false`. */
830
- disablePrint?: boolean | null;
831
- }
832
- export interface GalleryData {
833
- /** Styling for the gallery's container. */
834
- containerData?: PluginContainerData;
835
- /** The items in the gallery. */
836
- items?: Item[];
837
- /** Options for defining the gallery's appearance. */
838
- options?: GalleryOptions;
839
- /** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
840
- disableExpand?: boolean | null;
841
- /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
842
- disableDownload?: boolean | null;
843
- }
844
- export interface V1Media {
845
- /** The source for the media's data. */
846
- src?: FileSource;
847
- /** Media width in pixels. */
848
- width?: number | null;
849
- /** Media height in pixels. */
850
- height?: number | null;
851
- /** Media duration in seconds. Only relevant for audio and video files. */
852
- duration?: number | null;
853
- }
854
- export interface ItemImage {
855
- /** Image file details. */
856
- media?: V1Media;
857
- /** Link details for images that are links. */
858
- link?: Link;
859
- }
860
- export interface ItemVideo {
861
- /** Video file details. */
862
- media?: V1Media;
863
- /** Video thumbnail file details. */
864
- thumbnail?: V1Media;
865
- }
866
- export interface Item extends ItemDataOneOf {
867
- /** An image item. */
868
- image?: ItemImage;
869
- /** A video item. */
870
- video?: ItemVideo;
871
- /** Item title. */
872
- title?: string | null;
873
- /** Item's alternative text. */
874
- altText?: string | null;
875
- }
876
- /** @oneof */
877
- export interface ItemDataOneOf {
878
- /** An image item. */
879
- image?: ItemImage;
880
- /** A video item. */
881
- video?: ItemVideo;
882
- }
883
- export interface GalleryOptions {
884
- /** Gallery layout. */
885
- layout?: Layout;
886
- /** Styling for gallery items. */
887
- item?: ItemStyle;
888
- /** Styling for gallery thumbnail images. */
889
- thumbnails?: Thumbnails;
890
- }
891
- export declare enum LayoutType {
892
- /** Collage type */
893
- COLLAGE = "COLLAGE",
894
- /** Masonry type */
895
- MASONRY = "MASONRY",
896
- /** Grid type */
897
- GRID = "GRID",
898
- /** Thumbnail type */
899
- THUMBNAIL = "THUMBNAIL",
900
- /** Slider type */
901
- SLIDER = "SLIDER",
902
- /** Slideshow type */
903
- SLIDESHOW = "SLIDESHOW",
904
- /** Panorama type */
905
- PANORAMA = "PANORAMA",
906
- /** Column type */
907
- COLUMN = "COLUMN",
908
- /** Magic type */
909
- MAGIC = "MAGIC",
910
- /** Fullsize images type */
911
- FULLSIZE = "FULLSIZE"
912
- }
913
- /** @enumType */
914
- export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
915
- export declare enum Orientation {
916
- /** Rows Orientation */
917
- ROWS = "ROWS",
918
- /** Columns Orientation */
919
- COLUMNS = "COLUMNS"
920
- }
921
- /** @enumType */
922
- export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
923
- export declare enum Crop {
924
- /** Crop to fill */
925
- FILL = "FILL",
926
- /** Crop to fit */
927
- FIT = "FIT"
928
- }
929
- /** @enumType */
930
- export type CropWithLiterals = Crop | 'FILL' | 'FIT';
931
- export declare enum ThumbnailsAlignment {
932
- /** Top alignment */
933
- TOP = "TOP",
934
- /** Right alignment */
935
- RIGHT = "RIGHT",
936
- /** Bottom alignment */
937
- BOTTOM = "BOTTOM",
938
- /** Left alignment */
939
- LEFT = "LEFT",
940
- /** No thumbnail */
941
- NONE = "NONE"
942
- }
943
- /** @enumType */
944
- export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
945
- export interface Layout {
946
- /** Gallery layout type. */
947
- type?: LayoutTypeWithLiterals;
948
- /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
949
- horizontalScroll?: boolean | null;
950
- /** Gallery orientation. */
951
- orientation?: OrientationWithLiterals;
952
- /** The number of columns to display on full size screens. */
953
- numberOfColumns?: number | null;
954
- /** The number of columns to display on mobile screens. */
955
- mobileNumberOfColumns?: number | null;
956
- }
957
- export interface ItemStyle {
958
- /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
959
- targetSize?: number | null;
960
- /** Item ratio */
961
- ratio?: number | null;
962
- /** Sets how item images are cropped. */
963
- crop?: CropWithLiterals;
964
- /** The spacing between items in pixels. */
965
- spacing?: number | null;
966
- }
967
- export interface Thumbnails {
968
- /** Thumbnail alignment. */
969
- placement?: ThumbnailsAlignmentWithLiterals;
970
- /** Spacing between thumbnails in pixels. */
971
- spacing?: number | null;
972
- }
973
- export interface GIFData {
974
- /** Styling for the GIF's container. */
975
- containerData?: PluginContainerData;
976
- /** The source of the full size GIF. */
977
- original?: GIF;
978
- /** The source of the downsized GIF. */
979
- downsized?: GIF;
980
- /** Height in pixels. */
981
- height?: number;
982
- /** Width in pixels. */
983
- width?: number;
984
- /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
985
- gifType?: GIFTypeWithLiterals;
986
- }
987
- export interface GIF {
988
- /**
989
- * GIF format URL.
990
- * @format WEB_URL
991
- */
992
- gif?: string | null;
993
- /**
994
- * MP4 format URL.
995
- * @format WEB_URL
996
- */
997
- mp4?: string | null;
998
- /**
999
- * Thumbnail URL.
1000
- * @format WEB_URL
1001
- */
1002
- still?: string | null;
1003
- }
1004
- export declare enum GIFType {
1005
- NORMAL = "NORMAL",
1006
- STICKER = "STICKER"
1007
- }
1008
- /** @enumType */
1009
- export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
1010
- export interface HeadingData {
1011
- /** Heading level from 1-6. */
1012
- level?: number;
1013
- /** Styling for the heading text. */
1014
- textStyle?: TextStyle;
1015
- /** Indentation level from 1-4. */
1016
- indentation?: number | null;
1017
- }
1018
- export interface HTMLData extends HTMLDataDataOneOf {
1019
- /** The URL for the HTML code for the node. */
1020
- url?: string;
1021
- /** The HTML code for the node. */
1022
- html?: string;
1023
- /**
1024
- * Whether this is an AdSense element. Use `source` instead.
1025
- * @deprecated
1026
- */
1027
- isAdsense?: boolean | null;
1028
- /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
1029
- containerData?: PluginContainerData;
1030
- /** The type of HTML code. */
1031
- source?: SourceWithLiterals;
1032
- /** If container height is aligned with its content height. Defaults to `true`. */
1033
- autoHeight?: boolean | null;
1034
- }
1035
- /** @oneof */
1036
- export interface HTMLDataDataOneOf {
1037
- /** The URL for the HTML code for the node. */
1038
- url?: string;
1039
- /** The HTML code for the node. */
1040
- html?: string;
1041
- /**
1042
- * Whether this is an AdSense element. Use `source` instead.
1043
- * @deprecated
1044
- */
1045
- isAdsense?: boolean | null;
1046
- }
1047
- export declare enum Source {
1048
- HTML = "HTML",
1049
- ADSENSE = "ADSENSE"
1050
- }
1051
- /** @enumType */
1052
- export type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
1053
- export interface ImageData {
1054
- /** Styling for the image's container. */
1055
- containerData?: PluginContainerData;
1056
- /** Image file details. */
1057
- image?: V1Media;
1058
- /** Link details for images that are links. */
1059
- link?: Link;
1060
- /** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
1061
- disableExpand?: boolean | null;
1062
- /** Image's alternative text. */
1063
- altText?: string | null;
1064
- /**
1065
- * Deprecated: use Caption node instead.
1066
- * @deprecated
1067
- */
1068
- caption?: string | null;
1069
- /** Sets whether the image's download button is disabled. Defaults to `false`. */
1070
- disableDownload?: boolean | null;
1071
- /** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
1072
- decorative?: boolean | null;
1073
- /** Styling for the image. */
1074
- styles?: ImageDataStyles;
1075
- }
1076
- export interface StylesBorder {
1077
- /** Border width in pixels. */
1078
- width?: number | null;
1079
- /**
1080
- * Border color as a hexadecimal value.
1081
- * @format COLOR_HEX
1082
- */
1083
- color?: string | null;
1084
- /** Border radius in pixels. */
1085
- radius?: number | null;
1086
- }
1087
- export interface ImageDataStyles {
1088
- /** Border attributes. */
1089
- border?: StylesBorder;
1090
- }
1091
- export interface LinkPreviewData {
1092
- /** Styling for the link preview's container. */
1093
- containerData?: PluginContainerData;
1094
- /** Link details. */
1095
- link?: Link;
1096
- /** Preview title. */
1097
- title?: string | null;
1098
- /** Preview thumbnail URL. */
1099
- thumbnailUrl?: string | null;
1100
- /** Preview description. */
1101
- description?: string | null;
1102
- /** The preview content as HTML. */
1103
- html?: string | null;
1104
- /** Styling for the link preview. */
1105
- styles?: LinkPreviewDataStyles;
1106
- }
1107
- export declare enum Position {
1108
- /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
1109
- START = "START",
1110
- /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
1111
- END = "END",
1112
- /** Thumbnail positioned at the top */
1113
- TOP = "TOP",
1114
- /** Thumbnail hidden and not displayed */
1115
- HIDDEN = "HIDDEN"
1116
- }
1117
- /** @enumType */
1118
- export type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
1119
- export interface LinkPreviewDataStyles {
1120
- /**
1121
- * Background color as a hexadecimal value.
1122
- * @format COLOR_HEX
1123
- */
1124
- backgroundColor?: string | null;
1125
- /**
1126
- * Title color as a hexadecimal value.
1127
- * @format COLOR_HEX
1128
- */
1129
- titleColor?: string | null;
1130
- /**
1131
- * Subtitle color as a hexadecimal value.
1132
- * @format COLOR_HEX
1133
- */
1134
- subtitleColor?: string | null;
1135
- /**
1136
- * Link color as a hexadecimal value.
1137
- * @format COLOR_HEX
1138
- */
1139
- linkColor?: string | null;
1140
- /** Border width in pixels. */
1141
- borderWidth?: number | null;
1142
- /** Border radius in pixels. */
1143
- borderRadius?: number | null;
1144
- /**
1145
- * Border color as a hexadecimal value.
1146
- * @format COLOR_HEX
1147
- */
1148
- borderColor?: string | null;
1149
- /** Position of thumbnail. Defaults to `START`. */
1150
- thumbnailPosition?: PositionWithLiterals;
1151
- }
1152
- export interface MapData {
1153
- /** Styling for the map's container. */
1154
- containerData?: PluginContainerData;
1155
- /** Map settings. */
1156
- mapSettings?: MapSettings;
1157
- }
1158
- export interface MapSettings {
1159
- /** The address to display on the map. */
1160
- address?: string | null;
1161
- /** Sets whether the map is draggable. */
1162
- draggable?: boolean | null;
1163
- /** Sets whether the location marker is visible. */
1164
- marker?: boolean | null;
1165
- /** Sets whether street view control is enabled. */
1166
- streetViewControl?: boolean | null;
1167
- /** Sets whether zoom control is enabled. */
1168
- zoomControl?: boolean | null;
1169
- /** Location latitude. */
1170
- lat?: number | null;
1171
- /** Location longitude. */
1172
- lng?: number | null;
1173
- /** Location name. */
1174
- locationName?: string | null;
1175
- /** Sets whether view mode control is enabled. */
1176
- viewModeControl?: boolean | null;
1177
- /** Initial zoom value. */
1178
- initialZoom?: number | null;
1179
- /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
1180
- mapType?: MapTypeWithLiterals;
1181
- }
1182
- export declare enum MapType {
1183
- /** Roadmap map type */
1184
- ROADMAP = "ROADMAP",
1185
- /** Satellite map type */
1186
- SATELITE = "SATELITE",
1187
- /** Hybrid map type */
1188
- HYBRID = "HYBRID",
1189
- /** Terrain map type */
1190
- TERRAIN = "TERRAIN"
1191
- }
1192
- /** @enumType */
1193
- export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
1194
- export interface ParagraphData {
1195
- /** Styling for the paragraph text. */
1196
- textStyle?: TextStyle;
1197
- /** Indentation level from 1-4. */
1198
- indentation?: number | null;
1199
- /** Paragraph level */
1200
- level?: number | null;
1201
- }
1202
- export interface PollData {
1203
- /** Styling for the poll's container. */
1204
- containerData?: PluginContainerData;
1205
- /** Poll data. */
1206
- poll?: Poll;
1207
- /** Layout settings for the poll and voting options. */
1208
- layout?: PollDataLayout;
1209
- /** Styling for the poll and voting options. */
1210
- design?: Design;
1211
- }
1212
- export declare enum ViewRole {
1213
- /** Only Poll creator can view the results */
1214
- CREATOR = "CREATOR",
1215
- /** Anyone who voted can see the results */
1216
- VOTERS = "VOTERS",
1217
- /** Anyone can see the results, even if one didn't vote */
1218
- EVERYONE = "EVERYONE"
1219
- }
1220
- /** @enumType */
1221
- export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
1222
- export declare enum VoteRole {
1223
- /** Logged in member */
1224
- SITE_MEMBERS = "SITE_MEMBERS",
1225
- /** Anyone */
1226
- ALL = "ALL"
1227
- }
1228
- /** @enumType */
1229
- export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
1230
- export interface Permissions {
1231
- /** Sets who can view the poll results. */
1232
- view?: ViewRoleWithLiterals;
1233
- /** Sets who can vote. */
1234
- vote?: VoteRoleWithLiterals;
1235
- /** Sets whether one voter can vote multiple times. Defaults to `false`. */
1236
- allowMultipleVotes?: boolean | null;
1237
- }
1238
- export interface Option {
1239
- /** Option ID. */
1240
- id?: string | null;
1241
- /** Option title. */
1242
- title?: string | null;
1243
- /** The image displayed with the option. */
1244
- image?: V1Media;
1245
- }
1246
- export interface PollSettings {
1247
- /** Permissions settings for voting. */
1248
- permissions?: Permissions;
1249
- /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
1250
- showVoters?: boolean | null;
1251
- /** Sets whether the vote count is displayed. Defaults to `true`. */
1252
- showVotesCount?: boolean | null;
1253
- }
1254
- export declare enum PollLayoutType {
1255
- /** List */
1256
- LIST = "LIST",
1257
- /** Grid */
1258
- GRID = "GRID"
1259
- }
1260
- /** @enumType */
1261
- export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
1262
- export declare enum PollLayoutDirection {
1263
- /** Left-to-right */
1264
- LTR = "LTR",
1265
- /** Right-to-left */
1266
- RTL = "RTL"
1267
- }
1268
- /** @enumType */
1269
- export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
1270
- export interface PollLayout {
1271
- /** The layout for displaying the voting options. */
1272
- type?: PollLayoutTypeWithLiterals;
1273
- /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
1274
- direction?: PollLayoutDirectionWithLiterals;
1275
- /** Sets whether to display the main poll image. Defaults to `false`. */
1276
- enableImage?: boolean | null;
1277
- }
1278
- export interface OptionLayout {
1279
- /** Sets whether to display option images. Defaults to `false`. */
1280
- enableImage?: boolean | null;
1281
- }
1282
- export declare enum BackgroundType {
1283
- /** Color background type */
1284
- COLOR = "COLOR",
1285
- /** Image background type */
1286
- IMAGE = "IMAGE",
1287
- /** Gradiant background type */
1288
- GRADIENT = "GRADIENT"
1289
- }
1290
- /** @enumType */
1291
- export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
1292
- export interface Gradient {
1293
- /** The gradient angle in degrees. */
1294
- angle?: number | null;
1295
- /**
1296
- * The start color as a hexademical value.
1297
- * @format COLOR_HEX
1298
- */
1299
- startColor?: string | null;
1300
- /**
1301
- * The end color as a hexademical value.
1302
- * @format COLOR_HEX
1303
- */
1304
- lastColor?: string | null;
1305
- }
1306
- export interface Background extends BackgroundBackgroundOneOf {
1307
- /**
1308
- * The background color as a hexademical value.
1309
- * @format COLOR_HEX
1310
- */
1311
- color?: string | null;
1312
- /** An image to use for the background. */
1313
- image?: V1Media;
1314
- /** Details for a gradient background. */
1315
- gradient?: Gradient;
1316
- /** Background type. For each option, include the relevant details. */
1317
- type?: BackgroundTypeWithLiterals;
1318
- }
1319
- /** @oneof */
1320
- export interface BackgroundBackgroundOneOf {
1321
- /**
1322
- * The background color as a hexademical value.
1323
- * @format COLOR_HEX
1324
- */
1325
- color?: string | null;
1326
- /** An image to use for the background. */
1327
- image?: V1Media;
1328
- /** Details for a gradient background. */
1329
- gradient?: Gradient;
1330
- }
1331
- export interface PollDesign {
1332
- /** Background styling. */
1333
- background?: Background;
1334
- /** Border radius in pixels. */
1335
- borderRadius?: number | null;
1336
- }
1337
- export interface OptionDesign {
1338
- /** Border radius in pixels. */
1339
- borderRadius?: number | null;
1340
- }
1341
- export interface Poll {
1342
- /** Poll ID. */
1343
- id?: string | null;
1344
- /** Poll title. */
1345
- title?: string | null;
1346
- /** Poll creator ID. */
1347
- creatorId?: string | null;
1348
- /** Main poll image. */
1349
- image?: V1Media;
1350
- /** Voting options. */
1351
- options?: Option[];
1352
- /** The poll's permissions and display settings. */
1353
- settings?: PollSettings;
1354
- }
1355
- export interface PollDataLayout {
1356
- /** Poll layout settings. */
1357
- poll?: PollLayout;
1358
- /** Voting otpions layout settings. */
1359
- options?: OptionLayout;
1360
- }
1361
- export interface Design {
1362
- /** Styling for the poll. */
1363
- poll?: PollDesign;
1364
- /** Styling for voting options. */
1365
- options?: OptionDesign;
1366
- }
1367
- export interface TextData {
1368
- /** The text to apply decorations to. */
1369
- text?: string;
1370
- /** The decorations to apply. */
1371
- decorations?: Decoration[];
1372
- }
1373
- /** Adds appearence changes to text */
1374
- export interface Decoration extends DecorationDataOneOf {
1375
- /** Data for an anchor link decoration. */
1376
- anchorData?: AnchorData;
1377
- /** Data for a color decoration. */
1378
- colorData?: ColorData;
1379
- /** Data for an external link decoration. */
1380
- linkData?: LinkData;
1381
- /** Data for a mention decoration. */
1382
- mentionData?: MentionData;
1383
- /** Data for a font size decoration. */
1384
- fontSizeData?: FontSizeData;
1385
- /** Font weight for a bold decoration. */
1386
- fontWeightValue?: number | null;
1387
- /** Data for an italic decoration. Defaults to `true`. */
1388
- italicData?: boolean | null;
1389
- /** Data for an underline decoration. Defaults to `true`. */
1390
- underlineData?: boolean | null;
1391
- /** Data for a spoiler decoration. */
1392
- spoilerData?: SpoilerData;
1393
- /** Data for a strikethrough decoration. Defaults to `true`. */
1394
- strikethroughData?: boolean | null;
1395
- /** The type of decoration to apply. */
1396
- type?: DecorationTypeWithLiterals;
1397
- }
1398
- /** @oneof */
1399
- export interface DecorationDataOneOf {
1400
- /** Data for an anchor link decoration. */
1401
- anchorData?: AnchorData;
1402
- /** Data for a color decoration. */
1403
- colorData?: ColorData;
1404
- /** Data for an external link decoration. */
1405
- linkData?: LinkData;
1406
- /** Data for a mention decoration. */
1407
- mentionData?: MentionData;
1408
- /** Data for a font size decoration. */
1409
- fontSizeData?: FontSizeData;
1410
- /** Font weight for a bold decoration. */
1411
- fontWeightValue?: number | null;
1412
- /** Data for an italic decoration. Defaults to `true`. */
1413
- italicData?: boolean | null;
1414
- /** Data for an underline decoration. Defaults to `true`. */
1415
- underlineData?: boolean | null;
1416
- /** Data for a spoiler decoration. */
1417
- spoilerData?: SpoilerData;
1418
- /** Data for a strikethrough decoration. Defaults to `true`. */
1419
- strikethroughData?: boolean | null;
1420
- }
1421
- export declare enum DecorationType {
1422
- BOLD = "BOLD",
1423
- ITALIC = "ITALIC",
1424
- UNDERLINE = "UNDERLINE",
1425
- SPOILER = "SPOILER",
1426
- ANCHOR = "ANCHOR",
1427
- MENTION = "MENTION",
1428
- LINK = "LINK",
1429
- COLOR = "COLOR",
1430
- FONT_SIZE = "FONT_SIZE",
1431
- EXTERNAL = "EXTERNAL",
1432
- STRIKETHROUGH = "STRIKETHROUGH"
1433
- }
1434
- /** @enumType */
1435
- export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
1436
- export interface AnchorData {
1437
- /** The target node's ID. */
1438
- anchor?: string;
1439
- }
1440
- export interface ColorData {
1441
- /** The text's background color as a hexadecimal value. */
1442
- background?: string | null;
1443
- /** The text's foreground color as a hexadecimal value. */
1444
- foreground?: string | null;
1445
- }
1446
- export interface LinkData {
1447
- /** Link details. */
1448
- link?: Link;
1449
- }
1450
- export interface MentionData {
1451
- /** The mentioned user's name. */
1452
- name?: string;
1453
- /** The version of the user's name that appears after the `@` character in the mention. */
1454
- slug?: string;
1455
- /** Mentioned user's ID. */
1456
- id?: string | null;
1457
- }
1458
- export interface FontSizeData {
1459
- /** The units used for the font size. */
1460
- unit?: FontTypeWithLiterals;
1461
- /** Font size value. */
1462
- value?: number | null;
1463
- }
1464
- export declare enum FontType {
1465
- PX = "PX",
1466
- EM = "EM"
1467
- }
1468
- /** @enumType */
1469
- export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
1470
- export interface SpoilerData {
1471
- /** Spoiler ID. */
1472
- id?: string | null;
1473
- }
1474
- export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1475
- /** Data for embedded Wix Bookings content. */
1476
- bookingData?: BookingData;
1477
- /** Data for embedded Wix Events content. */
1478
- eventData?: EventData;
1479
- /** The type of Wix App content being embedded. */
1480
- type?: AppTypeWithLiterals;
1481
- /** The ID of the embedded content. */
1482
- itemId?: string | null;
1483
- /** The name of the embedded content. */
1484
- name?: string | null;
1485
- /**
1486
- * Deprecated: Use `image` instead.
1487
- * @deprecated
1488
- */
1489
- imageSrc?: string | null;
1490
- /** The URL for the embedded content. */
1491
- url?: string | null;
1492
- /** An image for the embedded content. */
1493
- image?: V1Media;
1494
- }
1495
- /** @oneof */
1496
- export interface AppEmbedDataAppDataOneOf {
1497
- /** Data for embedded Wix Bookings content. */
1498
- bookingData?: BookingData;
1499
- /** Data for embedded Wix Events content. */
1500
- eventData?: EventData;
1501
- }
1502
- export declare enum AppType {
1503
- PRODUCT = "PRODUCT",
1504
- EVENT = "EVENT",
1505
- BOOKING = "BOOKING"
1506
- }
1507
- /** @enumType */
1508
- export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
1509
- export interface BookingData {
1510
- /** Booking duration in minutes. */
1511
- durations?: string | null;
1512
- }
1513
- export interface EventData {
1514
- /** Event schedule. */
1515
- scheduling?: string | null;
1516
- /** Event location. */
1517
- location?: string | null;
1518
- }
1519
- export interface VideoData {
1520
- /** Styling for the video's container. */
1521
- containerData?: PluginContainerData;
1522
- /** Video details. */
1523
- video?: V1Media;
1524
- /** Video thumbnail details. */
1525
- thumbnail?: V1Media;
1526
- /** Sets whether the video's download button is disabled. Defaults to `false`. */
1527
- disableDownload?: boolean | null;
1528
- /** Video title. */
1529
- title?: string | null;
1530
- /** Video options. */
1531
- options?: PlaybackOptions;
1532
- }
1533
- export interface PlaybackOptions {
1534
- /** Sets whether the media will automatically start playing. */
1535
- autoPlay?: boolean | null;
1536
- /** Sets whether media's will be looped. */
1537
- playInLoop?: boolean | null;
1538
- /** Sets whether media's controls will be shown. */
1539
- showControls?: boolean | null;
1540
- }
1541
- export interface EmbedData {
1542
- /** Styling for the oEmbed node's container. */
1543
- containerData?: PluginContainerData;
1544
- /** An [oEmbed](https://www.oembed.com) object. */
1545
- oembed?: Oembed;
1546
- /** Origin asset source. */
1547
- src?: string | null;
1548
- }
1549
- export interface Oembed {
1550
- /** The resource type. */
1551
- type?: string | null;
1552
- /** The width of the resource specified in the `url` property in pixels. */
1553
- width?: number | null;
1554
- /** The height of the resource specified in the `url` property in pixels. */
1555
- height?: number | null;
1556
- /** Resource title. */
1557
- title?: string | null;
1558
- /** The source URL for the resource. */
1559
- url?: string | null;
1560
- /** HTML for embedding a video player. The HTML should have no padding or margins. */
1561
- html?: string | null;
1562
- /** The name of the author or owner of the resource. */
1563
- authorName?: string | null;
1564
- /** The URL for the author or owner of the resource. */
1565
- authorUrl?: string | null;
1566
- /** The name of the resource provider. */
1567
- providerName?: string | null;
1568
- /** The URL for the resource provider. */
1569
- providerUrl?: string | null;
1570
- /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
1571
- thumbnailUrl?: string | null;
1572
- /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
1573
- thumbnailWidth?: string | null;
1574
- /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
1575
- thumbnailHeight?: string | null;
1576
- /** The URL for an embedded viedo. */
1577
- videoUrl?: string | null;
1578
- /** The oEmbed version number. This value must be `1.0`. */
1579
- version?: string | null;
1580
- }
1581
- export interface CollapsibleListData {
1582
- /** Styling for the collapsible list's container. */
1583
- containerData?: PluginContainerData;
1584
- /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
1585
- expandOnlyOne?: boolean | null;
1586
- /** Sets which items are expanded when the page loads. */
1587
- initialExpandedItems?: InitialExpandedItemsWithLiterals;
1588
- /** The direction of the text in the list. Either left-to-right or right-to-left. */
1589
- direction?: DirectionWithLiterals;
1590
- /** If `true`, The collapsible item will appear in search results as an FAQ. */
1591
- isQapageData?: boolean | null;
1592
- }
1593
- export declare enum InitialExpandedItems {
1594
- /** First item will be expended initally */
1595
- FIRST = "FIRST",
1596
- /** All items will expended initally */
1597
- ALL = "ALL",
1598
- /** All items collapsed initally */
1599
- NONE = "NONE"
1600
- }
1601
- /** @enumType */
1602
- export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
1603
- export declare enum Direction {
1604
- /** Left-to-right */
1605
- LTR = "LTR",
1606
- /** Right-to-left */
1607
- RTL = "RTL"
1608
- }
1609
- /** @enumType */
1610
- export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
1611
- export interface TableData {
1612
- /** Styling for the table's container. */
1613
- containerData?: PluginContainerData;
1614
- /** The table's dimensions. */
1615
- dimensions?: Dimensions;
1616
- /**
1617
- * Deprecated: Use `rowHeader` and `columnHeader` instead.
1618
- * @deprecated
1619
- */
1620
- header?: boolean | null;
1621
- /** Sets whether the table's first row is a header. Defaults to `false`. */
1622
- rowHeader?: boolean | null;
1623
- /** Sets whether the table's first column is a header. Defaults to `false`. */
1624
- columnHeader?: boolean | null;
1625
- }
1626
- export interface Dimensions {
1627
- /** An array representing relative width of each column in relation to the other columns. */
1628
- colsWidthRatio?: number[];
1629
- /** An array representing the height of each row in pixels. */
1630
- rowsHeight?: number[];
1631
- /** An array representing the minimum width of each column in pixels. */
1632
- colsMinWidth?: number[];
1633
- }
1634
- export interface TableCellData {
1635
- /** Styling for the cell's background color and text alignment. */
1636
- cellStyle?: CellStyle;
1637
- /** The cell's border colors. */
1638
- borderColors?: BorderColors;
1639
- }
1640
- export declare enum VerticalAlignment {
1641
- /** Top alignment */
1642
- TOP = "TOP",
1643
- /** Middle alignment */
1644
- MIDDLE = "MIDDLE",
1645
- /** Bottom alignment */
1646
- BOTTOM = "BOTTOM"
1647
- }
1648
- /** @enumType */
1649
- export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
1650
- export interface CellStyle {
1651
- /** Vertical alignment for the cell's text. */
1652
- verticalAlignment?: VerticalAlignmentWithLiterals;
1653
- /**
1654
- * Cell background color as a hexadecimal value.
1655
- * @format COLOR_HEX
1656
- */
1657
- backgroundColor?: string | null;
1658
- }
1659
- export interface BorderColors {
1660
- /**
1661
- * Left border color as a hexadecimal value.
1662
- * @format COLOR_HEX
1663
- */
1664
- left?: string | null;
1665
- /**
1666
- * Right border color as a hexadecimal value.
1667
- * @format COLOR_HEX
1668
- */
1669
- right?: string | null;
1670
- /**
1671
- * Top border color as a hexadecimal value.
1672
- * @format COLOR_HEX
1673
- */
1674
- top?: string | null;
1675
- /**
1676
- * Bottom border color as a hexadecimal value.
1677
- * @format COLOR_HEX
1678
- */
1679
- bottom?: string | null;
1680
- }
1681
- /**
1682
- * `NullValue` is a singleton enumeration to represent the null value for the
1683
- * `Value` type union.
1684
- *
1685
- * The JSON representation for `NullValue` is JSON `null`.
1686
- */
1687
- export declare enum NullValue {
1688
- /** Null value. */
1689
- NULL_VALUE = "NULL_VALUE"
1690
- }
1691
- /** @enumType */
1692
- export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
1693
- /**
1694
- * `ListValue` is a wrapper around a repeated field of values.
1695
- *
1696
- * The JSON representation for `ListValue` is JSON array.
1697
- */
1698
- export interface ListValue {
1699
- /** Repeated field of dynamically typed values. */
1700
- values?: any[];
1701
- }
1702
- export interface AudioData {
1703
- /** Styling for the audio node's container. */
1704
- containerData?: PluginContainerData;
1705
- /** Audio file details. */
1706
- audio?: V1Media;
1707
- /** Sets whether the audio node's download button is disabled. Defaults to `false`. */
1708
- disableDownload?: boolean | null;
1709
- /** Cover image. */
1710
- coverImage?: V1Media;
1711
- /** Track name. */
1712
- name?: string | null;
1713
- /** Author name. */
1714
- authorName?: string | null;
1715
- /** An HTML version of the audio node. */
1716
- html?: string | null;
1717
- }
1718
- export interface OrderedListData {
1719
- /** Indentation level from 0-4. */
1720
- indentation?: number;
1721
- /** Offset level from 0-4. */
1722
- offset?: number | null;
1723
- /** List start number. */
1724
- start?: number | null;
1725
- }
1726
- export interface BulletedListData {
1727
- /** Indentation level from 0-4. */
1728
- indentation?: number;
1729
- /** Offset level from 0-4. */
1730
- offset?: number | null;
1731
- }
1732
- export interface BlockquoteData {
1733
- /** Indentation level from 1-4. */
1734
- indentation?: number;
1735
- }
1736
- export interface CaptionData {
1737
- textStyle?: TextStyle;
1738
- }
1739
- export interface LayoutCellData {
1740
- /** Size of the cell in 12 columns grid. */
1741
- colSpan?: number | null;
1742
- }
1743
- export interface Metadata {
1744
- /** Schema version. */
1745
- version?: number;
1746
- /**
1747
- * When the object was created.
1748
- * @readonly
1749
- * @deprecated
1750
- */
1751
- createdTimestamp?: Date | null;
1752
- /**
1753
- * When the object was most recently updated.
1754
- * @deprecated
1755
- */
1756
- updatedTimestamp?: Date | null;
1757
- /** Object ID. */
1758
- id?: string | null;
1759
- }
1760
- export interface DocumentStyle {
1761
- /** Styling for H1 nodes. */
1762
- headerOne?: TextNodeStyle;
1763
- /** Styling for H2 nodes. */
1764
- headerTwo?: TextNodeStyle;
1765
- /** Styling for H3 nodes. */
1766
- headerThree?: TextNodeStyle;
1767
- /** Styling for H4 nodes. */
1768
- headerFour?: TextNodeStyle;
1769
- /** Styling for H5 nodes. */
1770
- headerFive?: TextNodeStyle;
1771
- /** Styling for H6 nodes. */
1772
- headerSix?: TextNodeStyle;
1773
- /** Styling for paragraph nodes. */
1774
- paragraph?: TextNodeStyle;
1775
- /** Styling for block quote nodes. */
1776
- blockquote?: TextNodeStyle;
1777
- /** Styling for code block nodes. */
1778
- codeBlock?: TextNodeStyle;
1779
- }
1780
- export interface TextNodeStyle {
1781
- /** The decorations to apply to the node. */
1782
- decorations?: Decoration[];
1783
- /** Padding and background color for the node. */
1784
- nodeStyle?: NodeStyle;
1785
- /** Line height for text in the node. */
1786
- lineHeight?: string | null;
1787
- }
1788
- export declare enum Status {
1789
- UNKNOWN = "UNKNOWN",
1790
- /** Status indicating the draft post is published. */
1791
- PUBLISHED = "PUBLISHED",
1792
- /** Status indicating the draft post is unpublished. */
1793
- UNPUBLISHED = "UNPUBLISHED",
1794
- /** Status indicating the draft post is scheduled for publication. */
1795
- SCHEDULED = "SCHEDULED",
1796
- /** Status indicating the draft post is deleted. */
1797
- DELETED = "DELETED",
1798
- /** Status indicating the draft post is in review. */
1799
- IN_REVIEW = "IN_REVIEW"
1800
- }
1801
- /** @enumType */
1802
- export type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
1803
- export interface ModerationDetails {
1804
- /**
1805
- * Member ID of the person submitting the draft post for review.
1806
- * @format GUID
1807
- */
1808
- submittedBy?: string;
1809
- /** Date the post was submitted for review. */
1810
- submittedDate?: Date | null;
1811
- /** Status indicating whether the submission was approved or rejected by the moderator. */
1812
- status?: ModerationStatusStatusWithLiterals;
1813
- /**
1814
- * Member ID of the person who approved or rejected the post.
1815
- * @format GUID
1816
- */
1817
- moderatedBy?: string | null;
1818
- /** Date the post was approved or rejected. */
1819
- moderationDate?: Date | null;
1820
- }
1821
- export declare enum ModerationStatusStatus {
1822
- UNKNOWN = "UNKNOWN",
1823
- APPROVED = "APPROVED",
1824
- REJECTED = "REJECTED"
1825
- }
1826
- /** @enumType */
1827
- export type ModerationStatusStatusWithLiterals = ModerationStatusStatus | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
1828
- /**
1829
- * 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.
1830
- * The search engines use this information for ranking purposes, or to display snippets in the search results.
1831
- * 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.
1832
- */
1833
- export interface SeoSchema {
1834
- /** SEO tag information. */
1835
- tags?: Tag[];
1836
- /** SEO general settings. */
1837
- settings?: Settings;
1838
- }
1839
- export interface Keyword {
1840
- /** Keyword value. */
1841
- term?: string;
1842
- /** Whether the keyword is the main focus keyword. */
1843
- isMain?: boolean;
1844
- /**
1845
- * The source that added the keyword terms to the SEO settings.
1846
- * @maxLength 1000
1847
- */
1848
- origin?: string | null;
1849
- }
1850
- export interface Tag {
1851
- /**
1852
- * SEO tag type.
1853
- *
1854
- *
1855
- * Supported values: `title`, `meta`, `script`, `link`.
1856
- */
1857
- type?: string;
1858
- /**
1859
- * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
1860
- * For example: `{"name": "description", "content": "the description itself"}`.
1861
- */
1862
- props?: Record<string, any> | null;
1863
- /** SEO tag meta data. For example, `{"height": 300, "width": 240}`. */
1864
- meta?: Record<string, any> | null;
1865
- /** SEO tag inner content. For example, `<title> inner content </title>`. */
1866
- children?: string;
1867
- /** Whether the tag is a custom tag. */
1868
- custom?: boolean;
1869
- /** Whether the tag is disabled. */
1870
- disabled?: boolean;
1871
- }
1872
- export interface Settings {
1873
- /**
1874
- * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
1875
- *
1876
- *
1877
- * Default: `false` (Auto Redirect is enabled.)
1878
- */
1879
- preventAutoRedirect?: boolean;
1880
- /**
1881
- * User-selected keyword terms for a specific page.
1882
- * @maxSize 5
1883
- */
1884
- keywords?: Keyword[];
1885
- }
1886
- export interface PageUrl {
1887
- /** The base URL. For premium sites, this is the domain. For free sites, this is the site URL. For example, `mysite.wixsite.com/mysite`. */
1888
- base?: string;
1889
- /** The relative path for the page within the site. For example, `/product-page/a-product`. */
1890
- path?: string;
1891
- }
1892
- export interface Media extends MediaMediaOneOf {
1893
- /** Wix Media details. */
1894
- wixMedia?: WixMedia;
1895
- /** Embed media details. */
1896
- embedMedia?: EmbedMedia;
1897
- /** Whether cover media is displayed. */
1898
- displayed?: boolean;
1899
- /** Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media. */
1900
- custom?: boolean;
1901
- /**
1902
- * Media alternative text.
1903
- * @minLength 1
1904
- * @maxLength 1000
1905
- */
1906
- altText?: string | null;
1907
- }
1908
- /** @oneof */
1909
- export interface MediaMediaOneOf {
1910
- /** Wix Media details. */
1911
- wixMedia?: WixMedia;
1912
- /** Embed media details. */
1913
- embedMedia?: EmbedMedia;
1914
- }
1915
- export interface WixMedia {
1916
- /** Image details. */
1917
- image?: Image;
1918
- /** Video details. */
1919
- videoV2?: VideoV2;
1920
- }
1921
- export interface VideoV2 {
1922
- /** WixMedia ID. */
1923
- id?: string;
1924
- /**
1925
- * Available resolutions for the video, starting with the optimal resolution.
1926
- * @readonly
1927
- * @maxSize 100
1928
- */
1929
- resolutions?: VideoResolution[];
1930
- /**
1931
- * Video filename.
1932
- * @readonly
1933
- */
1934
- filename?: string | null;
1935
- }
1936
- export interface VideoResolution {
1937
- /** Video URL. */
1938
- url?: string;
1939
- /** Video height. */
1940
- height?: number;
1941
- /** Video width. */
1942
- width?: number;
1943
- /** Video format for example, mp4, hls. */
1944
- format?: string;
1945
- }
1946
- export interface EmbedMedia {
1947
- /** Thumbnail details. */
1948
- thumbnail?: EmbedThumbnail;
1949
- /** Video details. */
1950
- video?: EmbedVideo;
1951
- }
1952
- export interface EmbedThumbnail {
1953
- /**
1954
- * Thumbnail url.
1955
- * @maxLength 2000
1956
- */
1957
- url?: string;
1958
- /** Thumbnail width. */
1959
- width?: number;
1960
- /** Thumbnail height. */
1961
- height?: number;
1962
- }
1963
- export interface EmbedVideo {
1964
- /**
1965
- * Video url.
1966
- * @maxLength 2000
1967
- */
1968
- url?: string;
1969
- /** Video width. */
1970
- width?: number;
1971
- /** Video height. */
1972
- height?: number;
1973
- }
1974
- export interface DraftPostTranslation {
1975
- /**
1976
- * Post ID.
1977
- * @format GUID
1978
- */
1979
- id?: string;
1980
- /** Post status. */
1981
- status?: StatusWithLiterals;
1982
- /**
1983
- * Language the post is written in.
1984
- * @format LANGUAGE_TAG
1985
- */
1986
- language?: string | null;
1987
- /**
1988
- * Post slug. For example, 'post-slug'.
1989
- * @maxLength 100
1990
- */
1991
- slug?: string | null;
1992
- /** SEO data. */
1993
- seoData?: SeoSchema;
1994
- /** Post URL. */
1995
- url?: PageUrl;
1996
- }
1997
- export interface DraftCategoriesUpdated {
1998
- /**
1999
- * Draft post ID.
2000
- * @maxLength 38
2001
- */
2002
- draftPostId?: string;
2003
- /**
2004
- * Current categories of the draft.
2005
- * @maxSize 10
2006
- * @format GUID
2007
- */
2008
- categories?: string[];
2009
- /**
2010
- * Previous categories of the draft.
2011
- * @maxSize 10
2012
- * @format GUID
2013
- */
2014
- previousCategories?: string[];
2015
- }
2016
- export interface DraftTagsUpdated {
2017
- /**
2018
- * Draft post ID.
2019
- * @maxLength 38
2020
- */
2021
- draftPostId?: string;
2022
- /**
2023
- * Current tags of the draft.
2024
- * @maxSize 30
2025
- * @format GUID
2026
- */
2027
- tags?: string[];
2028
- /**
2029
- * Previous tags of the draft.
2030
- * @maxSize 30
2031
- * @format GUID
2032
- */
2033
- previousTags?: string[];
2034
- }
2035
- export interface GetDraftPostTotalsRequest {
2036
- /**
2037
- * Group results by fields (defaults to grouping by status).
2038
- * If, for example, grouping by language is passed, language values in response will be filled.
2039
- * If, for example, grouping by language is not passed, null values will be filled in language field in response.
2040
- * @maxSize 10
2041
- */
2042
- groupBy?: TotalDraftPostsGroupingFieldWithLiterals[];
2043
- /**
2044
- * Optional language filter by provided language code. Useful in multilingual context.
2045
- * @format LANGUAGE_TAG
2046
- */
2047
- language?: string | null;
2048
- }
2049
- export declare enum TotalDraftPostsGroupingField {
2050
- /** Groups results by status. */
2051
- STATUS = "STATUS",
2052
- /** Groups results by language. */
2053
- LANGUAGE = "LANGUAGE"
2054
- }
2055
- /** @enumType */
2056
- export type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
2057
- export interface GetDraftPostTotalsResponse {
2058
- /** Draft post totals. */
2059
- totalDraftPosts?: TotalDraftPosts[];
2060
- }
2061
- export interface TotalDraftPosts {
2062
- /** Draft post totals in that group. */
2063
- total?: number;
2064
- /** Draft post status (only has value when grouping by status, otherwise null). */
2065
- status?: StatusWithLiterals;
2066
- /**
2067
- * Draft post language code (only has value when grouping by language, otherwise null).
2068
- * @format LANGUAGE_TAG
2069
- */
2070
- language?: string | null;
2071
- }
2072
- export interface DomainEvent extends DomainEventBodyOneOf {
2073
- createdEvent?: EntityCreatedEvent;
2074
- updatedEvent?: EntityUpdatedEvent;
2075
- deletedEvent?: EntityDeletedEvent;
2076
- actionEvent?: ActionEvent;
2077
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2078
- id?: string;
2079
- /**
2080
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2081
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2082
- */
2083
- entityFqdn?: string;
2084
- /**
2085
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
2086
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2087
- */
2088
- slug?: string;
2089
- /** ID of the entity associated with the event. */
2090
- entityId?: string;
2091
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2092
- eventTime?: Date | null;
2093
- /**
2094
- * Whether the event was triggered as a result of a privacy regulation application
2095
- * (for example, GDPR).
2096
- */
2097
- triggeredByAnonymizeRequest?: boolean | null;
2098
- /** If present, indicates the action that triggered the event. */
2099
- originatedFrom?: string | null;
2100
- /**
2101
- * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
2102
- * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
2103
- */
2104
- entityEventSequence?: string | null;
2105
- }
2106
- /** @oneof */
2107
- export interface DomainEventBodyOneOf {
2108
- createdEvent?: EntityCreatedEvent;
2109
- updatedEvent?: EntityUpdatedEvent;
2110
- deletedEvent?: EntityDeletedEvent;
2111
- actionEvent?: ActionEvent;
2112
- }
2113
- export interface EntityCreatedEvent {
2114
- entityAsJson?: string;
2115
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
2116
- restoreInfo?: RestoreInfo;
2117
- }
2118
- export interface RestoreInfo {
2119
- deletedDate?: Date | null;
2120
- }
2121
- export interface EntityUpdatedEvent {
2122
- /**
2123
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2124
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2125
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2126
- */
2127
- currentEntityAsJson?: string;
2128
- }
2129
- export interface EntityDeletedEvent {
2130
- /** Entity that was deleted. */
2131
- deletedEntityAsJson?: string | null;
2132
- }
2133
- export interface ActionEvent {
2134
- bodyAsJson?: string;
2135
- }
2136
- export interface MessageEnvelope {
2137
- /**
2138
- * App instance ID.
2139
- * @format GUID
2140
- */
2141
- instanceId?: string | null;
2142
- /**
2143
- * Event type.
2144
- * @maxLength 150
2145
- */
2146
- eventType?: string;
2147
- /** The identification type and identity data. */
2148
- identity?: IdentificationData;
2149
- /** Stringify payload. */
2150
- data?: string;
2151
- }
2152
- export interface IdentificationData extends IdentificationDataIdOneOf {
2153
- /**
2154
- * ID of a site visitor that has not logged in to the site.
2155
- * @format GUID
2156
- */
2157
- anonymousVisitorId?: string;
2158
- /**
2159
- * ID of a site visitor that has logged in to the site.
2160
- * @format GUID
2161
- */
2162
- memberId?: string;
2163
- /**
2164
- * ID of a Wix user (site owner, contributor, etc.).
2165
- * @format GUID
2166
- */
2167
- wixUserId?: string;
2168
- /**
2169
- * ID of an app.
2170
- * @format GUID
2171
- */
2172
- appId?: string;
2173
- /** @readonly */
2174
- identityType?: WebhookIdentityTypeWithLiterals;
2175
- }
2176
- /** @oneof */
2177
- export interface IdentificationDataIdOneOf {
2178
- /**
2179
- * ID of a site visitor that has not logged in to the site.
2180
- * @format GUID
2181
- */
2182
- anonymousVisitorId?: string;
2183
- /**
2184
- * ID of a site visitor that has logged in to the site.
2185
- * @format GUID
2186
- */
2187
- memberId?: string;
2188
- /**
2189
- * ID of a Wix user (site owner, contributor, etc.).
2190
- * @format GUID
2191
- */
2192
- wixUserId?: string;
2193
- /**
2194
- * ID of an app.
2195
- * @format GUID
2196
- */
2197
- appId?: string;
2198
- }
2199
- export declare enum WebhookIdentityType {
2200
- UNKNOWN = "UNKNOWN",
2201
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2202
- MEMBER = "MEMBER",
2203
- WIX_USER = "WIX_USER",
2204
- APP = "APP"
2205
- }
2206
- /** @enumType */
2207
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2208
- export interface InitialDraftPostsCopied {
2209
- /** Number of draft posts copied. */
2210
- count?: number;
2211
- }
2212
- export interface CreateDraftPostRequest {
2213
- /** Draft post to create. */
2214
- draftPost: DraftPost;
2215
- /**
2216
- * Whether the draft post should be published on creation.
2217
- *
2218
- * Default: `false`
2219
- */
2220
- publish?: boolean;
2221
- /**
2222
- * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2223
- * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
2224
- * only the draft post's base fields are returned.
2225
- * @maxSize 10
2226
- */
2227
- fieldsets?: FieldWithLiterals[];
2228
- }
2229
- export declare enum Type {
2230
- UNKNOWN = "UNKNOWN",
2231
- /** Manually saved. */
2232
- MANUAL = "MANUAL",
2233
- /** Triggered by autosave. */
2234
- AUTO_SAVE = "AUTO_SAVE",
2235
- /** Copied from template during provisioning flow. */
2236
- PROVISIONING = "PROVISIONING",
2237
- /** Imported from another blog. */
2238
- IMPORT = "IMPORT",
2239
- /** Triggered by autosave when post created by AI tool. */
2240
- AI_AUTO_SAVE = "AI_AUTO_SAVE"
2241
- }
2242
- /** @enumType */
2243
- export type TypeWithLiterals = Type | 'UNKNOWN' | 'MANUAL' | 'AUTO_SAVE' | 'PROVISIONING' | 'IMPORT' | 'AI_AUTO_SAVE';
2244
- export declare enum Field {
2245
- /** Unknown field. */
2246
- UNKNOWN = "UNKNOWN",
2247
- /** Includes draft post preview URL. */
2248
- URL = "URL",
2249
- /** Includes content field. */
2250
- CONTENT = "CONTENT",
2251
- /** Includes rich content field. */
2252
- RICH_CONTENT = "RICH_CONTENT",
2253
- /** If the user has not set excerpt, returns the one autogenerated from content. */
2254
- GENERATED_EXCERPT = "GENERATED_EXCERPT"
2255
- }
2256
- /** @enumType */
2257
- export type FieldWithLiterals = Field | 'UNKNOWN' | 'URL' | 'CONTENT' | 'RICH_CONTENT' | 'GENERATED_EXCERPT';
2258
- export interface CreateDraftPostResponse {
2259
- /** Created draft post info. */
2260
- draftPost?: DraftPost;
2261
- }
2262
- export interface BulkCreateDraftPostsRequest {
2263
- /**
2264
- * Draft posts to create.
2265
- * @minSize 1
2266
- * @maxSize 20
2267
- */
2268
- draftPosts: DraftPost[];
2269
- /** Whether the draft post should be published after creation. */
2270
- publish?: boolean;
2271
- /** Whether to return the full created draft post entities in the response. */
2272
- returnFullEntity?: boolean;
2273
- /**
2274
- * List of draft post fields to be included in the response if the entities are present.
2275
- * Base default fieldset returns all core draft post properties (all properties that are not a supported fieldset value).
2276
- * For example, when `URL` fieldset is selected, returned draft post will include the set of base properties and the draft post's preview url.
2277
- * @maxSize 10
2278
- */
2279
- fieldsets?: FieldWithLiterals[];
2280
- }
2281
- export interface BulkCreateDraftPostsResponse {
2282
- /** Draft posts created by bulk action. */
2283
- results?: BulkDraftPostResult[];
2284
- /** Bulk action metadata. */
2285
- bulkActionMetadata?: BulkActionMetadata;
2286
- }
2287
- export interface BulkDraftPostResult {
2288
- /** Bulk actions metadata for draft post. */
2289
- itemMetadata?: ItemMetadata;
2290
- /** Optional full draft post. */
2291
- item?: DraftPost;
2292
- }
2293
- export interface ItemMetadata {
2294
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
2295
- id?: string | null;
2296
- /** Index of the item within the request array. Allows for correlation between request and response items. */
2297
- originalIndex?: number;
2298
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
2299
- success?: boolean;
2300
- /** Details about the error in case of failure. */
2301
- error?: ApplicationError;
2302
- }
2303
- export interface ApplicationError {
2304
- /** Error code. */
2305
- code?: string;
2306
- /** Description of the error. */
2307
- description?: string;
2308
- /** Data related to the error. */
2309
- data?: Record<string, any> | null;
2310
- }
2311
- export interface BulkActionMetadata {
2312
- /** Number of items that were successfully processed. */
2313
- totalSuccesses?: number;
2314
- /** Number of items that couldn't be processed. */
2315
- totalFailures?: number;
2316
- /** Number of failures without details because detailed failure threshold was exceeded. */
2317
- undetailedFailures?: number;
2318
- }
2319
- export interface BulkUpdateDraftPostsRequest {
2320
- /**
2321
- * Draft posts to update.
2322
- * @minSize 1
2323
- * @maxSize 20
2324
- */
2325
- draftPosts?: MaskedDraftPosts[];
2326
- /**
2327
- * Action to perform on the posts.
2328
- *
2329
- * Default: `UPDATE`
2330
- */
2331
- action?: ActionWithLiterals;
2332
- /** Posts' scheduled publish date when `action` is set to `UPDATE_SCHEDULE`. */
2333
- scheduledPublishDate?: Date | null;
2334
- /** Whether to return the full updated draft post entities in the response. */
2335
- returnFullEntity?: boolean;
2336
- /**
2337
- * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2338
- * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
2339
- * only the draft post's base fields are returned.
2340
- * @maxSize 10
2341
- */
2342
- fieldsets?: FieldWithLiterals[];
2343
- }
2344
- export interface MaskedDraftPosts {
2345
- /** Draft post */
2346
- draftPost?: DraftPost;
2347
- /** Field mask of fields to update. */
2348
- fieldMask?: string[];
2349
- }
2350
- export declare enum Action {
2351
- /** Update the draft post. */
2352
- UPDATE = "UPDATE",
2353
- /** Update and publish a draft post. */
2354
- UPDATE_PUBLISH = "UPDATE_PUBLISH",
2355
- /** Update the draft post and schedule a publish date. */
2356
- UPDATE_SCHEDULE = "UPDATE_SCHEDULE",
2357
- /** Update the post and revert it to draft. */
2358
- UPDATE_REVERT_TO_DRAFT = "UPDATE_REVERT_TO_DRAFT",
2359
- /** Update the draft post and cancel the scheduled publish date. */
2360
- UPDATE_CANCEL_SCHEDULE = "UPDATE_CANCEL_SCHEDULE",
2361
- /** Update and reject draft post. */
2362
- UPDATE_REJECT = "UPDATE_REJECT",
2363
- /** Update a post that's already been published. This creates and updates a draft version of the post. The original post is still published. */
2364
- UPDATE_PUBLICATION = "UPDATE_PUBLICATION"
2365
- }
2366
- /** @enumType */
2367
- export type ActionWithLiterals = Action | 'UPDATE' | 'UPDATE_PUBLISH' | 'UPDATE_SCHEDULE' | 'UPDATE_REVERT_TO_DRAFT' | 'UPDATE_CANCEL_SCHEDULE' | 'UPDATE_REJECT' | 'UPDATE_PUBLICATION';
2368
- export interface BulkUpdateDraftPostsResponse {
2369
- /** Draft posts updated by bulk action. */
2370
- results?: BulkDraftPostResult[];
2371
- /** Bulk action metadata. */
2372
- bulkActionMetadata?: BulkActionMetadata;
2373
- }
2374
- export interface DraftPostOwnerChanged {
2375
- }
2376
- export interface ListDeletedDraftPostsRequest {
2377
- /**
2378
- * Language filter.
2379
- *
2380
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2381
- * If omitted, deleted draft posts in all languages are returned.
2382
- * @format LANGUAGE_TAG
2383
- */
2384
- language?: string | null;
2385
- /**
2386
- * Sorting options.
2387
- *
2388
- * Default: `EDITING_DATE_DESCENDING`
2389
- */
2390
- sort?: GetDraftPostsSortWithLiterals;
2391
- /** Pagination options. */
2392
- paging?: BlogPaging;
2393
- /**
2394
- * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2395
- * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
2396
- * only the draft post's base fields are returned.
2397
- * @maxSize 10
2398
- */
2399
- fieldsets?: FieldWithLiterals[];
2400
- /**
2401
- * Draft post ids.
2402
- * @maxSize 100
2403
- * @format GUID
2404
- */
2405
- draftPostIds?: string[];
2406
- }
2407
- export declare enum GetDraftPostsSort {
2408
- /** Sort by `editedDate` in descending order. */
2409
- EDITING_DATE_DESC = "EDITING_DATE_DESC",
2410
- /** Sort by `editedDate` in ascending order. */
2411
- EDITING_DATE_ASC = "EDITING_DATE_ASC"
2412
- }
2413
- /** @enumType */
2414
- export type GetDraftPostsSortWithLiterals = GetDraftPostsSort | 'EDITING_DATE_DESC' | 'EDITING_DATE_ASC';
2415
- export interface BlogPaging {
2416
- /**
2417
- * Number of items to skip in the current sort order.
2418
- *
2419
- *
2420
- * Default: `0`
2421
- */
2422
- offset?: number;
2423
- /**
2424
- * Number of items to return.
2425
- *
2426
- *
2427
- * Default:`50`
2428
- * @min 1
2429
- * @max 100
2430
- */
2431
- limit?: number;
2432
- /**
2433
- * Pointer to the next or previous page in the list of results.
2434
- * @maxLength 2000
2435
- */
2436
- cursor?: string | null;
2437
- }
2438
- export interface ListDeletedDraftPostsResponse {
2439
- /** List of draft posts. */
2440
- draftPosts?: DraftPost[];
2441
- /**
2442
- * __Deprecated.__ Use `pagingMetadata` instead.
2443
- * This property will be removed on June 30, 2025.
2444
- *
2445
- * Details on the paged set of results returned.
2446
- * @deprecated __Deprecated.__ Use `pagingMetadata` instead.
2447
- * This property will be removed on June 30, 2025.
2448
- *
2449
- * Details on the paged set of results returned.
2450
- * @replacedBy pagingMetadata
2451
- * @targetRemovalDate 2025-06-30
2452
- */
2453
- metaData?: MetaData;
2454
- /** Details on the paged set of results returned. */
2455
- pagingMetadata?: PagingMetadataV2;
2456
- }
2457
- export interface MetaData {
2458
- /** Number of items returned in this response. */
2459
- count?: number;
2460
- /** Requested offset. */
2461
- offset?: number;
2462
- /** Total number of items that match the query. */
2463
- total?: number;
2464
- /**
2465
- * Pointer to the next or previous page in the list of results.
2466
- * @maxLength 2000
2467
- */
2468
- cursor?: string | null;
2469
- }
2470
- export interface PagingMetadataV2 {
2471
- /** Number of items returned in the response. */
2472
- count?: number | null;
2473
- /** Offset that was requested. */
2474
- offset?: number | null;
2475
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
2476
- total?: number | null;
2477
- /** Flag that indicates the server failed to calculate the `total` field. */
2478
- tooManyToCount?: boolean | null;
2479
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
2480
- cursors?: Cursors;
2481
- }
2482
- export interface Cursors {
2483
- /**
2484
- * Cursor pointing to next page in the list of results.
2485
- * @maxLength 2000
2486
- */
2487
- next?: string | null;
2488
- /**
2489
- * Cursor pointing to previous page in the list of results.
2490
- * @maxLength 2000
2491
- */
2492
- prev?: string | null;
2493
- }
2494
- export interface GetDraftPostRequest {
2495
- /**
2496
- * Draft post ID.
2497
- * @maxLength 38
2498
- */
2499
- draftPostId: string;
2500
- /**
2501
- * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2502
- * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
2503
- * only the draft post's base fields are returned.
2504
- * @maxSize 10
2505
- */
2506
- fieldsets?: FieldWithLiterals[];
2507
- }
2508
- export interface GetDraftPostResponse {
2509
- /** Draft post info. */
2510
- draftPost?: DraftPost;
2511
- }
2512
- export interface UpdateDraftPostContentRequest extends UpdateDraftPostContentRequestDraftContentOneOf {
2513
- /**
2514
- * DraftJs content to update.
2515
- * @maxLength 400000
2516
- */
2517
- content?: string;
2518
- /** Draft Post rich content. */
2519
- richContent?: RichContent;
2520
- /**
2521
- * Draft post ID.
2522
- * @maxLength 38
2523
- */
2524
- draftPostId?: string;
2525
- /** Change origin. */
2526
- changeOrigin?: OriginWithLiterals;
2527
- /**
2528
- * List of draft post fields to be included if entities are present in the response.
2529
- * Base fieldset, which is default, will return all core draft post properties.
2530
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2531
- * @maxSize 10
2532
- */
2533
- fieldsets?: FieldWithLiterals[];
2534
- }
2535
- /** @oneof */
2536
- export interface UpdateDraftPostContentRequestDraftContentOneOf {
2537
- /**
2538
- * DraftJs content to update.
2539
- * @maxLength 400000
2540
- */
2541
- content?: string;
2542
- /** Draft Post rich content. */
2543
- richContent?: RichContent;
2544
- }
2545
- export interface UpdateDraftPostContentResponse {
2546
- /** Updated draft post info. */
2547
- draftPost?: DraftPost;
2548
- }
2549
- export interface UpdateDraftPostRequest {
2550
- /** Draft post to update. */
2551
- draftPost: DraftPost;
2552
- /**
2553
- * Action to perform on the post.
2554
- *
2555
- * Default: `UPDATE`
2556
- */
2557
- action?: ActionWithLiterals;
2558
- /** Post publish schedule date if `action` is set to `UPDATE_SCHEDULE`. */
2559
- scheduledPublishDate?: Date | null;
2560
- /**
2561
- * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2562
- * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
2563
- * only the draft post's base fields are returned.
2564
- * @maxSize 10
2565
- */
2566
- fieldsets?: FieldWithLiterals[];
2567
- }
2568
- export interface UpdateDraftPostResponse {
2569
- /** Updated draft post info. */
2570
- draftPost?: DraftPost;
2571
- }
2572
- export interface DeleteDraftPostRequest {
2573
- /**
2574
- * Draft post ID.
2575
- * @maxLength 38
2576
- */
2577
- draftPostId: string;
2578
- /**
2579
- * Whether to bypass the trash bin and delete the post permanently.
2580
- *
2581
- * Default: `false`
2582
- */
2583
- permanent?: boolean;
2584
- }
2585
- export interface DeleteDraftPostResponse {
2586
- }
2587
- export interface RemoveFromTrashBinRequest {
2588
- /**
2589
- * Draft post ID.
2590
- * @maxLength 38
2591
- */
2592
- draftPostId: string;
2593
- }
2594
- export interface RemoveFromTrashBinResponse {
2595
- }
2596
- export interface BulkDeleteDraftPostsRequest {
2597
- /**
2598
- * Post IDs.
2599
- * @minSize 1
2600
- * @maxSize 100
2601
- * @maxLength 38
2602
- */
2603
- postIds: string[];
2604
- /** Should delete bypassing the trash-bin. */
2605
- permanent?: boolean;
2606
- }
2607
- export interface BulkDeleteDraftPostsResponse {
2608
- /** Bulk action results. */
2609
- results?: BulkDraftPostResult[];
2610
- /** Bulk action metadata. */
2611
- bulkActionMetadata?: BulkActionMetadata;
2612
- }
2613
- export interface ListDraftPostsRequest {
2614
- /**
2615
- * Draft post status filter.
2616
- *
2617
- * If omitted, draft posts with all statuses are returned.
2618
- */
2619
- status?: StatusWithLiterals;
2620
- /**
2621
- * Language filter.
2622
- *
2623
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2624
- * If omitted, draft posts in all languages are returned.
2625
- * @format LANGUAGE_TAG
2626
- */
2627
- language?: string | null;
2628
- /**
2629
- * Sort options.
2630
- *
2631
- * Default: `EDITING_DATE_DESCENDING`
2632
- */
2633
- sort?: GetDraftPostsSortWithLiterals;
2634
- /** Pagination options. */
2635
- paging?: BlogPaging;
2636
- /**
2637
- * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2638
- * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
2639
- * only the draft post's base fields are returned.
2640
- * @maxSize 10
2641
- */
2642
- fieldsets?: FieldWithLiterals[];
2643
- }
2644
- export interface ListDraftPostsResponse {
2645
- /** List of draft posts. */
2646
- draftPosts?: DraftPost[];
2647
- /** Details on the paged set of results returned. */
2648
- metaData?: MetaData;
2649
- }
2650
- export interface GetDeletedDraftPostRequest {
2651
- /**
2652
- * Draft post ID.
2653
- * @maxLength 38
2654
- */
2655
- draftPostId: string;
2656
- }
2657
- export interface GetDeletedDraftPostResponse {
2658
- /** Draft post info. */
2659
- draftPost?: DraftPost;
2660
- }
2661
- export interface RestoreFromTrashBinRequest {
2662
- /**
2663
- * Draft post ID.
2664
- * @maxLength 38
2665
- */
2666
- draftPostId: string;
2667
- }
2668
- export interface RestoreFromTrashBinResponse {
2669
- /** Restored draft post info. */
2670
- draftPost?: DraftPost;
2671
- }
2672
- export interface QueryDraftPostsRequest {
2673
- /**
2674
- * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2675
- * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
2676
- * only the draft post's base fields are returned.
2677
- * @maxSize 10
2678
- */
2679
- fieldsets?: FieldWithLiterals[];
2680
- /** Query options. */
2681
- query?: PlatformQuery;
2682
- }
2683
- export interface Sorting {
2684
- /**
2685
- * Name of the field to sort by.
2686
- * @maxLength 512
2687
- */
2688
- fieldName?: string;
2689
- /** Sort order. */
2690
- order?: SortOrderWithLiterals;
2691
- }
2692
- export declare enum SortOrder {
2693
- ASC = "ASC",
2694
- DESC = "DESC"
2695
- }
2696
- /** @enumType */
2697
- export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
2698
- export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
2699
- /** Paging options to limit and skip the number of items. */
2700
- paging?: Paging;
2701
- /** 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`. */
2702
- cursorPaging?: CursorPaging;
2703
- /**
2704
- * Filter object in the following format:
2705
- * `"filter" : {
2706
- * "fieldName1": "value1",
2707
- * "fieldName2":{"$operator":"value2"}
2708
- * }`
2709
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2710
- */
2711
- filter?: Record<string, any> | null;
2712
- /**
2713
- * Sort object in the following format:
2714
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2715
- * @maxSize 3
2716
- */
2717
- sort?: Sorting[];
2718
- }
2719
- /** @oneof */
2720
- export interface PlatformQueryPagingMethodOneOf {
2721
- /** Paging options to limit and skip the number of items. */
2722
- paging?: Paging;
2723
- /** 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`. */
2724
- cursorPaging?: CursorPaging;
2725
- }
2726
- export interface Paging {
2727
- /**
2728
- * Number of items to load.
2729
- * @max 100
2730
- */
2731
- limit?: number | null;
2732
- /** Number of items to skip in the current sort order. */
2733
- offset?: number | null;
2734
- }
2735
- export interface CursorPaging {
2736
- /**
2737
- * Number of items to load.
2738
- * @max 100
2739
- */
2740
- limit?: number | null;
2741
- /**
2742
- * Pointer to the next or previous page in the list of results.
2743
- *
2744
- * You can get the relevant cursor token
2745
- * from the `pagingMetadata` object in the previous call's response.
2746
- * Not relevant for the first request.
2747
- * @maxLength 2000
2748
- */
2749
- cursor?: string | null;
2750
- }
2751
- export interface QueryDraftPostsResponse {
2752
- /** List of posts. */
2753
- draftPosts?: DraftPost[];
2754
- /** Details on the paged set of results returned. */
2755
- pagingMetadata?: PagingMetadataV2;
2756
- }
2757
- export interface PublishDraftPostRequest {
2758
- /**
2759
- * Draft post ID.
2760
- * @maxLength 38
2761
- */
2762
- draftPostId: string;
2763
- }
2764
- export interface PublishDraftPostResponse {
2765
- /**
2766
- * Published post ID.
2767
- * @format GUID
2768
- */
2769
- postId?: string;
2770
- }
2771
- export interface UnpublishPostRequest {
2772
- /**
2773
- * Draft post ID.
2774
- * @maxLength 38
2775
- */
2776
- draftPostId?: string;
2777
- }
2778
- export interface UnpublishPostResponse {
2779
- }
2780
- export interface TranslateCategoryRequest {
2781
- /**
2782
- * Source category ID
2783
- * @format GUID
2784
- */
2785
- categoryId?: string;
2786
- /**
2787
- * Translation language
2788
- * @format LANGUAGE_TAG
2789
- */
2790
- language?: string;
2791
- }
2792
- export interface TranslateCategoryResponse {
2793
- /** Translated category */
2794
- category?: Category;
2795
- /** Other translations of returned category */
2796
- translations?: CategoryTranslation[];
2797
- }
2798
- export interface Category {
2799
- /**
2800
- * Category ID.
2801
- * @immutable
2802
- * @maxLength 38
2803
- */
2804
- id?: string;
2805
- /**
2806
- * Category label. Displayed in the Category Menu.
2807
- * @maxLength 35
2808
- */
2809
- label?: string;
2810
- /**
2811
- * Number of posts in the category.
2812
- * @readonly
2813
- */
2814
- postCount?: number;
2815
- /**
2816
- * The `url` of the page that lists every post with the specified category.
2817
- * @readonly
2818
- */
2819
- url?: PageUrl;
2820
- /**
2821
- * Category description.
2822
- * @maxLength 500
2823
- */
2824
- description?: string | null;
2825
- /**
2826
- * Category title.
2827
- * @maxLength 200
2828
- * @deprecated Category title.
2829
- * @targetRemovalDate 2025-07-16
2830
- */
2831
- title?: string;
2832
- /**
2833
- * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
2834
- * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
2835
- *
2836
- * Default: `-1`
2837
- */
2838
- displayPosition?: number | null;
2839
- /**
2840
- * ID of the category's translations. All translations of a single category share the same `translationId`.
2841
- * @format GUID
2842
- */
2843
- translationId?: string | null;
2844
- /**
2845
- * Category language.
2846
- *
2847
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2848
- * @immutable
2849
- */
2850
- language?: string | null;
2851
- /**
2852
- * 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`.
2853
- * @maxLength 100
2854
- */
2855
- slug?: string;
2856
- /** SEO data. */
2857
- seoData?: SeoSchema;
2858
- /** Category cover image. */
2859
- coverImage?: Image;
2860
- /**
2861
- * Date and time the Category was last updated.
2862
- * @readonly
2863
- */
2864
- updatedDate?: Date | null;
2865
- }
2866
- export interface CategoryTranslation {
2867
- /**
2868
- * Category ID.
2869
- * @format GUID
2870
- */
2871
- id?: string;
2872
- /**
2873
- * Label displayed in the categories menu on the site.
2874
- * @maxLength 100
2875
- */
2876
- label?: string | null;
2877
- /**
2878
- * Language of the category.
2879
- * @format LANGUAGE_TAG
2880
- */
2881
- language?: string | null;
2882
- /** URL of this category page. */
2883
- url?: PageUrl;
2884
- }
2885
- export interface TranslateDraftRequest {
2886
- /**
2887
- * Source post or draft ID
2888
- * @format GUID
2889
- */
2890
- postId?: string;
2891
- /**
2892
- * Translation language
2893
- * @format LANGUAGE_TAG
2894
- */
2895
- language?: string;
2896
- /**
2897
- * List of draft post fields to be included if entities are present in the response.
2898
- * Base fieldset, which is default, will return all core draft post properties.
2899
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2900
- * @maxSize 10
2901
- */
2902
- fieldsets?: FieldWithLiterals[];
2903
- }
2904
- export interface TranslateDraftResponse {
2905
- /** Draft post. */
2906
- draftPost?: DraftPost;
2907
- }
2908
- export interface IsDraftPostAutoTranslatableRequest {
2909
- /**
2910
- * Source post or draft ID.
2911
- * @format GUID
2912
- */
2913
- draftPostId?: string;
2914
- }
2915
- export interface IsDraftPostAutoTranslatableResponse {
2916
- /**
2917
- * Source draft post ID.
2918
- * @format GUID
2919
- */
2920
- draftPostId?: string;
2921
- /** Indicates if enough machine translation credits are available for the draft post translation. */
2922
- translatable?: boolean;
2923
- /** Draft post title word count. */
2924
- titleWordCount?: number;
2925
- /** Draft post content word count. */
2926
- contentWordCount?: number;
2927
- /** Word credits available for auto translation. */
2928
- availableAutoTranslateWords?: number;
2929
- /** Word credits available after auto translation would be done. */
2930
- availableAutoTranslateWordsAfter?: number;
2931
- /** Content text character count. */
2932
- contentTextCharacterCount?: number;
2933
- }
2934
- export interface UpdateDraftPostLanguageRequest {
2935
- /**
2936
- * Source draft post ID
2937
- * @format GUID
2938
- */
2939
- postId?: string;
2940
- /**
2941
- * New language to replace to
2942
- * @minLength 2
2943
- * @format LANGUAGE_TAG
2944
- */
2945
- language?: string;
2946
- /**
2947
- * List of draft post fields to be included if entities are present in the response.
2948
- * Base fieldset, which is default, will return all core draft post properties.
2949
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2950
- * @maxSize 10
2951
- */
2952
- fieldsets?: FieldWithLiterals[];
2953
- }
2954
- export interface UpdateDraftPostLanguageResponse {
2955
- /** Draft post */
2956
- draftPost?: DraftPost;
2957
- }
2958
- export interface BulkUpdateDraftPostLanguageRequest {
2959
- /**
2960
- * Source post or draft IDs
2961
- * @maxSize 50
2962
- * @format GUID
2963
- */
2964
- ids?: string[];
2965
- /**
2966
- * New language to replace to
2967
- * @format LANGUAGE_TAG
2968
- */
2969
- language?: string;
2970
- /** Should full draft post be returned */
2971
- returnFullEntity?: boolean;
2972
- /**
2973
- * List of draft post fields to be included if entities are present in the response.
2974
- * Base fieldset, which is default, will return all core draft post properties.
2975
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2976
- * @maxSize 10
2977
- */
2978
- fieldsets?: FieldWithLiterals[];
2979
- }
2980
- export interface BulkUpdateDraftPostLanguageResponse {
2981
- /** Bulk action results */
2982
- results?: BulkDraftPostResult[];
2983
- /** Bulk action metadata */
2984
- bulkActionMetadata?: BulkActionMetadata;
2985
- }
2986
- export interface GetPostAmountsByLanguageRequest {
2987
- /**
2988
- * Post status to filter by
2989
- * @maxLength 100
2990
- */
2991
- status?: string;
2992
- }
2993
- export interface GetPostAmountsByLanguageResponse {
2994
- /** Post amounts by language */
2995
- postAmountsByLanguage?: PostAmountByLanguage[];
2996
- }
2997
- export interface PostAmountByLanguage {
2998
- /**
2999
- * Post language code
3000
- * @format LANGUAGE_TAG
3001
- */
3002
- languageCode?: string;
3003
- /**
3004
- * Language flag
3005
- * @format LANGUAGE_TAG
3006
- */
3007
- flag?: string;
3008
- /** Post amount in that language */
3009
- postAmount?: number;
3010
- }
3011
- export interface BulkRevertToUnpublishedRequest {
3012
- /**
3013
- * Source post IDs.
3014
- * @minSize 1
3015
- * @maxSize 100
3016
- * @format GUID
3017
- */
3018
- postIds?: string[];
3019
- /** Should full draft post be returned. */
3020
- returnFullEntity?: boolean;
3021
- }
3022
- export interface BulkRevertToUnpublishedResponse {
3023
- /** Bulk action results. */
3024
- results?: BulkDraftPostResult[];
3025
- /** Bulk action metadata. */
3026
- bulkActionMetadata?: BulkActionMetadata;
3027
- }
3028
- export interface BulkRejectDraftPostRequest {
3029
- /**
3030
- * Source post IDs.
3031
- * @minSize 1
3032
- * @maxSize 100
3033
- * @format GUID
3034
- */
3035
- postIds?: string[];
3036
- /** Should full draft post be returned. */
3037
- returnFullEntity?: boolean;
3038
- }
3039
- export interface BulkRejectDraftPostResponse {
3040
- /** Bulk action results. */
3041
- results?: BulkDraftPostResult[];
3042
- /** Bulk action metadata. */
3043
- bulkActionMetadata?: BulkActionMetadata;
3044
- }
3045
- export interface RevertToUnpublishedRequest {
3046
- /**
3047
- * Source post ID.
3048
- * @format GUID
3049
- */
3050
- postId?: string;
3051
- /**
3052
- * List of draft post fields to be included if entities are present in the response.
3053
- * Base fieldset, which is default, will return all core draft post properties.
3054
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
3055
- * @maxSize 10
3056
- */
3057
- fieldsets?: FieldWithLiterals[];
3058
- }
3059
- export interface RevertToUnpublishedResponse {
3060
- /** Updated post draft. */
3061
- draftPost?: DraftPost;
3062
- }
3063
- export interface RejectDraftPostRequest {
3064
- /**
3065
- * Source post ID.
3066
- * @format GUID
3067
- */
3068
- postId?: string;
3069
- /**
3070
- * List of draft post fields to be included if entities are present in the response.
3071
- * Base fieldset, which is default, will return all core draft post properties.
3072
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
3073
- * @maxSize 10
3074
- */
3075
- fieldsets?: FieldWithLiterals[];
3076
- }
3077
- export interface RejectDraftPostResponse {
3078
- /** Draft post. */
3079
- draftPost?: DraftPost;
3080
- }
3081
- export interface ApproveDraftPostRequest {
3082
- /**
3083
- * Source post ID.
3084
- * @format GUID
3085
- */
3086
- postId?: string;
3087
- /**
3088
- * Scheduled publish date if should be not immediately published.
3089
- * @maxLength 24
3090
- */
3091
- scheduledPublishDate?: string | null;
3092
- /**
3093
- * List of draft post fields to be included if entities are present in the response.
3094
- * Base fieldset, which is default, will return all core draft post properties.
3095
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
3096
- * @maxSize 10
3097
- */
3098
- fieldsets?: FieldWithLiterals[];
3099
- }
3100
- export interface ApproveDraftPostResponse {
3101
- /** Updated post draft. */
3102
- draftPost?: DraftPost;
3103
- }
3104
- export interface MarkPostAsInModerationRequest {
3105
- /**
3106
- * Source post ID.
3107
- * @maxLength 38
3108
- */
3109
- postId?: string;
3110
- /**
3111
- * List of draft post fields to be included if entities are present in the response.
3112
- * Base fieldset, which is default, will return all core draft post properties.
3113
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
3114
- * @maxSize 10
3115
- */
3116
- fieldsets?: FieldWithLiterals[];
3117
- }
3118
- export interface MarkPostAsInModerationResponse {
3119
- /** Updated post draft. */
3120
- draftPost?: DraftPost;
3121
- }