@wix/members 1.0.99 → 1.0.101
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/package.json +4 -4
- package/type-bundles/context.bundle.d.ts +351 -319
- package/type-bundles/index.bundle.d.ts +351 -319
- package/type-bundles/meta.bundle.d.ts +136 -136
|
@@ -1057,229 +1057,6 @@ interface Group {
|
|
|
1057
1057
|
name?: string;
|
|
1058
1058
|
type?: string;
|
|
1059
1059
|
}
|
|
1060
|
-
/** Registration options. */
|
|
1061
|
-
interface RegisterRequest {
|
|
1062
|
-
/** Login email address for the new site member. */
|
|
1063
|
-
email?: string;
|
|
1064
|
-
/**
|
|
1065
|
-
* Password the new site member will use to log in.
|
|
1066
|
-
*
|
|
1067
|
-
* Must be 4 to 15 ASCII-printable characters.
|
|
1068
|
-
*/
|
|
1069
|
-
password?: string;
|
|
1070
|
-
/** Contact information for the registered member. */
|
|
1071
|
-
contactInfo?: MemberContactInfo;
|
|
1072
|
-
/**
|
|
1073
|
-
* @internal
|
|
1074
|
-
* @internal */
|
|
1075
|
-
dialogData?: DialogData;
|
|
1076
|
-
/**
|
|
1077
|
-
* Sets the privacy status of a new member upon registration.
|
|
1078
|
-
*
|
|
1079
|
-
* - `PUBLIC`: Member is visible to everyone.
|
|
1080
|
-
* - `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
|
|
1081
|
-
* - `UNKNOWN`: Insufficient permissions to get the status.
|
|
1082
|
-
*/
|
|
1083
|
-
profilePrivacyStatus?: SiteMemberPrivacyStatus;
|
|
1084
|
-
/**
|
|
1085
|
-
* @internal
|
|
1086
|
-
* @internal */
|
|
1087
|
-
isOfflineRegistration?: boolean;
|
|
1088
|
-
/**
|
|
1089
|
-
* @internal
|
|
1090
|
-
* @internal */
|
|
1091
|
-
recaptchaToken?: string | null;
|
|
1092
|
-
/**
|
|
1093
|
-
* @internal
|
|
1094
|
-
* @internal */
|
|
1095
|
-
invisibleRecaptchaToken?: string | null;
|
|
1096
|
-
/**
|
|
1097
|
-
* @internal
|
|
1098
|
-
* @internal */
|
|
1099
|
-
emailVerification?: EmailVerification;
|
|
1100
|
-
/**
|
|
1101
|
-
* @internal
|
|
1102
|
-
* @internal */
|
|
1103
|
-
isMobile?: boolean | null;
|
|
1104
|
-
}
|
|
1105
|
-
interface MemberContactInfo {
|
|
1106
|
-
/** First name. */
|
|
1107
|
-
firstName?: string | null;
|
|
1108
|
-
/** Last name. */
|
|
1109
|
-
lastName?: string | null;
|
|
1110
|
-
/** Contact's profile picture. */
|
|
1111
|
-
picture?: string | null;
|
|
1112
|
-
/** Contact's email addresses. */
|
|
1113
|
-
emails?: string[];
|
|
1114
|
-
/** Contact's phone numbers. */
|
|
1115
|
-
phones?: string[];
|
|
1116
|
-
/** List of contact's labels. */
|
|
1117
|
-
labels?: string[];
|
|
1118
|
-
/**
|
|
1119
|
-
* @internal
|
|
1120
|
-
* @internal */
|
|
1121
|
-
locale?: string | null;
|
|
1122
|
-
/**
|
|
1123
|
-
* Any number of custom fields.
|
|
1124
|
-
* [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
|
|
1125
|
-
* are used to store additional information about your site's contacts.
|
|
1126
|
-
* When setting a custom field, use key:value pairs,
|
|
1127
|
-
* where the key matches the names defined in your site's
|
|
1128
|
-
* [Contact List](https://support.wix.com/en/article/accessing-your-contact-list).
|
|
1129
|
-
* You can only set values for custom fields that already exist in the Contacts application.
|
|
1130
|
-
*/
|
|
1131
|
-
customFields?: CustomField$2[];
|
|
1132
|
-
}
|
|
1133
|
-
interface DialogData {
|
|
1134
|
-
visitorId?: string | null;
|
|
1135
|
-
appId?: string | null;
|
|
1136
|
-
initiator?: string | null;
|
|
1137
|
-
}
|
|
1138
|
-
interface EmailVerification {
|
|
1139
|
-
/** ID of the verification process. */
|
|
1140
|
-
verificationId?: string;
|
|
1141
|
-
/**
|
|
1142
|
-
* 6-digit code for verification. Code can be between 100000 and 999999.
|
|
1143
|
-
*
|
|
1144
|
-
*/
|
|
1145
|
-
otp?: string;
|
|
1146
|
-
}
|
|
1147
|
-
interface RegisterResponse {
|
|
1148
|
-
/** Newly registered member. */
|
|
1149
|
-
member?: Member$1;
|
|
1150
|
-
/**
|
|
1151
|
-
* in case the site is open for registration, all members are automatically
|
|
1152
|
-
* approved. they will get a temporary token for obtaining a valid session
|
|
1153
|
-
*/
|
|
1154
|
-
session?: Session;
|
|
1155
|
-
/**
|
|
1156
|
-
* in case the site requires members approval, the registered member
|
|
1157
|
-
* will be an applicant until he's approved. the token can be used as a member
|
|
1158
|
-
* identifier for approval using the `MembersService.Approve` API
|
|
1159
|
-
*/
|
|
1160
|
-
approvalToken?: string | null;
|
|
1161
|
-
}
|
|
1162
|
-
interface Session {
|
|
1163
|
-
/** Session token when the current member is logged into the site. */
|
|
1164
|
-
token?: string | null;
|
|
1165
|
-
}
|
|
1166
|
-
interface EmailVerificationRequired {
|
|
1167
|
-
/** ID of the verification process. */
|
|
1168
|
-
verificationId?: string;
|
|
1169
|
-
}
|
|
1170
|
-
interface EmailVerificationFailed {
|
|
1171
|
-
/** ID of the failed verification process. */
|
|
1172
|
-
verificationId?: string;
|
|
1173
|
-
/** Reason for verification failure. */
|
|
1174
|
-
verificationFailureReason?: VerificationFailureReason;
|
|
1175
|
-
}
|
|
1176
|
-
declare enum VerificationFailureReason {
|
|
1177
|
-
/** Default value - means no failure */
|
|
1178
|
-
UNSPECIFIED = "UNSPECIFIED",
|
|
1179
|
-
/** Bad verification code */
|
|
1180
|
-
BAD_CODE = "BAD_CODE",
|
|
1181
|
-
/** Verification code was not found */
|
|
1182
|
-
NOT_FOUND = "NOT_FOUND",
|
|
1183
|
-
/** Error while sending the code to the user */
|
|
1184
|
-
SEND_CODE_ERROR = "SEND_CODE_ERROR"
|
|
1185
|
-
}
|
|
1186
|
-
interface LoginRequest {
|
|
1187
|
-
/** Login email address. */
|
|
1188
|
-
email?: string;
|
|
1189
|
-
/** Member password. */
|
|
1190
|
-
password?: string;
|
|
1191
|
-
/**
|
|
1192
|
-
* @internal
|
|
1193
|
-
* @internal */
|
|
1194
|
-
recaptchaToken?: string;
|
|
1195
|
-
/**
|
|
1196
|
-
* @internal
|
|
1197
|
-
* @internal */
|
|
1198
|
-
invisibleRecaptchaToken?: string;
|
|
1199
|
-
/**
|
|
1200
|
-
* @internal
|
|
1201
|
-
* @internal */
|
|
1202
|
-
emailVerification?: EmailVerification;
|
|
1203
|
-
/**
|
|
1204
|
-
* @internal
|
|
1205
|
-
* @internal */
|
|
1206
|
-
isMobile?: boolean | null;
|
|
1207
|
-
}
|
|
1208
|
-
/** Session token for logging the member in. */
|
|
1209
|
-
interface LoginResponse {
|
|
1210
|
-
/** Session token. */
|
|
1211
|
-
session?: Session;
|
|
1212
|
-
/** the member's details */
|
|
1213
|
-
member?: Member$1;
|
|
1214
|
-
}
|
|
1215
|
-
interface GetResetPasswordLinkRequest {
|
|
1216
|
-
/** Contact ID of the member whose password will be reset. */
|
|
1217
|
-
contactId?: string;
|
|
1218
|
-
}
|
|
1219
|
-
interface GetResetPasswordLinkResponse {
|
|
1220
|
-
/**
|
|
1221
|
-
* Reset password link.
|
|
1222
|
-
* Valid for one use, up to two weeks from when it is created.
|
|
1223
|
-
*/
|
|
1224
|
-
resetPasswordLink?: string;
|
|
1225
|
-
}
|
|
1226
|
-
interface SendSetPasswordEmailRequest {
|
|
1227
|
-
/** Login email of the member whose password will be set. */
|
|
1228
|
-
email: string;
|
|
1229
|
-
/**
|
|
1230
|
-
* @internal
|
|
1231
|
-
* @internal
|
|
1232
|
-
* @deprecated
|
|
1233
|
-
*/
|
|
1234
|
-
requestedByMember?: boolean;
|
|
1235
|
-
/**
|
|
1236
|
-
* Whether to hide the ignore this email message .
|
|
1237
|
-
*
|
|
1238
|
-
* If `true`, the email tells the member
|
|
1239
|
-
* they can safely ignore
|
|
1240
|
-
* if they did not request the password change.
|
|
1241
|
-
*
|
|
1242
|
-
* Default: `false`.
|
|
1243
|
-
*/
|
|
1244
|
-
hideIgnoreMessage?: boolean;
|
|
1245
|
-
}
|
|
1246
|
-
interface SendSetPasswordEmailResponse {
|
|
1247
|
-
/** Indicates if the request was successfully received. */
|
|
1248
|
-
accepted?: boolean;
|
|
1249
|
-
}
|
|
1250
|
-
interface ResetPasswordRequest {
|
|
1251
|
-
/** Contact ID of the member whose password will be reset. */
|
|
1252
|
-
contactId?: string;
|
|
1253
|
-
}
|
|
1254
|
-
interface ResetPasswordResponse {
|
|
1255
|
-
/** Indicates if the request was successfully received. */
|
|
1256
|
-
accepted?: boolean;
|
|
1257
|
-
}
|
|
1258
|
-
interface SocialLoginRequest extends SocialLoginRequestLoginOneOf {
|
|
1259
|
-
appleLogin?: AppleLogin;
|
|
1260
|
-
googleLogin?: GoogleLogin;
|
|
1261
|
-
facebookLogin?: FacebookLogin;
|
|
1262
|
-
/** Must either pass explicit msid OR signed instance with visitor */
|
|
1263
|
-
metaSiteId?: string | null;
|
|
1264
|
-
}
|
|
1265
|
-
/** @oneof */
|
|
1266
|
-
interface SocialLoginRequestLoginOneOf {
|
|
1267
|
-
appleLogin?: AppleLogin;
|
|
1268
|
-
googleLogin?: GoogleLogin;
|
|
1269
|
-
facebookLogin?: FacebookLogin;
|
|
1270
|
-
}
|
|
1271
|
-
interface AppleLogin {
|
|
1272
|
-
/** JWT signed by apple, contains target (aud), email etc */
|
|
1273
|
-
token?: string;
|
|
1274
|
-
}
|
|
1275
|
-
interface GoogleLogin {
|
|
1276
|
-
/** JWT signed by Google, contains target (aud), email etc */
|
|
1277
|
-
token?: string;
|
|
1278
|
-
}
|
|
1279
|
-
interface FacebookLogin {
|
|
1280
|
-
/** AccessToken created by Facebook, used to later fetch details over API */
|
|
1281
|
-
token?: string;
|
|
1282
|
-
}
|
|
1283
1060
|
interface ListMembersRequest$1 {
|
|
1284
1061
|
/** for paging - maximum number of records to retrieve */
|
|
1285
1062
|
limit?: number;
|
|
@@ -1500,43 +1277,266 @@ interface ApproveMemberRequestMemberIdentifierOneOf {
|
|
|
1500
1277
|
/** Login email address of the member to approve. */
|
|
1501
1278
|
email?: string;
|
|
1502
1279
|
/**
|
|
1503
|
-
* <!--ONLY:VELO
|
|
1504
|
-
* Approval token returned by `register()`.
|
|
1505
|
-
* <!--END:ONLY:VELO-->
|
|
1506
|
-
*/
|
|
1507
|
-
token?: string;
|
|
1280
|
+
* <!--ONLY:VELO
|
|
1281
|
+
* Approval token returned by `register()`.
|
|
1282
|
+
* <!--END:ONLY:VELO-->
|
|
1283
|
+
*/
|
|
1284
|
+
token?: string;
|
|
1285
|
+
}
|
|
1286
|
+
interface ApproveMemberResponse$1 {
|
|
1287
|
+
/** Approval session token. */
|
|
1288
|
+
session?: Session;
|
|
1289
|
+
}
|
|
1290
|
+
interface Session {
|
|
1291
|
+
/** Session token when the current member is logged into the site. */
|
|
1292
|
+
token?: string | null;
|
|
1293
|
+
}
|
|
1294
|
+
interface BlockMemberRequest$2 extends BlockMemberRequestMemberIdentifierOneOf {
|
|
1295
|
+
/** ID of the member to block. */
|
|
1296
|
+
_id?: string;
|
|
1297
|
+
/** Login email address of the member to block. */
|
|
1298
|
+
email?: string;
|
|
1299
|
+
/**
|
|
1300
|
+
* @internal
|
|
1301
|
+
* @internal */
|
|
1302
|
+
source?: Source;
|
|
1303
|
+
}
|
|
1304
|
+
/** @oneof */
|
|
1305
|
+
interface BlockMemberRequestMemberIdentifierOneOf {
|
|
1306
|
+
_id?: string;
|
|
1307
|
+
/** Login email address of the member to block. */
|
|
1308
|
+
email?: string;
|
|
1309
|
+
}
|
|
1310
|
+
declare enum Source {
|
|
1311
|
+
UNKNOWN = "UNKNOWN",
|
|
1312
|
+
HANDLING_SPAM = "HANDLING_SPAM"
|
|
1313
|
+
}
|
|
1314
|
+
interface BlockMemberResponse$2 {
|
|
1315
|
+
}
|
|
1316
|
+
interface MakeMemberOfflineRequest {
|
|
1317
|
+
/** unique identifier of the requested member */
|
|
1318
|
+
_id?: string;
|
|
1319
|
+
}
|
|
1320
|
+
interface MakeMemberOfflineResponse {
|
|
1321
|
+
}
|
|
1322
|
+
/** Registration options. */
|
|
1323
|
+
interface RegisterRequest {
|
|
1324
|
+
/** Login email address for the new site member. */
|
|
1325
|
+
email?: string;
|
|
1326
|
+
/**
|
|
1327
|
+
* Password the new site member will use to log in.
|
|
1328
|
+
*
|
|
1329
|
+
* Must be 4 to 15 ASCII-printable characters.
|
|
1330
|
+
*/
|
|
1331
|
+
password?: string;
|
|
1332
|
+
/** Contact information for the registered member. */
|
|
1333
|
+
contactInfo?: MemberContactInfo;
|
|
1334
|
+
/**
|
|
1335
|
+
* @internal
|
|
1336
|
+
* @internal */
|
|
1337
|
+
dialogData?: DialogData;
|
|
1338
|
+
/**
|
|
1339
|
+
* Sets the privacy status of a new member upon registration.
|
|
1340
|
+
*
|
|
1341
|
+
* - `PUBLIC`: Member is visible to everyone.
|
|
1342
|
+
* - `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
|
|
1343
|
+
* - `UNKNOWN`: Insufficient permissions to get the status.
|
|
1344
|
+
*/
|
|
1345
|
+
profilePrivacyStatus?: SiteMemberPrivacyStatus;
|
|
1346
|
+
/**
|
|
1347
|
+
* @internal
|
|
1348
|
+
* @internal */
|
|
1349
|
+
isOfflineRegistration?: boolean;
|
|
1350
|
+
/**
|
|
1351
|
+
* @internal
|
|
1352
|
+
* @internal */
|
|
1353
|
+
recaptchaToken?: string | null;
|
|
1354
|
+
/**
|
|
1355
|
+
* @internal
|
|
1356
|
+
* @internal */
|
|
1357
|
+
invisibleRecaptchaToken?: string | null;
|
|
1358
|
+
/**
|
|
1359
|
+
* @internal
|
|
1360
|
+
* @internal */
|
|
1361
|
+
emailVerification?: EmailVerification;
|
|
1362
|
+
/**
|
|
1363
|
+
* @internal
|
|
1364
|
+
* @internal */
|
|
1365
|
+
isMobile?: boolean | null;
|
|
1366
|
+
}
|
|
1367
|
+
interface MemberContactInfo {
|
|
1368
|
+
/** First name. */
|
|
1369
|
+
firstName?: string | null;
|
|
1370
|
+
/** Last name. */
|
|
1371
|
+
lastName?: string | null;
|
|
1372
|
+
/** Contact's profile picture. */
|
|
1373
|
+
picture?: string | null;
|
|
1374
|
+
/** Contact's email addresses. */
|
|
1375
|
+
emails?: string[];
|
|
1376
|
+
/** Contact's phone numbers. */
|
|
1377
|
+
phones?: string[];
|
|
1378
|
+
/** List of contact's labels. */
|
|
1379
|
+
labels?: string[];
|
|
1380
|
+
/**
|
|
1381
|
+
* @internal
|
|
1382
|
+
* @internal */
|
|
1383
|
+
locale?: string | null;
|
|
1384
|
+
/**
|
|
1385
|
+
* Any number of custom fields.
|
|
1386
|
+
* [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
|
|
1387
|
+
* are used to store additional information about your site's contacts.
|
|
1388
|
+
* When setting a custom field, use key:value pairs,
|
|
1389
|
+
* where the key matches the names defined in your site's
|
|
1390
|
+
* [Contact List](https://support.wix.com/en/article/accessing-your-contact-list).
|
|
1391
|
+
* You can only set values for custom fields that already exist in the Contacts application.
|
|
1392
|
+
*/
|
|
1393
|
+
customFields?: CustomField$2[];
|
|
1394
|
+
}
|
|
1395
|
+
interface DialogData {
|
|
1396
|
+
visitorId?: string | null;
|
|
1397
|
+
appId?: string | null;
|
|
1398
|
+
initiator?: string | null;
|
|
1399
|
+
}
|
|
1400
|
+
interface EmailVerification {
|
|
1401
|
+
/** ID of the verification process. */
|
|
1402
|
+
verificationId?: string;
|
|
1403
|
+
/**
|
|
1404
|
+
* 6-digit code for verification. Code can be between 100000 and 999999.
|
|
1405
|
+
*
|
|
1406
|
+
*/
|
|
1407
|
+
otp?: string;
|
|
1408
|
+
}
|
|
1409
|
+
interface RegisterResponse {
|
|
1410
|
+
/** Newly registered member. */
|
|
1411
|
+
member?: Member$1;
|
|
1412
|
+
/**
|
|
1413
|
+
* in case the site is open for registration, all members are automatically
|
|
1414
|
+
* approved. they will get a temporary token for obtaining a valid session
|
|
1415
|
+
*/
|
|
1416
|
+
session?: Session;
|
|
1417
|
+
/**
|
|
1418
|
+
* in case the site requires members approval, the registered member
|
|
1419
|
+
* will be an applicant until he's approved. the token can be used as a member
|
|
1420
|
+
* identifier for approval using the `MembersService.Approve` API
|
|
1421
|
+
*/
|
|
1422
|
+
approvalToken?: string | null;
|
|
1423
|
+
}
|
|
1424
|
+
interface EmailVerificationRequired {
|
|
1425
|
+
/** ID of the verification process. */
|
|
1426
|
+
verificationId?: string;
|
|
1427
|
+
}
|
|
1428
|
+
interface EmailVerificationFailed {
|
|
1429
|
+
/** ID of the failed verification process. */
|
|
1430
|
+
verificationId?: string;
|
|
1431
|
+
/** Reason for verification failure. */
|
|
1432
|
+
verificationFailureReason?: VerificationFailureReason;
|
|
1433
|
+
}
|
|
1434
|
+
declare enum VerificationFailureReason {
|
|
1435
|
+
/** Default value - means no failure */
|
|
1436
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
1437
|
+
/** Bad verification code */
|
|
1438
|
+
BAD_CODE = "BAD_CODE",
|
|
1439
|
+
/** Verification code was not found */
|
|
1440
|
+
NOT_FOUND = "NOT_FOUND",
|
|
1441
|
+
/** Error while sending the code to the user */
|
|
1442
|
+
SEND_CODE_ERROR = "SEND_CODE_ERROR"
|
|
1443
|
+
}
|
|
1444
|
+
interface LoginRequest {
|
|
1445
|
+
/** Login email address. */
|
|
1446
|
+
email?: string;
|
|
1447
|
+
/** Member password. */
|
|
1448
|
+
password?: string;
|
|
1449
|
+
/**
|
|
1450
|
+
* @internal
|
|
1451
|
+
* @internal */
|
|
1452
|
+
recaptchaToken?: string;
|
|
1453
|
+
/**
|
|
1454
|
+
* @internal
|
|
1455
|
+
* @internal */
|
|
1456
|
+
invisibleRecaptchaToken?: string;
|
|
1457
|
+
/**
|
|
1458
|
+
* @internal
|
|
1459
|
+
* @internal */
|
|
1460
|
+
emailVerification?: EmailVerification;
|
|
1461
|
+
/**
|
|
1462
|
+
* @internal
|
|
1463
|
+
* @internal */
|
|
1464
|
+
isMobile?: boolean | null;
|
|
1508
1465
|
}
|
|
1509
|
-
|
|
1510
|
-
|
|
1466
|
+
/** Session token for logging the member in. */
|
|
1467
|
+
interface LoginResponse {
|
|
1468
|
+
/** Session token. */
|
|
1511
1469
|
session?: Session;
|
|
1470
|
+
/** the member's details */
|
|
1471
|
+
member?: Member$1;
|
|
1512
1472
|
}
|
|
1513
|
-
interface
|
|
1514
|
-
/** ID of the member
|
|
1515
|
-
|
|
1516
|
-
|
|
1517
|
-
|
|
1473
|
+
interface GetResetPasswordLinkRequest {
|
|
1474
|
+
/** Contact ID of the member whose password will be reset. */
|
|
1475
|
+
contactId?: string;
|
|
1476
|
+
}
|
|
1477
|
+
interface GetResetPasswordLinkResponse {
|
|
1478
|
+
/**
|
|
1479
|
+
* Reset password link.
|
|
1480
|
+
* Valid for one use, up to two weeks from when it is created.
|
|
1481
|
+
*/
|
|
1482
|
+
resetPasswordLink?: string;
|
|
1483
|
+
}
|
|
1484
|
+
interface SendSetPasswordEmailRequest {
|
|
1485
|
+
/** Login email of the member whose password will be set. */
|
|
1486
|
+
email: string;
|
|
1518
1487
|
/**
|
|
1519
1488
|
* @internal
|
|
1520
|
-
* @internal
|
|
1521
|
-
|
|
1489
|
+
* @internal
|
|
1490
|
+
* @deprecated
|
|
1491
|
+
*/
|
|
1492
|
+
requestedByMember?: boolean;
|
|
1493
|
+
/**
|
|
1494
|
+
* Whether to hide the ignore this email message .
|
|
1495
|
+
*
|
|
1496
|
+
* If `true`, the email tells the member
|
|
1497
|
+
* they can safely ignore
|
|
1498
|
+
* if they did not request the password change.
|
|
1499
|
+
*
|
|
1500
|
+
* Default: `false`.
|
|
1501
|
+
*/
|
|
1502
|
+
hideIgnoreMessage?: boolean;
|
|
1522
1503
|
}
|
|
1523
|
-
|
|
1524
|
-
|
|
1525
|
-
|
|
1526
|
-
/** Login email address of the member to block. */
|
|
1527
|
-
email?: string;
|
|
1504
|
+
interface SendSetPasswordEmailResponse {
|
|
1505
|
+
/** Indicates if the request was successfully received. */
|
|
1506
|
+
accepted?: boolean;
|
|
1528
1507
|
}
|
|
1529
|
-
|
|
1530
|
-
|
|
1531
|
-
|
|
1508
|
+
interface ResetPasswordRequest {
|
|
1509
|
+
/** Contact ID of the member whose password will be reset. */
|
|
1510
|
+
contactId?: string;
|
|
1532
1511
|
}
|
|
1533
|
-
interface
|
|
1512
|
+
interface ResetPasswordResponse {
|
|
1513
|
+
/** Indicates if the request was successfully received. */
|
|
1514
|
+
accepted?: boolean;
|
|
1534
1515
|
}
|
|
1535
|
-
interface
|
|
1536
|
-
|
|
1537
|
-
|
|
1516
|
+
interface SocialLoginRequest extends SocialLoginRequestLoginOneOf {
|
|
1517
|
+
appleLogin?: AppleLogin;
|
|
1518
|
+
googleLogin?: GoogleLogin;
|
|
1519
|
+
facebookLogin?: FacebookLogin;
|
|
1520
|
+
/** Must either pass explicit msid OR signed instance with visitor */
|
|
1521
|
+
metaSiteId?: string | null;
|
|
1538
1522
|
}
|
|
1539
|
-
|
|
1523
|
+
/** @oneof */
|
|
1524
|
+
interface SocialLoginRequestLoginOneOf {
|
|
1525
|
+
appleLogin?: AppleLogin;
|
|
1526
|
+
googleLogin?: GoogleLogin;
|
|
1527
|
+
facebookLogin?: FacebookLogin;
|
|
1528
|
+
}
|
|
1529
|
+
interface AppleLogin {
|
|
1530
|
+
/** JWT signed by apple, contains target (aud), email etc */
|
|
1531
|
+
token?: string;
|
|
1532
|
+
}
|
|
1533
|
+
interface GoogleLogin {
|
|
1534
|
+
/** JWT signed by Google, contains target (aud), email etc */
|
|
1535
|
+
token?: string;
|
|
1536
|
+
}
|
|
1537
|
+
interface FacebookLogin {
|
|
1538
|
+
/** AccessToken created by Facebook, used to later fetch details over API */
|
|
1539
|
+
token?: string;
|
|
1540
1540
|
}
|
|
1541
1541
|
interface CustomFieldNonNullableFields$1 {
|
|
1542
1542
|
numValue: number;
|
|
@@ -1560,6 +1560,9 @@ interface MemberNonNullableFields$1 {
|
|
|
1560
1560
|
picture: string;
|
|
1561
1561
|
groups: GroupNonNullableFields[];
|
|
1562
1562
|
}
|
|
1563
|
+
interface ChangeLoginEmailResponseNonNullableFields {
|
|
1564
|
+
member?: MemberNonNullableFields$1;
|
|
1565
|
+
}
|
|
1563
1566
|
interface RegisterResponseNonNullableFields {
|
|
1564
1567
|
member?: MemberNonNullableFields$1;
|
|
1565
1568
|
}
|
|
@@ -1569,8 +1572,29 @@ interface LoginResponseNonNullableFields {
|
|
|
1569
1572
|
interface SendSetPasswordEmailResponseNonNullableFields {
|
|
1570
1573
|
accepted: boolean;
|
|
1571
1574
|
}
|
|
1572
|
-
interface
|
|
1573
|
-
|
|
1575
|
+
interface ChangeLoginEmailOptions {
|
|
1576
|
+
/**
|
|
1577
|
+
* @internal
|
|
1578
|
+
* @internal */
|
|
1579
|
+
revokeCurrentSessions?: boolean | null;
|
|
1580
|
+
}
|
|
1581
|
+
interface ApproveOptions extends ApproveMemberRequestMemberIdentifierOneOf {
|
|
1582
|
+
/** ID of the member to approve. */
|
|
1583
|
+
_id?: string;
|
|
1584
|
+
/** Login email address of the member to approve. */
|
|
1585
|
+
email?: string;
|
|
1586
|
+
/** Approval token returned by the [`register()`](#register) function. */
|
|
1587
|
+
token?: string;
|
|
1588
|
+
}
|
|
1589
|
+
interface BlockOptions extends BlockMemberRequestMemberIdentifierOneOf {
|
|
1590
|
+
/** ID of the member to block. */
|
|
1591
|
+
_id?: string;
|
|
1592
|
+
/** Login email address of the member to block. */
|
|
1593
|
+
email?: string;
|
|
1594
|
+
/**
|
|
1595
|
+
* @internal
|
|
1596
|
+
* @internal */
|
|
1597
|
+
source?: Source;
|
|
1574
1598
|
}
|
|
1575
1599
|
interface RegisterOptions {
|
|
1576
1600
|
/** Contact information for the registered member. */
|
|
@@ -1626,31 +1650,51 @@ interface SendSetPasswordEmailOptions {
|
|
|
1626
1650
|
*/
|
|
1627
1651
|
hideIgnoreMessage?: boolean;
|
|
1628
1652
|
}
|
|
1629
|
-
|
|
1653
|
+
|
|
1654
|
+
declare function changeLoginEmail$1(httpClient: HttpClient): ChangeLoginEmailSignature;
|
|
1655
|
+
interface ChangeLoginEmailSignature {
|
|
1630
1656
|
/**
|
|
1631
|
-
*
|
|
1632
|
-
*
|
|
1633
|
-
|
|
1657
|
+
* Changes a member's login email address.
|
|
1658
|
+
*
|
|
1659
|
+
* After running this function, the specified member can log in with the new email address. If the member uses social login (for example, Google login) and the member tries to log in with the old email address, they will be re-registered with the old email address.
|
|
1660
|
+
*
|
|
1661
|
+
* Site collaborators can use `changeLoginEmail()` to change another member's login email. Members who are not site collaborators can use `changeLoginEmail()` to change their own login email only.
|
|
1662
|
+
*
|
|
1663
|
+
* > **Note:** `changeLoginEmail()` cannot be used to change the login email of a site collaborator. Site collaborators can change their login emails from their Wix [account settings](https://manage.wix.com/account/account-settings).
|
|
1664
|
+
* @param - Member ID.
|
|
1665
|
+
* @param - New login email address.
|
|
1666
|
+
* @param - Options for changing a login email address.
|
|
1667
|
+
*/
|
|
1668
|
+
(_id: string, newEmail: string, options?: ChangeLoginEmailOptions | undefined): Promise<ChangeLoginEmailResponse & ChangeLoginEmailResponseNonNullableFields>;
|
|
1634
1669
|
}
|
|
1635
|
-
|
|
1636
|
-
|
|
1637
|
-
|
|
1638
|
-
|
|
1639
|
-
|
|
1640
|
-
|
|
1641
|
-
|
|
1670
|
+
declare function approve$1(httpClient: HttpClient): ApproveSignature;
|
|
1671
|
+
interface ApproveSignature {
|
|
1672
|
+
/**
|
|
1673
|
+
* Approves a pending member using an ID, email address or approval token.
|
|
1674
|
+
*
|
|
1675
|
+
* Tokens must be approved within 30 hours of token creation.
|
|
1676
|
+
* Use the `approvalToken` parameter returned from the
|
|
1677
|
+
* [`register()`](#register) function when approving a member by `token`.
|
|
1678
|
+
*
|
|
1679
|
+
* > **Note:**
|
|
1680
|
+
* > A new member's status is `"PENDING"` when the site's membership policy is set to manual approval.
|
|
1681
|
+
* > To learn more about setting your site's membership approval policy, see
|
|
1682
|
+
* > [Editing Your Member Signup Settings](https://support.wix.com/en/article/editing-your-member-signup-settings-for-the-default-form).
|
|
1683
|
+
*
|
|
1684
|
+
* Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
|
|
1685
|
+
*/
|
|
1686
|
+
(options?: ApproveOptions | undefined): Promise<ApproveMemberResponse$1>;
|
|
1642
1687
|
}
|
|
1643
|
-
|
|
1644
|
-
|
|
1645
|
-
_id?: string;
|
|
1646
|
-
/** Login email address of the member to block. */
|
|
1647
|
-
email?: string;
|
|
1688
|
+
declare function block$1(httpClient: HttpClient): BlockSignature;
|
|
1689
|
+
interface BlockSignature {
|
|
1648
1690
|
/**
|
|
1649
|
-
*
|
|
1650
|
-
*
|
|
1651
|
-
|
|
1691
|
+
* Blocks a member from logging in to the site using an ID or email address.
|
|
1692
|
+
*
|
|
1693
|
+
* To unblock the member and allow them to log in to the site, use the [`approve()`](#approve) function.
|
|
1694
|
+
* @param - Options for blocking a member from logging in.
|
|
1695
|
+
*/
|
|
1696
|
+
(options?: BlockOptions | undefined): Promise<void>;
|
|
1652
1697
|
}
|
|
1653
|
-
|
|
1654
1698
|
declare function register$1(httpClient: HttpClient): RegisterSignature;
|
|
1655
1699
|
interface RegisterSignature {
|
|
1656
1700
|
/**
|
|
@@ -1695,57 +1739,13 @@ interface SendSetPasswordEmailSignature {
|
|
|
1695
1739
|
*/
|
|
1696
1740
|
(email: string, options?: SendSetPasswordEmailOptions | undefined): Promise<SendSetPasswordEmailResponse & SendSetPasswordEmailResponseNonNullableFields>;
|
|
1697
1741
|
}
|
|
1698
|
-
declare function changeLoginEmail$1(httpClient: HttpClient): ChangeLoginEmailSignature;
|
|
1699
|
-
interface ChangeLoginEmailSignature {
|
|
1700
|
-
/**
|
|
1701
|
-
* Changes a member's login email address.
|
|
1702
|
-
*
|
|
1703
|
-
* After running this function, the specified member can log in with the new email address. If the member uses social login (for example, Google login) and the member tries to log in with the old email address, they will be re-registered with the old email address.
|
|
1704
|
-
*
|
|
1705
|
-
* Site collaborators can use `changeLoginEmail()` to change another member's login email. Members who are not site collaborators can use `changeLoginEmail()` to change their own login email only.
|
|
1706
|
-
*
|
|
1707
|
-
* > **Note:** `changeLoginEmail()` cannot be used to change the login email of a site collaborator. Site collaborators can change their login emails from their Wix [account settings](https://manage.wix.com/account/account-settings).
|
|
1708
|
-
* @param - Member ID.
|
|
1709
|
-
* @param - New login email address.
|
|
1710
|
-
* @param - Options for changing a login email address.
|
|
1711
|
-
*/
|
|
1712
|
-
(_id: string, newEmail: string, options?: ChangeLoginEmailOptions | undefined): Promise<ChangeLoginEmailResponse & ChangeLoginEmailResponseNonNullableFields>;
|
|
1713
|
-
}
|
|
1714
|
-
declare function approve$1(httpClient: HttpClient): ApproveSignature;
|
|
1715
|
-
interface ApproveSignature {
|
|
1716
|
-
/**
|
|
1717
|
-
* Approves a pending member using an ID, email address or approval token.
|
|
1718
|
-
*
|
|
1719
|
-
* Tokens must be approved within 30 hours of token creation.
|
|
1720
|
-
* Use the `approvalToken` parameter returned from the
|
|
1721
|
-
* [`register()`](#register) function when approving a member by `token`.
|
|
1722
|
-
*
|
|
1723
|
-
* > **Note:**
|
|
1724
|
-
* > A new member's status is `"PENDING"` when the site's membership policy is set to manual approval.
|
|
1725
|
-
* > To learn more about setting your site's membership approval policy, see
|
|
1726
|
-
* > [Editing Your Member Signup Settings](https://support.wix.com/en/article/editing-your-member-signup-settings-for-the-default-form).
|
|
1727
|
-
*
|
|
1728
|
-
* Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
|
|
1729
|
-
*/
|
|
1730
|
-
(options?: ApproveOptions | undefined): Promise<ApproveMemberResponse$1>;
|
|
1731
|
-
}
|
|
1732
|
-
declare function block$1(httpClient: HttpClient): BlockSignature;
|
|
1733
|
-
interface BlockSignature {
|
|
1734
|
-
/**
|
|
1735
|
-
* Blocks a member from logging in to the site using an ID or email address.
|
|
1736
|
-
*
|
|
1737
|
-
* To unblock the member and allow them to log in to the site, use the [`approve()`](#approve) function.
|
|
1738
|
-
* @param - Options for blocking a member from logging in.
|
|
1739
|
-
*/
|
|
1740
|
-
(options?: BlockOptions | undefined): Promise<void>;
|
|
1741
|
-
}
|
|
1742
1742
|
|
|
1743
|
-
declare const register: BuildRESTFunction<typeof register$1> & typeof register$1;
|
|
1744
|
-
declare const login: BuildRESTFunction<typeof login$1> & typeof login$1;
|
|
1745
|
-
declare const sendSetPasswordEmail: BuildRESTFunction<typeof sendSetPasswordEmail$1> & typeof sendSetPasswordEmail$1;
|
|
1746
1743
|
declare const changeLoginEmail: BuildRESTFunction<typeof changeLoginEmail$1> & typeof changeLoginEmail$1;
|
|
1747
1744
|
declare const approve: BuildRESTFunction<typeof approve$1> & typeof approve$1;
|
|
1748
1745
|
declare const block: BuildRESTFunction<typeof block$1> & typeof block$1;
|
|
1746
|
+
declare const register: BuildRESTFunction<typeof register$1> & typeof register$1;
|
|
1747
|
+
declare const login: BuildRESTFunction<typeof login$1> & typeof login$1;
|
|
1748
|
+
declare const sendSetPasswordEmail: BuildRESTFunction<typeof sendSetPasswordEmail$1> & typeof sendSetPasswordEmail$1;
|
|
1749
1749
|
|
|
1750
1750
|
type context$7_AppleLogin = AppleLogin;
|
|
1751
1751
|
type context$7_ApproveMemberRequestMemberIdentifierOneOf = ApproveMemberRequestMemberIdentifierOneOf;
|
|
@@ -2365,6 +2365,38 @@ interface UserMembersQueryResult extends QueryCursorResult {
|
|
|
2365
2365
|
prev: () => Promise<UserMembersQueryResult>;
|
|
2366
2366
|
}
|
|
2367
2367
|
interface UserMembersQueryBuilder {
|
|
2368
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2369
|
+
* @param value - Value to compare against.
|
|
2370
|
+
* @documentationMaturity preview
|
|
2371
|
+
*/
|
|
2372
|
+
eq: (propertyName: 'memberId' | 'userId' | 'siteMembersInstanceId', value: any) => UserMembersQueryBuilder;
|
|
2373
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
2374
|
+
* @param value - Value to compare against.
|
|
2375
|
+
* @documentationMaturity preview
|
|
2376
|
+
*/
|
|
2377
|
+
ne: (propertyName: 'memberId' | 'userId' | 'siteMembersInstanceId', value: any) => UserMembersQueryBuilder;
|
|
2378
|
+
/** @param propertyName - Property whose value is compared with `string`.
|
|
2379
|
+
* @param string - String to compare against. Case-insensitive.
|
|
2380
|
+
* @documentationMaturity preview
|
|
2381
|
+
*/
|
|
2382
|
+
startsWith: (propertyName: 'memberId' | 'userId' | 'siteMembersInstanceId', value: string) => UserMembersQueryBuilder;
|
|
2383
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
2384
|
+
* @param values - List of values to compare against.
|
|
2385
|
+
* @documentationMaturity preview
|
|
2386
|
+
*/
|
|
2387
|
+
hasSome: (propertyName: 'memberId' | 'userId' | 'siteMembersInstanceId', value: any[]) => UserMembersQueryBuilder;
|
|
2388
|
+
/** @documentationMaturity preview */
|
|
2389
|
+
in: (propertyName: 'memberId' | 'userId' | 'siteMembersInstanceId', value: any) => UserMembersQueryBuilder;
|
|
2390
|
+
/** @documentationMaturity preview */
|
|
2391
|
+
exists: (propertyName: 'memberId' | 'userId' | 'siteMembersInstanceId', value: boolean) => UserMembersQueryBuilder;
|
|
2392
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
2393
|
+
* @documentationMaturity preview
|
|
2394
|
+
*/
|
|
2395
|
+
ascending: (...propertyNames: Array<'memberId' | 'userId' | 'siteMembersInstanceId'>) => UserMembersQueryBuilder;
|
|
2396
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
2397
|
+
* @documentationMaturity preview
|
|
2398
|
+
*/
|
|
2399
|
+
descending: (...propertyNames: Array<'memberId' | 'userId' | 'siteMembersInstanceId'>) => UserMembersQueryBuilder;
|
|
2368
2400
|
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
2369
2401
|
* @documentationMaturity preview
|
|
2370
2402
|
*/
|