@wix/auto_sdk_blog_draft-posts 1.0.23 → 1.0.25
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-yk8zFFHT.d.mts} +311 -604
- package/build/{internal/es/src/blog-v3-draft-draft-posts.universal.d.ts → blog-v3-draft-draft-posts.universal-yk8zFFHT.d.ts} +311 -604
- package/build/index.d.mts +195 -0
- package/build/index.d.ts +195 -0
- package/build/index.js +3444 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +3364 -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-yk8zFFHT.d.mts} +311 -604
- package/build/{es/src/blog-v3-draft-draft-posts.universal.d.ts → internal/blog-v3-draft-draft-posts.universal-yk8zFFHT.d.ts} +311 -604
- package/build/internal/index.d.mts +195 -0
- package/build/internal/index.d.ts +195 -0
- package/build/internal/index.js +3444 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +3364 -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} +263 -1025
- package/build/internal/{cjs/src/blog-v3-draft-draft-posts.types.d.ts → meta.d.ts} +263 -1025
- 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} +263 -1025
- package/build/{internal/es/src/blog-v3-draft-draft-posts.types.d.ts → meta.d.ts} +263 -1025
- 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 +12 -11
- 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 -477
- 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 -1478
- 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 -474
- 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 -1437
- 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 -477
- 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 -1478
- 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 -474
- 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 -1437
- package/build/internal/es/src/blog-v3-draft-draft-posts.universal.js.map +0 -1
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
|
|
1
|
+
import { ca as CreateDraftPostRequest$1, a as CreateDraftPostResponse$1, cb as BulkCreateDraftPostsRequest$1, b as BulkCreateDraftPostsResponse$1, cg as BulkUpdateDraftPostsRequest$1, d as BulkUpdateDraftPostsResponse$1, cj as ListDeletedDraftPostsRequest$1, e as ListDeletedDraftPostsResponse$1, co as GetDraftPostRequest$1, f as GetDraftPostResponse$1, cs as UpdateDraftPostRequest$1, h as UpdateDraftPostResponse$1, ct as DeleteDraftPostRequest$1, cu as DeleteDraftPostResponse$1, cv as RemoveFromTrashBinRequest$1, cw as RemoveFromTrashBinResponse$1, cx as BulkDeleteDraftPostsRequest$1, k as BulkDeleteDraftPostsResponse$1, cy as ListDraftPostsRequest$1, m as ListDraftPostsResponse$1, cz as GetDeletedDraftPostRequest$1, n as GetDeletedDraftPostResponse$1, cA as RestoreFromTrashBinRequest$1, R as RestoreFromTrashBinResponse$1, cB as QueryDraftPostsRequest$1, cH as QueryDraftPostsResponse$1, cI as PublishDraftPostRequest$1, P as PublishDraftPostResponse$1 } from './blog-v3-draft-draft-posts.universal-yk8zFFHT.mjs';
|
|
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,111 +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
|
-
/** @enumType */
|
|
299
|
-
export type OriginWithLiterals = Origin | 'UNKNOWN' | 'ADMIN' | 'ADD_CATEGORIES' | 'AUTO_SAVE' | 'COPY_TEMPLATE' | 'IMPORT' | 'IMPORT_BULK' | 'IMPORT_HTML' | 'IMPORT_PATCH' | 'LANGUAGE_CHANGE' | 'MANUAL_SAVE' | 'MIGRATION' | 'MODERATION' | 'MOVE_TO_TRASH' | 'PRICING_PLANS_CHANGE' | 'PROVISION' | 'PUBLISH' | 'REASSIGN_OWNER' | 'REBLOG' | 'RESTORE' | 'REVERT_TO_DRAFT' | 'TRANSLATION' | 'UNPUBLISH' | 'UNSCHEDULE' | 'NEW_EDIT_SESSION' | 'SCHEDULING_SERVICE_SCHEDULE' | 'SCHEDULING_SERVICE_UNSCHEDULE' | 'SCHEDULING_SERVICE_PUBLISH' | 'SCHEDULE' | 'REMOVE_FROM_MODERATION' | 'REJECT_FROM_MODERATION' | 'APPROVE_IN_MODERATION' | 'DELETE_TAG' | 'PIN' | 'UNPIN' | 'AI_AUTO_SAVE';
|
|
300
|
-
export interface RichContent {
|
|
161
|
+
interface RichContent {
|
|
301
162
|
/** Node objects representing a rich content document. */
|
|
302
163
|
nodes?: Node[];
|
|
303
164
|
/** Object metadata. */
|
|
@@ -305,7 +166,7 @@ export interface RichContent {
|
|
|
305
166
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
306
167
|
documentStyle?: DocumentStyle;
|
|
307
168
|
}
|
|
308
|
-
|
|
169
|
+
interface Node extends NodeDataOneOf {
|
|
309
170
|
/** Data for a button node. */
|
|
310
171
|
buttonData?: ButtonData;
|
|
311
172
|
/** Data for a code block node. */
|
|
@@ -370,7 +231,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
370
231
|
style?: NodeStyle;
|
|
371
232
|
}
|
|
372
233
|
/** @oneof */
|
|
373
|
-
|
|
234
|
+
interface NodeDataOneOf {
|
|
374
235
|
/** Data for a button node. */
|
|
375
236
|
buttonData?: ButtonData;
|
|
376
237
|
/** Data for a code block node. */
|
|
@@ -426,7 +287,7 @@ export interface NodeDataOneOf {
|
|
|
426
287
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
427
288
|
layoutCellData?: LayoutCellData;
|
|
428
289
|
}
|
|
429
|
-
|
|
290
|
+
declare enum NodeType {
|
|
430
291
|
PARAGRAPH = "PARAGRAPH",
|
|
431
292
|
TEXT = "TEXT",
|
|
432
293
|
HEADING = "HEADING",
|
|
@@ -463,8 +324,8 @@ export declare enum NodeType {
|
|
|
463
324
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
464
325
|
}
|
|
465
326
|
/** @enumType */
|
|
466
|
-
|
|
467
|
-
|
|
327
|
+
type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
|
|
328
|
+
interface NodeStyle {
|
|
468
329
|
/** The top padding value in pixels. */
|
|
469
330
|
paddingTop?: string | null;
|
|
470
331
|
/** The bottom padding value in pixels. */
|
|
@@ -472,7 +333,7 @@ export interface NodeStyle {
|
|
|
472
333
|
/** The background color as a hexadecimal value. */
|
|
473
334
|
backgroundColor?: string | null;
|
|
474
335
|
}
|
|
475
|
-
|
|
336
|
+
interface ButtonData {
|
|
476
337
|
/** Styling for the button's container. */
|
|
477
338
|
containerData?: PluginContainerData;
|
|
478
339
|
/** The button type. */
|
|
@@ -484,7 +345,7 @@ export interface ButtonData {
|
|
|
484
345
|
/** Button link details. */
|
|
485
346
|
link?: Link;
|
|
486
347
|
}
|
|
487
|
-
|
|
348
|
+
interface Border {
|
|
488
349
|
/**
|
|
489
350
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
490
351
|
* @deprecated
|
|
@@ -496,7 +357,7 @@ export interface Border {
|
|
|
496
357
|
*/
|
|
497
358
|
radius?: number | null;
|
|
498
359
|
}
|
|
499
|
-
|
|
360
|
+
interface Colors {
|
|
500
361
|
/**
|
|
501
362
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
502
363
|
* @deprecated
|
|
@@ -513,7 +374,7 @@ export interface Colors {
|
|
|
513
374
|
*/
|
|
514
375
|
background?: string | null;
|
|
515
376
|
}
|
|
516
|
-
|
|
377
|
+
interface PluginContainerData {
|
|
517
378
|
/** The width of the node when it's displayed. */
|
|
518
379
|
width?: PluginContainerDataWidth;
|
|
519
380
|
/** The node's alignment within its container. */
|
|
@@ -525,7 +386,7 @@ export interface PluginContainerData {
|
|
|
525
386
|
/** Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. */
|
|
526
387
|
textWrap?: boolean | null;
|
|
527
388
|
}
|
|
528
|
-
|
|
389
|
+
declare enum WidthType {
|
|
529
390
|
/** Width matches the content width */
|
|
530
391
|
CONTENT = "CONTENT",
|
|
531
392
|
/** Small Width */
|
|
@@ -536,8 +397,8 @@ export declare enum WidthType {
|
|
|
536
397
|
FULL_WIDTH = "FULL_WIDTH"
|
|
537
398
|
}
|
|
538
399
|
/** @enumType */
|
|
539
|
-
|
|
540
|
-
|
|
400
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
401
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
541
402
|
/**
|
|
542
403
|
* One of the following predefined width options:
|
|
543
404
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -550,7 +411,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
550
411
|
custom?: string | null;
|
|
551
412
|
}
|
|
552
413
|
/** @oneof */
|
|
553
|
-
|
|
414
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
554
415
|
/**
|
|
555
416
|
* One of the following predefined width options:
|
|
556
417
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -562,7 +423,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
562
423
|
/** A custom width value in pixels. */
|
|
563
424
|
custom?: string | null;
|
|
564
425
|
}
|
|
565
|
-
|
|
426
|
+
declare enum PluginContainerDataAlignment {
|
|
566
427
|
/** Center Alignment */
|
|
567
428
|
CENTER = "CENTER",
|
|
568
429
|
/** Left Alignment */
|
|
@@ -571,8 +432,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
571
432
|
RIGHT = "RIGHT"
|
|
572
433
|
}
|
|
573
434
|
/** @enumType */
|
|
574
|
-
|
|
575
|
-
|
|
435
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
436
|
+
interface Spoiler {
|
|
576
437
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
577
438
|
enabled?: boolean | null;
|
|
578
439
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -580,19 +441,19 @@ export interface Spoiler {
|
|
|
580
441
|
/** The text for the button used to remove the spoiler cover. */
|
|
581
442
|
buttonText?: string | null;
|
|
582
443
|
}
|
|
583
|
-
|
|
444
|
+
interface Height {
|
|
584
445
|
/** A custom height value in pixels. */
|
|
585
446
|
custom?: string | null;
|
|
586
447
|
}
|
|
587
|
-
|
|
448
|
+
declare enum ButtonDataType {
|
|
588
449
|
/** Regular link button */
|
|
589
450
|
LINK = "LINK",
|
|
590
451
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
591
452
|
ACTION = "ACTION"
|
|
592
453
|
}
|
|
593
454
|
/** @enumType */
|
|
594
|
-
|
|
595
|
-
|
|
455
|
+
type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
456
|
+
interface Styles {
|
|
596
457
|
/**
|
|
597
458
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
598
459
|
* @deprecated
|
|
@@ -645,7 +506,7 @@ export interface Styles {
|
|
|
645
506
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
646
507
|
buttonSize?: string | null;
|
|
647
508
|
}
|
|
648
|
-
|
|
509
|
+
interface Link extends LinkDataOneOf {
|
|
649
510
|
/** The absolute URL for the linked document. */
|
|
650
511
|
url?: string;
|
|
651
512
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -664,13 +525,13 @@ export interface Link extends LinkDataOneOf {
|
|
|
664
525
|
customData?: string | null;
|
|
665
526
|
}
|
|
666
527
|
/** @oneof */
|
|
667
|
-
|
|
528
|
+
interface LinkDataOneOf {
|
|
668
529
|
/** The absolute URL for the linked document. */
|
|
669
530
|
url?: string;
|
|
670
531
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
671
532
|
anchor?: string;
|
|
672
533
|
}
|
|
673
|
-
|
|
534
|
+
declare enum Target {
|
|
674
535
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
675
536
|
SELF = "SELF",
|
|
676
537
|
/** Opens the linked document in a new window or tab */
|
|
@@ -681,8 +542,8 @@ export declare enum Target {
|
|
|
681
542
|
TOP = "TOP"
|
|
682
543
|
}
|
|
683
544
|
/** @enumType */
|
|
684
|
-
|
|
685
|
-
|
|
545
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
546
|
+
interface Rel {
|
|
686
547
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
687
548
|
nofollow?: boolean | null;
|
|
688
549
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -692,17 +553,17 @@ export interface Rel {
|
|
|
692
553
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
693
554
|
noreferrer?: boolean | null;
|
|
694
555
|
}
|
|
695
|
-
|
|
556
|
+
interface CodeBlockData {
|
|
696
557
|
/** Styling for the code block's text. */
|
|
697
558
|
textStyle?: TextStyle;
|
|
698
559
|
}
|
|
699
|
-
|
|
560
|
+
interface TextStyle {
|
|
700
561
|
/** Text alignment. Defaults to `AUTO`. */
|
|
701
562
|
textAlignment?: TextAlignmentWithLiterals;
|
|
702
563
|
/** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
|
|
703
564
|
lineHeight?: string | null;
|
|
704
565
|
}
|
|
705
|
-
|
|
566
|
+
declare enum TextAlignment {
|
|
706
567
|
/** browser default, eqivalent to `initial` */
|
|
707
568
|
AUTO = "AUTO",
|
|
708
569
|
/** Left align */
|
|
@@ -715,8 +576,8 @@ export declare enum TextAlignment {
|
|
|
715
576
|
JUSTIFY = "JUSTIFY"
|
|
716
577
|
}
|
|
717
578
|
/** @enumType */
|
|
718
|
-
|
|
719
|
-
|
|
579
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
580
|
+
interface DividerData {
|
|
720
581
|
/** Styling for the divider's container. */
|
|
721
582
|
containerData?: PluginContainerData;
|
|
722
583
|
/** Divider line style. */
|
|
@@ -726,7 +587,7 @@ export interface DividerData {
|
|
|
726
587
|
/** Divider alignment. */
|
|
727
588
|
alignment?: AlignmentWithLiterals;
|
|
728
589
|
}
|
|
729
|
-
|
|
590
|
+
declare enum LineStyle {
|
|
730
591
|
/** Single Line */
|
|
731
592
|
SINGLE = "SINGLE",
|
|
732
593
|
/** Double Line */
|
|
@@ -737,8 +598,8 @@ export declare enum LineStyle {
|
|
|
737
598
|
DOTTED = "DOTTED"
|
|
738
599
|
}
|
|
739
600
|
/** @enumType */
|
|
740
|
-
|
|
741
|
-
|
|
601
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
602
|
+
declare enum Width {
|
|
742
603
|
/** Large line */
|
|
743
604
|
LARGE = "LARGE",
|
|
744
605
|
/** Medium line */
|
|
@@ -747,8 +608,8 @@ export declare enum Width {
|
|
|
747
608
|
SMALL = "SMALL"
|
|
748
609
|
}
|
|
749
610
|
/** @enumType */
|
|
750
|
-
|
|
751
|
-
|
|
611
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
612
|
+
declare enum Alignment {
|
|
752
613
|
/** Center alignment */
|
|
753
614
|
CENTER = "CENTER",
|
|
754
615
|
/** Left alignment */
|
|
@@ -757,8 +618,8 @@ export declare enum Alignment {
|
|
|
757
618
|
RIGHT = "RIGHT"
|
|
758
619
|
}
|
|
759
620
|
/** @enumType */
|
|
760
|
-
|
|
761
|
-
|
|
621
|
+
type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
622
|
+
interface FileData {
|
|
762
623
|
/** Styling for the file's container. */
|
|
763
624
|
containerData?: PluginContainerData;
|
|
764
625
|
/** The source for the file's data. */
|
|
@@ -781,7 +642,7 @@ export interface FileData {
|
|
|
781
642
|
/** File size in KB. */
|
|
782
643
|
sizeInKb?: string | null;
|
|
783
644
|
}
|
|
784
|
-
|
|
645
|
+
declare enum ViewMode {
|
|
785
646
|
/** No PDF view */
|
|
786
647
|
NONE = "NONE",
|
|
787
648
|
/** Full PDF view */
|
|
@@ -790,8 +651,8 @@ export declare enum ViewMode {
|
|
|
790
651
|
MINI = "MINI"
|
|
791
652
|
}
|
|
792
653
|
/** @enumType */
|
|
793
|
-
|
|
794
|
-
|
|
654
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
655
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
795
656
|
/** The absolute URL for the file's source. */
|
|
796
657
|
url?: string | null;
|
|
797
658
|
/**
|
|
@@ -805,7 +666,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
805
666
|
private?: boolean | null;
|
|
806
667
|
}
|
|
807
668
|
/** @oneof */
|
|
808
|
-
|
|
669
|
+
interface FileSourceDataOneOf {
|
|
809
670
|
/** The absolute URL for the file's source. */
|
|
810
671
|
url?: string | null;
|
|
811
672
|
/**
|
|
@@ -816,7 +677,7 @@ export interface FileSourceDataOneOf {
|
|
|
816
677
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
817
678
|
id?: string | null;
|
|
818
679
|
}
|
|
819
|
-
|
|
680
|
+
interface PDFSettings {
|
|
820
681
|
/**
|
|
821
682
|
* PDF view mode. One of the following:
|
|
822
683
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -829,7 +690,7 @@ export interface PDFSettings {
|
|
|
829
690
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
830
691
|
disablePrint?: boolean | null;
|
|
831
692
|
}
|
|
832
|
-
|
|
693
|
+
interface GalleryData {
|
|
833
694
|
/** Styling for the gallery's container. */
|
|
834
695
|
containerData?: PluginContainerData;
|
|
835
696
|
/** The items in the gallery. */
|
|
@@ -841,7 +702,7 @@ export interface GalleryData {
|
|
|
841
702
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
842
703
|
disableDownload?: boolean | null;
|
|
843
704
|
}
|
|
844
|
-
|
|
705
|
+
interface V1Media {
|
|
845
706
|
/** The source for the media's data. */
|
|
846
707
|
src?: FileSource;
|
|
847
708
|
/** Media width in pixels. */
|
|
@@ -851,19 +712,19 @@ export interface V1Media {
|
|
|
851
712
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
852
713
|
duration?: number | null;
|
|
853
714
|
}
|
|
854
|
-
|
|
715
|
+
interface ItemImage {
|
|
855
716
|
/** Image file details. */
|
|
856
717
|
media?: V1Media;
|
|
857
718
|
/** Link details for images that are links. */
|
|
858
719
|
link?: Link;
|
|
859
720
|
}
|
|
860
|
-
|
|
721
|
+
interface ItemVideo {
|
|
861
722
|
/** Video file details. */
|
|
862
723
|
media?: V1Media;
|
|
863
724
|
/** Video thumbnail file details. */
|
|
864
725
|
thumbnail?: V1Media;
|
|
865
726
|
}
|
|
866
|
-
|
|
727
|
+
interface Item extends ItemDataOneOf {
|
|
867
728
|
/** An image item. */
|
|
868
729
|
image?: ItemImage;
|
|
869
730
|
/** A video item. */
|
|
@@ -874,13 +735,13 @@ export interface Item extends ItemDataOneOf {
|
|
|
874
735
|
altText?: string | null;
|
|
875
736
|
}
|
|
876
737
|
/** @oneof */
|
|
877
|
-
|
|
738
|
+
interface ItemDataOneOf {
|
|
878
739
|
/** An image item. */
|
|
879
740
|
image?: ItemImage;
|
|
880
741
|
/** A video item. */
|
|
881
742
|
video?: ItemVideo;
|
|
882
743
|
}
|
|
883
|
-
|
|
744
|
+
interface GalleryOptions {
|
|
884
745
|
/** Gallery layout. */
|
|
885
746
|
layout?: Layout;
|
|
886
747
|
/** Styling for gallery items. */
|
|
@@ -888,7 +749,7 @@ export interface GalleryOptions {
|
|
|
888
749
|
/** Styling for gallery thumbnail images. */
|
|
889
750
|
thumbnails?: Thumbnails;
|
|
890
751
|
}
|
|
891
|
-
|
|
752
|
+
declare enum LayoutType {
|
|
892
753
|
/** Collage type */
|
|
893
754
|
COLLAGE = "COLLAGE",
|
|
894
755
|
/** Masonry type */
|
|
@@ -911,24 +772,24 @@ export declare enum LayoutType {
|
|
|
911
772
|
FULLSIZE = "FULLSIZE"
|
|
912
773
|
}
|
|
913
774
|
/** @enumType */
|
|
914
|
-
|
|
915
|
-
|
|
775
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
776
|
+
declare enum Orientation {
|
|
916
777
|
/** Rows Orientation */
|
|
917
778
|
ROWS = "ROWS",
|
|
918
779
|
/** Columns Orientation */
|
|
919
780
|
COLUMNS = "COLUMNS"
|
|
920
781
|
}
|
|
921
782
|
/** @enumType */
|
|
922
|
-
|
|
923
|
-
|
|
783
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
784
|
+
declare enum Crop {
|
|
924
785
|
/** Crop to fill */
|
|
925
786
|
FILL = "FILL",
|
|
926
787
|
/** Crop to fit */
|
|
927
788
|
FIT = "FIT"
|
|
928
789
|
}
|
|
929
790
|
/** @enumType */
|
|
930
|
-
|
|
931
|
-
|
|
791
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
792
|
+
declare enum ThumbnailsAlignment {
|
|
932
793
|
/** Top alignment */
|
|
933
794
|
TOP = "TOP",
|
|
934
795
|
/** Right alignment */
|
|
@@ -941,8 +802,8 @@ export declare enum ThumbnailsAlignment {
|
|
|
941
802
|
NONE = "NONE"
|
|
942
803
|
}
|
|
943
804
|
/** @enumType */
|
|
944
|
-
|
|
945
|
-
|
|
805
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
806
|
+
interface Layout {
|
|
946
807
|
/** Gallery layout type. */
|
|
947
808
|
type?: LayoutTypeWithLiterals;
|
|
948
809
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -954,7 +815,7 @@ export interface Layout {
|
|
|
954
815
|
/** The number of columns to display on mobile screens. */
|
|
955
816
|
mobileNumberOfColumns?: number | null;
|
|
956
817
|
}
|
|
957
|
-
|
|
818
|
+
interface ItemStyle {
|
|
958
819
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
959
820
|
targetSize?: number | null;
|
|
960
821
|
/** Item ratio */
|
|
@@ -964,13 +825,13 @@ export interface ItemStyle {
|
|
|
964
825
|
/** The spacing between items in pixels. */
|
|
965
826
|
spacing?: number | null;
|
|
966
827
|
}
|
|
967
|
-
|
|
828
|
+
interface Thumbnails {
|
|
968
829
|
/** Thumbnail alignment. */
|
|
969
830
|
placement?: ThumbnailsAlignmentWithLiterals;
|
|
970
831
|
/** Spacing between thumbnails in pixels. */
|
|
971
832
|
spacing?: number | null;
|
|
972
833
|
}
|
|
973
|
-
|
|
834
|
+
interface GIFData {
|
|
974
835
|
/** Styling for the GIF's container. */
|
|
975
836
|
containerData?: PluginContainerData;
|
|
976
837
|
/** The source of the full size GIF. */
|
|
@@ -984,7 +845,7 @@ export interface GIFData {
|
|
|
984
845
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
985
846
|
gifType?: GIFTypeWithLiterals;
|
|
986
847
|
}
|
|
987
|
-
|
|
848
|
+
interface GIF {
|
|
988
849
|
/**
|
|
989
850
|
* GIF format URL.
|
|
990
851
|
* @format WEB_URL
|
|
@@ -1001,13 +862,13 @@ export interface GIF {
|
|
|
1001
862
|
*/
|
|
1002
863
|
still?: string | null;
|
|
1003
864
|
}
|
|
1004
|
-
|
|
865
|
+
declare enum GIFType {
|
|
1005
866
|
NORMAL = "NORMAL",
|
|
1006
867
|
STICKER = "STICKER"
|
|
1007
868
|
}
|
|
1008
869
|
/** @enumType */
|
|
1009
|
-
|
|
1010
|
-
|
|
870
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
871
|
+
interface HeadingData {
|
|
1011
872
|
/** Heading level from 1-6. */
|
|
1012
873
|
level?: number;
|
|
1013
874
|
/** Styling for the heading text. */
|
|
@@ -1015,7 +876,7 @@ export interface HeadingData {
|
|
|
1015
876
|
/** Indentation level from 1-4. */
|
|
1016
877
|
indentation?: number | null;
|
|
1017
878
|
}
|
|
1018
|
-
|
|
879
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
1019
880
|
/** The URL for the HTML code for the node. */
|
|
1020
881
|
url?: string;
|
|
1021
882
|
/** The HTML code for the node. */
|
|
@@ -1033,7 +894,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
1033
894
|
autoHeight?: boolean | null;
|
|
1034
895
|
}
|
|
1035
896
|
/** @oneof */
|
|
1036
|
-
|
|
897
|
+
interface HTMLDataDataOneOf {
|
|
1037
898
|
/** The URL for the HTML code for the node. */
|
|
1038
899
|
url?: string;
|
|
1039
900
|
/** The HTML code for the node. */
|
|
@@ -1044,13 +905,13 @@ export interface HTMLDataDataOneOf {
|
|
|
1044
905
|
*/
|
|
1045
906
|
isAdsense?: boolean | null;
|
|
1046
907
|
}
|
|
1047
|
-
|
|
908
|
+
declare enum Source {
|
|
1048
909
|
HTML = "HTML",
|
|
1049
910
|
ADSENSE = "ADSENSE"
|
|
1050
911
|
}
|
|
1051
912
|
/** @enumType */
|
|
1052
|
-
|
|
1053
|
-
|
|
913
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
914
|
+
interface ImageData {
|
|
1054
915
|
/** Styling for the image's container. */
|
|
1055
916
|
containerData?: PluginContainerData;
|
|
1056
917
|
/** Image file details. */
|
|
@@ -1073,7 +934,7 @@ export interface ImageData {
|
|
|
1073
934
|
/** Styling for the image. */
|
|
1074
935
|
styles?: ImageDataStyles;
|
|
1075
936
|
}
|
|
1076
|
-
|
|
937
|
+
interface StylesBorder {
|
|
1077
938
|
/** Border width in pixels. */
|
|
1078
939
|
width?: number | null;
|
|
1079
940
|
/**
|
|
@@ -1084,11 +945,11 @@ export interface StylesBorder {
|
|
|
1084
945
|
/** Border radius in pixels. */
|
|
1085
946
|
radius?: number | null;
|
|
1086
947
|
}
|
|
1087
|
-
|
|
948
|
+
interface ImageDataStyles {
|
|
1088
949
|
/** Border attributes. */
|
|
1089
950
|
border?: StylesBorder;
|
|
1090
951
|
}
|
|
1091
|
-
|
|
952
|
+
interface LinkPreviewData {
|
|
1092
953
|
/** Styling for the link preview's container. */
|
|
1093
954
|
containerData?: PluginContainerData;
|
|
1094
955
|
/** Link details. */
|
|
@@ -1104,7 +965,7 @@ export interface LinkPreviewData {
|
|
|
1104
965
|
/** Styling for the link preview. */
|
|
1105
966
|
styles?: LinkPreviewDataStyles;
|
|
1106
967
|
}
|
|
1107
|
-
|
|
968
|
+
declare enum Position {
|
|
1108
969
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
1109
970
|
START = "START",
|
|
1110
971
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -1115,8 +976,8 @@ export declare enum Position {
|
|
|
1115
976
|
HIDDEN = "HIDDEN"
|
|
1116
977
|
}
|
|
1117
978
|
/** @enumType */
|
|
1118
|
-
|
|
1119
|
-
|
|
979
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
980
|
+
interface LinkPreviewDataStyles {
|
|
1120
981
|
/**
|
|
1121
982
|
* Background color as a hexadecimal value.
|
|
1122
983
|
* @format COLOR_HEX
|
|
@@ -1149,13 +1010,13 @@ export interface LinkPreviewDataStyles {
|
|
|
1149
1010
|
/** Position of thumbnail. Defaults to `START`. */
|
|
1150
1011
|
thumbnailPosition?: PositionWithLiterals;
|
|
1151
1012
|
}
|
|
1152
|
-
|
|
1013
|
+
interface MapData {
|
|
1153
1014
|
/** Styling for the map's container. */
|
|
1154
1015
|
containerData?: PluginContainerData;
|
|
1155
1016
|
/** Map settings. */
|
|
1156
1017
|
mapSettings?: MapSettings;
|
|
1157
1018
|
}
|
|
1158
|
-
|
|
1019
|
+
interface MapSettings {
|
|
1159
1020
|
/** The address to display on the map. */
|
|
1160
1021
|
address?: string | null;
|
|
1161
1022
|
/** Sets whether the map is draggable. */
|
|
@@ -1179,7 +1040,7 @@ export interface MapSettings {
|
|
|
1179
1040
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
1180
1041
|
mapType?: MapTypeWithLiterals;
|
|
1181
1042
|
}
|
|
1182
|
-
|
|
1043
|
+
declare enum MapType {
|
|
1183
1044
|
/** Roadmap map type */
|
|
1184
1045
|
ROADMAP = "ROADMAP",
|
|
1185
1046
|
/** Satellite map type */
|
|
@@ -1190,8 +1051,8 @@ export declare enum MapType {
|
|
|
1190
1051
|
TERRAIN = "TERRAIN"
|
|
1191
1052
|
}
|
|
1192
1053
|
/** @enumType */
|
|
1193
|
-
|
|
1194
|
-
|
|
1054
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
1055
|
+
interface ParagraphData {
|
|
1195
1056
|
/** Styling for the paragraph text. */
|
|
1196
1057
|
textStyle?: TextStyle;
|
|
1197
1058
|
/** Indentation level from 1-4. */
|
|
@@ -1199,7 +1060,7 @@ export interface ParagraphData {
|
|
|
1199
1060
|
/** Paragraph level */
|
|
1200
1061
|
level?: number | null;
|
|
1201
1062
|
}
|
|
1202
|
-
|
|
1063
|
+
interface PollData {
|
|
1203
1064
|
/** Styling for the poll's container. */
|
|
1204
1065
|
containerData?: PluginContainerData;
|
|
1205
1066
|
/** Poll data. */
|
|
@@ -1209,7 +1070,7 @@ export interface PollData {
|
|
|
1209
1070
|
/** Styling for the poll and voting options. */
|
|
1210
1071
|
design?: Design;
|
|
1211
1072
|
}
|
|
1212
|
-
|
|
1073
|
+
declare enum ViewRole {
|
|
1213
1074
|
/** Only Poll creator can view the results */
|
|
1214
1075
|
CREATOR = "CREATOR",
|
|
1215
1076
|
/** Anyone who voted can see the results */
|
|
@@ -1218,16 +1079,16 @@ export declare enum ViewRole {
|
|
|
1218
1079
|
EVERYONE = "EVERYONE"
|
|
1219
1080
|
}
|
|
1220
1081
|
/** @enumType */
|
|
1221
|
-
|
|
1222
|
-
|
|
1082
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
1083
|
+
declare enum VoteRole {
|
|
1223
1084
|
/** Logged in member */
|
|
1224
1085
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
1225
1086
|
/** Anyone */
|
|
1226
1087
|
ALL = "ALL"
|
|
1227
1088
|
}
|
|
1228
1089
|
/** @enumType */
|
|
1229
|
-
|
|
1230
|
-
|
|
1090
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
1091
|
+
interface Permissions {
|
|
1231
1092
|
/** Sets who can view the poll results. */
|
|
1232
1093
|
view?: ViewRoleWithLiterals;
|
|
1233
1094
|
/** Sets who can vote. */
|
|
@@ -1235,7 +1096,7 @@ export interface Permissions {
|
|
|
1235
1096
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1236
1097
|
allowMultipleVotes?: boolean | null;
|
|
1237
1098
|
}
|
|
1238
|
-
|
|
1099
|
+
interface Option {
|
|
1239
1100
|
/** Option ID. */
|
|
1240
1101
|
id?: string | null;
|
|
1241
1102
|
/** Option title. */
|
|
@@ -1243,7 +1104,7 @@ export interface Option {
|
|
|
1243
1104
|
/** The image displayed with the option. */
|
|
1244
1105
|
image?: V1Media;
|
|
1245
1106
|
}
|
|
1246
|
-
|
|
1107
|
+
interface PollSettings {
|
|
1247
1108
|
/** Permissions settings for voting. */
|
|
1248
1109
|
permissions?: Permissions;
|
|
1249
1110
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -1251,23 +1112,23 @@ export interface PollSettings {
|
|
|
1251
1112
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
1252
1113
|
showVotesCount?: boolean | null;
|
|
1253
1114
|
}
|
|
1254
|
-
|
|
1115
|
+
declare enum PollLayoutType {
|
|
1255
1116
|
/** List */
|
|
1256
1117
|
LIST = "LIST",
|
|
1257
1118
|
/** Grid */
|
|
1258
1119
|
GRID = "GRID"
|
|
1259
1120
|
}
|
|
1260
1121
|
/** @enumType */
|
|
1261
|
-
|
|
1262
|
-
|
|
1122
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
1123
|
+
declare enum PollLayoutDirection {
|
|
1263
1124
|
/** Left-to-right */
|
|
1264
1125
|
LTR = "LTR",
|
|
1265
1126
|
/** Right-to-left */
|
|
1266
1127
|
RTL = "RTL"
|
|
1267
1128
|
}
|
|
1268
1129
|
/** @enumType */
|
|
1269
|
-
|
|
1270
|
-
|
|
1130
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
1131
|
+
interface PollLayout {
|
|
1271
1132
|
/** The layout for displaying the voting options. */
|
|
1272
1133
|
type?: PollLayoutTypeWithLiterals;
|
|
1273
1134
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -1275,11 +1136,11 @@ export interface PollLayout {
|
|
|
1275
1136
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1276
1137
|
enableImage?: boolean | null;
|
|
1277
1138
|
}
|
|
1278
|
-
|
|
1139
|
+
interface OptionLayout {
|
|
1279
1140
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
1280
1141
|
enableImage?: boolean | null;
|
|
1281
1142
|
}
|
|
1282
|
-
|
|
1143
|
+
declare enum BackgroundType {
|
|
1283
1144
|
/** Color background type */
|
|
1284
1145
|
COLOR = "COLOR",
|
|
1285
1146
|
/** Image background type */
|
|
@@ -1288,8 +1149,8 @@ export declare enum BackgroundType {
|
|
|
1288
1149
|
GRADIENT = "GRADIENT"
|
|
1289
1150
|
}
|
|
1290
1151
|
/** @enumType */
|
|
1291
|
-
|
|
1292
|
-
|
|
1152
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
1153
|
+
interface Gradient {
|
|
1293
1154
|
/** The gradient angle in degrees. */
|
|
1294
1155
|
angle?: number | null;
|
|
1295
1156
|
/**
|
|
@@ -1303,7 +1164,7 @@ export interface Gradient {
|
|
|
1303
1164
|
*/
|
|
1304
1165
|
lastColor?: string | null;
|
|
1305
1166
|
}
|
|
1306
|
-
|
|
1167
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
1307
1168
|
/**
|
|
1308
1169
|
* The background color as a hexademical value.
|
|
1309
1170
|
* @format COLOR_HEX
|
|
@@ -1317,7 +1178,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1317
1178
|
type?: BackgroundTypeWithLiterals;
|
|
1318
1179
|
}
|
|
1319
1180
|
/** @oneof */
|
|
1320
|
-
|
|
1181
|
+
interface BackgroundBackgroundOneOf {
|
|
1321
1182
|
/**
|
|
1322
1183
|
* The background color as a hexademical value.
|
|
1323
1184
|
* @format COLOR_HEX
|
|
@@ -1328,17 +1189,17 @@ export interface BackgroundBackgroundOneOf {
|
|
|
1328
1189
|
/** Details for a gradient background. */
|
|
1329
1190
|
gradient?: Gradient;
|
|
1330
1191
|
}
|
|
1331
|
-
|
|
1192
|
+
interface PollDesign {
|
|
1332
1193
|
/** Background styling. */
|
|
1333
1194
|
background?: Background;
|
|
1334
1195
|
/** Border radius in pixels. */
|
|
1335
1196
|
borderRadius?: number | null;
|
|
1336
1197
|
}
|
|
1337
|
-
|
|
1198
|
+
interface OptionDesign {
|
|
1338
1199
|
/** Border radius in pixels. */
|
|
1339
1200
|
borderRadius?: number | null;
|
|
1340
1201
|
}
|
|
1341
|
-
|
|
1202
|
+
interface Poll {
|
|
1342
1203
|
/** Poll ID. */
|
|
1343
1204
|
id?: string | null;
|
|
1344
1205
|
/** Poll title. */
|
|
@@ -1352,26 +1213,26 @@ export interface Poll {
|
|
|
1352
1213
|
/** The poll's permissions and display settings. */
|
|
1353
1214
|
settings?: PollSettings;
|
|
1354
1215
|
}
|
|
1355
|
-
|
|
1216
|
+
interface PollDataLayout {
|
|
1356
1217
|
/** Poll layout settings. */
|
|
1357
1218
|
poll?: PollLayout;
|
|
1358
1219
|
/** Voting otpions layout settings. */
|
|
1359
1220
|
options?: OptionLayout;
|
|
1360
1221
|
}
|
|
1361
|
-
|
|
1222
|
+
interface Design {
|
|
1362
1223
|
/** Styling for the poll. */
|
|
1363
1224
|
poll?: PollDesign;
|
|
1364
1225
|
/** Styling for voting options. */
|
|
1365
1226
|
options?: OptionDesign;
|
|
1366
1227
|
}
|
|
1367
|
-
|
|
1228
|
+
interface TextData {
|
|
1368
1229
|
/** The text to apply decorations to. */
|
|
1369
1230
|
text?: string;
|
|
1370
1231
|
/** The decorations to apply. */
|
|
1371
1232
|
decorations?: Decoration[];
|
|
1372
1233
|
}
|
|
1373
1234
|
/** Adds appearence changes to text */
|
|
1374
|
-
|
|
1235
|
+
interface Decoration extends DecorationDataOneOf {
|
|
1375
1236
|
/** Data for an anchor link decoration. */
|
|
1376
1237
|
anchorData?: AnchorData;
|
|
1377
1238
|
/** Data for a color decoration. */
|
|
@@ -1396,7 +1257,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
1396
1257
|
type?: DecorationTypeWithLiterals;
|
|
1397
1258
|
}
|
|
1398
1259
|
/** @oneof */
|
|
1399
|
-
|
|
1260
|
+
interface DecorationDataOneOf {
|
|
1400
1261
|
/** Data for an anchor link decoration. */
|
|
1401
1262
|
anchorData?: AnchorData;
|
|
1402
1263
|
/** Data for a color decoration. */
|
|
@@ -1418,7 +1279,7 @@ export interface DecorationDataOneOf {
|
|
|
1418
1279
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1419
1280
|
strikethroughData?: boolean | null;
|
|
1420
1281
|
}
|
|
1421
|
-
|
|
1282
|
+
declare enum DecorationType {
|
|
1422
1283
|
BOLD = "BOLD",
|
|
1423
1284
|
ITALIC = "ITALIC",
|
|
1424
1285
|
UNDERLINE = "UNDERLINE",
|
|
@@ -1432,22 +1293,22 @@ export declare enum DecorationType {
|
|
|
1432
1293
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1433
1294
|
}
|
|
1434
1295
|
/** @enumType */
|
|
1435
|
-
|
|
1436
|
-
|
|
1296
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
1297
|
+
interface AnchorData {
|
|
1437
1298
|
/** The target node's ID. */
|
|
1438
1299
|
anchor?: string;
|
|
1439
1300
|
}
|
|
1440
|
-
|
|
1301
|
+
interface ColorData {
|
|
1441
1302
|
/** The text's background color as a hexadecimal value. */
|
|
1442
1303
|
background?: string | null;
|
|
1443
1304
|
/** The text's foreground color as a hexadecimal value. */
|
|
1444
1305
|
foreground?: string | null;
|
|
1445
1306
|
}
|
|
1446
|
-
|
|
1307
|
+
interface LinkData {
|
|
1447
1308
|
/** Link details. */
|
|
1448
1309
|
link?: Link;
|
|
1449
1310
|
}
|
|
1450
|
-
|
|
1311
|
+
interface MentionData {
|
|
1451
1312
|
/** The mentioned user's name. */
|
|
1452
1313
|
name?: string;
|
|
1453
1314
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -1455,23 +1316,23 @@ export interface MentionData {
|
|
|
1455
1316
|
/** Mentioned user's ID. */
|
|
1456
1317
|
id?: string | null;
|
|
1457
1318
|
}
|
|
1458
|
-
|
|
1319
|
+
interface FontSizeData {
|
|
1459
1320
|
/** The units used for the font size. */
|
|
1460
1321
|
unit?: FontTypeWithLiterals;
|
|
1461
1322
|
/** Font size value. */
|
|
1462
1323
|
value?: number | null;
|
|
1463
1324
|
}
|
|
1464
|
-
|
|
1325
|
+
declare enum FontType {
|
|
1465
1326
|
PX = "PX",
|
|
1466
1327
|
EM = "EM"
|
|
1467
1328
|
}
|
|
1468
1329
|
/** @enumType */
|
|
1469
|
-
|
|
1470
|
-
|
|
1330
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
1331
|
+
interface SpoilerData {
|
|
1471
1332
|
/** Spoiler ID. */
|
|
1472
1333
|
id?: string | null;
|
|
1473
1334
|
}
|
|
1474
|
-
|
|
1335
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1475
1336
|
/** Data for embedded Wix Bookings content. */
|
|
1476
1337
|
bookingData?: BookingData;
|
|
1477
1338
|
/** Data for embedded Wix Events content. */
|
|
@@ -1493,30 +1354,30 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1493
1354
|
image?: V1Media;
|
|
1494
1355
|
}
|
|
1495
1356
|
/** @oneof */
|
|
1496
|
-
|
|
1357
|
+
interface AppEmbedDataAppDataOneOf {
|
|
1497
1358
|
/** Data for embedded Wix Bookings content. */
|
|
1498
1359
|
bookingData?: BookingData;
|
|
1499
1360
|
/** Data for embedded Wix Events content. */
|
|
1500
1361
|
eventData?: EventData;
|
|
1501
1362
|
}
|
|
1502
|
-
|
|
1363
|
+
declare enum AppType {
|
|
1503
1364
|
PRODUCT = "PRODUCT",
|
|
1504
1365
|
EVENT = "EVENT",
|
|
1505
1366
|
BOOKING = "BOOKING"
|
|
1506
1367
|
}
|
|
1507
1368
|
/** @enumType */
|
|
1508
|
-
|
|
1509
|
-
|
|
1369
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
1370
|
+
interface BookingData {
|
|
1510
1371
|
/** Booking duration in minutes. */
|
|
1511
1372
|
durations?: string | null;
|
|
1512
1373
|
}
|
|
1513
|
-
|
|
1374
|
+
interface EventData {
|
|
1514
1375
|
/** Event schedule. */
|
|
1515
1376
|
scheduling?: string | null;
|
|
1516
1377
|
/** Event location. */
|
|
1517
1378
|
location?: string | null;
|
|
1518
1379
|
}
|
|
1519
|
-
|
|
1380
|
+
interface VideoData {
|
|
1520
1381
|
/** Styling for the video's container. */
|
|
1521
1382
|
containerData?: PluginContainerData;
|
|
1522
1383
|
/** Video details. */
|
|
@@ -1530,7 +1391,7 @@ export interface VideoData {
|
|
|
1530
1391
|
/** Video options. */
|
|
1531
1392
|
options?: PlaybackOptions;
|
|
1532
1393
|
}
|
|
1533
|
-
|
|
1394
|
+
interface PlaybackOptions {
|
|
1534
1395
|
/** Sets whether the media will automatically start playing. */
|
|
1535
1396
|
autoPlay?: boolean | null;
|
|
1536
1397
|
/** Sets whether media's will be looped. */
|
|
@@ -1538,7 +1399,7 @@ export interface PlaybackOptions {
|
|
|
1538
1399
|
/** Sets whether media's controls will be shown. */
|
|
1539
1400
|
showControls?: boolean | null;
|
|
1540
1401
|
}
|
|
1541
|
-
|
|
1402
|
+
interface EmbedData {
|
|
1542
1403
|
/** Styling for the oEmbed node's container. */
|
|
1543
1404
|
containerData?: PluginContainerData;
|
|
1544
1405
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -1546,7 +1407,7 @@ export interface EmbedData {
|
|
|
1546
1407
|
/** Origin asset source. */
|
|
1547
1408
|
src?: string | null;
|
|
1548
1409
|
}
|
|
1549
|
-
|
|
1410
|
+
interface Oembed {
|
|
1550
1411
|
/** The resource type. */
|
|
1551
1412
|
type?: string | null;
|
|
1552
1413
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -1578,7 +1439,7 @@ export interface Oembed {
|
|
|
1578
1439
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
1579
1440
|
version?: string | null;
|
|
1580
1441
|
}
|
|
1581
|
-
|
|
1442
|
+
interface CollapsibleListData {
|
|
1582
1443
|
/** Styling for the collapsible list's container. */
|
|
1583
1444
|
containerData?: PluginContainerData;
|
|
1584
1445
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -1590,7 +1451,7 @@ export interface CollapsibleListData {
|
|
|
1590
1451
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1591
1452
|
isQapageData?: boolean | null;
|
|
1592
1453
|
}
|
|
1593
|
-
|
|
1454
|
+
declare enum InitialExpandedItems {
|
|
1594
1455
|
/** First item will be expended initally */
|
|
1595
1456
|
FIRST = "FIRST",
|
|
1596
1457
|
/** All items will expended initally */
|
|
@@ -1599,16 +1460,16 @@ export declare enum InitialExpandedItems {
|
|
|
1599
1460
|
NONE = "NONE"
|
|
1600
1461
|
}
|
|
1601
1462
|
/** @enumType */
|
|
1602
|
-
|
|
1603
|
-
|
|
1463
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
1464
|
+
declare enum Direction {
|
|
1604
1465
|
/** Left-to-right */
|
|
1605
1466
|
LTR = "LTR",
|
|
1606
1467
|
/** Right-to-left */
|
|
1607
1468
|
RTL = "RTL"
|
|
1608
1469
|
}
|
|
1609
1470
|
/** @enumType */
|
|
1610
|
-
|
|
1611
|
-
|
|
1471
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
1472
|
+
interface TableData {
|
|
1612
1473
|
/** Styling for the table's container. */
|
|
1613
1474
|
containerData?: PluginContainerData;
|
|
1614
1475
|
/** The table's dimensions. */
|
|
@@ -1623,7 +1484,7 @@ export interface TableData {
|
|
|
1623
1484
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1624
1485
|
columnHeader?: boolean | null;
|
|
1625
1486
|
}
|
|
1626
|
-
|
|
1487
|
+
interface Dimensions {
|
|
1627
1488
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
1628
1489
|
colsWidthRatio?: number[];
|
|
1629
1490
|
/** An array representing the height of each row in pixels. */
|
|
@@ -1631,13 +1492,13 @@ export interface Dimensions {
|
|
|
1631
1492
|
/** An array representing the minimum width of each column in pixels. */
|
|
1632
1493
|
colsMinWidth?: number[];
|
|
1633
1494
|
}
|
|
1634
|
-
|
|
1495
|
+
interface TableCellData {
|
|
1635
1496
|
/** Styling for the cell's background color and text alignment. */
|
|
1636
1497
|
cellStyle?: CellStyle;
|
|
1637
1498
|
/** The cell's border colors. */
|
|
1638
1499
|
borderColors?: BorderColors;
|
|
1639
1500
|
}
|
|
1640
|
-
|
|
1501
|
+
declare enum VerticalAlignment {
|
|
1641
1502
|
/** Top alignment */
|
|
1642
1503
|
TOP = "TOP",
|
|
1643
1504
|
/** Middle alignment */
|
|
@@ -1646,8 +1507,8 @@ export declare enum VerticalAlignment {
|
|
|
1646
1507
|
BOTTOM = "BOTTOM"
|
|
1647
1508
|
}
|
|
1648
1509
|
/** @enumType */
|
|
1649
|
-
|
|
1650
|
-
|
|
1510
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
1511
|
+
interface CellStyle {
|
|
1651
1512
|
/** Vertical alignment for the cell's text. */
|
|
1652
1513
|
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
1653
1514
|
/**
|
|
@@ -1656,7 +1517,7 @@ export interface CellStyle {
|
|
|
1656
1517
|
*/
|
|
1657
1518
|
backgroundColor?: string | null;
|
|
1658
1519
|
}
|
|
1659
|
-
|
|
1520
|
+
interface BorderColors {
|
|
1660
1521
|
/**
|
|
1661
1522
|
* Left border color as a hexadecimal value.
|
|
1662
1523
|
* @format COLOR_HEX
|
|
@@ -1678,28 +1539,7 @@ export interface BorderColors {
|
|
|
1678
1539
|
*/
|
|
1679
1540
|
bottom?: string | null;
|
|
1680
1541
|
}
|
|
1681
|
-
|
|
1682
|
-
* `NullValue` is a singleton enumeration to represent the null value for the
|
|
1683
|
-
* `Value` type union.
|
|
1684
|
-
*
|
|
1685
|
-
* The JSON representation for `NullValue` is JSON `null`.
|
|
1686
|
-
*/
|
|
1687
|
-
export declare enum NullValue {
|
|
1688
|
-
/** Null value. */
|
|
1689
|
-
NULL_VALUE = "NULL_VALUE"
|
|
1690
|
-
}
|
|
1691
|
-
/** @enumType */
|
|
1692
|
-
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
1693
|
-
/**
|
|
1694
|
-
* `ListValue` is a wrapper around a repeated field of values.
|
|
1695
|
-
*
|
|
1696
|
-
* The JSON representation for `ListValue` is JSON array.
|
|
1697
|
-
*/
|
|
1698
|
-
export interface ListValue {
|
|
1699
|
-
/** Repeated field of dynamically typed values. */
|
|
1700
|
-
values?: any[];
|
|
1701
|
-
}
|
|
1702
|
-
export interface AudioData {
|
|
1542
|
+
interface AudioData {
|
|
1703
1543
|
/** Styling for the audio node's container. */
|
|
1704
1544
|
containerData?: PluginContainerData;
|
|
1705
1545
|
/** Audio file details. */
|
|
@@ -1715,7 +1555,7 @@ export interface AudioData {
|
|
|
1715
1555
|
/** An HTML version of the audio node. */
|
|
1716
1556
|
html?: string | null;
|
|
1717
1557
|
}
|
|
1718
|
-
|
|
1558
|
+
interface OrderedListData {
|
|
1719
1559
|
/** Indentation level from 0-4. */
|
|
1720
1560
|
indentation?: number;
|
|
1721
1561
|
/** Offset level from 0-4. */
|
|
@@ -1723,24 +1563,24 @@ export interface OrderedListData {
|
|
|
1723
1563
|
/** List start number. */
|
|
1724
1564
|
start?: number | null;
|
|
1725
1565
|
}
|
|
1726
|
-
|
|
1566
|
+
interface BulletedListData {
|
|
1727
1567
|
/** Indentation level from 0-4. */
|
|
1728
1568
|
indentation?: number;
|
|
1729
1569
|
/** Offset level from 0-4. */
|
|
1730
1570
|
offset?: number | null;
|
|
1731
1571
|
}
|
|
1732
|
-
|
|
1572
|
+
interface BlockquoteData {
|
|
1733
1573
|
/** Indentation level from 1-4. */
|
|
1734
1574
|
indentation?: number;
|
|
1735
1575
|
}
|
|
1736
|
-
|
|
1576
|
+
interface CaptionData {
|
|
1737
1577
|
textStyle?: TextStyle;
|
|
1738
1578
|
}
|
|
1739
|
-
|
|
1579
|
+
interface LayoutCellData {
|
|
1740
1580
|
/** Size of the cell in 12 columns grid. */
|
|
1741
1581
|
colSpan?: number | null;
|
|
1742
1582
|
}
|
|
1743
|
-
|
|
1583
|
+
interface Metadata {
|
|
1744
1584
|
/** Schema version. */
|
|
1745
1585
|
version?: number;
|
|
1746
1586
|
/**
|
|
@@ -1757,7 +1597,7 @@ export interface Metadata {
|
|
|
1757
1597
|
/** Object ID. */
|
|
1758
1598
|
id?: string | null;
|
|
1759
1599
|
}
|
|
1760
|
-
|
|
1600
|
+
interface DocumentStyle {
|
|
1761
1601
|
/** Styling for H1 nodes. */
|
|
1762
1602
|
headerOne?: TextNodeStyle;
|
|
1763
1603
|
/** Styling for H2 nodes. */
|
|
@@ -1777,7 +1617,7 @@ export interface DocumentStyle {
|
|
|
1777
1617
|
/** Styling for code block nodes. */
|
|
1778
1618
|
codeBlock?: TextNodeStyle;
|
|
1779
1619
|
}
|
|
1780
|
-
|
|
1620
|
+
interface TextNodeStyle {
|
|
1781
1621
|
/** The decorations to apply to the node. */
|
|
1782
1622
|
decorations?: Decoration[];
|
|
1783
1623
|
/** Padding and background color for the node. */
|
|
@@ -1785,7 +1625,7 @@ export interface TextNodeStyle {
|
|
|
1785
1625
|
/** Line height for text in the node. */
|
|
1786
1626
|
lineHeight?: string | null;
|
|
1787
1627
|
}
|
|
1788
|
-
|
|
1628
|
+
declare enum Status {
|
|
1789
1629
|
UNKNOWN = "UNKNOWN",
|
|
1790
1630
|
/** Status indicating the draft post is published. */
|
|
1791
1631
|
PUBLISHED = "PUBLISHED",
|
|
@@ -1799,8 +1639,8 @@ export declare enum Status {
|
|
|
1799
1639
|
IN_REVIEW = "IN_REVIEW"
|
|
1800
1640
|
}
|
|
1801
1641
|
/** @enumType */
|
|
1802
|
-
|
|
1803
|
-
|
|
1642
|
+
type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
|
|
1643
|
+
interface ModerationDetails {
|
|
1804
1644
|
/**
|
|
1805
1645
|
* Member ID of the person submitting the draft post for review.
|
|
1806
1646
|
* @format GUID
|
|
@@ -1818,25 +1658,25 @@ export interface ModerationDetails {
|
|
|
1818
1658
|
/** Date the post was approved or rejected. */
|
|
1819
1659
|
moderationDate?: Date | null;
|
|
1820
1660
|
}
|
|
1821
|
-
|
|
1661
|
+
declare enum ModerationStatusStatus {
|
|
1822
1662
|
UNKNOWN = "UNKNOWN",
|
|
1823
1663
|
APPROVED = "APPROVED",
|
|
1824
1664
|
REJECTED = "REJECTED"
|
|
1825
1665
|
}
|
|
1826
1666
|
/** @enumType */
|
|
1827
|
-
|
|
1667
|
+
type ModerationStatusStatusWithLiterals = ModerationStatusStatus | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
|
|
1828
1668
|
/**
|
|
1829
1669
|
* The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
|
|
1830
1670
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
1831
1671
|
* This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
|
|
1832
1672
|
*/
|
|
1833
|
-
|
|
1673
|
+
interface SeoSchema {
|
|
1834
1674
|
/** SEO tag information. */
|
|
1835
1675
|
tags?: Tag[];
|
|
1836
1676
|
/** SEO general settings. */
|
|
1837
1677
|
settings?: Settings;
|
|
1838
1678
|
}
|
|
1839
|
-
|
|
1679
|
+
interface Keyword {
|
|
1840
1680
|
/** Keyword value. */
|
|
1841
1681
|
term?: string;
|
|
1842
1682
|
/** Whether the keyword is the main focus keyword. */
|
|
@@ -1847,7 +1687,7 @@ export interface Keyword {
|
|
|
1847
1687
|
*/
|
|
1848
1688
|
origin?: string | null;
|
|
1849
1689
|
}
|
|
1850
|
-
|
|
1690
|
+
interface Tag {
|
|
1851
1691
|
/**
|
|
1852
1692
|
* SEO tag type.
|
|
1853
1693
|
*
|
|
@@ -1869,7 +1709,7 @@ export interface Tag {
|
|
|
1869
1709
|
/** Whether the tag is disabled. */
|
|
1870
1710
|
disabled?: boolean;
|
|
1871
1711
|
}
|
|
1872
|
-
|
|
1712
|
+
interface Settings {
|
|
1873
1713
|
/**
|
|
1874
1714
|
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
1875
1715
|
*
|
|
@@ -1883,13 +1723,13 @@ export interface Settings {
|
|
|
1883
1723
|
*/
|
|
1884
1724
|
keywords?: Keyword[];
|
|
1885
1725
|
}
|
|
1886
|
-
|
|
1726
|
+
interface PageUrl {
|
|
1887
1727
|
/** The base URL. For premium sites, this is the domain. For free sites, this is the site URL. For example, `mysite.wixsite.com/mysite`. */
|
|
1888
1728
|
base?: string;
|
|
1889
1729
|
/** The relative path for the page within the site. For example, `/product-page/a-product`. */
|
|
1890
1730
|
path?: string;
|
|
1891
1731
|
}
|
|
1892
|
-
|
|
1732
|
+
interface Media extends MediaMediaOneOf {
|
|
1893
1733
|
/** Wix Media details. */
|
|
1894
1734
|
wixMedia?: WixMedia;
|
|
1895
1735
|
/** Embed media details. */
|
|
@@ -1906,19 +1746,19 @@ export interface Media extends MediaMediaOneOf {
|
|
|
1906
1746
|
altText?: string | null;
|
|
1907
1747
|
}
|
|
1908
1748
|
/** @oneof */
|
|
1909
|
-
|
|
1749
|
+
interface MediaMediaOneOf {
|
|
1910
1750
|
/** Wix Media details. */
|
|
1911
1751
|
wixMedia?: WixMedia;
|
|
1912
1752
|
/** Embed media details. */
|
|
1913
1753
|
embedMedia?: EmbedMedia;
|
|
1914
1754
|
}
|
|
1915
|
-
|
|
1755
|
+
interface WixMedia {
|
|
1916
1756
|
/** Image details. */
|
|
1917
1757
|
image?: Image;
|
|
1918
1758
|
/** Video details. */
|
|
1919
1759
|
videoV2?: VideoV2;
|
|
1920
1760
|
}
|
|
1921
|
-
|
|
1761
|
+
interface VideoV2 {
|
|
1922
1762
|
/** WixMedia ID. */
|
|
1923
1763
|
id?: string;
|
|
1924
1764
|
/**
|
|
@@ -1933,7 +1773,7 @@ export interface VideoV2 {
|
|
|
1933
1773
|
*/
|
|
1934
1774
|
filename?: string | null;
|
|
1935
1775
|
}
|
|
1936
|
-
|
|
1776
|
+
interface VideoResolution {
|
|
1937
1777
|
/** Video URL. */
|
|
1938
1778
|
url?: string;
|
|
1939
1779
|
/** Video height. */
|
|
@@ -1943,13 +1783,13 @@ export interface VideoResolution {
|
|
|
1943
1783
|
/** Video format for example, mp4, hls. */
|
|
1944
1784
|
format?: string;
|
|
1945
1785
|
}
|
|
1946
|
-
|
|
1786
|
+
interface EmbedMedia {
|
|
1947
1787
|
/** Thumbnail details. */
|
|
1948
1788
|
thumbnail?: EmbedThumbnail;
|
|
1949
1789
|
/** Video details. */
|
|
1950
1790
|
video?: EmbedVideo;
|
|
1951
1791
|
}
|
|
1952
|
-
|
|
1792
|
+
interface EmbedThumbnail {
|
|
1953
1793
|
/**
|
|
1954
1794
|
* Thumbnail url.
|
|
1955
1795
|
* @maxLength 2000
|
|
@@ -1960,7 +1800,7 @@ export interface EmbedThumbnail {
|
|
|
1960
1800
|
/** Thumbnail height. */
|
|
1961
1801
|
height?: number;
|
|
1962
1802
|
}
|
|
1963
|
-
|
|
1803
|
+
interface EmbedVideo {
|
|
1964
1804
|
/**
|
|
1965
1805
|
* Video url.
|
|
1966
1806
|
* @maxLength 2000
|
|
@@ -1971,245 +1811,7 @@ export interface EmbedVideo {
|
|
|
1971
1811
|
/** Video height. */
|
|
1972
1812
|
height?: number;
|
|
1973
1813
|
}
|
|
1974
|
-
|
|
1975
|
-
/**
|
|
1976
|
-
* Post ID.
|
|
1977
|
-
* @format GUID
|
|
1978
|
-
*/
|
|
1979
|
-
id?: string;
|
|
1980
|
-
/** Post status. */
|
|
1981
|
-
status?: StatusWithLiterals;
|
|
1982
|
-
/**
|
|
1983
|
-
* Language the post is written in.
|
|
1984
|
-
* @format LANGUAGE_TAG
|
|
1985
|
-
*/
|
|
1986
|
-
language?: string | null;
|
|
1987
|
-
/**
|
|
1988
|
-
* Post slug. For example, 'post-slug'.
|
|
1989
|
-
* @maxLength 100
|
|
1990
|
-
*/
|
|
1991
|
-
slug?: string | null;
|
|
1992
|
-
/** SEO data. */
|
|
1993
|
-
seoData?: SeoSchema;
|
|
1994
|
-
/** Post URL. */
|
|
1995
|
-
url?: PageUrl;
|
|
1996
|
-
}
|
|
1997
|
-
export interface DraftCategoriesUpdated {
|
|
1998
|
-
/**
|
|
1999
|
-
* Draft post ID.
|
|
2000
|
-
* @maxLength 38
|
|
2001
|
-
*/
|
|
2002
|
-
draftPostId?: string;
|
|
2003
|
-
/**
|
|
2004
|
-
* Current categories of the draft.
|
|
2005
|
-
* @maxSize 10
|
|
2006
|
-
* @format GUID
|
|
2007
|
-
*/
|
|
2008
|
-
categories?: string[];
|
|
2009
|
-
/**
|
|
2010
|
-
* Previous categories of the draft.
|
|
2011
|
-
* @maxSize 10
|
|
2012
|
-
* @format GUID
|
|
2013
|
-
*/
|
|
2014
|
-
previousCategories?: string[];
|
|
2015
|
-
}
|
|
2016
|
-
export interface DraftTagsUpdated {
|
|
2017
|
-
/**
|
|
2018
|
-
* Draft post ID.
|
|
2019
|
-
* @maxLength 38
|
|
2020
|
-
*/
|
|
2021
|
-
draftPostId?: string;
|
|
2022
|
-
/**
|
|
2023
|
-
* Current tags of the draft.
|
|
2024
|
-
* @maxSize 30
|
|
2025
|
-
* @format GUID
|
|
2026
|
-
*/
|
|
2027
|
-
tags?: string[];
|
|
2028
|
-
/**
|
|
2029
|
-
* Previous tags of the draft.
|
|
2030
|
-
* @maxSize 30
|
|
2031
|
-
* @format GUID
|
|
2032
|
-
*/
|
|
2033
|
-
previousTags?: string[];
|
|
2034
|
-
}
|
|
2035
|
-
export interface GetDraftPostTotalsRequest {
|
|
2036
|
-
/**
|
|
2037
|
-
* Group results by fields (defaults to grouping by status).
|
|
2038
|
-
* If, for example, grouping by language is passed, language values in response will be filled.
|
|
2039
|
-
* If, for example, grouping by language is not passed, null values will be filled in language field in response.
|
|
2040
|
-
* @maxSize 10
|
|
2041
|
-
*/
|
|
2042
|
-
groupBy?: TotalDraftPostsGroupingFieldWithLiterals[];
|
|
2043
|
-
/**
|
|
2044
|
-
* Optional language filter by provided language code. Useful in multilingual context.
|
|
2045
|
-
* @format LANGUAGE_TAG
|
|
2046
|
-
*/
|
|
2047
|
-
language?: string | null;
|
|
2048
|
-
}
|
|
2049
|
-
export declare enum TotalDraftPostsGroupingField {
|
|
2050
|
-
/** Groups results by status. */
|
|
2051
|
-
STATUS = "STATUS",
|
|
2052
|
-
/** Groups results by language. */
|
|
2053
|
-
LANGUAGE = "LANGUAGE"
|
|
2054
|
-
}
|
|
2055
|
-
/** @enumType */
|
|
2056
|
-
export type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
|
|
2057
|
-
export interface GetDraftPostTotalsResponse {
|
|
2058
|
-
/** Draft post totals. */
|
|
2059
|
-
totalDraftPosts?: TotalDraftPosts[];
|
|
2060
|
-
}
|
|
2061
|
-
export interface TotalDraftPosts {
|
|
2062
|
-
/** Draft post totals in that group. */
|
|
2063
|
-
total?: number;
|
|
2064
|
-
/** Draft post status (only has value when grouping by status, otherwise null). */
|
|
2065
|
-
status?: StatusWithLiterals;
|
|
2066
|
-
/**
|
|
2067
|
-
* Draft post language code (only has value when grouping by language, otherwise null).
|
|
2068
|
-
* @format LANGUAGE_TAG
|
|
2069
|
-
*/
|
|
2070
|
-
language?: string | null;
|
|
2071
|
-
}
|
|
2072
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
2073
|
-
createdEvent?: EntityCreatedEvent;
|
|
2074
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2075
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2076
|
-
actionEvent?: ActionEvent;
|
|
2077
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2078
|
-
id?: string;
|
|
2079
|
-
/**
|
|
2080
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2081
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
2082
|
-
*/
|
|
2083
|
-
entityFqdn?: string;
|
|
2084
|
-
/**
|
|
2085
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2086
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
2087
|
-
*/
|
|
2088
|
-
slug?: string;
|
|
2089
|
-
/** ID of the entity associated with the event. */
|
|
2090
|
-
entityId?: string;
|
|
2091
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
2092
|
-
eventTime?: Date | null;
|
|
2093
|
-
/**
|
|
2094
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
2095
|
-
* (for example, GDPR).
|
|
2096
|
-
*/
|
|
2097
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
2098
|
-
/** If present, indicates the action that triggered the event. */
|
|
2099
|
-
originatedFrom?: string | null;
|
|
2100
|
-
/**
|
|
2101
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
2102
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
2103
|
-
*/
|
|
2104
|
-
entityEventSequence?: string | null;
|
|
2105
|
-
}
|
|
2106
|
-
/** @oneof */
|
|
2107
|
-
export interface DomainEventBodyOneOf {
|
|
2108
|
-
createdEvent?: EntityCreatedEvent;
|
|
2109
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2110
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2111
|
-
actionEvent?: ActionEvent;
|
|
2112
|
-
}
|
|
2113
|
-
export interface EntityCreatedEvent {
|
|
2114
|
-
entityAsJson?: string;
|
|
2115
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
2116
|
-
restoreInfo?: RestoreInfo;
|
|
2117
|
-
}
|
|
2118
|
-
export interface RestoreInfo {
|
|
2119
|
-
deletedDate?: Date | null;
|
|
2120
|
-
}
|
|
2121
|
-
export interface EntityUpdatedEvent {
|
|
2122
|
-
/**
|
|
2123
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2124
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2125
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2126
|
-
*/
|
|
2127
|
-
currentEntityAsJson?: string;
|
|
2128
|
-
}
|
|
2129
|
-
export interface EntityDeletedEvent {
|
|
2130
|
-
/** Entity that was deleted. */
|
|
2131
|
-
deletedEntityAsJson?: string | null;
|
|
2132
|
-
}
|
|
2133
|
-
export interface ActionEvent {
|
|
2134
|
-
bodyAsJson?: string;
|
|
2135
|
-
}
|
|
2136
|
-
export interface MessageEnvelope {
|
|
2137
|
-
/**
|
|
2138
|
-
* App instance ID.
|
|
2139
|
-
* @format GUID
|
|
2140
|
-
*/
|
|
2141
|
-
instanceId?: string | null;
|
|
2142
|
-
/**
|
|
2143
|
-
* Event type.
|
|
2144
|
-
* @maxLength 150
|
|
2145
|
-
*/
|
|
2146
|
-
eventType?: string;
|
|
2147
|
-
/** The identification type and identity data. */
|
|
2148
|
-
identity?: IdentificationData;
|
|
2149
|
-
/** Stringify payload. */
|
|
2150
|
-
data?: string;
|
|
2151
|
-
}
|
|
2152
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2153
|
-
/**
|
|
2154
|
-
* ID of a site visitor that has not logged in to the site.
|
|
2155
|
-
* @format GUID
|
|
2156
|
-
*/
|
|
2157
|
-
anonymousVisitorId?: string;
|
|
2158
|
-
/**
|
|
2159
|
-
* ID of a site visitor that has logged in to the site.
|
|
2160
|
-
* @format GUID
|
|
2161
|
-
*/
|
|
2162
|
-
memberId?: string;
|
|
2163
|
-
/**
|
|
2164
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2165
|
-
* @format GUID
|
|
2166
|
-
*/
|
|
2167
|
-
wixUserId?: string;
|
|
2168
|
-
/**
|
|
2169
|
-
* ID of an app.
|
|
2170
|
-
* @format GUID
|
|
2171
|
-
*/
|
|
2172
|
-
appId?: string;
|
|
2173
|
-
/** @readonly */
|
|
2174
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2175
|
-
}
|
|
2176
|
-
/** @oneof */
|
|
2177
|
-
export interface IdentificationDataIdOneOf {
|
|
2178
|
-
/**
|
|
2179
|
-
* ID of a site visitor that has not logged in to the site.
|
|
2180
|
-
* @format GUID
|
|
2181
|
-
*/
|
|
2182
|
-
anonymousVisitorId?: string;
|
|
2183
|
-
/**
|
|
2184
|
-
* ID of a site visitor that has logged in to the site.
|
|
2185
|
-
* @format GUID
|
|
2186
|
-
*/
|
|
2187
|
-
memberId?: string;
|
|
2188
|
-
/**
|
|
2189
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
2190
|
-
* @format GUID
|
|
2191
|
-
*/
|
|
2192
|
-
wixUserId?: string;
|
|
2193
|
-
/**
|
|
2194
|
-
* ID of an app.
|
|
2195
|
-
* @format GUID
|
|
2196
|
-
*/
|
|
2197
|
-
appId?: string;
|
|
2198
|
-
}
|
|
2199
|
-
export declare enum WebhookIdentityType {
|
|
2200
|
-
UNKNOWN = "UNKNOWN",
|
|
2201
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2202
|
-
MEMBER = "MEMBER",
|
|
2203
|
-
WIX_USER = "WIX_USER",
|
|
2204
|
-
APP = "APP"
|
|
2205
|
-
}
|
|
2206
|
-
/** @enumType */
|
|
2207
|
-
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2208
|
-
export interface InitialDraftPostsCopied {
|
|
2209
|
-
/** Number of draft posts copied. */
|
|
2210
|
-
count?: number;
|
|
2211
|
-
}
|
|
2212
|
-
export interface CreateDraftPostRequest {
|
|
1814
|
+
interface CreateDraftPostRequest {
|
|
2213
1815
|
/** Draft post to create. */
|
|
2214
1816
|
draftPost: DraftPost;
|
|
2215
1817
|
/**
|
|
@@ -2226,22 +1828,7 @@ export interface CreateDraftPostRequest {
|
|
|
2226
1828
|
*/
|
|
2227
1829
|
fieldsets?: FieldWithLiterals[];
|
|
2228
1830
|
}
|
|
2229
|
-
|
|
2230
|
-
UNKNOWN = "UNKNOWN",
|
|
2231
|
-
/** Manually saved. */
|
|
2232
|
-
MANUAL = "MANUAL",
|
|
2233
|
-
/** Triggered by autosave. */
|
|
2234
|
-
AUTO_SAVE = "AUTO_SAVE",
|
|
2235
|
-
/** Copied from template during provisioning flow. */
|
|
2236
|
-
PROVISIONING = "PROVISIONING",
|
|
2237
|
-
/** Imported from another blog. */
|
|
2238
|
-
IMPORT = "IMPORT",
|
|
2239
|
-
/** Triggered by autosave when post created by AI tool. */
|
|
2240
|
-
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
|
2241
|
-
}
|
|
2242
|
-
/** @enumType */
|
|
2243
|
-
export type TypeWithLiterals = Type | 'UNKNOWN' | 'MANUAL' | 'AUTO_SAVE' | 'PROVISIONING' | 'IMPORT' | 'AI_AUTO_SAVE';
|
|
2244
|
-
export declare enum Field {
|
|
1831
|
+
declare enum Field {
|
|
2245
1832
|
/** Unknown field. */
|
|
2246
1833
|
UNKNOWN = "UNKNOWN",
|
|
2247
1834
|
/** Includes draft post preview URL. */
|
|
@@ -2254,12 +1841,12 @@ export declare enum Field {
|
|
|
2254
1841
|
GENERATED_EXCERPT = "GENERATED_EXCERPT"
|
|
2255
1842
|
}
|
|
2256
1843
|
/** @enumType */
|
|
2257
|
-
|
|
2258
|
-
|
|
1844
|
+
type FieldWithLiterals = Field | 'UNKNOWN' | 'URL' | 'CONTENT' | 'RICH_CONTENT' | 'GENERATED_EXCERPT';
|
|
1845
|
+
interface CreateDraftPostResponse {
|
|
2259
1846
|
/** Created draft post info. */
|
|
2260
1847
|
draftPost?: DraftPost;
|
|
2261
1848
|
}
|
|
2262
|
-
|
|
1849
|
+
interface BulkCreateDraftPostsRequest {
|
|
2263
1850
|
/**
|
|
2264
1851
|
* Draft posts to create.
|
|
2265
1852
|
* @minSize 1
|
|
@@ -2278,19 +1865,19 @@ export interface BulkCreateDraftPostsRequest {
|
|
|
2278
1865
|
*/
|
|
2279
1866
|
fieldsets?: FieldWithLiterals[];
|
|
2280
1867
|
}
|
|
2281
|
-
|
|
1868
|
+
interface BulkCreateDraftPostsResponse {
|
|
2282
1869
|
/** Draft posts created by bulk action. */
|
|
2283
1870
|
results?: BulkDraftPostResult[];
|
|
2284
1871
|
/** Bulk action metadata. */
|
|
2285
1872
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2286
1873
|
}
|
|
2287
|
-
|
|
1874
|
+
interface BulkDraftPostResult {
|
|
2288
1875
|
/** Bulk actions metadata for draft post. */
|
|
2289
1876
|
itemMetadata?: ItemMetadata;
|
|
2290
1877
|
/** Optional full draft post. */
|
|
2291
1878
|
item?: DraftPost;
|
|
2292
1879
|
}
|
|
2293
|
-
|
|
1880
|
+
interface ItemMetadata {
|
|
2294
1881
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2295
1882
|
id?: string | null;
|
|
2296
1883
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
@@ -2300,7 +1887,7 @@ export interface ItemMetadata {
|
|
|
2300
1887
|
/** Details about the error in case of failure. */
|
|
2301
1888
|
error?: ApplicationError;
|
|
2302
1889
|
}
|
|
2303
|
-
|
|
1890
|
+
interface ApplicationError {
|
|
2304
1891
|
/** Error code. */
|
|
2305
1892
|
code?: string;
|
|
2306
1893
|
/** Description of the error. */
|
|
@@ -2308,7 +1895,7 @@ export interface ApplicationError {
|
|
|
2308
1895
|
/** Data related to the error. */
|
|
2309
1896
|
data?: Record<string, any> | null;
|
|
2310
1897
|
}
|
|
2311
|
-
|
|
1898
|
+
interface BulkActionMetadata {
|
|
2312
1899
|
/** Number of items that were successfully processed. */
|
|
2313
1900
|
totalSuccesses?: number;
|
|
2314
1901
|
/** Number of items that couldn't be processed. */
|
|
@@ -2316,7 +1903,7 @@ export interface BulkActionMetadata {
|
|
|
2316
1903
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
2317
1904
|
undetailedFailures?: number;
|
|
2318
1905
|
}
|
|
2319
|
-
|
|
1906
|
+
interface BulkUpdateDraftPostsRequest {
|
|
2320
1907
|
/**
|
|
2321
1908
|
* Draft posts to update.
|
|
2322
1909
|
* @minSize 1
|
|
@@ -2341,13 +1928,13 @@ export interface BulkUpdateDraftPostsRequest {
|
|
|
2341
1928
|
*/
|
|
2342
1929
|
fieldsets?: FieldWithLiterals[];
|
|
2343
1930
|
}
|
|
2344
|
-
|
|
1931
|
+
interface MaskedDraftPosts {
|
|
2345
1932
|
/** Draft post */
|
|
2346
1933
|
draftPost?: DraftPost;
|
|
2347
1934
|
/** Field mask of fields to update. */
|
|
2348
1935
|
fieldMask?: string[];
|
|
2349
1936
|
}
|
|
2350
|
-
|
|
1937
|
+
declare enum Action {
|
|
2351
1938
|
/** Update the draft post. */
|
|
2352
1939
|
UPDATE = "UPDATE",
|
|
2353
1940
|
/** Update and publish a draft post. */
|
|
@@ -2364,16 +1951,14 @@ export declare enum Action {
|
|
|
2364
1951
|
UPDATE_PUBLICATION = "UPDATE_PUBLICATION"
|
|
2365
1952
|
}
|
|
2366
1953
|
/** @enumType */
|
|
2367
|
-
|
|
2368
|
-
|
|
1954
|
+
type ActionWithLiterals = Action | 'UPDATE' | 'UPDATE_PUBLISH' | 'UPDATE_SCHEDULE' | 'UPDATE_REVERT_TO_DRAFT' | 'UPDATE_CANCEL_SCHEDULE' | 'UPDATE_REJECT' | 'UPDATE_PUBLICATION';
|
|
1955
|
+
interface BulkUpdateDraftPostsResponse {
|
|
2369
1956
|
/** Draft posts updated by bulk action. */
|
|
2370
1957
|
results?: BulkDraftPostResult[];
|
|
2371
1958
|
/** Bulk action metadata. */
|
|
2372
1959
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2373
1960
|
}
|
|
2374
|
-
|
|
2375
|
-
}
|
|
2376
|
-
export interface ListDeletedDraftPostsRequest {
|
|
1961
|
+
interface ListDeletedDraftPostsRequest {
|
|
2377
1962
|
/**
|
|
2378
1963
|
* Language filter.
|
|
2379
1964
|
*
|
|
@@ -2404,15 +1989,15 @@ export interface ListDeletedDraftPostsRequest {
|
|
|
2404
1989
|
*/
|
|
2405
1990
|
draftPostIds?: string[];
|
|
2406
1991
|
}
|
|
2407
|
-
|
|
1992
|
+
declare enum GetDraftPostsSort {
|
|
2408
1993
|
/** Sort by `editedDate` in descending order. */
|
|
2409
1994
|
EDITING_DATE_DESC = "EDITING_DATE_DESC",
|
|
2410
1995
|
/** Sort by `editedDate` in ascending order. */
|
|
2411
1996
|
EDITING_DATE_ASC = "EDITING_DATE_ASC"
|
|
2412
1997
|
}
|
|
2413
1998
|
/** @enumType */
|
|
2414
|
-
|
|
2415
|
-
|
|
1999
|
+
type GetDraftPostsSortWithLiterals = GetDraftPostsSort | 'EDITING_DATE_DESC' | 'EDITING_DATE_ASC';
|
|
2000
|
+
interface BlogPaging {
|
|
2416
2001
|
/**
|
|
2417
2002
|
* Number of items to skip in the current sort order.
|
|
2418
2003
|
*
|
|
@@ -2435,7 +2020,7 @@ export interface BlogPaging {
|
|
|
2435
2020
|
*/
|
|
2436
2021
|
cursor?: string | null;
|
|
2437
2022
|
}
|
|
2438
|
-
|
|
2023
|
+
interface ListDeletedDraftPostsResponse {
|
|
2439
2024
|
/** List of draft posts. */
|
|
2440
2025
|
draftPosts?: DraftPost[];
|
|
2441
2026
|
/**
|
|
@@ -2454,7 +2039,7 @@ export interface ListDeletedDraftPostsResponse {
|
|
|
2454
2039
|
/** Details on the paged set of results returned. */
|
|
2455
2040
|
pagingMetadata?: PagingMetadataV2;
|
|
2456
2041
|
}
|
|
2457
|
-
|
|
2042
|
+
interface MetaData {
|
|
2458
2043
|
/** Number of items returned in this response. */
|
|
2459
2044
|
count?: number;
|
|
2460
2045
|
/** Requested offset. */
|
|
@@ -2467,7 +2052,7 @@ export interface MetaData {
|
|
|
2467
2052
|
*/
|
|
2468
2053
|
cursor?: string | null;
|
|
2469
2054
|
}
|
|
2470
|
-
|
|
2055
|
+
interface PagingMetadataV2 {
|
|
2471
2056
|
/** Number of items returned in the response. */
|
|
2472
2057
|
count?: number | null;
|
|
2473
2058
|
/** Offset that was requested. */
|
|
@@ -2479,7 +2064,7 @@ export interface PagingMetadataV2 {
|
|
|
2479
2064
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
2480
2065
|
cursors?: Cursors;
|
|
2481
2066
|
}
|
|
2482
|
-
|
|
2067
|
+
interface Cursors {
|
|
2483
2068
|
/**
|
|
2484
2069
|
* Cursor pointing to next page in the list of results.
|
|
2485
2070
|
* @maxLength 2000
|
|
@@ -2491,7 +2076,7 @@ export interface Cursors {
|
|
|
2491
2076
|
*/
|
|
2492
2077
|
prev?: string | null;
|
|
2493
2078
|
}
|
|
2494
|
-
|
|
2079
|
+
interface GetDraftPostRequest {
|
|
2495
2080
|
/**
|
|
2496
2081
|
* Draft post ID.
|
|
2497
2082
|
* @maxLength 38
|
|
@@ -2505,48 +2090,11 @@ export interface GetDraftPostRequest {
|
|
|
2505
2090
|
*/
|
|
2506
2091
|
fieldsets?: FieldWithLiterals[];
|
|
2507
2092
|
}
|
|
2508
|
-
|
|
2093
|
+
interface GetDraftPostResponse {
|
|
2509
2094
|
/** Draft post info. */
|
|
2510
2095
|
draftPost?: DraftPost;
|
|
2511
2096
|
}
|
|
2512
|
-
|
|
2513
|
-
/**
|
|
2514
|
-
* DraftJs content to update.
|
|
2515
|
-
* @maxLength 400000
|
|
2516
|
-
*/
|
|
2517
|
-
content?: string;
|
|
2518
|
-
/** Draft Post rich content. */
|
|
2519
|
-
richContent?: RichContent;
|
|
2520
|
-
/**
|
|
2521
|
-
* Draft post ID.
|
|
2522
|
-
* @maxLength 38
|
|
2523
|
-
*/
|
|
2524
|
-
draftPostId?: string;
|
|
2525
|
-
/** Change origin. */
|
|
2526
|
-
changeOrigin?: OriginWithLiterals;
|
|
2527
|
-
/**
|
|
2528
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
2529
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
2530
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2531
|
-
* @maxSize 10
|
|
2532
|
-
*/
|
|
2533
|
-
fieldsets?: FieldWithLiterals[];
|
|
2534
|
-
}
|
|
2535
|
-
/** @oneof */
|
|
2536
|
-
export interface UpdateDraftPostContentRequestDraftContentOneOf {
|
|
2537
|
-
/**
|
|
2538
|
-
* DraftJs content to update.
|
|
2539
|
-
* @maxLength 400000
|
|
2540
|
-
*/
|
|
2541
|
-
content?: string;
|
|
2542
|
-
/** Draft Post rich content. */
|
|
2543
|
-
richContent?: RichContent;
|
|
2544
|
-
}
|
|
2545
|
-
export interface UpdateDraftPostContentResponse {
|
|
2546
|
-
/** Updated draft post info. */
|
|
2547
|
-
draftPost?: DraftPost;
|
|
2548
|
-
}
|
|
2549
|
-
export interface UpdateDraftPostRequest {
|
|
2097
|
+
interface UpdateDraftPostRequest {
|
|
2550
2098
|
/** Draft post to update. */
|
|
2551
2099
|
draftPost: DraftPost;
|
|
2552
2100
|
/**
|
|
@@ -2565,11 +2113,11 @@ export interface UpdateDraftPostRequest {
|
|
|
2565
2113
|
*/
|
|
2566
2114
|
fieldsets?: FieldWithLiterals[];
|
|
2567
2115
|
}
|
|
2568
|
-
|
|
2116
|
+
interface UpdateDraftPostResponse {
|
|
2569
2117
|
/** Updated draft post info. */
|
|
2570
2118
|
draftPost?: DraftPost;
|
|
2571
2119
|
}
|
|
2572
|
-
|
|
2120
|
+
interface DeleteDraftPostRequest {
|
|
2573
2121
|
/**
|
|
2574
2122
|
* Draft post ID.
|
|
2575
2123
|
* @maxLength 38
|
|
@@ -2582,18 +2130,18 @@ export interface DeleteDraftPostRequest {
|
|
|
2582
2130
|
*/
|
|
2583
2131
|
permanent?: boolean;
|
|
2584
2132
|
}
|
|
2585
|
-
|
|
2133
|
+
interface DeleteDraftPostResponse {
|
|
2586
2134
|
}
|
|
2587
|
-
|
|
2135
|
+
interface RemoveFromTrashBinRequest {
|
|
2588
2136
|
/**
|
|
2589
2137
|
* Draft post ID.
|
|
2590
2138
|
* @maxLength 38
|
|
2591
2139
|
*/
|
|
2592
2140
|
draftPostId: string;
|
|
2593
2141
|
}
|
|
2594
|
-
|
|
2142
|
+
interface RemoveFromTrashBinResponse {
|
|
2595
2143
|
}
|
|
2596
|
-
|
|
2144
|
+
interface BulkDeleteDraftPostsRequest {
|
|
2597
2145
|
/**
|
|
2598
2146
|
* Post IDs.
|
|
2599
2147
|
* @minSize 1
|
|
@@ -2604,13 +2152,13 @@ export interface BulkDeleteDraftPostsRequest {
|
|
|
2604
2152
|
/** Should delete bypassing the trash-bin. */
|
|
2605
2153
|
permanent?: boolean;
|
|
2606
2154
|
}
|
|
2607
|
-
|
|
2155
|
+
interface BulkDeleteDraftPostsResponse {
|
|
2608
2156
|
/** Bulk action results. */
|
|
2609
2157
|
results?: BulkDraftPostResult[];
|
|
2610
2158
|
/** Bulk action metadata. */
|
|
2611
2159
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2612
2160
|
}
|
|
2613
|
-
|
|
2161
|
+
interface ListDraftPostsRequest {
|
|
2614
2162
|
/**
|
|
2615
2163
|
* Draft post status filter.
|
|
2616
2164
|
*
|
|
@@ -2641,35 +2189,35 @@ export interface ListDraftPostsRequest {
|
|
|
2641
2189
|
*/
|
|
2642
2190
|
fieldsets?: FieldWithLiterals[];
|
|
2643
2191
|
}
|
|
2644
|
-
|
|
2192
|
+
interface ListDraftPostsResponse {
|
|
2645
2193
|
/** List of draft posts. */
|
|
2646
2194
|
draftPosts?: DraftPost[];
|
|
2647
2195
|
/** Details on the paged set of results returned. */
|
|
2648
2196
|
metaData?: MetaData;
|
|
2649
2197
|
}
|
|
2650
|
-
|
|
2198
|
+
interface GetDeletedDraftPostRequest {
|
|
2651
2199
|
/**
|
|
2652
2200
|
* Draft post ID.
|
|
2653
2201
|
* @maxLength 38
|
|
2654
2202
|
*/
|
|
2655
2203
|
draftPostId: string;
|
|
2656
2204
|
}
|
|
2657
|
-
|
|
2205
|
+
interface GetDeletedDraftPostResponse {
|
|
2658
2206
|
/** Draft post info. */
|
|
2659
2207
|
draftPost?: DraftPost;
|
|
2660
2208
|
}
|
|
2661
|
-
|
|
2209
|
+
interface RestoreFromTrashBinRequest {
|
|
2662
2210
|
/**
|
|
2663
2211
|
* Draft post ID.
|
|
2664
2212
|
* @maxLength 38
|
|
2665
2213
|
*/
|
|
2666
2214
|
draftPostId: string;
|
|
2667
2215
|
}
|
|
2668
|
-
|
|
2216
|
+
interface RestoreFromTrashBinResponse {
|
|
2669
2217
|
/** Restored draft post info. */
|
|
2670
2218
|
draftPost?: DraftPost;
|
|
2671
2219
|
}
|
|
2672
|
-
|
|
2220
|
+
interface QueryDraftPostsRequest {
|
|
2673
2221
|
/**
|
|
2674
2222
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
2675
2223
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
@@ -2680,7 +2228,7 @@ export interface QueryDraftPostsRequest {
|
|
|
2680
2228
|
/** Query options. */
|
|
2681
2229
|
query?: PlatformQuery;
|
|
2682
2230
|
}
|
|
2683
|
-
|
|
2231
|
+
interface Sorting {
|
|
2684
2232
|
/**
|
|
2685
2233
|
* Name of the field to sort by.
|
|
2686
2234
|
* @maxLength 512
|
|
@@ -2689,13 +2237,13 @@ export interface Sorting {
|
|
|
2689
2237
|
/** Sort order. */
|
|
2690
2238
|
order?: SortOrderWithLiterals;
|
|
2691
2239
|
}
|
|
2692
|
-
|
|
2240
|
+
declare enum SortOrder {
|
|
2693
2241
|
ASC = "ASC",
|
|
2694
2242
|
DESC = "DESC"
|
|
2695
2243
|
}
|
|
2696
2244
|
/** @enumType */
|
|
2697
|
-
|
|
2698
|
-
|
|
2245
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
2246
|
+
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
2699
2247
|
/** Paging options to limit and skip the number of items. */
|
|
2700
2248
|
paging?: Paging;
|
|
2701
2249
|
/** 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`. */
|
|
@@ -2717,13 +2265,13 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
|
2717
2265
|
sort?: Sorting[];
|
|
2718
2266
|
}
|
|
2719
2267
|
/** @oneof */
|
|
2720
|
-
|
|
2268
|
+
interface PlatformQueryPagingMethodOneOf {
|
|
2721
2269
|
/** Paging options to limit and skip the number of items. */
|
|
2722
2270
|
paging?: Paging;
|
|
2723
2271
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
2724
2272
|
cursorPaging?: CursorPaging;
|
|
2725
2273
|
}
|
|
2726
|
-
|
|
2274
|
+
interface Paging {
|
|
2727
2275
|
/**
|
|
2728
2276
|
* Number of items to load.
|
|
2729
2277
|
* @max 100
|
|
@@ -2732,7 +2280,7 @@ export interface Paging {
|
|
|
2732
2280
|
/** Number of items to skip in the current sort order. */
|
|
2733
2281
|
offset?: number | null;
|
|
2734
2282
|
}
|
|
2735
|
-
|
|
2283
|
+
interface CursorPaging {
|
|
2736
2284
|
/**
|
|
2737
2285
|
* Number of items to load.
|
|
2738
2286
|
* @max 100
|
|
@@ -2748,374 +2296,64 @@ export interface CursorPaging {
|
|
|
2748
2296
|
*/
|
|
2749
2297
|
cursor?: string | null;
|
|
2750
2298
|
}
|
|
2751
|
-
|
|
2299
|
+
interface QueryDraftPostsResponse {
|
|
2752
2300
|
/** List of posts. */
|
|
2753
2301
|
draftPosts?: DraftPost[];
|
|
2754
2302
|
/** Details on the paged set of results returned. */
|
|
2755
2303
|
pagingMetadata?: PagingMetadataV2;
|
|
2756
2304
|
}
|
|
2757
|
-
|
|
2305
|
+
interface PublishDraftPostRequest {
|
|
2758
2306
|
/**
|
|
2759
2307
|
* Draft post ID.
|
|
2760
2308
|
* @maxLength 38
|
|
2761
2309
|
*/
|
|
2762
2310
|
draftPostId: string;
|
|
2763
2311
|
}
|
|
2764
|
-
|
|
2312
|
+
interface PublishDraftPostResponse {
|
|
2765
2313
|
/**
|
|
2766
2314
|
* Published post ID.
|
|
2767
2315
|
* @format GUID
|
|
2768
2316
|
*/
|
|
2769
2317
|
postId?: string;
|
|
2770
2318
|
}
|
|
2771
|
-
|
|
2772
|
-
|
|
2773
|
-
|
|
2774
|
-
|
|
2775
|
-
|
|
2776
|
-
|
|
2777
|
-
|
|
2778
|
-
|
|
2779
|
-
|
|
2780
|
-
|
|
2781
|
-
|
|
2782
|
-
|
|
2783
|
-
|
|
2784
|
-
|
|
2785
|
-
|
|
2786
|
-
|
|
2787
|
-
|
|
2788
|
-
|
|
2789
|
-
|
|
2790
|
-
|
|
2791
|
-
}
|
|
2792
|
-
|
|
2793
|
-
|
|
2794
|
-
|
|
2795
|
-
|
|
2796
|
-
|
|
2797
|
-
}
|
|
2798
|
-
|
|
2799
|
-
|
|
2800
|
-
|
|
2801
|
-
|
|
2802
|
-
|
|
2803
|
-
|
|
2804
|
-
|
|
2805
|
-
|
|
2806
|
-
|
|
2807
|
-
|
|
2808
|
-
|
|
2809
|
-
|
|
2810
|
-
|
|
2811
|
-
|
|
2812
|
-
* @readonly
|
|
2813
|
-
*/
|
|
2814
|
-
postCount?: number;
|
|
2815
|
-
/**
|
|
2816
|
-
* The `url` of the page that lists every post with the specified category.
|
|
2817
|
-
* @readonly
|
|
2818
|
-
*/
|
|
2819
|
-
url?: PageUrl;
|
|
2820
|
-
/**
|
|
2821
|
-
* Category description.
|
|
2822
|
-
* @maxLength 500
|
|
2823
|
-
*/
|
|
2824
|
-
description?: string | null;
|
|
2825
|
-
/**
|
|
2826
|
-
* Category title.
|
|
2827
|
-
* @maxLength 200
|
|
2828
|
-
* @deprecated Category title.
|
|
2829
|
-
* @targetRemovalDate 2025-07-16
|
|
2830
|
-
*/
|
|
2831
|
-
title?: string;
|
|
2832
|
-
/**
|
|
2833
|
-
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
|
|
2834
|
-
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
|
|
2835
|
-
*
|
|
2836
|
-
* Default: `-1`
|
|
2837
|
-
*/
|
|
2838
|
-
displayPosition?: number | null;
|
|
2839
|
-
/**
|
|
2840
|
-
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
|
2841
|
-
* @format GUID
|
|
2842
|
-
*/
|
|
2843
|
-
translationId?: string | null;
|
|
2844
|
-
/**
|
|
2845
|
-
* Category language.
|
|
2846
|
-
*
|
|
2847
|
-
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2848
|
-
* @immutable
|
|
2849
|
-
*/
|
|
2850
|
-
language?: string | null;
|
|
2851
|
-
/**
|
|
2852
|
-
* Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`.
|
|
2853
|
-
* @maxLength 100
|
|
2854
|
-
*/
|
|
2855
|
-
slug?: string;
|
|
2856
|
-
/** SEO data. */
|
|
2857
|
-
seoData?: SeoSchema;
|
|
2858
|
-
/** Category cover image. */
|
|
2859
|
-
coverImage?: Image;
|
|
2860
|
-
/**
|
|
2861
|
-
* Date and time the Category was last updated.
|
|
2862
|
-
* @readonly
|
|
2863
|
-
*/
|
|
2864
|
-
updatedDate?: Date | null;
|
|
2865
|
-
}
|
|
2866
|
-
export interface CategoryTranslation {
|
|
2867
|
-
/**
|
|
2868
|
-
* Category ID.
|
|
2869
|
-
* @format GUID
|
|
2870
|
-
*/
|
|
2871
|
-
id?: string;
|
|
2872
|
-
/**
|
|
2873
|
-
* Label displayed in the categories menu on the site.
|
|
2874
|
-
* @maxLength 100
|
|
2875
|
-
*/
|
|
2876
|
-
label?: string | null;
|
|
2877
|
-
/**
|
|
2878
|
-
* Language of the category.
|
|
2879
|
-
* @format LANGUAGE_TAG
|
|
2880
|
-
*/
|
|
2881
|
-
language?: string | null;
|
|
2882
|
-
/** URL of this category page. */
|
|
2883
|
-
url?: PageUrl;
|
|
2884
|
-
}
|
|
2885
|
-
export interface TranslateDraftRequest {
|
|
2886
|
-
/**
|
|
2887
|
-
* Source post or draft ID
|
|
2888
|
-
* @format GUID
|
|
2889
|
-
*/
|
|
2890
|
-
postId?: string;
|
|
2891
|
-
/**
|
|
2892
|
-
* Translation language
|
|
2893
|
-
* @format LANGUAGE_TAG
|
|
2894
|
-
*/
|
|
2895
|
-
language?: string;
|
|
2896
|
-
/**
|
|
2897
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
2898
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
2899
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2900
|
-
* @maxSize 10
|
|
2901
|
-
*/
|
|
2902
|
-
fieldsets?: FieldWithLiterals[];
|
|
2903
|
-
}
|
|
2904
|
-
export interface TranslateDraftResponse {
|
|
2905
|
-
/** Draft post. */
|
|
2906
|
-
draftPost?: DraftPost;
|
|
2907
|
-
}
|
|
2908
|
-
export interface IsDraftPostAutoTranslatableRequest {
|
|
2909
|
-
/**
|
|
2910
|
-
* Source post or draft ID.
|
|
2911
|
-
* @format GUID
|
|
2912
|
-
*/
|
|
2913
|
-
draftPostId?: string;
|
|
2914
|
-
}
|
|
2915
|
-
export interface IsDraftPostAutoTranslatableResponse {
|
|
2916
|
-
/**
|
|
2917
|
-
* Source draft post ID.
|
|
2918
|
-
* @format GUID
|
|
2919
|
-
*/
|
|
2920
|
-
draftPostId?: string;
|
|
2921
|
-
/** Indicates if enough machine translation credits are available for the draft post translation. */
|
|
2922
|
-
translatable?: boolean;
|
|
2923
|
-
/** Draft post title word count. */
|
|
2924
|
-
titleWordCount?: number;
|
|
2925
|
-
/** Draft post content word count. */
|
|
2926
|
-
contentWordCount?: number;
|
|
2927
|
-
/** Word credits available for auto translation. */
|
|
2928
|
-
availableAutoTranslateWords?: number;
|
|
2929
|
-
/** Word credits available after auto translation would be done. */
|
|
2930
|
-
availableAutoTranslateWordsAfter?: number;
|
|
2931
|
-
/** Content text character count. */
|
|
2932
|
-
contentTextCharacterCount?: number;
|
|
2933
|
-
}
|
|
2934
|
-
export interface UpdateDraftPostLanguageRequest {
|
|
2935
|
-
/**
|
|
2936
|
-
* Source draft post ID
|
|
2937
|
-
* @format GUID
|
|
2938
|
-
*/
|
|
2939
|
-
postId?: string;
|
|
2940
|
-
/**
|
|
2941
|
-
* New language to replace to
|
|
2942
|
-
* @minLength 2
|
|
2943
|
-
* @format LANGUAGE_TAG
|
|
2944
|
-
*/
|
|
2945
|
-
language?: string;
|
|
2946
|
-
/**
|
|
2947
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
2948
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
2949
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2950
|
-
* @maxSize 10
|
|
2951
|
-
*/
|
|
2952
|
-
fieldsets?: FieldWithLiterals[];
|
|
2953
|
-
}
|
|
2954
|
-
export interface UpdateDraftPostLanguageResponse {
|
|
2955
|
-
/** Draft post */
|
|
2956
|
-
draftPost?: DraftPost;
|
|
2957
|
-
}
|
|
2958
|
-
export interface BulkUpdateDraftPostLanguageRequest {
|
|
2959
|
-
/**
|
|
2960
|
-
* Source post or draft IDs
|
|
2961
|
-
* @maxSize 50
|
|
2962
|
-
* @format GUID
|
|
2963
|
-
*/
|
|
2964
|
-
ids?: string[];
|
|
2965
|
-
/**
|
|
2966
|
-
* New language to replace to
|
|
2967
|
-
* @format LANGUAGE_TAG
|
|
2968
|
-
*/
|
|
2969
|
-
language?: string;
|
|
2970
|
-
/** Should full draft post be returned */
|
|
2971
|
-
returnFullEntity?: boolean;
|
|
2972
|
-
/**
|
|
2973
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
2974
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
2975
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2976
|
-
* @maxSize 10
|
|
2977
|
-
*/
|
|
2978
|
-
fieldsets?: FieldWithLiterals[];
|
|
2979
|
-
}
|
|
2980
|
-
export interface BulkUpdateDraftPostLanguageResponse {
|
|
2981
|
-
/** Bulk action results */
|
|
2982
|
-
results?: BulkDraftPostResult[];
|
|
2983
|
-
/** Bulk action metadata */
|
|
2984
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2985
|
-
}
|
|
2986
|
-
export interface GetPostAmountsByLanguageRequest {
|
|
2987
|
-
/**
|
|
2988
|
-
* Post status to filter by
|
|
2989
|
-
* @maxLength 100
|
|
2990
|
-
*/
|
|
2991
|
-
status?: string;
|
|
2992
|
-
}
|
|
2993
|
-
export interface GetPostAmountsByLanguageResponse {
|
|
2994
|
-
/** Post amounts by language */
|
|
2995
|
-
postAmountsByLanguage?: PostAmountByLanguage[];
|
|
2996
|
-
}
|
|
2997
|
-
export interface PostAmountByLanguage {
|
|
2998
|
-
/**
|
|
2999
|
-
* Post language code
|
|
3000
|
-
* @format LANGUAGE_TAG
|
|
3001
|
-
*/
|
|
3002
|
-
languageCode?: string;
|
|
3003
|
-
/**
|
|
3004
|
-
* Language flag
|
|
3005
|
-
* @format LANGUAGE_TAG
|
|
3006
|
-
*/
|
|
3007
|
-
flag?: string;
|
|
3008
|
-
/** Post amount in that language */
|
|
3009
|
-
postAmount?: number;
|
|
3010
|
-
}
|
|
3011
|
-
export interface BulkRevertToUnpublishedRequest {
|
|
3012
|
-
/**
|
|
3013
|
-
* Source post IDs.
|
|
3014
|
-
* @minSize 1
|
|
3015
|
-
* @maxSize 100
|
|
3016
|
-
* @format GUID
|
|
3017
|
-
*/
|
|
3018
|
-
postIds?: string[];
|
|
3019
|
-
/** Should full draft post be returned. */
|
|
3020
|
-
returnFullEntity?: boolean;
|
|
3021
|
-
}
|
|
3022
|
-
export interface BulkRevertToUnpublishedResponse {
|
|
3023
|
-
/** Bulk action results. */
|
|
3024
|
-
results?: BulkDraftPostResult[];
|
|
3025
|
-
/** Bulk action metadata. */
|
|
3026
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
3027
|
-
}
|
|
3028
|
-
export interface BulkRejectDraftPostRequest {
|
|
3029
|
-
/**
|
|
3030
|
-
* Source post IDs.
|
|
3031
|
-
* @minSize 1
|
|
3032
|
-
* @maxSize 100
|
|
3033
|
-
* @format GUID
|
|
3034
|
-
*/
|
|
3035
|
-
postIds?: string[];
|
|
3036
|
-
/** Should full draft post be returned. */
|
|
3037
|
-
returnFullEntity?: boolean;
|
|
3038
|
-
}
|
|
3039
|
-
export interface BulkRejectDraftPostResponse {
|
|
3040
|
-
/** Bulk action results. */
|
|
3041
|
-
results?: BulkDraftPostResult[];
|
|
3042
|
-
/** Bulk action metadata. */
|
|
3043
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
3044
|
-
}
|
|
3045
|
-
export interface RevertToUnpublishedRequest {
|
|
3046
|
-
/**
|
|
3047
|
-
* Source post ID.
|
|
3048
|
-
* @format GUID
|
|
3049
|
-
*/
|
|
3050
|
-
postId?: string;
|
|
3051
|
-
/**
|
|
3052
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
3053
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
3054
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
3055
|
-
* @maxSize 10
|
|
3056
|
-
*/
|
|
3057
|
-
fieldsets?: FieldWithLiterals[];
|
|
3058
|
-
}
|
|
3059
|
-
export interface RevertToUnpublishedResponse {
|
|
3060
|
-
/** Updated post draft. */
|
|
3061
|
-
draftPost?: DraftPost;
|
|
3062
|
-
}
|
|
3063
|
-
export interface RejectDraftPostRequest {
|
|
3064
|
-
/**
|
|
3065
|
-
* Source post ID.
|
|
3066
|
-
* @format GUID
|
|
3067
|
-
*/
|
|
3068
|
-
postId?: string;
|
|
3069
|
-
/**
|
|
3070
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
3071
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
3072
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
3073
|
-
* @maxSize 10
|
|
3074
|
-
*/
|
|
3075
|
-
fieldsets?: FieldWithLiterals[];
|
|
3076
|
-
}
|
|
3077
|
-
export interface RejectDraftPostResponse {
|
|
3078
|
-
/** Draft post. */
|
|
3079
|
-
draftPost?: DraftPost;
|
|
3080
|
-
}
|
|
3081
|
-
export interface ApproveDraftPostRequest {
|
|
3082
|
-
/**
|
|
3083
|
-
* Source post ID.
|
|
3084
|
-
* @format GUID
|
|
3085
|
-
*/
|
|
3086
|
-
postId?: string;
|
|
3087
|
-
/**
|
|
3088
|
-
* Scheduled publish date if should be not immediately published.
|
|
3089
|
-
* @maxLength 24
|
|
3090
|
-
*/
|
|
3091
|
-
scheduledPublishDate?: string | null;
|
|
3092
|
-
/**
|
|
3093
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
3094
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
3095
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
3096
|
-
* @maxSize 10
|
|
3097
|
-
*/
|
|
3098
|
-
fieldsets?: FieldWithLiterals[];
|
|
3099
|
-
}
|
|
3100
|
-
export interface ApproveDraftPostResponse {
|
|
3101
|
-
/** Updated post draft. */
|
|
3102
|
-
draftPost?: DraftPost;
|
|
3103
|
-
}
|
|
3104
|
-
export interface MarkPostAsInModerationRequest {
|
|
3105
|
-
/**
|
|
3106
|
-
* Source post ID.
|
|
3107
|
-
* @maxLength 38
|
|
3108
|
-
*/
|
|
3109
|
-
postId?: string;
|
|
3110
|
-
/**
|
|
3111
|
-
* List of draft post fields to be included if entities are present in the response.
|
|
3112
|
-
* Base fieldset, which is default, will return all core draft post properties.
|
|
3113
|
-
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
3114
|
-
* @maxSize 10
|
|
3115
|
-
*/
|
|
3116
|
-
fieldsets?: FieldWithLiterals[];
|
|
3117
|
-
}
|
|
3118
|
-
export interface MarkPostAsInModerationResponse {
|
|
3119
|
-
/** Updated post draft. */
|
|
3120
|
-
draftPost?: DraftPost;
|
|
3121
|
-
}
|
|
2319
|
+
|
|
2320
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
2321
|
+
getUrl: (context: any) => string;
|
|
2322
|
+
httpMethod: K;
|
|
2323
|
+
path: string;
|
|
2324
|
+
pathParams: M;
|
|
2325
|
+
__requestType: T;
|
|
2326
|
+
__originalRequestType: S;
|
|
2327
|
+
__responseType: Q;
|
|
2328
|
+
__originalResponseType: R;
|
|
2329
|
+
};
|
|
2330
|
+
declare function createDraftPost(): __PublicMethodMetaInfo<'POST', {}, CreateDraftPostRequest$1, CreateDraftPostRequest, CreateDraftPostResponse$1, CreateDraftPostResponse>;
|
|
2331
|
+
declare function bulkCreateDraftPosts(): __PublicMethodMetaInfo<'POST', {}, BulkCreateDraftPostsRequest$1, BulkCreateDraftPostsRequest, BulkCreateDraftPostsResponse$1, BulkCreateDraftPostsResponse>;
|
|
2332
|
+
declare function bulkUpdateDraftPosts(): __PublicMethodMetaInfo<'PATCH', {}, BulkUpdateDraftPostsRequest$1, BulkUpdateDraftPostsRequest, BulkUpdateDraftPostsResponse$1, BulkUpdateDraftPostsResponse>;
|
|
2333
|
+
declare function listDeletedDraftPosts(): __PublicMethodMetaInfo<'GET', {}, ListDeletedDraftPostsRequest$1, ListDeletedDraftPostsRequest, ListDeletedDraftPostsResponse$1, ListDeletedDraftPostsResponse>;
|
|
2334
|
+
declare function getDraftPost(): __PublicMethodMetaInfo<'GET', {
|
|
2335
|
+
draftPostId: string;
|
|
2336
|
+
}, GetDraftPostRequest$1, GetDraftPostRequest, GetDraftPostResponse$1, GetDraftPostResponse>;
|
|
2337
|
+
declare function updateDraftPost(): __PublicMethodMetaInfo<'PATCH', {
|
|
2338
|
+
draftPostId: string;
|
|
2339
|
+
}, UpdateDraftPostRequest$1, UpdateDraftPostRequest, UpdateDraftPostResponse$1, UpdateDraftPostResponse>;
|
|
2340
|
+
declare function deleteDraftPost(): __PublicMethodMetaInfo<'DELETE', {
|
|
2341
|
+
draftPostId: string;
|
|
2342
|
+
}, DeleteDraftPostRequest$1, DeleteDraftPostRequest, DeleteDraftPostResponse$1, DeleteDraftPostResponse>;
|
|
2343
|
+
declare function removeFromTrashBin(): __PublicMethodMetaInfo<'DELETE', {
|
|
2344
|
+
draftPostId: string;
|
|
2345
|
+
}, RemoveFromTrashBinRequest$1, RemoveFromTrashBinRequest, RemoveFromTrashBinResponse$1, RemoveFromTrashBinResponse>;
|
|
2346
|
+
declare function bulkDeleteDraftPosts(): __PublicMethodMetaInfo<'DELETE', {}, BulkDeleteDraftPostsRequest$1, BulkDeleteDraftPostsRequest, BulkDeleteDraftPostsResponse$1, BulkDeleteDraftPostsResponse>;
|
|
2347
|
+
declare function listDraftPosts(): __PublicMethodMetaInfo<'GET', {}, ListDraftPostsRequest$1, ListDraftPostsRequest, ListDraftPostsResponse$1, ListDraftPostsResponse>;
|
|
2348
|
+
declare function getDeletedDraftPost(): __PublicMethodMetaInfo<'GET', {
|
|
2349
|
+
draftPostId: string;
|
|
2350
|
+
}, GetDeletedDraftPostRequest$1, GetDeletedDraftPostRequest, GetDeletedDraftPostResponse$1, GetDeletedDraftPostResponse>;
|
|
2351
|
+
declare function restoreFromTrashBin(): __PublicMethodMetaInfo<'POST', {
|
|
2352
|
+
draftPostId: string;
|
|
2353
|
+
}, RestoreFromTrashBinRequest$1, RestoreFromTrashBinRequest, RestoreFromTrashBinResponse$1, RestoreFromTrashBinResponse>;
|
|
2354
|
+
declare function queryDraftPosts(): __PublicMethodMetaInfo<'POST', {}, QueryDraftPostsRequest$1, QueryDraftPostsRequest, QueryDraftPostsResponse$1, QueryDraftPostsResponse>;
|
|
2355
|
+
declare function publishDraftPost(): __PublicMethodMetaInfo<'POST', {
|
|
2356
|
+
draftPostId: string;
|
|
2357
|
+
}, PublishDraftPostRequest$1, PublishDraftPostRequest, PublishDraftPostResponse$1, PublishDraftPostResponse>;
|
|
2358
|
+
|
|
2359
|
+
export { type __PublicMethodMetaInfo, bulkCreateDraftPosts, bulkDeleteDraftPosts, bulkUpdateDraftPosts, createDraftPost, deleteDraftPost, getDeletedDraftPost, getDraftPost, listDeletedDraftPosts, listDraftPosts, publishDraftPost, queryDraftPosts, removeFromTrashBin, restoreFromTrashBin, updateDraftPost };
|