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