@wix/auto_sdk_members_members-about 1.0.19 → 1.0.21
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 +92 -1
- package/build/cjs/index.js +1199 -15
- package/build/cjs/index.js.map +1 -1
- package/build/{internal/cjs/src/members-about-v2-member-about-members-about.universal.d.ts → cjs/members-about-v2-member-about-members-about.universal-35AgPK6C.d.ts} +195 -383
- package/build/cjs/meta.d.ts +1640 -1
- package/build/cjs/meta.js +621 -15
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +92 -0
- package/build/es/index.mjs +1138 -0
- package/build/es/index.mjs.map +1 -0
- package/build/{cjs/src/members-about-v2-member-about-members-about.universal.d.ts → es/members-about-v2-member-about-members-about.universal-35AgPK6C.d.mts} +195 -383
- package/build/{cjs/src/members-about-v2-member-about-members-about.types.d.ts → es/meta.d.mts} +198 -328
- package/build/es/meta.mjs +592 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/internal/cjs/index.d.ts +92 -1
- package/build/internal/cjs/index.js +1199 -15
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/{es/src/members-about-v2-member-about-members-about.universal.d.ts → cjs/members-about-v2-member-about-members-about.universal-35AgPK6C.d.ts} +195 -383
- package/build/internal/cjs/meta.d.ts +1640 -1
- package/build/internal/cjs/meta.js +621 -15
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +92 -0
- package/build/internal/es/index.mjs +1138 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/{es/src/members-about-v2-member-about-members-about.universal.d.ts → internal/es/members-about-v2-member-about-members-about.universal-35AgPK6C.d.mts} +195 -383
- package/build/internal/{cjs/src/members-about-v2-member-about-members-about.types.d.ts → es/meta.d.mts} +198 -328
- package/build/internal/es/meta.mjs +592 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +10 -9
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/src/members-about-v2-member-about-members-about.context.d.ts +0 -26
- package/build/cjs/src/members-about-v2-member-about-members-about.context.js +0 -61
- package/build/cjs/src/members-about-v2-member-about-members-about.context.js.map +0 -1
- package/build/cjs/src/members-about-v2-member-about-members-about.http.d.ts +0 -34
- package/build/cjs/src/members-about-v2-member-about-members-about.http.js +0 -509
- package/build/cjs/src/members-about-v2-member-about-members-about.http.js.map +0 -1
- package/build/cjs/src/members-about-v2-member-about-members-about.meta.d.ts +0 -24
- package/build/cjs/src/members-about-v2-member-about-members-about.meta.js +0 -142
- package/build/cjs/src/members-about-v2-member-about-members-about.meta.js.map +0 -1
- package/build/cjs/src/members-about-v2-member-about-members-about.public.d.ts +0 -73
- package/build/cjs/src/members-about-v2-member-about-members-about.public.js +0 -200
- package/build/cjs/src/members-about-v2-member-about-members-about.public.js.map +0 -1
- package/build/cjs/src/members-about-v2-member-about-members-about.types.js +0 -327
- package/build/cjs/src/members-about-v2-member-about-members-about.types.js.map +0 -1
- package/build/cjs/src/members-about-v2-member-about-members-about.universal.js +0 -634
- package/build/cjs/src/members-about-v2-member-about-members-about.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/members-about-v2-member-about-members-about.context.d.ts +0 -26
- package/build/es/src/members-about-v2-member-about-members-about.context.js +0 -26
- package/build/es/src/members-about-v2-member-about-members-about.context.js.map +0 -1
- package/build/es/src/members-about-v2-member-about-members-about.http.d.ts +0 -34
- package/build/es/src/members-about-v2-member-about-members-about.http.js +0 -500
- package/build/es/src/members-about-v2-member-about-members-about.http.js.map +0 -1
- package/build/es/src/members-about-v2-member-about-members-about.meta.d.ts +0 -24
- package/build/es/src/members-about-v2-member-about-members-about.meta.js +0 -110
- package/build/es/src/members-about-v2-member-about-members-about.meta.js.map +0 -1
- package/build/es/src/members-about-v2-member-about-members-about.public.d.ts +0 -73
- package/build/es/src/members-about-v2-member-about-members-about.public.js +0 -159
- package/build/es/src/members-about-v2-member-about-members-about.public.js.map +0 -1
- package/build/es/src/members-about-v2-member-about-members-about.types.d.ts +0 -1770
- package/build/es/src/members-about-v2-member-about-members-about.types.js +0 -324
- package/build/es/src/members-about-v2-member-about-members-about.types.js.map +0 -1
- package/build/es/src/members-about-v2-member-about-members-about.universal.js +0 -602
- package/build/es/src/members-about-v2-member-about-members-about.universal.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/src/members-about-v2-member-about-members-about.context.d.ts +0 -26
- package/build/internal/cjs/src/members-about-v2-member-about-members-about.context.js +0 -61
- package/build/internal/cjs/src/members-about-v2-member-about-members-about.context.js.map +0 -1
- package/build/internal/cjs/src/members-about-v2-member-about-members-about.http.d.ts +0 -34
- package/build/internal/cjs/src/members-about-v2-member-about-members-about.http.js +0 -509
- package/build/internal/cjs/src/members-about-v2-member-about-members-about.http.js.map +0 -1
- package/build/internal/cjs/src/members-about-v2-member-about-members-about.meta.d.ts +0 -24
- package/build/internal/cjs/src/members-about-v2-member-about-members-about.meta.js +0 -142
- package/build/internal/cjs/src/members-about-v2-member-about-members-about.meta.js.map +0 -1
- package/build/internal/cjs/src/members-about-v2-member-about-members-about.public.d.ts +0 -73
- package/build/internal/cjs/src/members-about-v2-member-about-members-about.public.js +0 -200
- package/build/internal/cjs/src/members-about-v2-member-about-members-about.public.js.map +0 -1
- package/build/internal/cjs/src/members-about-v2-member-about-members-about.types.js +0 -327
- package/build/internal/cjs/src/members-about-v2-member-about-members-about.types.js.map +0 -1
- package/build/internal/cjs/src/members-about-v2-member-about-members-about.universal.js +0 -634
- package/build/internal/cjs/src/members-about-v2-member-about-members-about.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/members-about-v2-member-about-members-about.context.d.ts +0 -26
- package/build/internal/es/src/members-about-v2-member-about-members-about.context.js +0 -26
- package/build/internal/es/src/members-about-v2-member-about-members-about.context.js.map +0 -1
- package/build/internal/es/src/members-about-v2-member-about-members-about.http.d.ts +0 -34
- package/build/internal/es/src/members-about-v2-member-about-members-about.http.js +0 -500
- package/build/internal/es/src/members-about-v2-member-about-members-about.http.js.map +0 -1
- package/build/internal/es/src/members-about-v2-member-about-members-about.meta.d.ts +0 -24
- package/build/internal/es/src/members-about-v2-member-about-members-about.meta.js +0 -110
- package/build/internal/es/src/members-about-v2-member-about-members-about.meta.js.map +0 -1
- package/build/internal/es/src/members-about-v2-member-about-members-about.public.d.ts +0 -73
- package/build/internal/es/src/members-about-v2-member-about-members-about.public.js +0 -159
- package/build/internal/es/src/members-about-v2-member-about-members-about.public.js.map +0 -1
- package/build/internal/es/src/members-about-v2-member-about-members-about.types.d.ts +0 -1770
- package/build/internal/es/src/members-about-v2-member-about-members-about.types.js +0 -324
- package/build/internal/es/src/members-about-v2-member-about-members-about.types.js.map +0 -1
- package/build/internal/es/src/members-about-v2-member-about-members-about.universal.js +0 -602
- package/build/internal/es/src/members-about-v2-member-about-members-about.universal.js.map +0 -1
@@ -1,5 +1,4 @@
|
|
1
|
-
|
2
|
-
export interface MemberAbout {
|
1
|
+
interface MemberAbout {
|
3
2
|
/**
|
4
3
|
* ID of the "About" section content.
|
5
4
|
* @format GUID
|
@@ -16,7 +15,7 @@ export interface MemberAbout {
|
|
16
15
|
/** <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.video.divider.giphy.emoji.link" exampleid="9b569a8d-0fc1-40f4-987f-8bd40ecc72d0">Fallback Message for SSR and Error</widget> */
|
17
16
|
content?: RichContent;
|
18
17
|
}
|
19
|
-
|
18
|
+
interface RichContent {
|
20
19
|
/** Node objects representing a rich content document. */
|
21
20
|
nodes?: Node[];
|
22
21
|
/** Object metadata. */
|
@@ -24,7 +23,7 @@ export interface RichContent {
|
|
24
23
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
25
24
|
documentStyle?: DocumentStyle;
|
26
25
|
}
|
27
|
-
|
26
|
+
interface Node extends NodeDataOneOf {
|
28
27
|
/** Data for a button node. */
|
29
28
|
buttonData?: ButtonData;
|
30
29
|
/** Data for a code block node. */
|
@@ -89,7 +88,7 @@ export interface Node extends NodeDataOneOf {
|
|
89
88
|
style?: NodeStyle;
|
90
89
|
}
|
91
90
|
/** @oneof */
|
92
|
-
|
91
|
+
interface NodeDataOneOf {
|
93
92
|
/** Data for a button node. */
|
94
93
|
buttonData?: ButtonData;
|
95
94
|
/** Data for a code block node. */
|
@@ -145,7 +144,7 @@ export interface NodeDataOneOf {
|
|
145
144
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
146
145
|
layoutCellData?: LayoutCellData;
|
147
146
|
}
|
148
|
-
|
147
|
+
declare enum NodeType {
|
149
148
|
PARAGRAPH = "PARAGRAPH",
|
150
149
|
TEXT = "TEXT",
|
151
150
|
HEADING = "HEADING",
|
@@ -182,8 +181,8 @@ export declare enum NodeType {
|
|
182
181
|
LAYOUT_CELL = "LAYOUT_CELL"
|
183
182
|
}
|
184
183
|
/** @enumType */
|
185
|
-
|
186
|
-
|
184
|
+
type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
|
185
|
+
interface NodeStyle {
|
187
186
|
/** The top padding value in pixels. */
|
188
187
|
paddingTop?: string | null;
|
189
188
|
/** The bottom padding value in pixels. */
|
@@ -191,7 +190,7 @@ export interface NodeStyle {
|
|
191
190
|
/** The background color as a hexadecimal value. */
|
192
191
|
backgroundColor?: string | null;
|
193
192
|
}
|
194
|
-
|
193
|
+
interface ButtonData {
|
195
194
|
/** Styling for the button's container. */
|
196
195
|
containerData?: PluginContainerData;
|
197
196
|
/** The button type. */
|
@@ -203,7 +202,7 @@ export interface ButtonData {
|
|
203
202
|
/** Button link details. */
|
204
203
|
link?: Link;
|
205
204
|
}
|
206
|
-
|
205
|
+
interface Border {
|
207
206
|
/**
|
208
207
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
209
208
|
* @deprecated
|
@@ -215,7 +214,7 @@ export interface Border {
|
|
215
214
|
*/
|
216
215
|
radius?: number | null;
|
217
216
|
}
|
218
|
-
|
217
|
+
interface Colors {
|
219
218
|
/**
|
220
219
|
* Deprecated: Use `textColor` in `styles` instead.
|
221
220
|
* @deprecated
|
@@ -232,7 +231,7 @@ export interface Colors {
|
|
232
231
|
*/
|
233
232
|
background?: string | null;
|
234
233
|
}
|
235
|
-
|
234
|
+
interface PluginContainerData {
|
236
235
|
/** The width of the node when it's displayed. */
|
237
236
|
width?: PluginContainerDataWidth;
|
238
237
|
/** The node's alignment within its container. */
|
@@ -244,7 +243,7 @@ export interface PluginContainerData {
|
|
244
243
|
/** 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`. */
|
245
244
|
textWrap?: boolean | null;
|
246
245
|
}
|
247
|
-
|
246
|
+
declare enum WidthType {
|
248
247
|
/** Width matches the content width */
|
249
248
|
CONTENT = "CONTENT",
|
250
249
|
/** Small Width */
|
@@ -255,8 +254,8 @@ export declare enum WidthType {
|
|
255
254
|
FULL_WIDTH = "FULL_WIDTH"
|
256
255
|
}
|
257
256
|
/** @enumType */
|
258
|
-
|
259
|
-
|
257
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
258
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
260
259
|
/**
|
261
260
|
* One of the following predefined width options:
|
262
261
|
* `CONTENT`: The width of the container matches the content width.
|
@@ -269,7 +268,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
269
268
|
custom?: string | null;
|
270
269
|
}
|
271
270
|
/** @oneof */
|
272
|
-
|
271
|
+
interface PluginContainerDataWidthDataOneOf {
|
273
272
|
/**
|
274
273
|
* One of the following predefined width options:
|
275
274
|
* `CONTENT`: The width of the container matches the content width.
|
@@ -281,7 +280,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
281
280
|
/** A custom width value in pixels. */
|
282
281
|
custom?: string | null;
|
283
282
|
}
|
284
|
-
|
283
|
+
declare enum PluginContainerDataAlignment {
|
285
284
|
/** Center Alignment */
|
286
285
|
CENTER = "CENTER",
|
287
286
|
/** Left Alignment */
|
@@ -290,8 +289,8 @@ export declare enum PluginContainerDataAlignment {
|
|
290
289
|
RIGHT = "RIGHT"
|
291
290
|
}
|
292
291
|
/** @enumType */
|
293
|
-
|
294
|
-
|
292
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
293
|
+
interface Spoiler {
|
295
294
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
296
295
|
enabled?: boolean | null;
|
297
296
|
/** The description displayed on top of the spoiler cover. */
|
@@ -299,19 +298,19 @@ export interface Spoiler {
|
|
299
298
|
/** The text for the button used to remove the spoiler cover. */
|
300
299
|
buttonText?: string | null;
|
301
300
|
}
|
302
|
-
|
301
|
+
interface Height {
|
303
302
|
/** A custom height value in pixels. */
|
304
303
|
custom?: string | null;
|
305
304
|
}
|
306
|
-
|
305
|
+
declare enum Type {
|
307
306
|
/** Regular link button */
|
308
307
|
LINK = "LINK",
|
309
308
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
310
309
|
ACTION = "ACTION"
|
311
310
|
}
|
312
311
|
/** @enumType */
|
313
|
-
|
314
|
-
|
312
|
+
type TypeWithLiterals = Type | 'LINK' | 'ACTION';
|
313
|
+
interface Styles {
|
315
314
|
/**
|
316
315
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
317
316
|
* @deprecated
|
@@ -364,7 +363,7 @@ export interface Styles {
|
|
364
363
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
365
364
|
buttonSize?: string | null;
|
366
365
|
}
|
367
|
-
|
366
|
+
interface Link extends LinkDataOneOf {
|
368
367
|
/** The absolute URL for the linked document. */
|
369
368
|
url?: string;
|
370
369
|
/** The target node's ID. Used for linking to another node in this object. */
|
@@ -383,13 +382,13 @@ export interface Link extends LinkDataOneOf {
|
|
383
382
|
customData?: string | null;
|
384
383
|
}
|
385
384
|
/** @oneof */
|
386
|
-
|
385
|
+
interface LinkDataOneOf {
|
387
386
|
/** The absolute URL for the linked document. */
|
388
387
|
url?: string;
|
389
388
|
/** The target node's ID. Used for linking to another node in this object. */
|
390
389
|
anchor?: string;
|
391
390
|
}
|
392
|
-
|
391
|
+
declare enum Target {
|
393
392
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
394
393
|
SELF = "SELF",
|
395
394
|
/** Opens the linked document in a new window or tab */
|
@@ -400,8 +399,8 @@ export declare enum Target {
|
|
400
399
|
TOP = "TOP"
|
401
400
|
}
|
402
401
|
/** @enumType */
|
403
|
-
|
404
|
-
|
402
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
403
|
+
interface Rel {
|
405
404
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
406
405
|
nofollow?: boolean | null;
|
407
406
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
@@ -411,17 +410,17 @@ export interface Rel {
|
|
411
410
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
412
411
|
noreferrer?: boolean | null;
|
413
412
|
}
|
414
|
-
|
413
|
+
interface CodeBlockData {
|
415
414
|
/** Styling for the code block's text. */
|
416
415
|
textStyle?: TextStyle;
|
417
416
|
}
|
418
|
-
|
417
|
+
interface TextStyle {
|
419
418
|
/** Text alignment. Defaults to `AUTO`. */
|
420
419
|
textAlignment?: TextAlignmentWithLiterals;
|
421
420
|
/** 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. */
|
422
421
|
lineHeight?: string | null;
|
423
422
|
}
|
424
|
-
|
423
|
+
declare enum TextAlignment {
|
425
424
|
/** browser default, eqivalent to `initial` */
|
426
425
|
AUTO = "AUTO",
|
427
426
|
/** Left align */
|
@@ -434,8 +433,8 @@ export declare enum TextAlignment {
|
|
434
433
|
JUSTIFY = "JUSTIFY"
|
435
434
|
}
|
436
435
|
/** @enumType */
|
437
|
-
|
438
|
-
|
436
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
437
|
+
interface DividerData {
|
439
438
|
/** Styling for the divider's container. */
|
440
439
|
containerData?: PluginContainerData;
|
441
440
|
/** Divider line style. */
|
@@ -445,7 +444,7 @@ export interface DividerData {
|
|
445
444
|
/** Divider alignment. */
|
446
445
|
alignment?: AlignmentWithLiterals;
|
447
446
|
}
|
448
|
-
|
447
|
+
declare enum LineStyle {
|
449
448
|
/** Single Line */
|
450
449
|
SINGLE = "SINGLE",
|
451
450
|
/** Double Line */
|
@@ -456,8 +455,8 @@ export declare enum LineStyle {
|
|
456
455
|
DOTTED = "DOTTED"
|
457
456
|
}
|
458
457
|
/** @enumType */
|
459
|
-
|
460
|
-
|
458
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
459
|
+
declare enum Width {
|
461
460
|
/** Large line */
|
462
461
|
LARGE = "LARGE",
|
463
462
|
/** Medium line */
|
@@ -466,8 +465,8 @@ export declare enum Width {
|
|
466
465
|
SMALL = "SMALL"
|
467
466
|
}
|
468
467
|
/** @enumType */
|
469
|
-
|
470
|
-
|
468
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
469
|
+
declare enum Alignment {
|
471
470
|
/** Center alignment */
|
472
471
|
CENTER = "CENTER",
|
473
472
|
/** Left alignment */
|
@@ -476,8 +475,8 @@ export declare enum Alignment {
|
|
476
475
|
RIGHT = "RIGHT"
|
477
476
|
}
|
478
477
|
/** @enumType */
|
479
|
-
|
480
|
-
|
478
|
+
type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
479
|
+
interface FileData {
|
481
480
|
/** Styling for the file's container. */
|
482
481
|
containerData?: PluginContainerData;
|
483
482
|
/** The source for the file's data. */
|
@@ -500,7 +499,7 @@ export interface FileData {
|
|
500
499
|
/** File size in KB. */
|
501
500
|
sizeInKb?: string | null;
|
502
501
|
}
|
503
|
-
|
502
|
+
declare enum ViewMode {
|
504
503
|
/** No PDF view */
|
505
504
|
NONE = "NONE",
|
506
505
|
/** Full PDF view */
|
@@ -509,8 +508,8 @@ export declare enum ViewMode {
|
|
509
508
|
MINI = "MINI"
|
510
509
|
}
|
511
510
|
/** @enumType */
|
512
|
-
|
513
|
-
|
511
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
512
|
+
interface FileSource extends FileSourceDataOneOf {
|
514
513
|
/** The absolute URL for the file's source. */
|
515
514
|
url?: string | null;
|
516
515
|
/**
|
@@ -524,7 +523,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
524
523
|
private?: boolean | null;
|
525
524
|
}
|
526
525
|
/** @oneof */
|
527
|
-
|
526
|
+
interface FileSourceDataOneOf {
|
528
527
|
/** The absolute URL for the file's source. */
|
529
528
|
url?: string | null;
|
530
529
|
/**
|
@@ -535,7 +534,7 @@ export interface FileSourceDataOneOf {
|
|
535
534
|
/** An ID that's resolved to a URL by a resolver function. */
|
536
535
|
id?: string | null;
|
537
536
|
}
|
538
|
-
|
537
|
+
interface PDFSettings {
|
539
538
|
/**
|
540
539
|
* PDF view mode. One of the following:
|
541
540
|
* `NONE` : The PDF isn't displayed.
|
@@ -548,7 +547,7 @@ export interface PDFSettings {
|
|
548
547
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
549
548
|
disablePrint?: boolean | null;
|
550
549
|
}
|
551
|
-
|
550
|
+
interface GalleryData {
|
552
551
|
/** Styling for the gallery's container. */
|
553
552
|
containerData?: PluginContainerData;
|
554
553
|
/** The items in the gallery. */
|
@@ -560,7 +559,7 @@ export interface GalleryData {
|
|
560
559
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
561
560
|
disableDownload?: boolean | null;
|
562
561
|
}
|
563
|
-
|
562
|
+
interface Media {
|
564
563
|
/** The source for the media's data. */
|
565
564
|
src?: FileSource;
|
566
565
|
/** Media width in pixels. */
|
@@ -570,19 +569,19 @@ export interface Media {
|
|
570
569
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
571
570
|
duration?: number | null;
|
572
571
|
}
|
573
|
-
|
572
|
+
interface Image {
|
574
573
|
/** Image file details. */
|
575
574
|
media?: Media;
|
576
575
|
/** Link details for images that are links. */
|
577
576
|
link?: Link;
|
578
577
|
}
|
579
|
-
|
578
|
+
interface Video {
|
580
579
|
/** Video file details. */
|
581
580
|
media?: Media;
|
582
581
|
/** Video thumbnail file details. */
|
583
582
|
thumbnail?: Media;
|
584
583
|
}
|
585
|
-
|
584
|
+
interface Item extends ItemDataOneOf {
|
586
585
|
/** An image item. */
|
587
586
|
image?: Image;
|
588
587
|
/** A video item. */
|
@@ -593,13 +592,13 @@ export interface Item extends ItemDataOneOf {
|
|
593
592
|
altText?: string | null;
|
594
593
|
}
|
595
594
|
/** @oneof */
|
596
|
-
|
595
|
+
interface ItemDataOneOf {
|
597
596
|
/** An image item. */
|
598
597
|
image?: Image;
|
599
598
|
/** A video item. */
|
600
599
|
video?: Video;
|
601
600
|
}
|
602
|
-
|
601
|
+
interface GalleryOptions {
|
603
602
|
/** Gallery layout. */
|
604
603
|
layout?: Layout;
|
605
604
|
/** Styling for gallery items. */
|
@@ -607,7 +606,7 @@ export interface GalleryOptions {
|
|
607
606
|
/** Styling for gallery thumbnail images. */
|
608
607
|
thumbnails?: Thumbnails;
|
609
608
|
}
|
610
|
-
|
609
|
+
declare enum LayoutType {
|
611
610
|
/** Collage type */
|
612
611
|
COLLAGE = "COLLAGE",
|
613
612
|
/** Masonry type */
|
@@ -630,24 +629,24 @@ export declare enum LayoutType {
|
|
630
629
|
FULLSIZE = "FULLSIZE"
|
631
630
|
}
|
632
631
|
/** @enumType */
|
633
|
-
|
634
|
-
|
632
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
633
|
+
declare enum Orientation {
|
635
634
|
/** Rows Orientation */
|
636
635
|
ROWS = "ROWS",
|
637
636
|
/** Columns Orientation */
|
638
637
|
COLUMNS = "COLUMNS"
|
639
638
|
}
|
640
639
|
/** @enumType */
|
641
|
-
|
642
|
-
|
640
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
641
|
+
declare enum Crop {
|
643
642
|
/** Crop to fill */
|
644
643
|
FILL = "FILL",
|
645
644
|
/** Crop to fit */
|
646
645
|
FIT = "FIT"
|
647
646
|
}
|
648
647
|
/** @enumType */
|
649
|
-
|
650
|
-
|
648
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
649
|
+
declare enum ThumbnailsAlignment {
|
651
650
|
/** Top alignment */
|
652
651
|
TOP = "TOP",
|
653
652
|
/** Right alignment */
|
@@ -660,8 +659,8 @@ export declare enum ThumbnailsAlignment {
|
|
660
659
|
NONE = "NONE"
|
661
660
|
}
|
662
661
|
/** @enumType */
|
663
|
-
|
664
|
-
|
662
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
663
|
+
interface Layout {
|
665
664
|
/** Gallery layout type. */
|
666
665
|
type?: LayoutTypeWithLiterals;
|
667
666
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
@@ -673,7 +672,7 @@ export interface Layout {
|
|
673
672
|
/** The number of columns to display on mobile screens. */
|
674
673
|
mobileNumberOfColumns?: number | null;
|
675
674
|
}
|
676
|
-
|
675
|
+
interface ItemStyle {
|
677
676
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
678
677
|
targetSize?: number | null;
|
679
678
|
/** Item ratio */
|
@@ -683,13 +682,13 @@ export interface ItemStyle {
|
|
683
682
|
/** The spacing between items in pixels. */
|
684
683
|
spacing?: number | null;
|
685
684
|
}
|
686
|
-
|
685
|
+
interface Thumbnails {
|
687
686
|
/** Thumbnail alignment. */
|
688
687
|
placement?: ThumbnailsAlignmentWithLiterals;
|
689
688
|
/** Spacing between thumbnails in pixels. */
|
690
689
|
spacing?: number | null;
|
691
690
|
}
|
692
|
-
|
691
|
+
interface GIFData {
|
693
692
|
/** Styling for the GIF's container. */
|
694
693
|
containerData?: PluginContainerData;
|
695
694
|
/** The source of the full size GIF. */
|
@@ -703,7 +702,7 @@ export interface GIFData {
|
|
703
702
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
704
703
|
gifType?: GIFTypeWithLiterals;
|
705
704
|
}
|
706
|
-
|
705
|
+
interface GIF {
|
707
706
|
/**
|
708
707
|
* GIF format URL.
|
709
708
|
* @format WEB_URL
|
@@ -720,13 +719,13 @@ export interface GIF {
|
|
720
719
|
*/
|
721
720
|
still?: string | null;
|
722
721
|
}
|
723
|
-
|
722
|
+
declare enum GIFType {
|
724
723
|
NORMAL = "NORMAL",
|
725
724
|
STICKER = "STICKER"
|
726
725
|
}
|
727
726
|
/** @enumType */
|
728
|
-
|
729
|
-
|
727
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
728
|
+
interface HeadingData {
|
730
729
|
/** Heading level from 1-6. */
|
731
730
|
level?: number;
|
732
731
|
/** Styling for the heading text. */
|
@@ -734,7 +733,7 @@ export interface HeadingData {
|
|
734
733
|
/** Indentation level from 1-4. */
|
735
734
|
indentation?: number | null;
|
736
735
|
}
|
737
|
-
|
736
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
738
737
|
/** The URL for the HTML code for the node. */
|
739
738
|
url?: string;
|
740
739
|
/** The HTML code for the node. */
|
@@ -752,7 +751,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
752
751
|
autoHeight?: boolean | null;
|
753
752
|
}
|
754
753
|
/** @oneof */
|
755
|
-
|
754
|
+
interface HTMLDataDataOneOf {
|
756
755
|
/** The URL for the HTML code for the node. */
|
757
756
|
url?: string;
|
758
757
|
/** The HTML code for the node. */
|
@@ -763,13 +762,13 @@ export interface HTMLDataDataOneOf {
|
|
763
762
|
*/
|
764
763
|
isAdsense?: boolean | null;
|
765
764
|
}
|
766
|
-
|
765
|
+
declare enum Source {
|
767
766
|
HTML = "HTML",
|
768
767
|
ADSENSE = "ADSENSE"
|
769
768
|
}
|
770
769
|
/** @enumType */
|
771
|
-
|
772
|
-
|
770
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
771
|
+
interface ImageData {
|
773
772
|
/** Styling for the image's container. */
|
774
773
|
containerData?: PluginContainerData;
|
775
774
|
/** Image file details. */
|
@@ -792,7 +791,7 @@ export interface ImageData {
|
|
792
791
|
/** Styling for the image. */
|
793
792
|
styles?: ImageDataStyles;
|
794
793
|
}
|
795
|
-
|
794
|
+
interface StylesBorder {
|
796
795
|
/** Border width in pixels. */
|
797
796
|
width?: number | null;
|
798
797
|
/**
|
@@ -803,11 +802,11 @@ export interface StylesBorder {
|
|
803
802
|
/** Border radius in pixels. */
|
804
803
|
radius?: number | null;
|
805
804
|
}
|
806
|
-
|
805
|
+
interface ImageDataStyles {
|
807
806
|
/** Border attributes. */
|
808
807
|
border?: StylesBorder;
|
809
808
|
}
|
810
|
-
|
809
|
+
interface LinkPreviewData {
|
811
810
|
/** Styling for the link preview's container. */
|
812
811
|
containerData?: PluginContainerData;
|
813
812
|
/** Link details. */
|
@@ -823,7 +822,7 @@ export interface LinkPreviewData {
|
|
823
822
|
/** Styling for the link preview. */
|
824
823
|
styles?: LinkPreviewDataStyles;
|
825
824
|
}
|
826
|
-
|
825
|
+
declare enum Position {
|
827
826
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
828
827
|
START = "START",
|
829
828
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
@@ -834,8 +833,8 @@ export declare enum Position {
|
|
834
833
|
HIDDEN = "HIDDEN"
|
835
834
|
}
|
836
835
|
/** @enumType */
|
837
|
-
|
838
|
-
|
836
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
837
|
+
interface LinkPreviewDataStyles {
|
839
838
|
/**
|
840
839
|
* Background color as a hexadecimal value.
|
841
840
|
* @format COLOR_HEX
|
@@ -868,13 +867,13 @@ export interface LinkPreviewDataStyles {
|
|
868
867
|
/** Position of thumbnail. Defaults to `START`. */
|
869
868
|
thumbnailPosition?: PositionWithLiterals;
|
870
869
|
}
|
871
|
-
|
870
|
+
interface MapData {
|
872
871
|
/** Styling for the map's container. */
|
873
872
|
containerData?: PluginContainerData;
|
874
873
|
/** Map settings. */
|
875
874
|
mapSettings?: MapSettings;
|
876
875
|
}
|
877
|
-
|
876
|
+
interface MapSettings {
|
878
877
|
/** The address to display on the map. */
|
879
878
|
address?: string | null;
|
880
879
|
/** Sets whether the map is draggable. */
|
@@ -898,7 +897,7 @@ export interface MapSettings {
|
|
898
897
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
899
898
|
mapType?: MapTypeWithLiterals;
|
900
899
|
}
|
901
|
-
|
900
|
+
declare enum MapType {
|
902
901
|
/** Roadmap map type */
|
903
902
|
ROADMAP = "ROADMAP",
|
904
903
|
/** Satellite map type */
|
@@ -909,8 +908,8 @@ export declare enum MapType {
|
|
909
908
|
TERRAIN = "TERRAIN"
|
910
909
|
}
|
911
910
|
/** @enumType */
|
912
|
-
|
913
|
-
|
911
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
912
|
+
interface ParagraphData {
|
914
913
|
/** Styling for the paragraph text. */
|
915
914
|
textStyle?: TextStyle;
|
916
915
|
/** Indentation level from 1-4. */
|
@@ -918,7 +917,7 @@ export interface ParagraphData {
|
|
918
917
|
/** Paragraph level */
|
919
918
|
level?: number | null;
|
920
919
|
}
|
921
|
-
|
920
|
+
interface PollData {
|
922
921
|
/** Styling for the poll's container. */
|
923
922
|
containerData?: PluginContainerData;
|
924
923
|
/** Poll data. */
|
@@ -928,7 +927,7 @@ export interface PollData {
|
|
928
927
|
/** Styling for the poll and voting options. */
|
929
928
|
design?: Design;
|
930
929
|
}
|
931
|
-
|
930
|
+
declare enum ViewRole {
|
932
931
|
/** Only Poll creator can view the results */
|
933
932
|
CREATOR = "CREATOR",
|
934
933
|
/** Anyone who voted can see the results */
|
@@ -937,16 +936,16 @@ export declare enum ViewRole {
|
|
937
936
|
EVERYONE = "EVERYONE"
|
938
937
|
}
|
939
938
|
/** @enumType */
|
940
|
-
|
941
|
-
|
939
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
940
|
+
declare enum VoteRole {
|
942
941
|
/** Logged in member */
|
943
942
|
SITE_MEMBERS = "SITE_MEMBERS",
|
944
943
|
/** Anyone */
|
945
944
|
ALL = "ALL"
|
946
945
|
}
|
947
946
|
/** @enumType */
|
948
|
-
|
949
|
-
|
947
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
948
|
+
interface Permissions {
|
950
949
|
/** Sets who can view the poll results. */
|
951
950
|
view?: ViewRoleWithLiterals;
|
952
951
|
/** Sets who can vote. */
|
@@ -954,7 +953,7 @@ export interface Permissions {
|
|
954
953
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
955
954
|
allowMultipleVotes?: boolean | null;
|
956
955
|
}
|
957
|
-
|
956
|
+
interface Option {
|
958
957
|
/** Option ID. */
|
959
958
|
id?: string | null;
|
960
959
|
/** Option title. */
|
@@ -962,7 +961,7 @@ export interface Option {
|
|
962
961
|
/** The image displayed with the option. */
|
963
962
|
image?: Media;
|
964
963
|
}
|
965
|
-
|
964
|
+
interface Settings {
|
966
965
|
/** Permissions settings for voting. */
|
967
966
|
permissions?: Permissions;
|
968
967
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
@@ -970,23 +969,23 @@ export interface Settings {
|
|
970
969
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
971
970
|
showVotesCount?: boolean | null;
|
972
971
|
}
|
973
|
-
|
972
|
+
declare enum PollLayoutType {
|
974
973
|
/** List */
|
975
974
|
LIST = "LIST",
|
976
975
|
/** Grid */
|
977
976
|
GRID = "GRID"
|
978
977
|
}
|
979
978
|
/** @enumType */
|
980
|
-
|
981
|
-
|
979
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
980
|
+
declare enum PollLayoutDirection {
|
982
981
|
/** Left-to-right */
|
983
982
|
LTR = "LTR",
|
984
983
|
/** Right-to-left */
|
985
984
|
RTL = "RTL"
|
986
985
|
}
|
987
986
|
/** @enumType */
|
988
|
-
|
989
|
-
|
987
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
988
|
+
interface PollLayout {
|
990
989
|
/** The layout for displaying the voting options. */
|
991
990
|
type?: PollLayoutTypeWithLiterals;
|
992
991
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
@@ -994,11 +993,11 @@ export interface PollLayout {
|
|
994
993
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
995
994
|
enableImage?: boolean | null;
|
996
995
|
}
|
997
|
-
|
996
|
+
interface OptionLayout {
|
998
997
|
/** Sets whether to display option images. Defaults to `false`. */
|
999
998
|
enableImage?: boolean | null;
|
1000
999
|
}
|
1001
|
-
|
1000
|
+
declare enum BackgroundType {
|
1002
1001
|
/** Color background type */
|
1003
1002
|
COLOR = "COLOR",
|
1004
1003
|
/** Image background type */
|
@@ -1007,8 +1006,8 @@ export declare enum BackgroundType {
|
|
1007
1006
|
GRADIENT = "GRADIENT"
|
1008
1007
|
}
|
1009
1008
|
/** @enumType */
|
1010
|
-
|
1011
|
-
|
1009
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
1010
|
+
interface Gradient {
|
1012
1011
|
/** The gradient angle in degrees. */
|
1013
1012
|
angle?: number | null;
|
1014
1013
|
/**
|
@@ -1022,7 +1021,7 @@ export interface Gradient {
|
|
1022
1021
|
*/
|
1023
1022
|
lastColor?: string | null;
|
1024
1023
|
}
|
1025
|
-
|
1024
|
+
interface Background extends BackgroundBackgroundOneOf {
|
1026
1025
|
/**
|
1027
1026
|
* The background color as a hexademical value.
|
1028
1027
|
* @format COLOR_HEX
|
@@ -1036,7 +1035,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
1036
1035
|
type?: BackgroundTypeWithLiterals;
|
1037
1036
|
}
|
1038
1037
|
/** @oneof */
|
1039
|
-
|
1038
|
+
interface BackgroundBackgroundOneOf {
|
1040
1039
|
/**
|
1041
1040
|
* The background color as a hexademical value.
|
1042
1041
|
* @format COLOR_HEX
|
@@ -1047,17 +1046,17 @@ export interface BackgroundBackgroundOneOf {
|
|
1047
1046
|
/** Details for a gradient background. */
|
1048
1047
|
gradient?: Gradient;
|
1049
1048
|
}
|
1050
|
-
|
1049
|
+
interface PollDesign {
|
1051
1050
|
/** Background styling. */
|
1052
1051
|
background?: Background;
|
1053
1052
|
/** Border radius in pixels. */
|
1054
1053
|
borderRadius?: number | null;
|
1055
1054
|
}
|
1056
|
-
|
1055
|
+
interface OptionDesign {
|
1057
1056
|
/** Border radius in pixels. */
|
1058
1057
|
borderRadius?: number | null;
|
1059
1058
|
}
|
1060
|
-
|
1059
|
+
interface Poll {
|
1061
1060
|
/** Poll ID. */
|
1062
1061
|
id?: string | null;
|
1063
1062
|
/** Poll title. */
|
@@ -1071,26 +1070,26 @@ export interface Poll {
|
|
1071
1070
|
/** The poll's permissions and display settings. */
|
1072
1071
|
settings?: Settings;
|
1073
1072
|
}
|
1074
|
-
|
1073
|
+
interface PollDataLayout {
|
1075
1074
|
/** Poll layout settings. */
|
1076
1075
|
poll?: PollLayout;
|
1077
1076
|
/** Voting otpions layout settings. */
|
1078
1077
|
options?: OptionLayout;
|
1079
1078
|
}
|
1080
|
-
|
1079
|
+
interface Design {
|
1081
1080
|
/** Styling for the poll. */
|
1082
1081
|
poll?: PollDesign;
|
1083
1082
|
/** Styling for voting options. */
|
1084
1083
|
options?: OptionDesign;
|
1085
1084
|
}
|
1086
|
-
|
1085
|
+
interface TextData {
|
1087
1086
|
/** The text to apply decorations to. */
|
1088
1087
|
text?: string;
|
1089
1088
|
/** The decorations to apply. */
|
1090
1089
|
decorations?: Decoration[];
|
1091
1090
|
}
|
1092
1091
|
/** Adds appearence changes to text */
|
1093
|
-
|
1092
|
+
interface Decoration extends DecorationDataOneOf {
|
1094
1093
|
/** Data for an anchor link decoration. */
|
1095
1094
|
anchorData?: AnchorData;
|
1096
1095
|
/** Data for a color decoration. */
|
@@ -1115,7 +1114,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
1115
1114
|
type?: DecorationTypeWithLiterals;
|
1116
1115
|
}
|
1117
1116
|
/** @oneof */
|
1118
|
-
|
1117
|
+
interface DecorationDataOneOf {
|
1119
1118
|
/** Data for an anchor link decoration. */
|
1120
1119
|
anchorData?: AnchorData;
|
1121
1120
|
/** Data for a color decoration. */
|
@@ -1137,7 +1136,7 @@ export interface DecorationDataOneOf {
|
|
1137
1136
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
1138
1137
|
strikethroughData?: boolean | null;
|
1139
1138
|
}
|
1140
|
-
|
1139
|
+
declare enum DecorationType {
|
1141
1140
|
BOLD = "BOLD",
|
1142
1141
|
ITALIC = "ITALIC",
|
1143
1142
|
UNDERLINE = "UNDERLINE",
|
@@ -1151,22 +1150,22 @@ export declare enum DecorationType {
|
|
1151
1150
|
STRIKETHROUGH = "STRIKETHROUGH"
|
1152
1151
|
}
|
1153
1152
|
/** @enumType */
|
1154
|
-
|
1155
|
-
|
1153
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
1154
|
+
interface AnchorData {
|
1156
1155
|
/** The target node's ID. */
|
1157
1156
|
anchor?: string;
|
1158
1157
|
}
|
1159
|
-
|
1158
|
+
interface ColorData {
|
1160
1159
|
/** The text's background color as a hexadecimal value. */
|
1161
1160
|
background?: string | null;
|
1162
1161
|
/** The text's foreground color as a hexadecimal value. */
|
1163
1162
|
foreground?: string | null;
|
1164
1163
|
}
|
1165
|
-
|
1164
|
+
interface LinkData {
|
1166
1165
|
/** Link details. */
|
1167
1166
|
link?: Link;
|
1168
1167
|
}
|
1169
|
-
|
1168
|
+
interface MentionData {
|
1170
1169
|
/** The mentioned user's name. */
|
1171
1170
|
name?: string;
|
1172
1171
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
@@ -1174,23 +1173,23 @@ export interface MentionData {
|
|
1174
1173
|
/** Mentioned user's ID. */
|
1175
1174
|
id?: string | null;
|
1176
1175
|
}
|
1177
|
-
|
1176
|
+
interface FontSizeData {
|
1178
1177
|
/** The units used for the font size. */
|
1179
1178
|
unit?: FontTypeWithLiterals;
|
1180
1179
|
/** Font size value. */
|
1181
1180
|
value?: number | null;
|
1182
1181
|
}
|
1183
|
-
|
1182
|
+
declare enum FontType {
|
1184
1183
|
PX = "PX",
|
1185
1184
|
EM = "EM"
|
1186
1185
|
}
|
1187
1186
|
/** @enumType */
|
1188
|
-
|
1189
|
-
|
1187
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
1188
|
+
interface SpoilerData {
|
1190
1189
|
/** Spoiler ID. */
|
1191
1190
|
id?: string | null;
|
1192
1191
|
}
|
1193
|
-
|
1192
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
1194
1193
|
/** Data for embedded Wix Bookings content. */
|
1195
1194
|
bookingData?: BookingData;
|
1196
1195
|
/** Data for embedded Wix Events content. */
|
@@ -1212,30 +1211,30 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1212
1211
|
image?: Media;
|
1213
1212
|
}
|
1214
1213
|
/** @oneof */
|
1215
|
-
|
1214
|
+
interface AppEmbedDataAppDataOneOf {
|
1216
1215
|
/** Data for embedded Wix Bookings content. */
|
1217
1216
|
bookingData?: BookingData;
|
1218
1217
|
/** Data for embedded Wix Events content. */
|
1219
1218
|
eventData?: EventData;
|
1220
1219
|
}
|
1221
|
-
|
1220
|
+
declare enum AppType {
|
1222
1221
|
PRODUCT = "PRODUCT",
|
1223
1222
|
EVENT = "EVENT",
|
1224
1223
|
BOOKING = "BOOKING"
|
1225
1224
|
}
|
1226
1225
|
/** @enumType */
|
1227
|
-
|
1228
|
-
|
1226
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
1227
|
+
interface BookingData {
|
1229
1228
|
/** Booking duration in minutes. */
|
1230
1229
|
durations?: string | null;
|
1231
1230
|
}
|
1232
|
-
|
1231
|
+
interface EventData {
|
1233
1232
|
/** Event schedule. */
|
1234
1233
|
scheduling?: string | null;
|
1235
1234
|
/** Event location. */
|
1236
1235
|
location?: string | null;
|
1237
1236
|
}
|
1238
|
-
|
1237
|
+
interface VideoData {
|
1239
1238
|
/** Styling for the video's container. */
|
1240
1239
|
containerData?: PluginContainerData;
|
1241
1240
|
/** Video details. */
|
@@ -1249,7 +1248,7 @@ export interface VideoData {
|
|
1249
1248
|
/** Video options. */
|
1250
1249
|
options?: PlaybackOptions;
|
1251
1250
|
}
|
1252
|
-
|
1251
|
+
interface PlaybackOptions {
|
1253
1252
|
/** Sets whether the media will automatically start playing. */
|
1254
1253
|
autoPlay?: boolean | null;
|
1255
1254
|
/** Sets whether media's will be looped. */
|
@@ -1257,7 +1256,7 @@ export interface PlaybackOptions {
|
|
1257
1256
|
/** Sets whether media's controls will be shown. */
|
1258
1257
|
showControls?: boolean | null;
|
1259
1258
|
}
|
1260
|
-
|
1259
|
+
interface EmbedData {
|
1261
1260
|
/** Styling for the oEmbed node's container. */
|
1262
1261
|
containerData?: PluginContainerData;
|
1263
1262
|
/** An [oEmbed](https://www.oembed.com) object. */
|
@@ -1265,7 +1264,7 @@ export interface EmbedData {
|
|
1265
1264
|
/** Origin asset source. */
|
1266
1265
|
src?: string | null;
|
1267
1266
|
}
|
1268
|
-
|
1267
|
+
interface Oembed {
|
1269
1268
|
/** The resource type. */
|
1270
1269
|
type?: string | null;
|
1271
1270
|
/** The width of the resource specified in the `url` property in pixels. */
|
@@ -1297,7 +1296,7 @@ export interface Oembed {
|
|
1297
1296
|
/** The oEmbed version number. This value must be `1.0`. */
|
1298
1297
|
version?: string | null;
|
1299
1298
|
}
|
1300
|
-
|
1299
|
+
interface CollapsibleListData {
|
1301
1300
|
/** Styling for the collapsible list's container. */
|
1302
1301
|
containerData?: PluginContainerData;
|
1303
1302
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
@@ -1309,7 +1308,7 @@ export interface CollapsibleListData {
|
|
1309
1308
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
1310
1309
|
isQapageData?: boolean | null;
|
1311
1310
|
}
|
1312
|
-
|
1311
|
+
declare enum InitialExpandedItems {
|
1313
1312
|
/** First item will be expended initally */
|
1314
1313
|
FIRST = "FIRST",
|
1315
1314
|
/** All items will expended initally */
|
@@ -1318,16 +1317,16 @@ export declare enum InitialExpandedItems {
|
|
1318
1317
|
NONE = "NONE"
|
1319
1318
|
}
|
1320
1319
|
/** @enumType */
|
1321
|
-
|
1322
|
-
|
1320
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
1321
|
+
declare enum Direction {
|
1323
1322
|
/** Left-to-right */
|
1324
1323
|
LTR = "LTR",
|
1325
1324
|
/** Right-to-left */
|
1326
1325
|
RTL = "RTL"
|
1327
1326
|
}
|
1328
1327
|
/** @enumType */
|
1329
|
-
|
1330
|
-
|
1328
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
1329
|
+
interface TableData {
|
1331
1330
|
/** Styling for the table's container. */
|
1332
1331
|
containerData?: PluginContainerData;
|
1333
1332
|
/** The table's dimensions. */
|
@@ -1342,7 +1341,7 @@ export interface TableData {
|
|
1342
1341
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
1343
1342
|
columnHeader?: boolean | null;
|
1344
1343
|
}
|
1345
|
-
|
1344
|
+
interface Dimensions {
|
1346
1345
|
/** An array representing relative width of each column in relation to the other columns. */
|
1347
1346
|
colsWidthRatio?: number[];
|
1348
1347
|
/** An array representing the height of each row in pixels. */
|
@@ -1350,13 +1349,13 @@ export interface Dimensions {
|
|
1350
1349
|
/** An array representing the minimum width of each column in pixels. */
|
1351
1350
|
colsMinWidth?: number[];
|
1352
1351
|
}
|
1353
|
-
|
1352
|
+
interface TableCellData {
|
1354
1353
|
/** Styling for the cell's background color and text alignment. */
|
1355
1354
|
cellStyle?: CellStyle;
|
1356
1355
|
/** The cell's border colors. */
|
1357
1356
|
borderColors?: BorderColors;
|
1358
1357
|
}
|
1359
|
-
|
1358
|
+
declare enum VerticalAlignment {
|
1360
1359
|
/** Top alignment */
|
1361
1360
|
TOP = "TOP",
|
1362
1361
|
/** Middle alignment */
|
@@ -1365,8 +1364,8 @@ export declare enum VerticalAlignment {
|
|
1365
1364
|
BOTTOM = "BOTTOM"
|
1366
1365
|
}
|
1367
1366
|
/** @enumType */
|
1368
|
-
|
1369
|
-
|
1367
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
1368
|
+
interface CellStyle {
|
1370
1369
|
/** Vertical alignment for the cell's text. */
|
1371
1370
|
verticalAlignment?: VerticalAlignmentWithLiterals;
|
1372
1371
|
/**
|
@@ -1375,7 +1374,7 @@ export interface CellStyle {
|
|
1375
1374
|
*/
|
1376
1375
|
backgroundColor?: string | null;
|
1377
1376
|
}
|
1378
|
-
|
1377
|
+
interface BorderColors {
|
1379
1378
|
/**
|
1380
1379
|
* Left border color as a hexadecimal value.
|
1381
1380
|
* @format COLOR_HEX
|
@@ -1403,22 +1402,20 @@ export interface BorderColors {
|
|
1403
1402
|
*
|
1404
1403
|
* The JSON representation for `NullValue` is JSON `null`.
|
1405
1404
|
*/
|
1406
|
-
|
1405
|
+
declare enum NullValue {
|
1407
1406
|
/** Null value. */
|
1408
1407
|
NULL_VALUE = "NULL_VALUE"
|
1409
1408
|
}
|
1410
|
-
/** @enumType */
|
1411
|
-
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
1412
1409
|
/**
|
1413
1410
|
* `ListValue` is a wrapper around a repeated field of values.
|
1414
1411
|
*
|
1415
1412
|
* The JSON representation for `ListValue` is JSON array.
|
1416
1413
|
*/
|
1417
|
-
|
1414
|
+
interface ListValue {
|
1418
1415
|
/** Repeated field of dynamically typed values. */
|
1419
1416
|
values?: any[];
|
1420
1417
|
}
|
1421
|
-
|
1418
|
+
interface AudioData {
|
1422
1419
|
/** Styling for the audio node's container. */
|
1423
1420
|
containerData?: PluginContainerData;
|
1424
1421
|
/** Audio file details. */
|
@@ -1434,7 +1431,7 @@ export interface AudioData {
|
|
1434
1431
|
/** An HTML version of the audio node. */
|
1435
1432
|
html?: string | null;
|
1436
1433
|
}
|
1437
|
-
|
1434
|
+
interface OrderedListData {
|
1438
1435
|
/** Indentation level from 0-4. */
|
1439
1436
|
indentation?: number;
|
1440
1437
|
/** Offset level from 0-4. */
|
@@ -1442,24 +1439,24 @@ export interface OrderedListData {
|
|
1442
1439
|
/** List start number. */
|
1443
1440
|
start?: number | null;
|
1444
1441
|
}
|
1445
|
-
|
1442
|
+
interface BulletedListData {
|
1446
1443
|
/** Indentation level from 0-4. */
|
1447
1444
|
indentation?: number;
|
1448
1445
|
/** Offset level from 0-4. */
|
1449
1446
|
offset?: number | null;
|
1450
1447
|
}
|
1451
|
-
|
1448
|
+
interface BlockquoteData {
|
1452
1449
|
/** Indentation level from 1-4. */
|
1453
1450
|
indentation?: number;
|
1454
1451
|
}
|
1455
|
-
|
1452
|
+
interface CaptionData {
|
1456
1453
|
textStyle?: TextStyle;
|
1457
1454
|
}
|
1458
|
-
|
1455
|
+
interface LayoutCellData {
|
1459
1456
|
/** Size of the cell in 12 columns grid. */
|
1460
1457
|
colSpan?: number | null;
|
1461
1458
|
}
|
1462
|
-
|
1459
|
+
interface Metadata {
|
1463
1460
|
/** Schema version. */
|
1464
1461
|
version?: number;
|
1465
1462
|
/**
|
@@ -1476,7 +1473,7 @@ export interface Metadata {
|
|
1476
1473
|
/** Object ID. */
|
1477
1474
|
_id?: string | null;
|
1478
1475
|
}
|
1479
|
-
|
1476
|
+
interface DocumentStyle {
|
1480
1477
|
/** Styling for H1 nodes. */
|
1481
1478
|
headerOne?: TextNodeStyle;
|
1482
1479
|
/** Styling for H2 nodes. */
|
@@ -1496,7 +1493,7 @@ export interface DocumentStyle {
|
|
1496
1493
|
/** Styling for code block nodes. */
|
1497
1494
|
codeBlock?: TextNodeStyle;
|
1498
1495
|
}
|
1499
|
-
|
1496
|
+
interface TextNodeStyle {
|
1500
1497
|
/** The decorations to apply to the node. */
|
1501
1498
|
decorations?: Decoration[];
|
1502
1499
|
/** Padding and background color for the node. */
|
@@ -1504,53 +1501,53 @@ export interface TextNodeStyle {
|
|
1504
1501
|
/** Line height for text in the node. */
|
1505
1502
|
lineHeight?: string | null;
|
1506
1503
|
}
|
1507
|
-
|
1504
|
+
interface CreateMemberAboutRequest {
|
1508
1505
|
/** The "About" section content to create. */
|
1509
1506
|
memberAbout: MemberAbout;
|
1510
1507
|
}
|
1511
|
-
|
1508
|
+
interface CreateMemberAboutResponse {
|
1512
1509
|
/** The created "About" section content. */
|
1513
1510
|
memberAbout?: MemberAbout;
|
1514
1511
|
}
|
1515
|
-
|
1512
|
+
interface UpdateMemberAboutRequest {
|
1516
1513
|
/** The "About" section content to update. */
|
1517
1514
|
memberAbout: MemberAbout;
|
1518
1515
|
}
|
1519
|
-
|
1516
|
+
interface UpdateMemberAboutResponse {
|
1520
1517
|
/** The updated "About" section content. */
|
1521
1518
|
memberAbout?: MemberAbout;
|
1522
1519
|
}
|
1523
|
-
|
1520
|
+
interface DeleteMemberAboutRequest {
|
1524
1521
|
/**
|
1525
1522
|
* ID of the "About" section content to delete.
|
1526
1523
|
* @format GUID
|
1527
1524
|
*/
|
1528
1525
|
_id: string;
|
1529
1526
|
}
|
1530
|
-
|
1527
|
+
interface DeleteMemberAboutResponse {
|
1531
1528
|
}
|
1532
|
-
|
1529
|
+
interface GetMemberAboutRequest {
|
1533
1530
|
/**
|
1534
1531
|
* ID of the "About" section content to retrieve.
|
1535
1532
|
* @format GUID
|
1536
1533
|
*/
|
1537
1534
|
_id: string;
|
1538
1535
|
}
|
1539
|
-
|
1536
|
+
interface GetMemberAboutResponse {
|
1540
1537
|
/** The retrieved "About" section content. */
|
1541
1538
|
memberAbout?: MemberAbout;
|
1542
1539
|
}
|
1543
|
-
|
1540
|
+
interface GetMyMemberAboutRequest {
|
1544
1541
|
}
|
1545
|
-
|
1542
|
+
interface GetMyMemberAboutResponse {
|
1546
1543
|
/** The "About" section content of the current member. */
|
1547
1544
|
memberAbout?: MemberAbout;
|
1548
1545
|
}
|
1549
|
-
|
1546
|
+
interface QueryMemberAboutsRequest {
|
1550
1547
|
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
1551
1548
|
query?: CursorQuery;
|
1552
1549
|
}
|
1553
|
-
|
1550
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
1554
1551
|
/** 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`. */
|
1555
1552
|
cursorPaging?: CursorPaging;
|
1556
1553
|
/**
|
@@ -1569,25 +1566,25 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1569
1566
|
sort?: Sorting[];
|
1570
1567
|
}
|
1571
1568
|
/** @oneof */
|
1572
|
-
|
1569
|
+
interface CursorQueryPagingMethodOneOf {
|
1573
1570
|
/** 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`. */
|
1574
1571
|
cursorPaging?: CursorPaging;
|
1575
1572
|
}
|
1576
|
-
|
1573
|
+
interface Sorting {
|
1577
1574
|
/** Name of the field to sort by. */
|
1578
1575
|
fieldName?: string;
|
1579
1576
|
/** Sort order. */
|
1580
1577
|
order?: SortOrderWithLiterals;
|
1581
1578
|
}
|
1582
|
-
|
1579
|
+
declare enum SortOrder {
|
1583
1580
|
/** Sort is in ascending order. */
|
1584
1581
|
ASC = "ASC",
|
1585
1582
|
/** Sort is in the descending order. */
|
1586
1583
|
DESC = "DESC"
|
1587
1584
|
}
|
1588
1585
|
/** @enumType */
|
1589
|
-
|
1590
|
-
|
1586
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
1587
|
+
interface CursorPaging {
|
1591
1588
|
/**
|
1592
1589
|
* Number of items to load.
|
1593
1590
|
* @max 100
|
@@ -1602,13 +1599,13 @@ export interface CursorPaging {
|
|
1602
1599
|
*/
|
1603
1600
|
cursor?: string | null;
|
1604
1601
|
}
|
1605
|
-
|
1602
|
+
interface QueryMemberAboutsResponse {
|
1606
1603
|
/** The retrieved content from the "About" sections. */
|
1607
1604
|
memberAbouts?: MemberAbout[];
|
1608
1605
|
/** Metadata for the paginated results. */
|
1609
1606
|
metadata?: CursorPagingMetadata;
|
1610
1607
|
}
|
1611
|
-
|
1608
|
+
interface CursorPagingMetadata {
|
1612
1609
|
/** Number of items returned in current page. */
|
1613
1610
|
count?: number | null;
|
1614
1611
|
/** Cursor strings that point to the next page, previous page, or both. */
|
@@ -1621,7 +1618,7 @@ export interface CursorPagingMetadata {
|
|
1621
1618
|
*/
|
1622
1619
|
hasNext?: boolean | null;
|
1623
1620
|
}
|
1624
|
-
|
1621
|
+
interface Cursors {
|
1625
1622
|
/**
|
1626
1623
|
* Cursor string pointing to the next page in the list of results.
|
1627
1624
|
* @maxLength 16000
|
@@ -1633,7 +1630,7 @@ export interface Cursors {
|
|
1633
1630
|
*/
|
1634
1631
|
prev?: string | null;
|
1635
1632
|
}
|
1636
|
-
|
1633
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
1637
1634
|
createdEvent?: EntityCreatedEvent;
|
1638
1635
|
updatedEvent?: EntityUpdatedEvent;
|
1639
1636
|
deletedEvent?: EntityDeletedEvent;
|
@@ -1668,19 +1665,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1668
1665
|
entityEventSequence?: string | null;
|
1669
1666
|
}
|
1670
1667
|
/** @oneof */
|
1671
|
-
|
1668
|
+
interface DomainEventBodyOneOf {
|
1672
1669
|
createdEvent?: EntityCreatedEvent;
|
1673
1670
|
updatedEvent?: EntityUpdatedEvent;
|
1674
1671
|
deletedEvent?: EntityDeletedEvent;
|
1675
1672
|
actionEvent?: ActionEvent;
|
1676
1673
|
}
|
1677
|
-
|
1674
|
+
interface EntityCreatedEvent {
|
1678
1675
|
entity?: string;
|
1679
1676
|
}
|
1680
|
-
|
1677
|
+
interface RestoreInfo {
|
1681
1678
|
deletedDate?: Date | null;
|
1682
1679
|
}
|
1683
|
-
|
1680
|
+
interface EntityUpdatedEvent {
|
1684
1681
|
/**
|
1685
1682
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
1686
1683
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
@@ -1688,14 +1685,14 @@ export interface EntityUpdatedEvent {
|
|
1688
1685
|
*/
|
1689
1686
|
currentEntity?: string;
|
1690
1687
|
}
|
1691
|
-
|
1688
|
+
interface EntityDeletedEvent {
|
1692
1689
|
/** Entity that was deleted. */
|
1693
1690
|
deletedEntity?: string | null;
|
1694
1691
|
}
|
1695
|
-
|
1692
|
+
interface ActionEvent {
|
1696
1693
|
body?: string;
|
1697
1694
|
}
|
1698
|
-
|
1695
|
+
interface MessageEnvelope {
|
1699
1696
|
/**
|
1700
1697
|
* App instance ID.
|
1701
1698
|
* @format GUID
|
@@ -1711,7 +1708,7 @@ export interface MessageEnvelope {
|
|
1711
1708
|
/** Stringify payload. */
|
1712
1709
|
data?: string;
|
1713
1710
|
}
|
1714
|
-
|
1711
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
1715
1712
|
/**
|
1716
1713
|
* ID of a site visitor that has not logged in to the site.
|
1717
1714
|
* @format GUID
|
@@ -1736,7 +1733,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1736
1733
|
identityType?: WebhookIdentityTypeWithLiterals;
|
1737
1734
|
}
|
1738
1735
|
/** @oneof */
|
1739
|
-
|
1736
|
+
interface IdentificationDataIdOneOf {
|
1740
1737
|
/**
|
1741
1738
|
* ID of a site visitor that has not logged in to the site.
|
1742
1739
|
* @format GUID
|
@@ -1758,7 +1755,7 @@ export interface IdentificationDataIdOneOf {
|
|
1758
1755
|
*/
|
1759
1756
|
appId?: string;
|
1760
1757
|
}
|
1761
|
-
|
1758
|
+
declare enum WebhookIdentityType {
|
1762
1759
|
UNKNOWN = "UNKNOWN",
|
1763
1760
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
1764
1761
|
MEMBER = "MEMBER",
|
@@ -1766,8 +1763,8 @@ export declare enum WebhookIdentityType {
|
|
1766
1763
|
APP = "APP"
|
1767
1764
|
}
|
1768
1765
|
/** @enumType */
|
1769
|
-
|
1770
|
-
|
1766
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
1767
|
+
interface BaseEventMetadata {
|
1771
1768
|
/**
|
1772
1769
|
* App instance ID.
|
1773
1770
|
* @format GUID
|
@@ -1781,7 +1778,7 @@ export interface BaseEventMetadata {
|
|
1781
1778
|
/** The identification type and identity data. */
|
1782
1779
|
identity?: IdentificationData;
|
1783
1780
|
}
|
1784
|
-
|
1781
|
+
interface EventMetadata extends BaseEventMetadata {
|
1785
1782
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
1786
1783
|
_id?: string;
|
1787
1784
|
/**
|
@@ -1811,114 +1808,18 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
1811
1808
|
*/
|
1812
1809
|
entityEventSequence?: string | null;
|
1813
1810
|
}
|
1814
|
-
|
1811
|
+
interface MemberAboutCreatedEnvelope {
|
1815
1812
|
entity: MemberAbout;
|
1816
1813
|
metadata: EventMetadata;
|
1817
1814
|
}
|
1818
|
-
|
1819
|
-
* Triggered when a member's "About" section content is created.
|
1820
|
-
* @permissionScope Manage Members
|
1821
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
1822
|
-
* @permissionScope Manage Challenges
|
1823
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
1824
|
-
* @permissionScope Read Members and Contacts - all read permissions
|
1825
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
1826
|
-
* @permissionScope Read Members
|
1827
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
1828
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
1829
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
1830
|
-
* @permissionId MEMBERS.MEMBER_ABOUT_READ
|
1831
|
-
* @webhook
|
1832
|
-
* @eventType wix.members.about.v2.member_about_created
|
1833
|
-
* @serviceIdentifier wix.members.about.v2.MembersAbout
|
1834
|
-
* @slug created
|
1835
|
-
* @documentationMaturity preview
|
1836
|
-
*/
|
1837
|
-
export declare function onMemberAboutCreated(handler: (event: MemberAboutCreatedEnvelope) => void | Promise<void>): void;
|
1838
|
-
export interface MemberAboutDeletedEnvelope {
|
1815
|
+
interface MemberAboutDeletedEnvelope {
|
1839
1816
|
metadata: EventMetadata;
|
1840
1817
|
}
|
1841
|
-
|
1842
|
-
* Triggered when a member's "About" section content is deleted.
|
1843
|
-
* @permissionScope Manage Members
|
1844
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
1845
|
-
* @permissionScope Manage Challenges
|
1846
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
1847
|
-
* @permissionScope Read Members and Contacts - all read permissions
|
1848
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
1849
|
-
* @permissionScope Read Members
|
1850
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
1851
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
1852
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
1853
|
-
* @permissionId MEMBERS.MEMBER_ABOUT_READ
|
1854
|
-
* @webhook
|
1855
|
-
* @eventType wix.members.about.v2.member_about_deleted
|
1856
|
-
* @serviceIdentifier wix.members.about.v2.MembersAbout
|
1857
|
-
* @slug deleted
|
1858
|
-
* @documentationMaturity preview
|
1859
|
-
*/
|
1860
|
-
export declare function onMemberAboutDeleted(handler: (event: MemberAboutDeletedEnvelope) => void | Promise<void>): void;
|
1861
|
-
export interface MemberAboutUpdatedEnvelope {
|
1818
|
+
interface MemberAboutUpdatedEnvelope {
|
1862
1819
|
entity: MemberAbout;
|
1863
1820
|
metadata: EventMetadata;
|
1864
1821
|
}
|
1865
|
-
|
1866
|
-
* Triggered when a member's "About" section content is updated.
|
1867
|
-
* @permissionScope Manage Members
|
1868
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
1869
|
-
* @permissionScope Manage Challenges
|
1870
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
1871
|
-
* @permissionScope Read Members and Contacts - all read permissions
|
1872
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
1873
|
-
* @permissionScope Read Members
|
1874
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
1875
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
1876
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
1877
|
-
* @permissionId MEMBERS.MEMBER_ABOUT_READ
|
1878
|
-
* @webhook
|
1879
|
-
* @eventType wix.members.about.v2.member_about_updated
|
1880
|
-
* @serviceIdentifier wix.members.about.v2.MembersAbout
|
1881
|
-
* @slug updated
|
1882
|
-
* @documentationMaturity preview
|
1883
|
-
*/
|
1884
|
-
export declare function onMemberAboutUpdated(handler: (event: MemberAboutUpdatedEnvelope) => void | Promise<void>): void;
|
1885
|
-
/**
|
1886
|
-
* Creates the "About" section content for a member.
|
1887
|
-
* @param memberAbout - The "About" section content to create.
|
1888
|
-
* @public
|
1889
|
-
* @documentationMaturity preview
|
1890
|
-
* @requiredField memberAbout
|
1891
|
-
* @requiredField memberAbout.content
|
1892
|
-
* @permissionId MEMBERS.MEMBER_ABOUT_CREATE
|
1893
|
-
* @permissionScope SCOPE.DC-MEMBERS.MANAGE-ABOUT
|
1894
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-ABOUT
|
1895
|
-
* @applicableIdentity APP
|
1896
|
-
* @applicableIdentity MEMBER
|
1897
|
-
* @returns The created "About" section content.
|
1898
|
-
* @fqn wix.members.about.v2.MembersAbout.CreateMemberAbout
|
1899
|
-
*/
|
1900
|
-
export declare function createMemberAbout(memberAbout: NonNullablePaths<MemberAbout, `content`>): Promise<MemberAbout>;
|
1901
|
-
/**
|
1902
|
-
* Updates the "About" section content for a member.
|
1903
|
-
*
|
1904
|
-
* Each time the "About" section content is updated, `revision` increments by 1. The existing `revision` must be included when updating the "About" section content. This ensures you're working with the latest "About" section and prevents unintended overwrites.
|
1905
|
-
* @param _id - ID of the "About" section content.
|
1906
|
-
* @public
|
1907
|
-
* @documentationMaturity preview
|
1908
|
-
* @requiredField _id
|
1909
|
-
* @requiredField memberAbout
|
1910
|
-
* @requiredField memberAbout.content
|
1911
|
-
* @requiredField memberAbout.revision
|
1912
|
-
* @permissionId MEMBERS.MEMBER_ABOUT_UPDATE
|
1913
|
-
* @permissionScope SCOPE.DC-MEMBERS.MANAGE-ABOUT
|
1914
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-ABOUT
|
1915
|
-
* @applicableIdentity APP
|
1916
|
-
* @applicableIdentity MEMBER
|
1917
|
-
* @returns The updated "About" section content.
|
1918
|
-
* @fqn wix.members.about.v2.MembersAbout.UpdateMemberAbout
|
1919
|
-
*/
|
1920
|
-
export declare function updateMemberAbout(_id: string, memberAbout: NonNullablePaths<UpdateMemberAbout, `content` | `revision`>): Promise<MemberAbout>;
|
1921
|
-
export interface UpdateMemberAbout {
|
1822
|
+
interface UpdateMemberAbout {
|
1922
1823
|
/**
|
1923
1824
|
* ID of the "About" section content.
|
1924
1825
|
* @format GUID
|
@@ -1935,96 +1836,6 @@ export interface UpdateMemberAbout {
|
|
1935
1836
|
/** <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.video.divider.giphy.emoji.link" exampleid="9b569a8d-0fc1-40f4-987f-8bd40ecc72d0">Fallback Message for SSR and Error</widget> */
|
1936
1837
|
content?: RichContent;
|
1937
1838
|
}
|
1938
|
-
/**
|
1939
|
-
* Deletes the "About" section content for a member.
|
1940
|
-
* @param _id - ID of the "About" section content to delete.
|
1941
|
-
* @public
|
1942
|
-
* @documentationMaturity preview
|
1943
|
-
* @requiredField _id
|
1944
|
-
* @permissionId MEMBERS.MEMBER_ABOUT_DELETE
|
1945
|
-
* @permissionScope SCOPE.DC-MEMBERS.MANAGE-ABOUT
|
1946
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-ABOUT
|
1947
|
-
* @applicableIdentity APP
|
1948
|
-
* @applicableIdentity MEMBER
|
1949
|
-
* @fqn wix.members.about.v2.MembersAbout.DeleteMemberAbout
|
1950
|
-
*/
|
1951
|
-
export declare function deleteMemberAbout(_id: string): Promise<void>;
|
1952
|
-
/**
|
1953
|
-
* Retrieves a member's "About" section content.
|
1954
|
-
* @param _id - ID of the "About" section content to retrieve.
|
1955
|
-
* @public
|
1956
|
-
* @documentationMaturity preview
|
1957
|
-
* @requiredField _id
|
1958
|
-
* @permissionId MEMBERS.MEMBER_ABOUT_READ
|
1959
|
-
* @permissionScope Manage Members
|
1960
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
1961
|
-
* @permissionScope Manage Challenges
|
1962
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
1963
|
-
* @permissionScope Read Members and Contacts - all read permissions
|
1964
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
1965
|
-
* @permissionScope Read Members
|
1966
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
1967
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
1968
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
1969
|
-
* @applicableIdentity APP
|
1970
|
-
* @applicableIdentity VISITOR
|
1971
|
-
* @returns The retrieved "About" section content.
|
1972
|
-
* @fqn wix.members.about.v2.MembersAbout.GetMemberAbout
|
1973
|
-
*/
|
1974
|
-
export declare function getMemberAbout(_id: string): Promise<MemberAbout>;
|
1975
|
-
/**
|
1976
|
-
* Retrieves the "About" section content of the current member.
|
1977
|
-
*
|
1978
|
-
* >**Note:**
|
1979
|
-
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
|
1980
|
-
* @public
|
1981
|
-
* @documentationMaturity preview
|
1982
|
-
* @permissionId MEMBERS.MEMBER_ABOUT_READ
|
1983
|
-
* @permissionScope Manage Members
|
1984
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
1985
|
-
* @permissionScope Manage Challenges
|
1986
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
1987
|
-
* @permissionScope Read Members and Contacts - all read permissions
|
1988
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
1989
|
-
* @permissionScope Read Members
|
1990
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
1991
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
1992
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
1993
|
-
* @applicableIdentity APP
|
1994
|
-
* @applicableIdentity VISITOR
|
1995
|
-
* @fqn wix.members.about.v2.MembersAbout.GetMyMemberAbout
|
1996
|
-
*/
|
1997
|
-
export declare function getMyMemberAbout(): Promise<GetMyMemberAboutResponse>;
|
1998
|
-
/**
|
1999
|
-
* Creates a query to retrieve a list of "About" sections.
|
2000
|
-
*
|
2001
|
-
* The `queryMemberAbouts()` method builds a query to retrieve a list of "About" sections and returns a [`MemberAboutsQueryBuilder`](https://dev.wix.com/docs/sdk/backend-modules/members/members-about/member-abouts-query-builder/eq) object.
|
2002
|
-
*
|
2003
|
-
* The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/members/members-about/member-abouts-query-builder/find) method.
|
2004
|
-
*
|
2005
|
-
* You can refine the query by chaining `MemberAboutsQueryBuilder` methods onto the query. `MemberAboutsQueryBuilder` methods enable you to sort, filter, and control the results `queryMemberAbouts()` returns.
|
2006
|
-
*
|
2007
|
-
* `queryMemberAbouts()` runs with these `MemberAboutsQueryBuilder` defaults, which you can override:
|
2008
|
-
*
|
2009
|
-
* - [`limit(50)`](https://dev.wix.com/docs/sdk/backend-modules/members/members-about/member-abouts-query-builder/limit)
|
2010
|
-
* @public
|
2011
|
-
* @documentationMaturity preview
|
2012
|
-
* @permissionScope Manage Members
|
2013
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
2014
|
-
* @permissionScope Manage Challenges
|
2015
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
2016
|
-
* @permissionScope Read Members and Contacts - all read permissions
|
2017
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
2018
|
-
* @permissionScope Read Members
|
2019
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
2020
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
2021
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
2022
|
-
* @permissionId MEMBERS.MEMBER_ABOUT_READ
|
2023
|
-
* @applicableIdentity APP
|
2024
|
-
* @applicableIdentity VISITOR
|
2025
|
-
* @fqn wix.members.about.v2.MembersAbout.QueryMemberAbouts
|
2026
|
-
*/
|
2027
|
-
export declare function queryMemberAbouts(): MemberAboutsQueryBuilder;
|
2028
1839
|
interface QueryCursorResult {
|
2029
1840
|
cursors: Cursors;
|
2030
1841
|
hasNext: () => boolean;
|
@@ -2032,13 +1843,13 @@ interface QueryCursorResult {
|
|
2032
1843
|
length: number;
|
2033
1844
|
pageSize: number;
|
2034
1845
|
}
|
2035
|
-
|
1846
|
+
interface MemberAboutsQueryResult extends QueryCursorResult {
|
2036
1847
|
items: MemberAbout[];
|
2037
1848
|
query: MemberAboutsQueryBuilder;
|
2038
1849
|
next: () => Promise<MemberAboutsQueryResult>;
|
2039
1850
|
prev: () => Promise<MemberAboutsQueryResult>;
|
2040
1851
|
}
|
2041
|
-
|
1852
|
+
interface MemberAboutsQueryBuilder {
|
2042
1853
|
/** @param propertyName - Property whose value is compared with `value`.
|
2043
1854
|
* @param value - Value to compare against.
|
2044
1855
|
* @documentationMaturity preview
|
@@ -2094,4 +1905,5 @@ export interface MemberAboutsQueryBuilder {
|
|
2094
1905
|
/** @documentationMaturity preview */
|
2095
1906
|
find: () => Promise<MemberAboutsQueryResult>;
|
2096
1907
|
}
|
2097
|
-
|
1908
|
+
|
1909
|
+
export { type LinkDataOneOf as $, Alignment as A, BackgroundType as B, Crop as C, DecorationType as D, type Border as E, FontType as F, type GetMyMemberAboutResponse as G, type Colors as H, InitialExpandedItems as I, type PluginContainerData as J, type PluginContainerDataWidth as K, LineStyle as L, type MemberAbout as M, NodeType as N, Orientation as O, PluginContainerDataAlignment as P, type PluginContainerDataWidthDataOneOf as Q, type RichContent as R, Source as S, Type as T, type UpdateMemberAbout as U, ViewMode as V, WidthType as W, type Spoiler as X, type Height as Y, type Styles as Z, type Link as _, type MemberAboutsQueryBuilder as a, type TableData as a$, type Rel as a0, type CodeBlockData as a1, type TextStyle as a2, type DividerData as a3, type FileData as a4, type FileSource as a5, type FileSourceDataOneOf as a6, type PDFSettings as a7, type GalleryData as a8, type Media as a9, type OptionLayout as aA, type Gradient as aB, type Background as aC, type BackgroundBackgroundOneOf as aD, type PollDesign as aE, type OptionDesign as aF, type Poll as aG, type PollDataLayout as aH, type Design as aI, type TextData as aJ, type Decoration as aK, type DecorationDataOneOf as aL, type AnchorData as aM, type ColorData as aN, type LinkData as aO, type MentionData as aP, type FontSizeData as aQ, type SpoilerData as aR, type AppEmbedData as aS, type AppEmbedDataAppDataOneOf as aT, type BookingData as aU, type EventData as aV, type VideoData as aW, type PlaybackOptions as aX, type EmbedData as aY, type Oembed as aZ, type CollapsibleListData as a_, type Image as aa, type Video as ab, type Item as ac, type ItemDataOneOf as ad, type GalleryOptions as ae, type Layout as af, type ItemStyle as ag, type Thumbnails as ah, type GIFData as ai, type GIF as aj, type HeadingData as ak, type HTMLData as al, type HTMLDataDataOneOf as am, type ImageData as an, type StylesBorder as ao, type ImageDataStyles as ap, type LinkPreviewData as aq, type LinkPreviewDataStyles as ar, type MapData as as, type MapSettings as at, type ParagraphData as au, type PollData as av, type Permissions as aw, type Option as ax, type Settings as ay, type PollLayout as az, type MemberAboutCreatedEnvelope as b, type Dimensions as b0, type TableCellData as b1, type CellStyle as b2, type BorderColors as b3, type ListValue as b4, type AudioData as b5, type OrderedListData as b6, type BulletedListData as b7, type BlockquoteData as b8, type CaptionData as b9, type EntityDeletedEvent as bA, type ActionEvent as bB, type MessageEnvelope as bC, type IdentificationData as bD, type IdentificationDataIdOneOf as bE, type BaseEventMetadata as bF, type EventMetadata as bG, type MemberAboutsQueryResult as bH, type LayoutCellData as ba, type Metadata as bb, type DocumentStyle as bc, type TextNodeStyle as bd, type CreateMemberAboutRequest as be, type CreateMemberAboutResponse as bf, type UpdateMemberAboutRequest as bg, type UpdateMemberAboutResponse as bh, type DeleteMemberAboutRequest as bi, type DeleteMemberAboutResponse as bj, type GetMemberAboutRequest as bk, type GetMemberAboutResponse as bl, type GetMyMemberAboutRequest as bm, type QueryMemberAboutsRequest as bn, type CursorQuery as bo, type CursorQueryPagingMethodOneOf as bp, type Sorting as bq, type CursorPaging as br, type QueryMemberAboutsResponse as bs, type CursorPagingMetadata as bt, type Cursors as bu, type DomainEvent as bv, type DomainEventBodyOneOf as bw, type EntityCreatedEvent as bx, type RestoreInfo as by, type EntityUpdatedEvent as bz, type MemberAboutDeletedEnvelope as c, type MemberAboutUpdatedEnvelope as d, Target as e, TextAlignment as f, Width as g, LayoutType as h, ThumbnailsAlignment as i, GIFType as j, Position as k, MapType as l, ViewRole as m, VoteRole as n, PollLayoutType as o, PollLayoutDirection as p, AppType as q, Direction as r, VerticalAlignment as s, NullValue as t, SortOrder as u, WebhookIdentityType as v, type Node as w, type NodeDataOneOf as x, type NodeStyle as y, type ButtonData as z };
|