@wix/auto_sdk_blog_draft-posts 1.0.15 → 1.0.16
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.
- package/build/{internal/cjs/src/blog-v3-draft-draft-posts.universal.d.ts → blog-v3-draft-draft-posts.universal-vVP72XfS.d.mts} +267 -559
- package/build/{internal/es/src/blog-v3-draft-draft-posts.universal.d.ts → blog-v3-draft-draft-posts.universal-vVP72XfS.d.ts} +267 -559
- package/build/index.d.mts +193 -0
- package/build/index.d.ts +193 -0
- package/build/index.js +3411 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +3331 -0
- package/build/index.mjs.map +1 -0
- package/build/{cjs/src/blog-v3-draft-draft-posts.universal.d.ts → internal/blog-v3-draft-draft-posts.universal-vVP72XfS.d.mts} +267 -559
- package/build/{es/src/blog-v3-draft-draft-posts.universal.d.ts → internal/blog-v3-draft-draft-posts.universal-vVP72XfS.d.ts} +267 -559
- package/build/internal/index.d.mts +193 -0
- package/build/internal/index.d.ts +193 -0
- package/build/internal/index.js +3411 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +3331 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/{es/src/blog-v3-draft-draft-posts.types.d.ts → internal/meta.d.mts} +234 -989
- package/build/internal/{cjs/src/blog-v3-draft-draft-posts.types.d.ts → meta.d.ts} +234 -989
- package/build/internal/meta.js +2057 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +2017 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{cjs/src/blog-v3-draft-draft-posts.types.d.ts → meta.d.mts} +234 -989
- package/build/{internal/es/src/blog-v3-draft-draft-posts.types.d.ts → meta.d.ts} +234 -989
- package/build/meta.js +2057 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +2017 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/blog-v3-draft-draft-posts.context.d.ts +0 -34
- package/build/cjs/src/blog-v3-draft-draft-posts.context.js +0 -78
- package/build/cjs/src/blog-v3-draft-draft-posts.context.js.map +0 -1
- package/build/cjs/src/blog-v3-draft-draft-posts.http.d.ts +0 -83
- package/build/cjs/src/blog-v3-draft-draft-posts.http.js +0 -1803
- package/build/cjs/src/blog-v3-draft-draft-posts.http.js.map +0 -1
- package/build/cjs/src/blog-v3-draft-draft-posts.meta.d.ts +0 -40
- package/build/cjs/src/blog-v3-draft-draft-posts.meta.js +0 -294
- package/build/cjs/src/blog-v3-draft-draft-posts.meta.js.map +0 -1
- package/build/cjs/src/blog-v3-draft-draft-posts.public.d.ts +0 -168
- package/build/cjs/src/blog-v3-draft-draft-posts.public.js +0 -339
- package/build/cjs/src/blog-v3-draft-draft-posts.public.js.map +0 -1
- package/build/cjs/src/blog-v3-draft-draft-posts.types.js +0 -476
- package/build/cjs/src/blog-v3-draft-draft-posts.types.js.map +0 -1
- package/build/cjs/src/blog-v3-draft-draft-posts.universal.js +0 -1497
- package/build/cjs/src/blog-v3-draft-draft-posts.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/blog-v3-draft-draft-posts.context.d.ts +0 -34
- package/build/es/src/blog-v3-draft-draft-posts.context.js +0 -34
- package/build/es/src/blog-v3-draft-draft-posts.context.js.map +0 -1
- package/build/es/src/blog-v3-draft-draft-posts.http.d.ts +0 -83
- package/build/es/src/blog-v3-draft-draft-posts.http.js +0 -1786
- package/build/es/src/blog-v3-draft-draft-posts.http.js.map +0 -1
- package/build/es/src/blog-v3-draft-draft-posts.meta.d.ts +0 -40
- package/build/es/src/blog-v3-draft-draft-posts.meta.js +0 -254
- package/build/es/src/blog-v3-draft-draft-posts.meta.js.map +0 -1
- package/build/es/src/blog-v3-draft-draft-posts.public.d.ts +0 -168
- package/build/es/src/blog-v3-draft-draft-posts.public.js +0 -281
- package/build/es/src/blog-v3-draft-draft-posts.public.js.map +0 -1
- package/build/es/src/blog-v3-draft-draft-posts.types.js +0 -473
- package/build/es/src/blog-v3-draft-draft-posts.types.js.map +0 -1
- package/build/es/src/blog-v3-draft-draft-posts.universal.js +0 -1456
- package/build/es/src/blog-v3-draft-draft-posts.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.d.ts +0 -34
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.js +0 -78
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.http.d.ts +0 -83
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.http.js +0 -1803
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.http.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.meta.d.ts +0 -40
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.meta.js +0 -294
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.meta.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.d.ts +0 -168
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.js +0 -339
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.js +0 -476
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.js.map +0 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.js +0 -1497
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.context.d.ts +0 -34
- package/build/internal/es/src/blog-v3-draft-draft-posts.context.js +0 -34
- package/build/internal/es/src/blog-v3-draft-draft-posts.context.js.map +0 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.http.d.ts +0 -83
- package/build/internal/es/src/blog-v3-draft-draft-posts.http.js +0 -1786
- package/build/internal/es/src/blog-v3-draft-draft-posts.http.js.map +0 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.meta.d.ts +0 -40
- package/build/internal/es/src/blog-v3-draft-draft-posts.meta.js +0 -254
- package/build/internal/es/src/blog-v3-draft-draft-posts.meta.js.map +0 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.public.d.ts +0 -168
- package/build/internal/es/src/blog-v3-draft-draft-posts.public.js +0 -281
- package/build/internal/es/src/blog-v3-draft-draft-posts.public.js.map +0 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.types.js +0 -473
- package/build/internal/es/src/blog-v3-draft-draft-posts.types.js.map +0 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.universal.js +0 -1456
- package/build/internal/es/src/blog-v3-draft-draft-posts.universal.js.map +0 -1
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
|
|
1
|
+
import { c7 as CreateDraftPostRequest$1, a as CreateDraftPostResponse$1, c8 as BulkCreateDraftPostsRequest$1, b as BulkCreateDraftPostsResponse$1, cd as BulkUpdateDraftPostsRequest$1, d as BulkUpdateDraftPostsResponse$1, cg as ListDeletedDraftPostsRequest$1, e as ListDeletedDraftPostsResponse$1, cl as GetDraftPostRequest$1, f as GetDraftPostResponse$1, cp as UpdateDraftPostRequest$1, h as UpdateDraftPostResponse$1, cq as DeleteDraftPostRequest$1, cr as DeleteDraftPostResponse$1, cs as RemoveFromTrashBinRequest$1, ct as RemoveFromTrashBinResponse$1, cu as BulkDeleteDraftPostsRequest$1, k as BulkDeleteDraftPostsResponse$1, cv as ListDraftPostsRequest$1, m as ListDraftPostsResponse$1, cw as GetDeletedDraftPostRequest$1, n as GetDeletedDraftPostResponse$1, cx as RestoreFromTrashBinRequest$1, R as RestoreFromTrashBinResponse$1, cy as QueryDraftPostsRequest$1, cE as QueryDraftPostsResponse$1, cF as PublishDraftPostRequest$1, P as PublishDraftPostResponse$1 } from './blog-v3-draft-draft-posts.universal-vVP72XfS.js';
|
|
2
|
+
|
|
3
|
+
interface DraftPost {
|
|
2
4
|
/**
|
|
3
5
|
* Draft post ID.
|
|
4
6
|
* @readonly
|
|
@@ -133,44 +135,7 @@ export interface DraftPost {
|
|
|
133
135
|
/** Number of paragraphs to display in a paid content preview for non-paying users. */
|
|
134
136
|
previewTextParagraph?: number | null;
|
|
135
137
|
}
|
|
136
|
-
|
|
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 {
|
|
138
|
+
interface Image {
|
|
174
139
|
/** WixMedia image ID. */
|
|
175
140
|
id?: string;
|
|
176
141
|
/** Image URL. */
|
|
@@ -193,109 +158,7 @@ export interface Image {
|
|
|
193
158
|
*/
|
|
194
159
|
filename?: string | null;
|
|
195
160
|
}
|
|
196
|
-
|
|
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
|
-
export interface RichContent {
|
|
161
|
+
interface RichContent {
|
|
299
162
|
/** Node objects representing a rich content document. */
|
|
300
163
|
nodes?: Node[];
|
|
301
164
|
/** Object metadata. */
|
|
@@ -303,7 +166,7 @@ export interface RichContent {
|
|
|
303
166
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
304
167
|
documentStyle?: DocumentStyle;
|
|
305
168
|
}
|
|
306
|
-
|
|
169
|
+
interface Node extends NodeDataOneOf {
|
|
307
170
|
/** Data for a button node. */
|
|
308
171
|
buttonData?: ButtonData;
|
|
309
172
|
/** Data for a code block node. */
|
|
@@ -368,7 +231,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
368
231
|
style?: NodeStyle;
|
|
369
232
|
}
|
|
370
233
|
/** @oneof */
|
|
371
|
-
|
|
234
|
+
interface NodeDataOneOf {
|
|
372
235
|
/** Data for a button node. */
|
|
373
236
|
buttonData?: ButtonData;
|
|
374
237
|
/** Data for a code block node. */
|
|
@@ -424,7 +287,7 @@ export interface NodeDataOneOf {
|
|
|
424
287
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
425
288
|
layoutCellData?: LayoutCellData;
|
|
426
289
|
}
|
|
427
|
-
|
|
290
|
+
declare enum NodeType {
|
|
428
291
|
PARAGRAPH = "PARAGRAPH",
|
|
429
292
|
TEXT = "TEXT",
|
|
430
293
|
HEADING = "HEADING",
|
|
@@ -460,7 +323,7 @@ export declare enum NodeType {
|
|
|
460
323
|
LAYOUT = "LAYOUT",
|
|
461
324
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
462
325
|
}
|
|
463
|
-
|
|
326
|
+
interface NodeStyle {
|
|
464
327
|
/** The top padding value in pixels. */
|
|
465
328
|
paddingTop?: string | null;
|
|
466
329
|
/** The bottom padding value in pixels. */
|
|
@@ -468,7 +331,7 @@ export interface NodeStyle {
|
|
|
468
331
|
/** The background color as a hexadecimal value. */
|
|
469
332
|
backgroundColor?: string | null;
|
|
470
333
|
}
|
|
471
|
-
|
|
334
|
+
interface ButtonData {
|
|
472
335
|
/** Styling for the button's container. */
|
|
473
336
|
containerData?: PluginContainerData;
|
|
474
337
|
/** The button type. */
|
|
@@ -480,7 +343,7 @@ export interface ButtonData {
|
|
|
480
343
|
/** Button link details. */
|
|
481
344
|
link?: Link;
|
|
482
345
|
}
|
|
483
|
-
|
|
346
|
+
interface Border {
|
|
484
347
|
/**
|
|
485
348
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
486
349
|
* @deprecated
|
|
@@ -492,7 +355,7 @@ export interface Border {
|
|
|
492
355
|
*/
|
|
493
356
|
radius?: number | null;
|
|
494
357
|
}
|
|
495
|
-
|
|
358
|
+
interface Colors {
|
|
496
359
|
/**
|
|
497
360
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
498
361
|
* @deprecated
|
|
@@ -509,7 +372,7 @@ export interface Colors {
|
|
|
509
372
|
*/
|
|
510
373
|
background?: string | null;
|
|
511
374
|
}
|
|
512
|
-
|
|
375
|
+
interface PluginContainerData {
|
|
513
376
|
/** The width of the node when it's displayed. */
|
|
514
377
|
width?: PluginContainerDataWidth;
|
|
515
378
|
/** The node's alignment within its container. */
|
|
@@ -521,7 +384,7 @@ export interface PluginContainerData {
|
|
|
521
384
|
/** 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`. */
|
|
522
385
|
textWrap?: boolean | null;
|
|
523
386
|
}
|
|
524
|
-
|
|
387
|
+
declare enum WidthType {
|
|
525
388
|
/** Width matches the content width */
|
|
526
389
|
CONTENT = "CONTENT",
|
|
527
390
|
/** Small Width */
|
|
@@ -531,7 +394,7 @@ export declare enum WidthType {
|
|
|
531
394
|
/** coast-to-coast display */
|
|
532
395
|
FULL_WIDTH = "FULL_WIDTH"
|
|
533
396
|
}
|
|
534
|
-
|
|
397
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
535
398
|
/**
|
|
536
399
|
* One of the following predefined width options:
|
|
537
400
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -544,7 +407,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
544
407
|
custom?: string | null;
|
|
545
408
|
}
|
|
546
409
|
/** @oneof */
|
|
547
|
-
|
|
410
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
548
411
|
/**
|
|
549
412
|
* One of the following predefined width options:
|
|
550
413
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -556,7 +419,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
556
419
|
/** A custom width value in pixels. */
|
|
557
420
|
custom?: string | null;
|
|
558
421
|
}
|
|
559
|
-
|
|
422
|
+
declare enum PluginContainerDataAlignment {
|
|
560
423
|
/** Center Alignment */
|
|
561
424
|
CENTER = "CENTER",
|
|
562
425
|
/** Left Alignment */
|
|
@@ -564,7 +427,7 @@ export declare enum PluginContainerDataAlignment {
|
|
|
564
427
|
/** Right Alignment */
|
|
565
428
|
RIGHT = "RIGHT"
|
|
566
429
|
}
|
|
567
|
-
|
|
430
|
+
interface Spoiler {
|
|
568
431
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
569
432
|
enabled?: boolean | null;
|
|
570
433
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -572,17 +435,17 @@ export interface Spoiler {
|
|
|
572
435
|
/** The text for the button used to remove the spoiler cover. */
|
|
573
436
|
buttonText?: string | null;
|
|
574
437
|
}
|
|
575
|
-
|
|
438
|
+
interface Height {
|
|
576
439
|
/** A custom height value in pixels. */
|
|
577
440
|
custom?: string | null;
|
|
578
441
|
}
|
|
579
|
-
|
|
442
|
+
declare enum ButtonDataType {
|
|
580
443
|
/** Regular link button */
|
|
581
444
|
LINK = "LINK",
|
|
582
445
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
583
446
|
ACTION = "ACTION"
|
|
584
447
|
}
|
|
585
|
-
|
|
448
|
+
interface Styles {
|
|
586
449
|
/**
|
|
587
450
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
588
451
|
* @deprecated
|
|
@@ -635,7 +498,7 @@ export interface Styles {
|
|
|
635
498
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
636
499
|
buttonSize?: string | null;
|
|
637
500
|
}
|
|
638
|
-
|
|
501
|
+
interface Link extends LinkDataOneOf {
|
|
639
502
|
/** The absolute URL for the linked document. */
|
|
640
503
|
url?: string;
|
|
641
504
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -654,13 +517,13 @@ export interface Link extends LinkDataOneOf {
|
|
|
654
517
|
customData?: string | null;
|
|
655
518
|
}
|
|
656
519
|
/** @oneof */
|
|
657
|
-
|
|
520
|
+
interface LinkDataOneOf {
|
|
658
521
|
/** The absolute URL for the linked document. */
|
|
659
522
|
url?: string;
|
|
660
523
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
661
524
|
anchor?: string;
|
|
662
525
|
}
|
|
663
|
-
|
|
526
|
+
declare enum Target {
|
|
664
527
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
665
528
|
SELF = "SELF",
|
|
666
529
|
/** Opens the linked document in a new window or tab */
|
|
@@ -670,7 +533,7 @@ export declare enum Target {
|
|
|
670
533
|
/** Opens the linked document in the full body of the window */
|
|
671
534
|
TOP = "TOP"
|
|
672
535
|
}
|
|
673
|
-
|
|
536
|
+
interface Rel {
|
|
674
537
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
675
538
|
nofollow?: boolean | null;
|
|
676
539
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -680,17 +543,17 @@ export interface Rel {
|
|
|
680
543
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
681
544
|
noreferrer?: boolean | null;
|
|
682
545
|
}
|
|
683
|
-
|
|
546
|
+
interface CodeBlockData {
|
|
684
547
|
/** Styling for the code block's text. */
|
|
685
548
|
textStyle?: TextStyle;
|
|
686
549
|
}
|
|
687
|
-
|
|
550
|
+
interface TextStyle {
|
|
688
551
|
/** Text alignment. Defaults to `AUTO`. */
|
|
689
552
|
textAlignment?: TextAlignment;
|
|
690
553
|
/** 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. */
|
|
691
554
|
lineHeight?: string | null;
|
|
692
555
|
}
|
|
693
|
-
|
|
556
|
+
declare enum TextAlignment {
|
|
694
557
|
/** browser default, eqivalent to `initial` */
|
|
695
558
|
AUTO = "AUTO",
|
|
696
559
|
/** Left align */
|
|
@@ -702,7 +565,7 @@ export declare enum TextAlignment {
|
|
|
702
565
|
/** 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 */
|
|
703
566
|
JUSTIFY = "JUSTIFY"
|
|
704
567
|
}
|
|
705
|
-
|
|
568
|
+
interface DividerData {
|
|
706
569
|
/** Styling for the divider's container. */
|
|
707
570
|
containerData?: PluginContainerData;
|
|
708
571
|
/** Divider line style. */
|
|
@@ -712,7 +575,7 @@ export interface DividerData {
|
|
|
712
575
|
/** Divider alignment. */
|
|
713
576
|
alignment?: Alignment;
|
|
714
577
|
}
|
|
715
|
-
|
|
578
|
+
declare enum LineStyle {
|
|
716
579
|
/** Single Line */
|
|
717
580
|
SINGLE = "SINGLE",
|
|
718
581
|
/** Double Line */
|
|
@@ -722,7 +585,7 @@ export declare enum LineStyle {
|
|
|
722
585
|
/** Dotted Line */
|
|
723
586
|
DOTTED = "DOTTED"
|
|
724
587
|
}
|
|
725
|
-
|
|
588
|
+
declare enum Width {
|
|
726
589
|
/** Large line */
|
|
727
590
|
LARGE = "LARGE",
|
|
728
591
|
/** Medium line */
|
|
@@ -730,7 +593,7 @@ export declare enum Width {
|
|
|
730
593
|
/** Small line */
|
|
731
594
|
SMALL = "SMALL"
|
|
732
595
|
}
|
|
733
|
-
|
|
596
|
+
declare enum Alignment {
|
|
734
597
|
/** Center alignment */
|
|
735
598
|
CENTER = "CENTER",
|
|
736
599
|
/** Left alignment */
|
|
@@ -738,7 +601,7 @@ export declare enum Alignment {
|
|
|
738
601
|
/** Right alignment */
|
|
739
602
|
RIGHT = "RIGHT"
|
|
740
603
|
}
|
|
741
|
-
|
|
604
|
+
interface FileData {
|
|
742
605
|
/** Styling for the file's container. */
|
|
743
606
|
containerData?: PluginContainerData;
|
|
744
607
|
/** The source for the file's data. */
|
|
@@ -761,7 +624,7 @@ export interface FileData {
|
|
|
761
624
|
/** File size in KB. */
|
|
762
625
|
sizeInKb?: string | null;
|
|
763
626
|
}
|
|
764
|
-
|
|
627
|
+
declare enum ViewMode {
|
|
765
628
|
/** No PDF view */
|
|
766
629
|
NONE = "NONE",
|
|
767
630
|
/** Full PDF view */
|
|
@@ -769,7 +632,7 @@ export declare enum ViewMode {
|
|
|
769
632
|
/** Mini PDF view */
|
|
770
633
|
MINI = "MINI"
|
|
771
634
|
}
|
|
772
|
-
|
|
635
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
773
636
|
/** The absolute URL for the file's source. */
|
|
774
637
|
url?: string | null;
|
|
775
638
|
/**
|
|
@@ -783,7 +646,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
783
646
|
private?: boolean | null;
|
|
784
647
|
}
|
|
785
648
|
/** @oneof */
|
|
786
|
-
|
|
649
|
+
interface FileSourceDataOneOf {
|
|
787
650
|
/** The absolute URL for the file's source. */
|
|
788
651
|
url?: string | null;
|
|
789
652
|
/**
|
|
@@ -794,7 +657,7 @@ export interface FileSourceDataOneOf {
|
|
|
794
657
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
795
658
|
id?: string | null;
|
|
796
659
|
}
|
|
797
|
-
|
|
660
|
+
interface PDFSettings {
|
|
798
661
|
/**
|
|
799
662
|
* PDF view mode. One of the following:
|
|
800
663
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -807,7 +670,7 @@ export interface PDFSettings {
|
|
|
807
670
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
808
671
|
disablePrint?: boolean | null;
|
|
809
672
|
}
|
|
810
|
-
|
|
673
|
+
interface GalleryData {
|
|
811
674
|
/** Styling for the gallery's container. */
|
|
812
675
|
containerData?: PluginContainerData;
|
|
813
676
|
/** The items in the gallery. */
|
|
@@ -819,7 +682,7 @@ export interface GalleryData {
|
|
|
819
682
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
820
683
|
disableDownload?: boolean | null;
|
|
821
684
|
}
|
|
822
|
-
|
|
685
|
+
interface V1Media {
|
|
823
686
|
/** The source for the media's data. */
|
|
824
687
|
src?: FileSource;
|
|
825
688
|
/** Media width in pixels. */
|
|
@@ -829,19 +692,19 @@ export interface V1Media {
|
|
|
829
692
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
830
693
|
duration?: number | null;
|
|
831
694
|
}
|
|
832
|
-
|
|
695
|
+
interface ItemImage {
|
|
833
696
|
/** Image file details. */
|
|
834
697
|
media?: V1Media;
|
|
835
698
|
/** Link details for images that are links. */
|
|
836
699
|
link?: Link;
|
|
837
700
|
}
|
|
838
|
-
|
|
701
|
+
interface ItemVideo {
|
|
839
702
|
/** Video file details. */
|
|
840
703
|
media?: V1Media;
|
|
841
704
|
/** Video thumbnail file details. */
|
|
842
705
|
thumbnail?: V1Media;
|
|
843
706
|
}
|
|
844
|
-
|
|
707
|
+
interface Item extends ItemDataOneOf {
|
|
845
708
|
/** An image item. */
|
|
846
709
|
image?: ItemImage;
|
|
847
710
|
/** A video item. */
|
|
@@ -852,13 +715,13 @@ export interface Item extends ItemDataOneOf {
|
|
|
852
715
|
altText?: string | null;
|
|
853
716
|
}
|
|
854
717
|
/** @oneof */
|
|
855
|
-
|
|
718
|
+
interface ItemDataOneOf {
|
|
856
719
|
/** An image item. */
|
|
857
720
|
image?: ItemImage;
|
|
858
721
|
/** A video item. */
|
|
859
722
|
video?: ItemVideo;
|
|
860
723
|
}
|
|
861
|
-
|
|
724
|
+
interface GalleryOptions {
|
|
862
725
|
/** Gallery layout. */
|
|
863
726
|
layout?: Layout;
|
|
864
727
|
/** Styling for gallery items. */
|
|
@@ -866,7 +729,7 @@ export interface GalleryOptions {
|
|
|
866
729
|
/** Styling for gallery thumbnail images. */
|
|
867
730
|
thumbnails?: Thumbnails;
|
|
868
731
|
}
|
|
869
|
-
|
|
732
|
+
declare enum LayoutType {
|
|
870
733
|
/** Collage type */
|
|
871
734
|
COLLAGE = "COLLAGE",
|
|
872
735
|
/** Masonry type */
|
|
@@ -888,19 +751,19 @@ export declare enum LayoutType {
|
|
|
888
751
|
/** Fullsize images type */
|
|
889
752
|
FULLSIZE = "FULLSIZE"
|
|
890
753
|
}
|
|
891
|
-
|
|
754
|
+
declare enum Orientation {
|
|
892
755
|
/** Rows Orientation */
|
|
893
756
|
ROWS = "ROWS",
|
|
894
757
|
/** Columns Orientation */
|
|
895
758
|
COLUMNS = "COLUMNS"
|
|
896
759
|
}
|
|
897
|
-
|
|
760
|
+
declare enum Crop {
|
|
898
761
|
/** Crop to fill */
|
|
899
762
|
FILL = "FILL",
|
|
900
763
|
/** Crop to fit */
|
|
901
764
|
FIT = "FIT"
|
|
902
765
|
}
|
|
903
|
-
|
|
766
|
+
declare enum ThumbnailsAlignment {
|
|
904
767
|
/** Top alignment */
|
|
905
768
|
TOP = "TOP",
|
|
906
769
|
/** Right alignment */
|
|
@@ -912,7 +775,7 @@ export declare enum ThumbnailsAlignment {
|
|
|
912
775
|
/** No thumbnail */
|
|
913
776
|
NONE = "NONE"
|
|
914
777
|
}
|
|
915
|
-
|
|
778
|
+
interface Layout {
|
|
916
779
|
/** Gallery layout type. */
|
|
917
780
|
type?: LayoutType;
|
|
918
781
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -924,7 +787,7 @@ export interface Layout {
|
|
|
924
787
|
/** The number of columns to display on mobile screens. */
|
|
925
788
|
mobileNumberOfColumns?: number | null;
|
|
926
789
|
}
|
|
927
|
-
|
|
790
|
+
interface ItemStyle {
|
|
928
791
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
929
792
|
targetSize?: number | null;
|
|
930
793
|
/** Item ratio */
|
|
@@ -934,13 +797,13 @@ export interface ItemStyle {
|
|
|
934
797
|
/** The spacing between items in pixels. */
|
|
935
798
|
spacing?: number | null;
|
|
936
799
|
}
|
|
937
|
-
|
|
800
|
+
interface Thumbnails {
|
|
938
801
|
/** Thumbnail alignment. */
|
|
939
802
|
placement?: ThumbnailsAlignment;
|
|
940
803
|
/** Spacing between thumbnails in pixels. */
|
|
941
804
|
spacing?: number | null;
|
|
942
805
|
}
|
|
943
|
-
|
|
806
|
+
interface GIFData {
|
|
944
807
|
/** Styling for the GIF's container. */
|
|
945
808
|
containerData?: PluginContainerData;
|
|
946
809
|
/** The source of the full size GIF. */
|
|
@@ -954,7 +817,7 @@ export interface GIFData {
|
|
|
954
817
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
955
818
|
gifType?: GIFType;
|
|
956
819
|
}
|
|
957
|
-
|
|
820
|
+
interface GIF {
|
|
958
821
|
/**
|
|
959
822
|
* GIF format URL.
|
|
960
823
|
* @format WEB_URL
|
|
@@ -971,11 +834,11 @@ export interface GIF {
|
|
|
971
834
|
*/
|
|
972
835
|
still?: string | null;
|
|
973
836
|
}
|
|
974
|
-
|
|
837
|
+
declare enum GIFType {
|
|
975
838
|
NORMAL = "NORMAL",
|
|
976
839
|
STICKER = "STICKER"
|
|
977
840
|
}
|
|
978
|
-
|
|
841
|
+
interface HeadingData {
|
|
979
842
|
/** Heading level from 1-6. */
|
|
980
843
|
level?: number;
|
|
981
844
|
/** Styling for the heading text. */
|
|
@@ -983,7 +846,7 @@ export interface HeadingData {
|
|
|
983
846
|
/** Indentation level from 1-4. */
|
|
984
847
|
indentation?: number | null;
|
|
985
848
|
}
|
|
986
|
-
|
|
849
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
987
850
|
/** The URL for the HTML code for the node. */
|
|
988
851
|
url?: string;
|
|
989
852
|
/** The HTML code for the node. */
|
|
@@ -1001,7 +864,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
1001
864
|
autoHeight?: boolean | null;
|
|
1002
865
|
}
|
|
1003
866
|
/** @oneof */
|
|
1004
|
-
|
|
867
|
+
interface HTMLDataDataOneOf {
|
|
1005
868
|
/** The URL for the HTML code for the node. */
|
|
1006
869
|
url?: string;
|
|
1007
870
|
/** The HTML code for the node. */
|
|
@@ -1012,11 +875,11 @@ export interface HTMLDataDataOneOf {
|
|
|
1012
875
|
*/
|
|
1013
876
|
isAdsense?: boolean | null;
|
|
1014
877
|
}
|
|
1015
|
-
|
|
878
|
+
declare enum Source {
|
|
1016
879
|
HTML = "HTML",
|
|
1017
880
|
ADSENSE = "ADSENSE"
|
|
1018
881
|
}
|
|
1019
|
-
|
|
882
|
+
interface ImageData {
|
|
1020
883
|
/** Styling for the image's container. */
|
|
1021
884
|
containerData?: PluginContainerData;
|
|
1022
885
|
/** Image file details. */
|
|
@@ -1039,7 +902,7 @@ export interface ImageData {
|
|
|
1039
902
|
/** Styling for the image. */
|
|
1040
903
|
styles?: ImageDataStyles;
|
|
1041
904
|
}
|
|
1042
|
-
|
|
905
|
+
interface StylesBorder {
|
|
1043
906
|
/** Border width in pixels. */
|
|
1044
907
|
width?: number | null;
|
|
1045
908
|
/**
|
|
@@ -1050,11 +913,11 @@ export interface StylesBorder {
|
|
|
1050
913
|
/** Border radius in pixels. */
|
|
1051
914
|
radius?: number | null;
|
|
1052
915
|
}
|
|
1053
|
-
|
|
916
|
+
interface ImageDataStyles {
|
|
1054
917
|
/** Border attributes. */
|
|
1055
918
|
border?: StylesBorder;
|
|
1056
919
|
}
|
|
1057
|
-
|
|
920
|
+
interface LinkPreviewData {
|
|
1058
921
|
/** Styling for the link preview's container. */
|
|
1059
922
|
containerData?: PluginContainerData;
|
|
1060
923
|
/** Link details. */
|
|
@@ -1070,7 +933,7 @@ export interface LinkPreviewData {
|
|
|
1070
933
|
/** Styling for the link preview. */
|
|
1071
934
|
styles?: LinkPreviewDataStyles;
|
|
1072
935
|
}
|
|
1073
|
-
|
|
936
|
+
declare enum Position {
|
|
1074
937
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
1075
938
|
START = "START",
|
|
1076
939
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -1080,7 +943,7 @@ export declare enum Position {
|
|
|
1080
943
|
/** Thumbnail hidden and not displayed */
|
|
1081
944
|
HIDDEN = "HIDDEN"
|
|
1082
945
|
}
|
|
1083
|
-
|
|
946
|
+
interface LinkPreviewDataStyles {
|
|
1084
947
|
/**
|
|
1085
948
|
* Background color as a hexadecimal value.
|
|
1086
949
|
* @format COLOR_HEX
|
|
@@ -1113,13 +976,13 @@ export interface LinkPreviewDataStyles {
|
|
|
1113
976
|
/** Position of thumbnail. Defaults to `START`. */
|
|
1114
977
|
thumbnailPosition?: Position;
|
|
1115
978
|
}
|
|
1116
|
-
|
|
979
|
+
interface MapData {
|
|
1117
980
|
/** Styling for the map's container. */
|
|
1118
981
|
containerData?: PluginContainerData;
|
|
1119
982
|
/** Map settings. */
|
|
1120
983
|
mapSettings?: MapSettings;
|
|
1121
984
|
}
|
|
1122
|
-
|
|
985
|
+
interface MapSettings {
|
|
1123
986
|
/** The address to display on the map. */
|
|
1124
987
|
address?: string | null;
|
|
1125
988
|
/** Sets whether the map is draggable. */
|
|
@@ -1143,7 +1006,7 @@ export interface MapSettings {
|
|
|
1143
1006
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
1144
1007
|
mapType?: MapType;
|
|
1145
1008
|
}
|
|
1146
|
-
|
|
1009
|
+
declare enum MapType {
|
|
1147
1010
|
/** Roadmap map type */
|
|
1148
1011
|
ROADMAP = "ROADMAP",
|
|
1149
1012
|
/** Satellite map type */
|
|
@@ -1153,7 +1016,7 @@ export declare enum MapType {
|
|
|
1153
1016
|
/** Terrain map type */
|
|
1154
1017
|
TERRAIN = "TERRAIN"
|
|
1155
1018
|
}
|
|
1156
|
-
|
|
1019
|
+
interface ParagraphData {
|
|
1157
1020
|
/** Styling for the paragraph text. */
|
|
1158
1021
|
textStyle?: TextStyle;
|
|
1159
1022
|
/** Indentation level from 1-4. */
|
|
@@ -1161,7 +1024,7 @@ export interface ParagraphData {
|
|
|
1161
1024
|
/** Paragraph level */
|
|
1162
1025
|
level?: number | null;
|
|
1163
1026
|
}
|
|
1164
|
-
|
|
1027
|
+
interface PollData {
|
|
1165
1028
|
/** Styling for the poll's container. */
|
|
1166
1029
|
containerData?: PluginContainerData;
|
|
1167
1030
|
/** Poll data. */
|
|
@@ -1171,7 +1034,7 @@ export interface PollData {
|
|
|
1171
1034
|
/** Styling for the poll and voting options. */
|
|
1172
1035
|
design?: Design;
|
|
1173
1036
|
}
|
|
1174
|
-
|
|
1037
|
+
declare enum ViewRole {
|
|
1175
1038
|
/** Only Poll creator can view the results */
|
|
1176
1039
|
CREATOR = "CREATOR",
|
|
1177
1040
|
/** Anyone who voted can see the results */
|
|
@@ -1179,13 +1042,13 @@ export declare enum ViewRole {
|
|
|
1179
1042
|
/** Anyone can see the results, even if one didn't vote */
|
|
1180
1043
|
EVERYONE = "EVERYONE"
|
|
1181
1044
|
}
|
|
1182
|
-
|
|
1045
|
+
declare enum VoteRole {
|
|
1183
1046
|
/** Logged in member */
|
|
1184
1047
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
1185
1048
|
/** Anyone */
|
|
1186
1049
|
ALL = "ALL"
|
|
1187
1050
|
}
|
|
1188
|
-
|
|
1051
|
+
interface Permissions {
|
|
1189
1052
|
/** Sets who can view the poll results. */
|
|
1190
1053
|
view?: ViewRole;
|
|
1191
1054
|
/** Sets who can vote. */
|
|
@@ -1193,7 +1056,7 @@ export interface Permissions {
|
|
|
1193
1056
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1194
1057
|
allowMultipleVotes?: boolean | null;
|
|
1195
1058
|
}
|
|
1196
|
-
|
|
1059
|
+
interface Option {
|
|
1197
1060
|
/** Option ID. */
|
|
1198
1061
|
id?: string | null;
|
|
1199
1062
|
/** Option title. */
|
|
@@ -1201,7 +1064,7 @@ export interface Option {
|
|
|
1201
1064
|
/** The image displayed with the option. */
|
|
1202
1065
|
image?: V1Media;
|
|
1203
1066
|
}
|
|
1204
|
-
|
|
1067
|
+
interface PollSettings {
|
|
1205
1068
|
/** Permissions settings for voting. */
|
|
1206
1069
|
permissions?: Permissions;
|
|
1207
1070
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -1209,19 +1072,19 @@ export interface PollSettings {
|
|
|
1209
1072
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
1210
1073
|
showVotesCount?: boolean | null;
|
|
1211
1074
|
}
|
|
1212
|
-
|
|
1075
|
+
declare enum PollLayoutType {
|
|
1213
1076
|
/** List */
|
|
1214
1077
|
LIST = "LIST",
|
|
1215
1078
|
/** Grid */
|
|
1216
1079
|
GRID = "GRID"
|
|
1217
1080
|
}
|
|
1218
|
-
|
|
1081
|
+
declare enum PollLayoutDirection {
|
|
1219
1082
|
/** Left-to-right */
|
|
1220
1083
|
LTR = "LTR",
|
|
1221
1084
|
/** Right-to-left */
|
|
1222
1085
|
RTL = "RTL"
|
|
1223
1086
|
}
|
|
1224
|
-
|
|
1087
|
+
interface PollLayout {
|
|
1225
1088
|
/** The layout for displaying the voting options. */
|
|
1226
1089
|
type?: PollLayoutType;
|
|
1227
1090
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -1229,11 +1092,11 @@ export interface PollLayout {
|
|
|
1229
1092
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1230
1093
|
enableImage?: boolean | null;
|
|
1231
1094
|
}
|
|
1232
|
-
|
|
1095
|
+
interface OptionLayout {
|
|
1233
1096
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
1234
1097
|
enableImage?: boolean | null;
|
|
1235
1098
|
}
|
|
1236
|
-
|
|
1099
|
+
declare enum BackgroundType {
|
|
1237
1100
|
/** Color background type */
|
|
1238
1101
|
COLOR = "COLOR",
|
|
1239
1102
|
/** Image background type */
|
|
@@ -1241,7 +1104,7 @@ export declare enum BackgroundType {
|
|
|
1241
1104
|
/** Gradiant background type */
|
|
1242
1105
|
GRADIENT = "GRADIENT"
|
|
1243
1106
|
}
|
|
1244
|
-
|
|
1107
|
+
interface Gradient {
|
|
1245
1108
|
/** The gradient angle in degrees. */
|
|
1246
1109
|
angle?: number | null;
|
|
1247
1110
|
/**
|
|
@@ -1255,7 +1118,7 @@ export interface Gradient {
|
|
|
1255
1118
|
*/
|
|
1256
1119
|
lastColor?: string | null;
|
|
1257
1120
|
}
|
|
1258
|
-
|
|
1121
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
1259
1122
|
/**
|
|
1260
1123
|
* The background color as a hexademical value.
|
|
1261
1124
|
* @format COLOR_HEX
|
|
@@ -1269,7 +1132,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1269
1132
|
type?: BackgroundType;
|
|
1270
1133
|
}
|
|
1271
1134
|
/** @oneof */
|
|
1272
|
-
|
|
1135
|
+
interface BackgroundBackgroundOneOf {
|
|
1273
1136
|
/**
|
|
1274
1137
|
* The background color as a hexademical value.
|
|
1275
1138
|
* @format COLOR_HEX
|
|
@@ -1280,17 +1143,17 @@ export interface BackgroundBackgroundOneOf {
|
|
|
1280
1143
|
/** Details for a gradient background. */
|
|
1281
1144
|
gradient?: Gradient;
|
|
1282
1145
|
}
|
|
1283
|
-
|
|
1146
|
+
interface PollDesign {
|
|
1284
1147
|
/** Background styling. */
|
|
1285
1148
|
background?: Background;
|
|
1286
1149
|
/** Border radius in pixels. */
|
|
1287
1150
|
borderRadius?: number | null;
|
|
1288
1151
|
}
|
|
1289
|
-
|
|
1152
|
+
interface OptionDesign {
|
|
1290
1153
|
/** Border radius in pixels. */
|
|
1291
1154
|
borderRadius?: number | null;
|
|
1292
1155
|
}
|
|
1293
|
-
|
|
1156
|
+
interface Poll {
|
|
1294
1157
|
/** Poll ID. */
|
|
1295
1158
|
id?: string | null;
|
|
1296
1159
|
/** Poll title. */
|
|
@@ -1304,26 +1167,26 @@ export interface Poll {
|
|
|
1304
1167
|
/** The poll's permissions and display settings. */
|
|
1305
1168
|
settings?: PollSettings;
|
|
1306
1169
|
}
|
|
1307
|
-
|
|
1170
|
+
interface PollDataLayout {
|
|
1308
1171
|
/** Poll layout settings. */
|
|
1309
1172
|
poll?: PollLayout;
|
|
1310
1173
|
/** Voting otpions layout settings. */
|
|
1311
1174
|
options?: OptionLayout;
|
|
1312
1175
|
}
|
|
1313
|
-
|
|
1176
|
+
interface Design {
|
|
1314
1177
|
/** Styling for the poll. */
|
|
1315
1178
|
poll?: PollDesign;
|
|
1316
1179
|
/** Styling for voting options. */
|
|
1317
1180
|
options?: OptionDesign;
|
|
1318
1181
|
}
|
|
1319
|
-
|
|
1182
|
+
interface TextData {
|
|
1320
1183
|
/** The text to apply decorations to. */
|
|
1321
1184
|
text?: string;
|
|
1322
1185
|
/** The decorations to apply. */
|
|
1323
1186
|
decorations?: Decoration[];
|
|
1324
1187
|
}
|
|
1325
1188
|
/** Adds appearence changes to text */
|
|
1326
|
-
|
|
1189
|
+
interface Decoration extends DecorationDataOneOf {
|
|
1327
1190
|
/** Data for an anchor link decoration. */
|
|
1328
1191
|
anchorData?: AnchorData;
|
|
1329
1192
|
/** Data for a color decoration. */
|
|
@@ -1342,11 +1205,13 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
1342
1205
|
underlineData?: boolean | null;
|
|
1343
1206
|
/** Data for a spoiler decoration. */
|
|
1344
1207
|
spoilerData?: SpoilerData;
|
|
1208
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1209
|
+
strikethroughData?: boolean | null;
|
|
1345
1210
|
/** The type of decoration to apply. */
|
|
1346
1211
|
type?: DecorationType;
|
|
1347
1212
|
}
|
|
1348
1213
|
/** @oneof */
|
|
1349
|
-
|
|
1214
|
+
interface DecorationDataOneOf {
|
|
1350
1215
|
/** Data for an anchor link decoration. */
|
|
1351
1216
|
anchorData?: AnchorData;
|
|
1352
1217
|
/** Data for a color decoration. */
|
|
@@ -1365,8 +1230,10 @@ export interface DecorationDataOneOf {
|
|
|
1365
1230
|
underlineData?: boolean | null;
|
|
1366
1231
|
/** Data for a spoiler decoration. */
|
|
1367
1232
|
spoilerData?: SpoilerData;
|
|
1233
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1234
|
+
strikethroughData?: boolean | null;
|
|
1368
1235
|
}
|
|
1369
|
-
|
|
1236
|
+
declare enum DecorationType {
|
|
1370
1237
|
BOLD = "BOLD",
|
|
1371
1238
|
ITALIC = "ITALIC",
|
|
1372
1239
|
UNDERLINE = "UNDERLINE",
|
|
@@ -1376,23 +1243,24 @@ export declare enum DecorationType {
|
|
|
1376
1243
|
LINK = "LINK",
|
|
1377
1244
|
COLOR = "COLOR",
|
|
1378
1245
|
FONT_SIZE = "FONT_SIZE",
|
|
1379
|
-
EXTERNAL = "EXTERNAL"
|
|
1246
|
+
EXTERNAL = "EXTERNAL",
|
|
1247
|
+
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1380
1248
|
}
|
|
1381
|
-
|
|
1249
|
+
interface AnchorData {
|
|
1382
1250
|
/** The target node's ID. */
|
|
1383
1251
|
anchor?: string;
|
|
1384
1252
|
}
|
|
1385
|
-
|
|
1253
|
+
interface ColorData {
|
|
1386
1254
|
/** The text's background color as a hexadecimal value. */
|
|
1387
1255
|
background?: string | null;
|
|
1388
1256
|
/** The text's foreground color as a hexadecimal value. */
|
|
1389
1257
|
foreground?: string | null;
|
|
1390
1258
|
}
|
|
1391
|
-
|
|
1259
|
+
interface LinkData {
|
|
1392
1260
|
/** Link details. */
|
|
1393
1261
|
link?: Link;
|
|
1394
1262
|
}
|
|
1395
|
-
|
|
1263
|
+
interface MentionData {
|
|
1396
1264
|
/** The mentioned user's name. */
|
|
1397
1265
|
name?: string;
|
|
1398
1266
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -1400,21 +1268,21 @@ export interface MentionData {
|
|
|
1400
1268
|
/** Mentioned user's ID. */
|
|
1401
1269
|
id?: string | null;
|
|
1402
1270
|
}
|
|
1403
|
-
|
|
1271
|
+
interface FontSizeData {
|
|
1404
1272
|
/** The units used for the font size. */
|
|
1405
1273
|
unit?: FontType;
|
|
1406
1274
|
/** Font size value. */
|
|
1407
1275
|
value?: number | null;
|
|
1408
1276
|
}
|
|
1409
|
-
|
|
1277
|
+
declare enum FontType {
|
|
1410
1278
|
PX = "PX",
|
|
1411
1279
|
EM = "EM"
|
|
1412
1280
|
}
|
|
1413
|
-
|
|
1281
|
+
interface SpoilerData {
|
|
1414
1282
|
/** Spoiler ID. */
|
|
1415
1283
|
id?: string | null;
|
|
1416
1284
|
}
|
|
1417
|
-
|
|
1285
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1418
1286
|
/** Data for embedded Wix Bookings content. */
|
|
1419
1287
|
bookingData?: BookingData;
|
|
1420
1288
|
/** Data for embedded Wix Events content. */
|
|
@@ -1436,28 +1304,28 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1436
1304
|
image?: V1Media;
|
|
1437
1305
|
}
|
|
1438
1306
|
/** @oneof */
|
|
1439
|
-
|
|
1307
|
+
interface AppEmbedDataAppDataOneOf {
|
|
1440
1308
|
/** Data for embedded Wix Bookings content. */
|
|
1441
1309
|
bookingData?: BookingData;
|
|
1442
1310
|
/** Data for embedded Wix Events content. */
|
|
1443
1311
|
eventData?: EventData;
|
|
1444
1312
|
}
|
|
1445
|
-
|
|
1313
|
+
declare enum AppType {
|
|
1446
1314
|
PRODUCT = "PRODUCT",
|
|
1447
1315
|
EVENT = "EVENT",
|
|
1448
1316
|
BOOKING = "BOOKING"
|
|
1449
1317
|
}
|
|
1450
|
-
|
|
1318
|
+
interface BookingData {
|
|
1451
1319
|
/** Booking duration in minutes. */
|
|
1452
1320
|
durations?: string | null;
|
|
1453
1321
|
}
|
|
1454
|
-
|
|
1322
|
+
interface EventData {
|
|
1455
1323
|
/** Event schedule. */
|
|
1456
1324
|
scheduling?: string | null;
|
|
1457
1325
|
/** Event location. */
|
|
1458
1326
|
location?: string | null;
|
|
1459
1327
|
}
|
|
1460
|
-
|
|
1328
|
+
interface VideoData {
|
|
1461
1329
|
/** Styling for the video's container. */
|
|
1462
1330
|
containerData?: PluginContainerData;
|
|
1463
1331
|
/** Video details. */
|
|
@@ -1471,7 +1339,7 @@ export interface VideoData {
|
|
|
1471
1339
|
/** Video options. */
|
|
1472
1340
|
options?: PlaybackOptions;
|
|
1473
1341
|
}
|
|
1474
|
-
|
|
1342
|
+
interface PlaybackOptions {
|
|
1475
1343
|
/** Sets whether the media will automatically start playing. */
|
|
1476
1344
|
autoPlay?: boolean | null;
|
|
1477
1345
|
/** Sets whether media's will be looped. */
|
|
@@ -1479,7 +1347,7 @@ export interface PlaybackOptions {
|
|
|
1479
1347
|
/** Sets whether media's controls will be shown. */
|
|
1480
1348
|
showControls?: boolean | null;
|
|
1481
1349
|
}
|
|
1482
|
-
|
|
1350
|
+
interface EmbedData {
|
|
1483
1351
|
/** Styling for the oEmbed node's container. */
|
|
1484
1352
|
containerData?: PluginContainerData;
|
|
1485
1353
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -1487,7 +1355,7 @@ export interface EmbedData {
|
|
|
1487
1355
|
/** Origin asset source. */
|
|
1488
1356
|
src?: string | null;
|
|
1489
1357
|
}
|
|
1490
|
-
|
|
1358
|
+
interface Oembed {
|
|
1491
1359
|
/** The resource type. */
|
|
1492
1360
|
type?: string | null;
|
|
1493
1361
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -1519,7 +1387,7 @@ export interface Oembed {
|
|
|
1519
1387
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
1520
1388
|
version?: string | null;
|
|
1521
1389
|
}
|
|
1522
|
-
|
|
1390
|
+
interface CollapsibleListData {
|
|
1523
1391
|
/** Styling for the collapsible list's container. */
|
|
1524
1392
|
containerData?: PluginContainerData;
|
|
1525
1393
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -1531,7 +1399,7 @@ export interface CollapsibleListData {
|
|
|
1531
1399
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1532
1400
|
isQapageData?: boolean | null;
|
|
1533
1401
|
}
|
|
1534
|
-
|
|
1402
|
+
declare enum InitialExpandedItems {
|
|
1535
1403
|
/** First item will be expended initally */
|
|
1536
1404
|
FIRST = "FIRST",
|
|
1537
1405
|
/** All items will expended initally */
|
|
@@ -1539,13 +1407,13 @@ export declare enum InitialExpandedItems {
|
|
|
1539
1407
|
/** All items collapsed initally */
|
|
1540
1408
|
NONE = "NONE"
|
|
1541
1409
|
}
|
|
1542
|
-
|
|
1410
|
+
declare enum Direction {
|
|
1543
1411
|
/** Left-to-right */
|
|
1544
1412
|
LTR = "LTR",
|
|
1545
1413
|
/** Right-to-left */
|
|
1546
1414
|
RTL = "RTL"
|
|
1547
1415
|
}
|
|
1548
|
-
|
|
1416
|
+
interface TableData {
|
|
1549
1417
|
/** Styling for the table's container. */
|
|
1550
1418
|
containerData?: PluginContainerData;
|
|
1551
1419
|
/** The table's dimensions. */
|
|
@@ -1560,7 +1428,7 @@ export interface TableData {
|
|
|
1560
1428
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1561
1429
|
columnHeader?: boolean | null;
|
|
1562
1430
|
}
|
|
1563
|
-
|
|
1431
|
+
interface Dimensions {
|
|
1564
1432
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
1565
1433
|
colsWidthRatio?: number[];
|
|
1566
1434
|
/** An array representing the height of each row in pixels. */
|
|
@@ -1568,13 +1436,13 @@ export interface Dimensions {
|
|
|
1568
1436
|
/** An array representing the minimum width of each column in pixels. */
|
|
1569
1437
|
colsMinWidth?: number[];
|
|
1570
1438
|
}
|
|
1571
|
-
|
|
1439
|
+
interface TableCellData {
|
|
1572
1440
|
/** Styling for the cell's background color and text alignment. */
|
|
1573
1441
|
cellStyle?: CellStyle;
|
|
1574
1442
|
/** The cell's border colors. */
|
|
1575
1443
|
borderColors?: BorderColors;
|
|
1576
1444
|
}
|
|
1577
|
-
|
|
1445
|
+
declare enum VerticalAlignment {
|
|
1578
1446
|
/** Top alignment */
|
|
1579
1447
|
TOP = "TOP",
|
|
1580
1448
|
/** Middle alignment */
|
|
@@ -1582,7 +1450,7 @@ export declare enum VerticalAlignment {
|
|
|
1582
1450
|
/** Bottom alignment */
|
|
1583
1451
|
BOTTOM = "BOTTOM"
|
|
1584
1452
|
}
|
|
1585
|
-
|
|
1453
|
+
interface CellStyle {
|
|
1586
1454
|
/** Vertical alignment for the cell's text. */
|
|
1587
1455
|
verticalAlignment?: VerticalAlignment;
|
|
1588
1456
|
/**
|
|
@@ -1591,7 +1459,7 @@ export interface CellStyle {
|
|
|
1591
1459
|
*/
|
|
1592
1460
|
backgroundColor?: string | null;
|
|
1593
1461
|
}
|
|
1594
|
-
|
|
1462
|
+
interface BorderColors {
|
|
1595
1463
|
/**
|
|
1596
1464
|
* Left border color as a hexadecimal value.
|
|
1597
1465
|
* @format COLOR_HEX
|
|
@@ -1613,26 +1481,7 @@ export interface BorderColors {
|
|
|
1613
1481
|
*/
|
|
1614
1482
|
bottom?: string | null;
|
|
1615
1483
|
}
|
|
1616
|
-
|
|
1617
|
-
* `NullValue` is a singleton enumeration to represent the null value for the
|
|
1618
|
-
* `Value` type union.
|
|
1619
|
-
*
|
|
1620
|
-
* The JSON representation for `NullValue` is JSON `null`.
|
|
1621
|
-
*/
|
|
1622
|
-
export declare enum NullValue {
|
|
1623
|
-
/** Null value. */
|
|
1624
|
-
NULL_VALUE = "NULL_VALUE"
|
|
1625
|
-
}
|
|
1626
|
-
/**
|
|
1627
|
-
* `ListValue` is a wrapper around a repeated field of values.
|
|
1628
|
-
*
|
|
1629
|
-
* The JSON representation for `ListValue` is JSON array.
|
|
1630
|
-
*/
|
|
1631
|
-
export interface ListValue {
|
|
1632
|
-
/** Repeated field of dynamically typed values. */
|
|
1633
|
-
values?: any[];
|
|
1634
|
-
}
|
|
1635
|
-
export interface AudioData {
|
|
1484
|
+
interface AudioData {
|
|
1636
1485
|
/** Styling for the audio node's container. */
|
|
1637
1486
|
containerData?: PluginContainerData;
|
|
1638
1487
|
/** Audio file details. */
|
|
@@ -1648,7 +1497,7 @@ export interface AudioData {
|
|
|
1648
1497
|
/** An HTML version of the audio node. */
|
|
1649
1498
|
html?: string | null;
|
|
1650
1499
|
}
|
|
1651
|
-
|
|
1500
|
+
interface OrderedListData {
|
|
1652
1501
|
/** Indentation level from 0-4. */
|
|
1653
1502
|
indentation?: number;
|
|
1654
1503
|
/** Offset level from 0-4. */
|
|
@@ -1656,24 +1505,24 @@ export interface OrderedListData {
|
|
|
1656
1505
|
/** List start number. */
|
|
1657
1506
|
start?: number | null;
|
|
1658
1507
|
}
|
|
1659
|
-
|
|
1508
|
+
interface BulletedListData {
|
|
1660
1509
|
/** Indentation level from 0-4. */
|
|
1661
1510
|
indentation?: number;
|
|
1662
1511
|
/** Offset level from 0-4. */
|
|
1663
1512
|
offset?: number | null;
|
|
1664
1513
|
}
|
|
1665
|
-
|
|
1514
|
+
interface BlockquoteData {
|
|
1666
1515
|
/** Indentation level from 1-4. */
|
|
1667
1516
|
indentation?: number;
|
|
1668
1517
|
}
|
|
1669
|
-
|
|
1518
|
+
interface CaptionData {
|
|
1670
1519
|
textStyle?: TextStyle;
|
|
1671
1520
|
}
|
|
1672
|
-
|
|
1521
|
+
interface LayoutCellData {
|
|
1673
1522
|
/** Size of the cell in 12 columns grid. */
|
|
1674
1523
|
colSpan?: number | null;
|
|
1675
1524
|
}
|
|
1676
|
-
|
|
1525
|
+
interface Metadata {
|
|
1677
1526
|
/** Schema version. */
|
|
1678
1527
|
version?: number;
|
|
1679
1528
|
/**
|
|
@@ -1690,7 +1539,7 @@ export interface Metadata {
|
|
|
1690
1539
|
/** Object ID. */
|
|
1691
1540
|
id?: string | null;
|
|
1692
1541
|
}
|
|
1693
|
-
|
|
1542
|
+
interface DocumentStyle {
|
|
1694
1543
|
/** Styling for H1 nodes. */
|
|
1695
1544
|
headerOne?: TextNodeStyle;
|
|
1696
1545
|
/** Styling for H2 nodes. */
|
|
@@ -1710,7 +1559,7 @@ export interface DocumentStyle {
|
|
|
1710
1559
|
/** Styling for code block nodes. */
|
|
1711
1560
|
codeBlock?: TextNodeStyle;
|
|
1712
1561
|
}
|
|
1713
|
-
|
|
1562
|
+
interface TextNodeStyle {
|
|
1714
1563
|
/** The decorations to apply to the node. */
|
|
1715
1564
|
decorations?: Decoration[];
|
|
1716
1565
|
/** Padding and background color for the node. */
|
|
@@ -1718,7 +1567,7 @@ export interface TextNodeStyle {
|
|
|
1718
1567
|
/** Line height for text in the node. */
|
|
1719
1568
|
lineHeight?: string | null;
|
|
1720
1569
|
}
|
|
1721
|
-
|
|
1570
|
+
declare enum Status {
|
|
1722
1571
|
UNKNOWN = "UNKNOWN",
|
|
1723
1572
|
/** Status indicating the draft post is published. */
|
|
1724
1573
|
PUBLISHED = "PUBLISHED",
|
|
@@ -1731,7 +1580,7 @@ export declare enum Status {
|
|
|
1731
1580
|
/** Status indicating the draft post is in review. */
|
|
1732
1581
|
IN_REVIEW = "IN_REVIEW"
|
|
1733
1582
|
}
|
|
1734
|
-
|
|
1583
|
+
interface ModerationDetails {
|
|
1735
1584
|
/**
|
|
1736
1585
|
* Member ID of the person submitting the draft post for review.
|
|
1737
1586
|
* @format GUID
|
|
@@ -1749,7 +1598,7 @@ export interface ModerationDetails {
|
|
|
1749
1598
|
/** Date the post was approved or rejected. */
|
|
1750
1599
|
moderationDate?: Date | null;
|
|
1751
1600
|
}
|
|
1752
|
-
|
|
1601
|
+
declare enum ModerationStatusStatus {
|
|
1753
1602
|
UNKNOWN = "UNKNOWN",
|
|
1754
1603
|
APPROVED = "APPROVED",
|
|
1755
1604
|
REJECTED = "REJECTED"
|
|
@@ -1759,13 +1608,13 @@ export declare enum ModerationStatusStatus {
|
|
|
1759
1608
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
1760
1609
|
* 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.
|
|
1761
1610
|
*/
|
|
1762
|
-
|
|
1611
|
+
interface SeoSchema {
|
|
1763
1612
|
/** SEO tag information. */
|
|
1764
1613
|
tags?: Tag[];
|
|
1765
1614
|
/** SEO general settings. */
|
|
1766
1615
|
settings?: Settings;
|
|
1767
1616
|
}
|
|
1768
|
-
|
|
1617
|
+
interface Keyword {
|
|
1769
1618
|
/** Keyword value. */
|
|
1770
1619
|
term?: string;
|
|
1771
1620
|
/** Whether the keyword is the main focus keyword. */
|
|
@@ -1776,7 +1625,7 @@ export interface Keyword {
|
|
|
1776
1625
|
*/
|
|
1777
1626
|
origin?: string | null;
|
|
1778
1627
|
}
|
|
1779
|
-
|
|
1628
|
+
interface Tag {
|
|
1780
1629
|
/**
|
|
1781
1630
|
* SEO tag type.
|
|
1782
1631
|
*
|
|
@@ -1798,7 +1647,7 @@ export interface Tag {
|
|
|
1798
1647
|
/** Whether the tag is disabled. */
|
|
1799
1648
|
disabled?: boolean;
|
|
1800
1649
|
}
|
|
1801
|
-
|
|
1650
|
+
interface Settings {
|
|
1802
1651
|
/**
|
|
1803
1652
|
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
1804
1653
|
*
|
|
@@ -1812,13 +1661,13 @@ export interface Settings {
|
|
|
1812
1661
|
*/
|
|
1813
1662
|
keywords?: Keyword[];
|
|
1814
1663
|
}
|
|
1815
|
-
|
|
1664
|
+
interface PageUrl {
|
|
1816
1665
|
/** The base URL. For premium sites, this is the domain. For free sites, this is the site URL. For example, `mysite.wixsite.com/mysite`. */
|
|
1817
1666
|
base?: string;
|
|
1818
1667
|
/** The relative path for the page within the site. For example, `/product-page/a-product`. */
|
|
1819
1668
|
path?: string;
|
|
1820
1669
|
}
|
|
1821
|
-
|
|
1670
|
+
interface Media extends MediaMediaOneOf {
|
|
1822
1671
|
/** Wix Media details. */
|
|
1823
1672
|
wixMedia?: WixMedia;
|
|
1824
1673
|
/** Embed media details. */
|
|
@@ -1835,19 +1684,19 @@ export interface Media extends MediaMediaOneOf {
|
|
|
1835
1684
|
altText?: string | null;
|
|
1836
1685
|
}
|
|
1837
1686
|
/** @oneof */
|
|
1838
|
-
|
|
1687
|
+
interface MediaMediaOneOf {
|
|
1839
1688
|
/** Wix Media details. */
|
|
1840
1689
|
wixMedia?: WixMedia;
|
|
1841
1690
|
/** Embed media details. */
|
|
1842
1691
|
embedMedia?: EmbedMedia;
|
|
1843
1692
|
}
|
|
1844
|
-
|
|
1693
|
+
interface WixMedia {
|
|
1845
1694
|
/** Image details. */
|
|
1846
1695
|
image?: Image;
|
|
1847
1696
|
/** Video details. */
|
|
1848
1697
|
videoV2?: VideoV2;
|
|
1849
1698
|
}
|
|
1850
|
-
|
|
1699
|
+
interface VideoV2 {
|
|
1851
1700
|
/** WixMedia ID. */
|
|
1852
1701
|
id?: string;
|
|
1853
1702
|
/**
|
|
@@ -1862,7 +1711,7 @@ export interface VideoV2 {
|
|
|
1862
1711
|
*/
|
|
1863
1712
|
filename?: string | null;
|
|
1864
1713
|
}
|
|
1865
|
-
|
|
1714
|
+
interface VideoResolution {
|
|
1866
1715
|
/** Video URL. */
|
|
1867
1716
|
url?: string;
|
|
1868
1717
|
/** Video height. */
|
|
@@ -1872,13 +1721,13 @@ export interface VideoResolution {
|
|
|
1872
1721
|
/** Video format for example, mp4, hls. */
|
|
1873
1722
|
format?: string;
|
|
1874
1723
|
}
|
|
1875
|
-
|
|
1724
|
+
interface EmbedMedia {
|
|
1876
1725
|
/** Thumbnail details. */
|
|
1877
1726
|
thumbnail?: EmbedThumbnail;
|
|
1878
1727
|
/** Video details. */
|
|
1879
1728
|
video?: EmbedVideo;
|
|
1880
1729
|
}
|
|
1881
|
-
|
|
1730
|
+
interface EmbedThumbnail {
|
|
1882
1731
|
/**
|
|
1883
1732
|
* Thumbnail url.
|
|
1884
1733
|
* @maxLength 2000
|
|
@@ -1889,7 +1738,7 @@ export interface EmbedThumbnail {
|
|
|
1889
1738
|
/** Thumbnail height. */
|
|
1890
1739
|
height?: number;
|
|
1891
1740
|
}
|
|
1892
|
-
|
|
1741
|
+
interface EmbedVideo {
|
|
1893
1742
|
/**
|
|
1894
1743
|
* Video url.
|
|
1895
1744
|
* @maxLength 2000
|
|
@@ -1900,249 +1749,7 @@ export interface EmbedVideo {
|
|
|
1900
1749
|
/** Video height. */
|
|
1901
1750
|
height?: number;
|
|
1902
1751
|
}
|
|
1903
|
-
|
|
1904
|
-
/**
|
|
1905
|
-
* Post ID.
|
|
1906
|
-
* @format GUID
|
|
1907
|
-
*/
|
|
1908
|
-
id?: string;
|
|
1909
|
-
/** Post status. */
|
|
1910
|
-
status?: Status;
|
|
1911
|
-
/**
|
|
1912
|
-
* Language the post is written in.
|
|
1913
|
-
* @format LANGUAGE_TAG
|
|
1914
|
-
*/
|
|
1915
|
-
language?: string | null;
|
|
1916
|
-
/**
|
|
1917
|
-
* Post slug. For example, 'post-slug'.
|
|
1918
|
-
* @maxLength 100
|
|
1919
|
-
*/
|
|
1920
|
-
slug?: string | null;
|
|
1921
|
-
/** SEO data. */
|
|
1922
|
-
seoData?: SeoSchema;
|
|
1923
|
-
/** Post URL. */
|
|
1924
|
-
url?: PageUrl;
|
|
1925
|
-
}
|
|
1926
|
-
export interface DraftCategoriesUpdated {
|
|
1927
|
-
/**
|
|
1928
|
-
* Draft post ID.
|
|
1929
|
-
* @maxLength 38
|
|
1930
|
-
*/
|
|
1931
|
-
draftPostId?: string;
|
|
1932
|
-
/**
|
|
1933
|
-
* Current categories of the draft.
|
|
1934
|
-
* @maxSize 10
|
|
1935
|
-
* @format GUID
|
|
1936
|
-
*/
|
|
1937
|
-
categories?: string[];
|
|
1938
|
-
/**
|
|
1939
|
-
* Previous categories of the draft.
|
|
1940
|
-
* @maxSize 10
|
|
1941
|
-
* @format GUID
|
|
1942
|
-
*/
|
|
1943
|
-
previousCategories?: string[];
|
|
1944
|
-
}
|
|
1945
|
-
export interface DraftTagsUpdated {
|
|
1946
|
-
/**
|
|
1947
|
-
* Draft post ID.
|
|
1948
|
-
* @maxLength 38
|
|
1949
|
-
*/
|
|
1950
|
-
draftPostId?: string;
|
|
1951
|
-
/**
|
|
1952
|
-
* Current tags of the draft.
|
|
1953
|
-
* @maxSize 30
|
|
1954
|
-
* @format GUID
|
|
1955
|
-
*/
|
|
1956
|
-
tags?: string[];
|
|
1957
|
-
/**
|
|
1958
|
-
* Previous tags of the draft.
|
|
1959
|
-
* @maxSize 30
|
|
1960
|
-
* @format GUID
|
|
1961
|
-
*/
|
|
1962
|
-
previousTags?: string[];
|
|
1963
|
-
}
|
|
1964
|
-
export interface GetDraftPostTotalsRequest {
|
|
1965
|
-
/**
|
|
1966
|
-
* Group results by fields (defaults to grouping by status).
|
|
1967
|
-
* If, for example, grouping by language is passed, language values in response will be filled.
|
|
1968
|
-
* If, for example, grouping by language is not passed, null values will be filled in language field in response.
|
|
1969
|
-
* @maxSize 10
|
|
1970
|
-
*/
|
|
1971
|
-
groupBy?: TotalDraftPostsGroupingField[];
|
|
1972
|
-
/**
|
|
1973
|
-
* Optional language filter by provided language code. Useful in multilingual context.
|
|
1974
|
-
* @format LANGUAGE_TAG
|
|
1975
|
-
*/
|
|
1976
|
-
language?: string | null;
|
|
1977
|
-
}
|
|
1978
|
-
export declare enum TotalDraftPostsGroupingField {
|
|
1979
|
-
/** Groups results by status. */
|
|
1980
|
-
STATUS = "STATUS",
|
|
1981
|
-
/** Groups results by language. */
|
|
1982
|
-
LANGUAGE = "LANGUAGE"
|
|
1983
|
-
}
|
|
1984
|
-
export interface GetDraftPostTotalsResponse {
|
|
1985
|
-
/** Draft post totals. */
|
|
1986
|
-
totalDraftPosts?: TotalDraftPosts[];
|
|
1987
|
-
}
|
|
1988
|
-
export interface TotalDraftPosts {
|
|
1989
|
-
/** Draft post totals in that group. */
|
|
1990
|
-
total?: number;
|
|
1991
|
-
/** Draft post status (only has value when grouping by status, otherwise null). */
|
|
1992
|
-
status?: Status;
|
|
1993
|
-
/**
|
|
1994
|
-
* Draft post language code (only has value when grouping by language, otherwise null).
|
|
1995
|
-
* @format LANGUAGE_TAG
|
|
1996
|
-
*/
|
|
1997
|
-
language?: string | null;
|
|
1998
|
-
}
|
|
1999
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
2000
|
-
createdEvent?: EntityCreatedEvent;
|
|
2001
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2002
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2003
|
-
actionEvent?: ActionEvent;
|
|
2004
|
-
/**
|
|
2005
|
-
* Unique event ID.
|
|
2006
|
-
* Allows clients to ignore duplicate webhooks.
|
|
2007
|
-
*/
|
|
2008
|
-
id?: string;
|
|
2009
|
-
/**
|
|
2010
|
-
* Assumes actions are also always typed to an entity_type
|
|
2011
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
2012
|
-
*/
|
|
2013
|
-
entityFqdn?: string;
|
|
2014
|
-
/**
|
|
2015
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
2016
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
2017
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
2018
|
-
*/
|
|
2019
|
-
slug?: string;
|
|
2020
|
-
/** ID of the entity associated with the event. */
|
|
2021
|
-
entityId?: string;
|
|
2022
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
2023
|
-
eventTime?: Date | null;
|
|
2024
|
-
/**
|
|
2025
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
2026
|
-
* (for example, GDPR).
|
|
2027
|
-
*/
|
|
2028
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
2029
|
-
/** If present, indicates the action that triggered the event. */
|
|
2030
|
-
originatedFrom?: string | null;
|
|
2031
|
-
/**
|
|
2032
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
2033
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
2034
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2035
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2036
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2037
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2038
|
-
*/
|
|
2039
|
-
entityEventSequence?: string | null;
|
|
2040
|
-
}
|
|
2041
|
-
/** @oneof */
|
|
2042
|
-
export interface DomainEventBodyOneOf {
|
|
2043
|
-
createdEvent?: EntityCreatedEvent;
|
|
2044
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2045
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2046
|
-
actionEvent?: ActionEvent;
|
|
2047
|
-
}
|
|
2048
|
-
export interface EntityCreatedEvent {
|
|
2049
|
-
entityAsJson?: string;
|
|
2050
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
2051
|
-
restoreInfo?: RestoreInfo;
|
|
2052
|
-
}
|
|
2053
|
-
export interface RestoreInfo {
|
|
2054
|
-
deletedDate?: Date | null;
|
|
2055
|
-
}
|
|
2056
|
-
export interface EntityUpdatedEvent {
|
|
2057
|
-
/**
|
|
2058
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2059
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2060
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2061
|
-
*/
|
|
2062
|
-
currentEntityAsJson?: string;
|
|
2063
|
-
}
|
|
2064
|
-
export interface EntityDeletedEvent {
|
|
2065
|
-
/** Entity that was deleted */
|
|
2066
|
-
deletedEntityAsJson?: string | null;
|
|
2067
|
-
}
|
|
2068
|
-
export interface ActionEvent {
|
|
2069
|
-
bodyAsJson?: string;
|
|
2070
|
-
}
|
|
2071
|
-
export interface MessageEnvelope {
|
|
2072
|
-
/**
|
|
2073
|
-
* App instance ID.
|
|
2074
|
-
* @format GUID
|
|
2075
|
-
*/
|
|
2076
|
-
instanceId?: string | null;
|
|
2077
|
-
/**
|
|
2078
|
-
* Event type.
|
|
2079
|
-
* @maxLength 150
|
|
2080
|
-
*/
|
|
2081
|
-
eventType?: string;
|
|
2082
|
-
/** The identification type and identity data. */
|
|
2083
|
-
identity?: IdentificationData;
|
|
2084
|
-
/** Stringify payload. */
|
|
2085
|
-
data?: string;
|
|
2086
|
-
}
|
|
2087
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2088
|
-
/**
|
|
2089
|
-
* ID of a site visitor that has not logged in to the site.
|
|
2090
|
-
* @format GUID
|
|
2091
|
-
*/
|
|
2092
|
-
anonymousVisitorId?: string;
|
|
2093
|
-
/**
|
|
2094
|
-
* ID of a site visitor that has logged in to the site.
|
|
2095
|
-
* @format GUID
|
|
2096
|
-
*/
|
|
2097
|
-
memberId?: string;
|
|
2098
|
-
/**
|
|
2099
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2100
|
-
* @format GUID
|
|
2101
|
-
*/
|
|
2102
|
-
wixUserId?: string;
|
|
2103
|
-
/**
|
|
2104
|
-
* ID of an app.
|
|
2105
|
-
* @format GUID
|
|
2106
|
-
*/
|
|
2107
|
-
appId?: string;
|
|
2108
|
-
/** @readonly */
|
|
2109
|
-
identityType?: WebhookIdentityType;
|
|
2110
|
-
}
|
|
2111
|
-
/** @oneof */
|
|
2112
|
-
export interface IdentificationDataIdOneOf {
|
|
2113
|
-
/**
|
|
2114
|
-
* ID of a site visitor that has not logged in to the site.
|
|
2115
|
-
* @format GUID
|
|
2116
|
-
*/
|
|
2117
|
-
anonymousVisitorId?: string;
|
|
2118
|
-
/**
|
|
2119
|
-
* ID of a site visitor that has logged in to the site.
|
|
2120
|
-
* @format GUID
|
|
2121
|
-
*/
|
|
2122
|
-
memberId?: string;
|
|
2123
|
-
/**
|
|
2124
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2125
|
-
* @format GUID
|
|
2126
|
-
*/
|
|
2127
|
-
wixUserId?: string;
|
|
2128
|
-
/**
|
|
2129
|
-
* ID of an app.
|
|
2130
|
-
* @format GUID
|
|
2131
|
-
*/
|
|
2132
|
-
appId?: string;
|
|
2133
|
-
}
|
|
2134
|
-
export declare enum WebhookIdentityType {
|
|
2135
|
-
UNKNOWN = "UNKNOWN",
|
|
2136
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2137
|
-
MEMBER = "MEMBER",
|
|
2138
|
-
WIX_USER = "WIX_USER",
|
|
2139
|
-
APP = "APP"
|
|
2140
|
-
}
|
|
2141
|
-
export interface InitialDraftPostsCopied {
|
|
2142
|
-
/** Number of draft posts copied. */
|
|
2143
|
-
count?: number;
|
|
2144
|
-
}
|
|
2145
|
-
export interface CreateDraftPostRequest {
|
|
1752
|
+
interface CreateDraftPostRequest {
|
|
2146
1753
|
/** Draft post to create. */
|
|
2147
1754
|
draftPost: DraftPost;
|
|
2148
1755
|
/**
|
|
@@ -2159,20 +1766,7 @@ export interface CreateDraftPostRequest {
|
|
|
2159
1766
|
*/
|
|
2160
1767
|
fieldsets?: Field[];
|
|
2161
1768
|
}
|
|
2162
|
-
|
|
2163
|
-
UNKNOWN = "UNKNOWN",
|
|
2164
|
-
/** Manually saved. */
|
|
2165
|
-
MANUAL = "MANUAL",
|
|
2166
|
-
/** Triggered by autosave. */
|
|
2167
|
-
AUTO_SAVE = "AUTO_SAVE",
|
|
2168
|
-
/** Copied from template during provisioning flow. */
|
|
2169
|
-
PROVISIONING = "PROVISIONING",
|
|
2170
|
-
/** Imported from another blog. */
|
|
2171
|
-
IMPORT = "IMPORT",
|
|
2172
|
-
/** Triggered by autosave when post created by AI tool. */
|
|
2173
|
-
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
|
2174
|
-
}
|
|
2175
|
-
export declare enum Field {
|
|
1769
|
+
declare enum Field {
|
|
2176
1770
|
/** Unknown field. */
|
|
2177
1771
|
UNKNOWN = "UNKNOWN",
|
|
2178
1772
|
/** Includes draft post preview URL. */
|
|
@@ -2184,11 +1778,11 @@ export declare enum Field {
|
|
|
2184
1778
|
/** If the user has not set excerpt, returns the one autogenerated from content. */
|
|
2185
1779
|
GENERATED_EXCERPT = "GENERATED_EXCERPT"
|
|
2186
1780
|
}
|
|
2187
|
-
|
|
1781
|
+
interface CreateDraftPostResponse {
|
|
2188
1782
|
/** Created draft post info. */
|
|
2189
1783
|
draftPost?: DraftPost;
|
|
2190
1784
|
}
|
|
2191
|
-
|
|
1785
|
+
interface BulkCreateDraftPostsRequest {
|
|
2192
1786
|
/**
|
|
2193
1787
|
* Draft posts to create.
|
|
2194
1788
|
* @minSize 1
|
|
@@ -2207,19 +1801,19 @@ export interface BulkCreateDraftPostsRequest {
|
|
|
2207
1801
|
*/
|
|
2208
1802
|
fieldsets?: Field[];
|
|
2209
1803
|
}
|
|
2210
|
-
|
|
1804
|
+
interface BulkCreateDraftPostsResponse {
|
|
2211
1805
|
/** Draft posts created by bulk action. */
|
|
2212
1806
|
results?: BulkDraftPostResult[];
|
|
2213
1807
|
/** Bulk action metadata. */
|
|
2214
1808
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2215
1809
|
}
|
|
2216
|
-
|
|
1810
|
+
interface BulkDraftPostResult {
|
|
2217
1811
|
/** Bulk actions metadata for draft post. */
|
|
2218
1812
|
itemMetadata?: ItemMetadata;
|
|
2219
1813
|
/** Optional full draft post. */
|
|
2220
1814
|
item?: DraftPost;
|
|
2221
1815
|
}
|
|
2222
|
-
|
|
1816
|
+
interface ItemMetadata {
|
|
2223
1817
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2224
1818
|
id?: string | null;
|
|
2225
1819
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
@@ -2229,7 +1823,7 @@ export interface ItemMetadata {
|
|
|
2229
1823
|
/** Details about the error in case of failure. */
|
|
2230
1824
|
error?: ApplicationError;
|
|
2231
1825
|
}
|
|
2232
|
-
|
|
1826
|
+
interface ApplicationError {
|
|
2233
1827
|
/** Error code. */
|
|
2234
1828
|
code?: string;
|
|
2235
1829
|
/** Description of the error. */
|
|
@@ -2237,7 +1831,7 @@ export interface ApplicationError {
|
|
|
2237
1831
|
/** Data related to the error. */
|
|
2238
1832
|
data?: Record<string, any> | null;
|
|
2239
1833
|
}
|
|
2240
|
-
|
|
1834
|
+
interface BulkActionMetadata {
|
|
2241
1835
|
/** Number of items that were successfully processed. */
|
|
2242
1836
|
totalSuccesses?: number;
|
|
2243
1837
|
/** Number of items that couldn't be processed. */
|
|
@@ -2245,7 +1839,7 @@ export interface BulkActionMetadata {
|
|
|
2245
1839
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
2246
1840
|
undetailedFailures?: number;
|
|
2247
1841
|
}
|
|
2248
|
-
|
|
1842
|
+
interface BulkUpdateDraftPostsRequest {
|
|
2249
1843
|
/**
|
|
2250
1844
|
* Draft posts to update.
|
|
2251
1845
|
* @minSize 1
|
|
@@ -2270,13 +1864,13 @@ export interface BulkUpdateDraftPostsRequest {
|
|
|
2270
1864
|
*/
|
|
2271
1865
|
fieldsets?: Field[];
|
|
2272
1866
|
}
|
|
2273
|
-
|
|
1867
|
+
interface MaskedDraftPosts {
|
|
2274
1868
|
/** Draft post */
|
|
2275
1869
|
draftPost?: DraftPost;
|
|
2276
1870
|
/** Field mask of fields to update. */
|
|
2277
1871
|
fieldMask?: string[];
|
|
2278
1872
|
}
|
|
2279
|
-
|
|
1873
|
+
declare enum Action {
|
|
2280
1874
|
/** Update the draft post. */
|
|
2281
1875
|
UPDATE = "UPDATE",
|
|
2282
1876
|
/** Update and publish a draft post. */
|
|
@@ -2292,15 +1886,13 @@ export declare enum Action {
|
|
|
2292
1886
|
/** Update a post that's already been published. This creates and updates a draft version of the post. The original post is still published. */
|
|
2293
1887
|
UPDATE_PUBLICATION = "UPDATE_PUBLICATION"
|
|
2294
1888
|
}
|
|
2295
|
-
|
|
1889
|
+
interface BulkUpdateDraftPostsResponse {
|
|
2296
1890
|
/** Draft posts updated by bulk action. */
|
|
2297
1891
|
results?: BulkDraftPostResult[];
|
|
2298
1892
|
/** Bulk action metadata. */
|
|
2299
1893
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2300
1894
|
}
|
|
2301
|
-
|
|
2302
|
-
}
|
|
2303
|
-
export interface ListDeletedDraftPostsRequest {
|
|
1895
|
+
interface ListDeletedDraftPostsRequest {
|
|
2304
1896
|
/**
|
|
2305
1897
|
* Language filter.
|
|
2306
1898
|
*
|
|
@@ -2331,13 +1923,13 @@ export interface ListDeletedDraftPostsRequest {
|
|
|
2331
1923
|
*/
|
|
2332
1924
|
draftPostIds?: string[];
|
|
2333
1925
|
}
|
|
2334
|
-
|
|
1926
|
+
declare enum GetDraftPostsSort {
|
|
2335
1927
|
/** Sort by `editedDate` in descending order. */
|
|
2336
1928
|
EDITING_DATE_DESC = "EDITING_DATE_DESC",
|
|
2337
1929
|
/** Sort by `editedDate` in ascending order. */
|
|
2338
1930
|
EDITING_DATE_ASC = "EDITING_DATE_ASC"
|
|
2339
1931
|
}
|
|
2340
|
-
|
|
1932
|
+
interface BlogPaging {
|
|
2341
1933
|
/**
|
|
2342
1934
|
* Number of items to skip in the current sort order.
|
|
2343
1935
|
*
|
|
@@ -2360,7 +1952,7 @@ export interface BlogPaging {
|
|
|
2360
1952
|
*/
|
|
2361
1953
|
cursor?: string | null;
|
|
2362
1954
|
}
|
|
2363
|
-
|
|
1955
|
+
interface ListDeletedDraftPostsResponse {
|
|
2364
1956
|
/** List of draft posts. */
|
|
2365
1957
|
draftPosts?: DraftPost[];
|
|
2366
1958
|
/**
|
|
@@ -2379,7 +1971,7 @@ export interface ListDeletedDraftPostsResponse {
|
|
|
2379
1971
|
/** Details on the paged set of results returned. */
|
|
2380
1972
|
pagingMetadata?: PagingMetadataV2;
|
|
2381
1973
|
}
|
|
2382
|
-
|
|
1974
|
+
interface MetaData {
|
|
2383
1975
|
/** Number of items returned in this response. */
|
|
2384
1976
|
count?: number;
|
|
2385
1977
|
/** Requested offset. */
|
|
@@ -2392,7 +1984,7 @@ export interface MetaData {
|
|
|
2392
1984
|
*/
|
|
2393
1985
|
cursor?: string | null;
|
|
2394
1986
|
}
|
|
2395
|
-
|
|
1987
|
+
interface PagingMetadataV2 {
|
|
2396
1988
|
/** Number of items returned in the response. */
|
|
2397
1989
|
count?: number | null;
|
|
2398
1990
|
/** Offset that was requested. */
|
|
@@ -2404,7 +1996,7 @@ export interface PagingMetadataV2 {
|
|
|
2404
1996
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
2405
1997
|
cursors?: Cursors;
|
|
2406
1998
|
}
|
|
2407
|
-
|
|
1999
|
+
interface Cursors {
|
|
2408
2000
|
/**
|
|
2409
2001
|
* Cursor pointing to next page in the list of results.
|
|
2410
2002
|
* @maxLength 2000
|
|
@@ -2416,7 +2008,7 @@ export interface Cursors {
|
|
|
2416
2008
|
*/
|
|
2417
2009
|
prev?: string | null;
|
|
2418
2010
|
}
|
|
2419
|
-
|
|
2011
|
+
interface GetDraftPostRequest {
|
|
2420
2012
|
/**
|
|
2421
2013
|
* Draft post ID.
|
|
2422
2014
|
* @maxLength 38
|
|
@@ -2430,48 +2022,11 @@ export interface GetDraftPostRequest {
|
|
|
2430
2022
|
*/
|
|
2431
2023
|
fieldsets?: Field[];
|
|
2432
2024
|
}
|
|
2433
|
-
|
|
2025
|
+
interface GetDraftPostResponse {
|
|
2434
2026
|
/** Draft post info. */
|
|
2435
2027
|
draftPost?: DraftPost;
|
|
2436
2028
|
}
|
|
2437
|
-
|
|
2438
|
-
/**
|
|
2439
|
-
* DraftJs content to update.
|
|
2440
|
-
* @maxLength 400000
|
|
2441
|
-
*/
|
|
2442
|
-
content?: string;
|
|
2443
|
-
/** Draft Post rich content. */
|
|
2444
|
-
richContent?: RichContent;
|
|
2445
|
-
/**
|
|
2446
|
-
* Draft post ID.
|
|
2447
|
-
* @maxLength 38
|
|
2448
|
-
*/
|
|
2449
|
-
draftPostId?: string;
|
|
2450
|
-
/** Change origin. */
|
|
2451
|
-
changeOrigin?: Origin;
|
|
2452
|
-
/**
|
|
2453
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
2454
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
2455
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2456
|
-
* @maxSize 10
|
|
2457
|
-
*/
|
|
2458
|
-
fieldsets?: Field[];
|
|
2459
|
-
}
|
|
2460
|
-
/** @oneof */
|
|
2461
|
-
export interface UpdateDraftPostContentRequestDraftContentOneOf {
|
|
2462
|
-
/**
|
|
2463
|
-
* DraftJs content to update.
|
|
2464
|
-
* @maxLength 400000
|
|
2465
|
-
*/
|
|
2466
|
-
content?: string;
|
|
2467
|
-
/** Draft Post rich content. */
|
|
2468
|
-
richContent?: RichContent;
|
|
2469
|
-
}
|
|
2470
|
-
export interface UpdateDraftPostContentResponse {
|
|
2471
|
-
/** Updated draft post info. */
|
|
2472
|
-
draftPost?: DraftPost;
|
|
2473
|
-
}
|
|
2474
|
-
export interface UpdateDraftPostRequest {
|
|
2029
|
+
interface UpdateDraftPostRequest {
|
|
2475
2030
|
/** Draft post to update. */
|
|
2476
2031
|
draftPost: DraftPost;
|
|
2477
2032
|
/**
|
|
@@ -2490,11 +2045,11 @@ export interface UpdateDraftPostRequest {
|
|
|
2490
2045
|
*/
|
|
2491
2046
|
fieldsets?: Field[];
|
|
2492
2047
|
}
|
|
2493
|
-
|
|
2048
|
+
interface UpdateDraftPostResponse {
|
|
2494
2049
|
/** Updated draft post info. */
|
|
2495
2050
|
draftPost?: DraftPost;
|
|
2496
2051
|
}
|
|
2497
|
-
|
|
2052
|
+
interface DeleteDraftPostRequest {
|
|
2498
2053
|
/**
|
|
2499
2054
|
* Draft post ID.
|
|
2500
2055
|
* @maxLength 38
|
|
@@ -2507,18 +2062,18 @@ export interface DeleteDraftPostRequest {
|
|
|
2507
2062
|
*/
|
|
2508
2063
|
permanent?: boolean;
|
|
2509
2064
|
}
|
|
2510
|
-
|
|
2065
|
+
interface DeleteDraftPostResponse {
|
|
2511
2066
|
}
|
|
2512
|
-
|
|
2067
|
+
interface RemoveFromTrashBinRequest {
|
|
2513
2068
|
/**
|
|
2514
2069
|
* Draft post ID.
|
|
2515
2070
|
* @maxLength 38
|
|
2516
2071
|
*/
|
|
2517
2072
|
draftPostId: string;
|
|
2518
2073
|
}
|
|
2519
|
-
|
|
2074
|
+
interface RemoveFromTrashBinResponse {
|
|
2520
2075
|
}
|
|
2521
|
-
|
|
2076
|
+
interface BulkDeleteDraftPostsRequest {
|
|
2522
2077
|
/**
|
|
2523
2078
|
* Post IDs.
|
|
2524
2079
|
* @minSize 1
|
|
@@ -2529,13 +2084,13 @@ export interface BulkDeleteDraftPostsRequest {
|
|
|
2529
2084
|
/** Should delete bypassing the trash-bin. */
|
|
2530
2085
|
permanent?: boolean;
|
|
2531
2086
|
}
|
|
2532
|
-
|
|
2087
|
+
interface BulkDeleteDraftPostsResponse {
|
|
2533
2088
|
/** Bulk action results. */
|
|
2534
2089
|
results?: BulkDraftPostResult[];
|
|
2535
2090
|
/** Bulk action metadata. */
|
|
2536
2091
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2537
2092
|
}
|
|
2538
|
-
|
|
2093
|
+
interface ListDraftPostsRequest {
|
|
2539
2094
|
/**
|
|
2540
2095
|
* Draft post status filter.
|
|
2541
2096
|
*
|
|
@@ -2566,35 +2121,35 @@ export interface ListDraftPostsRequest {
|
|
|
2566
2121
|
*/
|
|
2567
2122
|
fieldsets?: Field[];
|
|
2568
2123
|
}
|
|
2569
|
-
|
|
2124
|
+
interface ListDraftPostsResponse {
|
|
2570
2125
|
/** List of draft posts. */
|
|
2571
2126
|
draftPosts?: DraftPost[];
|
|
2572
2127
|
/** Details on the paged set of results returned. */
|
|
2573
2128
|
metaData?: MetaData;
|
|
2574
2129
|
}
|
|
2575
|
-
|
|
2130
|
+
interface GetDeletedDraftPostRequest {
|
|
2576
2131
|
/**
|
|
2577
2132
|
* Draft post ID.
|
|
2578
2133
|
* @maxLength 38
|
|
2579
2134
|
*/
|
|
2580
2135
|
draftPostId: string;
|
|
2581
2136
|
}
|
|
2582
|
-
|
|
2137
|
+
interface GetDeletedDraftPostResponse {
|
|
2583
2138
|
/** Draft post info. */
|
|
2584
2139
|
draftPost?: DraftPost;
|
|
2585
2140
|
}
|
|
2586
|
-
|
|
2141
|
+
interface RestoreFromTrashBinRequest {
|
|
2587
2142
|
/**
|
|
2588
2143
|
* Draft post ID.
|
|
2589
2144
|
* @maxLength 38
|
|
2590
2145
|
*/
|
|
2591
2146
|
draftPostId: string;
|
|
2592
2147
|
}
|
|
2593
|
-
|
|
2148
|
+
interface RestoreFromTrashBinResponse {
|
|
2594
2149
|
/** Restored draft post info. */
|
|
2595
2150
|
draftPost?: DraftPost;
|
|
2596
2151
|
}
|
|
2597
|
-
|
|
2152
|
+
interface QueryDraftPostsRequest {
|
|
2598
2153
|
/**
|
|
2599
2154
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
2600
2155
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
@@ -2605,7 +2160,7 @@ export interface QueryDraftPostsRequest {
|
|
|
2605
2160
|
/** Query options. */
|
|
2606
2161
|
query?: PlatformQuery;
|
|
2607
2162
|
}
|
|
2608
|
-
|
|
2163
|
+
interface Sorting {
|
|
2609
2164
|
/**
|
|
2610
2165
|
* Name of the field to sort by.
|
|
2611
2166
|
* @maxLength 512
|
|
@@ -2614,11 +2169,11 @@ export interface Sorting {
|
|
|
2614
2169
|
/** Sort order. */
|
|
2615
2170
|
order?: SortOrder;
|
|
2616
2171
|
}
|
|
2617
|
-
|
|
2172
|
+
declare enum SortOrder {
|
|
2618
2173
|
ASC = "ASC",
|
|
2619
2174
|
DESC = "DESC"
|
|
2620
2175
|
}
|
|
2621
|
-
|
|
2176
|
+
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
2622
2177
|
/** Paging options to limit and skip the number of items. */
|
|
2623
2178
|
paging?: Paging;
|
|
2624
2179
|
/** 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`. */
|
|
@@ -2640,13 +2195,13 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
|
2640
2195
|
sort?: Sorting[];
|
|
2641
2196
|
}
|
|
2642
2197
|
/** @oneof */
|
|
2643
|
-
|
|
2198
|
+
interface PlatformQueryPagingMethodOneOf {
|
|
2644
2199
|
/** Paging options to limit and skip the number of items. */
|
|
2645
2200
|
paging?: Paging;
|
|
2646
2201
|
/** 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`. */
|
|
2647
2202
|
cursorPaging?: CursorPaging;
|
|
2648
2203
|
}
|
|
2649
|
-
|
|
2204
|
+
interface Paging {
|
|
2650
2205
|
/**
|
|
2651
2206
|
* Number of items to load.
|
|
2652
2207
|
* @max 100
|
|
@@ -2655,7 +2210,7 @@ export interface Paging {
|
|
|
2655
2210
|
/** Number of items to skip in the current sort order. */
|
|
2656
2211
|
offset?: number | null;
|
|
2657
2212
|
}
|
|
2658
|
-
|
|
2213
|
+
interface CursorPaging {
|
|
2659
2214
|
/**
|
|
2660
2215
|
* Number of items to load.
|
|
2661
2216
|
* @max 100
|
|
@@ -2671,374 +2226,64 @@ export interface CursorPaging {
|
|
|
2671
2226
|
*/
|
|
2672
2227
|
cursor?: string | null;
|
|
2673
2228
|
}
|
|
2674
|
-
|
|
2229
|
+
interface QueryDraftPostsResponse {
|
|
2675
2230
|
/** List of posts. */
|
|
2676
2231
|
draftPosts?: DraftPost[];
|
|
2677
2232
|
/** Details on the paged set of results returned. */
|
|
2678
2233
|
pagingMetadata?: PagingMetadataV2;
|
|
2679
2234
|
}
|
|
2680
|
-
|
|
2235
|
+
interface PublishDraftPostRequest {
|
|
2681
2236
|
/**
|
|
2682
2237
|
* Draft post ID.
|
|
2683
2238
|
* @maxLength 38
|
|
2684
2239
|
*/
|
|
2685
2240
|
draftPostId: string;
|
|
2686
2241
|
}
|
|
2687
|
-
|
|
2242
|
+
interface PublishDraftPostResponse {
|
|
2688
2243
|
/**
|
|
2689
2244
|
* Published post ID.
|
|
2690
2245
|
* @format GUID
|
|
2691
2246
|
*/
|
|
2692
2247
|
postId?: string;
|
|
2693
2248
|
}
|
|
2694
|
-
|
|
2695
|
-
|
|
2696
|
-
|
|
2697
|
-
|
|
2698
|
-
|
|
2699
|
-
|
|
2700
|
-
|
|
2701
|
-
|
|
2702
|
-
|
|
2703
|
-
|
|
2704
|
-
|
|
2705
|
-
|
|
2706
|
-
|
|
2707
|
-
|
|
2708
|
-
|
|
2709
|
-
|
|
2710
|
-
|
|
2711
|
-
|
|
2712
|
-
|
|
2713
|
-
|
|
2714
|
-
}
|
|
2715
|
-
|
|
2716
|
-
|
|
2717
|
-
|
|
2718
|
-
|
|
2719
|
-
|
|
2720
|
-
}
|
|
2721
|
-
|
|
2722
|
-
|
|
2723
|
-
|
|
2724
|
-
|
|
2725
|
-
|
|
2726
|
-
|
|
2727
|
-
|
|
2728
|
-
|
|
2729
|
-
|
|
2730
|
-
|
|
2731
|
-
|
|
2732
|
-
|
|
2733
|
-
|
|
2734
|
-
|
|
2735
|
-
* @readonly
|
|
2736
|
-
*/
|
|
2737
|
-
postCount?: number;
|
|
2738
|
-
/**
|
|
2739
|
-
* The `url` of the page that lists every post with the specified category.
|
|
2740
|
-
* @readonly
|
|
2741
|
-
*/
|
|
2742
|
-
url?: PageUrl;
|
|
2743
|
-
/**
|
|
2744
|
-
* Category description.
|
|
2745
|
-
* @maxLength 500
|
|
2746
|
-
*/
|
|
2747
|
-
description?: string | null;
|
|
2748
|
-
/**
|
|
2749
|
-
* Category title.
|
|
2750
|
-
* @maxLength 200
|
|
2751
|
-
* @deprecated Category title.
|
|
2752
|
-
* @targetRemovalDate 2025-07-16
|
|
2753
|
-
*/
|
|
2754
|
-
title?: string;
|
|
2755
|
-
/**
|
|
2756
|
-
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
|
2757
|
-
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
|
2758
|
-
*
|
|
2759
|
-
* Default: `-1`
|
|
2760
|
-
*/
|
|
2761
|
-
displayPosition?: number | null;
|
|
2762
|
-
/**
|
|
2763
|
-
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
|
2764
|
-
* @format GUID
|
|
2765
|
-
*/
|
|
2766
|
-
translationId?: string | null;
|
|
2767
|
-
/**
|
|
2768
|
-
* Category language.
|
|
2769
|
-
*
|
|
2770
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2771
|
-
* @immutable
|
|
2772
|
-
*/
|
|
2773
|
-
language?: string | null;
|
|
2774
|
-
/**
|
|
2775
|
-
* 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`.
|
|
2776
|
-
* @maxLength 100
|
|
2777
|
-
*/
|
|
2778
|
-
slug?: string;
|
|
2779
|
-
/** SEO data. */
|
|
2780
|
-
seoData?: SeoSchema;
|
|
2781
|
-
/** Category cover image. */
|
|
2782
|
-
coverImage?: Image;
|
|
2783
|
-
/**
|
|
2784
|
-
* Date and time the Category was last updated.
|
|
2785
|
-
* @readonly
|
|
2786
|
-
*/
|
|
2787
|
-
updatedDate?: Date | null;
|
|
2788
|
-
}
|
|
2789
|
-
export interface CategoryTranslation {
|
|
2790
|
-
/**
|
|
2791
|
-
* Category ID.
|
|
2792
|
-
* @format GUID
|
|
2793
|
-
*/
|
|
2794
|
-
id?: string;
|
|
2795
|
-
/**
|
|
2796
|
-
* Label displayed in the categories menu on the site.
|
|
2797
|
-
* @maxLength 100
|
|
2798
|
-
*/
|
|
2799
|
-
label?: string | null;
|
|
2800
|
-
/**
|
|
2801
|
-
* Language of the category.
|
|
2802
|
-
* @format LANGUAGE_TAG
|
|
2803
|
-
*/
|
|
2804
|
-
language?: string | null;
|
|
2805
|
-
/** URL of this category page. */
|
|
2806
|
-
url?: PageUrl;
|
|
2807
|
-
}
|
|
2808
|
-
export interface TranslateDraftRequest {
|
|
2809
|
-
/**
|
|
2810
|
-
* Source post or draft ID
|
|
2811
|
-
* @format GUID
|
|
2812
|
-
*/
|
|
2813
|
-
postId?: string;
|
|
2814
|
-
/**
|
|
2815
|
-
* Translation language
|
|
2816
|
-
* @format LANGUAGE_TAG
|
|
2817
|
-
*/
|
|
2818
|
-
language?: string;
|
|
2819
|
-
/**
|
|
2820
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
2821
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
2822
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2823
|
-
* @maxSize 10
|
|
2824
|
-
*/
|
|
2825
|
-
fieldsets?: Field[];
|
|
2826
|
-
}
|
|
2827
|
-
export interface TranslateDraftResponse {
|
|
2828
|
-
/** Draft post. */
|
|
2829
|
-
draftPost?: DraftPost;
|
|
2830
|
-
}
|
|
2831
|
-
export interface IsDraftPostAutoTranslatableRequest {
|
|
2832
|
-
/**
|
|
2833
|
-
* Source post or draft ID.
|
|
2834
|
-
* @format GUID
|
|
2835
|
-
*/
|
|
2836
|
-
draftPostId?: string;
|
|
2837
|
-
}
|
|
2838
|
-
export interface IsDraftPostAutoTranslatableResponse {
|
|
2839
|
-
/**
|
|
2840
|
-
* Source draft post ID.
|
|
2841
|
-
* @format GUID
|
|
2842
|
-
*/
|
|
2843
|
-
draftPostId?: string;
|
|
2844
|
-
/** Indicates if enough machine translation credits are available for the draft post translation. */
|
|
2845
|
-
translatable?: boolean;
|
|
2846
|
-
/** Draft post title word count. */
|
|
2847
|
-
titleWordCount?: number;
|
|
2848
|
-
/** Draft post content word count. */
|
|
2849
|
-
contentWordCount?: number;
|
|
2850
|
-
/** Word credits available for auto translation. */
|
|
2851
|
-
availableAutoTranslateWords?: number;
|
|
2852
|
-
/** Word credits available after auto translation would be done. */
|
|
2853
|
-
availableAutoTranslateWordsAfter?: number;
|
|
2854
|
-
/** Content text character count. */
|
|
2855
|
-
contentTextCharacterCount?: number;
|
|
2856
|
-
}
|
|
2857
|
-
export interface UpdateDraftPostLanguageRequest {
|
|
2858
|
-
/**
|
|
2859
|
-
* Source draft post ID
|
|
2860
|
-
* @format GUID
|
|
2861
|
-
*/
|
|
2862
|
-
postId?: string;
|
|
2863
|
-
/**
|
|
2864
|
-
* New language to replace to
|
|
2865
|
-
* @minLength 2
|
|
2866
|
-
* @format LANGUAGE_TAG
|
|
2867
|
-
*/
|
|
2868
|
-
language?: string;
|
|
2869
|
-
/**
|
|
2870
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
2871
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
2872
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2873
|
-
* @maxSize 10
|
|
2874
|
-
*/
|
|
2875
|
-
fieldsets?: Field[];
|
|
2876
|
-
}
|
|
2877
|
-
export interface UpdateDraftPostLanguageResponse {
|
|
2878
|
-
/** Draft post */
|
|
2879
|
-
draftPost?: DraftPost;
|
|
2880
|
-
}
|
|
2881
|
-
export interface BulkUpdateDraftPostLanguageRequest {
|
|
2882
|
-
/**
|
|
2883
|
-
* Source post or draft IDs
|
|
2884
|
-
* @maxSize 50
|
|
2885
|
-
* @format GUID
|
|
2886
|
-
*/
|
|
2887
|
-
ids?: string[];
|
|
2888
|
-
/**
|
|
2889
|
-
* New language to replace to
|
|
2890
|
-
* @format LANGUAGE_TAG
|
|
2891
|
-
*/
|
|
2892
|
-
language?: string;
|
|
2893
|
-
/** Should full draft post be returned */
|
|
2894
|
-
returnFullEntity?: boolean;
|
|
2895
|
-
/**
|
|
2896
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
2897
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
2898
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2899
|
-
* @maxSize 10
|
|
2900
|
-
*/
|
|
2901
|
-
fieldsets?: Field[];
|
|
2902
|
-
}
|
|
2903
|
-
export interface BulkUpdateDraftPostLanguageResponse {
|
|
2904
|
-
/** Bulk action results */
|
|
2905
|
-
results?: BulkDraftPostResult[];
|
|
2906
|
-
/** Bulk action metadata */
|
|
2907
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2908
|
-
}
|
|
2909
|
-
export interface GetPostAmountsByLanguageRequest {
|
|
2910
|
-
/**
|
|
2911
|
-
* Post status to filter by
|
|
2912
|
-
* @maxLength 100
|
|
2913
|
-
*/
|
|
2914
|
-
status?: string;
|
|
2915
|
-
}
|
|
2916
|
-
export interface GetPostAmountsByLanguageResponse {
|
|
2917
|
-
/** Post amounts by language */
|
|
2918
|
-
postAmountsByLanguage?: PostAmountByLanguage[];
|
|
2919
|
-
}
|
|
2920
|
-
export interface PostAmountByLanguage {
|
|
2921
|
-
/**
|
|
2922
|
-
* Post language code
|
|
2923
|
-
* @format LANGUAGE_TAG
|
|
2924
|
-
*/
|
|
2925
|
-
languageCode?: string;
|
|
2926
|
-
/**
|
|
2927
|
-
* Language flag
|
|
2928
|
-
* @format LANGUAGE_TAG
|
|
2929
|
-
*/
|
|
2930
|
-
flag?: string;
|
|
2931
|
-
/** Post amount in that language */
|
|
2932
|
-
postAmount?: number;
|
|
2933
|
-
}
|
|
2934
|
-
export interface BulkRevertToUnpublishedRequest {
|
|
2935
|
-
/**
|
|
2936
|
-
* Source post IDs.
|
|
2937
|
-
* @minSize 1
|
|
2938
|
-
* @maxSize 100
|
|
2939
|
-
* @format GUID
|
|
2940
|
-
*/
|
|
2941
|
-
postIds?: string[];
|
|
2942
|
-
/** Should full draft post be returned. */
|
|
2943
|
-
returnFullEntity?: boolean;
|
|
2944
|
-
}
|
|
2945
|
-
export interface BulkRevertToUnpublishedResponse {
|
|
2946
|
-
/** Bulk action results. */
|
|
2947
|
-
results?: BulkDraftPostResult[];
|
|
2948
|
-
/** Bulk action metadata. */
|
|
2949
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2950
|
-
}
|
|
2951
|
-
export interface BulkRejectDraftPostRequest {
|
|
2952
|
-
/**
|
|
2953
|
-
* Source post IDs.
|
|
2954
|
-
* @minSize 1
|
|
2955
|
-
* @maxSize 100
|
|
2956
|
-
* @format GUID
|
|
2957
|
-
*/
|
|
2958
|
-
postIds?: string[];
|
|
2959
|
-
/** Should full draft post be returned. */
|
|
2960
|
-
returnFullEntity?: boolean;
|
|
2961
|
-
}
|
|
2962
|
-
export interface BulkRejectDraftPostResponse {
|
|
2963
|
-
/** Bulk action results. */
|
|
2964
|
-
results?: BulkDraftPostResult[];
|
|
2965
|
-
/** Bulk action metadata. */
|
|
2966
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2967
|
-
}
|
|
2968
|
-
export interface RevertToUnpublishedRequest {
|
|
2969
|
-
/**
|
|
2970
|
-
* Source post ID.
|
|
2971
|
-
* @format GUID
|
|
2972
|
-
*/
|
|
2973
|
-
postId?: string;
|
|
2974
|
-
/**
|
|
2975
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
2976
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
2977
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2978
|
-
* @maxSize 10
|
|
2979
|
-
*/
|
|
2980
|
-
fieldsets?: Field[];
|
|
2981
|
-
}
|
|
2982
|
-
export interface RevertToUnpublishedResponse {
|
|
2983
|
-
/** Updated post draft. */
|
|
2984
|
-
draftPost?: DraftPost;
|
|
2985
|
-
}
|
|
2986
|
-
export interface RejectDraftPostRequest {
|
|
2987
|
-
/**
|
|
2988
|
-
* Source post ID.
|
|
2989
|
-
* @format GUID
|
|
2990
|
-
*/
|
|
2991
|
-
postId?: string;
|
|
2992
|
-
/**
|
|
2993
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
2994
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
2995
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2996
|
-
* @maxSize 10
|
|
2997
|
-
*/
|
|
2998
|
-
fieldsets?: Field[];
|
|
2999
|
-
}
|
|
3000
|
-
export interface RejectDraftPostResponse {
|
|
3001
|
-
/** Draft post. */
|
|
3002
|
-
draftPost?: DraftPost;
|
|
3003
|
-
}
|
|
3004
|
-
export interface ApproveDraftPostRequest {
|
|
3005
|
-
/**
|
|
3006
|
-
* Source post ID.
|
|
3007
|
-
* @format GUID
|
|
3008
|
-
*/
|
|
3009
|
-
postId?: string;
|
|
3010
|
-
/**
|
|
3011
|
-
* Scheduled publish date if should be not immediately published.
|
|
3012
|
-
* @maxLength 24
|
|
3013
|
-
*/
|
|
3014
|
-
scheduledPublishDate?: string | null;
|
|
3015
|
-
/**
|
|
3016
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
3017
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
3018
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
3019
|
-
* @maxSize 10
|
|
3020
|
-
*/
|
|
3021
|
-
fieldsets?: Field[];
|
|
3022
|
-
}
|
|
3023
|
-
export interface ApproveDraftPostResponse {
|
|
3024
|
-
/** Updated post draft. */
|
|
3025
|
-
draftPost?: DraftPost;
|
|
3026
|
-
}
|
|
3027
|
-
export interface MarkPostAsInModerationRequest {
|
|
3028
|
-
/**
|
|
3029
|
-
* Source post ID.
|
|
3030
|
-
* @maxLength 38
|
|
3031
|
-
*/
|
|
3032
|
-
postId?: string;
|
|
3033
|
-
/**
|
|
3034
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
3035
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
3036
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
3037
|
-
* @maxSize 10
|
|
3038
|
-
*/
|
|
3039
|
-
fieldsets?: Field[];
|
|
3040
|
-
}
|
|
3041
|
-
export interface MarkPostAsInModerationResponse {
|
|
3042
|
-
/** Updated post draft. */
|
|
3043
|
-
draftPost?: DraftPost;
|
|
3044
|
-
}
|
|
2249
|
+
|
|
2250
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
2251
|
+
getUrl: (context: any) => string;
|
|
2252
|
+
httpMethod: K;
|
|
2253
|
+
path: string;
|
|
2254
|
+
pathParams: M;
|
|
2255
|
+
__requestType: T;
|
|
2256
|
+
__originalRequestType: S;
|
|
2257
|
+
__responseType: Q;
|
|
2258
|
+
__originalResponseType: R;
|
|
2259
|
+
};
|
|
2260
|
+
declare function createDraftPost(): __PublicMethodMetaInfo<'POST', {}, CreateDraftPostRequest$1, CreateDraftPostRequest, CreateDraftPostResponse$1, CreateDraftPostResponse>;
|
|
2261
|
+
declare function bulkCreateDraftPosts(): __PublicMethodMetaInfo<'POST', {}, BulkCreateDraftPostsRequest$1, BulkCreateDraftPostsRequest, BulkCreateDraftPostsResponse$1, BulkCreateDraftPostsResponse>;
|
|
2262
|
+
declare function bulkUpdateDraftPosts(): __PublicMethodMetaInfo<'PATCH', {}, BulkUpdateDraftPostsRequest$1, BulkUpdateDraftPostsRequest, BulkUpdateDraftPostsResponse$1, BulkUpdateDraftPostsResponse>;
|
|
2263
|
+
declare function listDeletedDraftPosts(): __PublicMethodMetaInfo<'GET', {}, ListDeletedDraftPostsRequest$1, ListDeletedDraftPostsRequest, ListDeletedDraftPostsResponse$1, ListDeletedDraftPostsResponse>;
|
|
2264
|
+
declare function getDraftPost(): __PublicMethodMetaInfo<'GET', {
|
|
2265
|
+
draftPostId: string;
|
|
2266
|
+
}, GetDraftPostRequest$1, GetDraftPostRequest, GetDraftPostResponse$1, GetDraftPostResponse>;
|
|
2267
|
+
declare function updateDraftPost(): __PublicMethodMetaInfo<'PATCH', {
|
|
2268
|
+
draftPostId: string;
|
|
2269
|
+
}, UpdateDraftPostRequest$1, UpdateDraftPostRequest, UpdateDraftPostResponse$1, UpdateDraftPostResponse>;
|
|
2270
|
+
declare function deleteDraftPost(): __PublicMethodMetaInfo<'DELETE', {
|
|
2271
|
+
draftPostId: string;
|
|
2272
|
+
}, DeleteDraftPostRequest$1, DeleteDraftPostRequest, DeleteDraftPostResponse$1, DeleteDraftPostResponse>;
|
|
2273
|
+
declare function removeFromTrashBin(): __PublicMethodMetaInfo<'DELETE', {
|
|
2274
|
+
draftPostId: string;
|
|
2275
|
+
}, RemoveFromTrashBinRequest$1, RemoveFromTrashBinRequest, RemoveFromTrashBinResponse$1, RemoveFromTrashBinResponse>;
|
|
2276
|
+
declare function bulkDeleteDraftPosts(): __PublicMethodMetaInfo<'DELETE', {}, BulkDeleteDraftPostsRequest$1, BulkDeleteDraftPostsRequest, BulkDeleteDraftPostsResponse$1, BulkDeleteDraftPostsResponse>;
|
|
2277
|
+
declare function listDraftPosts(): __PublicMethodMetaInfo<'GET', {}, ListDraftPostsRequest$1, ListDraftPostsRequest, ListDraftPostsResponse$1, ListDraftPostsResponse>;
|
|
2278
|
+
declare function getDeletedDraftPost(): __PublicMethodMetaInfo<'GET', {
|
|
2279
|
+
draftPostId: string;
|
|
2280
|
+
}, GetDeletedDraftPostRequest$1, GetDeletedDraftPostRequest, GetDeletedDraftPostResponse$1, GetDeletedDraftPostResponse>;
|
|
2281
|
+
declare function restoreFromTrashBin(): __PublicMethodMetaInfo<'POST', {
|
|
2282
|
+
draftPostId: string;
|
|
2283
|
+
}, RestoreFromTrashBinRequest$1, RestoreFromTrashBinRequest, RestoreFromTrashBinResponse$1, RestoreFromTrashBinResponse>;
|
|
2284
|
+
declare function queryDraftPosts(): __PublicMethodMetaInfo<'POST', {}, QueryDraftPostsRequest$1, QueryDraftPostsRequest, QueryDraftPostsResponse$1, QueryDraftPostsResponse>;
|
|
2285
|
+
declare function publishDraftPost(): __PublicMethodMetaInfo<'POST', {
|
|
2286
|
+
draftPostId: string;
|
|
2287
|
+
}, PublishDraftPostRequest$1, PublishDraftPostRequest, PublishDraftPostResponse$1, PublishDraftPostResponse>;
|
|
2288
|
+
|
|
2289
|
+
export { type __PublicMethodMetaInfo, bulkCreateDraftPosts, bulkDeleteDraftPosts, bulkUpdateDraftPosts, createDraftPost, deleteDraftPost, getDeletedDraftPost, getDraftPost, listDeletedDraftPosts, listDraftPosts, publishDraftPost, queryDraftPosts, removeFromTrashBin, restoreFromTrashBin, updateDraftPost };
|