@wix/auto_sdk_members_members-about 1.0.21 → 1.0.23
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 +5 -5
- package/build/cjs/index.js +71 -18
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/{members-about-v2-member-about-members-about.universal-35AgPK6C.d.ts → index.typings.d.ts} +380 -14
- package/build/cjs/index.typings.js +1048 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +227 -14
- package/build/es/index.d.mts +5 -5
- package/build/es/index.mjs +64 -18
- package/build/es/index.mjs.map +1 -1
- package/build/es/{members-about-v2-member-about-members-about.universal-35AgPK6C.d.mts → index.typings.d.mts} +380 -14
- package/build/es/index.typings.mjs +980 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +227 -14
- package/build/internal/cjs/index.d.ts +5 -5
- package/build/internal/cjs/index.js +71 -18
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/{members-about-v2-member-about-members-about.universal-35AgPK6C.d.ts → index.typings.d.ts} +380 -14
- package/build/internal/cjs/index.typings.js +1048 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +227 -14
- package/build/internal/es/index.d.mts +5 -5
- package/build/internal/es/index.mjs +64 -18
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/{members-about-v2-member-about-members-about.universal-35AgPK6C.d.mts → index.typings.d.mts} +380 -14
- package/build/internal/es/index.typings.mjs +980 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +227 -14
- package/package.json +3 -3
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
interface MemberAbout {
|
|
2
4
|
/**
|
|
3
5
|
* ID of the "About" section content.
|
|
@@ -194,7 +196,7 @@ interface ButtonData {
|
|
|
194
196
|
/** Styling for the button's container. */
|
|
195
197
|
containerData?: PluginContainerData;
|
|
196
198
|
/** The button type. */
|
|
197
|
-
type?:
|
|
199
|
+
type?: ButtonDataTypeWithLiterals;
|
|
198
200
|
/** Styling for the button. */
|
|
199
201
|
styles?: Styles;
|
|
200
202
|
/** The text to display on the button. */
|
|
@@ -302,14 +304,14 @@ interface Height {
|
|
|
302
304
|
/** A custom height value in pixels. */
|
|
303
305
|
custom?: string | null;
|
|
304
306
|
}
|
|
305
|
-
declare enum
|
|
307
|
+
declare enum ButtonDataType {
|
|
306
308
|
/** Regular link button */
|
|
307
309
|
LINK = "LINK",
|
|
308
310
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
309
311
|
ACTION = "ACTION"
|
|
310
312
|
}
|
|
311
313
|
/** @enumType */
|
|
312
|
-
type
|
|
314
|
+
type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
313
315
|
interface Styles {
|
|
314
316
|
/**
|
|
315
317
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
@@ -442,7 +444,7 @@ interface DividerData {
|
|
|
442
444
|
/** Divider width. */
|
|
443
445
|
width?: WidthWithLiterals;
|
|
444
446
|
/** Divider alignment. */
|
|
445
|
-
alignment?:
|
|
447
|
+
alignment?: DividerDataAlignmentWithLiterals;
|
|
446
448
|
}
|
|
447
449
|
declare enum LineStyle {
|
|
448
450
|
/** Single Line */
|
|
@@ -466,7 +468,7 @@ declare enum Width {
|
|
|
466
468
|
}
|
|
467
469
|
/** @enumType */
|
|
468
470
|
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
469
|
-
declare enum
|
|
471
|
+
declare enum DividerDataAlignment {
|
|
470
472
|
/** Center alignment */
|
|
471
473
|
CENTER = "CENTER",
|
|
472
474
|
/** Left alignment */
|
|
@@ -475,7 +477,7 @@ declare enum Alignment {
|
|
|
475
477
|
RIGHT = "RIGHT"
|
|
476
478
|
}
|
|
477
479
|
/** @enumType */
|
|
478
|
-
type
|
|
480
|
+
type DividerDataAlignmentWithLiterals = DividerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
479
481
|
interface FileData {
|
|
480
482
|
/** Styling for the file's container. */
|
|
481
483
|
containerData?: PluginContainerData;
|
|
@@ -600,7 +602,7 @@ interface ItemDataOneOf {
|
|
|
600
602
|
}
|
|
601
603
|
interface GalleryOptions {
|
|
602
604
|
/** Gallery layout. */
|
|
603
|
-
layout?:
|
|
605
|
+
layout?: GalleryOptionsLayout;
|
|
604
606
|
/** Styling for gallery items. */
|
|
605
607
|
item?: ItemStyle;
|
|
606
608
|
/** Styling for gallery thumbnail images. */
|
|
@@ -660,7 +662,7 @@ declare enum ThumbnailsAlignment {
|
|
|
660
662
|
}
|
|
661
663
|
/** @enumType */
|
|
662
664
|
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
663
|
-
interface
|
|
665
|
+
interface GalleryOptionsLayout {
|
|
664
666
|
/** Gallery layout type. */
|
|
665
667
|
type?: LayoutTypeWithLiterals;
|
|
666
668
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -822,7 +824,7 @@ interface LinkPreviewData {
|
|
|
822
824
|
/** Styling for the link preview. */
|
|
823
825
|
styles?: LinkPreviewDataStyles;
|
|
824
826
|
}
|
|
825
|
-
declare enum
|
|
827
|
+
declare enum StylesPosition {
|
|
826
828
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
827
829
|
START = "START",
|
|
828
830
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -833,7 +835,7 @@ declare enum Position {
|
|
|
833
835
|
HIDDEN = "HIDDEN"
|
|
834
836
|
}
|
|
835
837
|
/** @enumType */
|
|
836
|
-
type
|
|
838
|
+
type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
837
839
|
interface LinkPreviewDataStyles {
|
|
838
840
|
/**
|
|
839
841
|
* Background color as a hexadecimal value.
|
|
@@ -865,7 +867,7 @@ interface LinkPreviewDataStyles {
|
|
|
865
867
|
*/
|
|
866
868
|
borderColor?: string | null;
|
|
867
869
|
/** Position of thumbnail. Defaults to `START`. */
|
|
868
|
-
thumbnailPosition?:
|
|
870
|
+
thumbnailPosition?: StylesPositionWithLiterals;
|
|
869
871
|
}
|
|
870
872
|
interface MapData {
|
|
871
873
|
/** Styling for the map's container. */
|
|
@@ -1110,6 +1112,10 @@ interface Decoration extends DecorationDataOneOf {
|
|
|
1110
1112
|
spoilerData?: SpoilerData;
|
|
1111
1113
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1112
1114
|
strikethroughData?: boolean | null;
|
|
1115
|
+
/** Data for a superscript decoration. Defaults to `true`. */
|
|
1116
|
+
superscriptData?: boolean | null;
|
|
1117
|
+
/** Data for a subscript decoration. Defaults to `true`. */
|
|
1118
|
+
subscriptData?: boolean | null;
|
|
1113
1119
|
/** The type of decoration to apply. */
|
|
1114
1120
|
type?: DecorationTypeWithLiterals;
|
|
1115
1121
|
}
|
|
@@ -1135,6 +1141,10 @@ interface DecorationDataOneOf {
|
|
|
1135
1141
|
spoilerData?: SpoilerData;
|
|
1136
1142
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1137
1143
|
strikethroughData?: boolean | null;
|
|
1144
|
+
/** Data for a superscript decoration. Defaults to `true`. */
|
|
1145
|
+
superscriptData?: boolean | null;
|
|
1146
|
+
/** Data for a subscript decoration. Defaults to `true`. */
|
|
1147
|
+
subscriptData?: boolean | null;
|
|
1138
1148
|
}
|
|
1139
1149
|
declare enum DecorationType {
|
|
1140
1150
|
BOLD = "BOLD",
|
|
@@ -1147,10 +1157,12 @@ declare enum DecorationType {
|
|
|
1147
1157
|
COLOR = "COLOR",
|
|
1148
1158
|
FONT_SIZE = "FONT_SIZE",
|
|
1149
1159
|
EXTERNAL = "EXTERNAL",
|
|
1150
|
-
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1160
|
+
STRIKETHROUGH = "STRIKETHROUGH",
|
|
1161
|
+
SUPERSCRIPT = "SUPERSCRIPT",
|
|
1162
|
+
SUBSCRIPT = "SUBSCRIPT"
|
|
1151
1163
|
}
|
|
1152
1164
|
/** @enumType */
|
|
1153
|
-
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
1165
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH' | 'SUPERSCRIPT' | 'SUBSCRIPT';
|
|
1154
1166
|
interface AnchorData {
|
|
1155
1167
|
/** The target node's ID. */
|
|
1156
1168
|
anchor?: string;
|
|
@@ -1209,6 +1221,32 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1209
1221
|
url?: string | null;
|
|
1210
1222
|
/** An image for the embedded content. */
|
|
1211
1223
|
image?: Media;
|
|
1224
|
+
/** Whether to hide the image. */
|
|
1225
|
+
hideImage?: boolean | null;
|
|
1226
|
+
/** Whether to hide the title. */
|
|
1227
|
+
hideTitle?: boolean | null;
|
|
1228
|
+
/** Whether to hide the price. */
|
|
1229
|
+
hidePrice?: boolean | null;
|
|
1230
|
+
/** Whether to hide the description (Event and Booking). */
|
|
1231
|
+
hideDescription?: boolean | null;
|
|
1232
|
+
/** Whether to hide the date and time (Event). */
|
|
1233
|
+
hideDateTime?: boolean | null;
|
|
1234
|
+
/** Whether to hide the location (Event). */
|
|
1235
|
+
hideLocation?: boolean | null;
|
|
1236
|
+
/** Whether to hide the duration (Booking). */
|
|
1237
|
+
hideDuration?: boolean | null;
|
|
1238
|
+
/** Whether to hide the button. */
|
|
1239
|
+
hideButton?: boolean | null;
|
|
1240
|
+
/** Whether to hide the ribbon. */
|
|
1241
|
+
hideRibbon?: boolean | null;
|
|
1242
|
+
/** Button styling options. */
|
|
1243
|
+
buttonStyles?: ButtonStyles;
|
|
1244
|
+
/** Image styling options. */
|
|
1245
|
+
imageStyles?: ImageStyles;
|
|
1246
|
+
/** Ribbon styling options. */
|
|
1247
|
+
ribbonStyles?: RibbonStyles;
|
|
1248
|
+
/** Card styling options. */
|
|
1249
|
+
cardStyles?: CardStyles;
|
|
1212
1250
|
}
|
|
1213
1251
|
/** @oneof */
|
|
1214
1252
|
interface AppEmbedDataAppDataOneOf {
|
|
@@ -1217,6 +1255,66 @@ interface AppEmbedDataAppDataOneOf {
|
|
|
1217
1255
|
/** Data for embedded Wix Events content. */
|
|
1218
1256
|
eventData?: EventData;
|
|
1219
1257
|
}
|
|
1258
|
+
declare enum Position {
|
|
1259
|
+
/** Image positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
1260
|
+
START = "START",
|
|
1261
|
+
/** Image positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
1262
|
+
END = "END",
|
|
1263
|
+
/** Image positioned at the top */
|
|
1264
|
+
TOP = "TOP"
|
|
1265
|
+
}
|
|
1266
|
+
/** @enumType */
|
|
1267
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP';
|
|
1268
|
+
declare enum AspectRatio {
|
|
1269
|
+
/** 1:1 aspect ratio */
|
|
1270
|
+
SQUARE = "SQUARE",
|
|
1271
|
+
/** 16:9 aspect ratio */
|
|
1272
|
+
RECTANGLE = "RECTANGLE"
|
|
1273
|
+
}
|
|
1274
|
+
/** @enumType */
|
|
1275
|
+
type AspectRatioWithLiterals = AspectRatio | 'SQUARE' | 'RECTANGLE';
|
|
1276
|
+
declare enum Resizing {
|
|
1277
|
+
/** Fill the container, may crop the image */
|
|
1278
|
+
FILL = "FILL",
|
|
1279
|
+
/** Fit the image within the container */
|
|
1280
|
+
FIT = "FIT"
|
|
1281
|
+
}
|
|
1282
|
+
/** @enumType */
|
|
1283
|
+
type ResizingWithLiterals = Resizing | 'FILL' | 'FIT';
|
|
1284
|
+
declare enum Placement {
|
|
1285
|
+
/** Ribbon placed on the image */
|
|
1286
|
+
IMAGE = "IMAGE",
|
|
1287
|
+
/** Ribbon placed on the product information */
|
|
1288
|
+
PRODUCT_INFO = "PRODUCT_INFO"
|
|
1289
|
+
}
|
|
1290
|
+
/** @enumType */
|
|
1291
|
+
type PlacementWithLiterals = Placement | 'IMAGE' | 'PRODUCT_INFO';
|
|
1292
|
+
declare enum Type {
|
|
1293
|
+
/** Card with visible border and background */
|
|
1294
|
+
CONTAINED = "CONTAINED",
|
|
1295
|
+
/** Card without visible border */
|
|
1296
|
+
FRAMELESS = "FRAMELESS"
|
|
1297
|
+
}
|
|
1298
|
+
/** @enumType */
|
|
1299
|
+
type TypeWithLiterals = Type | 'CONTAINED' | 'FRAMELESS';
|
|
1300
|
+
declare enum Alignment {
|
|
1301
|
+
/** Content aligned to start (left in LTR layouts, right in RTL layouts) */
|
|
1302
|
+
START = "START",
|
|
1303
|
+
/** Content centered */
|
|
1304
|
+
CENTER = "CENTER",
|
|
1305
|
+
/** Content aligned to end (right in LTR layouts, left in RTL layouts) */
|
|
1306
|
+
END = "END"
|
|
1307
|
+
}
|
|
1308
|
+
/** @enumType */
|
|
1309
|
+
type AlignmentWithLiterals = Alignment | 'START' | 'CENTER' | 'END';
|
|
1310
|
+
declare enum Layout {
|
|
1311
|
+
/** Elements stacked vertically */
|
|
1312
|
+
STACKED = "STACKED",
|
|
1313
|
+
/** Elements arranged horizontally */
|
|
1314
|
+
SIDE_BY_SIDE = "SIDE_BY_SIDE"
|
|
1315
|
+
}
|
|
1316
|
+
/** @enumType */
|
|
1317
|
+
type LayoutWithLiterals = Layout | 'STACKED' | 'SIDE_BY_SIDE';
|
|
1220
1318
|
declare enum AppType {
|
|
1221
1319
|
PRODUCT = "PRODUCT",
|
|
1222
1320
|
EVENT = "EVENT",
|
|
@@ -1234,6 +1332,122 @@ interface EventData {
|
|
|
1234
1332
|
/** Event location. */
|
|
1235
1333
|
location?: string | null;
|
|
1236
1334
|
}
|
|
1335
|
+
interface ButtonStyles {
|
|
1336
|
+
/** Text to display on the button. */
|
|
1337
|
+
buttonText?: string | null;
|
|
1338
|
+
/** Border width in pixels. */
|
|
1339
|
+
borderWidth?: number | null;
|
|
1340
|
+
/** Border radius in pixels. */
|
|
1341
|
+
borderRadius?: number | null;
|
|
1342
|
+
/**
|
|
1343
|
+
* Border color as a hexadecimal value.
|
|
1344
|
+
* @format COLOR_HEX
|
|
1345
|
+
*/
|
|
1346
|
+
borderColor?: string | null;
|
|
1347
|
+
/**
|
|
1348
|
+
* Text color as a hexadecimal value.
|
|
1349
|
+
* @format COLOR_HEX
|
|
1350
|
+
*/
|
|
1351
|
+
textColor?: string | null;
|
|
1352
|
+
/**
|
|
1353
|
+
* Background color as a hexadecimal value.
|
|
1354
|
+
* @format COLOR_HEX
|
|
1355
|
+
*/
|
|
1356
|
+
backgroundColor?: string | null;
|
|
1357
|
+
/**
|
|
1358
|
+
* Border color as a hexadecimal value (hover state).
|
|
1359
|
+
* @format COLOR_HEX
|
|
1360
|
+
*/
|
|
1361
|
+
borderColorHover?: string | null;
|
|
1362
|
+
/**
|
|
1363
|
+
* Text color as a hexadecimal value (hover state).
|
|
1364
|
+
* @format COLOR_HEX
|
|
1365
|
+
*/
|
|
1366
|
+
textColorHover?: string | null;
|
|
1367
|
+
/**
|
|
1368
|
+
* Background color as a hexadecimal value (hover state).
|
|
1369
|
+
* @format COLOR_HEX
|
|
1370
|
+
*/
|
|
1371
|
+
backgroundColorHover?: string | null;
|
|
1372
|
+
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
1373
|
+
buttonSize?: string | null;
|
|
1374
|
+
}
|
|
1375
|
+
interface ImageStyles {
|
|
1376
|
+
/** Whether to hide the image. */
|
|
1377
|
+
hideImage?: boolean | null;
|
|
1378
|
+
/** Position of image. Defaults to `START`. */
|
|
1379
|
+
imagePosition?: PositionWithLiterals;
|
|
1380
|
+
/** Aspect ratio for the image. Defaults to `SQUARE`. */
|
|
1381
|
+
aspectRatio?: AspectRatioWithLiterals;
|
|
1382
|
+
/** How the image should be resized. Defaults to `FILL`. */
|
|
1383
|
+
resizing?: ResizingWithLiterals;
|
|
1384
|
+
/**
|
|
1385
|
+
* Image border color as a hexadecimal value.
|
|
1386
|
+
* @format COLOR_HEX
|
|
1387
|
+
*/
|
|
1388
|
+
borderColor?: string | null;
|
|
1389
|
+
/** Image border width in pixels. */
|
|
1390
|
+
borderWidth?: number | null;
|
|
1391
|
+
/** Image border radius in pixels. */
|
|
1392
|
+
borderRadius?: number | null;
|
|
1393
|
+
}
|
|
1394
|
+
interface RibbonStyles {
|
|
1395
|
+
/** Text to display on the ribbon. */
|
|
1396
|
+
ribbonText?: string | null;
|
|
1397
|
+
/**
|
|
1398
|
+
* Ribbon background color as a hexadecimal value.
|
|
1399
|
+
* @format COLOR_HEX
|
|
1400
|
+
*/
|
|
1401
|
+
backgroundColor?: string | null;
|
|
1402
|
+
/**
|
|
1403
|
+
* Ribbon text color as a hexadecimal value.
|
|
1404
|
+
* @format COLOR_HEX
|
|
1405
|
+
*/
|
|
1406
|
+
textColor?: string | null;
|
|
1407
|
+
/**
|
|
1408
|
+
* Ribbon border color as a hexadecimal value.
|
|
1409
|
+
* @format COLOR_HEX
|
|
1410
|
+
*/
|
|
1411
|
+
borderColor?: string | null;
|
|
1412
|
+
/** Ribbon border width in pixels. */
|
|
1413
|
+
borderWidth?: number | null;
|
|
1414
|
+
/** Ribbon border radius in pixels. */
|
|
1415
|
+
borderRadius?: number | null;
|
|
1416
|
+
/** Placement of the ribbon. Defaults to `IMAGE`. */
|
|
1417
|
+
ribbonPlacement?: PlacementWithLiterals;
|
|
1418
|
+
}
|
|
1419
|
+
interface CardStyles {
|
|
1420
|
+
/**
|
|
1421
|
+
* Card background color as a hexadecimal value.
|
|
1422
|
+
* @format COLOR_HEX
|
|
1423
|
+
*/
|
|
1424
|
+
backgroundColor?: string | null;
|
|
1425
|
+
/**
|
|
1426
|
+
* Card border color as a hexadecimal value.
|
|
1427
|
+
* @format COLOR_HEX
|
|
1428
|
+
*/
|
|
1429
|
+
borderColor?: string | null;
|
|
1430
|
+
/** Card border width in pixels. */
|
|
1431
|
+
borderWidth?: number | null;
|
|
1432
|
+
/** Card border radius in pixels. */
|
|
1433
|
+
borderRadius?: number | null;
|
|
1434
|
+
/** Card type. Defaults to `CONTAINED`. */
|
|
1435
|
+
type?: TypeWithLiterals;
|
|
1436
|
+
/** Content alignment. Defaults to `START`. */
|
|
1437
|
+
alignment?: AlignmentWithLiterals;
|
|
1438
|
+
/** Layout for title and price. Defaults to `STACKED`. */
|
|
1439
|
+
titlePriceLayout?: LayoutWithLiterals;
|
|
1440
|
+
/**
|
|
1441
|
+
* Title text color as a hexadecimal value.
|
|
1442
|
+
* @format COLOR_HEX
|
|
1443
|
+
*/
|
|
1444
|
+
titleColor?: string | null;
|
|
1445
|
+
/**
|
|
1446
|
+
* Text color as a hexadecimal value.
|
|
1447
|
+
* @format COLOR_HEX
|
|
1448
|
+
*/
|
|
1449
|
+
textColor?: string | null;
|
|
1450
|
+
}
|
|
1237
1451
|
interface VideoData {
|
|
1238
1452
|
/** Styling for the video's container. */
|
|
1239
1453
|
containerData?: PluginContainerData;
|
|
@@ -1406,6 +1620,8 @@ declare enum NullValue {
|
|
|
1406
1620
|
/** Null value. */
|
|
1407
1621
|
NULL_VALUE = "NULL_VALUE"
|
|
1408
1622
|
}
|
|
1623
|
+
/** @enumType */
|
|
1624
|
+
type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
1409
1625
|
/**
|
|
1410
1626
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
1411
1627
|
*
|
|
@@ -1812,13 +2028,105 @@ interface MemberAboutCreatedEnvelope {
|
|
|
1812
2028
|
entity: MemberAbout;
|
|
1813
2029
|
metadata: EventMetadata;
|
|
1814
2030
|
}
|
|
2031
|
+
/**
|
|
2032
|
+
* Triggered when a member's "About" section content is created.
|
|
2033
|
+
* @permissionScope Manage Members
|
|
2034
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
2035
|
+
* @permissionScope Manage Challenges
|
|
2036
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2037
|
+
* @permissionScope Read Members and Contacts - all read permissions
|
|
2038
|
+
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
|
2039
|
+
* @permissionScope Read Members
|
|
2040
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
2041
|
+
* @permissionScope Manage Members and Contacts - all permissions
|
|
2042
|
+
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
2043
|
+
* @permissionId MEMBERS.MEMBER_ABOUT_READ
|
|
2044
|
+
* @webhook
|
|
2045
|
+
* @eventType wix.members.about.v2.member_about_created
|
|
2046
|
+
* @serviceIdentifier wix.members.about.v2.MembersAbout
|
|
2047
|
+
* @slug created
|
|
2048
|
+
* @documentationMaturity preview
|
|
2049
|
+
*/
|
|
2050
|
+
declare function onMemberAboutCreated(handler: (event: MemberAboutCreatedEnvelope) => void | Promise<void>): void;
|
|
1815
2051
|
interface MemberAboutDeletedEnvelope {
|
|
1816
2052
|
metadata: EventMetadata;
|
|
1817
2053
|
}
|
|
2054
|
+
/**
|
|
2055
|
+
* Triggered when a member's "About" section content is deleted.
|
|
2056
|
+
* @permissionScope Manage Members
|
|
2057
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
2058
|
+
* @permissionScope Manage Challenges
|
|
2059
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2060
|
+
* @permissionScope Read Members and Contacts - all read permissions
|
|
2061
|
+
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
|
2062
|
+
* @permissionScope Read Members
|
|
2063
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
2064
|
+
* @permissionScope Manage Members and Contacts - all permissions
|
|
2065
|
+
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
2066
|
+
* @permissionId MEMBERS.MEMBER_ABOUT_READ
|
|
2067
|
+
* @webhook
|
|
2068
|
+
* @eventType wix.members.about.v2.member_about_deleted
|
|
2069
|
+
* @serviceIdentifier wix.members.about.v2.MembersAbout
|
|
2070
|
+
* @slug deleted
|
|
2071
|
+
* @documentationMaturity preview
|
|
2072
|
+
*/
|
|
2073
|
+
declare function onMemberAboutDeleted(handler: (event: MemberAboutDeletedEnvelope) => void | Promise<void>): void;
|
|
1818
2074
|
interface MemberAboutUpdatedEnvelope {
|
|
1819
2075
|
entity: MemberAbout;
|
|
1820
2076
|
metadata: EventMetadata;
|
|
1821
2077
|
}
|
|
2078
|
+
/**
|
|
2079
|
+
* Triggered when a member's "About" section content is updated.
|
|
2080
|
+
* @permissionScope Manage Members
|
|
2081
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
2082
|
+
* @permissionScope Manage Challenges
|
|
2083
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2084
|
+
* @permissionScope Read Members and Contacts - all read permissions
|
|
2085
|
+
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
|
2086
|
+
* @permissionScope Read Members
|
|
2087
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
2088
|
+
* @permissionScope Manage Members and Contacts - all permissions
|
|
2089
|
+
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
2090
|
+
* @permissionId MEMBERS.MEMBER_ABOUT_READ
|
|
2091
|
+
* @webhook
|
|
2092
|
+
* @eventType wix.members.about.v2.member_about_updated
|
|
2093
|
+
* @serviceIdentifier wix.members.about.v2.MembersAbout
|
|
2094
|
+
* @slug updated
|
|
2095
|
+
* @documentationMaturity preview
|
|
2096
|
+
*/
|
|
2097
|
+
declare function onMemberAboutUpdated(handler: (event: MemberAboutUpdatedEnvelope) => void | Promise<void>): void;
|
|
2098
|
+
/**
|
|
2099
|
+
* Creates the "About" section content for a member.
|
|
2100
|
+
* @param memberAbout - The "About" section content to create.
|
|
2101
|
+
* @public
|
|
2102
|
+
* @documentationMaturity preview
|
|
2103
|
+
* @requiredField memberAbout
|
|
2104
|
+
* @requiredField memberAbout.content
|
|
2105
|
+
* @permissionId MEMBERS.MEMBER_ABOUT_CREATE
|
|
2106
|
+
* @applicableIdentity APP
|
|
2107
|
+
* @applicableIdentity MEMBER
|
|
2108
|
+
* @returns The created "About" section content.
|
|
2109
|
+
* @fqn wix.members.about.v2.MembersAbout.CreateMemberAbout
|
|
2110
|
+
*/
|
|
2111
|
+
declare function createMemberAbout(memberAbout: NonNullablePaths<MemberAbout, `content`>): Promise<MemberAbout>;
|
|
2112
|
+
/**
|
|
2113
|
+
* Updates the "About" section content for a member.
|
|
2114
|
+
*
|
|
2115
|
+
* 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.
|
|
2116
|
+
* @param _id - ID of the "About" section content.
|
|
2117
|
+
* @public
|
|
2118
|
+
* @documentationMaturity preview
|
|
2119
|
+
* @requiredField _id
|
|
2120
|
+
* @requiredField memberAbout
|
|
2121
|
+
* @requiredField memberAbout.content
|
|
2122
|
+
* @requiredField memberAbout.revision
|
|
2123
|
+
* @permissionId MEMBERS.MEMBER_ABOUT_UPDATE
|
|
2124
|
+
* @applicableIdentity APP
|
|
2125
|
+
* @applicableIdentity MEMBER
|
|
2126
|
+
* @returns The updated "About" section content.
|
|
2127
|
+
* @fqn wix.members.about.v2.MembersAbout.UpdateMemberAbout
|
|
2128
|
+
*/
|
|
2129
|
+
declare function updateMemberAbout(_id: string, memberAbout: NonNullablePaths<UpdateMemberAbout, `content` | `revision`>): Promise<MemberAbout>;
|
|
1822
2130
|
interface UpdateMemberAbout {
|
|
1823
2131
|
/**
|
|
1824
2132
|
* ID of the "About" section content.
|
|
@@ -1836,6 +2144,64 @@ interface UpdateMemberAbout {
|
|
|
1836
2144
|
/** <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> */
|
|
1837
2145
|
content?: RichContent;
|
|
1838
2146
|
}
|
|
2147
|
+
/**
|
|
2148
|
+
* Deletes the "About" section content for a member.
|
|
2149
|
+
* @param _id - ID of the "About" section content to delete.
|
|
2150
|
+
* @public
|
|
2151
|
+
* @documentationMaturity preview
|
|
2152
|
+
* @requiredField _id
|
|
2153
|
+
* @permissionId MEMBERS.MEMBER_ABOUT_DELETE
|
|
2154
|
+
* @applicableIdentity APP
|
|
2155
|
+
* @applicableIdentity MEMBER
|
|
2156
|
+
* @fqn wix.members.about.v2.MembersAbout.DeleteMemberAbout
|
|
2157
|
+
*/
|
|
2158
|
+
declare function deleteMemberAbout(_id: string): Promise<void>;
|
|
2159
|
+
/**
|
|
2160
|
+
* Retrieves a member's "About" section content.
|
|
2161
|
+
* @param _id - ID of the "About" section content to retrieve.
|
|
2162
|
+
* @public
|
|
2163
|
+
* @documentationMaturity preview
|
|
2164
|
+
* @requiredField _id
|
|
2165
|
+
* @permissionId MEMBERS.MEMBER_ABOUT_READ
|
|
2166
|
+
* @applicableIdentity APP
|
|
2167
|
+
* @applicableIdentity VISITOR
|
|
2168
|
+
* @returns The retrieved "About" section content.
|
|
2169
|
+
* @fqn wix.members.about.v2.MembersAbout.GetMemberAbout
|
|
2170
|
+
*/
|
|
2171
|
+
declare function getMemberAbout(_id: string): Promise<MemberAbout>;
|
|
2172
|
+
/**
|
|
2173
|
+
* Retrieves the "About" section content of the current member.
|
|
2174
|
+
*
|
|
2175
|
+
* >**Note:**
|
|
2176
|
+
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
|
|
2177
|
+
* @public
|
|
2178
|
+
* @documentationMaturity preview
|
|
2179
|
+
* @permissionId MEMBERS.MEMBER_ABOUT_READ
|
|
2180
|
+
* @applicableIdentity APP
|
|
2181
|
+
* @applicableIdentity VISITOR
|
|
2182
|
+
* @fqn wix.members.about.v2.MembersAbout.GetMyMemberAbout
|
|
2183
|
+
*/
|
|
2184
|
+
declare function getMyMemberAbout(): Promise<GetMyMemberAboutResponse>;
|
|
2185
|
+
/**
|
|
2186
|
+
* Creates a query to retrieve a list of "About" sections.
|
|
2187
|
+
*
|
|
2188
|
+
* 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.
|
|
2189
|
+
*
|
|
2190
|
+
* 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.
|
|
2191
|
+
*
|
|
2192
|
+
* 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.
|
|
2193
|
+
*
|
|
2194
|
+
* `queryMemberAbouts()` runs with these `MemberAboutsQueryBuilder` defaults, which you can override:
|
|
2195
|
+
*
|
|
2196
|
+
* - [`limit(50)`](https://dev.wix.com/docs/sdk/backend-modules/members/members-about/member-abouts-query-builder/limit)
|
|
2197
|
+
* @public
|
|
2198
|
+
* @documentationMaturity preview
|
|
2199
|
+
* @permissionId MEMBERS.MEMBER_ABOUT_READ
|
|
2200
|
+
* @applicableIdentity APP
|
|
2201
|
+
* @applicableIdentity VISITOR
|
|
2202
|
+
* @fqn wix.members.about.v2.MembersAbout.QueryMemberAbouts
|
|
2203
|
+
*/
|
|
2204
|
+
declare function queryMemberAbouts(): MemberAboutsQueryBuilder;
|
|
1839
2205
|
interface QueryCursorResult {
|
|
1840
2206
|
cursors: Cursors;
|
|
1841
2207
|
hasNext: () => boolean;
|
|
@@ -1906,4 +2272,4 @@ interface MemberAboutsQueryBuilder {
|
|
|
1906
2272
|
find: () => Promise<MemberAboutsQueryResult>;
|
|
1907
2273
|
}
|
|
1908
2274
|
|
|
1909
|
-
export { type
|
|
2275
|
+
export { type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, BackgroundType, type BackgroundTypeWithLiterals, type BaseEventMetadata, type BlockquoteData, type BookingData, type Border, type BorderColors, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardStyles, type CellStyle, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type CreateMemberAboutRequest, type CreateMemberAboutResponse, Crop, type CropWithLiterals, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeleteMemberAboutRequest, type DeleteMemberAboutResponse, type Design, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type EventMetadata, type FileData, type FileSource, type FileSourceDataOneOf, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetMemberAboutRequest, type GetMemberAboutResponse, type GetMyMemberAboutRequest, type GetMyMemberAboutResponse, type Gradient, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type Item, type ItemDataOneOf, type ItemStyle, Layout, type LayoutCellData, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MemberAbout, type MemberAboutCreatedEnvelope, type MemberAboutDeletedEnvelope, type MemberAboutUpdatedEnvelope, type MemberAboutsQueryBuilder, type MemberAboutsQueryResult, type MentionData, type MessageEnvelope, type Metadata, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, type OrderedListData, Orientation, type OrientationWithLiterals, type PDFSettings, type ParagraphData, type Permissions, Placement, type PlacementWithLiterals, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, Position, type PositionWithLiterals, type QueryMemberAboutsRequest, type QueryMemberAboutsResponse, type Rel, Resizing, type ResizingWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, type Settings, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, Type, type TypeWithLiterals, type UpdateMemberAbout, type UpdateMemberAboutRequest, type UpdateMemberAboutResponse, VerticalAlignment, type VerticalAlignmentWithLiterals, type Video, type VideoData, ViewMode, type ViewModeWithLiterals, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, createMemberAbout, deleteMemberAbout, getMemberAbout, getMyMemberAbout, onMemberAboutCreated, onMemberAboutDeleted, onMemberAboutUpdated, queryMemberAbouts, updateMemberAbout };
|