@wix/auto_sdk_identity_authentication 1.0.69 → 1.0.71
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -1
- package/build/cjs/index.js +59 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +188 -1
- package/build/cjs/index.typings.js +59 -0
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +188 -1
- package/build/cjs/meta.js +59 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +1 -1
- package/build/es/index.mjs +52 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +188 -1
- package/build/es/index.typings.mjs +52 -0
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +188 -1
- package/build/es/meta.mjs +52 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +1 -1
- package/build/internal/cjs/index.typings.d.ts +188 -1
- package/build/internal/cjs/meta.d.ts +188 -1
- package/build/internal/es/index.d.mts +1 -1
- package/build/internal/es/index.typings.d.mts +188 -1
- package/build/internal/es/meta.d.mts +188 -1
- package/package.json +2 -2
|
@@ -2,6 +2,102 @@ import { NonNullablePaths } from '@wix/sdk-types';
|
|
|
2
2
|
|
|
3
3
|
interface Authentication {
|
|
4
4
|
}
|
|
5
|
+
/**
|
|
6
|
+
* Published for a passed check as well as a rejected one, so a consumer can tell a rejection rate
|
|
7
|
+
* from a rejection count.
|
|
8
|
+
*
|
|
9
|
+
* The caller's IP, geo and user agent are deliberately not fields: they travel as call-scope aspects
|
|
10
|
+
* in the message headers, which only reach a single-record subscription - a batch handler runs on an
|
|
11
|
+
* orphan CallScope and loses them.
|
|
12
|
+
*/
|
|
13
|
+
interface CaptchaVerification {
|
|
14
|
+
/** @format GUID */
|
|
15
|
+
eventId?: string;
|
|
16
|
+
/** When the check happened, not when this was published. */
|
|
17
|
+
eventTime?: Date | null;
|
|
18
|
+
flow?: CaptchaFlowWithLiterals;
|
|
19
|
+
identityType?: CaptchaIdentityTypeWithLiterals;
|
|
20
|
+
/**
|
|
21
|
+
* Legacy combined outcome. Use result and decision_reason instead.
|
|
22
|
+
* @deprecated Legacy combined outcome. Use result and decision_reason instead.
|
|
23
|
+
* @replacedBy result
|
|
24
|
+
* @targetRemovalDate 2027-04-18
|
|
25
|
+
*/
|
|
26
|
+
outcome?: CaptchaOutcomeWithLiterals;
|
|
27
|
+
captchaKind?: CaptchaKindWithLiterals;
|
|
28
|
+
/**
|
|
29
|
+
* How far the assessment landed from the minimum it was judged against, positive for a pass. A
|
|
30
|
+
* margin rather than a raw score because that minimum differs by surface and OS, so raw scores are
|
|
31
|
+
* not comparable across channels.
|
|
32
|
+
*
|
|
33
|
+
* Absent when no score decided the outcome - an inauthentic token, no token at all, or a
|
|
34
|
+
* PerimeterX escalation where reCAPTCHA itself passed.
|
|
35
|
+
* @min -1
|
|
36
|
+
* @max 1
|
|
37
|
+
*/
|
|
38
|
+
minScoreMargin?: number | null;
|
|
39
|
+
/**
|
|
40
|
+
* Google's reasons for the score: AUTOMATION, UNEXPECTED_ENVIRONMENT, TOO_MUCH_TRAFFIC, ...
|
|
41
|
+
* @maxLength 100
|
|
42
|
+
* @maxSize 100
|
|
43
|
+
*/
|
|
44
|
+
reasons?: string[];
|
|
45
|
+
/** What happened after verification, independently of why. */
|
|
46
|
+
result?: CaptchaResultWithLiterals;
|
|
47
|
+
/** The deciding cause of rejection or escalation. Unspecified for a pass. */
|
|
48
|
+
decisionReason?: CaptchaDecisionReasonWithLiterals;
|
|
49
|
+
}
|
|
50
|
+
declare enum CaptchaFlow {
|
|
51
|
+
REGISTER = "REGISTER",
|
|
52
|
+
/** Not published yet. */
|
|
53
|
+
LOGIN = "LOGIN"
|
|
54
|
+
}
|
|
55
|
+
/** @enumType */
|
|
56
|
+
type CaptchaFlowWithLiterals = CaptchaFlow | 'REGISTER' | 'LOGIN';
|
|
57
|
+
declare enum CaptchaIdentityType {
|
|
58
|
+
USER = "USER",
|
|
59
|
+
/** Not published yet. */
|
|
60
|
+
MEMBER = "MEMBER"
|
|
61
|
+
}
|
|
62
|
+
/** @enumType */
|
|
63
|
+
type CaptchaIdentityTypeWithLiterals = CaptchaIdentityType | 'USER' | 'MEMBER';
|
|
64
|
+
declare enum CaptchaOutcome {
|
|
65
|
+
PASSED = "PASSED",
|
|
66
|
+
LOW_SCORE = "LOW_SCORE",
|
|
67
|
+
/** Rejected as inauthentic, which is independent of the score. */
|
|
68
|
+
INVALID_TOKEN = "INVALID_TOKEN",
|
|
69
|
+
MISSING_TOKEN = "MISSING_TOKEN",
|
|
70
|
+
/**
|
|
71
|
+
* Escalated to a visible challenge. PerimeterX can cause this while reCAPTCHA itself passed, so it
|
|
72
|
+
* does not on its own mean the captcha scored badly - `reasons` distinguishes them.
|
|
73
|
+
*/
|
|
74
|
+
VISIBLE_REQUIRED = "VISIBLE_REQUIRED"
|
|
75
|
+
}
|
|
76
|
+
/** @enumType */
|
|
77
|
+
type CaptchaOutcomeWithLiterals = CaptchaOutcome | 'PASSED' | 'LOW_SCORE' | 'INVALID_TOKEN' | 'MISSING_TOKEN' | 'VISIBLE_REQUIRED';
|
|
78
|
+
declare enum CaptchaKind {
|
|
79
|
+
INVISIBLE = "INVISIBLE",
|
|
80
|
+
VISIBLE = "VISIBLE",
|
|
81
|
+
/** Verified against a site key the client registered itself (branded and headless apps). */
|
|
82
|
+
CLIENT_SITE_KEY = "CLIENT_SITE_KEY"
|
|
83
|
+
}
|
|
84
|
+
/** @enumType */
|
|
85
|
+
type CaptchaKindWithLiterals = CaptchaKind | 'INVISIBLE' | 'VISIBLE' | 'CLIENT_SITE_KEY';
|
|
86
|
+
declare enum CaptchaResult {
|
|
87
|
+
VERIFICATION_PASSED = "VERIFICATION_PASSED",
|
|
88
|
+
VERIFICATION_REJECTED = "VERIFICATION_REJECTED",
|
|
89
|
+
CHALLENGE_REQUIRED = "CHALLENGE_REQUIRED"
|
|
90
|
+
}
|
|
91
|
+
/** @enumType */
|
|
92
|
+
type CaptchaResultWithLiterals = CaptchaResult | 'VERIFICATION_PASSED' | 'VERIFICATION_REJECTED' | 'CHALLENGE_REQUIRED';
|
|
93
|
+
declare enum CaptchaDecisionReason {
|
|
94
|
+
SCORE_BELOW_THRESHOLD = "SCORE_BELOW_THRESHOLD",
|
|
95
|
+
TOKEN_INVALID = "TOKEN_INVALID",
|
|
96
|
+
TOKEN_MISSING = "TOKEN_MISSING",
|
|
97
|
+
PERIMETERX_REJECTED = "PERIMETERX_REJECTED"
|
|
98
|
+
}
|
|
99
|
+
/** @enumType */
|
|
100
|
+
type CaptchaDecisionReasonWithLiterals = CaptchaDecisionReason | 'SCORE_BELOW_THRESHOLD' | 'TOKEN_INVALID' | 'TOKEN_MISSING' | 'PERIMETERX_REJECTED';
|
|
5
101
|
interface RegisterV2Request {
|
|
6
102
|
/** Identifier of the registering member. */
|
|
7
103
|
loginId: LoginId;
|
|
@@ -1082,6 +1178,97 @@ interface GetWebauthnChallengeResponse {
|
|
|
1082
1178
|
/** The challenge that will be used for a WebAuthn authentication ceremony. */
|
|
1083
1179
|
webauthn?: WebAuthnChallengeData;
|
|
1084
1180
|
}
|
|
1181
|
+
interface MessageEnvelope {
|
|
1182
|
+
/**
|
|
1183
|
+
* App instance ID.
|
|
1184
|
+
* @format GUID
|
|
1185
|
+
*/
|
|
1186
|
+
instanceId?: string | null;
|
|
1187
|
+
/**
|
|
1188
|
+
* Event type.
|
|
1189
|
+
* @maxLength 150
|
|
1190
|
+
*/
|
|
1191
|
+
eventType?: string;
|
|
1192
|
+
/** The identification type and identity data. */
|
|
1193
|
+
identity?: IdentificationData;
|
|
1194
|
+
/** Stringify payload. */
|
|
1195
|
+
data?: string;
|
|
1196
|
+
/** Details related to the account */
|
|
1197
|
+
accountInfo?: AccountInfo;
|
|
1198
|
+
}
|
|
1199
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1200
|
+
/**
|
|
1201
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1202
|
+
* @format GUID
|
|
1203
|
+
*/
|
|
1204
|
+
anonymousVisitorId?: string;
|
|
1205
|
+
/**
|
|
1206
|
+
* ID of a site visitor that has logged in to the site.
|
|
1207
|
+
* @format GUID
|
|
1208
|
+
*/
|
|
1209
|
+
memberId?: string;
|
|
1210
|
+
/**
|
|
1211
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1212
|
+
* @format GUID
|
|
1213
|
+
*/
|
|
1214
|
+
wixUserId?: string;
|
|
1215
|
+
/**
|
|
1216
|
+
* ID of an app.
|
|
1217
|
+
* @format GUID
|
|
1218
|
+
*/
|
|
1219
|
+
appId?: string;
|
|
1220
|
+
/** @readonly */
|
|
1221
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1222
|
+
}
|
|
1223
|
+
/** @oneof */
|
|
1224
|
+
interface IdentificationDataIdOneOf {
|
|
1225
|
+
/**
|
|
1226
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1227
|
+
* @format GUID
|
|
1228
|
+
*/
|
|
1229
|
+
anonymousVisitorId?: string;
|
|
1230
|
+
/**
|
|
1231
|
+
* ID of a site visitor that has logged in to the site.
|
|
1232
|
+
* @format GUID
|
|
1233
|
+
*/
|
|
1234
|
+
memberId?: string;
|
|
1235
|
+
/**
|
|
1236
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1237
|
+
* @format GUID
|
|
1238
|
+
*/
|
|
1239
|
+
wixUserId?: string;
|
|
1240
|
+
/**
|
|
1241
|
+
* ID of an app.
|
|
1242
|
+
* @format GUID
|
|
1243
|
+
*/
|
|
1244
|
+
appId?: string;
|
|
1245
|
+
}
|
|
1246
|
+
declare enum WebhookIdentityType {
|
|
1247
|
+
UNKNOWN = "UNKNOWN",
|
|
1248
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1249
|
+
MEMBER = "MEMBER",
|
|
1250
|
+
WIX_USER = "WIX_USER",
|
|
1251
|
+
APP = "APP"
|
|
1252
|
+
}
|
|
1253
|
+
/** @enumType */
|
|
1254
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1255
|
+
interface AccountInfo {
|
|
1256
|
+
/**
|
|
1257
|
+
* ID of the Wix account associated with the event.
|
|
1258
|
+
* @format GUID
|
|
1259
|
+
*/
|
|
1260
|
+
accountId?: string | null;
|
|
1261
|
+
/**
|
|
1262
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
1263
|
+
* @format GUID
|
|
1264
|
+
*/
|
|
1265
|
+
parentAccountId?: string | null;
|
|
1266
|
+
/**
|
|
1267
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
1268
|
+
* @format GUID
|
|
1269
|
+
*/
|
|
1270
|
+
siteId?: string | null;
|
|
1271
|
+
}
|
|
1085
1272
|
/** @docsIgnore */
|
|
1086
1273
|
type RegisterV2ApplicationErrors = {
|
|
1087
1274
|
code?: 'UNIMPLEMENTED_FEATURE';
|
|
@@ -1362,4 +1549,4 @@ interface LogoutOptions {
|
|
|
1362
1549
|
clientId?: string | null;
|
|
1363
1550
|
}
|
|
1364
1551
|
|
|
1365
|
-
export { type Address, AddressTag, type AddressTagWithLiterals, type AddressWrapper, type Authentication, type AuthenticatorConnection, type CallVerifyData, type CaptchaToken, type CaptchaTokenTokenOneOf, type ChangePasswordRequest, type ChangePasswordResponse, type ConnectIdpRequest, type Connection, type ConnectionTypeOneOf, type CustomField, type CustomValue, type CustomValueValueOneOf, DeliveryMethod, type DeliveryMethodWithLiterals, type Email, EmailTag, type EmailTagWithLiterals, type EmailValidationFailure, type ExternalEmailVerifyData, type Factor, FactorStatus, type FactorStatusWithLiterals, FactorType, type FactorTypeWithLiterals, type GetWebauthnChallengeRequest, type GetWebauthnChallengeResponse, type HeadersEntry, type Identity, type IdentityProfile, type IdpConnection, type ListValue, type LoginCallbackRequest, type LoginId, type LoginIdTypeOneOf, type LoginV2ApplicationErrors, type LoginV2Options, type LoginV2Request, type LoginV2ValidationErrors, type LoginWithIdpConnectionRedirectRequest, type LoginWithIdpConnectionRequest, type LoginWithIdpConnectionTokenParamsRequest, type LogoutOptions, type LogoutRequest, type MapValue, type Metadata, type MfaChallengeData, MfaReason, type MfaReasonWithLiterals, type PathParametersEntry, type Phone, PhoneTag, type PhoneTagWithLiterals, PrivacyStatus, type PrivacyStatusWithLiterals, type PushChallengeData, type PushVerifyData, type QueryParametersEntry, type RawHttpRequest, type RawHttpResponse, Reason, type ReasonWithLiterals, type RecaptchaForClientSiteKey, type RecoveryCodeVerifyData, type RegisterV2ApplicationErrors, type RegisterV2Options, type RegisterV2Request, type RegisterV2ValidationErrors, type RequireMfaData, type SecondaryEmail, type SignOnOptions, type SignOnRequest, type SignOnResponse, type SmsVerifyData, type StateMachineResponse, type StateMachineResponseStateDataOneOf, StateType, type StateTypeWithLiterals, Status, StatusName, type StatusNameWithLiterals, type StatusV2, type StatusWithLiterals, TenantType, type TenantTypeWithLiterals, type TotpVerifyData, type V1CustomValue, type V1CustomValueValueOneOf, type V1Factor, type V1ListValue, type V1MapValue, V1Reason, type V1ReasonWithLiterals, type ValidateEmailRequest, type ValidateEmailResponse, type VerificationChallenge, type VerificationChallengeFactorChallengeDataOneOf, type VerifyRequest, type VerifyRequestFactorDataOneOf, type WebAuthnChallengeData, type WebAuthnVerifyData, changePassword, loginV2, logout, registerV2, signOn, validateEmail };
|
|
1552
|
+
export { type AccountInfo, type Address, AddressTag, type AddressTagWithLiterals, type AddressWrapper, type Authentication, type AuthenticatorConnection, type CallVerifyData, CaptchaDecisionReason, type CaptchaDecisionReasonWithLiterals, CaptchaFlow, type CaptchaFlowWithLiterals, CaptchaIdentityType, type CaptchaIdentityTypeWithLiterals, CaptchaKind, type CaptchaKindWithLiterals, CaptchaOutcome, type CaptchaOutcomeWithLiterals, CaptchaResult, type CaptchaResultWithLiterals, type CaptchaToken, type CaptchaTokenTokenOneOf, type CaptchaVerification, type ChangePasswordRequest, type ChangePasswordResponse, type ConnectIdpRequest, type Connection, type ConnectionTypeOneOf, type CustomField, type CustomValue, type CustomValueValueOneOf, DeliveryMethod, type DeliveryMethodWithLiterals, type Email, EmailTag, type EmailTagWithLiterals, type EmailValidationFailure, type ExternalEmailVerifyData, type Factor, FactorStatus, type FactorStatusWithLiterals, FactorType, type FactorTypeWithLiterals, type GetWebauthnChallengeRequest, type GetWebauthnChallengeResponse, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, type Identity, type IdentityProfile, type IdpConnection, type ListValue, type LoginCallbackRequest, type LoginId, type LoginIdTypeOneOf, type LoginV2ApplicationErrors, type LoginV2Options, type LoginV2Request, type LoginV2ValidationErrors, type LoginWithIdpConnectionRedirectRequest, type LoginWithIdpConnectionRequest, type LoginWithIdpConnectionTokenParamsRequest, type LogoutOptions, type LogoutRequest, type MapValue, type MessageEnvelope, type Metadata, type MfaChallengeData, MfaReason, type MfaReasonWithLiterals, type PathParametersEntry, type Phone, PhoneTag, type PhoneTagWithLiterals, PrivacyStatus, type PrivacyStatusWithLiterals, type PushChallengeData, type PushVerifyData, type QueryParametersEntry, type RawHttpRequest, type RawHttpResponse, Reason, type ReasonWithLiterals, type RecaptchaForClientSiteKey, type RecoveryCodeVerifyData, type RegisterV2ApplicationErrors, type RegisterV2Options, type RegisterV2Request, type RegisterV2ValidationErrors, type RequireMfaData, type SecondaryEmail, type SignOnOptions, type SignOnRequest, type SignOnResponse, type SmsVerifyData, type StateMachineResponse, type StateMachineResponseStateDataOneOf, StateType, type StateTypeWithLiterals, Status, StatusName, type StatusNameWithLiterals, type StatusV2, type StatusWithLiterals, TenantType, type TenantTypeWithLiterals, type TotpVerifyData, type V1CustomValue, type V1CustomValueValueOneOf, type V1Factor, type V1ListValue, type V1MapValue, V1Reason, type V1ReasonWithLiterals, type ValidateEmailRequest, type ValidateEmailResponse, type VerificationChallenge, type VerificationChallengeFactorChallengeDataOneOf, type VerifyRequest, type VerifyRequestFactorDataOneOf, type WebAuthnChallengeData, type WebAuthnVerifyData, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, changePassword, loginV2, logout, registerV2, signOn, validateEmail };
|
|
@@ -3,6 +3,102 @@ import '@wix/sdk-types';
|
|
|
3
3
|
|
|
4
4
|
interface Authentication {
|
|
5
5
|
}
|
|
6
|
+
/**
|
|
7
|
+
* Published for a passed check as well as a rejected one, so a consumer can tell a rejection rate
|
|
8
|
+
* from a rejection count.
|
|
9
|
+
*
|
|
10
|
+
* The caller's IP, geo and user agent are deliberately not fields: they travel as call-scope aspects
|
|
11
|
+
* in the message headers, which only reach a single-record subscription - a batch handler runs on an
|
|
12
|
+
* orphan CallScope and loses them.
|
|
13
|
+
*/
|
|
14
|
+
interface CaptchaVerification {
|
|
15
|
+
/** @format GUID */
|
|
16
|
+
eventId?: string;
|
|
17
|
+
/** When the check happened, not when this was published. */
|
|
18
|
+
eventTime?: Date | null;
|
|
19
|
+
flow?: CaptchaFlowWithLiterals;
|
|
20
|
+
identityType?: CaptchaIdentityTypeWithLiterals;
|
|
21
|
+
/**
|
|
22
|
+
* Legacy combined outcome. Use result and decision_reason instead.
|
|
23
|
+
* @deprecated Legacy combined outcome. Use result and decision_reason instead.
|
|
24
|
+
* @replacedBy result
|
|
25
|
+
* @targetRemovalDate 2027-04-18
|
|
26
|
+
*/
|
|
27
|
+
outcome?: CaptchaOutcomeWithLiterals;
|
|
28
|
+
captchaKind?: CaptchaKindWithLiterals;
|
|
29
|
+
/**
|
|
30
|
+
* How far the assessment landed from the minimum it was judged against, positive for a pass. A
|
|
31
|
+
* margin rather than a raw score because that minimum differs by surface and OS, so raw scores are
|
|
32
|
+
* not comparable across channels.
|
|
33
|
+
*
|
|
34
|
+
* Absent when no score decided the outcome - an inauthentic token, no token at all, or a
|
|
35
|
+
* PerimeterX escalation where reCAPTCHA itself passed.
|
|
36
|
+
* @min -1
|
|
37
|
+
* @max 1
|
|
38
|
+
*/
|
|
39
|
+
minScoreMargin?: number | null;
|
|
40
|
+
/**
|
|
41
|
+
* Google's reasons for the score: AUTOMATION, UNEXPECTED_ENVIRONMENT, TOO_MUCH_TRAFFIC, ...
|
|
42
|
+
* @maxLength 100
|
|
43
|
+
* @maxSize 100
|
|
44
|
+
*/
|
|
45
|
+
reasons?: string[];
|
|
46
|
+
/** What happened after verification, independently of why. */
|
|
47
|
+
result?: CaptchaResultWithLiterals;
|
|
48
|
+
/** The deciding cause of rejection or escalation. Unspecified for a pass. */
|
|
49
|
+
decisionReason?: CaptchaDecisionReasonWithLiterals;
|
|
50
|
+
}
|
|
51
|
+
declare enum CaptchaFlow {
|
|
52
|
+
REGISTER = "REGISTER",
|
|
53
|
+
/** Not published yet. */
|
|
54
|
+
LOGIN = "LOGIN"
|
|
55
|
+
}
|
|
56
|
+
/** @enumType */
|
|
57
|
+
type CaptchaFlowWithLiterals = CaptchaFlow | 'REGISTER' | 'LOGIN';
|
|
58
|
+
declare enum CaptchaIdentityType {
|
|
59
|
+
USER = "USER",
|
|
60
|
+
/** Not published yet. */
|
|
61
|
+
MEMBER = "MEMBER"
|
|
62
|
+
}
|
|
63
|
+
/** @enumType */
|
|
64
|
+
type CaptchaIdentityTypeWithLiterals = CaptchaIdentityType | 'USER' | 'MEMBER';
|
|
65
|
+
declare enum CaptchaOutcome {
|
|
66
|
+
PASSED = "PASSED",
|
|
67
|
+
LOW_SCORE = "LOW_SCORE",
|
|
68
|
+
/** Rejected as inauthentic, which is independent of the score. */
|
|
69
|
+
INVALID_TOKEN = "INVALID_TOKEN",
|
|
70
|
+
MISSING_TOKEN = "MISSING_TOKEN",
|
|
71
|
+
/**
|
|
72
|
+
* Escalated to a visible challenge. PerimeterX can cause this while reCAPTCHA itself passed, so it
|
|
73
|
+
* does not on its own mean the captcha scored badly - `reasons` distinguishes them.
|
|
74
|
+
*/
|
|
75
|
+
VISIBLE_REQUIRED = "VISIBLE_REQUIRED"
|
|
76
|
+
}
|
|
77
|
+
/** @enumType */
|
|
78
|
+
type CaptchaOutcomeWithLiterals = CaptchaOutcome | 'PASSED' | 'LOW_SCORE' | 'INVALID_TOKEN' | 'MISSING_TOKEN' | 'VISIBLE_REQUIRED';
|
|
79
|
+
declare enum CaptchaKind {
|
|
80
|
+
INVISIBLE = "INVISIBLE",
|
|
81
|
+
VISIBLE = "VISIBLE",
|
|
82
|
+
/** Verified against a site key the client registered itself (branded and headless apps). */
|
|
83
|
+
CLIENT_SITE_KEY = "CLIENT_SITE_KEY"
|
|
84
|
+
}
|
|
85
|
+
/** @enumType */
|
|
86
|
+
type CaptchaKindWithLiterals = CaptchaKind | 'INVISIBLE' | 'VISIBLE' | 'CLIENT_SITE_KEY';
|
|
87
|
+
declare enum CaptchaResult {
|
|
88
|
+
VERIFICATION_PASSED = "VERIFICATION_PASSED",
|
|
89
|
+
VERIFICATION_REJECTED = "VERIFICATION_REJECTED",
|
|
90
|
+
CHALLENGE_REQUIRED = "CHALLENGE_REQUIRED"
|
|
91
|
+
}
|
|
92
|
+
/** @enumType */
|
|
93
|
+
type CaptchaResultWithLiterals = CaptchaResult | 'VERIFICATION_PASSED' | 'VERIFICATION_REJECTED' | 'CHALLENGE_REQUIRED';
|
|
94
|
+
declare enum CaptchaDecisionReason {
|
|
95
|
+
SCORE_BELOW_THRESHOLD = "SCORE_BELOW_THRESHOLD",
|
|
96
|
+
TOKEN_INVALID = "TOKEN_INVALID",
|
|
97
|
+
TOKEN_MISSING = "TOKEN_MISSING",
|
|
98
|
+
PERIMETERX_REJECTED = "PERIMETERX_REJECTED"
|
|
99
|
+
}
|
|
100
|
+
/** @enumType */
|
|
101
|
+
type CaptchaDecisionReasonWithLiterals = CaptchaDecisionReason | 'SCORE_BELOW_THRESHOLD' | 'TOKEN_INVALID' | 'TOKEN_MISSING' | 'PERIMETERX_REJECTED';
|
|
6
102
|
interface RegisterV2Request {
|
|
7
103
|
/** Identifier of the registering member. */
|
|
8
104
|
loginId: LoginId;
|
|
@@ -1093,6 +1189,97 @@ interface GetWebauthnChallengeResponse {
|
|
|
1093
1189
|
/** The challenge that will be used for a WebAuthn authentication ceremony. */
|
|
1094
1190
|
webauthn?: WebAuthnChallengeData;
|
|
1095
1191
|
}
|
|
1192
|
+
interface MessageEnvelope {
|
|
1193
|
+
/**
|
|
1194
|
+
* App instance ID.
|
|
1195
|
+
* @format GUID
|
|
1196
|
+
*/
|
|
1197
|
+
instanceId?: string | null;
|
|
1198
|
+
/**
|
|
1199
|
+
* Event type.
|
|
1200
|
+
* @maxLength 150
|
|
1201
|
+
*/
|
|
1202
|
+
eventType?: string;
|
|
1203
|
+
/** The identification type and identity data. */
|
|
1204
|
+
identity?: IdentificationData;
|
|
1205
|
+
/** Stringify payload. */
|
|
1206
|
+
data?: string;
|
|
1207
|
+
/** Details related to the account */
|
|
1208
|
+
accountInfo?: AccountInfo;
|
|
1209
|
+
}
|
|
1210
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1211
|
+
/**
|
|
1212
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1213
|
+
* @format GUID
|
|
1214
|
+
*/
|
|
1215
|
+
anonymousVisitorId?: string;
|
|
1216
|
+
/**
|
|
1217
|
+
* ID of a site visitor that has logged in to the site.
|
|
1218
|
+
* @format GUID
|
|
1219
|
+
*/
|
|
1220
|
+
memberId?: string;
|
|
1221
|
+
/**
|
|
1222
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1223
|
+
* @format GUID
|
|
1224
|
+
*/
|
|
1225
|
+
wixUserId?: string;
|
|
1226
|
+
/**
|
|
1227
|
+
* ID of an app.
|
|
1228
|
+
* @format GUID
|
|
1229
|
+
*/
|
|
1230
|
+
appId?: string;
|
|
1231
|
+
/** @readonly */
|
|
1232
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1233
|
+
}
|
|
1234
|
+
/** @oneof */
|
|
1235
|
+
interface IdentificationDataIdOneOf {
|
|
1236
|
+
/**
|
|
1237
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1238
|
+
* @format GUID
|
|
1239
|
+
*/
|
|
1240
|
+
anonymousVisitorId?: string;
|
|
1241
|
+
/**
|
|
1242
|
+
* ID of a site visitor that has logged in to the site.
|
|
1243
|
+
* @format GUID
|
|
1244
|
+
*/
|
|
1245
|
+
memberId?: string;
|
|
1246
|
+
/**
|
|
1247
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1248
|
+
* @format GUID
|
|
1249
|
+
*/
|
|
1250
|
+
wixUserId?: string;
|
|
1251
|
+
/**
|
|
1252
|
+
* ID of an app.
|
|
1253
|
+
* @format GUID
|
|
1254
|
+
*/
|
|
1255
|
+
appId?: string;
|
|
1256
|
+
}
|
|
1257
|
+
declare enum WebhookIdentityType {
|
|
1258
|
+
UNKNOWN = "UNKNOWN",
|
|
1259
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1260
|
+
MEMBER = "MEMBER",
|
|
1261
|
+
WIX_USER = "WIX_USER",
|
|
1262
|
+
APP = "APP"
|
|
1263
|
+
}
|
|
1264
|
+
/** @enumType */
|
|
1265
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1266
|
+
interface AccountInfo {
|
|
1267
|
+
/**
|
|
1268
|
+
* ID of the Wix account associated with the event.
|
|
1269
|
+
* @format GUID
|
|
1270
|
+
*/
|
|
1271
|
+
accountId?: string | null;
|
|
1272
|
+
/**
|
|
1273
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
1274
|
+
* @format GUID
|
|
1275
|
+
*/
|
|
1276
|
+
parentAccountId?: string | null;
|
|
1277
|
+
/**
|
|
1278
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
1279
|
+
* @format GUID
|
|
1280
|
+
*/
|
|
1281
|
+
siteId?: string | null;
|
|
1282
|
+
}
|
|
1096
1283
|
/** @docsIgnore */
|
|
1097
1284
|
type RegisterV2ApplicationErrors = {
|
|
1098
1285
|
code?: 'UNIMPLEMENTED_FEATURE';
|
|
@@ -1225,4 +1412,4 @@ declare function changePassword(): __PublicMethodMetaInfo<'POST', {}, ChangePass
|
|
|
1225
1412
|
declare function signOn(): __PublicMethodMetaInfo<'POST', {}, SignOnRequest$1, SignOnRequest, SignOnResponse$1, SignOnResponse>;
|
|
1226
1413
|
declare function logout(): __PublicMethodMetaInfo<'GET', {}, LogoutRequest$1, LogoutRequest, RawHttpResponse$1, RawHttpResponse>;
|
|
1227
1414
|
|
|
1228
|
-
export { type Address as AddressOriginal, AddressTag as AddressTagOriginal, type AddressTagWithLiterals as AddressTagWithLiteralsOriginal, type AddressWrapper as AddressWrapperOriginal, type Authentication as AuthenticationOriginal, type AuthenticatorConnection as AuthenticatorConnectionOriginal, type CallVerifyData as CallVerifyDataOriginal, type CaptchaToken as CaptchaTokenOriginal, type CaptchaTokenTokenOneOf as CaptchaTokenTokenOneOfOriginal, type ChangePasswordRequest as ChangePasswordRequestOriginal, type ChangePasswordResponse as ChangePasswordResponseOriginal, type ConnectIdpRequest as ConnectIdpRequestOriginal, type Connection as ConnectionOriginal, type ConnectionTypeOneOf as ConnectionTypeOneOfOriginal, type CustomField as CustomFieldOriginal, type CustomValue as CustomValueOriginal, type CustomValueValueOneOf as CustomValueValueOneOfOriginal, DeliveryMethod as DeliveryMethodOriginal, type DeliveryMethodWithLiterals as DeliveryMethodWithLiteralsOriginal, type Email as EmailOriginal, EmailTag as EmailTagOriginal, type EmailTagWithLiterals as EmailTagWithLiteralsOriginal, type EmailValidationFailure as EmailValidationFailureOriginal, type ExternalEmailVerifyData as ExternalEmailVerifyDataOriginal, type Factor as FactorOriginal, FactorStatus as FactorStatusOriginal, type FactorStatusWithLiterals as FactorStatusWithLiteralsOriginal, FactorType as FactorTypeOriginal, type FactorTypeWithLiterals as FactorTypeWithLiteralsOriginal, type GetWebauthnChallengeRequest as GetWebauthnChallengeRequestOriginal, type GetWebauthnChallengeResponse as GetWebauthnChallengeResponseOriginal, type HeadersEntry as HeadersEntryOriginal, type Identity as IdentityOriginal, type IdentityProfile as IdentityProfileOriginal, type IdpConnection as IdpConnectionOriginal, type ListValue as ListValueOriginal, type LoginCallbackRequest as LoginCallbackRequestOriginal, type LoginId as LoginIdOriginal, type LoginIdTypeOneOf as LoginIdTypeOneOfOriginal, type LoginV2ApplicationErrors as LoginV2ApplicationErrorsOriginal, type LoginV2Request as LoginV2RequestOriginal, type LoginV2ValidationErrors as LoginV2ValidationErrorsOriginal, type LoginWithIdpConnectionRedirectRequest as LoginWithIdpConnectionRedirectRequestOriginal, type LoginWithIdpConnectionRequest as LoginWithIdpConnectionRequestOriginal, type LoginWithIdpConnectionTokenParamsRequest as LoginWithIdpConnectionTokenParamsRequestOriginal, type LogoutRequest as LogoutRequestOriginal, type MapValue as MapValueOriginal, type Metadata as MetadataOriginal, type MfaChallengeData as MfaChallengeDataOriginal, MfaReason as MfaReasonOriginal, type MfaReasonWithLiterals as MfaReasonWithLiteralsOriginal, type PathParametersEntry as PathParametersEntryOriginal, type Phone as PhoneOriginal, PhoneTag as PhoneTagOriginal, type PhoneTagWithLiterals as PhoneTagWithLiteralsOriginal, PrivacyStatus as PrivacyStatusOriginal, type PrivacyStatusWithLiterals as PrivacyStatusWithLiteralsOriginal, type PushChallengeData as PushChallengeDataOriginal, type PushVerifyData as PushVerifyDataOriginal, type QueryParametersEntry as QueryParametersEntryOriginal, type RawHttpRequest as RawHttpRequestOriginal, type RawHttpResponse as RawHttpResponseOriginal, Reason as ReasonOriginal, type ReasonWithLiterals as ReasonWithLiteralsOriginal, type RecaptchaForClientSiteKey as RecaptchaForClientSiteKeyOriginal, type RecoveryCodeVerifyData as RecoveryCodeVerifyDataOriginal, type RegisterV2ApplicationErrors as RegisterV2ApplicationErrorsOriginal, type RegisterV2Request as RegisterV2RequestOriginal, type RegisterV2ValidationErrors as RegisterV2ValidationErrorsOriginal, type RequireMfaData as RequireMfaDataOriginal, type SecondaryEmail as SecondaryEmailOriginal, type SignOnRequest as SignOnRequestOriginal, type SignOnResponse as SignOnResponseOriginal, type SmsVerifyData as SmsVerifyDataOriginal, type StateMachineResponse as StateMachineResponseOriginal, type StateMachineResponseStateDataOneOf as StateMachineResponseStateDataOneOfOriginal, StateType as StateTypeOriginal, type StateTypeWithLiterals as StateTypeWithLiteralsOriginal, StatusName as StatusNameOriginal, type StatusNameWithLiterals as StatusNameWithLiteralsOriginal, Status as StatusOriginal, type StatusV2 as StatusV2Original, type StatusWithLiterals as StatusWithLiteralsOriginal, TenantType as TenantTypeOriginal, type TenantTypeWithLiterals as TenantTypeWithLiteralsOriginal, type TotpVerifyData as TotpVerifyDataOriginal, type V1CustomValue as V1CustomValueOriginal, type V1CustomValueValueOneOf as V1CustomValueValueOneOfOriginal, type V1Factor as V1FactorOriginal, type V1ListValue as V1ListValueOriginal, type V1MapValue as V1MapValueOriginal, V1Reason as V1ReasonOriginal, type V1ReasonWithLiterals as V1ReasonWithLiteralsOriginal, type ValidateEmailRequest as ValidateEmailRequestOriginal, type ValidateEmailResponse as ValidateEmailResponseOriginal, type VerificationChallengeFactorChallengeDataOneOf as VerificationChallengeFactorChallengeDataOneOfOriginal, type VerificationChallenge as VerificationChallengeOriginal, type VerifyRequestFactorDataOneOf as VerifyRequestFactorDataOneOfOriginal, type VerifyRequest as VerifyRequestOriginal, type WebAuthnChallengeData as WebAuthnChallengeDataOriginal, type WebAuthnVerifyData as WebAuthnVerifyDataOriginal, type __PublicMethodMetaInfo, changePassword, loginV2, logout, registerV2, signOn, validateEmail };
|
|
1415
|
+
export { type AccountInfo as AccountInfoOriginal, type Address as AddressOriginal, AddressTag as AddressTagOriginal, type AddressTagWithLiterals as AddressTagWithLiteralsOriginal, type AddressWrapper as AddressWrapperOriginal, type Authentication as AuthenticationOriginal, type AuthenticatorConnection as AuthenticatorConnectionOriginal, type CallVerifyData as CallVerifyDataOriginal, CaptchaDecisionReason as CaptchaDecisionReasonOriginal, type CaptchaDecisionReasonWithLiterals as CaptchaDecisionReasonWithLiteralsOriginal, CaptchaFlow as CaptchaFlowOriginal, type CaptchaFlowWithLiterals as CaptchaFlowWithLiteralsOriginal, CaptchaIdentityType as CaptchaIdentityTypeOriginal, type CaptchaIdentityTypeWithLiterals as CaptchaIdentityTypeWithLiteralsOriginal, CaptchaKind as CaptchaKindOriginal, type CaptchaKindWithLiterals as CaptchaKindWithLiteralsOriginal, CaptchaOutcome as CaptchaOutcomeOriginal, type CaptchaOutcomeWithLiterals as CaptchaOutcomeWithLiteralsOriginal, CaptchaResult as CaptchaResultOriginal, type CaptchaResultWithLiterals as CaptchaResultWithLiteralsOriginal, type CaptchaToken as CaptchaTokenOriginal, type CaptchaTokenTokenOneOf as CaptchaTokenTokenOneOfOriginal, type CaptchaVerification as CaptchaVerificationOriginal, type ChangePasswordRequest as ChangePasswordRequestOriginal, type ChangePasswordResponse as ChangePasswordResponseOriginal, type ConnectIdpRequest as ConnectIdpRequestOriginal, type Connection as ConnectionOriginal, type ConnectionTypeOneOf as ConnectionTypeOneOfOriginal, type CustomField as CustomFieldOriginal, type CustomValue as CustomValueOriginal, type CustomValueValueOneOf as CustomValueValueOneOfOriginal, DeliveryMethod as DeliveryMethodOriginal, type DeliveryMethodWithLiterals as DeliveryMethodWithLiteralsOriginal, type Email as EmailOriginal, EmailTag as EmailTagOriginal, type EmailTagWithLiterals as EmailTagWithLiteralsOriginal, type EmailValidationFailure as EmailValidationFailureOriginal, type ExternalEmailVerifyData as ExternalEmailVerifyDataOriginal, type Factor as FactorOriginal, FactorStatus as FactorStatusOriginal, type FactorStatusWithLiterals as FactorStatusWithLiteralsOriginal, FactorType as FactorTypeOriginal, type FactorTypeWithLiterals as FactorTypeWithLiteralsOriginal, type GetWebauthnChallengeRequest as GetWebauthnChallengeRequestOriginal, type GetWebauthnChallengeResponse as GetWebauthnChallengeResponseOriginal, type HeadersEntry as HeadersEntryOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Identity as IdentityOriginal, type IdentityProfile as IdentityProfileOriginal, type IdpConnection as IdpConnectionOriginal, type ListValue as ListValueOriginal, type LoginCallbackRequest as LoginCallbackRequestOriginal, type LoginId as LoginIdOriginal, type LoginIdTypeOneOf as LoginIdTypeOneOfOriginal, type LoginV2ApplicationErrors as LoginV2ApplicationErrorsOriginal, type LoginV2Request as LoginV2RequestOriginal, type LoginV2ValidationErrors as LoginV2ValidationErrorsOriginal, type LoginWithIdpConnectionRedirectRequest as LoginWithIdpConnectionRedirectRequestOriginal, type LoginWithIdpConnectionRequest as LoginWithIdpConnectionRequestOriginal, type LoginWithIdpConnectionTokenParamsRequest as LoginWithIdpConnectionTokenParamsRequestOriginal, type LogoutRequest as LogoutRequestOriginal, type MapValue as MapValueOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type Metadata as MetadataOriginal, type MfaChallengeData as MfaChallengeDataOriginal, MfaReason as MfaReasonOriginal, type MfaReasonWithLiterals as MfaReasonWithLiteralsOriginal, type PathParametersEntry as PathParametersEntryOriginal, type Phone as PhoneOriginal, PhoneTag as PhoneTagOriginal, type PhoneTagWithLiterals as PhoneTagWithLiteralsOriginal, PrivacyStatus as PrivacyStatusOriginal, type PrivacyStatusWithLiterals as PrivacyStatusWithLiteralsOriginal, type PushChallengeData as PushChallengeDataOriginal, type PushVerifyData as PushVerifyDataOriginal, type QueryParametersEntry as QueryParametersEntryOriginal, type RawHttpRequest as RawHttpRequestOriginal, type RawHttpResponse as RawHttpResponseOriginal, Reason as ReasonOriginal, type ReasonWithLiterals as ReasonWithLiteralsOriginal, type RecaptchaForClientSiteKey as RecaptchaForClientSiteKeyOriginal, type RecoveryCodeVerifyData as RecoveryCodeVerifyDataOriginal, type RegisterV2ApplicationErrors as RegisterV2ApplicationErrorsOriginal, type RegisterV2Request as RegisterV2RequestOriginal, type RegisterV2ValidationErrors as RegisterV2ValidationErrorsOriginal, type RequireMfaData as RequireMfaDataOriginal, type SecondaryEmail as SecondaryEmailOriginal, type SignOnRequest as SignOnRequestOriginal, type SignOnResponse as SignOnResponseOriginal, type SmsVerifyData as SmsVerifyDataOriginal, type StateMachineResponse as StateMachineResponseOriginal, type StateMachineResponseStateDataOneOf as StateMachineResponseStateDataOneOfOriginal, StateType as StateTypeOriginal, type StateTypeWithLiterals as StateTypeWithLiteralsOriginal, StatusName as StatusNameOriginal, type StatusNameWithLiterals as StatusNameWithLiteralsOriginal, Status as StatusOriginal, type StatusV2 as StatusV2Original, type StatusWithLiterals as StatusWithLiteralsOriginal, TenantType as TenantTypeOriginal, type TenantTypeWithLiterals as TenantTypeWithLiteralsOriginal, type TotpVerifyData as TotpVerifyDataOriginal, type V1CustomValue as V1CustomValueOriginal, type V1CustomValueValueOneOf as V1CustomValueValueOneOfOriginal, type V1Factor as V1FactorOriginal, type V1ListValue as V1ListValueOriginal, type V1MapValue as V1MapValueOriginal, V1Reason as V1ReasonOriginal, type V1ReasonWithLiterals as V1ReasonWithLiteralsOriginal, type ValidateEmailRequest as ValidateEmailRequestOriginal, type ValidateEmailResponse as ValidateEmailResponseOriginal, type VerificationChallengeFactorChallengeDataOneOf as VerificationChallengeFactorChallengeDataOneOfOriginal, type VerificationChallenge as VerificationChallengeOriginal, type VerifyRequestFactorDataOneOf as VerifyRequestFactorDataOneOfOriginal, type VerifyRequest as VerifyRequestOriginal, type WebAuthnChallengeData as WebAuthnChallengeDataOriginal, type WebAuthnVerifyData as WebAuthnVerifyDataOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, changePassword, loginV2, logout, registerV2, signOn, validateEmail };
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
2
|
import { LoginId, RegisterV2Options, StateMachineResponse, RegisterV2ApplicationErrors, RegisterV2ValidationErrors, ValidateEmailResponse, LoginV2Options, LoginV2ApplicationErrors, LoginV2ValidationErrors, SignOnOptions, SignOnResponse, LogoutOptions, RawHttpResponse } from './index.typings.mjs';
|
|
3
|
-
export { Address, AddressTag, AddressTagWithLiterals, AddressWrapper, Authentication, AuthenticatorConnection, CallVerifyData, CaptchaToken, CaptchaTokenTokenOneOf, ChangePasswordRequest, ChangePasswordResponse, ConnectIdpRequest, Connection, ConnectionTypeOneOf, CustomField, CustomValue, CustomValueValueOneOf, DeliveryMethod, DeliveryMethodWithLiterals, Email, EmailTag, EmailTagWithLiterals, EmailValidationFailure, ExternalEmailVerifyData, Factor, FactorStatus, FactorStatusWithLiterals, FactorType, FactorTypeWithLiterals, GetWebauthnChallengeRequest, GetWebauthnChallengeResponse, HeadersEntry, Identity, IdentityProfile, IdpConnection, ListValue, LoginCallbackRequest, LoginIdTypeOneOf, LoginV2Request, LoginWithIdpConnectionRedirectRequest, LoginWithIdpConnectionRequest, LoginWithIdpConnectionTokenParamsRequest, LogoutRequest, MapValue, Metadata, MfaChallengeData, MfaReason, MfaReasonWithLiterals, PathParametersEntry, Phone, PhoneTag, PhoneTagWithLiterals, PrivacyStatus, PrivacyStatusWithLiterals, PushChallengeData, PushVerifyData, QueryParametersEntry, RawHttpRequest, Reason, ReasonWithLiterals, RecaptchaForClientSiteKey, RecoveryCodeVerifyData, RegisterV2Request, RequireMfaData, SecondaryEmail, SignOnRequest, SmsVerifyData, StateMachineResponseStateDataOneOf, StateType, StateTypeWithLiterals, Status, StatusName, StatusNameWithLiterals, StatusV2, StatusWithLiterals, TenantType, TenantTypeWithLiterals, TotpVerifyData, V1CustomValue, V1CustomValueValueOneOf, V1Factor, V1ListValue, V1MapValue, V1Reason, V1ReasonWithLiterals, ValidateEmailRequest, VerificationChallenge, VerificationChallengeFactorChallengeDataOneOf, VerifyRequest, VerifyRequestFactorDataOneOf, WebAuthnChallengeData, WebAuthnVerifyData } from './index.typings.mjs';
|
|
3
|
+
export { AccountInfo, Address, AddressTag, AddressTagWithLiterals, AddressWrapper, Authentication, AuthenticatorConnection, CallVerifyData, CaptchaDecisionReason, CaptchaDecisionReasonWithLiterals, CaptchaFlow, CaptchaFlowWithLiterals, CaptchaIdentityType, CaptchaIdentityTypeWithLiterals, CaptchaKind, CaptchaKindWithLiterals, CaptchaOutcome, CaptchaOutcomeWithLiterals, CaptchaResult, CaptchaResultWithLiterals, CaptchaToken, CaptchaTokenTokenOneOf, CaptchaVerification, ChangePasswordRequest, ChangePasswordResponse, ConnectIdpRequest, Connection, ConnectionTypeOneOf, CustomField, CustomValue, CustomValueValueOneOf, DeliveryMethod, DeliveryMethodWithLiterals, Email, EmailTag, EmailTagWithLiterals, EmailValidationFailure, ExternalEmailVerifyData, Factor, FactorStatus, FactorStatusWithLiterals, FactorType, FactorTypeWithLiterals, GetWebauthnChallengeRequest, GetWebauthnChallengeResponse, HeadersEntry, IdentificationData, IdentificationDataIdOneOf, Identity, IdentityProfile, IdpConnection, ListValue, LoginCallbackRequest, LoginIdTypeOneOf, LoginV2Request, LoginWithIdpConnectionRedirectRequest, LoginWithIdpConnectionRequest, LoginWithIdpConnectionTokenParamsRequest, LogoutRequest, MapValue, MessageEnvelope, Metadata, MfaChallengeData, MfaReason, MfaReasonWithLiterals, PathParametersEntry, Phone, PhoneTag, PhoneTagWithLiterals, PrivacyStatus, PrivacyStatusWithLiterals, PushChallengeData, PushVerifyData, QueryParametersEntry, RawHttpRequest, Reason, ReasonWithLiterals, RecaptchaForClientSiteKey, RecoveryCodeVerifyData, RegisterV2Request, RequireMfaData, SecondaryEmail, SignOnRequest, SmsVerifyData, StateMachineResponseStateDataOneOf, StateType, StateTypeWithLiterals, Status, StatusName, StatusNameWithLiterals, StatusV2, StatusWithLiterals, TenantType, TenantTypeWithLiterals, TotpVerifyData, V1CustomValue, V1CustomValueValueOneOf, V1Factor, V1ListValue, V1MapValue, V1Reason, V1ReasonWithLiterals, ValidateEmailRequest, VerificationChallenge, VerificationChallengeFactorChallengeDataOneOf, VerifyRequest, VerifyRequestFactorDataOneOf, WebAuthnChallengeData, WebAuthnVerifyData, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.mjs';
|
|
4
4
|
|
|
5
5
|
declare function registerV2$1(httpClient: HttpClient): RegisterV2Signature;
|
|
6
6
|
interface RegisterV2Signature {
|
|
@@ -2,6 +2,102 @@ import { NonNullablePaths } from '@wix/sdk-types';
|
|
|
2
2
|
|
|
3
3
|
interface Authentication {
|
|
4
4
|
}
|
|
5
|
+
/**
|
|
6
|
+
* Published for a passed check as well as a rejected one, so a consumer can tell a rejection rate
|
|
7
|
+
* from a rejection count.
|
|
8
|
+
*
|
|
9
|
+
* The caller's IP, geo and user agent are deliberately not fields: they travel as call-scope aspects
|
|
10
|
+
* in the message headers, which only reach a single-record subscription - a batch handler runs on an
|
|
11
|
+
* orphan CallScope and loses them.
|
|
12
|
+
*/
|
|
13
|
+
interface CaptchaVerification {
|
|
14
|
+
/** @format GUID */
|
|
15
|
+
eventId?: string;
|
|
16
|
+
/** When the check happened, not when this was published. */
|
|
17
|
+
eventTime?: Date | null;
|
|
18
|
+
flow?: CaptchaFlowWithLiterals;
|
|
19
|
+
identityType?: CaptchaIdentityTypeWithLiterals;
|
|
20
|
+
/**
|
|
21
|
+
* Legacy combined outcome. Use result and decision_reason instead.
|
|
22
|
+
* @deprecated Legacy combined outcome. Use result and decision_reason instead.
|
|
23
|
+
* @replacedBy result
|
|
24
|
+
* @targetRemovalDate 2027-04-18
|
|
25
|
+
*/
|
|
26
|
+
outcome?: CaptchaOutcomeWithLiterals;
|
|
27
|
+
captchaKind?: CaptchaKindWithLiterals;
|
|
28
|
+
/**
|
|
29
|
+
* How far the assessment landed from the minimum it was judged against, positive for a pass. A
|
|
30
|
+
* margin rather than a raw score because that minimum differs by surface and OS, so raw scores are
|
|
31
|
+
* not comparable across channels.
|
|
32
|
+
*
|
|
33
|
+
* Absent when no score decided the outcome - an inauthentic token, no token at all, or a
|
|
34
|
+
* PerimeterX escalation where reCAPTCHA itself passed.
|
|
35
|
+
* @min -1
|
|
36
|
+
* @max 1
|
|
37
|
+
*/
|
|
38
|
+
minScoreMargin?: number | null;
|
|
39
|
+
/**
|
|
40
|
+
* Google's reasons for the score: AUTOMATION, UNEXPECTED_ENVIRONMENT, TOO_MUCH_TRAFFIC, ...
|
|
41
|
+
* @maxLength 100
|
|
42
|
+
* @maxSize 100
|
|
43
|
+
*/
|
|
44
|
+
reasons?: string[];
|
|
45
|
+
/** What happened after verification, independently of why. */
|
|
46
|
+
result?: CaptchaResultWithLiterals;
|
|
47
|
+
/** The deciding cause of rejection or escalation. Unspecified for a pass. */
|
|
48
|
+
decisionReason?: CaptchaDecisionReasonWithLiterals;
|
|
49
|
+
}
|
|
50
|
+
declare enum CaptchaFlow {
|
|
51
|
+
REGISTER = "REGISTER",
|
|
52
|
+
/** Not published yet. */
|
|
53
|
+
LOGIN = "LOGIN"
|
|
54
|
+
}
|
|
55
|
+
/** @enumType */
|
|
56
|
+
type CaptchaFlowWithLiterals = CaptchaFlow | 'REGISTER' | 'LOGIN';
|
|
57
|
+
declare enum CaptchaIdentityType {
|
|
58
|
+
USER = "USER",
|
|
59
|
+
/** Not published yet. */
|
|
60
|
+
MEMBER = "MEMBER"
|
|
61
|
+
}
|
|
62
|
+
/** @enumType */
|
|
63
|
+
type CaptchaIdentityTypeWithLiterals = CaptchaIdentityType | 'USER' | 'MEMBER';
|
|
64
|
+
declare enum CaptchaOutcome {
|
|
65
|
+
PASSED = "PASSED",
|
|
66
|
+
LOW_SCORE = "LOW_SCORE",
|
|
67
|
+
/** Rejected as inauthentic, which is independent of the score. */
|
|
68
|
+
INVALID_TOKEN = "INVALID_TOKEN",
|
|
69
|
+
MISSING_TOKEN = "MISSING_TOKEN",
|
|
70
|
+
/**
|
|
71
|
+
* Escalated to a visible challenge. PerimeterX can cause this while reCAPTCHA itself passed, so it
|
|
72
|
+
* does not on its own mean the captcha scored badly - `reasons` distinguishes them.
|
|
73
|
+
*/
|
|
74
|
+
VISIBLE_REQUIRED = "VISIBLE_REQUIRED"
|
|
75
|
+
}
|
|
76
|
+
/** @enumType */
|
|
77
|
+
type CaptchaOutcomeWithLiterals = CaptchaOutcome | 'PASSED' | 'LOW_SCORE' | 'INVALID_TOKEN' | 'MISSING_TOKEN' | 'VISIBLE_REQUIRED';
|
|
78
|
+
declare enum CaptchaKind {
|
|
79
|
+
INVISIBLE = "INVISIBLE",
|
|
80
|
+
VISIBLE = "VISIBLE",
|
|
81
|
+
/** Verified against a site key the client registered itself (branded and headless apps). */
|
|
82
|
+
CLIENT_SITE_KEY = "CLIENT_SITE_KEY"
|
|
83
|
+
}
|
|
84
|
+
/** @enumType */
|
|
85
|
+
type CaptchaKindWithLiterals = CaptchaKind | 'INVISIBLE' | 'VISIBLE' | 'CLIENT_SITE_KEY';
|
|
86
|
+
declare enum CaptchaResult {
|
|
87
|
+
VERIFICATION_PASSED = "VERIFICATION_PASSED",
|
|
88
|
+
VERIFICATION_REJECTED = "VERIFICATION_REJECTED",
|
|
89
|
+
CHALLENGE_REQUIRED = "CHALLENGE_REQUIRED"
|
|
90
|
+
}
|
|
91
|
+
/** @enumType */
|
|
92
|
+
type CaptchaResultWithLiterals = CaptchaResult | 'VERIFICATION_PASSED' | 'VERIFICATION_REJECTED' | 'CHALLENGE_REQUIRED';
|
|
93
|
+
declare enum CaptchaDecisionReason {
|
|
94
|
+
SCORE_BELOW_THRESHOLD = "SCORE_BELOW_THRESHOLD",
|
|
95
|
+
TOKEN_INVALID = "TOKEN_INVALID",
|
|
96
|
+
TOKEN_MISSING = "TOKEN_MISSING",
|
|
97
|
+
PERIMETERX_REJECTED = "PERIMETERX_REJECTED"
|
|
98
|
+
}
|
|
99
|
+
/** @enumType */
|
|
100
|
+
type CaptchaDecisionReasonWithLiterals = CaptchaDecisionReason | 'SCORE_BELOW_THRESHOLD' | 'TOKEN_INVALID' | 'TOKEN_MISSING' | 'PERIMETERX_REJECTED';
|
|
5
101
|
interface RegisterV2Request {
|
|
6
102
|
/** Identifier of the registering member. */
|
|
7
103
|
loginId: LoginId;
|
|
@@ -1082,6 +1178,97 @@ interface GetWebauthnChallengeResponse {
|
|
|
1082
1178
|
/** The challenge that will be used for a WebAuthn authentication ceremony. */
|
|
1083
1179
|
webauthn?: WebAuthnChallengeData;
|
|
1084
1180
|
}
|
|
1181
|
+
interface MessageEnvelope {
|
|
1182
|
+
/**
|
|
1183
|
+
* App instance ID.
|
|
1184
|
+
* @format GUID
|
|
1185
|
+
*/
|
|
1186
|
+
instanceId?: string | null;
|
|
1187
|
+
/**
|
|
1188
|
+
* Event type.
|
|
1189
|
+
* @maxLength 150
|
|
1190
|
+
*/
|
|
1191
|
+
eventType?: string;
|
|
1192
|
+
/** The identification type and identity data. */
|
|
1193
|
+
identity?: IdentificationData;
|
|
1194
|
+
/** Stringify payload. */
|
|
1195
|
+
data?: string;
|
|
1196
|
+
/** Details related to the account */
|
|
1197
|
+
accountInfo?: AccountInfo;
|
|
1198
|
+
}
|
|
1199
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1200
|
+
/**
|
|
1201
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1202
|
+
* @format GUID
|
|
1203
|
+
*/
|
|
1204
|
+
anonymousVisitorId?: string;
|
|
1205
|
+
/**
|
|
1206
|
+
* ID of a site visitor that has logged in to the site.
|
|
1207
|
+
* @format GUID
|
|
1208
|
+
*/
|
|
1209
|
+
memberId?: string;
|
|
1210
|
+
/**
|
|
1211
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1212
|
+
* @format GUID
|
|
1213
|
+
*/
|
|
1214
|
+
wixUserId?: string;
|
|
1215
|
+
/**
|
|
1216
|
+
* ID of an app.
|
|
1217
|
+
* @format GUID
|
|
1218
|
+
*/
|
|
1219
|
+
appId?: string;
|
|
1220
|
+
/** @readonly */
|
|
1221
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1222
|
+
}
|
|
1223
|
+
/** @oneof */
|
|
1224
|
+
interface IdentificationDataIdOneOf {
|
|
1225
|
+
/**
|
|
1226
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1227
|
+
* @format GUID
|
|
1228
|
+
*/
|
|
1229
|
+
anonymousVisitorId?: string;
|
|
1230
|
+
/**
|
|
1231
|
+
* ID of a site visitor that has logged in to the site.
|
|
1232
|
+
* @format GUID
|
|
1233
|
+
*/
|
|
1234
|
+
memberId?: string;
|
|
1235
|
+
/**
|
|
1236
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1237
|
+
* @format GUID
|
|
1238
|
+
*/
|
|
1239
|
+
wixUserId?: string;
|
|
1240
|
+
/**
|
|
1241
|
+
* ID of an app.
|
|
1242
|
+
* @format GUID
|
|
1243
|
+
*/
|
|
1244
|
+
appId?: string;
|
|
1245
|
+
}
|
|
1246
|
+
declare enum WebhookIdentityType {
|
|
1247
|
+
UNKNOWN = "UNKNOWN",
|
|
1248
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1249
|
+
MEMBER = "MEMBER",
|
|
1250
|
+
WIX_USER = "WIX_USER",
|
|
1251
|
+
APP = "APP"
|
|
1252
|
+
}
|
|
1253
|
+
/** @enumType */
|
|
1254
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1255
|
+
interface AccountInfo {
|
|
1256
|
+
/**
|
|
1257
|
+
* ID of the Wix account associated with the event.
|
|
1258
|
+
* @format GUID
|
|
1259
|
+
*/
|
|
1260
|
+
accountId?: string | null;
|
|
1261
|
+
/**
|
|
1262
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
1263
|
+
* @format GUID
|
|
1264
|
+
*/
|
|
1265
|
+
parentAccountId?: string | null;
|
|
1266
|
+
/**
|
|
1267
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
1268
|
+
* @format GUID
|
|
1269
|
+
*/
|
|
1270
|
+
siteId?: string | null;
|
|
1271
|
+
}
|
|
1085
1272
|
/** @docsIgnore */
|
|
1086
1273
|
type RegisterV2ApplicationErrors = {
|
|
1087
1274
|
code?: 'UNIMPLEMENTED_FEATURE';
|
|
@@ -1362,4 +1549,4 @@ interface LogoutOptions {
|
|
|
1362
1549
|
clientId?: string | null;
|
|
1363
1550
|
}
|
|
1364
1551
|
|
|
1365
|
-
export { type Address, AddressTag, type AddressTagWithLiterals, type AddressWrapper, type Authentication, type AuthenticatorConnection, type CallVerifyData, type CaptchaToken, type CaptchaTokenTokenOneOf, type ChangePasswordRequest, type ChangePasswordResponse, type ConnectIdpRequest, type Connection, type ConnectionTypeOneOf, type CustomField, type CustomValue, type CustomValueValueOneOf, DeliveryMethod, type DeliveryMethodWithLiterals, type Email, EmailTag, type EmailTagWithLiterals, type EmailValidationFailure, type ExternalEmailVerifyData, type Factor, FactorStatus, type FactorStatusWithLiterals, FactorType, type FactorTypeWithLiterals, type GetWebauthnChallengeRequest, type GetWebauthnChallengeResponse, type HeadersEntry, type Identity, type IdentityProfile, type IdpConnection, type ListValue, type LoginCallbackRequest, type LoginId, type LoginIdTypeOneOf, type LoginV2ApplicationErrors, type LoginV2Options, type LoginV2Request, type LoginV2ValidationErrors, type LoginWithIdpConnectionRedirectRequest, type LoginWithIdpConnectionRequest, type LoginWithIdpConnectionTokenParamsRequest, type LogoutOptions, type LogoutRequest, type MapValue, type Metadata, type MfaChallengeData, MfaReason, type MfaReasonWithLiterals, type PathParametersEntry, type Phone, PhoneTag, type PhoneTagWithLiterals, PrivacyStatus, type PrivacyStatusWithLiterals, type PushChallengeData, type PushVerifyData, type QueryParametersEntry, type RawHttpRequest, type RawHttpResponse, Reason, type ReasonWithLiterals, type RecaptchaForClientSiteKey, type RecoveryCodeVerifyData, type RegisterV2ApplicationErrors, type RegisterV2Options, type RegisterV2Request, type RegisterV2ValidationErrors, type RequireMfaData, type SecondaryEmail, type SignOnOptions, type SignOnRequest, type SignOnResponse, type SmsVerifyData, type StateMachineResponse, type StateMachineResponseStateDataOneOf, StateType, type StateTypeWithLiterals, Status, StatusName, type StatusNameWithLiterals, type StatusV2, type StatusWithLiterals, TenantType, type TenantTypeWithLiterals, type TotpVerifyData, type V1CustomValue, type V1CustomValueValueOneOf, type V1Factor, type V1ListValue, type V1MapValue, V1Reason, type V1ReasonWithLiterals, type ValidateEmailRequest, type ValidateEmailResponse, type VerificationChallenge, type VerificationChallengeFactorChallengeDataOneOf, type VerifyRequest, type VerifyRequestFactorDataOneOf, type WebAuthnChallengeData, type WebAuthnVerifyData, changePassword, loginV2, logout, registerV2, signOn, validateEmail };
|
|
1552
|
+
export { type AccountInfo, type Address, AddressTag, type AddressTagWithLiterals, type AddressWrapper, type Authentication, type AuthenticatorConnection, type CallVerifyData, CaptchaDecisionReason, type CaptchaDecisionReasonWithLiterals, CaptchaFlow, type CaptchaFlowWithLiterals, CaptchaIdentityType, type CaptchaIdentityTypeWithLiterals, CaptchaKind, type CaptchaKindWithLiterals, CaptchaOutcome, type CaptchaOutcomeWithLiterals, CaptchaResult, type CaptchaResultWithLiterals, type CaptchaToken, type CaptchaTokenTokenOneOf, type CaptchaVerification, type ChangePasswordRequest, type ChangePasswordResponse, type ConnectIdpRequest, type Connection, type ConnectionTypeOneOf, type CustomField, type CustomValue, type CustomValueValueOneOf, DeliveryMethod, type DeliveryMethodWithLiterals, type Email, EmailTag, type EmailTagWithLiterals, type EmailValidationFailure, type ExternalEmailVerifyData, type Factor, FactorStatus, type FactorStatusWithLiterals, FactorType, type FactorTypeWithLiterals, type GetWebauthnChallengeRequest, type GetWebauthnChallengeResponse, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, type Identity, type IdentityProfile, type IdpConnection, type ListValue, type LoginCallbackRequest, type LoginId, type LoginIdTypeOneOf, type LoginV2ApplicationErrors, type LoginV2Options, type LoginV2Request, type LoginV2ValidationErrors, type LoginWithIdpConnectionRedirectRequest, type LoginWithIdpConnectionRequest, type LoginWithIdpConnectionTokenParamsRequest, type LogoutOptions, type LogoutRequest, type MapValue, type MessageEnvelope, type Metadata, type MfaChallengeData, MfaReason, type MfaReasonWithLiterals, type PathParametersEntry, type Phone, PhoneTag, type PhoneTagWithLiterals, PrivacyStatus, type PrivacyStatusWithLiterals, type PushChallengeData, type PushVerifyData, type QueryParametersEntry, type RawHttpRequest, type RawHttpResponse, Reason, type ReasonWithLiterals, type RecaptchaForClientSiteKey, type RecoveryCodeVerifyData, type RegisterV2ApplicationErrors, type RegisterV2Options, type RegisterV2Request, type RegisterV2ValidationErrors, type RequireMfaData, type SecondaryEmail, type SignOnOptions, type SignOnRequest, type SignOnResponse, type SmsVerifyData, type StateMachineResponse, type StateMachineResponseStateDataOneOf, StateType, type StateTypeWithLiterals, Status, StatusName, type StatusNameWithLiterals, type StatusV2, type StatusWithLiterals, TenantType, type TenantTypeWithLiterals, type TotpVerifyData, type V1CustomValue, type V1CustomValueValueOneOf, type V1Factor, type V1ListValue, type V1MapValue, V1Reason, type V1ReasonWithLiterals, type ValidateEmailRequest, type ValidateEmailResponse, type VerificationChallenge, type VerificationChallengeFactorChallengeDataOneOf, type VerifyRequest, type VerifyRequestFactorDataOneOf, type WebAuthnChallengeData, type WebAuthnVerifyData, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, changePassword, loginV2, logout, registerV2, signOn, validateEmail };
|